> ## Documentation Index > Fetch the complete documentation index at: https://docs.closient.com/llms.txt > Use this file to discover all available pages before exploring further. # List webhook deliveries > Recent delivery attempts across **every** endpoint on the authenticated organization, ordered most-recent first. Each row is a single attempt — replays produce a new row rather than mutating the prior one. Filter by endpoint, lifecycle status, event type, and a ``created_at`` date range. Page size is fixed at 50. ## OpenAPI ````yaml /openapi/openapi-integrations.json get /integrations/api/v1/webhooks/deliveries/ openapi: 3.1.0 info: title: Integrations API version: 1.0.0 description: > Webhook endpoint management and delivery tracking. ## Authentication All endpoints require an API key passed via the `X-API-Key` HTTP header, unless otherwise noted. ``` X-API-Key: csb__ ``` Generate API keys in **Settings > API Keys** in your dashboard, or via the Account API. Session-based (cookie) authentication is also accepted for browser-based access. ## Rate Limits | Tier | Requests / minute | Requests / day | |-------------|-------------------|----------------| | Default | 300 | 10,000 | | Custom | Contact us | Contact us | Rate-limit headers are included on every response so callers can self-throttle without hitting our 429s ("informed governor"): - `RateLimit-Policy` — every active window, e.g. `300;w=60, 10000;w=86400` - `RateLimit-Limit` — quota for the **most-restrictive** currently-active window - `RateLimit-Remaining` — requests left in that window - `RateLimit-Reset` — seconds until that window resets (relative; clock-skew safe) Legacy `X-RateLimit-*` aliases are also emitted for back-compat. `X-RateLimit-Reset` keeps the absolute Unix-timestamp shape to avoid breaking existing consumers. When rate-limited, you receive `429 Too Many Requests` with a `retry_after_seconds` field in the error envelope and a `Retry-After` header. ## Pagination List endpoints return paginated results in this envelope: ```json { "data": [...], "pagination": { "page": 1, "page_size": 25, "total_count": 342, "total_pages": 14, "has_next": true, "has_previous": false } } ``` Use `?page=2&page_size=50` query parameters. Maximum page size is 100. ## Error Responses All errors conform to [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) with `Content-Type: application/problem+json`: ```json { "type": "https://closient.com/docs/errors/not_found", "title": "Not Found", "status": 404, "detail": "The requested resource was not found.", "error_code": "not_found", "retryable": false, "timestamp": "2026-03-31T12:00:00+00:00" } ``` Common error codes: `unauthorized` (401), `forbidden` (403), `not_found` (404), `validation_error` (422), `rate_limited` (429), `internal_error` (500). termsOfService: https://www.closient.com/terms/ servers: - url: https://www.closient.com security: [] tags: - name: Webhook Endpoints description: Register and manage webhook delivery endpoints. - name: Webhook Deliveries description: Track and replay webhook delivery attempts. externalDocs: description: Closient Documentation url: https://docs.closient.com paths: /integrations/api/v1/webhooks/deliveries/: get: tags: - Webhook Deliveries summary: List webhook deliveries description: >- Recent delivery attempts across **every** endpoint on the authenticated organization, ordered most-recent first. Each row is a single attempt — replays produce a new row rather than mutating the prior one. Filter by endpoint, lifecycle status, event type, and a ``created_at`` date range. Page size is fixed at 50. operationId: apps_integrations_webhooks_api_list_deliveries_view parameters: - in: query name: endpoint_id schema: anyOf: - type: string - type: 'null' description: >- Filter deliveries down to a single webhook endpoint by UUID. Omit to include deliveries across every endpoint on the authenticated organization. title: Endpoint Id required: false description: >- Filter deliveries down to a single webhook endpoint by UUID. Omit to include deliveries across every endpoint on the authenticated organization. - in: query name: status schema: anyOf: - $ref: '#/components/schemas/DeliveryStatusEnum' - type: 'null' description: >- Filter by delivery lifecycle state. ``dead_letter`` returns deliveries that exhausted their retry budget and need manual replay; ``rate_limited`` returns the 429-bucket separately from genuine ``failed`` retries. required: false description: >- Filter by delivery lifecycle state. ``dead_letter`` returns deliveries that exhausted their retry budget and need manual replay; ``rate_limited`` returns the 429-bucket separately from genuine ``failed`` retries. - in: query name: event_type schema: anyOf: - maxLength: 100 type: string - type: 'null' description: >- Filter to a single event-type string (exact match, e.g. ``offer.updated``). Wildcards are not supported — issue one request per event type. title: Event Type required: false description: >- Filter to a single event-type string (exact match, e.g. ``offer.updated``). Wildcards are not supported — issue one request per event type. - in: query name: created_after schema: anyOf: - type: string - type: 'null' description: >- Inclusive lower bound on the delivery's ``created_at`` (ISO 8601 timestamp). title: Created After required: false description: >- Inclusive lower bound on the delivery's ``created_at`` (ISO 8601 timestamp). - in: query name: created_before schema: anyOf: - type: string - type: 'null' description: >- Inclusive upper bound on the delivery's ``created_at`` (ISO 8601 timestamp). title: Created Before required: false description: >- Inclusive upper bound on the delivery's ``created_at`` (ISO 8601 timestamp). - in: query name: page schema: default: 1 description: Page number (1-indexed). minimum: 1 title: Page type: integer required: false description: Page number (1-indexed). - in: query name: page_size schema: default: 25 description: Number of items per page (max 100). maximum: 100 minimum: 1 title: Page Size type: integer required: false description: Number of items per page (max 100). responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedDeliveryResponseSchema' security: - APIKeyHeaderAuth: [] - OAuthTokenAuth: [] - SessionAuth: [] components: schemas: DeliveryStatusEnum: description: >- Lifecycle status of a single :class:`~apps.integrations.models.WebhookDelivery`. Mirrors :class:`apps.integrations.models.WebhookDelivery.Status` (and the standalone :class:`apps.integrations.models.DeliveryStatus`, which carry identical values). State transitions:: pending ──► delivered (2xx response, terminal success) pending ──► failed ──► pending (retried with backoff) pending ──► rate_limited ──► pending (429 response, retried) failed ──► dead_letter (max attempts exceeded, terminal) ``rate_limited`` is reported separately from ``failed`` so customers can dashboard 429s without inflating their failure rate. ``dead_letter`` deliveries can be re-queued via ``POST /webhooks/deliveries/{id}/replay/``. enum: - pending - delivered - failed - rate_limited - dead_letter title: DeliveryStatusEnum type: string PagedDeliveryResponseSchema: properties: data: description: >- Items on the current page, each conforming to the endpoint's item schema. Empty when the result set is empty or ``page`` is past the end. items: $ref: '#/components/schemas/DeliveryResponseSchema' title: Data type: array pagination: $ref: '#/components/schemas/PaginationMeta' description: Pagination envelope describing position within the full result set. required: - data - pagination title: PagedDeliveryResponseSchema type: object DeliveryResponseSchema: description: |- A single webhook delivery attempt as read from the API. Returned by ``GET /webhooks/deliveries/`` (paged list). The response body is intentionally truncated to 256 characters; Closient does not retain full bodies. examples: - attempts: 1 created_at: '2025-08-15T16:30:00Z' endpoint_id: f47ac10b-58cc-4372-a567-0e02b2c3d479 event_id: evt_abc123def456 event_type: offer.updated http_status_code: 200 id: e6f7a8b9-0123-4567-abcd-ef8901234567 last_attempted_at: '2025-08-15T16:30:01Z' response_body: '{"received": true}' status: delivered properties: id: description: >- UUID identifier of the delivery attempt record. Use this in ``POST /webhooks/deliveries/{delivery_id}/replay/``. format: uuid title: Id type: string endpoint_id: description: >- UUID identifier of the endpoint. Use this in path params and the deliveries-list ``endpoint_id`` filter. format: uuid title: Endpoint Id type: string event_id: description: >- Stable identifier of the event being delivered (e.g. ``evt_abc123``). Identical across retry attempts of the same event, so customers can deduplicate at the consumer side using this value as an idempotency key. maxLength: 255 title: Event Id type: string event_type: description: >- The event-type string carried by this delivery — same shape as the values in ``WebhookEndpoint.event_types`` (e.g. ``offer.updated``). maxLength: 100 title: Event Type type: string status: $ref: '#/components/schemas/DeliveryStatusEnum' description: >- Lifecycle state of the delivery attempt. ``pending`` deliveries are awaiting their next retry; ``delivered`` is terminal-success; ``failed`` is mid-retry-backoff; ``rate_limited`` is a 429 response (retried separately so 429s don't inflate failure rates); ``dead_letter`` is terminal-failure after retries are exhausted and must be replayed via the deliveries-replay endpoint to attempt again. http_status_code: anyOf: - maximum: 599 minimum: 100 type: integer - type: 'null' description: >- HTTP status code returned by the customer endpoint on the most recent attempt. ``null`` while the delivery is enqueued but has not been attempted yet, or when the request errored before a response was received (DNS / TLS / connect timeout). title: Http Status Code response_body: default: '' description: >- First 256 characters of the customer endpoint's response body — kept for debugging only and intentionally truncated to bound storage. The full response body is not retained. maxLength: 256 title: Response Body type: string attempts: default: 0 description: >- Number of delivery attempts made so far, including the current one. Resets only when a delivery is replayed; the replay creates a new delivery record with ``attempts=0``. minimum: 0 title: Attempts type: integer last_attempted_at: anyOf: - format: date-time type: string - type: 'null' description: >- Server-side ISO 8601 timestamp (UTC) of the most recent attempt. ``null`` while a delivery is enqueued but not yet attempted. title: Last Attempted At created_at: description: >- Server-side ISO 8601 timestamp (UTC) of when the resource was first persisted. format: date-time title: Created At type: string required: - id - endpoint_id - event_id - event_type - status - created_at title: DeliveryResponseSchema type: object PaginationMeta: description: >- Page envelope returned alongside ``data`` on every paginated list endpoint. examples: - has_next: true has_previous: false page: 1 page_size: 25 total_count: 342 total_pages: 14 properties: page: description: >- 1-indexed page number that was returned. Echoes the ``?page=`` query parameter. examples: - 1 minimum: 1 title: Page type: integer page_size: description: >- Number of items returned in ``data`` for this page. Capped at the endpoint's ``max_page_size`` (typically 100). examples: - 25 minimum: 1 title: Page Size type: integer total_count: description: Total number of items matching the query across all pages. examples: - 342 minimum: 0 title: Total Count type: integer total_pages: description: >- Total number of pages at the current ``page_size``. Always at least 1 (an empty result still reports ``total_pages: 1``). examples: - 14 minimum: 1 title: Total Pages type: integer has_next: description: >- True when ``page < total_pages`` — clients can request ``page=page+1`` to continue. examples: - true title: Has Next type: boolean has_previous: description: >- True when ``page > 1`` — clients can request ``page=page-1`` to go back. examples: - false title: Has Previous type: boolean required: - page - page_size - total_count - total_pages - has_next - has_previous title: PaginationMeta type: object securitySchemes: APIKeyHeaderAuth: type: apiKey in: header name: X-API-Key OAuthTokenAuth: type: http scheme: bearer SessionAuth: type: apiKey in: cookie name: sessionid ````