Create a Realtime app
POST
/v1/realtime/apps
curl -X POST "https://us1.platform.bird.com/v1/realtime/apps" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{}'Provisions a new Realtime app for the workspace and returns it together with the initial key. The key secret is included in this response only and is never returned again — store it now; if lost, create a new key and revoke this one.
Treść żądania
client_events
boolean
connection_counting
boolean
authorized_connections
boolean
name
string
wymagane
region
object
wymagane
The region this app runs in. Unlike other Bird products, a Realtime app can be placed in a region other than the workspace's home region. Immutable after creation.
Treść odpowiedzi
created_at
string
wymagane
updated_at
string
wymagane
client_events
boolean
wymagane
Allow clients to trigger events directly (client events).
connection_counting
boolean
wymagane
Emit connection-count events on channels.
authorized_connections
boolean
wymagane
Require every connection to be authorized.
id
string
wymagane
app_id
integer
wymagane
The numeric Realtime app id. Use it together with a key and secret to initialize a Realtime client/server SDK. Immutable.
name
string
wymagane
region
object
wymagane
The region this app runs in. Unlike other Bird products, a Realtime app can be placed in a region other than the workspace's home region. Immutable after creation.
status
string
wymagane
Lifecycle state of the app. active apps serve connections; suspended apps are provisioned but reject connections.
Possible values: active, suspended
key
object
wymagane
The app's initial key, including its one-time secret. Present in this create response only; the secret is never returned again.
Pokaż atrybuty podrzędne
key.id
string
wymagane
key.key
string
wymagane
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
wymagane
When the key was revoked, or null if still active.
key.created_at
string
wymagane