Appearance
API Reference
SignalBin's REST API is served under /api/v1. It drives endpoints, destinations, captured webhooks, billing, and team membership programmatically.
Authentication
Requests carry an API token in an Authorization: Bearer header. Tokens are issued in the web app under Settings, on the API Tokens tab, are shown once at creation, and begin with sb_live_. Only workspace owners can create them.
A token belongs to exactly one workspace and can only ever read or write that workspace's data. GET /api/v1/me returns the token's user, workspace, role, granted scopes, and expiry.
Scopes are endpoints:read, endpoints:write, webhooks:read, billing:read, billing:write, team:read, and team:write. Granting a write scope also grants its read counterpart. There is no wildcard scope. A request missing the scope its route requires is refused.
Each token is rate limited independently. Go over the limit and requests are refused until the window resets, with a Retry-After header saying how long to wait (429).
What the API covers
| Area | Routes cover |
|---|---|
| Identity and stats | The calling token's identity; workspace request and byte counters with remaining credit |
| Live events | A server-sent event stream of captures as they arrive |
| Endpoints | Create, read, update, delete; rotate or clear an endpoint's secret; send a test delivery |
| Destinations | List, create, update, and delete the relay targets on an endpoint, up to 10 per endpoint |
| Mock rules | Per-endpoint canned responses, including their order |
| Sample payloads | Browse the built-in sample library, manage custom samples, and send a sample to an endpoint |
| Webhooks | List and inspect captures, download file attachments, replay a capture, and read its replay history |
| Billing | Credit balance, ledger, usage, and purchase history; create a checkout session for more credit |
| Team | List members and invites, invite a teammate, change a role, remove a member |
Some things the web app does have no /api/v1 equivalent, including API token management and workspace settings.
Full reference
Authoritative source
Every route, request and response schema, and error shape lives at signalbin.work/api/docs, generated from SignalBin's OpenAPI spec. This page is a map to it.
MCP
SignalBin also runs an MCP server at /mcp, backed by the same tokens and scopes, for AI clients that manage a workspace rather than calling the REST API directly. MCP Integration documents the connection details and the available tools.