Manage Config

Get, update, or delete a webhook configuration. Update the URL, events, secret, or active status. Deleting a config stops all future deliveries.

Retrieve, update, or delete a webhook configuration. Use GET to inspect the current settings, PATCH to modify specific fields, and DELETE to permanently remove the configuration and stop all future deliveries to its URL.

Updates take effect immediately — the next event that fires will use the updated URL, events, and secret. Common update patterns include rotating the signing secret, adding or removing event subscriptions, and temporarily disabling a webhook by setting is_active: false.

Deleting a webhook configuration is permanent. Any events that occur after deletion are not queued. If you need to temporarily stop deliveries without losing the configuration, set is_active to false instead.

When rotating secrets, update the webhook configuration first, then update your server to verify against the new secret. During the transition, you may need to accept signatures from both the old and new secrets to avoid rejecting in-flight deliveries.

Response (PATCH)

{
  "id": "wh_b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "url": "https://api.example.com/webhooks/talonic-v2",
  "events": ["extraction.complete"],
  "is_active": true,
  "source_connection_id": null,
  "created_at": "2024-10-05T12:00:00.000Z",
  "updated_at": "2024-10-06T09:30:00.000Z",
  "links": {
    "self": "/v1/webhooks/wh_b2c3d4e5-f6a7-8901-bcde-f12345678901"
  }
}

Response (DELETE)

{ "deleted": true, "id": "wh_b2c3d4e5-f6a7-8901-bcde-f12345678901" }

Errors