Send an event to a member

POST

/v1/realtime/apps/{realtime_app_id}/members/{member_id}/events

curl -X POST "https://us1.platform.bird.com/v1/realtime/apps/{realtime_app_id}/members/{member_id}/events" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

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, so there is no need to track their connections or give them a channel of their own. The member must have signed in on the connection for it to be addressable. Delivery is best-effort and not queued: a member holding no connections at the moment of the call simply does not receive the event.

Anfrage-Nutzlast

event

string

erforderlich

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.

curl -X POST "https://us1.platform.bird.com/v1/realtime/apps/{realtime_app_id}/members/{member_id}/events" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'