Skip to main content
POST
Notify — multi-channel fan-out or waterfall

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
bindings
object[]
required

Array of per-binding payloads. Each specifies a channel and destination. Minimum 2 bindings for waterfall mode.

Required array length: 1 - 10000 elements
body
string

Shared message body — applied to every binding that doesn't carry its own.

Required string length: 1 - 4000
from
string

Shared sender identifier — applied to every binding that doesn't carry its own.

Required string length: 1 - 128
template_name
string

Shared template name — applied when neither shared nor per-binding body is set.

Required string length: 1 - 128
template_params
object

Shared template parameters — applied to every binding that doesn't carry its own.

metadata
object

Shared metadata bag — merged onto every binding's metadata.

mode
enum<string>

Delivery strategy. fanout (default): send every binding immediately. waterfall: send the first binding; auto-escalate remaining bindings on DLR undelivered within the TTL.

Available options:
fanout,
waterfall
fallback_window_seconds
integer

Waterfall freshness window in seconds. An undelivered DLR landing after this window does NOT escalate. Ignored in fanout mode. Default 24h; floor 30s, ceiling 24h.

Required range: 30 <= x <= 86400

Response

Success — every binding queued (fanout) or at least one binding queued (waterfall). Returns per-binding delivery handles and async escalation chain.

data
object
meta
object