BeeBuzz API
Version 0.9.0
BeeBuzz public API reference. Send push notifications, manage webhooks, and retrieve paired device public keys for end-to-end payload encryption.
Authentication
Public BeeBuzz API endpoints authenticate with an API token sent as a Bearer credential in the Authorization header.
Authorization: Bearer YOUR_API_TOKENAPI tokens are created from Account → Tokens in the BeeBuzz web app. Treat them like passwords: store them securely and rotate if leaked.
Health
Health check
No parameters or body.
API health check
No parameters or body.
Push
Send a notification
Trusted path — send application/json or multipart/form-data with plaintext title and body. The server handles delivery to paired devices.
E2EE path — retrieve device age public keys from GET /v1/push/keys, encrypt your payload client-side, then send as application/octet-stream. Use the X-Priority header to set priority.
Header parameters
| Name | Type | Description |
|---|---|---|
X-Priority | "normal" | "high" | Push delivery priority. Relevant for `application/octet-stream`
requests, where priority is passed via header instead of JSON body.
normalhigh |
Request body required
{
"title": "Hello from BeeBuzz!",
"body": "This is a test notification",
"priority": "normal",
"attachment_url": "https://example.com"
}Send a notification to a topic
Trusted path — send application/json or multipart/form-data with plaintext title and body. The server handles delivery to paired devices.
E2EE path — retrieve device age public keys from GET /v1/push/keys, encrypt your payload client-side, then send as application/octet-stream. Use the X-Priority header to set priority.
Path parameters
| Name | Type | Description |
|---|---|---|
topic required | string |
Header parameters
| Name | Type | Description |
|---|---|---|
X-Priority | "normal" | "high" | Push delivery priority. Relevant for `application/octet-stream`
requests, where priority is passed via header instead of JSON body.
normalhigh |
Request body required
{
"title": "Hello from BeeBuzz!",
"body": "This is a test notification",
"priority": "normal",
"attachment_url": "https://example.com"
}List device public keys
Returns the age public keys for all paired devices. Use these keys to
encrypt push payloads for E2EE delivery via POST /v1/push or
POST /v1/push/{topic} (send as application/octet-stream).
No parameters or body.
Webhooks
Send a notification from a webhook
Path parameters
| Name | Type | Description |
|---|---|---|
token required | string |
Request body required
{
"title": "Build succeeded",
"body": "All tests passed in 12s"
}