Docs

API docs

Use the backend API to configure Dispatch, send messages, inspect attempts, and read Ingest data.

Reference

The interactive API reference includes request fields, path parameters, response examples, and downloadable OpenAPI files.

Open interactive API reference

Download OpenAPI JSON · Download OpenAPI YAML

Authentication

Create API keys from the Dispatch dashboard and send them as bearer tokens from your backend. Keep API keys server-side.

Authorization: Bearer rlk_...

Dashboard sessions can also call API routes from the signed-in app. Production integrations should use API keys.

Scopes

Use * for a trusted backend service, or issue narrower keys for specific jobs.

ScopeUse it for
app:read / app:writeList, fetch, and create Dispatch apps.
recipient:read / recipient:writeManage recipients and create portal sessions.
event_type:read / event_type:writeList, publish, and archive event types.
endpoint:read / endpoint:writeManage recipient endpoints and rotate endpoint secrets.
message:read / message:writeList, send, inspect, and replay messages.

Common workflows

  • Create apps and event types during product setup.
  • Create portal sessions when customers manage their webhook endpoints.
  • Send messages when customer-facing events happen in your app.
  • List messages and attempts when debugging a customer delivery issue.
  • Replay a message after a destination comes back online.

Status codes and errors

  • 200 means the requested record or list was returned.
  • 201 means a configuration object was created.
  • 202 means a message or replay was accepted and delivery will continue asynchronously.
  • 400 means the request is missing a required field or has invalid input.
  • 401 means the request is missing valid authentication.
  • 403 means the API key does not have the required scope.
  • 404 means the app, recipient, endpoint, message, or event was not found in your workspace.
  • 429 means the workspace or plan limit was reached for that action.
{ "ok": false, "error": "app_not_found" }

Read Ingest state

Use these endpoints when your backend needs a workspace-level read of sources, recent events, or open issues.

GET /api/v1/sources GET /api/v1/events GET /api/v1/anomalies

For event-level investigation, the dashboard usually gives more context because it includes delivery attempts, payload access, and replay controls.