GET

List subscription delivery attempts

ENDPOINT/v1/webhook-subscriptions/{webhook_subscription_id}/attempts

Returns HTTP delivery attempts for one webhook subscription, newest first. Filter by status. This operation is program-scoped.

Authentication & Headers

Header	Type	Requirement	Description
Authorization	string	REQUIRED	API key passed as an HTTP Bearer token: `Bearer rk_live_...`
X-Program-ID	UUID	PROGRAM-SCOPED	Program boundary UUID that scopes the issuing card, wallet, or transfer.

Path Parameters

Parameter	Type	Requirement	Description
webhook_subscription_id	string	REQUIRED	Unique identifier of the webhook subscription.

Query Parameters

Parameter	Type	Requirement	Description
status	string	OPTIONAL	Return only delivery attempts in this status. Allowed:`PENDINGSUCCESSFAILED`
page	integer	OPTIONAL	1-based page index. Default 1. Values below 1 are treated as 1.
page_size	integer	OPTIONAL	Number of objects to return in the page. Minimum 1, maximum 100, default 10. Also accepted as `page-size`. Values below 1 fall back to the default; values above 100 are capped at 100.
order_by	string	OPTIONAL	Field to sort by. When omitted, the endpoint uses its default order. Also accepted as `order-by`. Valid fields are endpoint-specific (`created_at`, `updated_at`, …).
ascending	boolean	OPTIONAL	Sort direction. Default true (ascending). Pass `false` for descending. Invalid values are ignored and the default is used.

Response Codes & Schemas

200A page of webhook attempts for this subscription.

application/json

{
  "data": [
    {
      "id": "f14d7f13-5e80-42a2-d61a-2f0e484c5df6",
      "object": "webhook_attempt",
      "event_id": "6e1a4c80-2b5d-4f19-a3e7-9c0d8b1f2463",
      "webhook_subscription_id": "e03c6e02-4d7f-4191-c509-1efd373b4ce5",
      "status": "SUCCESS",
      "response_code": 200,
      "response_body": "{\"received\":true}",
      "attempted_at": "2026-08-12T10:15:01Z",
      "created_at": "2026-08-12T10:15:01Z",
      "updated_at": "2026-08-12T10:15:01Z"
    },
    {
      "id": "0a5e8024-6f91-43b3-e72b-30412f5d6918",
      "object": "webhook_attempt",
      "event_id": "6e1a4c80-2b5d-4f19-a3e7-9c0d8b1f2463",
      "webhook_subscription_id": "e03c6e02-4d7f-4191-c509-1efd373b4ce5",
      "status": "FAILED",
      "response_code": 500,
      "response_body": "{\"error\":\"internal\"}",
      "attempted_at": "2026-08-12T10:16:01Z",
      "created_at": "2026-08-12T10:16:01Z",
      "updated_at": "2026-08-12T11:16:01Z"
    }
  ],
  "total_count": 2
}

400Bad Request: malformed JSON, failed schema validation, or conflicting parameters.

application/json

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "invalid order by: foo. Valid options are: [created_at updated_at]",
    "param": "order_by",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/invalid_request"
  }
}

401Unauthorized: missing, malformed, or unknown API key.

application/json

{
  "error": {
    "type": "authentication_error",
    "code": "authentication_error",
    "message": "A valid API key is required.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/authentication_error"
  }
}

403Forbidden: the API key is denied by RBAC, or it cannot access this program. A resource that exists on another program or organization returns `404 not_found`, not `403`.

application/json

{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The API key cannot access this program.",
    "param": "X-Program-ID",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/permission_denied"
  }
}

404Not Found: unknown id, or the resource is not visible to this API key.

application/json

{
  "error": {
    "type": "not_found_error",
    "code": "not_found",
    "message": "No card found for the given id.",
    "param": "card_id",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/not_found"
  }
}

429Too Many Requests: the API key exceeded its rate limit.

application/json

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limited",
    "message": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/rate_limited"
  }
}

500Internal Server Error: unexpected failure. Retry with the same Idempotency-Key.

application/json

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected error occurred. Retry with the same Idempotency-Key.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/internal_error"
  }
}