Create a Realtime app
POST
/v1/realtime/apps
bird 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
}'Respuesta201
{
"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.
Cuerpo de la solicitud
client_events
boolean
Allow clients to trigger events directly (client events).
connection_counting
boolean
Count the connections subscribed to each channel and expose the count on channel queries.
connection_count_events
boolean
Broadcast a connection-count event to a channel's subscribers whenever its connection count changes. Requires connection_counting.
watchlist_events
boolean
Tell 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_connections
boolean
Require every connection to be authorized.
name
string
obligatorio
A label for the app, shown wherever it is listed.
region
string
obligatorio
The 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.
Carga de respuesta
created_at
string
obligatorio
updated_at
string
obligatorio
client_events
boolean
obligatorio
Allow clients to trigger events directly (client events).
connection_counting
boolean
obligatorio
Count the connections subscribed to each channel and expose the count on channel queries.
connection_count_events
boolean
obligatorio
Broadcast a connection-count event to a channel's subscribers whenever its connection count changes. Requires connection_counting.
watchlist_events
boolean
obligatorio
Tell 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_connections
boolean
obligatorio
Require every connection to be authorized.
id
string
obligatorio
app_id
integer
obligatorio
The numeric Realtime app id. Use it together with a key and secret to initialize a Realtime client/server SDK. Immutable.
name
string
obligatorio
A label for the app, shown wherever it is listed.
region
string
obligatorio
The 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.
status
string
obligatorio
Lifecycle state of the app. active apps serve connections; suspended apps are provisioned but reject connections.
Possible values: active, suspended
key
object
obligatorio
The app's initial key, including its one-time secret. Present in this create response only; the secret is never returned again.
Mostrar atributos secundarios
key.id
string
obligatorio
key.key
string
obligatorio
The public app key clients use to connect.
key.secret
string
The key secret, used for server-side request signing. Returned only when the key is created, and never shown again: store it securely. If lost, create a new key and revoke this one.
key.revoked_at
nullable string
obligatorio
When the key was revoked, or null if still active.
key.created_at
string
obligatorio