> This page is for API. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.spreadspace.app/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.spreadspace.app/_mcp/server. # List deliveries GET https://api.spreadspace.app/api/webhooks/{id}/deliveries Lists delivery attempts for one endpoint, newest first. Requires the `webhooks:read` scope. Rate limit: 200 requests per minute per key (the `api` lane). Reference: https://docs.spreadspace.app/api/api-reference/webhooks/list-deliveries ## Authentication - `Authorization` header (bearer token, required) — Bearer token. Use `ss_live_…` for live data or `ss_test_…` for the sandbox (test mode). See [Authentication](https://docs.spreadspace.app/api/authentication). ## Request ### Path parameters - `id` (string, required) — 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 - `limit` (integer, optional, default: 50) — Page size, 1-100 (default 50). A value outside that range is refused with a 400 `invalid_limit`, not clamped. - `cursor` (string, optional) — 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`. - `status` (string, optional) — Only deliveries in this state: `pending`, `delivered` or `dead`. Matched exactly, so a value no delivery carries returns an empty page. - `event_type` (string, optional) — Only deliveries of this event type, e.g. `document.processed`. Matched exactly against the delivery's `event_type`; no wildcard. - `loan_id` (string, optional) — Only deliveries whose event was about this loan (the payload's `data.loan_id`). ### Headers - `SpreadSpace-Version` (string, optional) — Pin the API version, e.g. `2026-10-07`. Omit to get the latest. See [Versioning](https://docs.spreadspace.app/api/versioning). ## Response ### 200 OK - `data` (list of WebhookDeliverySummary, required) - `has_more` (boolean, required) - `next_cursor` (string, optional, nullable) ## Errors ### 400 Bad Request Error Bad request: validation failed, the cursor is malformed, or the API version is unknown. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 401 Unauthorized Error Unauthorized: the bearer token or API key is missing or invalid. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 402 Payment Required Error Payment required: the standard error envelope with `type` `subscription_required` when the workspace has no active or trialing subscription, or `billing_required` where a plan entitlement applies. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 403 Forbidden Error Forbidden: authentication succeeded but the caller is not permitted to perform this action, for example an API key missing the required scope, an embed session reaching a loan it was not minted for, or a feature outside the workspace's plan. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 404 Not Found Error Not found: the resource does not exist or is not visible to the calling tenant. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 429 Too Many Requests Error Too many requests: the rate limit was hit, or an idempotency-key replay is still in progress. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 500 Internal Server Error Internal server error: an unexpected failure. Quote the `request_id` in support tickets. A mutation sent with an `Idempotency-Key` replays this fault under that key rather than re-running; confirm the resource state before resending with a new key. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ## Types ### WebhookDeliverySummary - `id` (string, required) - `event_id` (string, required) - `event_type` (string, required) - `status` (enum, required) — `pending`, `delivered` or `dead`. - Allowed values: `pending`, `delivered`, `dead` - `attempts` (integer, required) - `created_at` (datetime, required) - `event_ref` (string, optional, nullable) — The event id as delivered: the envelope's `id` and the `SpreadSpace-Event-Id` header. Stable across retries; a replay creates a new delivery under the same event id. - `loan_id` (string, optional, nullable) — The loan the event was about (`data.loan_id`), when the payload carried one. - `next_attempt_at` (datetime, optional, nullable) - `last_response_status` (integer, optional, nullable) - `delivered_at` (datetime, optional, nullable) - `dead_at` (datetime, optional, nullable) ### ApiErrorBody Inner body of the canonical API error envelope. - `type` (string, required) — Stable error type identifier. Pattern-match on this value, not the human-readable message. - `message` (string, required) — Human-readable error message. Subject to wording changes; do not parse. - `request_id` (string, optional, nullable) — Per-request correlation ID (matches `X-Request-ID` response header). Quote in support tickets. - `details` (map from string to string, optional, nullable) — Structured detail. Some error types populate documented keys in every environment: a version conflict (409) carries `current_version`, the version the resource is actually at, so the client can reload and re-apply. Free-form diagnostic detail beyond those keys appears in development environments only. An `insufficient_credits` 402 carries `balance_usd`, `reserved_usd`, `in_flight_docs`, `incoming_docs` and `per_doc_reservation_usd` as decimal strings. ## Examples **Response** ```json { "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 } ``` **SDK Code** ```python import requests url = "https://api.spreadspace.app/api/webhooks/3fa85f64-5717-4562-b3fc-2c963f66afa6/deliveries" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.spreadspace.app/api/webhooks/3fa85f64-5717-4562-b3fc-2c963f66afa6/deliveries'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.spreadspace.app/api/webhooks/3fa85f64-5717-4562-b3fc-2c963f66afa6/deliveries" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.spreadspace.app/api/webhooks/3fa85f64-5717-4562-b3fc-2c963f66afa6/deliveries") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.spreadspace.app/api/webhooks/3fa85f64-5717-4562-b3fc-2c963f66afa6/deliveries") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.spreadspace.app/api/webhooks/3fa85f64-5717-4562-b3fc-2c963f66afa6/deliveries', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.spreadspace.app/api/webhooks/3fa85f64-5717-4562-b3fc-2c963f66afa6/deliveries"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.spreadspace.app/api/webhooks/3fa85f64-5717-4562-b3fc-2c963f66afa6/deliveries")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```