Documentation
Sign inGet started

Send an event to a member

POST
/v1/realtime/apps/{realtime_app_id}/members/{member_id}/events
await bird.realtime.members.send("rap_01krdgeqcxet5s7t44vh8rt9mg", "user_42", {
  event: "order-shipped",
  data: { order_id: "ord_123" },
});
Delivers an event to one member of a Realtime app, addressing the person rather than a channel. Every connection that member currently holds receives it across tabs and devices, without requiring a dedicated channel.
The member must have signed in on the connection for it to be addressable. Delivery is best-effort and not queued. A member with no active connections at the time of the call does not receive the event.
Parameter
realtime_app_id
string
ID of the Realtime app (rap_ prefix), as returned when the app was created.
member_id
string
The member to deliver the event to.
Payload Permintaan
event
string
wajib
The event name clients bind to. Application event names are free-form; the bird: and bird_internal: prefixes are reserved for the protocol and rejected.
data
Arbitrary JSON payload delivered as the event data: an object, array, or scalar. Cap: 10 KB serialized.