Webhooks API

Action	Endpoint
Fetch a Webhook	GET/event/{tenantLocator}/webhooks/{webhookLocator}
Fetch All Webhooks	GET/event/{tenantLocator}/webhooks/list
Create a Webhook	POST/event/{tenantLocator}/webhooks
Update a Webhook	PATCH/event/{tenantLocator}/webhooks/{webhookLocator}
Unsuspend Webhook	PATCH/event/{tenantLocator}/webhooks/{webhookLocator}/unsuspend
Delete a Webhook	DELETE/event/{tenantLocator}/webhooks/{webhookLocator}

Fetch a Webhook

Fetch a WebhookfetchWebhook

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`webhookLocator`	path	`ulid`	Yes

Response:WebhookResponse

Security Group:webhooks

Permission:

read

Fetch All Webhooks

Fetch All WebhooksfetchWebhooks

GET/event/{tenantLocator}/webhooks/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`name`	query	`string?`	No
`enabled`	query	`boolean?`	No
`suspended`	query	`boolean?`	No
`active`	query	`boolean?`	No
`eventTypes`	query	`string[]?`	No
`extended`	query	`boolean?`	No

Response:WebhookListResponse

Security Group:webhooks

Permissions:

read,list

WebhookListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`WebhookResponse[]`

WebhookResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`name`	`string`
`enabled`	`boolean`
`endpoint`	`EndpointResponse`
`failureHandling`	`FailureHandlingResponse`
`suspended`	`boolean`
`suspendedAt`	`datetime`
`eventTypes`	`string[]`

EndpointResponse

Required properties

Property	Type	Description
`hmacEnabled`	`boolean`
`secret`	`string`
`secureSsl`	`boolean`
`tag`	`string`
`url`	`string`
`headers`	`map<string, string[]>`

Create a Webhook

Create a WebhookcreateWebhook

POST/event/{tenantLocator}/webhooks

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Request:CreateWebhookRequest

Response:WebhookResponse

Security Group:webhooks

Permission:

write

CreateWebhookRequest

Required properties

Property	Type	Description
`name`	`string`
`enabled`	`boolean`
`endpoint`	`CreateEndpointRequest`
`failureHandling`	`FailureHandlingCreateRequest`
`eventTypes`	`string[]`

Optional properties

Property	Type	Description
`useAutomationPlugin`	`boolean?`

CreateEndpointRequest

Required properties

Property	Type	Description
`url`	`string`

Optional properties

Property	Type	Description
`hmacEnabled`	`boolean?`
`secret`	`string?`
`secureSsl`	`boolean?`
`tag`	`string?`
`headers`	`map<string, string[]>?`

Update a Webhook

Update a WebhookupdateWebhook

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`webhookLocator`	path	`ulid`	Yes

Request:UpdateWebhookRequest

Response:WebhookResponse

Security Group:webhooks

Permission:

write

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 properties

Property	Type	Description
`name`	`string`
`enabled`	`boolean`
`endpoint`	`UpdateEndpointRequest`
`failureHandling`	`FailureHandlingUpdateRequest`
`removeFailureHandling`	`boolean`
`addEventTypes`	`string[]`
`removeEventTypes`	`string[]`

UpdateEndpointRequest

Required properties

Property	Type	Description
`url`	`string`
`addHeaders`	`map<string, string[]>`
`removeHeaders`	`string[]`

Optional properties

Property	Type	Description
`hmacEnabled`	`boolean?`
`secret`	`string?`
`secureSsl`	`boolean?`
`tag`	`string?`

Unsuspend Webhook

Unsuspend WebhookunsuspendWebhook

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`webhookLocator`	path	`ulid`	Yes

Response:void

Security Group:webhooks

Permission:

write

Delete a Webhook

Delete a WebhookdeleteWebhook

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`webhookLocator`	path	`ulid`	Yes

Response:void

Security Group:webhooks

Permission:

write

Webhooks API

Fetch a Webhook

Fetch All Webhooks

Create a Webhook

Update a Webhook

Unsuspend Webhook

Delete a Webhook

See Also

On this page