Delivery Attempts

Inspect individual delivery attempts with status codes, latency, and response bodies.

Delivery attempts track each attempt to deliver an event to a destination. Each attempt records the HTTP status code, response body, latency, and whether it was an initial delivery or a retry. Failed attempts are automatically retried according to the destination's retry policy.

List Delivery Attempts

GET /v1/delivery-attempts

List delivery attempts with optional filters for event, destination, and status.

Authentication: API key or session cookie.

Query Parameters

event_id string

Filter by event ID.

connection_id string

Filter by connection ID.

destination_id string

Filter by destination ID.

status string

Filter by attempt status (e.g., success, failed, pending).

is_dlq string

Set to "1" to only return dead-letter queue attempts.

limit number default: 50

Number of results to return (max 100).

offset number default: 0

Offset for pagination.

bash
curl "https://hookstream.io/v1/delivery-attempts?event_id=evt_d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9" \
  -H "X-API-Key: $HOOKSTREAM_API_KEY"

json
{
  "delivery_attempts": [
    {
      "id": "da_e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0",
      "event_id": "evt_d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
      "connection_id": "conn_c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8",
      "destination_id": "dst_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7",
      "destination_name": "Backend API",
      "status": "success",
      "is_dlq": 0,
      "created_at": "2026-03-01T14:30:01Z"
    }
  ],
  "pagination": {
    "total": 892,
    "limit": 50,
    "offset": 0,
    "has_more": true
  }
}

Retrieve Delivery Attempt

GET /v1/delivery-attempts/:id

Get full detail for a delivery attempt including the response body.

Authentication: API key or session cookie.

json
{
  "id": "da_e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0",
  "event_id": "evt_d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
  "destination_id": "dst_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7",
  "destination_name": "Backend API",
  "status": "success",
  "status_code": 200,
  "request_headers": { "content-type": "application/json" },
  "response_headers": { "content-type": "application/json" },
  "response_body": "{\"ok\":true}",
  "latency_ms": 42,
  "attempt_number": 1,
  "next_retry_at": null,
  "attempted_at": "2026-03-01T14:30:01Z"
}

Retry Delivery Attempt

POST /v1/delivery-attempts/:id/retry

Retry a specific failed delivery attempt immediately.

Authentication: API key or session cookie.

bash
curl -X POST https://hookstream.io/v1/delivery-attempts/da_e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0/retry \
  -H "X-API-Key: $HOOKSTREAM_API_KEY"

json
{
  "delivery_attempt": {
    "id": "da_e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0",
    "event_id": "evt_d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
    "destination_id": "dst_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7",
    "status": "pending"
  }
}

Was this page helpful?

Previous Events

Next Metrics