Managing businesses

A business self-manages through endpoints authenticated by its API key. Admins can manage any business by id.

Your business

# View
curl -H "X-API-Key: sk_live_…" http://localhost:8080/api/v1/me

# Rename and/or rotate the API key (old key stops working immediately)
curl -X PATCH http://localhost:8080/api/v1/me \
  -H "X-API-Key: sk_live_…" -H 'Content-Type: application/json' \
  -d '{"name":"New Name","rotate_api_key":true}'

When rotate_api_key is true, every live key of that business is revoked and one replacement is issued; the response returns the new api_key once. To retire a single key without disturbing the others, revoke it by id from the dashboard instead (POST /api/v1/admin/api-keys/{id}/revoke).

Webhook endpoints

A business can register several endpoints; each has its own signing secret.

# Add — returns `secret` ONCE
curl -X POST http://localhost:8080/api/v1/webhook-endpoints \
  -H "X-API-Key: sk_live_…" -H 'Content-Type: application/json' \
  -d '{"url":"https://your-app.example/webhooks"}'

# List (secrets are never returned)
curl -H "X-API-Key: sk_live_…" http://localhost:8080/api/v1/webhook-endpoints

# Update URL / status, or rotate the secret (returns the new secret once)
curl -X PATCH http://localhost:8080/api/v1/webhook-endpoints/ENDPOINT_ID \
  -H "X-API-Key: sk_live_…" -H 'Content-Type: application/json' \
  -d '{"rotate_secret":true}'

# Remove
curl -X DELETE http://localhost:8080/api/v1/webhook-endpoints/ENDPOINT_ID \
  -H "X-API-Key: sk_live_…"

Set {"status":"DISABLED"} to pause an endpoint without deleting it. See Webhooks for the payload and signature format.

Admin

Provisioning and cross-business management is done by admins:

POST /api/v1/businesses — create a business (issues a first key and returns it once).
PATCH /api/v1/businesses/{id} — update name/status, or rotate every key at once.
POST|GET|PATCH|DELETE /api/v1/businesses/{id}/webhook-endpoints[/{endpoint_id}] — manage a business’s endpoints.

Admin endpoints are intended for internal/operator use and should sit behind an admin guard before production.

Get Started

Concepts

Guides

Reference

Your business

Webhook endpoints

Admin

​Your business

​Webhook endpoints

​Admin

Your business

Webhook endpoints

Admin