Skip to main content
POST
Send a human a one-way notification

Authorizations

x-api-key
string
header
required

Body

application/json

A notification to send: the message text, an optional named channel that carries it (omit to record to the internal sink), an optional per-call recipient delivery address, and an optional audience identity whose in-app inbox shows it (honored even with a channel set; distinct from recipient).

message
string
required
audience
string | null

The identity (user_id) whose in-app inbox shows this (honored even with a channel set); leave unset for an operator/broadcast notification. Distinct from recipient, which is a channel delivery address.

channel
string | null
recipient
string | null
sender_identity
string | null

Reserved: the sending identity a channel message leaves FROM, set by the conversation bridge on the notification it builds to answer a route. Callers MUST NOT supply it here — a set value is rejected with a 400, never forwarded.

Response

Success.

data
any
required