List deliveries

GET

https://api.spreadspace.app/api/webhooks/:id/deliveries

GET

/api/webhooks/:id/deliveries

curl https://api.spreadspace.app/api/webhooks/3fa85f64-5717-4562-b3fc-2c963f66afa6/deliveries \
     -H "Authorization: Bearer <token>"

{
  "data": [
    {
      "id": "a3f1c9e2-4b7d-4f2a-9c3e-1d2b5f6a7e8c",
      "event_id": "0f9e8d7c-6b5a-4938-a1b2-c3d4e5f6a7b8",
      "event_type": "document.processed",
      "status": "delivered",
      "attempts": 1,
      "created_at": "2024-06-01T15:22:30.563524+00:00",
      "event_ref": "evt_0f9e8d7c6b5a4938a1b2c3d4",
      "loan_id": "9f8b7c6d5e4a3b2c1d0e4f5a",
      "next_attempt_at": null,
      "last_response_status": 200,
      "delivered_at": "2024-06-01T15:22:31.387502+00:00",
      "dead_at": null
    },
    {
      "id": "b4e2d3f1-5c6a-4b7e-8d9f-0a1b2c3d4e5f",
      "event_id": "1a2b3c4d-5e6f-4708-9a0b-c1d2e3f4a5b6",
      "event_type": "document.failed",
      "status": "pending",
      "attempts": 1,
      "created_at": "2024-06-01T14:10:05.686278+00:00",
      "event_ref": "evt_1a2b3c4d5e6f47089a0bc1d2",
      "loan_id": "9876543210abcdef98765432",
      "next_attempt_at": "2024-06-01T14:40:05.077096+00:00",
      "last_response_status": 503,
      "delivered_at": null,
      "dead_at": null
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Lists delivery attempts for one endpoint, newest first.

Requires the webhooks:read scope. Rate limit: 200 requests per minute per key (the api lane).

Authentication

AuthorizationBearer

Bearer token. Use ss_live_… for live data or ss_test_… for the sandbox (test mode). See Authentication.

Path parameters

idstringRequiredformat: "uuid"

The webhook endpoint whose deliveries to list (revoked endpoints included); 404 when no endpoint with this id belongs to the caller’s tenant.

Query parameters

limitintegerOptional1-100Defaults to 50

Page size, 1-100 (default 50). A value outside that range is refused with a 400 invalid_limit, not clamped.

cursorstringOptional

The opaque next_cursor from the previous page, passed back verbatim; omit it to start from the newest delivery (pages run newest first). A malformed or altered cursor is a 400 invalid_cursor; one from a retired cursor format, a 400 cursor_expired.

statusstringOptional

Only deliveries in this state: pending, delivered or dead. Matched exactly, so a value no delivery carries returns an empty page.

event_typestringOptional

Only deliveries of this event type, e.g. document.processed. Matched exactly against the delivery’s event_type; no wildcard.

loan_idstringOptional

Only deliveries whose event was about this loan (the payload’s data.loan_id).

Response headers

X-Request-IDstringOptional

Correlation ID for this request. Quote it in support tickets.

SpreadSpace-VersionstringOptional

The API surface version the server resolved for this request. Always present, regardless of whether the client supplied the request-side SpreadSpace-Version header. Default: 2026-10-07.

RateLimit-Limitinteger

Request budget of the endpoint’s rate-limit policy per 60-second sliding window. See Rate limits.

RateLimit-Remaininginteger

Requests left in the current window. Suppressed on 429 responses produced outside the rate limiter (for example a usage throttle), where a remaining budget would be misleading.

RateLimit-Resetinteger

Seconds until a guaranteed-fresh window.

RateLimit-PolicystringOptional

The active policy in limit;w=window-seconds form.

Response

datalist of objects

has_moreboolean

next_cursorstring or nullOptional

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error