{ "item": [ { "name": "v1", "description": "", "item": [ { "name": "healthz", "description": "", "item": [ { "id": "322ac087-4224-4969-9f74-bb6347d767b6", "name": "Liveness check", "request": { "name": "Liveness check", "description": { "content": "Returns 200 if the API is up. Does not require auth.", "type": "text/plain" }, "url": { "path": [ "v1", "healthz" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2faea0e4-7a13-4813-94d2-d07dc93f842b", "name": "Service is up.", "originalRequest": { "url": { "path": [ "v1", "healthz" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"healthy\",\n \"version\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "events", "description": "", "item": [ { "id": "44270c10-e7ab-4a18-bd2e-0546616d2229", "name": "Ingest an event", "request": { "name": "Ingest an event", "description": { "content": "Accepts an event and enqueues it for fan-out to all matching\nsubscriptions. Provide an `Idempotency-Key` header to safely retry;\ndedup window is 24 hours per workspace.\n", "type": "text/plain" }, "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional dedup key; requests with the same key within 24h return the original response.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"rpo4vu4v4840tckcf7i9-0c8jqnrld7j8i0ox_hwscjak2ypk8gxzka.joz_7i4th9bp82eu6y..a24wgprs5s.mdrq9u923o\",\n \"payload\": {\n \"key_0\": true,\n \"key_1\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "75c25b64-f308-419f-b0ed-8a16c03c8429", "name": "Event accepted for fan-out.", "originalRequest": { "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional dedup key; requests with the same key within 24h return the original response.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"rpo4vu4v4840tckcf7i9-0c8jqnrld7j8i0ox_hwscjak2ypk8gxzka.joz_7i4th9bp82eu6y..a24wgprs5s.mdrq9u923o\",\n \"payload\": {\n \"key_0\": true,\n \"key_1\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"payload\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"created_at\": \"\",\n \"deliveries_summary\": {\n \"total\": \"\",\n \"succeeded\": \"\",\n \"failed\": \"\",\n \"pending\": \"\"\n },\n \"idempotency_key\": \"\",\n \"source_ip\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bfbd62e-67dc-4829-8b03-229d00e452e5", "name": "Validation error.", "originalRequest": { "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional dedup key; requests with the same key within 24h return the original response.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"rpo4vu4v4840tckcf7i9-0c8jqnrld7j8i0ox_hwscjak2ypk8gxzka.joz_7i4th9bp82eu6y..a24wgprs5s.mdrq9u923o\",\n \"payload\": {\n \"key_0\": true,\n \"key_1\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dca5f1f-fb9c-4612-8efc-e348b09095b3", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional dedup key; requests with the same key within 24h return the original response.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"rpo4vu4v4840tckcf7i9-0c8jqnrld7j8i0ox_hwscjak2ypk8gxzka.joz_7i4th9bp82eu6y..a24wgprs5s.mdrq9u923o\",\n \"payload\": {\n \"key_0\": true,\n \"key_1\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65ad246c-ef7b-4b9c-8f9c-e0c245396751", "name": "Idempotency key already used with a different payload.", "originalRequest": { "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional dedup key; requests with the same key within 24h return the original response.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"rpo4vu4v4840tckcf7i9-0c8jqnrld7j8i0ox_hwscjak2ypk8gxzka.joz_7i4th9bp82eu6y..a24wgprs5s.mdrq9u923o\",\n \"payload\": {\n \"key_0\": true,\n \"key_1\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c42e6ea-3cdf-4e50-8938-7e747261461e", "name": "Workspace rate limit exceeded.", "originalRequest": { "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional dedup key; requests with the same key within 24h return the original response.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"rpo4vu4v4840tckcf7i9-0c8jqnrld7j8i0ox_hwscjak2ypk8gxzka.joz_7i4th9bp82eu6y..a24wgprs5s.mdrq9u923o\",\n \"payload\": {\n \"key_0\": true,\n \"key_1\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "725698b9-29cd-4470-8fb4-dbdf68192a31", "name": "List events", "request": { "name": "List events", "description": { "content": "Returns a cursor-paginated page of events, newest first, scoped to the caller's workspace.", "type": "text/plain" }, "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by event type (exact match).", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "created_after", "value": "" }, { "disabled": false, "description": { "content": "Opaque cursor from a prior page's `next_cursor`.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "53555832-1fa0-4859-9dcb-7e770d6ef108", "name": "Page of events, newest first.", "originalRequest": { "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by event type (exact match).", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "created_after", "value": "" }, { "disabled": false, "description": { "content": "Opaque cursor from a prior page's `next_cursor`.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"payload\": {\n \"key_0\": 9243.901128637413,\n \"key_1\": true\n },\n \"created_at\": \"\",\n \"deliveries_summary\": {\n \"total\": \"\",\n \"succeeded\": \"\",\n \"failed\": \"\",\n \"pending\": \"\"\n },\n \"idempotency_key\": \"\",\n \"source_ip\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"payload\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": 7459.280860876056,\n \"key_3\": true\n },\n \"created_at\": \"\",\n \"deliveries_summary\": {\n \"total\": \"\",\n \"succeeded\": \"\",\n \"failed\": \"\",\n \"pending\": \"\"\n },\n \"idempotency_key\": \"\",\n \"source_ip\": \"\"\n }\n ],\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73923767-0f4c-4410-8532-ed411f492e83", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by event type (exact match).", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "created_after", "value": "" }, { "disabled": false, "description": { "content": "Opaque cursor from a prior page's `next_cursor`.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "aeae0e5e-af9b-416f-9c87-6df41f3ac00e", "name": "Retrieve an event", "request": { "name": "Retrieve an event", "description": { "content": "Returns the event and a summary of its deliveries across all matching subscriptions.", "type": "text/plain" }, "url": { "path": [ "v1", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ULID of the event.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9abb9dd5-84a9-4854-a129-4d6c2fac5cfc", "name": "The event with a delivery summary.", "originalRequest": { "url": { "path": [ "v1", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ULID of the event.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"payload\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"created_at\": \"\",\n \"deliveries_summary\": {\n \"total\": \"\",\n \"succeeded\": \"\",\n \"failed\": \"\",\n \"pending\": \"\"\n },\n \"idempotency_key\": \"\",\n \"source_ip\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d429a6d-282e-4852-8652-d78b94e37997", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ULID of the event.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82e6a80d-f9f1-466d-8387-f80e077a5d3e", "name": "Resource not found in this workspace.", "originalRequest": { "url": { "path": [ "v1", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ULID of the event.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "subscriptions", "description": "", "item": [ { "id": "71a05f90-cf39-4236-a40d-52cd163d6701", "name": "Create a subscription", "request": { "name": "Create a subscription", "description": { "content": "Registers a new endpoint to receive matching events. The signing\nsecret is generated server-side and returned ONCE in the response —\nstore it now; you cannot retrieve it later (only rotate it).\n", "type": "text/plain" }, "url": { "path": [ "v1", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://\",\n \"name\": \"\",\n \"event_filter\": \"*\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "208d0d11-ce3d-46f5-a887-f3f0f6762831", "name": "Subscription created.", "originalRequest": { "url": { "path": [ "v1", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://\",\n \"name\": \"\",\n \"event_filter\": \"*\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"consecutive_failures\": \"\",\n \"created_at\": \"\",\n \"event_filter\": \"\",\n \"id\": \"\",\n \"signing_secret\": \"\",\n \"state\": \"active\",\n \"url\": \"\",\n \"name\": \"\",\n \"paused_at\": \"\",\n \"secret_rotated_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5db2c1ac-8126-45be-af7f-63661ea0202f", "name": "Validation error.", "originalRequest": { "url": { "path": [ "v1", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://\",\n \"name\": \"\",\n \"event_filter\": \"*\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc1825b4-fa50-4945-a39c-7bd1d3562bf2", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://\",\n \"name\": \"\",\n \"event_filter\": \"*\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "38605da9-62ec-41a2-90be-2a2d206a05d5", "name": "List subscriptions", "request": { "name": "List subscriptions", "description": { "content": "Cursor-paginated, scoped to the caller's workspace.", "type": "text/plain" }, "url": { "path": [ "v1", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": " (This can only be one of active,paused,disabled)", "type": "text/plain" }, "key": "state", "value": "active" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f0c93a67-6fc7-4fce-8c2a-427b21a82e4a", "name": "Page of subscriptions.", "originalRequest": { "url": { "path": [ "v1", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": " (This can only be one of active,paused,disabled)", "type": "text/plain" }, "key": "state", "value": "active" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"event_filter\": \"\",\n \"state\": \"disabled\",\n \"consecutive_failures\": \"\",\n \"created_at\": \"\",\n \"name\": \"\",\n \"paused_at\": \"\",\n \"secret_rotated_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"event_filter\": \"\",\n \"state\": \"active\",\n \"consecutive_failures\": \"\",\n \"created_at\": \"\",\n \"name\": \"\",\n \"paused_at\": \"\",\n \"secret_rotated_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "378b8acb-bed3-4ce0-8930-0ff5cb92671a", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": " (This can only be one of active,paused,disabled)", "type": "text/plain" }, "key": "state", "value": "active" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "38f6da95-2939-42a8-b5a7-91c0028229b6", "name": "Retrieve a subscription", "request": { "name": "Retrieve a subscription", "description": { "content": "Returns a single subscription without its signing secret.", "type": "text/plain" }, "url": { "path": [ "v1", "subscriptions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e52789ee-be90-4d5f-b78b-bc894a530c78", "name": "The subscription.", "originalRequest": { "url": { "path": [ "v1", "subscriptions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"url\": \"\",\n \"event_filter\": \"\",\n \"state\": \"active\",\n \"consecutive_failures\": \"\",\n \"created_at\": \"\",\n \"name\": \"\",\n \"paused_at\": \"\",\n \"secret_rotated_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8176472-6115-4ed9-b272-b942dc58a40f", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "subscriptions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86868afa-1bd2-4be6-95d8-bc22c292e630", "name": "Resource not found in this workspace.", "originalRequest": { "url": { "path": [ "v1", "subscriptions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1a08a142-3538-44fc-b9dc-d4b26179781a", "name": "Update a subscription", "request": { "name": "Update a subscription", "description": { "content": "Partial update. Mutable fields are name, url, event_filter.", "type": "text/plain" }, "url": { "path": [ "v1", "subscriptions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"https://\",\n \"event_filter\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f2a9e8f6-d4cd-43e2-a935-00b7d57247b6", "name": "Updated subscription.", "originalRequest": { "url": { "path": [ "v1", "subscriptions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"https://\",\n \"event_filter\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"url\": \"\",\n \"event_filter\": \"\",\n \"state\": \"active\",\n \"consecutive_failures\": \"\",\n \"created_at\": \"\",\n \"name\": \"\",\n \"paused_at\": \"\",\n \"secret_rotated_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "197b110b-389e-46a3-89cd-91c66f28f9a4", "name": "Validation error.", "originalRequest": { "url": { "path": [ "v1", "subscriptions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"https://\",\n \"event_filter\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "364bb089-6236-480f-8f27-946bfb483903", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "subscriptions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"https://\",\n \"event_filter\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b66b5e92-a847-44de-9ab4-8366f58d5139", "name": "Resource not found in this workspace.", "originalRequest": { "url": { "path": [ "v1", "subscriptions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"https://\",\n \"event_filter\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0309a72a-95d2-44a6-af2a-553ae89bdb0f", "name": "Delete a subscription", "request": { "name": "Delete a subscription", "description": { "content": "Permanently deletes the subscription. Deliveries are retained for audit.", "type": "text/plain" }, "url": { "path": [ "v1", "subscriptions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "76f5dc93-2eb1-4ac1-9463-f346cddf6e2f", "name": "Deleted.", "originalRequest": { "url": { "path": [ "v1", "subscriptions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "345c8428-ec4d-4a25-8910-d39c6874e5a7", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "subscriptions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfc9312f-417c-4e1e-ba17-946e842efb50", "name": "Resource not found in this workspace.", "originalRequest": { "url": { "path": [ "v1", "subscriptions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "pause", "description": "", "item": [ { "id": "7963fffc-17cf-4213-8b02-d0882bc85ff6", "name": "Pause a subscription", "request": { "name": "Pause a subscription", "description": { "content": "Stops new deliveries until resumed. Existing in-flight deliveries are not cancelled.", "type": "text/plain" }, "url": { "path": [ "v1", "subscriptions", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "3a66a9ca-07c2-44c7-b38a-b187d5a3651f", "name": "Paused.", "originalRequest": { "url": { "path": [ "v1", "subscriptions", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"url\": \"\",\n \"event_filter\": \"\",\n \"state\": \"active\",\n \"consecutive_failures\": \"\",\n \"created_at\": \"\",\n \"name\": \"\",\n \"paused_at\": \"\",\n \"secret_rotated_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6e4d9e2-e10c-44f2-b48f-f3d5cce547f3", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "subscriptions", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e49fd586-3dcc-4f89-9d0b-db54bf3dfc81", "name": "Resource not found in this workspace.", "originalRequest": { "url": { "path": [ "v1", "subscriptions", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "resume", "description": "", "item": [ { "id": "621c5777-40ac-499a-ae40-73a6bacad2b7", "name": "Resume a paused subscription", "request": { "name": "Resume a paused subscription", "description": { "content": "Resets consecutive_failures to 0 and returns the subscription to active state.", "type": "text/plain" }, "url": { "path": [ "v1", "subscriptions", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "6f097fd1-e5da-409f-b4d5-adb5e148ae23", "name": "Resumed.", "originalRequest": { "url": { "path": [ "v1", "subscriptions", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"url\": \"\",\n \"event_filter\": \"\",\n \"state\": \"active\",\n \"consecutive_failures\": \"\",\n \"created_at\": \"\",\n \"name\": \"\",\n \"paused_at\": \"\",\n \"secret_rotated_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "615a0740-a2d6-4c77-b071-2b483302cfe1", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "subscriptions", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4856a5d-5274-4cca-af81-3783fb3870b4", "name": "Resource not found in this workspace.", "originalRequest": { "url": { "path": [ "v1", "subscriptions", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "rotate-secret", "description": "", "item": [ { "id": "4ecd2607-8d07-422e-b0e1-c08905625b36", "name": "Rotate the signing secret", "request": { "name": "Rotate the signing secret", "description": { "content": "Generates a new secret and returns it once. The previous secret\nremains valid for a 48-hour grace window so receivers can update\ntheir verifier without losing requests.\n", "type": "text/plain" }, "url": { "path": [ "v1", "subscriptions", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "c8e747e5-aa7c-4d44-976f-49691f08f46a", "name": "Rotated.", "originalRequest": { "url": { "path": [ "v1", "subscriptions", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"consecutive_failures\": \"\",\n \"created_at\": \"\",\n \"event_filter\": \"\",\n \"id\": \"\",\n \"signing_secret\": \"\",\n \"state\": \"active\",\n \"url\": \"\",\n \"name\": \"\",\n \"paused_at\": \"\",\n \"secret_rotated_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "290c8bf3-5c04-47c3-a9bd-18b3702cfc29", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "subscriptions", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da21c30a-97b1-43ab-bb91-a75e0ffc6c77", "name": "Resource not found in this workspace.", "originalRequest": { "url": { "path": [ "v1", "subscriptions", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ULID of the subscription.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "deliveries", "description": "", "item": [ { "id": "132ec434-abdf-48bc-aaf4-c1648b8ca582", "name": "List deliveries", "request": { "name": "List deliveries", "description": { "content": "Cursor-paginated, newest first, scoped to the caller's workspace.", "type": "text/plain" }, "url": { "path": [ "v1", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "event_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "subscription_id", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of pending,success,failed,dead)", "type": "text/plain" }, "key": "status", "value": "dead" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f0f3fd74-9271-4841-9bdc-586c06f33786", "name": "Page of deliveries.", "originalRequest": { "url": { "path": [ "v1", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "event_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "subscription_id", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of pending,success,failed,dead)", "type": "text/plain" }, "key": "status", "value": "dead" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"event_id\": \"\",\n \"subscription_id\": \"\",\n \"status\": \"dead\",\n \"attempts_made\": \"\",\n \"created_at\": \"\",\n \"next_attempt_at\": \"\",\n \"final_status_code\": \"\",\n \"completed_at\": \"\",\n \"attempts\": [\n {\n \"attempt_number\": \"\",\n \"request_signature\": \"\",\n \"attempted_at\": \"\",\n \"response_status\": \"\",\n \"response_headers\": {\n \"key_0\": \"\"\n },\n \"response_body_snippet\": \"\",\n \"latency_ms\": \"\",\n \"error_code\": \"\"\n },\n {\n \"attempt_number\": \"\",\n \"request_signature\": \"\",\n \"attempted_at\": \"\",\n \"response_status\": \"\",\n \"response_headers\": {\n \"key_0\": \"\"\n },\n \"response_body_snippet\": \"\",\n \"latency_ms\": \"\",\n \"error_code\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"event_id\": \"\",\n \"subscription_id\": \"\",\n \"status\": \"pending\",\n \"attempts_made\": \"\",\n \"created_at\": \"\",\n \"next_attempt_at\": \"\",\n \"final_status_code\": \"\",\n \"completed_at\": \"\",\n \"attempts\": [\n {\n \"attempt_number\": \"\",\n \"request_signature\": \"\",\n \"attempted_at\": \"\",\n \"response_status\": \"\",\n \"response_headers\": {\n \"key_0\": \"\"\n },\n \"response_body_snippet\": \"\",\n \"latency_ms\": \"\",\n \"error_code\": \"\"\n },\n {\n \"attempt_number\": \"\",\n \"request_signature\": \"\",\n \"attempted_at\": \"\",\n \"response_status\": \"\",\n \"response_headers\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"response_body_snippet\": \"\",\n \"latency_ms\": \"\",\n \"error_code\": \"\"\n }\n ]\n }\n ],\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38230f49-e832-4a17-8ee6-317634a340e5", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "event_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "subscription_id", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of pending,success,failed,dead)", "type": "text/plain" }, "key": "status", "value": "dead" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "61df5d3a-a5b4-4fcd-90ed-d68e307fa960", "name": "Retrieve a delivery", "request": { "name": "Retrieve a delivery", "description": { "content": "Returns the delivery with its full attempt timeline.", "type": "text/plain" }, "url": { "path": [ "v1", "deliveries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "16351e75-c752-47a6-9133-ac01e23bc497", "name": "The delivery with attempts.", "originalRequest": { "url": { "path": [ "v1", "deliveries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"event_id\": \"\",\n \"subscription_id\": \"\",\n \"status\": \"dead\",\n \"attempts_made\": \"\",\n \"created_at\": \"\",\n \"next_attempt_at\": \"\",\n \"final_status_code\": \"\",\n \"completed_at\": \"\",\n \"attempts\": [\n {\n \"attempt_number\": \"\",\n \"request_signature\": \"\",\n \"attempted_at\": \"\",\n \"response_status\": \"\",\n \"response_headers\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"response_body_snippet\": \"\",\n \"latency_ms\": \"\",\n \"error_code\": \"\"\n },\n {\n \"attempt_number\": \"\",\n \"request_signature\": \"\",\n \"attempted_at\": \"\",\n \"response_status\": \"\",\n \"response_headers\": {\n \"key_0\": \"\"\n },\n \"response_body_snippet\": \"\",\n \"latency_ms\": \"\",\n \"error_code\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a72f215a-637b-4d08-8a0c-ef6fc4a5a4de", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "deliveries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c04c52f5-9c2d-4623-936c-7ecbf319c663", "name": "Resource not found in this workspace.", "originalRequest": { "url": { "path": [ "v1", "deliveries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "retry", "description": "", "item": [ { "id": "9ae46f57-2fc1-499c-9a74-eb05b5ba7bd9", "name": "Manually retry a delivery", "request": { "name": "Manually retry a delivery", "description": { "content": "Sets the delivery to `pending` and enqueues a fresh delivery attempt\nimmediately. Works regardless of current status. Does not reset\n`attempts_made` — the new attempt is recorded as the next one in\nthe timeline.\n", "type": "text/plain" }, "url": { "path": [ "v1", "deliveries", ":id", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "1813935e-8b25-497e-933b-905df28751b2", "name": "Updated delivery with attempts.", "originalRequest": { "url": { "path": [ "v1", "deliveries", ":id", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"event_id\": \"\",\n \"subscription_id\": \"\",\n \"status\": \"dead\",\n \"attempts_made\": \"\",\n \"created_at\": \"\",\n \"next_attempt_at\": \"\",\n \"final_status_code\": \"\",\n \"completed_at\": \"\",\n \"attempts\": [\n {\n \"attempt_number\": \"\",\n \"request_signature\": \"\",\n \"attempted_at\": \"\",\n \"response_status\": \"\",\n \"response_headers\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"response_body_snippet\": \"\",\n \"latency_ms\": \"\",\n \"error_code\": \"\"\n },\n {\n \"attempt_number\": \"\",\n \"request_signature\": \"\",\n \"attempted_at\": \"\",\n \"response_status\": \"\",\n \"response_headers\": {\n \"key_0\": \"\"\n },\n \"response_body_snippet\": \"\",\n \"latency_ms\": \"\",\n \"error_code\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5b187d8-0f1d-40de-9e83-6f82cf0e4a17", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "deliveries", ":id", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba33b238-61f3-434c-9030-909c180ba32b", "name": "Resource not found in this workspace.", "originalRequest": { "url": { "path": [ "v1", "deliveries", ":id", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "dead-letters", "description": "", "item": [ { "id": "85389bda-8ef5-4656-9831-fbf24418b4e8", "name": "List dead-lettered deliveries", "request": { "name": "List dead-lettered deliveries", "description": { "content": "Returns deliveries with `status=dead` — the human-attention queue.\nA delivery lands here when:\n - The subscriber returned 4xx (not retried).\n - Retries exhausted on 5xx / timeout / connection errors.\n - The subscription was paused / disabled before the attempt.\n - The SSRF guard blocked the URL.\n", "type": "text/plain" }, "url": { "path": [ "v1", "dead-letters" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "subscription_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "since", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d4f44e94-f1bd-4d65-92ec-c1e109ff0445", "name": "Page of dead-lettered deliveries.", "originalRequest": { "url": { "path": [ "v1", "dead-letters" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "subscription_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "since", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"event_id\": \"\",\n \"subscription_id\": \"\",\n \"status\": \"dead\",\n \"attempts_made\": \"\",\n \"created_at\": \"\",\n \"next_attempt_at\": \"\",\n \"final_status_code\": \"\",\n \"completed_at\": \"\",\n \"attempts\": [\n {\n \"attempt_number\": \"\",\n \"request_signature\": \"\",\n \"attempted_at\": \"\",\n \"response_status\": \"\",\n \"response_headers\": {\n \"key_0\": \"\"\n },\n \"response_body_snippet\": \"\",\n \"latency_ms\": \"\",\n \"error_code\": \"\"\n },\n {\n \"attempt_number\": \"\",\n \"request_signature\": \"\",\n \"attempted_at\": \"\",\n \"response_status\": \"\",\n \"response_headers\": {\n \"key_0\": \"\"\n },\n \"response_body_snippet\": \"\",\n \"latency_ms\": \"\",\n \"error_code\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"event_id\": \"\",\n \"subscription_id\": \"\",\n \"status\": \"pending\",\n \"attempts_made\": \"\",\n \"created_at\": \"\",\n \"next_attempt_at\": \"\",\n \"final_status_code\": \"\",\n \"completed_at\": \"\",\n \"attempts\": [\n {\n \"attempt_number\": \"\",\n \"request_signature\": \"\",\n \"attempted_at\": \"\",\n \"response_status\": \"\",\n \"response_headers\": {\n \"key_0\": \"\"\n },\n \"response_body_snippet\": \"\",\n \"latency_ms\": \"\",\n \"error_code\": \"\"\n },\n {\n \"attempt_number\": \"\",\n \"request_signature\": \"\",\n \"attempted_at\": \"\",\n \"response_status\": \"\",\n \"response_headers\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"response_body_snippet\": \"\",\n \"latency_ms\": \"\",\n \"error_code\": \"\"\n }\n ]\n }\n ],\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c04ccc3f-d75c-43df-83d9-e7db0947c15d", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "dead-letters" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "subscription_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "since", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "name": "replay", "description": "", "item": [ { "id": "ef58b3cf-e291-46f3-9772-44ad1b99f3f8", "name": "Replay a dead-lettered delivery", "request": { "name": "Replay a dead-lettered delivery", "description": { "content": "Resurrects a `status=dead` delivery — sets it back to `pending` and\nenqueues a fresh attempt. Returns 409 if the delivery is not in the\ndead-letter state. To retry deliveries in other states use POST\n/v1/deliveries/{id}/retry instead.\n", "type": "text/plain" }, "url": { "path": [ "v1", "dead-letters", ":id", "replay" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "376f032a-4369-4716-b981-f2d82344a272", "name": "Replayed delivery (now pending) with attempts.", "originalRequest": { "url": { "path": [ "v1", "dead-letters", ":id", "replay" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"event_id\": \"\",\n \"subscription_id\": \"\",\n \"status\": \"dead\",\n \"attempts_made\": \"\",\n \"created_at\": \"\",\n \"next_attempt_at\": \"\",\n \"final_status_code\": \"\",\n \"completed_at\": \"\",\n \"attempts\": [\n {\n \"attempt_number\": \"\",\n \"request_signature\": \"\",\n \"attempted_at\": \"\",\n \"response_status\": \"\",\n \"response_headers\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"response_body_snippet\": \"\",\n \"latency_ms\": \"\",\n \"error_code\": \"\"\n },\n {\n \"attempt_number\": \"\",\n \"request_signature\": \"\",\n \"attempted_at\": \"\",\n \"response_status\": \"\",\n \"response_headers\": {\n \"key_0\": \"\"\n },\n \"response_body_snippet\": \"\",\n \"latency_ms\": \"\",\n \"error_code\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3775f92-32a4-4241-9cc2-997b71bf67a3", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "dead-letters", ":id", "replay" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "690032fc-8de2-42ee-ac9b-d4436984b933", "name": "Resource not found in this workspace.", "originalRequest": { "url": { "path": [ "v1", "dead-letters", ":id", "replay" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "046e15e1-24cf-4de2-8653-51475f257ea3", "name": "Delivery is not dead-lettered.", "originalRequest": { "url": { "path": [ "v1", "dead-letters", ":id", "replay" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "webhooks", "description": "", "item": [ { "name": "test", "description": "", "item": [ { "id": "6979cf53-bd2e-42f7-b63e-36852b80d64b", "name": "Ping a webhook URL", "request": { "name": "Ping a webhook URL", "description": { "content": "Sends one synchronously signed sample event to the URL you provide\nand returns the response. No subscription is created; nothing is\nstored. Used by the docs-site try-it widget so prospects can probe\ntheir own endpoints before subscribing. Subject to the workspace\nrate limit.\n\nThe SSRF guard applies: private / loopback / link-local IPs are\nrejected with 400.\n", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://\",\n \"secret\": \"\",\n \"event_type\": \"test.ping\",\n \"payload\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c1d67b13-2484-49b2-b0f8-d28537cec598", "name": "Probe completed (regardless of receiver's HTTP status).", "originalRequest": { "url": { "path": [ "v1", "webhooks", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://\",\n \"secret\": \"\",\n \"event_type\": \"test.ping\",\n \"payload\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": \"\",\n \"signature_sent\": \"\",\n \"secret_used\": \"\",\n \"status\": \"\",\n \"latency_ms\": \"\",\n \"response_body_snippet\": \"\",\n \"error_code\": \"\",\n \"error_detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9883dd68-4e69-43dc-b8f3-e12e86224704", "name": "Validation error.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://\",\n \"secret\": \"\",\n \"event_type\": \"test.ping\",\n \"payload\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59cafb6e-185e-41e8-a9b9-7b538cc18e1c", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://\",\n \"secret\": \"\",\n \"event_type\": \"test.ping\",\n \"payload\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "415ecacc-f944-4c36-9d0f-7a0859074672", "name": "Workspace rate limit exceeded.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://\",\n \"secret\": \"\",\n \"event_type\": \"test.ping\",\n \"payload\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.webhook-relay.dcsuniverse.com" } ], "info": { "_postman_id": "3c49ac24-b745-428c-8e10-5c12f6b09117", "name": "Webhook Relay API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Webhook Relay accepts events from your application and fans them out to\nsubscriber endpoints with HMAC signing, idempotency-key dedup,\nexponential-backoff retries, dead-letter handling, and per-attempt\nobservability.\n\nThis spec is the source of truth for the API. Controllers conform to it;\nSDKs are generated from it. Run `npx @stoplight/spectral-cli lint\nopenapi/spec.yaml` to validate locally.\n\n\nContact Support:\n Name: Philip Rehberger", "type": "text/plain" } } }