Webhooks API

Fetch a Webhook

fetchWebhook

GET /event/{tenantLocator}/webhooks/{webhookLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
webhookLocator	path	locator	required

Response:WebhookResponse
Security Group:webhooks   Permission:read

Fetch All Webhooks

fetchWebhooks

GET /event/{tenantLocator}/webhooks/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional
name	query	string?	optional
enabled	query	boolean?	optional
suspended	query	boolean?	optional
active	query	boolean?	optional
eventTypes	query	string[]?	optional

Response:WebhookResponse[]
Security Group:webhooks   Permissions:read,list

WebhookResponse

required
locator locator
name string
enabled boolean
endpoint EndpointResponse
failureHandling FailureHandlingResponse
suspended boolean
suspendedAt datetime
eventTypes string[]

EndpointResponse

required
url string
headers map<string,string[]>

Create a Webhook

createWebhook

POST /event/{tenantLocator}/webhooks

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:CreateWebhookRequest
Response:WebhookResponse
Security Group:webhooks   Permission:write

CreateWebhookRequest

required
name string
enabled boolean
endpoint CreateEndpointRequest
failureHandling FailureHandlingCreateRequest
eventTypes string[]

CreateEndpointRequest

required
url string
headers map<string,string[]>

Update a Webhook

updateWebhook

PATCH /event/{tenantLocator}/webhooks/{webhookLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
webhookLocator	path	locator	required

Request:UpdateWebhookRequest
Response:WebhookResponse
Security Group:webhooks   Permission:write

Note

This endpoint follows Enterprise Core’s add-remove semantics for updates: removals happen first, followed by additions. This means that addition takes precedence over removal if a request includes some item in both “remove” and “add”.

UpdateWebhookRequest

required
name string
enabled boolean
endpoint UpdateEndpointRequest
failureHandling FailureHandlingUpdateRequest
removeFailureHandling boolean
addEventTypes string[]
removeEventTypes string[]

UpdateEndpointRequest

required
url string
addHeaders map<string,string[]>
removeHeaders string[]

Unsuspend Webhook

unsuspendWebhook

PATCH /event/{tenantLocator}/webhooks/{webhookLocator}/unsuspend

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
webhookLocator	path	locator	required

Response:void
Security Group:webhooks   Permission:write

Delete a Webhook

deleteWebhook

DELETE /event/{tenantLocator}/webhooks/{webhookLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
webhookLocator	path	locator	required

Response:void
Security Group:webhooks   Permission:write

See Also

• Webhooks Feature Guide: Webhooks feature guide

• Events API: API details, including a list of supported events

• Diverted Eventss API: Functionality to handle failed webhook event messages.