POST

Authorizations

apikey
string
header
required

Your publishable (pb_pk_…) or secret (pb_sk_…) key.

Authorization
string
header
required

The signed-in person's access token.

Body

application/json
channel
string
required

The channel to publish to, such as orders:42.

Required string length: 1 - 200
event
string
default:message

The event name subscribers listen for, such as order.updated.

Required string length: 1 - 100
payload
any

Any JSON value delivered to subscribers.

client_msg_id
string | null

An idempotency key for durable channels: resending the same id returns the stored message instead of delivering it twice.

Maximum string length: 128

Response

Success.

id
string
required

Unique identifier.

channel
string
required
event
string
required