realtime-events

Publish a batch of Realtime events

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

post/v1/realtime/apps/{realtime_app_id}/batch-events

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/realtime/apps/{realtime_app_id}/batch-events
  • Auth: one of:
    • HTTP bearer and API key in header X-Realtime-Key and API key in header X-Realtime-Secret
    • API key in cookie bird_session and API key in header X-Realtime-Key and API key in header X-Realtime-Secret

Headers

Idempotency-Keystring

Client-supplied key. On operations supporting request deduplication, a retained response is replayed for duplicate requests with the same key within the idempotency window (3 hours by default). This protection requires a workspace, organization, or staff-account scope. User-only and unscoped unauthenticated operations, streams, and operations with a separate replay contract do not use this response replay.

On a supported operation, if idempotency protection is unavailable before execution, the API returns 503 IdempotencyUnavailable (E01033) without executing this attempt. Retry with backoff using the same key and request. An operation that takes effect before its response is retained can still execute again on retry.

Two distinct 409 errors signal misuse:

  • request_in_progress (E01004): The same key is currently being processed by a concurrent request. Wait briefly and retry. The lock expires within 30 seconds.
  • idempotency_key_reuse (E01005): The same key has already completed against a different request body or method. Generate a new key.

Recommended key format is <event-type>/<entity-id> (for example welcome-user/usr_abc123).

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Request body

Example request

{
  "events": [
    {
      "event": "order-updated",
      "channel": "orders-42",
      "exclude_connection_id": "123.4567"
    }
  ]
}

Response

The events were accepted for delivery.

Example response

{
  "data": [
    {
      "channel": "orders-42"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.