Webhooks API

Fetch a Webhook
fetchWebhook
GET /event/{tenantLocator}/webhooks/{webhookLocator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    webhookLocatorpathlocatorrequired
    Security Group:webhooks   Permission:read
Fetch All Webhooks
fetchWebhooks
GET /event/{tenantLocator}/webhooks/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    offsetqueryint?optional
    countqueryint?optional
    namequerystring?optional
    enabledqueryboolean?optional
    suspendedqueryboolean?optional
    activequeryboolean?optional
    eventTypesquerystring[]?optional
    extendedqueryboolean?optional
    Security Group:webhooks   Permissions:read,list
WebhookListResponse
required
listCompleted boolean
WebhookResponse
required
locator locator
name string
enabled boolean
failureHandling FailureHandlingResponse
suspended boolean
suspendedAt datetime
eventTypes string[]
EndpointResponse
required
hmacEnabled boolean
secret string
secureSsl boolean
tag string
url string
headers map<string,string[]>
Create a Webhook
createWebhook
POST /event/{tenantLocator}/webhooks
CreateWebhookRequest
required
name string
enabled boolean
eventTypes string[]
CreateEndpointRequest
required
url string

optional
hmacEnabled boolean?
secret string?
secureSsl boolean?
tag string?
headers map<string,string[]>?
Update a Webhook
updateWebhook
PATCH /event/{tenantLocator}/webhooks/{webhookLocator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    webhookLocatorpathlocatorrequired
    Security Group:webhooks   Permission:write

Note

This endpoint follows Socotra Insurance Suite’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
removeFailureHandling boolean
addEventTypes string[]
removeEventTypes string[]
UpdateEndpointRequest
required
url string
addHeaders map<string,string[]>
removeHeaders string[]

optional
hmacEnabled boolean?
secret string?
secureSsl boolean?
tag string?
Unsuspend Webhook
unsuspendWebhook
PATCH /event/{tenantLocator}/webhooks/{webhookLocator}/unsuspend
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    webhookLocatorpathlocatorrequired
    Response:void
    Security Group:webhooks   Permission:write
Delete a Webhook
deleteWebhook
DELETE /event/{tenantLocator}/webhooks/{webhookLocator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    webhookLocatorpathlocatorrequired
    Response:void
    Security Group:webhooks   Permission:write

See Also