Skip to main content

List Configs

List all webhook configurations for your workspace. Each config defines a destination URL, subscribed event types, and an optional signing secret for HMAC verification.

Webhook configurations define where event notifications are delivered. Each configuration specifies a destination URL, a set of subscribed event types, and an optional signing secret used for HMAC-SHA256 payload verification. Configurations can be scoped to a specific source connection or apply workspace-wide.

Use this endpoint to audit your current webhook setup — which URLs are receiving events, which event types are subscribed, and whether each configuration is active or paused. The is_active flag lets you temporarily disable a webhook without deleting its configuration.

Each configuration includes a source_connection_id field. When set, the webhook only fires for events originating from that specific source. When null, the webhook fires for events from all sources in the workspace. This is useful for routing different source types to different processing endpoints.

Combine the list endpoint with the Events reference to understand which event types are available. The default subscription when creating a webhook without specifying events is extraction.complete and extraction.failed — the two most common integration triggers.

Webhook configurations are independent of the webhook_url parameter on POST /v1/extract. Configurations created here persist across requests and apply automatically to matching events. The extract-level webhook_url is a one-time override for that specific extraction.
GET/v1/webhooks

Response

Response fields

dataarrayArray of webhook configuration objects.
data[].idstringConfiguration UUID.
data[].urlstringDestination URL for webhook deliveries.
data[].eventsstring[]Subscribed event types (e.g. extraction.complete).
data[].is_activebooleanWhether this webhook is currently active.
data[].source_connection_idstring | nullSource connection this webhook is scoped to, or null for workspace-wide.
data[].created_atstringISO 8601 creation timestamp.
data[].updated_atstringISO 8601 last update timestamp.
data[].links.selfstringURL to this configuration.

Response

{
  "data": [
    {
      "id": "wh_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "url": "https://api.example.com/webhooks/talonic",
      "events": ["extraction.complete", "extraction.failed"],
      "is_active": true,
      "source_connection_id": null,
      "created_at": "2024-10-01T08:00:00.000Z",
      "updated_at": "2024-10-01T08:00:00.000Z",
      "links": {
        "self": "/v1/webhooks/wh_a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      }
    }
  ]
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Related

Create Config
Webhook Events