Get started
Authentication
Every request is authenticated with an API key sent in the Authorization header. There is no session or token exchange to manage.
The Authorization header
Send your key with the App prefix, followed by a space, on every request:
HTTP
Requests go to the base URL shown next to your keys in the dashboard. Always use HTTPS.
check-key.ts
Managing keys
- One key per environment. Create separate keys for development, staging and production, so you can revoke one without touching the others.
- Rotate without downtime. Create the new key, deploy it, then revoke the old one. Both work in the meantime.
- Revoke on leak. If a key ends up in a log, a commit or a ticket, revoke it in the dashboard right away. Requests using it fail immediately.
Keep keys on the server
A key can send messages and place calls billed to your account. Call Pulsr from your backend, a serverless function or a job queue, never directly from a browser or mobile app. If your frontend needs to trigger a message, expose your own endpoint that checks who is asking, then calls Pulsr.
Authentication errors
| Status | Meaning |
|---|---|
401 Unauthorized | The header is missing, malformed or the key does not exist or was revoked. |
403 Forbidden | The key is valid but is not allowed to use this endpoint or this feature. |
Response · 401 Unauthorized