API / Realtime / Émettre un broadcast Émettre un broadcast POST /realtime/v1/broadcast
Envoie un événement custom à tous les clients abonnés à un canal. Indépendant de Postgres — fanout direct via NATS.
channelstring REQUIS
Nom du canal cible. Tous les abonnés reçoivent le message.
eventstring REQUIS
Nom de l'événement ("typing", "cursor", "score_update").
payloadobject REQUIS
Corps de l'événement, max 256 KB. JSON sérialisable.
Attention
Par défaut, seul le service_role_key peut broadcast. Pour autoriser les clients à broadcast, définissez une policy allow_broadcast dans realtime.channels.
v1.0 · révisé 15 avr. 2026
Node (client) cURL (server)
REQUEST · broadcast.ts
TYPESCRIPT copy
await aura. channel ( 'chat:general' ). send ({
type : 'broadcast' , event : 'typing' ,
payload : { userId, until: Date. now () + 2000 },
})
200 413
RESPONSE · 200.json
JSON copy
{ "sent_to" : 247 , "latency_ms" : 9 }
