Add Event Destination

Attach a channel as a destination to an existing event

Info

Required scope: stream.write

Warning

This method requires authentication

Attach an existing channel to an event as a destination. Create the event first with Create Event, and the channel with Add Channel.

curl -X POST \
     -H "Authorization: Bearer [access token]" \
     -H "Content-Type: application/json" \
     -d '{"channelId": 12345, "streamingOrientation": "horizontal"}' \
     https://api.restream.io/v2/user/events/{eventId}/destinations

Path Parameters:

ParameterTypeDescription
eventIdstring (UUID)The UUID of the event (required)

Request Body

FieldTypeDescription
channelIdnumberID of an existing channel that belongs to the authenticated user (required).
streamingOrientationstring"horizontal" or "vertical" (optional). Defaults to "horizontal" when omitted.

Supported Platforms

The channel's platform determines whether it can be attached.

PlatformID
Custom RTMP29
Steam49
Nimo60
Naver61
Mixcloud68
Telegram72
Amazon Live74
Custom SRT78
Substack79
Mux80
Custom WHIP81
Custom HLS82
Info

Channels on other platforms (YouTube, Facebook, Instagram, TikTok, LinkedIn, X) are not yet supported.

Response

Success (201)
Error (Platform Not Supported)
Error (Destination Already Exists)
{
  "id": "8f3b1c2a-1d4e-4a9b-9c7d-2e5f6a7b8c9d"
}