API reference
HTTP API for SignalSeal.
The SignalSeal HTTP API lets you query workspace data and receive webhooks for the events that matter to your team.
The public API is in private beta. If you need server-to-server access today, email hello@signalseal.net.
Base URL
https://api.signalseal.netAll API responses are JSON.
Authentication
Every request is authenticated with a workspace API key, sent as a
bearer token in the Authorization header:
Authorization: Bearer ssk_live_...See Authentication for how to create and manage keys.
Resources
Errors
The API uses conventional HTTP status codes:
| Code | Meaning |
|---|---|
200 | Success. |
400 | The request was malformed. |
401 | The API key is missing or invalid. |
403 | The API key is valid but doesn't have access to the resource. |
404 | The resource doesn't exist or you can't see it. |
429 | You're being rate-limited. Back off and retry. |
5xx | Something went wrong on our end. Retries are safe. |
Every error response includes a JSON body with a stable error code and a human-readable message:
{
"error": {
"code": "invalid_api_key",
"message": "The API key you supplied is invalid or has been revoked."
}
}Rate limits
The API allows generous per-workspace rate limits - you'll get back a
429 with a Retry-After header if you exceed them. We'll publish
specific limits when the API leaves private beta.