Sign inGet Started
Jetzt starten
Anleitungen
API-Referenz
SDKs
CLI
Wissensdatenbank
Changelog

Create a Realtime app

POST
/v1/realtime/apps
bird realtime apps create \
  --connection-counting=true \
  --name chat-production \
  --region eu1
Antwort201
{
  "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.

Anfrage-Nutzlast

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
erforderlich

A label for the app, shown wherever it is listed.

region
string
erforderlich

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.

Antwort-Payload

created_at
string
erforderlich
updated_at
string
erforderlich
client_events
boolean
erforderlich

Allow clients to trigger events directly (client events).

connection_counting
boolean
erforderlich

Count the connections subscribed to each channel and expose the count on channel queries.

connection_count_events
boolean
erforderlich

Broadcast a connection-count event to a channel's subscribers whenever its connection count changes. Requires connection_counting.

watchlist_events
boolean
erforderlich

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
erforderlich

Require every connection to be authorized.

id
string
erforderlich
app_id
integer
erforderlich

The numeric Realtime app id. Use it together with a key and secret to initialize a Realtime client/server SDK. Immutable.

name
string
erforderlich

A label for the app, shown wherever it is listed.

region
string
erforderlich

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
erforderlich

Lifecycle state of the app. active apps serve connections; suspended apps are provisioned but reject connections.

Possible values: active, suspended

key
object
erforderlich

The app's initial key, including its one-time secret. Present in this create response only; the secret is never returned again.

Untergeordnete Attribute anzeigen
key.id
string
erforderlich
key.key
string
erforderlich

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
erforderlich

When the key was revoked, or null if still active.

key.created_at
string
erforderlich

Verwandte Ressourcen

Weiter mit der Dokumentation, Anleitungen und Beispielen zu diesem Thema.

Übung ausprobieren und ein Implementierungs-Briefing erhalten