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.
请求载荷
client_events
boolean
connection_counting
boolean
authorized_connections
boolean
name
string
必填
region
object
必填
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.
响应载荷
created_at
string
必填
updated_at
string
必填
client_events
boolean
必填
Allow clients to trigger events directly (client events).
connection_counting
boolean
必填
Emit connection-count events on channels.
authorized_connections
boolean
必填
Require every connection to be authorized.
id
string
必填
app_id
integer
必填
The numeric Realtime app id. Use it together with a key and secret to initialize a Realtime client/server SDK. Immutable.
name
string
必填
region
object
必填
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
必填
Lifecycle state of the app. active apps serve connections; suspended apps are provisioned but reject connections.
Possible values: active, suspended
key
object
必填
The app's initial key, including its one-time secret. Present in this create response only; the secret is never returned again.
显示子属性
key.id
string
必填
key.key
string
必填
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
必填
When the key was revoked, or null if still active.
key.created_at
string
必填