{ "item": [ { "name": "meta", "description": "", "item": [ { "id": "7b6f2af0-cd61-450f-b4b1-d471f6ab981a", "name": "Liveness probe.", "request": { "name": "Liveness probe.", "description": { "content": "Unauthenticated liveness probe. Returns a fixed shape so synthetic monitors can branch on response body in addition to status code.", "type": "text/plain" }, "url": { "path": [ "v1", "healthz" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7d40ad32-410b-44fc-a0c6-880a48b34d10", "name": "Health check OK.", "originalRequest": { "url": { "path": [ "v1", "healthz" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"worker\": \"admin-api\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e4d7939b-b571-4f7d-80c2-738cc7de488d", "name": "Whoami + capabilities for the current API key.", "request": { "name": "Whoami + capabilities for the current API key.", "description": { "content": "Returns the workspace id, plan, scopes, current rate-limit snapshot, and a `capabilities` map advertising which conditionally-exposed features this key has access to. Clients should branch on the `capabilities` map rather than probing the surface for 403s.", "type": "text/plain" }, "url": { "path": [ "v1", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "37c2d5d3-385b-4cac-8786-72f19d636e7d", "name": "Discovery + capabilities for the current API key. Clients SHOULD call this on cold start and cache `plan` + `capabilities`.", "originalRequest": { "url": { "path": [ "v1", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"client_id\": \"\",\n \"name\": \"\",\n \"plan\": \"free\",\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"rate_limit\": {\n \"limit\": \"\",\n \"period\": 60,\n \"remaining\": \"\",\n \"reset\": \"\"\n },\n \"capabilities\": {\n \"events_read\": \"\",\n \"webhooks_outbound\": \"\",\n \"agency_endpoints\": \"\",\n \"fine_grained_scopes\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "072d42c6-68d6-4239-a921-511b79c1d3a1", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecf98c9d-d0be-44ae-95b2-b6a6a797a587", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "sources", "description": "", "item": [ { "id": "7453bff9-dcc9-45ce-98bb-0b01b580b6da", "name": "List sources.", "request": { "name": "List sources.", "description": { "content": "Returns the workspace's sources in `created_at DESC` order. Echo `next_cursor` from this response into the `cursor` query param to fetch the next page. The cursor is opaque — do not parse it.", "type": "text/plain" }, "url": { "path": [ "v1", "sources" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Opaque base64 pagination cursor from a prior page's `next_cursor`. A malformed/unknown cursor renders a 400 `invalid-cursor` problem.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size, 1..100. Omit to let the handler apply the default (50). Out-of-range values render a 422 schema-validation problem.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "7a21ad20-9edf-4e54-92ad-775db4b64a93", "name": "Paged list of sources in the calling key's workspace.", "originalRequest": { "url": { "path": [ "v1", "sources" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Opaque base64 pagination cursor from a prior page's `next_cursor`. A malformed/unknown cursor renders a 400 `invalid-cursor` problem.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size, 1..100. Omit to let the handler apply the default (50). Out-of-range values render a 422 schema-validation problem.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"client_id\": \"\",\n \"name\": \"\",\n \"source_type\": \"\",\n \"status\": \"revoked\",\n \"allowed_site_url\": \"\",\n \"auth_mode\": \"hmac_v1\",\n \"schema_version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"client_id\": \"\",\n \"name\": \"\",\n \"source_type\": \"\",\n \"status\": \"paused\",\n \"allowed_site_url\": \"\",\n \"auth_mode\": \"hmac_v1\",\n \"schema_version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"has_more\": \"\",\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "458595fa-c28e-45c9-9534-012626f5e87d", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "sources" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Opaque base64 pagination cursor from a prior page's `next_cursor`. A malformed/unknown cursor renders a 400 `invalid-cursor` problem.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size, 1..100. Omit to let the handler apply the default (50). Out-of-range values render a 422 schema-validation problem.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fded9a89-3b2e-43c3-bcd0-81d99297f79a", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "sources" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Opaque base64 pagination cursor from a prior page's `next_cursor`. A malformed/unknown cursor renders a 400 `invalid-cursor` problem.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size, 1..100. Omit to let the handler apply the default (50). Out-of-range values render a 422 schema-validation problem.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f369a59e-3062-4b04-aef3-7d8296d82b92", "name": "Create a source.", "request": { "name": "Create a source.", "description": { "content": "Idempotent. Requires an `Idempotency-Key` request header (any client-chosen string up to 255 characters). A successful response is cached for 24 hours; replaying the same key returns the cached body verbatim with `Idempotent-Replayed: true`. Replaying with a different request body returns 422 `idempotency-conflict`.", "type": "text/plain" }, "url": { "path": [ "v1", "sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "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 \"name\": \"\",\n \"source_type\": \"\",\n \"allowed_site_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "410e6322-c3c0-474d-a2c3-7f4e7980b83c", "name": "Idempotent replay. Body is bit-identical to the original 201 response. `Idempotent-Replayed: true` header is set.", "originalRequest": { "url": { "path": [ "v1", "sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"source_type\": \"\",\n \"allowed_site_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"client_id\": \"\",\n \"name\": \"\",\n \"source_type\": \"\",\n \"status\": \"revoked\",\n \"allowed_site_url\": \"\",\n \"auth_mode\": \"hmac_v1\",\n \"schema_version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3740c74-5041-4d8a-86b9-4c637abca144", "name": "Source created.", "originalRequest": { "url": { "path": [ "v1", "sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"source_type\": \"\",\n \"allowed_site_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"client_id\": \"\",\n \"name\": \"\",\n \"source_type\": \"\",\n \"status\": \"revoked\",\n \"allowed_site_url\": \"\",\n \"auth_mode\": \"hmac_v1\",\n \"schema_version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4a42d98-9f51-4f9e-a2fa-7fa655e7938e", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"source_type\": \"\",\n \"allowed_site_url\": \"\"\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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "108b05a6-22cb-4340-b116-e176842c9314", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"source_type\": \"\",\n \"allowed_site_url\": \"\"\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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d44e52f-6b82-4028-942a-35bd5ace8a9f", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"source_type\": \"\",\n \"allowed_site_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f639d15-55bf-4b9d-9350-89ee1d272c7d", "name": "Get a source by id.", "request": { "name": "Get a source by id.", "description": {}, "url": { "path": [ "v1", "sources", ":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": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "158bcc0c-9c14-4e29-9e19-18d1a14d9696", "name": "Source detail.", "originalRequest": { "url": { "path": [ "v1", "sources", ":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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"client_id\": \"\",\n \"name\": \"\",\n \"source_type\": \"\",\n \"status\": \"revoked\",\n \"allowed_site_url\": \"\",\n \"auth_mode\": \"hmac_v1\",\n \"schema_version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d299a3d-d004-44a0-bd3c-aa2a43f7c712", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "sources", ":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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cea69401-1d5e-401b-b1c0-6f8ce15e0804", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "sources", ":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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ec7e94c8-5055-4bf9-8bd6-fb7b1dfb7334", "name": "Update a source (partial).", "request": { "name": "Update a source (partial).", "description": { "content": "Partial update. Requires `Idempotency-Key`. To flip status to `revoked`, use `POST /v1/sources/{id}/revoke` — the dedicated endpoint ensures the irreversible action gets its own audit row.", "type": "text/plain" }, "url": { "path": [ "v1", "sources", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"status\": \"paused\",\n \"allowed_site_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "a0b31a79-840e-401f-9d32-3c08d5721e8b", "name": "Source updated (or idempotent replay).", "originalRequest": { "url": { "path": [ "v1", "sources", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"status\": \"paused\",\n \"allowed_site_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"client_id\": \"\",\n \"name\": \"\",\n \"source_type\": \"\",\n \"status\": \"revoked\",\n \"allowed_site_url\": \"\",\n \"auth_mode\": \"hmac_v1\",\n \"schema_version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2943d407-a8a5-43b3-93cc-5d6c9d163c1c", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "sources", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"status\": \"paused\",\n \"allowed_site_url\": \"\"\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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61817b55-d88b-4e4f-9e7a-1fc8cf4e23c8", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "sources", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"status\": \"paused\",\n \"allowed_site_url\": \"\"\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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14160a6d-dc34-4f6e-974d-5365edbbe56f", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "sources", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"status\": \"paused\",\n \"allowed_site_url\": \"\"\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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4be243cc-1c05-4b96-9618-291a4daafb0d", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "sources", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"status\": \"paused\",\n \"allowed_site_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9ba35b0f-30c7-44f4-b0ba-608049dd1765", "name": "Pause a source.", "request": { "name": "Pause a source.", "description": { "content": "Idempotent. A paused source still ingests events (they persist with `source_paused: true` activity) but no delivery jobs fan out. Already-paused sources return 200 unchanged.", "type": "text/plain" }, "url": { "path": [ "v1", "sources", ":id", "pause" ], "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": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "ffe4ac41-1864-4702-b66e-cd177a7bea68", "name": "Source paused.", "originalRequest": { "url": { "path": [ "v1", "sources", ":id", "pause" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"client_id\": \"\",\n \"name\": \"\",\n \"source_type\": \"\",\n \"status\": \"revoked\",\n \"allowed_site_url\": \"\",\n \"auth_mode\": \"hmac_v1\",\n \"schema_version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f1ab6a7-8514-4abd-83bf-db60068caa03", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "sources", ":id", "pause" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b21a666-3a2a-47ee-a4d4-6cdda531f913", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "sources", ":id", "pause" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aa2b44a2-ed02-43a3-be96-85e7aeffa8df", "name": "Revoke a source.", "request": { "name": "Revoke a source.", "description": { "content": "Irreversible. Sets status to `revoked` and (transitively) hard-fails intake from any keys still associated with the source. Idempotent — already-revoked sources return 200 unchanged.", "type": "text/plain" }, "url": { "path": [ "v1", "sources", ":id", "revoke" ], "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": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "cc176a2d-8903-40eb-9140-7852cf227474", "name": "Source revoked (terminal). Future intake from this source's keys hard-fails at auth.", "originalRequest": { "url": { "path": [ "v1", "sources", ":id", "revoke" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"client_id\": \"\",\n \"name\": \"\",\n \"source_type\": \"\",\n \"status\": \"revoked\",\n \"allowed_site_url\": \"\",\n \"auth_mode\": \"hmac_v1\",\n \"schema_version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8179a4c-aa80-45f0-85b8-80dcdd125cc0", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "sources", ":id", "revoke" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8938a27-d92a-4515-b1b6-e55c50ca3516", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "sources", ":id", "revoke" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4f3d343f-d6f9-426a-95cd-7db4c6e1160d", "name": "Rotate a source's HMAC signing secret.", "request": { "name": "Rotate a source's HMAC signing secret.", "description": { "content": "Revokes any active signing key on the source and mints a fresh 32-byte secret. The plaintext is returned ONCE in the response — there is no endpoint to recover it later. Requires `Idempotency-Key`.", "type": "text/plain" }, "url": { "path": [ "v1", "sources", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "ef1a4bdd-2ea3-4804-b2a7-b94623d1152c", "name": "Idempotent replay. Body is bit-identical to the original 201 response (the same plaintext is returned). `Idempotent-Replayed: true` header is set.", "originalRequest": { "url": { "path": [ "v1", "sources", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_id\": \"\",\n \"signing_secret\": \"\",\n \"created_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bd2e342-9431-4d6d-87a0-a0ecf98235bb", "name": "New signing secret minted. The plaintext is returned exactly once — persist it before this response leaves memory.", "originalRequest": { "url": { "path": [ "v1", "sources", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_id\": \"\",\n \"signing_secret\": \"\",\n \"created_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72fb9874-32a5-4c8e-8a79-ccbbc262b84f", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "sources", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bcee859-6189-4342-a814-17c034f86b29", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "sources", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc5c0f48-0956-4f8b-922a-663d42c43761", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "sources", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a71ae0a6-4c00-4b71-8b8d-32d49a312b2c", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "sources", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd4377a0-d44d-4c74-8c3f-b139fbc98df7", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "sources", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "destinations", "description": "", "item": [ { "id": "90aef874-2016-4c34-8fa5-f564ab43c737", "name": "List destinations.", "request": { "name": "List destinations.", "description": { "content": "Returns the workspace's destinations, newest first. Forward-only cursor pagination via the opaque `cursor` query parameter. Requires the `destinations:read` scope.", "type": "text/plain" }, "url": { "path": [ "v1", "destinations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "7ffeb866-8009-44ae-b9db-fd69acfc8525", "name": "Page of destinations for the authenticated workspace.", "originalRequest": { "url": { "path": [ "v1", "destinations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"client_id\": \"\",\n \"name\": \"\",\n \"adapter_type\": \"\",\n \"status\": \"paused\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"provider_scope\": \"full\"\n },\n {\n \"id\": \"\",\n \"client_id\": \"\",\n \"name\": \"\",\n \"adapter_type\": \"\",\n \"status\": \"revoked\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"provider_scope\": \"send-only\"\n }\n ],\n \"has_more\": \"\",\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab5b5da8-20c8-4a32-b690-4216bb432ab6", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "349fa360-86d6-4b11-b88c-8db33cf85d5e", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7fc5b8fa-dcb7-450f-bab0-eb7201110a07", "name": "Create a destination.", "request": { "name": "Create a destination.", "description": { "content": "Creates a destination of any supported adapter type. The `config` payload is validated against the adapter's Zod schema; outbound URL fields are re-checked against the SSRF guard. The `Idempotency-Key` header is REQUIRED (1-255 chars); retries with the same token replay the cached response. Requires the `destinations:write` scope.", "type": "text/plain" }, "url": { "path": [ "v1", "destinations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "4fbc6841-3b5a-4435-9a67-129943126c2e", "name": "Destination created.", "originalRequest": { "url": { "path": [ "v1", "destinations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"client_id\": \"\",\n \"name\": \"\",\n \"adapter_type\": \"\",\n \"status\": \"revoked\",\n \"config\": {\n \"key_0\": \"string\",\n \"key_1\": 230,\n \"key_2\": 9185\n },\n \"sensitive_keys\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"provider_metadata\": \"\",\n \"provider_scope\": \"full\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11cab2b3-1f1b-449b-a8f7-c40368730a21", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cec87f0-ed5e-4c0b-b781-f579d82f79b7", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c94287b-4c74-42d8-8c3a-ebe46f4451aa", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fde21da-126a-4252-bf26-372c16da9387", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "62f6ab86-9148-4678-b594-b84d74f41e6f", "name": "Get a destination by id.", "request": { "name": "Get a destination by id.", "description": { "content": "Returns the decrypted config map plus `sensitive_keys` listing which fields SDK clients should mask in their UIs. Requires the `destinations:read` scope.", "type": "text/plain" }, "url": { "path": [ "v1", "destinations", ":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": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "38dc8f06-93b7-483f-b426-9f7e564eed98", "name": "Destination detail with decrypted config.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"client_id\": \"\",\n \"name\": \"\",\n \"adapter_type\": \"\",\n \"status\": \"revoked\",\n \"config\": {\n \"key_0\": \"string\",\n \"key_1\": 230,\n \"key_2\": 9185\n },\n \"sensitive_keys\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"provider_metadata\": \"\",\n \"provider_scope\": \"full\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ca6adc6-10d7-47a3-96df-9733b20e6307", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "932ce232-7a8e-4a8f-8a40-b2f2d082b592", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f6cc754-1c69-43e6-adb4-848a737bbce9", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "264287b6-65ec-44f9-9ee9-cdeea4d58743", "name": "Update a destination.", "request": { "name": "Update a destination.", "description": { "content": "Partial update; `adapter_type` is NOT patchable (create a new destination instead). Outbound URL fields are re-validated against the SSRF guard at write time. The `Idempotency-Key` header is REQUIRED (1-255 chars); retries with the same token replay the cached response. Requires the `destinations:write` scope.", "type": "text/plain" }, "url": { "path": [ "v1", "destinations", ":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": "PATCH", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "a0ab2123-9e22-4590-aafe-3ef89fd49fbb", "name": "Destination updated.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"client_id\": \"\",\n \"name\": \"\",\n \"adapter_type\": \"\",\n \"status\": \"revoked\",\n \"config\": {\n \"key_0\": \"string\",\n \"key_1\": 230,\n \"key_2\": 9185\n },\n \"sensitive_keys\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"provider_metadata\": \"\",\n \"provider_scope\": \"full\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d67d8a53-41f4-4525-a7d8-a0dc77a61cd9", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": {} }, "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73ff8221-0249-4c84-b18c-25f45dfab0f7", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "708e2717-c4d3-49b1-b311-e9cf2b7de558", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "457846d8-f89a-48f5-a0be-7eb1e16ad4a5", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92c40e72-8570-44d5-9510-7958dc6a4b9d", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5645c898-5c2e-4088-90bf-b925b77e8fcf", "name": "Pause a destination.", "request": { "name": "Pause a destination.", "description": { "content": "Flips the destination to `paused`. Pre-existing delivery jobs already on the queue still execute; new fanout skips this destination. Idempotent: pausing an already-paused destination is a no-op success. Requires the `destinations:write` scope.", "type": "text/plain" }, "url": { "path": [ "v1", "destinations", ":id", "pause" ], "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": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "6a872a1d-d6d0-4016-a614-bb57173c4298", "name": "Destination paused. Future deliveries skip this destination.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":id", "pause" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"client_id\": \"\",\n \"name\": \"\",\n \"adapter_type\": \"\",\n \"status\": \"revoked\",\n \"config\": {\n \"key_0\": \"string\",\n \"key_1\": 230,\n \"key_2\": 9185\n },\n \"sensitive_keys\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"provider_metadata\": \"\",\n \"provider_scope\": \"full\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a68e0e98-7a66-47fa-bb89-16c3249629b5", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":id", "pause" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78c9accb-57d9-4926-af33-8e9288600ef3", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":id", "pause" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9432130c-4305-433c-95ad-097c3e097099", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":id", "pause" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "95c43adf-f916-4f19-a024-14d53c750eb3", "name": "Refresh this destination's cached provider template manifest.", "request": { "name": "Refresh this destination's cached provider template manifest.", "description": { "content": "Re-fetches the upstream template manifest (today: Resend for `email_resend_v2`) and updates the destination's `provider_metadata`. Returns a diff vs the prior manifest. Rate-limited to ~1 request per 10s per destination; excess returns 429 with `Retry-After`. Requires the `destinations:write` scope.", "type": "text/plain" }, "url": { "path": [ "v1", "destinations", ":id", "refresh-template" ], "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": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d22eb8cc-19e5-4704-b3cc-96d54e55fd9d", "name": "Manifest refreshed. `changed` reports whether the new manifest differs from the prior cached one.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":id", "refresh-template" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"changed\": \"\",\n \"manifest\": \"\",\n \"diff\": {\n \"added\": [\n \"\",\n \"\"\n ],\n \"removed\": [\n \"\",\n \"\"\n ],\n \"changed\": [\n \"\",\n \"\"\n ],\n \"from_changed\": \"\"\n },\n \"provider_scope\": \"send-only\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f676563-cfe1-4b13-82f7-94b7dd41fc41", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":id", "refresh-template" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07c1e16f-f8fa-46da-abad-57f38eb40cf4", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":id", "refresh-template" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "378a2788-cb6e-4b6d-a5b7-ade32d32a22e", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":id", "refresh-template" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "739e281d-6ee3-4833-84c5-f24f6ab56930", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":id", "refresh-template" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f759426c-dc89-44dc-9987-30bd948d3e43", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":id", "refresh-template" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9913214e-73cc-4a20-afce-42559a300525", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":id", "refresh-template" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "02068599-6e23-435f-9cb1-069aa7d66129", "name": "Read this destination's cached provider template manifest.", "request": { "name": "Read this destination's cached provider template manifest.", "description": { "content": "Returns the cached upstream template manifest (today: Resend for `email_resend_v2`) so the mapping editor can render typed variable targets and validate route mappings before any lead flows. This is a UI-rendering concern only — it is NOT a delivery prerequisite, and `POST /test` does not consult it. `manifest` is null when the destination's provider key is scoped send-only. Adapters without a provider manifest return 422. Requires the `destinations:read` scope.", "type": "text/plain" }, "url": { "path": [ "v1", "destinations", ":id", "manifest-status" ], "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": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "68408811-1c19-4b55-9fc3-3197280b3798", "name": "Cached provider template manifest for the mapping editor. `manifest` is null when the destination's provider API key is scoped send-only (no manifest fetchable).", "originalRequest": { "url": { "path": [ "v1", "destinations", ":id", "manifest-status" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"provider_scope\": \"full\",\n \"fetched_at\": \"\",\n \"manifest\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e431d6b0-0626-4498-9184-829935933ef1", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":id", "manifest-status" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44939c7e-e7a7-4c21-85ca-993827aedf65", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":id", "manifest-status" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fb1b5da-8424-44d3-9eaf-55f2aa3df73e", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":id", "manifest-status" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b645f048-f256-4dc3-92c6-0bc75b8ecb16", "name": "Send a synthetic test event through this destination.", "request": { "name": "Send a synthetic test event through this destination.", "description": { "content": "Dispatches a synthetic LeadEvent through the destination's adapter and reports the classified outcome. NO delivery_job is persisted; this is a faithful synthetic of real delivery — it performs the same provider call delivery would (e.g. a real POST to Resend `/emails`) so provider-side blockers surface here exactly as they would in production. For `email_*` adapters: optionally supply `variables` (`to` defaults to a synthetic recipient when unset); they flow through verbatim and are NOT pre-validated against the cached template manifest — use `GET /manifest-status` for the manifest view. Requires the `destinations:write` scope.", "type": "text/plain" }, "url": { "path": [ "v1", "destinations", ":id", "test" ], "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": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "1ed58312-62cf-4f31-9f81-a14ece2f6d04", "name": "Synthetic test event dispatched. Body reports the adapter's classification.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":id", "test" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": \"\",\n \"classification\": \"success\",\n \"error_code\": \"\",\n \"error_message\": \"\",\n \"response_summary\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ecd5eff-9ae8-4b34-81f9-a100d0566095", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":id", "test" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0654d167-6e7b-4357-83d2-c4c49ac089b2", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":id", "test" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d61cc338-a078-405a-a95e-5dc98586364a", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":id", "test" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54f30ac2-51f6-4585-87b7-b441c0980f22", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "destinations", ":id", "test" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "routes", "description": "", "item": [ { "id": "3c978989-94f4-49a5-b0a3-b71c003196b1", "name": "List routes.", "request": { "name": "List routes.", "description": { "content": "Returns the workspace's routes in `created_at DESC` order. Echo `next_cursor` from this response into the `cursor` query param to fetch the next page. The cursor is opaque — do not parse it.", "type": "text/plain" }, "url": { "path": [ "v1", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Opaque base64 pagination cursor from a prior page's `next_cursor`. A malformed/unknown cursor renders a 400 `invalid-cursor` problem.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size, 1..100. Omit to let the handler apply the default (50). Out-of-range values render a 422 schema-validation problem.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "a1f83c1c-5d29-48a9-b243-74d7ced6fc10", "name": "Paged list of routes in the calling key's workspace.", "originalRequest": { "url": { "path": [ "v1", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Opaque base64 pagination cursor from a prior page's `next_cursor`. A malformed/unknown cursor renders a 400 `invalid-cursor` problem.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size, 1..100. Omit to let the handler apply the default (50). Out-of-range values render a 422 schema-validation problem.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"client_id\": \"\",\n \"source_id\": \"\",\n \"destination_id\": \"\",\n \"workflow_id\": \"\",\n \"name\": \"\",\n \"status\": \"paused\",\n \"priority\": \"\",\n \"filter_rules_json\": \"\",\n \"mapping_version\": \"\",\n \"mapping_json\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"client_id\": \"\",\n \"source_id\": \"\",\n \"destination_id\": \"\",\n \"workflow_id\": \"\",\n \"name\": \"\",\n \"status\": \"revoked\",\n \"priority\": \"\",\n \"filter_rules_json\": \"\",\n \"mapping_version\": \"\",\n \"mapping_json\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"has_more\": \"\",\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3c27787-97f9-45e7-9669-67f9c482ab5a", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Opaque base64 pagination cursor from a prior page's `next_cursor`. A malformed/unknown cursor renders a 400 `invalid-cursor` problem.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size, 1..100. Omit to let the handler apply the default (50). Out-of-range values render a 422 schema-validation problem.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "434fb022-6b02-458c-a509-633d51425e98", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "routes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Opaque base64 pagination cursor from a prior page's `next_cursor`. A malformed/unknown cursor renders a 400 `invalid-cursor` problem.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size, 1..100. Omit to let the handler apply the default (50). Out-of-range values render a 422 schema-validation problem.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cb47ac76-097a-4830-b240-2b07214cb171", "name": "Create a route.", "request": { "name": "Create a route.", "description": { "content": "Wires a source to a destination. `source_id` and `destination_id` MUST both belong to the calling key's workspace; a cross-workspace reference returns 400 `invalid-reference`. `workflow_id` is optional — when omitted, the handler resolves the source's default workflow. Requires an `Idempotency-Key` request header (1-255 chars).", "type": "text/plain" }, "url": { "path": [ "v1", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "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 \"source_id\": \"\",\n \"destination_id\": \"\",\n \"name\": \"\",\n \"workflow_id\": \"\",\n \"priority\": \"\",\n \"filter_rules_json\": \"\",\n \"mapping_version\": \"\",\n \"mapping_json\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "1fa19edf-374f-4ace-8b4f-63c36d2aa0af", "name": "Idempotent replay. Body is bit-identical to the original 201 response. `Idempotent-Replayed: true` header is set.", "originalRequest": { "url": { "path": [ "v1", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source_id\": \"\",\n \"destination_id\": \"\",\n \"name\": \"\",\n \"workflow_id\": \"\",\n \"priority\": \"\",\n \"filter_rules_json\": \"\",\n \"mapping_version\": \"\",\n \"mapping_json\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"client_id\": \"\",\n \"source_id\": \"\",\n \"destination_id\": \"\",\n \"workflow_id\": \"\",\n \"name\": \"\",\n \"status\": \"active\",\n \"priority\": \"\",\n \"filter_rules_json\": \"\",\n \"mapping_version\": \"\",\n \"mapping_json\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9512808e-daad-4cb6-9c28-112bcf111676", "name": "Route created.", "originalRequest": { "url": { "path": [ "v1", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source_id\": \"\",\n \"destination_id\": \"\",\n \"name\": \"\",\n \"workflow_id\": \"\",\n \"priority\": \"\",\n \"filter_rules_json\": \"\",\n \"mapping_version\": \"\",\n \"mapping_json\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"client_id\": \"\",\n \"source_id\": \"\",\n \"destination_id\": \"\",\n \"workflow_id\": \"\",\n \"name\": \"\",\n \"status\": \"active\",\n \"priority\": \"\",\n \"filter_rules_json\": \"\",\n \"mapping_version\": \"\",\n \"mapping_json\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6af6e0f-f8af-40f4-95a6-0dd8cdbfb95a", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source_id\": \"\",\n \"destination_id\": \"\",\n \"name\": \"\",\n \"workflow_id\": \"\",\n \"priority\": \"\",\n \"filter_rules_json\": \"\",\n \"mapping_version\": \"\",\n \"mapping_json\": \"\"\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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47d966df-2d06-431b-9e48-56826f5b0f72", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source_id\": \"\",\n \"destination_id\": \"\",\n \"name\": \"\",\n \"workflow_id\": \"\",\n \"priority\": \"\",\n \"filter_rules_json\": \"\",\n \"mapping_version\": \"\",\n \"mapping_json\": \"\"\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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e72a5d51-c959-40c6-9dc8-1152fe8701cc", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source_id\": \"\",\n \"destination_id\": \"\",\n \"name\": \"\",\n \"workflow_id\": \"\",\n \"priority\": \"\",\n \"filter_rules_json\": \"\",\n \"mapping_version\": \"\",\n \"mapping_json\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd20f6b7-ceff-4210-b8e3-a9313acf7a81", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source_id\": \"\",\n \"destination_id\": \"\",\n \"name\": \"\",\n \"workflow_id\": \"\",\n \"priority\": \"\",\n \"filter_rules_json\": \"\",\n \"mapping_version\": \"\",\n \"mapping_json\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "23dfbb23-c91b-4dad-a31c-8703e449c305", "name": "Get a route by id.", "request": { "name": "Get a route by id.", "description": {}, "url": { "path": [ "v1", "routes", ":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": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "e9730bfd-f5f0-41c1-958c-89b09b1db581", "name": "Route detail.", "originalRequest": { "url": { "path": [ "v1", "routes", ":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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"client_id\": \"\",\n \"source_id\": \"\",\n \"destination_id\": \"\",\n \"workflow_id\": \"\",\n \"name\": \"\",\n \"status\": \"active\",\n \"priority\": \"\",\n \"filter_rules_json\": \"\",\n \"mapping_version\": \"\",\n \"mapping_json\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3604a59-a302-4e73-aafc-a099eabed8ac", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "routes", ":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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fd5c3b5-af5f-46d8-957f-a45f1c1ee2ec", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "routes", ":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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fe8590c1-f3bc-48f5-92de-9663d605add3", "name": "Update a route (partial).", "request": { "name": "Update a route (partial).", "description": { "content": "Partial update. `destination_id`, when supplied, is re-validated against the route's workspace. `source_id` is NOT patchable. To soft-delete a route use `DELETE /v1/routes/{id}` — that endpoint stamps a dedicated audit row.", "type": "text/plain" }, "url": { "path": [ "v1", "routes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"status\": \"paused\",\n \"priority\": \"\",\n \"destination_id\": \"\",\n \"filter_rules_json\": \"\",\n \"mapping_version\": \"\",\n \"mapping_json\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "a5d1c917-3bba-497d-8d4d-ceb7cde65679", "name": "Route updated (or idempotent replay).", "originalRequest": { "url": { "path": [ "v1", "routes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"status\": \"paused\",\n \"priority\": \"\",\n \"destination_id\": \"\",\n \"filter_rules_json\": \"\",\n \"mapping_version\": \"\",\n \"mapping_json\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"client_id\": \"\",\n \"source_id\": \"\",\n \"destination_id\": \"\",\n \"workflow_id\": \"\",\n \"name\": \"\",\n \"status\": \"active\",\n \"priority\": \"\",\n \"filter_rules_json\": \"\",\n \"mapping_version\": \"\",\n \"mapping_json\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb1a8dd2-7c4d-4404-9130-91a6d84368eb", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "routes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"status\": \"paused\",\n \"priority\": \"\",\n \"destination_id\": \"\",\n \"filter_rules_json\": \"\",\n \"mapping_version\": \"\",\n \"mapping_json\": \"\"\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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0ce88f4-d6e5-4958-a948-c41da23b86af", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "routes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"status\": \"paused\",\n \"priority\": \"\",\n \"destination_id\": \"\",\n \"filter_rules_json\": \"\",\n \"mapping_version\": \"\",\n \"mapping_json\": \"\"\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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c24af0c-86ad-499e-ad9d-3efd3b59e066", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "routes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"status\": \"paused\",\n \"priority\": \"\",\n \"destination_id\": \"\",\n \"filter_rules_json\": \"\",\n \"mapping_version\": \"\",\n \"mapping_json\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0132b007-c221-433e-b724-a99b2b3a4219", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "routes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"status\": \"paused\",\n \"priority\": \"\",\n \"destination_id\": \"\",\n \"filter_rules_json\": \"\",\n \"mapping_version\": \"\",\n \"mapping_json\": \"\"\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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7598cd7-bacd-4b64-9230-30ddd661a8dd", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "routes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"status\": \"paused\",\n \"priority\": \"\",\n \"destination_id\": \"\",\n \"filter_rules_json\": \"\",\n \"mapping_version\": \"\",\n \"mapping_json\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25387652-be98-49e4-bc02-99428d564c86", "name": "Soft-delete a route.", "request": { "name": "Soft-delete a route.", "description": { "content": "Flips status to `revoked`. Future fanout skips revoked routes; in-flight delivery_jobs already on the queue still execute. Idempotent — deleting a revoked route is a no-op success.", "type": "text/plain" }, "url": { "path": [ "v1", "routes", ":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": "DELETE", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "9c31534e-f7ef-40f8-a2d6-5d47a8bf4a6e", "name": "Route soft-deleted (status → revoked). Idempotent: deleting an already-revoked route returns the cached row.", "originalRequest": { "url": { "path": [ "v1", "routes", ":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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"client_id\": \"\",\n \"source_id\": \"\",\n \"destination_id\": \"\",\n \"workflow_id\": \"\",\n \"name\": \"\",\n \"status\": \"active\",\n \"priority\": \"\",\n \"filter_rules_json\": \"\",\n \"mapping_version\": \"\",\n \"mapping_json\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81e6ef5c-4221-4eca-97e6-657f47aa5d41", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "routes", ":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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "578110cb-68b7-4428-a711-9815409f0d74", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "routes", ":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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "events", "description": "", "item": [ { "id": "0a55e369-6608-434a-9f01-66e2ec0120fc", "name": "List events.", "request": { "name": "List events.", "description": { "content": "Returns a cursor-paginated page of `lead_events` for the caller's workspace, newest first. Filters: `source_id`, `destination_id`, `status` (`delivered|failed|pending`), `from`, `to` (ISO timestamps). Default limit 50, max 200.\n\nRequires a Pro, Agency, or Scale plan. Free/Starter callers receive a 403 RFC-9457 problem document with type `https://docs.leadrails.dev/errors/plan-required`.\n\nInformational scope: `events:read`. v1 ships wildcard scopes (`['*']`); fine-grained scope enforcement lands in v1.1.", "type": "text/plain" }, "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page size as a string; the handler parses and clamps to the shared default/max.", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "Opaque forward-only pagination cursor from a prior page's `next_cursor`.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to events ingested under this `src_<…>` source.", "type": "text/plain" }, "key": "source_id", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to events that fanned out to this `dst_<…>` destination.", "type": "text/plain" }, "key": "destination_id", "value": "" }, { "disabled": false, "description": { "content": "Delivery-side status filter; one of `delivered | failed | pending`.", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "ISO-8601 lower bound on `received_at` (inclusive).", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "ISO-8601 upper bound on `received_at` (inclusive).", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "7f4bda92-0396-4a31-9fee-73b29be736ab", "name": "Paginated event list scoped to the caller's workspace.", "originalRequest": { "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page size as a string; the handler parses and clamps to the shared default/max.", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "Opaque forward-only pagination cursor from a prior page's `next_cursor`.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to events ingested under this `src_<…>` source.", "type": "text/plain" }, "key": "source_id", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to events that fanned out to this `dst_<…>` destination.", "type": "text/plain" }, "key": "destination_id", "value": "" }, { "disabled": false, "description": { "content": "Delivery-side status filter; one of `delivered | failed | pending`.", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "ISO-8601 lower bound on `received_at` (inclusive).", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "ISO-8601 upper bound on `received_at` (inclusive).", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"client_id\": \"\",\n \"source_id\": \"\",\n \"schema_version\": \"\",\n \"idempotency_key\": \"\",\n \"normalized_status\": \"pending\",\n \"received_at\": \"\",\n \"remote_ip\": \"\",\n \"user_agent\": \"\",\n \"referer\": \"\",\n \"origin\": \"\",\n \"site_url\": \"\",\n \"workflow_name\": \"\"\n },\n {\n \"id\": \"\",\n \"client_id\": \"\",\n \"source_id\": \"\",\n \"schema_version\": \"\",\n \"idempotency_key\": \"\",\n \"normalized_status\": \"normalized\",\n \"received_at\": \"\",\n \"remote_ip\": \"\",\n \"user_agent\": \"\",\n \"referer\": \"\",\n \"origin\": \"\",\n \"site_url\": \"\",\n \"workflow_name\": \"\"\n }\n ],\n \"has_more\": \"\",\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abfd9289-0211-4081-8978-225e162f972b", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page size as a string; the handler parses and clamps to the shared default/max.", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "Opaque forward-only pagination cursor from a prior page's `next_cursor`.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to events ingested under this `src_<…>` source.", "type": "text/plain" }, "key": "source_id", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to events that fanned out to this `dst_<…>` destination.", "type": "text/plain" }, "key": "destination_id", "value": "" }, { "disabled": false, "description": { "content": "Delivery-side status filter; one of `delivered | failed | pending`.", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "ISO-8601 lower bound on `received_at` (inclusive).", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "ISO-8601 upper bound on `received_at` (inclusive).", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ec5f58a-98bb-4676-9f03-ad321f6aa562", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page size as a string; the handler parses and clamps to the shared default/max.", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "Opaque forward-only pagination cursor from a prior page's `next_cursor`.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to events ingested under this `src_<…>` source.", "type": "text/plain" }, "key": "source_id", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to events that fanned out to this `dst_<…>` destination.", "type": "text/plain" }, "key": "destination_id", "value": "" }, { "disabled": false, "description": { "content": "Delivery-side status filter; one of `delivered | failed | pending`.", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "ISO-8601 lower bound on `received_at` (inclusive).", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "ISO-8601 upper bound on `received_at` (inclusive).", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d8aa5ec-67fc-488e-a454-15d1da477140", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page size as a string; the handler parses and clamps to the shared default/max.", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "Opaque forward-only pagination cursor from a prior page's `next_cursor`.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to events ingested under this `src_<…>` source.", "type": "text/plain" }, "key": "source_id", "value": "" }, { "disabled": false, "description": { "content": "Restrict results to events that fanned out to this `dst_<…>` destination.", "type": "text/plain" }, "key": "destination_id", "value": "" }, { "disabled": false, "description": { "content": "Delivery-side status filter; one of `delivered | failed | pending`.", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "ISO-8601 lower bound on `received_at` (inclusive).", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "ISO-8601 upper bound on `received_at` (inclusive).", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f2635d13-4780-4dfe-ba85-58acd91ac364", "name": "Get a single event by id.", "request": { "name": "Get a single event by id.", "description": { "content": "Returns one event in the caller's workspace. Events belonging to another workspace return 404 (existence is hidden).\n\nRequires a Pro, Agency, or Scale plan. Free/Starter callers receive a 403 RFC-9457 problem document with type `https://docs.leadrails.dev/errors/plan-required`.\n\nInformational scope: `events:read`. v1 ships wildcard scopes (`['*']`); fine-grained scope enforcement lands in v1.1.", "type": "text/plain" }, "url": { "path": [ "v1", "events", ":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": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "e8fd537b-6862-45e6-be24-98e2c9cb4af9", "name": "Single-event projection.", "originalRequest": { "url": { "path": [ "v1", "events", ":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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"client_id\": \"\",\n \"source_id\": \"\",\n \"schema_version\": \"\",\n \"idempotency_key\": \"\",\n \"normalized_status\": \"failed\",\n \"received_at\": \"\",\n \"remote_ip\": \"\",\n \"user_agent\": \"\",\n \"referer\": \"\",\n \"origin\": \"\",\n \"site_url\": \"\",\n \"workflow_name\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e556126-6f8b-4539-8083-3885551608e4", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "events", ":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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "314e65b6-3979-4800-8e59-658342d47f38", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "events", ":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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d46f3b38-8298-45fc-8d11-0bcda4799549", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "events", ":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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "962a35ed-fb19-454b-9dca-bf5364045c6e", "name": "List delivery jobs for a single event.", "request": { "name": "List delivery jobs for a single event.", "description": { "content": "Returns every delivery job fanned out from the given event at intake time (one per matching route), each with its full attempt history ordered by `attempt_number`. Events in another workspace return 404.\n\nRequires a Pro, Agency, or Scale plan. Free/Starter callers receive a 403 RFC-9457 problem document with type `https://docs.leadrails.dev/errors/plan-required`.\n\nInformational scope: `events:read`. v1 ships wildcard scopes (`['*']`); fine-grained scope enforcement lands in v1.1.", "type": "text/plain" }, "url": { "path": [ "v1", "events", ":id", "delivery-jobs" ], "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": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "1ab4cfea-b197-44b7-ade7-c240e86f057d", "name": "All delivery jobs fanned out from the given event, with attempt history embedded on each job.", "originalRequest": { "url": { "path": [ "v1", "events", ":id", "delivery-jobs" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"event_id\": \"\",\n \"client_id\": \"\",\n \"route_id\": \"\",\n \"destination_id\": \"\",\n \"adapter_type\": \"\",\n \"status\": \"delivered\",\n \"attempt_count\": \"\",\n \"max_attempts\": \"\",\n \"next_attempt_at\": \"\",\n \"last_error_code\": \"\",\n \"last_error_message\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"delivered_at\": \"\",\n \"attempts\": [\n {\n \"id\": \"\",\n \"job_id\": \"\",\n \"event_id\": \"\",\n \"destination_id\": \"\",\n \"adapter_type\": \"\",\n \"attempt_number\": \"\",\n \"status\": \"transient_failure\",\n \"request_summary_json\": \"\",\n \"response_summary_json\": \"\",\n \"error_code\": \"\",\n \"error_message\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\"\n },\n {\n \"id\": \"\",\n \"job_id\": \"\",\n \"event_id\": \"\",\n \"destination_id\": \"\",\n \"adapter_type\": \"\",\n \"attempt_number\": \"\",\n \"status\": \"transient_failure\",\n \"request_summary_json\": \"\",\n \"response_summary_json\": \"\",\n \"error_code\": \"\",\n \"error_message\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"event_id\": \"\",\n \"client_id\": \"\",\n \"route_id\": \"\",\n \"destination_id\": \"\",\n \"adapter_type\": \"\",\n \"status\": \"skipped\",\n \"attempt_count\": \"\",\n \"max_attempts\": \"\",\n \"next_attempt_at\": \"\",\n \"last_error_code\": \"\",\n \"last_error_message\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"delivered_at\": \"\",\n \"attempts\": [\n {\n \"id\": \"\",\n \"job_id\": \"\",\n \"event_id\": \"\",\n \"destination_id\": \"\",\n \"adapter_type\": \"\",\n \"attempt_number\": \"\",\n \"status\": \"success\",\n \"request_summary_json\": \"\",\n \"response_summary_json\": \"\",\n \"error_code\": \"\",\n \"error_message\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\"\n },\n {\n \"id\": \"\",\n \"job_id\": \"\",\n \"event_id\": \"\",\n \"destination_id\": \"\",\n \"adapter_type\": \"\",\n \"attempt_number\": \"\",\n \"status\": \"success\",\n \"request_summary_json\": \"\",\n \"response_summary_json\": \"\",\n \"error_code\": \"\",\n \"error_message\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aec21de5-f987-4b77-92cb-80e0b1307e2b", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "events", ":id", "delivery-jobs" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a4ca52d-c9dc-425a-8f0d-f6c0e087f319", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "events", ":id", "delivery-jobs" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43053c7c-1728-4329-97a8-637aca170215", "name": "RFC 9457 problem document. Returned for every non-2xx response from a /v1/* endpoint.", "originalRequest": { "url": { "path": [ "v1", "events", ":id", "delivery-jobs" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "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 \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.leadrails.dev" } ], "info": { "_postman_id": "d87ed56d-6c46-498b-bcbc-75ab169bd095", "name": "LeadRails Public API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "LeadRails public REST API. Authenticate with an API key issued from the admin UI; send it as `Authorization: Bearer lr_live_`.", "type": "text/plain" } } }