Get an inbox session token

POST 
/api/v1/notifications/get-inbox-session

Returns a session token and connection URLs for the real-time in-app inbox. The token is short-lived and should be refreshed before expiry.

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized scoped domain action.

Use this in a guide: Build an in-app inbox · Inbox state and actions

Request

Responses

200

Inbox session created successfully

Create an inbox session for the selected user; identity comes from authentication.

Section ID: DOC-CP-notifications-api-getInboxSession#example-notifications-getInboxSession-request

Request example

{}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.

Section ID: DOC-CP-notifications-api-getInboxSession#example-notifications-getInboxSession-response

Response example

{
  "token": "example",
  "socketUrl": "https://example.com/resource",
  "expiresIn": "1"
}

Document ID: DOC-CP-notifications-api-getInboxSession. Section identities and revisions.

Section	Stable reference
Get an inbox session token	DOC-CP-notifications-api-getInboxSession#overview
Request	DOC-CP-notifications-api-getInboxSession#request
Responses	DOC-CP-notifications-api-getInboxSession#responses