# Diverted Events API



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

<EndpointIndex
  names={[
  	'fetchDivertedEvent',
  	'fetchMultipleDivertedEvents',
  	'resendDivertedEvent',
  	'deleteDivertedEvent',
  ]}
/>

Fetch Diverted Event [#fetch-diverted-event]

<ApiEndpoint name="fetchDivertedEvent" />

Fetch Multiple Diverted Events [#fetch-multiple-diverted-events]

<ApiEndpoint name="fetchMultipleDivertedEvents" />

<ApiSchema name="DivertedEventResponse" />

Resend Diverted Event [#resend-diverted-event]

<ApiEndpoint name="resendDivertedEvent" />

Delete Diverted Event [#delete-diverted-event]

<ApiEndpoint name="deleteDivertedEvent" />

<ApiSchema name="FailureHandlingCreateRequest" />

<ApiSchema name="FailureHandlingUpdateRequest" />

<ApiSchema name="FailureHandlingResponse" />

<ApiSchema name="RetryStrategyCreateRequest" />

<ApiSchema name="RetryStrategyResponse" />

<ApiSchema name="RetryStrategyUpdateRequest" />

See Also [#see-also]

* [Events Feature Guide](/configuration/general-topics/events)
* [Webhooks Feature Guide](/configuration/general-topics/webhooks)
* [Events API](/api/events/events): Events API details, including a list of supported events


## API Reference

GET /event/{tenantLocator}/webhooks/{webhookLocator}/diverted/{eventLocator} — fetchDivertedEvent
Tags: diverted-events-controller
Permissions: read
Parameters:
  tenantLocator (uuid, path, required)
  webhookLocator (ulid, path, required)
  eventLocator (ulid, path, required)
Responses:
  200 DivertedEventResponse — OK

GET /event/{tenantLocator}/webhooks/{webhookLocator}/diverted — fetchMultipleDivertedEvents
Tags: diverted-events-controller
Permissions: read, list
Parameters:
  tenantLocator (uuid, path, required)
  webhookLocator (ulid, path, required)
  offset (integer, query)
  count (integer, query)
Responses:
  200 DivertedEventResponse[] — OK

POST /event/{tenantLocator}/webhooks/{webhookLocator}/diverted/{eventLocator}/resend — resendDivertedEvent
Tags: diverted-events-controller
Permissions: resend
Parameters:
  tenantLocator (uuid, path, required)
  webhookLocator (ulid, path, required)
  eventLocator (ulid, path, required)
Responses:
  200 object — OK

DELETE /event/{tenantLocator}/webhooks/{webhookLocator}/diverted/{eventLocator} — deleteDivertedEvent
Tags: diverted-events-controller
Permissions: delete
Parameters:
  tenantLocator (uuid, path, required)
  webhookLocator (ulid, path, required)
  eventLocator (ulid, path, required)
Responses:
  200 object — OK

DivertedEventResponse
Properties:
  requestLocator (ulid, required)
  eventLocator (ulid, required)
  failureTrigger (string, required)
  failureMessage (string, required)
  failureTimestamp (datetime, required)

FailureHandlingCreateRequest
Properties:
  alertEndpoint (CreateEndpointRequest, required)
  triggers (string[], required)
  retryStrategy (RetryStrategyCreateRequest, required)
  divert (boolean, required)
  suspend (boolean, required)

FailureHandlingUpdateRequest
Properties:
  removeAlertEndpoint (boolean, required)
  alertEndpoint (UpdateEndpointRequest, required)
  removeTriggers (string[], required)
  addTriggers (string[], required)
  removeRetryStrategy (boolean, required)
  retryStrategy (RetryStrategyUpdateRequest, required)
  divert (boolean, required)
  suspend (boolean, required)

FailureHandlingResponse
Properties:
  alertEndpoint (EndpointResponse, required)
  triggers (string[], required)
  retryStrategy (RetryStrategyResponse, required)
  divert (boolean, required)
  suspend (boolean, required)

RetryStrategyCreateRequest
Properties:
  type (Enum linear | exponential, required)
  interval (integer, required)
  attempts (integer, required)

RetryStrategyResponse
Properties:
  type (Enum linear | exponential, required)
  interval (integer, required)
  attempts (integer, required)

RetryStrategyUpdateRequest
Properties:
  type (Enum linear | exponential, required)
  interval (integer, required)
  attempts (integer, required)