Diverted Events API

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

Fetch Diverted Event

fetchDivertedEvent

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
webhookLocator	path	string	required
eventLocator	path	string	required

Response:DivertedEventResponse
Security Group:diverted-events   Permission:read

Fetch Multiple Diverted Events

fetchMultipleDivertedEvents

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
webhookLocator	path	string	required
offset	query	int?	optional
count	query	int?	optional

Response:DivertedEventResponse[]
Security Group:diverted-events   Permissions:read,list

DivertedEventResponse

required
eventLocator string
requestLocator string
failureMessage string
failureTimestamp datetime
failureTrigger string

Resend Diverted Event

resendDivertedEvent

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
webhookLocator	path	string	required
eventLocator	path	string	required

Response:object
Security Group:diverted-events   Permission:resend

Delete Diverted Event

deleteDivertedEvent

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
webhookLocator	path	string	required
eventLocator	path	string	required

Response:object
Security Group:diverted-events   Permission:delete

FailureHandlingCreateRequest

required
alertEndpoint CreateEndpointRequest
divert boolean
retryStrategy RetryStrategyCreateRequest
suspend boolean
triggers string[]

FailureHandlingUpdateRequest

required
alertEndpoint UpdateEndpointRequest
divert boolean
removeAlertEndpoint boolean
removeRetryStrategy boolean
retryStrategy RetryStrategyUpdateRequest
suspend boolean
addTriggers string[]
removeTriggers string[]

FailureHandlingResponse

required
alertEndpoint EndpointResponse
divert boolean
retryStrategy RetryStrategyResponse
suspend boolean
triggers string[]

RetryStrategyCreateRequest

required
attempts int
interval int
type Enum linear | exponential

RetryStrategyResponse

required
attempts int
interval int
type Enum linear | exponential

RetryStrategyUpdateRequest

required
attempts int
interval int
type Enum linear | exponential

See Also

• Events Feature Guide

• Webhooks Feature Guide

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