How to create an online session

Use this guide when you need to create a session that takes place online — whether that's a breakout room, a livestream, an on-demand recording, or an external stream.

What you'll need before starting

What you need	Where to get it
Language ID	`GET /api/v2/sessions/getLanguages`
Track ID	`GET /api/v2/sessions/getTracks?event_id=`
Type ID	`GET /api/v2/sessions/getTypes?event_id=`

Online session types

`online_type` value	Description
`1`	Breakout room
`2`	Livestream
`3`	On-demand
`4`	External stream

Request — breakout room

Bash

curl -X POST "https://your-event-domain.com/api/v2/sessions/set" \
  -H "Authorization: Bearer your_api_key_here" \
  -F "event_id=7" \
  -F "title=Product Demo Breakout" \
  -F "language=1" \
  -F "track=2" \
  -F "type=3" \
  -F "date=2030-06-15" \
  -F "startTime=14:00" \
  -F "endTime=15:00" \
  -F "online=true" \
  -F "online_type=1"

Request — livestream with embed code

Bash

curl -X POST "https://your-event-domain.com/api/v2/sessions/set" \
  -H "Authorization: Bearer your_api_key_here" \
  -F "event_id=7" \
  -F "title=Keynote Livestream" \
  -F "language=1" \
  -F "track=2" \
  -F "type=3" \
  -F "date=2030-06-15" \
  -F "startTime=09:00" \
  -F "endTime=10:00" \
  -F "online=true" \
  -F "online_type=2" \
  -F "embed_code=<iframe src='https://stream.example.com/live/keynote'></iframe>"

Request — on-demand

Bash

curl -X POST "https://your-event-domain.com/api/v2/sessions/set" \
  -H "Authorization: Bearer your_api_key_here" \
  -F "event_id=7" \
  -F "title=Recorded Workshop" \
  -F "language=1" \
  -F "track=2" \
  -F "type=3" \
  -F "date=2030-06-15" \
  -F "startTime=09:00" \
  -F "endTime=10:00" \
  -F "online=true" \
  -F "online_type=3"

Response

JSON

{
  "code": 200,
  "response_id": "1700000000.12345",
  "data": {
    "id": 42,
    "status": "created",
    "external_id": null,
    "errors": []
  }
}

Notes

When online=true and online_type is omitted, it defaults to 1 (Breakout)
embed_code is used for Livestream (2) and External (4) types to embed the streaming player
green_room=true enables a green room waiting area for speakers before the session goes live