Skip to main content
View as Markdown

Planning

The Planning object describes a session (planning in the API): its schedule, title and description, format, registration settings, video content, custom fields, evaluations and speakers. It is sent in the planning field of session webhooks.

Planning object​

Fields

  • idstring

    Unique identifier for the planning.

  • event_idstring

    Unique identifier for the event.

  • community_idstring

    Unique identifier for the community.

  • ticket_urlstring

    URL of the ticket associated with the planning.

  • is_overlapping_allowedbool

    Whether overlapping is allowed on this planning.

  • community_profile_can_registerbool

    Whether people can register directly.

  • max_seatsuint32

    The maximum number of seats allowed for this planning.

  • hide_attendeesbool

    Whether attendees are hidden on the planning.

  • is_ratablebool

    Whether attendees can rate this planning.

  • formatstring

    The meeting format.

  • access_control_modestring

    The access control mode set up for this planning.

  • on_demandobject

    Additional information when the planning is on demand.

  • on_demand.idstring

    Unique identifier for the on-demand object.

  • on_demand.available_atstring

    Start date of availability of the on-demand video.

  • on_demand.available_untilstring

    End date of availability of the on-demand video.

  • on_demand.is_publicstring

    Whether the on-demand session is public.

  • on_demand.VideoEmbeddedVideo

    The video of the on-demand session.

  • on_demand.UploadedVideoIdstring

    The identifier of the uploaded video.

  • on_demand.created_atstring

    Creation date of the on-demand object.

  • on_demand.updated_atstring

    Update date of the on-demand object.

  • on_demand.deleted_atstring

    Deletion date of the on-demand object.

  • live_streamobject

    Additional information when the planning is a live stream.

  • live_stream.idstring

    Unique identifier for the live-stream object.

  • live_stream.available_atstring

    Start date of availability of the live-stream.

  • live_stream.available_untilstring

    End date of availability of the live-stream.

  • live_stream.is_publicstring

    Whether the live-stream session is public.

  • live_stream.is_recordedstring

    Whether the live-stream session is recorded.

  • live_stream.StreamEmbeddedVideo

    The stream of the live-stream.

  • live_stream.created_atstring

    Creation date of the on-demand object.

  • live_stream.updated_atstring

    Update date of the on-demand object.

  • live_stream.deleted_atstring

    Deletion date of the on-demand object.

  • pre_recordedobject

    Additional information when the planning is pre-recorded.

  • pre_recorded.idstring

    Unique identifier for the pre-recorded object.

  • pre_recorded.available_atstring

    Start date of availability of the pre-recorded video.

  • pre_recorded.available_untilstring

    End date of availability of the pre-recorded video.

  • pre_recorded.is_publicstring

    Whether the pre-recorded session is public.

  • pre_recorded.VideoEmbeddedVideo

    The video of the pre-recorded session.

  • pre_recorded.UploadedVideoIdstring

    The identifier of the uploaded video.

  • pre_recorded.created_atstring

    Creation date of the pre-recorded object.

  • pre_recorded.updated_atstring

    Update date of the pre-recorded object.

  • pre_recorded.deleted_atstring

    Deletion date of the pre-recorded object.

  • roundtableobject

    Additional information when the planning is a roundtable.

  • roundtable.idstring

    Unique identifier for the roundtable object.

  • roundtable.starts_atstring

    Start date of the roundtable.

  • roundtable.ends_atstring

    End date of the roundtable.

  • roundtable.max_participantsuint32

    Maximum number of participants in the roundtable.

  • roundtable.vonage_session_idstring

    Third-party Vonage session ID.

  • roundtable.providerstring

    Currently only one provider: Vonage.

  • roundtable.video_background_image_urlstring

    URL of the media file for the video background image.

  • roundtable.audio_onlybool

    Whether the roundtable is audio only.

  • roundtable.moderated_stagebool

    Whether the roundtable has a moderated stage.

  • roundtable.deleted_atstring

    Deletion date of the roundtable object.

  • List of custom fields attached to the planning.

  • evaluationsarray of object

    List of evaluations of the planning.

  • evaluations.idstring

    Unique identifier for the evaluation.

  • evaluations.user_idstring

    Unique identifier for the user who submitted the evaluation.

  • evaluations.commentstring

    Evaluation comment of the planning.

  • evaluations.ratingfloat64

    Evaluation rating of the planning.

  • evaluation.created_atstring

    Creation date of the evaluation.

  • evaluation.updated_atstring

    Update date of the evaluation.

  • exhibitor_idsarray of strings

    IDs of the exhibitors taking part in the planning.

  • client_idsarray of strings

    External IDs associated with the planning.

  • created_atstring

    Creation date of the planning.

  • updated_atstring

    Update date of the planning.

  • deleted_atstring

    Deletion date of the planning.

  • begins_atstring

    Start date of the planning.

  • ends_atstring

    End date of the planning.

  • titlestring

    Planning title.

  • text_descriptionstring

    Planning description.

  • description_translationsmap[string]string

    Planning description translations.

  • title_translationsmap[string]string

    Planning title translations.

  • List of speakers attached to the planning.