Skip to main content

Notifications

Every call needs Authorization: Bearer <key>. 2 calls:

My notifications​

GET /v1/notifications

The dashboard bell: your notifications in this workspace, newest first, with how many are unread.

Query parameters

NameTypeRequiredDescription
limitintegerNoFrom 1 to 50. Default 20.
unreadenumNotrue lists only unread notifications. One of: true, false.

Headers

NameTypeRequiredDescription
x-workspace-idstringNoWorkspace for session (JWT) callers. API keys carry their own workspace.

Response 200

FieldTypeDescription
dataobject[]
data[].bodystring or null
data[].created_atstring (date-time)ISO 8601 timestamp.
data[].eventenumOne of: conversation_assigned, new_conversation, mention, line_degraded, webhook_disabled, billing, daily_digest.
data[].idstring (uuid)
data[].linkstring or null
data[].read_atstring (date-time) or nullISO 8601 timestamp.
data[].titlestring
unread_countintegerFrom 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

NameTypeRequiredDescription
x-workspace-idstringNoWorkspace for session (JWT) callers. API keys carry their own workspace.
idempotency-keystringNoMakes 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

FieldTypeRequiredDescription
idsstring (uuid)[]YesUp to 100 items.

Response 200

FieldTypeDescription
unread_countintegerFrom 0 to 9007199254740991.
updatedintegerFrom 0 to 9007199254740991.

Errors: 400, 401, 403, 404, 409, 413, 415, 429, 500. See errors for the shape and codes.