Sign in

v4

latestSwagger 2.02026-08-0343714211.7 MB
event_delivery_attempts
Event Delivery Attempts

List Event Delivery Attempts

List Event Delivery Attempts

get/event_delivery_attempts

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are created_at, status, event_record_id, event_target_id or workspace_id.

If set, return records where the specified field is equal to the supplied value. Valid fields are status, workspace_id, event_record_id or event_target_id. Valid field combinations are [ workspace_id, status ], [ workspace_id, event_record_id ] or [ workspace_id, event_target_id ].

Response

A list of EventDeliveryAttempts objects.

idinteger

Event Delivery Attempt ID

event_record_idinteger

Event Record ID

event_subscription_idinteger

Event Subscription ID

event_target_idinteger

Event Target ID

workspace_idinteger

Workspace ID. 0 means the default workspace or site-wide.

status'queued' | 'success' | 'retrying' | 'failed'

Delivery status.

attempt_numberinteger

Number of delivery attempts made.

response_codeinteger

HTTP response code, if applicable.

error_messagestring

Delivery error message, if applicable.

response_bodystring

Delivery response body, if applicable.

latency_msinteger

Delivery latency in milliseconds.

delivered_atstring date-time

Successful delivery date/time.

last_attempted_atstring date-time

Most recent attempt date/time.

next_attempt_atstring date-time

Next scheduled attempt date/time.

created_atstring date-time

Delivery Attempt create date/time.

Example response

[
  {
    "id": 1,
    "event_record_id": 1,
    "event_subscription_id": 1,
    "event_target_id": 1,
    "workspace_id": 1,
    "status": "example",
    "attempt_number": 1,
    "response_code": 1,
    "error_message": "example",
    "response_body": "example",
    "latency_ms": 1,
    "delivered_at": "2000-01-01T01:00:00Z",
    "last_attempted_at": "2000-01-01T01:00:00Z",
    "next_attempt_at": "2000-01-01T01:00:00Z",
    "created_at": "2000-01-01T01:00:00Z"
  }
]