Skip to main content
POST
Create an RTMP destination

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization-code flow with PKCE.

Headers

X-Workspace-Id
string

Workspace this request operates in — the workspace id (wksp_…) or the organization id, from GET /workspaces. Required with an API key, which carries no workspace (400 WORKSPACE_REQUIRED without it). With an OAuth token it defaults to the workspace the token was issued for. Responds 403 WORKSPACE_FORBIDDEN when the caller is not a current member, rather than falling back to another workspace.

Idempotency-Key
string

Optional client-generated key. A repeated request with the same key, method and path (by the same caller in the same workspace) replays the original response, with Idempotency-Replayed: true, for 24 hours instead of running again — safe retries. The same key with a different body is refused with 422 IDEMPOTENCY_KEY_REUSED (nothing runs): use a new key for each new request. A 5xx answer is not remembered (a retry runs).

Body

application/json
name
string
required
rtmpKey
string
required
rtmpUrl
string
required

Response

Created.

createdAt
string<date-time>
required
id
string
required
kind
enum<string>
required
Available options:
custom_rtmp,
youtube
name
string
required
status
enum<string>
required
Available options:
active,
needs_reauth,
revoked,
disabled
rtmpURL
string | null

Full RTMP ingest URL, e.g. rtmp://live.twitch.tv/app. Null for non-rtmp kinds.

rtmpUrlMasked
string | null

Display-safe RTMP publish URL with the stream key redacted.