Skip to main content
POST
Publish a Sync Stream message

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Path Parameters

name
string
required

Unique name of the Sync Stream.

Pattern: ^[A-Za-z0-9._:-]+$

Body

application/json

Write body for appending/replacing a Sync List item or publishing a Sync Stream message.

data
object
required

Arbitrary JSON object payload carried by a Sync object or item. Every Sync value is a JSON map (matching Twilio Sync). The serialised payload must not exceed 64 KiB.

Response

201 - application/json

The published message receipt

data
object

Receipt for a published Sync Stream message. Streams are ephemeral pub/sub — a message is delivered only to clients subscribed at publish time and is never persisted.

meta
object