Sign in

v1

latestOpenAPI 3.0.02026-07-2494288373.8 KB
Webhooks

Retrieve a webhook

Retrieves the webhook endpoint with the given ID.

See also

Learn more about Webhooks

get/v1/webhooks/{id}

Path parameters

idstring uuid required

Id of the webhook

Response

A webhook registered with the workspace

ℹ️ Click to see full payload

idstring uuid required
namestring required
status'online' | 'offline' required
type'user' | 'system' required

system webhooks are hidden from console app.

eventsstring[] required
urlstring url required
secretstring required

A secret token used to sign the webhook payload.

created_atstring date-time required

Creation date
Date time in format ISO 8601 (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z)

updated_atstring date-time required

Latest update date
Date time in format ISO 8601 (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z)