# List webhooks

List webhook subscriptions, supported event names and eligible shared resource types. Signing secrets are excluded. Resource type identifiers can be used when preparing a subscription.

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

## Access & visibility

Allow `webhooks.ListWebhooks` 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

No parameters. Send an empty JSON object (`{}`).

## Discover what can be subscribed to

This administrator view returns three independent collections: `events` is the event-name catalogue, `resources` is the eligible shared resource catalogue, and `items` is the existing subscription list. An empty `items` does not mean there are no supported events.

For an integration that only needs its granted subscriptions, use [List webhook subscriptions](https://developer.brigg.app/reference/webhooks/ListWebhookSubscriptions). That operation checks the credential's resource grants; this administrator catalogue requires an approved owner/admin identity. Neither response returns signing secrets.

Pass exact `resources[].type` values as `resource_types` when [preparing a webhook](https://developer.brigg.app/reference/webhooks/PrepareWebhook). An administrator must approve the proposal before it becomes an active subscription. New resource types are not added to an existing subscription automatically.

## 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 |
| --- | --- | --- | --- |
| `events` | array of string | Yes | Supported event-name strings, not event records or delivery history. See the [event reference](https://developer.brigg.app/events) for each payload. |
| `resources` | array of [object](#response-resources) | No | Published shared resources available to this credential for webhook subscriptions. |
| `items` | array of [Webhook subscription](#webhook-subscription-response-items) | Yes | Workspace webhook subscriptions; supported events and resource types are returned separately. This operation has no cursor pagination. |

### response.resources[]

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | Exact resource type identifier to put in resource_types, for example core:Company. This is not an operation namespace or a model-variant tag. |
| `label` | string | Yes | Human-readable name of the supported resource or event. |
| `app` | string | Yes | Internal app identifier owning the resource; use label for display and type for subscription selection. |

### Webhook subscription · response.items[]

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | Webhook subscription ID used by DeleteWebhook and TestWebhook. |
| `url` | string | Yes | Approved HTTPS destination that receives deliveries. This is not a Brigg API endpoint. |
| `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. |
| `version` | string | No | Payload contract version used for this subscription. |
| `resource_types` | array of string | No | 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. |
| `consecutive_failures` | number | Yes | Consecutive failed deliveries recorded for this subscription. |
| `last_failure_reason` | string or null | Yes | Most recent delivery failure, or null if none is recorded. |
| `last_delivered_at` | number or null | Yes | Most recent successful delivery time in Unix milliseconds, or null before a successful delivery. |
| `created_at` | number | Yes | Subscription creation time in Unix milliseconds. |

## 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

- [Prepare webhook](https://developer.brigg.app/reference/webhooks/PrepareWebhook)
- [List webhook subscriptions](https://developer.brigg.app/reference/webhooks/ListWebhookSubscriptions)
- [List webhook deliveries](https://developer.brigg.app/reference/webhooks/ListWebhookDeliveries)
- [List webhook events](https://developer.brigg.app/reference/webhooks/ListWebhookEvents)

[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.ListWebhooks' \
  -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.ListWebhooks", {
  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.ListWebhooks",
    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
{
  "events": [
    "meeting.completed",
    "resource.created",
    "resource.updated",
    "resource.deleted"
  ],
  "items": [
    {
      "id": "webhook_crm",
      "url": "https://example.com/webhooks/brigg",
      "event": "resource.updated",
      "version": "v1",
      "resource_types": [
        "core:Company"
      ],
      "enabled": true,
      "consecutive_failures": 0,
      "last_failure_reason": null,
      "last_delivered_at": null,
      "created_at": 1794301200000
    }
  ],
  "resources": [
    {
      "type": "core:Company",
      "label": "Company",
      "app": "customers"
    }
  ]
}
```

## JSON schemas


```json-schema-request
{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "examples": [
    {}
  ]
}
```


```json-schema-response
{
  "type": "object",
  "properties": {
    "events": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Supported event-name strings, not event records or delivery history. See the [event reference](https://developer.brigg.app/events) for each payload."
    },
    "resources": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "Exact resource type identifier to put in resource_types, for example core:Company. This is not an operation namespace or a model-variant tag."
          },
          "label": {
            "type": "string",
            "description": "Human-readable name of the supported resource or event."
          },
          "app": {
            "type": "string",
            "description": "Internal app identifier owning the resource; use label for display and type for subscription selection."
          }
        },
        "required": [
          "type",
          "label",
          "app"
        ],
        "additionalProperties": false
      },
      "description": "Published shared resources available to this credential for webhook subscriptions."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Webhook subscription ID used by DeleteWebhook and TestWebhook.",
            "examples": [
              "webhook_crm"
            ]
          },
          "url": {
            "type": "string",
            "description": "Approved HTTPS destination that receives deliveries. This is not a Brigg API endpoint.",
            "examples": [
              "https://example.com/webhooks/brigg"
            ]
          },
          "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"
            ]
          },
          "version": {
            "type": "string",
            "description": "Payload contract version used for this subscription.",
            "examples": [
              "v1"
            ]
          },
          "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
            ]
          },
          "consecutive_failures": {
            "type": "number",
            "description": "Consecutive failed deliveries recorded for this subscription.",
            "examples": [
              0
            ]
          },
          "last_failure_reason": {
            "type": [
              "string",
              "null"
            ],
            "description": "Most recent delivery failure, or null if none is recorded.",
            "examples": [
              null
            ]
          },
          "last_delivered_at": {
            "type": [
              "number",
              "null"
            ],
            "description": "Most recent successful delivery time in Unix milliseconds, or null before a successful delivery.",
            "examples": [
              null
            ]
          },
          "created_at": {
            "type": "number",
            "description": "Subscription creation time in Unix milliseconds.",
            "examples": [
              1794301200000
            ]
          }
        },
        "required": [
          "id",
          "url",
          "event",
          "enabled",
          "consecutive_failures",
          "last_failure_reason",
          "last_delivered_at",
          "created_at"
        ],
        "additionalProperties": false,
        "title": "Webhook subscription"
      },
      "description": "Workspace webhook subscriptions; supported events and resource types are returned separately. This operation has no cursor pagination."
    }
  },
  "required": [
    "items",
    "events"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "events": [
        "meeting.completed",
        "resource.created",
        "resource.updated",
        "resource.deleted"
      ],
      "items": [
        {
          "id": "webhook_crm",
          "url": "https://example.com/webhooks/brigg",
          "event": "resource.updated",
          "version": "v1",
          "resource_types": [
            "core:Company"
          ],
          "enabled": true,
          "consecutive_failures": 0,
          "last_failure_reason": null,
          "last_delivered_at": null,
          "created_at": 1794301200000
        }
      ],
      "resources": [
        {
          "type": "core:Company",
          "label": "Company",
          "app": "customers"
        }
      ]
    }
  ]
}
```