list(options?: SortedListOptions): Promise<Page<WebhookResource>>Returns one page of the live webhook endpoints. Signing secrets are never part of a read, so every row carries only secretLastFour, which is enough to confirm which secret a receiver is verifying against and nothing more.
Ordering defaults to name, A to Z. options.order set to asc or desc switches to createdAt, oldest or newest first, and any other value falls back to name order. options.search matches name, url and description together.
Every method in this namespace, this read included, is refused with 403 auth.key_project_restricted when the calling key is fenced to specific projects. Endpoints are workspace wide and subscribe to workspace wide events, so authenticate with a key that has no projectIds fence.
Example
const page = await envless.webhooks.list({ search: 'billing' })
console.log(page.items.map((hook) => [hook.url, hook.enabled]))
console.log(page.pagination.totalCount)Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
options.limit | number | No | Rows per page, a whole number from 1 to 100. |
options.offset | number | No | Whole number of endpoints to skip before the page starts. |
options.search | string | No | Case insensitive substring match across name, url and description. |
options.order | string | No | Defaults to name, which sorts A to Z. Pass asc for oldest first or desc for newest first on createdAt. |
options.signal | AbortSignal | No | Cancels the request. |
Returns
Page<WebhookResource> with items and a pagination envelope counting every live endpoint.
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
- Deleted endpoints are excluded permanently and their ids are never reused.
- A workspace is capped at 20 endpoints, so one page of 100 always holds the whole set.
Required scopes
webhooks:read
Underlying endpoint
GET /webhooks
Request and response schema, every error code, and a live playground.
In Python
envless.webhooks.list()
The same method in envless-sdk, the Python SDK, with the same request, retries and errors.
In Ruby
Envless.webhooks.list
The same method in envless-sdk, the Ruby gem, with the same request, retries and errors.
In PHP
$envless->webhooks->list()
The same method in envless/sdk, the PHP SDK, with the same request, retries and errors.