Webhooks

envless.webhooks.listAll()

Collect every webhook endpoint into one array

ts
listAll(options?: SortedListOptions): Promise<Array<WebhookResource>>

Walks the pages and resolves with a flat array of every live endpoint. The 20 endpoint cap means this is a single request in practice, which makes it the normal way to load a settings screen.

The pagination envelope is dropped, so totalCount and hasMore are gone. Secrets are still absent from every row, so use create or rotateSecret if you need a usable secret rather than secretLastFour.

Example

ts
const hooks = await envless.webhooks.listAll()

const unhealthy = hooks.filter((hook) => hook.enabled && hook.lastFailureAt !== null)

console.log(unhealthy.map((hook) => [hook.id, hook.lastSuccessAt]))

Parameters

ParameterTypeRequiredDescription
options.limitnumberNoPage size used while walking, capped at 100 and defaulting to 100.
options.offsetnumberNoRow the walk starts from, so earlier endpoints are left out of the result.
options.searchstringNoCase insensitive substring match applied to every page.
options.orderstringNoDefaults to name, which sorts A to Z. Pass asc for oldest first or desc for newest first on createdAt.
options.signalAbortSignalNoCancels every request in the walk.

Returns

Array<WebhookResource> holding each live endpoint in the workspace.

Reads the webhooks collection. list returns one page as { items, pagination }, listAll collects every page into an array, and iterate streams one item at a time without buffering the whole set.

Worth knowing

  • A failure on any page rejects the whole call and the rows already collected are lost.
  • Refused for project fenced keys, like every other method here.

Required scopes

webhooks:read

Underlying endpoint

GET /webhooks

Request and response schema, every error code, and a live playground.

In Python

envless.webhooks.list_all()

The same method in envless-sdk, the Python SDK, with the same request, retries and errors.

In Ruby

Envless.webhooks.list_all

The same method in envless-sdk, the Ruby gem, with the same request, retries and errors.

In PHP

$envless->webhooks->listAll()

The same method in envless/sdk, the PHP SDK, with the same request, retries and errors.