Retrigger Failed Webhook Events

This endpoint allows clients to manually retrigger failed webhook events when their webhook endpoint remains unavailable or fails beyond the automatic retry limit.

A failed webhook event is defined as any event where Carriyo receives a non-200 response from the client’s endpoint.

Specify a time range of up to 1 day, going back as far as the last 30 days, to retrigger failed events. Note that each call will retrigger a maximum of 1,000 events.

SecurityOAuth2.0
Request
header Parameters
x-api-key
required
string
tenant-id
required
string
Request Body schema: application/json
required
webhook_id
required
string

ID of the Carriyo webhook configuration

start_date
required
string <date-time>

The start date and time in ISO 8601 format with milliseconds. Pattern: yyyy-MM-dd'T'HH:mm:ss.SSSZ

end_date
required
string <date-time>

The end date and time in ISO 8601 format with milliseconds. Pattern: yyyy-MM-dd'T'HH:mm:ss.SSSZ

Responses
200

Success Response

400

Error Response

post/webhooks/retrigger-failed-events
Request samples
application/json
{
  • "webhook_id": "ACCOUNT_w1234-5678-abcd",
  • "start_date": "2023-03-22T10:15:30.123Z",
  • "end_date": "2023-03-22T10:15:30.123Z"
}
Response samples
application/json
{
  • "original_failure_count": 10,
  • "retriggered_count": 1,
  • "retriggered_events": [
    ]
}