Notifications
Every call needs Authorization: Bearer <key>. 2 calls:
- My notifications:
GET /v1/notifications - Mark notifications read:
POST /v1/notifications/read
My notifications
GET /v1/notifications
The dashboard bell: your notifications in this workspace, newest first, with how many are unread.
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | From 1 to 50. Default 20. |
unread | enum | No | true lists only unread notifications. One of: true, false. |
Headers
| Name | Type | Required | Description |
|---|---|---|---|
x-workspace-id | string | No | Workspace for session (JWT) callers. API keys carry their own workspace. |
Response 200
| Field | Type | Description |
|---|---|---|
data | object[] | |
data[].body | string or null | |
data[].created_at | string (date-time) | ISO 8601 timestamp. |
data[].event | enum | One of: conversation_assigned, new_conversation, mention, line_degraded, webhook_disabled, billing, daily_digest. |
data[].id | string (uuid) | |
data[].link | string or null | |
data[].read_at | string (date-time) or null | ISO 8601 timestamp. |
data[].title | string | |
unread_count | integer | From 0 to 9007199254740991. |
Errors: 400, 401, 403, 404, 409, 413, 415, 429, 500. See errors for the shape and codes.
Mark notifications read
POST /v1/notifications/read
Marks the given notifications, or all of yours with all: true, as read. Ids that aren’t yours or are already read are ignored.
Headers
| Name | Type | Required | Description |
|---|---|---|---|
x-workspace-id | string | No | Workspace for session (JWT) callers. API keys carry their own workspace. |
idempotency-key | string | No | Makes the write safe to retry for 24 hours. 1 to 255 printable characters. Keys starting with outreach:, workflow: or agent: are reserved for messages bubbl3 sends itself and are refused with 400. Up to 255 characters. |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
ids | string (uuid)[] | Yes | Up to 100 items. |
Response 200
| Field | Type | Description |
|---|---|---|
unread_count | integer | From 0 to 9007199254740991. |
updated | integer | From 0 to 9007199254740991. |
Errors: 400, 401, 403, 404, 409, 413, 415, 429, 500. See errors for the shape and codes.