# List webhook subscriptions

Find approved subscriptions for the published resource types your credential can read. Use a subscription’s ID to inspect deliveries, recover missed events or request a replay. Destination URLs, secrets and legacy transcript exports are excluded.

POST https://api.brigg.app/v1/operations/webhooks.ListWebhookSubscriptions

## Access & visibility

Allow `webhooks.ListWebhookSubscriptions` on your API key.

**Workspace access by default.** Private member data requires [approved member delegation](https://developer.brigg.app/authentication#member-delegation) through `Brigg-Act-As`; the key supplies permissions while private ownership and project boundaries remain enforced.

[Set up authentication](https://developer.brigg.app/authentication) · [Choose permissions](https://developer.brigg.app/permissions)

## Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `event` | string | No | Event name. Supported values: `meeting.completed`, `resource.created`, `resource.updated`, `resource.deleted`. See the [event reference](https://developer.brigg.app/events) for payloads and delivery contracts. |

## Response

Returns **200 OK** with a JSON body.

This operation has no continuation cursor. An empty `items` array means no matching visible results were returned.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `items` | array of [Webhook subscription](#webhook-subscription-response-items) | Yes | Subscriptions accessible under the credential's operation and resource grants, optionally filtered by event. This operation has no cursor pagination. |

### Webhook subscription · response.items[]

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `webhook_id` | string | Yes | Identifier of the approved webhook subscription. After administrator approval, discover it with `webhooks.ListWebhookSubscriptions` using a credential with read access to every selected resource type. It is different from an event ID or delivery ID. |
| `event` | string | Yes | Event name. Supported values: `meeting.completed`, `resource.created`, `resource.updated`, `resource.deleted`. See the [event reference](https://developer.brigg.app/events) for payloads and delivery contracts. |
| `resource_types` | array of string | Yes | Explicit resource type identifiers, such as `core:Company` or a workspace app's qualified type. Discover the exact values from `resource` on the record operations returned by `GET /v1/operations` using a key with access to those records. These are resource types, not app names or operation namespaces. Required and non-empty for `resource.created`, `resource.updated` and `resource.deleted`; omit for legacy `meeting.completed`. Only selected, published shared types are included; new types are never added automatically. See [webhook resource selection](https://developer.brigg.app/webhooks#choose-resource-types). |
| `enabled` | boolean | Yes | Whether this subscription may receive deliveries. It does not confirm that its endpoint is healthy. |
| `created_at` | number | Yes | Creation time in Unix milliseconds. |
| `last_delivered_at` | number or null | Yes | Most recent successful delivery time in Unix milliseconds, or null before a successful delivery. |

## Errors & retries

This operation reads data. It needs no idempotency key and can be retried after a transient failure.

For rate limits, follow the server’s retry guidance and back off. See [HTTP errors](https://developer.brigg.app/http#errors) and [safe retries and limits](https://developer.brigg.app/reliability).

| HTTP status | Code | What to do |
| --- | --- | --- |
| 400 | `invalid_json` | Send a JSON object with Content-Type: application/json. |
| 400 | `invalid_input` | Check the request fields and types. |
| 401 | `invalid_key` | The workspace API key is missing, invalid or revoked. |
| 403 | `forbidden` | Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member. |
| 404 | `not_found` | The requested operation or resource is not available to this credential. |
| 429 | `rate_limited` | Wait for Retry-After before retrying. |

## Next steps

- [Receive and verify webhooks](https://developer.brigg.app/webhooks)

[Download OpenAPI](https://developer.brigg.app/openapi.json) · [Versioning & retirement](https://developer.brigg.app/versioning)

## Examples

### Example request

Fictional values. Replace IDs and business details with values from your workspace.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/webhooks.ListWebhookSubscriptions' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{}'
```

#### TypeScript


```typescript
const response = await fetch("https://api.brigg.app/v1/operations/webhooks.ListWebhookSubscriptions", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);
```

#### Python


```python
import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {}
request = Request(
    "https://api.brigg.app/v1/operations/webhooks.ListWebhookSubscriptions",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise
```

#### Response example


```json
{
  "items": [
    {
      "webhook_id": "webhook_crm",
      "event": "resource.updated",
      "resource_types": [
        "core:Company"
      ],
      "enabled": true,
      "created_at": 1794301200000,
      "last_delivered_at": null
    }
  ]
}
```

## JSON schemas


```json-schema-request
{
  "type": "object",
  "properties": {
    "event": {
      "type": "string",
      "description": "Event name. Supported values: `meeting.completed`, `resource.created`, `resource.updated`, `resource.deleted`. See the [event reference](https://developer.brigg.app/events) for payloads and delivery contracts."
    }
  },
  "additionalProperties": false,
  "examples": [
    {}
  ]
}
```


```json-schema-response
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "webhook_id": {
            "type": "string",
            "description": "Identifier of the approved webhook subscription. After administrator approval, discover it with `webhooks.ListWebhookSubscriptions` using a credential with read access to every selected resource type. It is different from an event ID or delivery ID.",
            "examples": [
              "webhook_crm"
            ]
          },
          "event": {
            "type": "string",
            "description": "Event name. Supported values: `meeting.completed`, `resource.created`, `resource.updated`, `resource.deleted`. See the [event reference](https://developer.brigg.app/events) for payloads and delivery contracts.",
            "examples": [
              "resource.updated"
            ]
          },
          "resource_types": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Explicit resource type identifiers, such as `core:Company` or a workspace app's qualified type. Discover the exact values from `resource` on the record operations returned by `GET /v1/operations` using a key with access to those records. These are resource types, not app names or operation namespaces. Required and non-empty for `resource.created`, `resource.updated` and `resource.deleted`; omit for legacy `meeting.completed`. Only selected, published shared types are included; new types are never added automatically. See [webhook resource selection](https://developer.brigg.app/webhooks#choose-resource-types).",
            "examples": [
              [
                "core:Company"
              ]
            ]
          },
          "enabled": {
            "type": "boolean",
            "description": "Whether this subscription may receive deliveries. It does not confirm that its endpoint is healthy.",
            "examples": [
              true
            ]
          },
          "created_at": {
            "type": "number",
            "description": "Creation time in Unix milliseconds."
          },
          "last_delivered_at": {
            "type": [
              "number",
              "null"
            ],
            "description": "Most recent successful delivery time in Unix milliseconds, or null before a successful delivery.",
            "examples": [
              null
            ]
          }
        },
        "required": [
          "webhook_id",
          "event",
          "resource_types",
          "enabled",
          "created_at",
          "last_delivered_at"
        ],
        "additionalProperties": false,
        "title": "Webhook subscription"
      },
      "description": "Subscriptions accessible under the credential's operation and resource grants, optionally filtered by event. This operation has no cursor pagination."
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "items": [
        {
          "webhook_id": "webhook_crm",
          "event": "resource.updated",
          "resource_types": [
            "core:Company"
          ],
          "enabled": true,
          "created_at": 1794301200000,
          "last_delivered_at": null
        }
      ]
    }
  ]
}
```