Retrieve Failed Webhook Events

This endpoint retrieves details of webhook events that failed within a specified time range, up to a maximum window of 1 day, going back as far as the last 30 days

A failed webhook event is defined as an event where Carriyo received a non-200 response from the client's endpoint.

Use start_date and end_date in ISO 8601 format (e.g., 2023-03-22T10:15:30.123Z) to specify the time range for retrieval.

SecurityOAuth2.0
Request
query Parameters
webhook_id
required
string

ID of the Carriyo webhook configuration

Example: webhook_id=ACCOUNT_w1234-5678-abcd
start_date
required
string

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

Example: start_date=2023-03-22T10:15:30.123Z
end_date
required
string

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

Example: end_date=2023-03-22T10:15:30.123Z
header Parameters
x-api-key
required
string
tenant-id
required
string
Content-Type
string
Default: application/json
Responses
200

Success Response

400

Error Response

get/webhooks/failed-events
Request samples 
Response samples 
application/json
{
  • "original_failure_count": 10,
  • "current_failure_count": 1,
  • "failed_events": [
    ]
}