Overview

The Inbox API stores per-user notification items. Items are created by agents or platform flows and surfaced to the user with a severity and status. Clients can list items, mark them read, or create new items programmatically.

Base URL

For local development:

Authentication

All requests require a valid bearer token in the Authorization header. See Authentication for details.

Inbox item object

Endpoints

List inbox items

Query parameters

Response

Update inbox item

Request body

Response

Create inbox item

Request body

Response

Error codes