Skip to content
calternal docs

Persist one web toast in Notifications

POST
/api/v1/notifications/inbox/toasts
curl --request POST \
  --url https://example.com/api/v1/notifications/inbox/toasts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "action_label": "example", "event_id": "example", "link": "example", "title": "example" }'

Store one toast for the authenticated User. Retries with the same event ID update the same inbox item. Toast notices do not send browser push. Route: /api/v1/notifications/inbox/toasts. Inputs: . Do not automatically replay this operation after an uncertain result.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

One authenticated web toast and the same action text shown by its toast.

object
action_label

Optional action label while the originating web Installation is live.

string | null
event_id
required

Client event identity used to make delivery retries idempotent.

string
link

Optional stable in-app destination for an Open or Show action.

string | null
title
required

Exact toast text, stored as the inbox title.

string
Examplegenerated
{
  "action_label": "example",
  "event_id": "example",
  "link": "example",
  "title": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

One inbox item returned to the authenticated User.

object
action_label

Action label for a web toast while its Installation still owns the action.

string | null
body

Optional display detail.

string | null
created_ms
required

Creation time in Unix milliseconds.

integer format: int64
id
required

Stable notification identifier.

string
kind
required

Stable notification category.

string
link

Optional local deep link.

string | null
read_ms

Read time in Unix milliseconds, or null when unread.

integer | null format: int64
reminder_state

Per-User action state for an active block reminder, when this row owns one.

string | null
title
required

Short display title.

string
Examplegenerated
{
  "action_label": "example",
  "body": "example",
  "created_ms": 1,
  "id": "example",
  "kind": "example",
  "link": "example",
  "read_ms": 1,
  "reminder_state": "example",
  "title": "example"
}

400

Section titled “400”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

401

Section titled “401”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

403

Section titled “403”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

413

Section titled “413”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

429

Section titled “429”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}