Create a Realtime app
/v1/realtime/appsbird realtime apps create \
--connection-counting=true \
--name chat-production \
--region eu1curl -X POST "https://us1.platform.bird.com/v1/realtime/apps" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "chat-production",
"region": "eu1",
"connection_counting": true
}'{
"created_at": "2026-05-20T09:14:52Z",
"updated_at": "2026-05-25T16:42:01Z",
"id": "rap_01krdgeqcxet5s7t44vh8rt9mg",
"app_id": 432557,
"name": "chat-production",
"region": "us1",
"status": "active",
"key": {
"id": "rak_01krdgeqcxet5s7t44vh8rt9mg",
"key": "d0e95a856ddc1b09d4c8",
"secret": "862925e1991a8b6902f9"
}
}
Provisions a new Realtime app for the workspace and returns it with the initial key. Store the key secret when you receive it because later responses do not include it. If you lose the secret, create a new key and revoke this one.
Treść żądania
client_eventsAllow clients to trigger events directly (client events).
connection_countingCount the connections subscribed to each channel and expose the count on channel queries.
connection_count_eventsBroadcast connection-count events to public and private channel subscribers. Requires connection_counting. Presence channels do not emit these events; use a channel query to read their connection count.
watchlist_eventsTell a signed-in member when the members on their watchlist come online or go offline. The watchlist is part of the identity your backend signs at signin.
authorized_connectionsRequire every connection to be authorized.
nameA label for the app, shown wherever it is listed.
regionThe region this app runs in. Unlike other products, a Realtime app can be placed in a region other than the workspace's home region. Immutable after creation.
Possible values: us1, eu1
Treść odpowiedzi
created_atupdated_atclient_eventsAllow clients to trigger events directly (client events).
connection_countingCount the connections subscribed to each channel and expose the count on channel queries.
connection_count_eventsBroadcast connection-count events to public and private channel subscribers. Requires connection_counting. Presence channels do not emit these events; use a channel query to read their connection count.
watchlist_eventsTell a signed-in member when the members on their watchlist come online or go offline. The watchlist is part of the identity your backend signs at signin.
authorized_connectionsRequire every connection to be authorized.
idapp_idThe numeric Realtime app id. Use it together with a key and secret to initialize a Realtime client/server SDK. Immutable.
nameA label for the app, shown wherever it is listed.
regionThe region this app runs in. Unlike other products, a Realtime app can be placed in a region other than the workspace's home region. Immutable after creation.
Possible values: us1, eu1
statusLifecycle state of the app. active apps serve connections; suspended apps are provisioned but reject connections.
Possible values: active, suspended
keyThe app's initial key, including its one-time secret. Present in this create response only; the secret is never returned again.
Powiązane zasoby
Przejdź do dokumentacji, przewodników i przykładów dotyczących tego tematu.