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:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    webhookLocatorpathlocatorrequired
    eventLocatorpathlocatorrequired
    Security Group:diverted-events   Permission:read
Fetch Multiple Diverted Events
fetchMultipleDivertedEvents
GET /event/{tenantLocator}/webhooks/{webhookLocator}/diverted
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    webhookLocatorpathlocatorrequired
    offsetqueryint?optional
    countqueryint?optional
    Security Group:diverted-events   Permissions:read,list
DivertedEventResponse
required
eventLocator locator
requestLocator locator
failureMessage string
failureTimestamp datetime
failureTrigger string
Resend Diverted Event
resendDivertedEvent
POST /event/{tenantLocator}/webhooks/{webhookLocator}/diverted/{eventLocator}/resend
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    webhookLocatorpathlocatorrequired
    eventLocatorpathlocatorrequired
    Response:object
    Security Group:diverted-events   Permission:resend
Delete Diverted Event
deleteDivertedEvent
DELETE /event/{tenantLocator}/webhooks/{webhookLocator}/diverted/{eventLocator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    webhookLocatorpathlocatorrequired
    eventLocatorpathlocatorrequired
    Response:object
    Security Group:diverted-events   Permission:delete
FailureHandlingCreateRequest
required
alertEndpoint CreateEndpointRequest
divert boolean
suspend boolean
triggers string[]
FailureHandlingUpdateRequest
required
alertEndpoint UpdateEndpointRequest
divert boolean
removeAlertEndpoint boolean
removeRetryStrategy boolean
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