Sign in

v10

latestOpenAPI 3.1.02026-08-0375143791.1 KB
webdbs

Get a webhook

Returns one WebDB webhook.

get/webdbs/webhooks/{webhook_id}

Path parameters

webhook_idstring required

Webhook ID.

Example:wh_123

Webhook ID.

Query parameters

tagsstring[]

Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.

Optional comma-separated caller-defined tags for tracking this request. Tags are recorded on the request's usage log and can be used to filter usage on the dashboard usage page. Up to 20 tags, each 1-50 characters.

[
  "production",
  "team-alpha"
]

Response

Webhook

idstring required

Webhook ID.

urlstring uri required

HTTPS URL that receives events.

eventsstring[] required

Events sent to this webhook.

collection_idstring nullable required

Collection being watched, or null for all collections.

delivery'instant' | 'batch' required

Whether events are sent immediately or in batches.

secretstring required

Secret used to verify webhook signatures.

status'active' | 'disabled' required

Current webhook status.

created_atstring date-time required

Time the webhook was created.

updated_atstring date-time required

Time the webhook was last updated.

Example response

{
  "id": "wh_123"
}