# List webhook endpoints

`GET https://api.cademi.com.br/api/v3/webhooks`

Operation ID: `webhooks.list` · API v3

Returns the webhook endpoints of the current account, paginated by cursor. The collection can be filtered by status and event type. Signing secrets are never included.

Required permissions: `webhooks.read`.

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `limit` | query | integer | no |  |
| `cursor` | query | string | no |  |
| `sort` | query | string, one of `created_at`, `-created_at` | no |  |
| `status` | query | string, one of `active`, `inactive` | no |  |
| `event_type` | query | string | no |  |

## Responses

### 200

Returns the collection of webhook endpoints.

Body: `data`: array of Webhook.

Fields of Webhook:

| Field | Type | Required | Description |
|---|---|---|---|
| `created_at` | string (date-time) | yes |  |
| `description` | string or null | no |  |
| `event_types` | array of string | yes |  |
| `health` | object or null | no |  |
| `id` | string | yes |  |
| `max_per_second` | integer | no |  |
| `object` | string, one of `webhook` | yes |  |
| `payload_version` | integer | no |  |
| `resource_filters` | object or null | no |  |
| `revision` | integer | yes |  |
| `secret` | string or null | no | Secret of the webhook destination. Returned only when the webhook is created or its secret is rotated, and shown only once. |
| `status` | string, one of `active`, `inactive` | yes |  |
| `timeout_ms` | integer | no |  |
| `updated_at` | string (date-time) | yes |  |
| `url` | string (uri) | yes |  |

### 400

The cursor is invalid or the request contains an unsupported query parameter.

Body: Error.

### 401

The credential is missing, malformed, expired, or revoked.

Body: Error.

### 403

The current credentials do not have the permission required by this operation.

Body: Error.

Full schema: https://cademi.dev/openapi/v3.json
