{ "info": { "description": "\n External API that allows you to create, update, and delete lectures\n ", "title": "Talque Lecture Webhook API", "version": "1.0.0" }, "paths": { "/webhook/org/{orgId}/lecture/create": { "post": { "summary": "Create a lecture via webhook", "description": "Creates a new lecture in the organization.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the organization." }, { "name": "X-TQ-CLIENT-ID", "in": "header", "required": true, "schema": { "type": "string" }, "description": "The API client ID for authentication." }, { "name": "X-TQ-SECRET", "in": "header", "required": true, "schema": { "type": "string" }, "description": "The API client secret for authentication." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "extId": { "type": "string", "nullable": true }, "name": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "Title of the lecture." }, "description": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "Abstract of the lecture." }, "descriptionIsMarkdown": { "type": "boolean", "description": "Is the description markdown formatted (only applies to the translated description)." }, "period": { "$schema": "http://json-schema.org/draft-04/schema", "title": "period", "oneOf": [ { "type": "object", "properties": { "periodType": { "type": "string", "enum": [ "INSTANT", "TIME" ] }, "start": { "type": "integer", "minimum": 0 }, "duration": { "type": "integer", "minimum": 0 } }, "required": [ "periodType", "start", "duration" ] }, { "type": "object", "properties": { "periodType": { "type": "string", "enum": [ "FULL_DAY", "MULTI_DAY" ] }, "startDay": { "$ref": "#/$defs/date-array" }, "endDay": { "$ref": "#/$defs/date-array" } }, "required": [ "periodType", "startDay", "endDay" ] } ], "$defs": { "date-array": { "type": "array", "items": [ { "type": "integer", "minimum": 1 }, { "type": "string", "enum": [ "JAN", "FEB", "MAR", "APR", "MAY", "JUN", "JUL", "AUG", "SEP", "OCT", "NOV", "DEZ" ] }, { "type": "integer", "minimum": 1, "maximum": 31 } ] } }, "description": "The time interval of the lecture." }, "surveyUrl": { "type": "string", "description": "Url for the external lecture survey." }, "surveys": { "type": "array", "items": { "type": "string" }, "description": "The talque-internal surveys." }, "isHighlight": { "type": "boolean", "description": "Whether the lecture is marked as a highlight lecture." }, "languages": { "type": "array", "items": { "type": "string" }, "description": "List of languages that the lecture is available in (e.g., ENG, DEU, FRA)." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags of the lecture (for filtering the schedule)." }, "roomId": { "type": "string", "nullable": true, "description": "Room identifier. The room with this ID is where the lecture takes place." }, "mapFeatureId": { "type": "string", "nullable": true, "description": "This lecture takes place at the designated vendor booth (or any other map feature)." }, "topics": { "type": "array", "items": { "type": "string" }, "description": "The topics of the lecture." }, "format": { "type": "string", "nullable": true, "description": "Lecture format." }, "formatId": { "type": "string", "nullable": true, "description": "The unique identifier of the format." }, "photo": { "type": "string", "nullable": true, "description": "Temp file identifier for the lecture photo." }, "speakerRoles": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "additionalProperties": { "type": "string", "minLength": 1 }, "description": "\nMap of speaker profile identifiers to their participant category\n(e.g., 'MODERATOR'). That is, an object of the form\n\n \"speakerRoles\": {\n \"\": \"\"\n }\n" }, "vendors": { "type": "array", "items": { "type": "string" }, "description": "A list of vendor identifiers associated with the lecture." }, "isPublished": { "type": "boolean", "description": "Whether the talk is published and visible to normal org participants." }, "isPublic": { "type": "boolean", "description": "Whether the talk should be part of the public web page." }, "isBlocker": { "type": "boolean", "description": "Whether this lecture blocks the entire schedule." }, "isMeetBlocker": { "type": "boolean", "description": "Event blocks meeting requests." }, "partCollection": { "$schema": "http://json-schema.org/draft-04/schema", "title": "lecture part collection change", "type": "object", "properties": { "isDeckEnabled": { "type": "boolean" }, "isCustomDataEnabled": { "type": "boolean" }, "parts": { "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "partId": { "type": [ "string", "null" ] }, "speakers": { "type": "array", "items": { "type": "string" } }, "name": { "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false }, "description": { "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false }, "descriptionIsMarkdown": { "type": "boolean" }, "deck": { "oneOf": [ { "$schema": "http://json-schema.org/draft-04/schema", "oneOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "ADD_FILE" ] }, "tempFileId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "action", "tempFileId", "name" ] }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "KEEP_FILE" ] }, "fileId": { "type": "string" } }, "required": [ "action", "fileId" ] }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "REMOVE_FILE" ] }, "fileId": { "type": "string" } }, "required": [ "action", "fileId" ] } ] }, { "type": "null" } ] }, "adminDeck": { "oneOf": [ { "$schema": "http://json-schema.org/draft-04/schema", "oneOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "ADD_FILE" ] }, "tempFileId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "action", "tempFileId", "name" ] }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "KEEP_FILE" ] }, "fileId": { "type": "string" } }, "required": [ "action", "fileId" ] }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "REMOVE_FILE" ] }, "fileId": { "type": "string" } }, "required": [ "action", "fileId" ] } ] }, { "type": "null" } ] }, "files": { "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema", "oneOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "ADD_FILE" ] }, "tempFileId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "action", "tempFileId", "name" ] }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "KEEP_FILE" ] }, "fileId": { "type": "string" } }, "required": [ "action", "fileId" ] }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "REMOVE_FILE" ] }, "fileId": { "type": "string" } }, "required": [ "action", "fileId" ] } ] } }, "customData": { "type": "object" } }, "required": [ "partId", "speakers", "name", "description", "descriptionIsMarkdown", "deck", "adminDeck", "files", "customData" ] } }, "deck": { "oneOf": [ { "$schema": "http://json-schema.org/draft-04/schema", "oneOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "ADD_FILE" ] }, "tempFileId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "action", "tempFileId", "name" ] }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "KEEP_FILE" ] }, "fileId": { "type": "string" } }, "required": [ "action", "fileId" ] }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "REMOVE_FILE" ] }, "fileId": { "type": "string" } }, "required": [ "action", "fileId" ] } ] }, { "type": "null" } ] }, "adminDeck": { "oneOf": [ { "$schema": "http://json-schema.org/draft-04/schema", "oneOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "ADD_FILE" ] }, "tempFileId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "action", "tempFileId", "name" ] }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "KEEP_FILE" ] }, "fileId": { "type": "string" } }, "required": [ "action", "fileId" ] }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "REMOVE_FILE" ] }, "fileId": { "type": "string" } }, "required": [ "action", "fileId" ] } ] }, { "type": "null" } ] }, "files": { "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema", "oneOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "ADD_FILE" ] }, "tempFileId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "action", "tempFileId", "name" ] }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "KEEP_FILE" ] }, "fileId": { "type": "string" } }, "required": [ "action", "fileId" ] }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "REMOVE_FILE" ] }, "fileId": { "type": "string" } }, "required": [ "action", "fileId" ] } ] } }, "customData": { "type": "object" } }, "required": [ "isDeckEnabled", "isCustomDataEnabled", "parts", "deck", "adminDeck", "customData" ], "description": "Files (slide deck and misc files) and data about sub-sessions if there are any." }, "enrollment": { "type": "string", "enum": [ "FREE", "TICKET", "APPLICATION_PROCESS", "CLOSED" ], "description": "Who can change enrollment for this lecture." }, "isApplicationEnabled": { "type": "boolean", "description": "Whether applications are currently enabled." }, "video": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "nullable": true, "description": "Optional embedded livestream or archived video of the lecture." }, "lectureVideo": { "type": "string", "enum": [ "NONE", "ROOM_STREAM", "LECTURE_VOD", "SELF_HOSTED_LIVESTREAM", "EXTERNAL_URL" ], "description": "Setting for where this lecture takes its video from." }, "player.vodTime": { "type": "string", "enum": [ "START", "CURRENT", "RELATIVE" ], "description": "Settings for how the video content is being played back." }, "excludeTickets": { "type": "array", "items": { "type": "string" }, "description": "Determine which ticket holders can see this lecture." }, "unauthorized.isVisible": { "type": "boolean", "description": "Is the lecture visible to unauthorized users." }, "unauthorized.video": { "type": "boolean", "description": "Is the video visible to unauthorized users." }, "course": { "type": "string", "enum": [ "HYBRID", "ON_SITE", "VIRTUAL" ], "description": "How the lecture takes place: on-site, virtual, hybrid." }, "commentChat": { "type": "boolean", "description": "Is the chat for the lecture enabled." }, "chatEngagement": { "type": "string", "enum": [ "NONE", "COMMENTS", "QUESTIONS", "POLLS" ], "description": "Engagement messages in the comment chat." }, "showAttendeeList": { "type": "boolean", "description": "Show the attendee list or not." }, "capacity": { "type": "integer", "nullable": true, "description": "Optional amount of allowed participants. A capacity of zero sets the lecture to waitlist only." } }, "required": [ "name", "description", "descriptionIsMarkdown", "period", "surveyUrl", "isHighlight", "languages", "isPublic", "isBlocker", "isMeetBlocker", "partCollection", "enrollment", "course" ] } } } }, "responses": { "200": { "description": "Lecture successfully created", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Whether the lecture was successfully created." }, "lecture": { "type": "object", "properties": { "lectureId": { "type": "string", "description": "Unique identifier for the lecture." }, "extId": { "type": "string", "nullable": true, "description": "Optional external identifier." }, "mtime": { "type": "string", "format": "date-time", "description": "Last modification time of the record." }, "name": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "Title of the lecture." }, "description": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "Abstract of the lecture." }, "period": { "$schema": "http://json-schema.org/draft-04/schema", "title": "period", "oneOf": [ { "type": "object", "properties": { "periodType": { "type": "string", "enum": [ "INSTANT", "TIME" ] }, "start": { "type": "integer", "minimum": 0 }, "duration": { "type": "integer", "minimum": 0 } }, "required": [ "periodType", "start", "duration" ] }, { "type": "object", "properties": { "periodType": { "type": "string", "enum": [ "FULL_DAY", "MULTI_DAY" ] }, "startDay": { "$ref": "#/$defs/date-array" }, "endDay": { "$ref": "#/$defs/date-array" } }, "required": [ "periodType", "startDay", "endDay" ] } ], "$defs": { "date-array": { "type": "array", "items": [ { "type": "integer", "minimum": 1 }, { "type": "string", "enum": [ "JAN", "FEB", "MAR", "APR", "MAY", "JUN", "JUL", "AUG", "SEP", "OCT", "NOV", "DEZ" ] }, { "type": "integer", "minimum": 1, "maximum": 31 } ] } }, "description": "The time interval of the lecture." }, "roomId": { "type": "string", "nullable": true, "description": "Room identifier. The room with this ID is where the lecture takes place." }, "isPublished": { "type": "boolean", "description": "Whether the talk is published and visible to normal org participants." }, "isPublic": { "type": "boolean", "description": "Whether the talk should be part of the public web page." }, "isBlocker": { "type": "boolean", "description": "Whether this lecture blocks the entire schedule." }, "isHighlight": { "type": "boolean", "description": "Whether the lecture is marked as a highlight lecture." }, "format": { "type": "string", "nullable": true, "description": "Lecture format." }, "topics": { "type": "array", "items": { "type": "string" }, "description": "The topics of the lecture." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags of the lecture (for filtering the schedule)." }, "languages": { "type": "array", "items": { "type": "string" }, "description": "List of languages that the lecture is available in (e.g., ENG, DEU, FRA)." }, "speakers": { "type": "array", "items": { "type": "string" }, "description": "List of speaker identifiers. This includes presenters." }, "speakerRoles": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "additionalProperties": { "type": "string", "minLength": 1 }, "description": "\nMap of speaker profile identifiers to their participant category\n(e.g., 'MODERATOR'). That is, an object of the form\n\n \"speakerRoles\": {\n \"\": \"\"\n }\n" }, "capacity": { "type": "integer", "nullable": true, "description": "Optional amount of allowed participants. A capacity of zero sets the lecture to waitlist only." }, "course": { "type": "string", "description": "How the lecture takes place: on-site, virtual, hybrid." } }, "required": [ "lectureId", "mtime", "name", "period" ] } }, "required": [ "success", "lecture" ] } } } }, "400": { "description": "Bad request (e.g., lecture already exists or missing required fields)" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Organization not found" } } } }, "/webhook/org/{orgId}/lecture/update": { "post": { "summary": "Update a lecture via webhook", "description": "Updates an existing lecture in the organization.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the organization." }, { "name": "X-TQ-CLIENT-ID", "in": "header", "required": true, "schema": { "type": "string" }, "description": "The API client ID for authentication." }, { "name": "X-TQ-SECRET", "in": "header", "required": true, "schema": { "type": "string" }, "description": "The API client secret for authentication." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "lectureId": { "type": "string", "description": "Unique identifier for the lecture." }, "extId": { "type": "string", "nullable": true, "description": "Optional external identifier." }, "name": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "Title of the lecture." }, "description": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "Abstract of the lecture." }, "descriptionIsMarkdown": { "type": "boolean", "description": "Is the description markdown formatted (only applies to the translated description)." }, "period": { "$schema": "http://json-schema.org/draft-04/schema", "title": "period", "oneOf": [ { "type": "object", "properties": { "periodType": { "type": "string", "enum": [ "INSTANT", "TIME" ] }, "start": { "type": "integer", "minimum": 0 }, "duration": { "type": "integer", "minimum": 0 } }, "required": [ "periodType", "start", "duration" ] }, { "type": "object", "properties": { "periodType": { "type": "string", "enum": [ "FULL_DAY", "MULTI_DAY" ] }, "startDay": { "$ref": "#/$defs/date-array" }, "endDay": { "$ref": "#/$defs/date-array" } }, "required": [ "periodType", "startDay", "endDay" ] } ], "$defs": { "date-array": { "type": "array", "items": [ { "type": "integer", "minimum": 1 }, { "type": "string", "enum": [ "JAN", "FEB", "MAR", "APR", "MAY", "JUN", "JUL", "AUG", "SEP", "OCT", "NOV", "DEZ" ] }, { "type": "integer", "minimum": 1, "maximum": 31 } ] } }, "description": "The time interval of the lecture." }, "surveyUrl": { "type": "string", "description": "Url for the external lecture survey." }, "surveys": { "type": "array", "items": { "type": "string" }, "description": "The talque-internal surveys." }, "isHighlight": { "type": "boolean", "description": "Whether the lecture is marked as a highlight lecture." }, "languages": { "type": "array", "items": { "type": "string" }, "description": "List of languages that the lecture is available in (e.g., ENG, DEU, FRA)." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags of the lecture (for filtering the schedule)." }, "roomId": { "type": "string", "nullable": true, "description": "Room identifier. The room with this ID is where the lecture takes place." }, "mapFeatureId": { "type": "string", "nullable": true, "description": "This lecture takes place at the designated vendor booth (or any other map feature)." }, "topics": { "type": "array", "items": { "type": "string" }, "description": "The topics of the lecture." }, "format": { "type": "string", "nullable": true, "description": "Lecture format." }, "formatId": { "type": "string", "nullable": true, "description": "The unique identifier of the format." }, "photo": { "type": "string", "nullable": true, "description": "Temp file identifier for the lecture photo." }, "speakerRoles": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "additionalProperties": { "type": "string", "minLength": 1 }, "description": "Map of speaker identifiers to special roles (e.g., 'MODERATOR')." }, "vendors": { "type": "array", "items": { "type": "string" }, "description": "A list of vendor identifiers associated with the lecture." }, "isPublished": { "type": "boolean", "description": "Whether the talk is published and visible to normal org participants." }, "isPublic": { "type": "boolean", "description": "Whether the talk should be part of the public web page." }, "isBlocker": { "type": "boolean", "description": "Whether this lecture blocks the entire schedule." }, "isMeetBlocker": { "type": "boolean", "description": "Event blocks meeting requests." }, "partCollection": { "$schema": "http://json-schema.org/draft-04/schema", "title": "lecture part collection change", "type": "object", "properties": { "isDeckEnabled": { "type": "boolean" }, "isCustomDataEnabled": { "type": "boolean" }, "parts": { "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "partId": { "type": [ "string", "null" ] }, "speakers": { "type": "array", "items": { "type": "string" } }, "name": { "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false }, "description": { "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false }, "descriptionIsMarkdown": { "type": "boolean" }, "deck": { "oneOf": [ { "$schema": "http://json-schema.org/draft-04/schema", "oneOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "ADD_FILE" ] }, "tempFileId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "action", "tempFileId", "name" ] }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "KEEP_FILE" ] }, "fileId": { "type": "string" } }, "required": [ "action", "fileId" ] }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "REMOVE_FILE" ] }, "fileId": { "type": "string" } }, "required": [ "action", "fileId" ] } ] }, { "type": "null" } ] }, "adminDeck": { "oneOf": [ { "$schema": "http://json-schema.org/draft-04/schema", "oneOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "ADD_FILE" ] }, "tempFileId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "action", "tempFileId", "name" ] }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "KEEP_FILE" ] }, "fileId": { "type": "string" } }, "required": [ "action", "fileId" ] }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "REMOVE_FILE" ] }, "fileId": { "type": "string" } }, "required": [ "action", "fileId" ] } ] }, { "type": "null" } ] }, "files": { "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema", "oneOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "ADD_FILE" ] }, "tempFileId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "action", "tempFileId", "name" ] }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "KEEP_FILE" ] }, "fileId": { "type": "string" } }, "required": [ "action", "fileId" ] }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "REMOVE_FILE" ] }, "fileId": { "type": "string" } }, "required": [ "action", "fileId" ] } ] } }, "customData": { "type": "object" } }, "required": [ "partId", "speakers", "name", "description", "descriptionIsMarkdown", "deck", "adminDeck", "files", "customData" ] } }, "deck": { "oneOf": [ { "$schema": "http://json-schema.org/draft-04/schema", "oneOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "ADD_FILE" ] }, "tempFileId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "action", "tempFileId", "name" ] }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "KEEP_FILE" ] }, "fileId": { "type": "string" } }, "required": [ "action", "fileId" ] }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "REMOVE_FILE" ] }, "fileId": { "type": "string" } }, "required": [ "action", "fileId" ] } ] }, { "type": "null" } ] }, "adminDeck": { "oneOf": [ { "$schema": "http://json-schema.org/draft-04/schema", "oneOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "ADD_FILE" ] }, "tempFileId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "action", "tempFileId", "name" ] }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "KEEP_FILE" ] }, "fileId": { "type": "string" } }, "required": [ "action", "fileId" ] }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "REMOVE_FILE" ] }, "fileId": { "type": "string" } }, "required": [ "action", "fileId" ] } ] }, { "type": "null" } ] }, "files": { "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema", "oneOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "ADD_FILE" ] }, "tempFileId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "action", "tempFileId", "name" ] }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "KEEP_FILE" ] }, "fileId": { "type": "string" } }, "required": [ "action", "fileId" ] }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "REMOVE_FILE" ] }, "fileId": { "type": "string" } }, "required": [ "action", "fileId" ] } ] } }, "customData": { "type": "object" } }, "required": [ "isDeckEnabled", "isCustomDataEnabled", "parts", "deck", "adminDeck", "customData" ], "description": "Files (slide deck and misc files) and data about sub-sessions if there are any." }, "enrollment": { "type": "string", "enum": [ "FREE", "TICKET", "APPLICATION_PROCESS", "CLOSED" ], "description": "Who can change enrollment for this lecture." }, "isApplicationEnabled": { "type": "boolean", "description": "Whether applications are currently enabled." }, "video": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "nullable": true, "description": "Optional embedded livestream or archived video of the lecture." }, "lectureVideo": { "type": "string", "enum": [ "NONE", "ROOM_STREAM", "LECTURE_VOD", "SELF_HOSTED_LIVESTREAM", "EXTERNAL_URL" ], "description": "Setting for where this lecture takes its video from." }, "player.vodTime": { "type": "string", "enum": [ "START", "CURRENT", "RELATIVE" ], "description": "Settings for how the video content is being played back." }, "excludeTickets": { "type": "array", "items": { "type": "string" }, "description": "Determine which ticket holders can see this lecture." }, "unauthorized.isVisible": { "type": "boolean", "description": "Is the lecture visible to unauthorized users." }, "unauthorized.video": { "type": "boolean", "description": "Is the video visible to unauthorized users." }, "course": { "type": "string", "enum": [ "HYBRID", "ON_SITE", "VIRTUAL" ], "description": "How the lecture takes place: on-site, virtual, hybrid." }, "commentChat": { "type": "boolean", "description": "Is the chat for the lecture enabled." }, "chatEngagement": { "type": "string", "enum": [ "NONE", "COMMENTS", "QUESTIONS", "POLLS" ], "description": "Engagement messages in the comment chat." }, "showAttendeeList": { "type": "boolean", "description": "Show the attendee list or not." }, "capacity": { "type": "integer", "nullable": true, "description": "Optional amount of allowed participants. A capacity of zero sets the lecture to waitlist only." } }, "description": "Identification of the lecture to be updated (lectureId or extId) and the fields to update." } } } }, "responses": { "200": { "description": "Lecture successfully updated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Whether the lecture was successfully updated." }, "lecture": { "type": "object", "properties": { "lectureId": { "type": "string", "description": "Unique identifier for the lecture." }, "extId": { "type": "string", "nullable": true, "description": "Optional external identifier." }, "mtime": { "type": "string", "format": "date-time", "description": "Last modification time of the record." }, "name": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "Title of the lecture." }, "description": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "Abstract of the lecture." }, "period": { "$schema": "http://json-schema.org/draft-04/schema", "title": "period", "oneOf": [ { "type": "object", "properties": { "periodType": { "type": "string", "enum": [ "INSTANT", "TIME" ] }, "start": { "type": "integer", "minimum": 0 }, "duration": { "type": "integer", "minimum": 0 } }, "required": [ "periodType", "start", "duration" ] }, { "type": "object", "properties": { "periodType": { "type": "string", "enum": [ "FULL_DAY", "MULTI_DAY" ] }, "startDay": { "$ref": "#/$defs/date-array" }, "endDay": { "$ref": "#/$defs/date-array" } }, "required": [ "periodType", "startDay", "endDay" ] } ], "$defs": { "date-array": { "type": "array", "items": [ { "type": "integer", "minimum": 1 }, { "type": "string", "enum": [ "JAN", "FEB", "MAR", "APR", "MAY", "JUN", "JUL", "AUG", "SEP", "OCT", "NOV", "DEZ" ] }, { "type": "integer", "minimum": 1, "maximum": 31 } ] } }, "description": "The time interval of the lecture." }, "roomId": { "type": "string", "nullable": true, "description": "Room identifier. The room with this ID is where the lecture takes place." }, "isPublished": { "type": "boolean", "description": "Whether the talk is published and visible to normal org participants." }, "isPublic": { "type": "boolean", "description": "Whether the talk should be part of the public web page." }, "isBlocker": { "type": "boolean", "description": "Whether this lecture blocks the entire schedule." }, "isHighlight": { "type": "boolean", "description": "Whether the lecture is marked as a highlight lecture." }, "format": { "type": "string", "nullable": true, "description": "Lecture format." }, "topics": { "type": "array", "items": { "type": "string" }, "description": "The topics of the lecture." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags of the lecture (for filtering the schedule)." }, "languages": { "type": "array", "items": { "type": "string" }, "description": "List of languages that the lecture is available in (e.g., ENG, DEU, FRA)." }, "speakers": { "type": "array", "items": { "type": "string" }, "description": "List of speaker identifiers. This includes presenters." }, "speakerRoles": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "additionalProperties": { "type": "string", "minLength": 1 }, "description": "Map of speaker identifiers to special roles (e.g., 'MODERATOR')." }, "capacity": { "type": "integer", "nullable": true, "description": "Optional amount of allowed participants. A capacity of zero sets the lecture to waitlist only." }, "course": { "type": "string", "description": "How the lecture takes place: on-site, virtual, hybrid." } }, "required": [ "lectureId", "mtime", "name", "period" ] } }, "required": [ "success", "lecture" ] } } } }, "400": { "description": "Bad request (e.g., missing lectureId/extId or invalid data)" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Organization or Lecture not found" } } } }, "/webhook/org/{orgId}/lecture/delete": { "post": { "summary": "Delete a lecture via webhook", "description": "Permanently deletes a lecture and all its associated data. The lecture can be identified by its talque lectureId or by an external identifier (extId) previously associated with it.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the organization." }, { "name": "X-TQ-CLIENT-ID", "in": "header", "required": true, "schema": { "type": "string" }, "description": "The API client ID for authentication." }, { "name": "X-TQ-SECRET", "in": "header", "required": true, "schema": { "type": "string" }, "description": "The API client secret for authentication." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "lectureId": { "type": "string", "description": "Unique identifier for the lecture." }, "extId": { "type": "string", "description": "The external identifier of the lecture as used in your system." } }, "description": "Identification of the lecture to be deleted. One of lectureId or extId must be provided." } } } }, "responses": { "200": { "description": "The lecture was successfully deleted.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Indicates if the lecture was successfully deleted." }, "lectureId": { "type": "string", "description": "Unique identifier for the lecture." } }, "required": [ "success", "lectureId" ] } } } }, "400": { "description": "Bad request. Occurs if neither lectureId nor extId is provided, or if the orgId is invalid." }, "401": { "description": "Unauthorized. Missing or invalid X-TQ-CLIENT-ID or X-TQ-SECRET headers." }, "403": { "description": "Forbidden. The API client does not have permission to delete lectures in this organization." }, "404": { "description": "Not Found. The organization or the specified lecture could not be found." } } } } }, "openapi": "3.0.3" }