Skip to main content
GET
Get a webhook

Endpoint

GET /webhooks/{webhook_id} Returns a single webhook, including its derived delivery status.

Path Parameters

Response

A webhook object. See List Webhooks for the field reference. The signing secret is never returned; has_secret indicates whether one is configured.

404 Not Found

No webhook with that ID exists for the authenticated customer.

Authentication

This endpoint requires authentication. You can only retrieve webhooks owned by the authenticated customer.

Authorizations

X-API-KEY
string
header
required

Path Parameters

webhook_id
string
required

ID of the webhook to retrieve.

Response

The requested webhook.

id
string

Unique ID for the webhook.

webhook_url
string<uri>
is_active
boolean
has_secret
boolean

Whether a signing secret is configured. The secret itself is never returned.

status
enum<string>

Derived health: disabled when inactive, failing when the last delivery returned a non-2xx status, otherwise active.

Available options:
active,
failing,
disabled
last_delivery_at
string<date-time> | null

Timestamp of the most recent delivery attempt, or null if none.

last_delivery_status
integer | null

HTTP status code of the most recent delivery attempt, or null if none.

events
enum<string>[]
Available options:
cdd_state_changed,
monitoring_alert_fired,
cdd_document_fetched,
search_completed,
alert_remediated,
flow_run_completed,
flow_run_failed