Skip to main content
Developer routes are workspace-scoped and protected by bearer API key authentication.

API keys

Use API key routes to create and revoke workspace API credentials.
EndpointPurpose
GET /v1/api-keysList workspace API keys.
POST /v1/api-keysCreate an API key.
POST /v1/api-keys/{apiKeyId}/revokeRevoke an API key.
Create an API key with:
{
  "name": "Treasury automation",
  "scopes": ["wallets:read", "transfers:create"],
  "expires_at": "2026-12-31T23:59:59Z"
}
The token is returned only when the key is created. Store it securely. Available scopes:
  • wallets:read
  • transfers:read
  • transfers:create
  • transfers:approve
  • api_keys:manage
  • admin:*

Webhooks

Use webhook routes to receive signed workspace events.
EndpointPurpose
GET /v1/webhooksList webhooks.
POST /v1/webhooksCreate a webhook.
POST /v1/webhooks/{webhookId}/rotate-secretRotate the signing secret.
POST /v1/webhooks/{webhookId}/disableDisable a webhook.
POST /v1/webhooks/{webhookId}/enableEnable a webhook.
Create a webhook with:
{
  "name": "Production events",
  "url": "https://example.com/onstacks/webhooks"
}
The signing secret is returned when you create or rotate the webhook.

Health checks

Use GET /healthz for liveness and GET /readyz for readiness.

Environment scope

API key and webhook routes accept environment=sandbox or environment=live.