Sign inGet Started

Publish a batch of Realtime events

POST
/v1/realtime/apps/{realtime_app_id}/batch-events
await bird.realtime.publishBatch("rap_01krdgeqcxet5s7t44vh8rt9mg", {
  events: [
    { event: "order.created", channel: "orders", data: { id: 1 } },
    { event: "order.updated", channel: "orders", data: { id: 2 } },
  ],
});
Respuesta200
{
  "data": [
    {
      "channel": "orders-42"
    }
  ]
}

Publishes up to 10 events (each to one channel) in a single request.

Parámetros

realtime_app_idstring

ID of the Realtime app (rap_ prefix), as returned when the app was created.

Cuerpo de la solicitud

events
array of object
obligatorio

Up to 10 events per batch.

Mostrar parámetros secundarios

Carga de respuesta

data
array of object

Per-event channel attributes at publish time, present only when at least one event asked for them via include. Positional: one item per event, in request order.

Mostrar atributos secundarios

Continúa con la documentación, guías y ejemplos de este tema.