Webhooks API
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
GET /event/{tenantLocator}/webhooks/listRequest 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
¶requiredlocator locatorname stringenabled booleanendpoint EndpointResponsefailureHandling FailureHandlingResponsesuspended booleansuspendedAt datetimeeventTypes string[]
EndpointResponse
¶requiredurl stringheaders map<string,string[]>
POST /event/{tenantLocator}/webhooksRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
Request:CreateWebhookRequest
Response:WebhookResponse
Security Group:webhooks  Permission:write
CreateWebhookRequest
¶requiredname stringenabled booleanendpoint CreateEndpointRequestfailureHandling FailureHandlingCreateRequesteventTypes string[]
CreateEndpointRequest
¶requiredurl stringheaders map<string,string[]>
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
¶requiredname stringenabled booleanendpoint UpdateEndpointRequestfailureHandling FailureHandlingUpdateRequestremoveFailureHandling booleanaddEventTypes string[]removeEventTypes string[]
UpdateEndpointRequest
¶requiredurl stringaddHeaders map<string,string[]>removeHeaders string[]
PATCH /event/{tenantLocator}/webhooks/{webhookLocator}/unsuspendRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| webhookLocator | path | locator | required |
Response:void
Security Group:webhooks  Permission:write
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.