# Planning

Source: https://swapcard.dev/webhooks/reference/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

<HttpParameters
  title="Fields"
  params={[
    {
      "name": "id",
      "type": "string",
      "description": "Unique identifier for the planning."
    },
    {
      "name": "event_id",
      "type": "string",
      "description": "Unique identifier for the event."
    },
    {
      "name": "community_id",
      "type": "string",
      "description": "Unique identifier for the community."
    },
    {
      "name": "ticket_url",
      "type": "string",
      "description": "URL of the ticket associated with the planning."
    },
    {
      "name": "is_overlapping_allowed",
      "type": "bool",
      "description": "Whether overlapping is allowed on this planning."
    },
    {
      "name": "community_profile_can_register",
      "type": "bool",
      "description": "Whether people can register directly."
    },
    {
      "name": "max_seats",
      "type": "uint32",
      "description": "The maximum number of seats allowed for this planning."
    },
    {
      "name": "hide_attendees",
      "type": "bool",
      "description": "Whether attendees are hidden on the planning."
    },
    {
      "name": "is_ratable",
      "type": "bool",
      "description": "Whether attendees can rate this planning."
    },
    {
      "name": "format",
      "type": "string",
      "description": "The meeting format."
    },
    {
      "name": "access_control_mode",
      "type": "string",
      "description": "The access control mode set up for this planning."
    },
    {
      "name": "on_demand",
      "type": "object",
      "description": "Additional information when the planning is on demand."
    },
    {
      "name": "on_demand.id",
      "type": "string",
      "description": "Unique identifier for the on-demand object."
    },
    {
      "name": "on_demand.available_at",
      "type": "string",
      "description": "Start date of availability of the on-demand video."
    },
    {
      "name": "on_demand.available_until",
      "type": "string",
      "description": "End date of availability of the on-demand video."
    },
    {
      "name": "on_demand.is_public",
      "type": "string",
      "description": "Whether the on-demand session is public."
    },
    {
      "name": "on_demand.Video",
      "type": "EmbeddedVideo",
      "link": "/webhooks/reference/embedded-video",
      "description": "The video of the on-demand session."
    },
    {
      "name": "on_demand.UploadedVideoId",
      "type": "string",
      "description": "The identifier of the uploaded video."
    },
    {
      "name": "on_demand.created_at",
      "type": "string",
      "description": "Creation date of the on-demand object."
    },
    {
      "name": "on_demand.updated_at",
      "type": "string",
      "description": "Update date of the on-demand object."
    },
    {
      "name": "on_demand.deleted_at",
      "type": "string",
      "description": "Deletion date of the on-demand object."
    },
    {
      "name": "live_stream",
      "type": "object",
      "description": "Additional information when the planning is a live stream."
    },
    {
      "name": "live_stream.id",
      "type": "string",
      "description": "Unique identifier for the live-stream object."
    },
    {
      "name": "live_stream.available_at",
      "type": "string",
      "description": "Start date of availability of the live-stream."
    },
    {
      "name": "live_stream.available_until",
      "type": "string",
      "description": "End date of availability of the live-stream."
    },
    {
      "name": "live_stream.is_public",
      "type": "string",
      "description": "Whether the live-stream session is public."
    },
    {
      "name": "live_stream.is_recorded",
      "type": "string",
      "description": "Whether the live-stream session is recorded."
    },
    {
      "name": "live_stream.Stream",
      "type": "EmbeddedVideo",
      "link": "/webhooks/reference/embedded-video",
      "description": "The stream of the live-stream."
    },
    {
      "name": "live_stream.created_at",
      "type": "string",
      "description": "Creation date of the on-demand object."
    },
    {
      "name": "live_stream.updated_at",
      "type": "string",
      "description": "Update date of the on-demand object."
    },
    {
      "name": "live_stream.deleted_at",
      "type": "string",
      "description": "Deletion date of the on-demand object."
    },
    {
      "name": "pre_recorded",
      "type": "object",
      "description": "Additional information when the planning is pre-recorded."
    },
    {
      "name": "pre_recorded.id",
      "type": "string",
      "description": "Unique identifier for the pre-recorded object."
    },
    {
      "name": "pre_recorded.available_at",
      "type": "string",
      "description": "Start date of availability of the pre-recorded video."
    },
    {
      "name": "pre_recorded.available_until",
      "type": "string",
      "description": "End date of availability of the pre-recorded video."
    },
    {
      "name": "pre_recorded.is_public",
      "type": "string",
      "description": "Whether the pre-recorded session is public."
    },
    {
      "name": "pre_recorded.Video",
      "type": "EmbeddedVideo",
      "link": "/webhooks/reference/embedded-video",
      "description": "The video of the pre-recorded session."
    },
    {
      "name": "pre_recorded.UploadedVideoId",
      "type": "string",
      "description": "The identifier of the uploaded video."
    },
    {
      "name": "pre_recorded.created_at",
      "type": "string",
      "description": "Creation date of the pre-recorded object."
    },
    {
      "name": "pre_recorded.updated_at",
      "type": "string",
      "description": "Update date of the pre-recorded object."
    },
    {
      "name": "pre_recorded.deleted_at",
      "type": "string",
      "description": "Deletion date of the pre-recorded object."
    },
    {
      "name": "roundtable",
      "type": "object",
      "description": "Additional information when the planning is a roundtable."
    },
    {
      "name": "roundtable.id",
      "type": "string",
      "description": "Unique identifier for the roundtable object."
    },
    {
      "name": "roundtable.starts_at",
      "type": "string",
      "description": "Start date of the roundtable."
    },
    {
      "name": "roundtable.ends_at",
      "type": "string",
      "description": "End date of the roundtable."
    },
    {
      "name": "roundtable.max_participants",
      "type": "uint32",
      "description": "Maximum number of participants in the roundtable."
    },
    {
      "name": "roundtable.vonage_session_id",
      "type": "string",
      "description": "Third-party Vonage session ID."
    },
    {
      "name": "roundtable.provider",
      "type": "string",
      "description": "Currently only one provider: Vonage."
    },
    {
      "name": "roundtable.video_background_image_url",
      "type": "string",
      "description": "URL of the media file for the video background image."
    },
    {
      "name": "roundtable.audio_only",
      "type": "bool",
      "description": "Whether the roundtable is audio only."
    },
    {
      "name": "roundtable.moderated_stage",
      "type": "bool",
      "description": "Whether the roundtable has a moderated stage."
    },
    {
      "name": "roundtable.deleted_at",
      "type": "string",
      "description": "Deletion date of the roundtable object."
    },
    {
      "name": "field_values",
      "type": "array of FieldValue",
      "link": "/webhooks/reference/field-value",
      "description": "List of custom fields attached to the planning."
    },
    {
      "name": "evaluations",
      "type": "array of object",
      "description": "List of evaluations of the planning."
    },
    {
      "name": "evaluations.id",
      "type": "string",
      "description": "Unique identifier for the evaluation."
    },
    {
      "name": "evaluations.user_id",
      "type": "string",
      "description": "Unique identifier for the user who submitted the evaluation."
    },
    {
      "name": "evaluations.comment",
      "type": "string",
      "description": "Evaluation comment of the planning."
    },
    {
      "name": "evaluations.rating",
      "type": "float64",
      "description": "Evaluation rating of the planning."
    },
    {
      "name": "evaluation.created_at",
      "type": "string",
      "description": "Creation date of the evaluation."
    },
    {
      "name": "evaluation.updated_at",
      "type": "string",
      "description": "Update date of the evaluation."
    },
    {
      "name": "exhibitor_ids",
      "type": "array of strings",
      "description": "IDs of the exhibitors taking part in the planning."
    },
    {
      "name": "client_ids",
      "type": "array of strings",
      "description": "External IDs associated with the planning."
    },
    {
      "name": "created_at",
      "type": "string",
      "description": "Creation date of the planning."
    },
    {
      "name": "updated_at",
      "type": "string",
      "description": "Update date of the planning."
    },
    {
      "name": "deleted_at",
      "type": "string",
      "description": "Deletion date of the planning."
    },
    {
      "name": "begins_at",
      "type": "string",
      "description": "Start date of the planning."
    },
    {
      "name": "ends_at",
      "type": "string",
      "description": "End date of the planning."
    },
    {
      "name": "title",
      "type": "string",
      "description": "Planning title."
    },
    {
      "name": "text_description",
      "type": "string",
      "description": "Planning description."
    },
    {
      "name": "description_translations",
      "type": "map[string]string",
      "description": "Planning description translations."
    },
    {
      "name": "title_translations",
      "type": "map[string]string",
      "description": "Planning title translations."
    },
    {
      "name": "speakers",
      "type": "array of Speaker",
      "link": "/webhooks/reference/speaker",
      "description": "List of speakers attached to the planning."
    },
  ]}
/>
