Diverted Events API

This API Guide describes functionality for handling failed webhook event messages.

Action	Endpoint
Fetch Diverted Event	GET/event/{tenantLocator}/webhooks/{webhookLocator}/diverted/{eventLocator}
Fetch Multiple Diverted Events	GET/event/{tenantLocator}/webhooks/{webhookLocator}/diverted
Resend Diverted Event	POST/event/{tenantLocator}/webhooks/{webhookLocator}/diverted/{eventLocator}/resend
Delete Diverted Event	DELETE/event/{tenantLocator}/webhooks/{webhookLocator}/diverted/{eventLocator}

Fetch Diverted Event

Fetch Diverted EventfetchDivertedEvent

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

Parameters

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

Response:DivertedEventResponse

Security Group:diverted-events

Permission:

read

Fetch Multiple Diverted Events

Fetch Multiple Diverted EventsfetchMultipleDivertedEvents

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`webhookLocator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:DivertedEventResponse[]

Security Group:diverted-events

Permissions:

read,list

DivertedEventResponse

Required properties

Property	Type	Description
`eventLocator`	`ulid`
`requestLocator`	`ulid`
`failureMessage`	`string`
`failureTimestamp`	`datetime`
`failureTrigger`	`string`

Resend Diverted Event

Resend Diverted EventresendDivertedEvent

POST/event/{tenantLocator}/webhooks/{webhookLocator}/diverted/{eventLocator}/resend

Parameters

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

Response:object

Security Group:diverted-events

Permission:

resend

Delete Diverted Event

Delete Diverted EventdeleteDivertedEvent

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

Parameters

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

Response:object

Security Group:diverted-events

Permission:

delete

FailureHandlingCreateRequest

Required properties

Property	Type	Description
`alertEndpoint`	`CreateEndpointRequest`
`divert`	`boolean`
`retryStrategy`	`RetryStrategyCreateRequest`
`suspend`	`boolean`
`triggers`	`string[]`

FailureHandlingUpdateRequest

Required properties

Property	Type	Description
`alertEndpoint`	`UpdateEndpointRequest`
`divert`	`boolean`
`removeAlertEndpoint`	`boolean`
`removeRetryStrategy`	`boolean`
`retryStrategy`	`RetryStrategyUpdateRequest`
`suspend`	`boolean`
`addTriggers`	`string[]`
`removeTriggers`	`string[]`

FailureHandlingResponse

Required properties

Property	Type	Description
`alertEndpoint`	`EndpointResponse`
`divert`	`boolean`
`retryStrategy`	`RetryStrategyResponse`
`suspend`	`boolean`
`triggers`	`string[]`

RetryStrategyCreateRequest

Required properties

Property	Type	Description
`attempts`	`integer`
`interval`	`integer`
`type`	`Enum linear \| exponential`

RetryStrategyResponse

Required properties

Property	Type	Description
`attempts`	`integer`
`interval`	`integer`
`type`	`Enum linear \| exponential`

RetryStrategyUpdateRequest

Required properties

Property	Type	Description
`attempts`	`integer`
`interval`	`integer`
`type`	`Enum linear \| exponential`

Diverted Events API

Fetch Diverted Event

Fetch Multiple Diverted Events

Resend Diverted Event

Delete Diverted Event

See Also

On this page