Sign in
webhooks

Get Webhook Endpoint

Get one webhook endpoint: its URL, filters, whether it is disabled and why, and the most recent delivery. The secret is never included.

disabled_reason is delivery_failures when Captain disabled the endpoint after sustained failed deliveries. Re-enable it with PATCH and {"disabled": false}, then recover the events it missed.

get/v2/webhooks/endpoints/{endpoint_id}

Path parameters

endpoint_idstring required

The endpoint's id (whe_...).

Response

Successful Response

endpoint_idstring required

The endpoint's id (whe_...).

urlstring required

HTTPS URL that receives events.

descriptionstring required

Free-text label. Empty string when not set.

event_typesstring[] required

Events this endpoint receives. Empty means all five.

collection_idsstring[] required

Collection filter. Empty means every collection.

sync_idsstring[] required

Sync filter. Empty means no sync filter.

sourcesstring[] required

Source filter (api, sync). Empty means both.

channelsstring[] required

Filters set in Captain Studio's Webhooks page that cannot be expressed as collection_ids, sync_ids and sources. Empty for endpoints whose filters were set through the API. Setting collection_ids, sync_ids or sources with PATCH replaces them.

include_collection_nameboolean required

Whether payloads sent to this endpoint may carry collection_name.

disabledboolean required

true when no events are being sent to this endpoint.

disabled_reasonstring nullable required

delivery_failures when Captain disabled the endpoint after sustained failed deliveries. null when it is enabled or was paused through the API.

created_atstring date-time required
updated_atstring date-time required

Changes

Changed in 1 of the 13 revisions of this API.1