Diverted Events API
This API Guide describes functionality for handling failed webhook event messages.
GET /event/{tenantLocator}/webhooks/{webhookLocator}/diverted/{eventLocator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
webhookLocator | path | locator | required |
eventLocator | path | locator | required |
Response:DivertedEventResponse
Security Group:diverted-events  Permission:read
GET /event/{tenantLocator}/webhooks/{webhookLocator}/diverted
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
webhookLocator | path | locator | required |
offset | query | int? | optional |
count | query | int? | optional |
Response:DivertedEventResponse[]
Security Group:diverted-events  Permissions:read,list
DivertedEventResponse
¶requiredeventLocator locatorrequestLocator locatorfailureMessage stringfailureTimestamp datetimefailureTrigger string
POST /event/{tenantLocator}/webhooks/{webhookLocator}/diverted/{eventLocator}/resend
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
webhookLocator | path | locator | required |
eventLocator | path | locator | required |
Response:object
Security Group:diverted-events  Permission:resend
DELETE /event/{tenantLocator}/webhooks/{webhookLocator}/diverted/{eventLocator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
webhookLocator | path | locator | required |
eventLocator | path | locator | required |
Response:object
Security Group:diverted-events  Permission:delete
FailureHandlingCreateRequest
¶requiredalertEndpoint CreateEndpointRequestdivert booleanretryStrategy RetryStrategyCreateRequestsuspend booleantriggers string[]
FailureHandlingUpdateRequest
¶requiredalertEndpoint UpdateEndpointRequestdivert booleanremoveAlertEndpoint booleanremoveRetryStrategy booleanretryStrategy RetryStrategyUpdateRequestsuspend booleanaddTriggers string[]removeTriggers string[]
FailureHandlingResponse
¶requiredalertEndpoint EndpointResponsedivert booleanretryStrategy RetryStrategyResponsesuspend booleantriggers string[]
RetryStrategyCreateRequest
¶requiredattempts intinterval inttype Enum linear | exponential
RetryStrategyResponse
¶requiredattempts intinterval inttype Enum linear | exponential
RetryStrategyUpdateRequest
¶requiredattempts intinterval inttype Enum linear | exponential
See Also
Events API: Events API details, including a list of supported events