event_id uuid |
title Title |
description Description — OPTIONAL |
event_type EventTypePossible values: [in-person, online] |
location Location — OPTIONAL |
timezone Timezone — OPTIONAL |
utc_start_dt date-timeEvent start date and time in UTC |
utc_end_dt date-timeEvent end date and time in UTC |
is_recurring Is Recurring — OPTIONALIndicates if the event is recurring |
cover_image_key Cover Image Key — OPTIONAL |
cover_image_url Cover Image Url — OPTIONAL |
qr_code_url uriPossible values: 1 ≤ length ≤ 2083 |
lifecycle_status EventLifecycleStatusV2Possible values: [setup_required, upcoming, ready, live, finished] |
finished_at Finished At — OPTIONALEvent completion time in UTC |
access_code Access Code — OPTIONAL |
input_languages string[] — OPTIONALEvent input languages (aggregated from channels) |
output_languages string[] — OPTIONALEvent output languages (aggregated from channels) |
target_languages string[] — OPTIONALOrganizer-configured default translation languages; pre-fills the language list when creating channels |
listener_language_mode ListenerLanguageMode — OPTIONALPossible values: [off, approval, auto] |
utc_created_at date-timeEvent creation time in UTC |
utc_updated_at date-timeEvent last update time in UTC |
stages object[] — OPTIONALEvent stages with derived status and their channel refs (id + live runtime status) stage_id uuid | event_id uuid | name Name | status StageStatusPossible values: [setup_required, ready, live] | qr_code_url uriPossible values: 1 ≤ length ≤ 2083 | greenscreen_settings Greenscreen Settings — OPTIONALStage caption rendering settings | utc_created_at date-timeStage creation time in UTC | utc_updated_at date-timeStage last update time in UTC | channels object[] — OPTIONALChannels in the stage (lean ref: id, broadcast link, live runtime status) channel_id uuid | broadcast_id Broadcast Id — OPTIONALUnderlying broadcast ID for direct streaming access | runtime_status — OPTIONALLive runtime state of the channel's stream. null = stream not started or status not yet known (not an error). Eventually-consistent: can lag a few seconds behind the actual stream; 'errored' can be transient while a stream (re)starts, so debounce before surfacing an alert. |
|
|