API Keys

API keys are used exclusively for sending messages via /v1/notify/*.

Create a key

POST /tenant/api-keys
Authorization: Bearer eyJ...
Content-Type: application/json

{
  "name": "Production server",
  "rateLimitOverride": 500
}

Field	Type	Required	Description
name	string	yes	Human-readable label
rateLimitOverride	integer (1–10000)	no	Requests per minute; overrides plan default

Response 201

{
  "id": "key_01j...",
  "name": "Production server",
  "keyPrefix": "notifo_live_",
  "key": "notifo_live_abc123...",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "warning": "Store this key — it will not be shown again."
}

caution

The full key value is shown once at creation. Store it securely — it cannot be retrieved later.

List keys

GET /tenant/api-keys
Authorization: Bearer eyJ...

Returns an array of key objects. The key field is never returned here — only keyPrefix and metadata.

Revoke a key

DELETE /tenant/api-keys/:id
Authorization: Bearer eyJ...

Response: 204 No Content. The key stops working immediately.

Using a key

POST /v1/notify/whatsapp/text
X-Api-Key: notifo_live_abc123...
Content-Type: application/json