Cvent Registration Webcasts API

Webcasts are virtual or livestreaming components of your Cvent events. Use these APIs to integrate your virtual events from outside sources into your Cvent workflows, create and delete webcasts from within Cvent, and retrieve and update webcast details.

Operations 11

POST /webcasts Create Webcast #
GET /webcasts List Webcasts #
GET /webcasts/players List Players #
GET /webcasts/{id} Get Webcast #
DELETE /webcasts/{id} Delete Webcast #
PUT /webcasts/{id} Update Webcast #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/cvent-registration-webcasts-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cvent-registration-webcasts-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Cvent REST Webcasts API
  description: '# Introduction

    The Cvent API Platform is built around REST.'
  contact:
    name: Cvent Development Platform
    url: https://developers.cvent.com/
  version: ea
servers:
- url: https://api-platform.cvent.com/ea
- url: https://api-platform-eur.cvent.com/ea
tags:
- name: Webcasts
  description: Webcasts are virtual or livestreaming components of your Cvent events. Use these APIs to integrate your virtual events from outside sources into your Cvent workflows, create and delete webcasts from within Cvent, and retrieve and update webcast details.
paths:
  /webcasts:
    post:
      tags:
      - Webcasts
      operationId: createWebcast
      security:
      - OAuth2.clientCredentials:
        - event/webcasts:write
      - OAuth2.authorizationCode:
        - event/webcasts:write
      summary: Create Webcast
      description: Used to create a new webcast for a specific event.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/webcast'
        required: true
      responses:
        '200':
          description: Webcast was successfully integrated for specific event.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/existing-webcast'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '409':
          $ref: '#/components/responses/Conflict1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    get:
      security:
      - OAuth2.clientCredentials:
        - event/webcasts:read
      - OAuth2.authorizationCode:
        - event/webcasts:read
      summary: List Webcasts
      description: Gets a paginated list of webcasts associated with your event.
      operationId: listWebcasts
      parameters:
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/before'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - name: filter
        in: query
        required: false
        description: 'Use filter query parameters to limit results

          to data that matches your criteria. See

          [Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.


          Supported fields and operators are listed below:


          | Field          | Operators                                |

          |----------------|------------------------------------------|

          | id             | `eq`, `ne`                               |

          | event.id       | `eq`, `ne`                               |

          | session.id     | `eq`, `ne`, `is empty`, `is not empty`   |

          | appointment.id | `eq`, `ne`, `is empty`, `is not empty`   |

          | exhibitor.id   | `eq`, `ne`, `is empty`, `is not empty`   |

          | sourceId       | `eq`, `ne`, `is empty`, `is not empty`   |

          | solutionType   | `eq`, `ne`                               |

          | provider       | `eq`, `ne`                               |

          | type           | `eq`, `ne`                               |

          | status         | `eq`, `ne`                               |

          | meetingId      | `eq`, `ne`                               |

          | created        | `eq`, `ne`, `lt`, `le`, `gt`, `ge`       |

          | lastModified   | `eq`, `ne`, `lt`, `le`, `gt`, `ge`       |

          | playerType     | `eq`, `ne`                               |

          '
        schema:
          type: string
          example: event.id eq '04ca6ae2-0dc3-487b-953e-86d6abbdf7d3' and sourceId ne 'sampleWebcastSystemId'
      tags:
      - Webcasts
      responses:
        '200':
          description: Successfully retrieved a paginated list of webcasts.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webcast-paginated-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
  /webcasts/attendee-links:
    get:
      security:
      - OAuth2.clientCredentials:
        - event/attendee-links:read
      - OAuth2.authorizationCode:
        - event/attendee-links:read
      summary: List Attendee Links
      description: Gets a paginated list of attendee links.
      operationId: listAttendeeLinks
      parameters:
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/before'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - name: filter
        in: query
        required: false
        description: 'Use filter query parameters to limit results

          to data that matches your criteria. See

          [Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.


          Supported fields and operators are listed below:


          | Field        | Operators                          |

          |--------------| -----------------------------------|

          | id           | `eq`, `ne`                         |

          | sourceId     | `eq`, `ne`                         |

          | attendee.id  | `eq`, `ne`                         |

          | webcast.id   | `eq`, `ne`                         |

          | created      | `eq`, `ne`, `lt`, `le`, `gt`, `ge` |

          | lastModified | `eq`, `ne`, `lt`, `le`, `gt`, `ge` |

          '
        schema:
          type: string
          example: id eq '04ca6ae2-0dc3-487b-953e-86d6abbdf7d3' and event.id eq '55ca6645-0dc3-487b-953e-86d6abbdf7d3'
      tags:
      - Webcasts
      responses:
        '200':
          description: Successfully retrieved a paginated list of attendee links.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/attendee-link-paginated-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
  /webcasts/players:
    get:
      security:
      - OAuth2.clientCredentials:
        - event/players:read
      - OAuth2.authorizationCode:
        - event/players:read
      summary: List Players
      description: Gets a paginated list of player details associated with webcast.
      operationId: listPlayers
      parameters:
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/before'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - name: filter
        in: query
        required: false
        description: 'Use filter query parameters to limit results

          to data that matches your criteria. See

          [Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.


          Supported fields and operators are listed below:


          | Field        | Operators                          |

          |--------------| -----------------------------------|

          | webcast.id   | `eq`, `ne`                         |

          | id           | `eq`, `ne`                         |

          | created      | `eq`, `ne`, `lt`, `le`, `gt`, `ge` |

          | lastModified | `eq`, `ne`, `lt`, `le`, `gt`, `ge` |

          '
        schema:
          type: string
          example: webcast.id eq '04ca6ae2-0dc3-487b-953e-86d6abbdf7d3'
      tags:
      - Webcasts
      responses:
        '200':
          description: Successfully retrieved a paginated list of players.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/player-paginated-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
  /webcasts/{id}:
    parameters:
    - $ref: '#/components/parameters/id13'
    get:
      summary: Get Webcast
      description: Retrieve a single webcast details by ID.
      operationId: getWebcastById
      security:
      - OAuth2.clientCredentials:
        - event/webcasts:read
      - OAuth2.authorizationCode:
        - event/webcasts:read
      tags:
      - Webcasts
      responses:
        '200':
          description: Successfully retrieved a webcast object.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/existing-webcast'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    delete:
      summary: Delete Webcast
      description: Delete an existing webcast by ID.
      operationId: deleteWebcast
      security:
      - OAuth2.clientCredentials:
        - event/webcasts:delete
      - OAuth2.authorizationCode:
        - event/webcasts:delete
      tags:
      - Webcasts
      responses:
        '204':
          description: Successfully deleted webcast from specific event.
          headers: {}
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    put:
      tags:
      - Webcasts
      operationId: updateWebcast
      security:
      - OAuth2.clientCredentials:
        - event/webcasts:write
      - OAuth2.authorizationCode:
        - event/webcasts:write
      summary: Update Webcast
      description: Update info for an existing webcast within a Cvent event.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/existing-webcast'
        required: true
      responses:
        '200':
          description: Webcast was successfully updated for specific event.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/existing-webcast'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '409':
          $ref: '#/components/responses/Conflict1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
  /webcasts/{id}/attendee-links:
    parameters:
    - $ref: '#/components/parameters/id13'
    post:
      tags:
      - Webcasts
      operationId: createAttendeeLinks
      security:
      - OAuth2.clientCredentials:
        - event/attendee-links:write
      - OAuth2.authorizationCode:
        - event/attendee-links:write
      summary: Create Attendee Link
      description: Create attendee links in bulk for a given webcast.
      requestBody:
        description: Up to **100 attendee links** can be created per call.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bulk-attendee-link'
        required: true
      responses:
        '207':
          description: Attendee links successfully created.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/attendee-link-bulk-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    put:
      tags:
      - Webcasts
      operationId: updateAttendeeLinks
      security:
      - OAuth2.clientCredentials:
        - event/attendee-links:write
      - OAuth2.authorizationCode:
        - event/attendee-links:write
      summary: Update Attendee Link
      description: Update data for existing attendee links in bulk for a given webcast.
      requestBody:
        description: Up to **100 attendee links** can be updated per call.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bulk-existing-attendee-link'
        required: true
      responses:
        '207':
          description: Attendee links successfully updated.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/attendee-link-bulk-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    get:
      security:
      - OAuth2.clientCredentials:
        - event/attendee-links:read
      - OAuth2.authorizationCode:
        - event/attendee-links:read
      summary: List Attendee Links
      description: Gets a paginated list of attendee links in a webcast.
      operationId: listWebcastAttendeeLinks
      parameters:
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/before'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - name: filter
        in: query
        required: false
        description: 'Use filter query parameters to limit results

          to data that matches your criteria. See

          [Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.


          Supported fields and operators are listed below:


          | Field        | Operators                          |

          |--------------| -----------------------------------|

          | id           | `eq`, `ne`                         |

          | sourceId     | `eq`, `ne`                         |

          | attendee.id  | `eq`, `ne`                         |

          | created      | `eq`, `ne`, `lt`, `le`, `gt`, `ge` |

          | lastModified | `eq`, `ne`, `lt`, `le`, `gt`, `ge` |

          '
        schema:
          type: string
          example: id eq '04ca6ae2-0dc3-487b-953e-86d6abbdf7d3'
      tags:
      - Webcasts
      responses:
        '200':
          description: Successfully retrieved a paginated list of attendee links.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/attendee-link-paginated-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: true
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
  /webcasts/{id}/attendee-links/{attendeeLinkId}:
    parameters:
    - $ref: '#/components/parameters/id13'
    - $ref: '#/components/parameters/attendeeLinkId'
    delete:
      summary: Delete Attendee Link
      description: Delete attendee links for webcast.
      operationId: deleteAttendeeLink
      security:
      - OAuth2.clientCredentials:
        - event/attendee-links:delete
      - OAuth2.authorizationCode:
        - event/attendee-links:delete
      tags:
      - Webcasts
      responses:
        '204':
          description: Successfully deleted webcast attendee link from specific event.
          headers: {}
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
components:
  schemas:
    uuid-property:
      title: UUID Property
      description: A string that has to be a format matching the industry standard uuid
      type: string
      format: uuid
      example: 04ca6ae2-0dc3-487b-953e-86d6abbdf7d3
    webcast-delete-bulk-item.json:
      title: WebcastDeletedBulkResponseItem
      description: This entity is used to represent a single item that is returned as part of a bulk request call.
      allOf:
      - title: BulkResponseItem
        description: Represents a single item that is returned as part of a Bulk request call.
        type: object
        required:
        - status
        - data
        properties:
          data:
            type: object
            description: The data returned for a single item in the bulk request call.
            example:
              event_id: 1234
              attendee_count: 50
            additionalProperties: true
          status:
            type: integer
            description: http status code representing processing status of a single item
            example: 400
          message:
            type: string
            description: Quick description of what happened with processing
            example: Example error message.
          request:
            type: object
            description: The processed request tied to this response. This field is only sent when processing fails.
            example:
              operation: PUT
              headers:
                header1: header1Value
                header2: header2Value
              queryParams:
                param1: param1Value
                param2: param2Value
            additionalProperties: true
        additionalProperties: false
      properties:
        data:
          title: Webcasts
          oneOf:
          - title: WebcastId
            type: object
            description: deleted webcast
            required:
            - id
            properties:
              id:
                type: string
                format: uuid
                description: Id of the webcast.
                example: 9463c74e-18c6-401a-a710-ae0f485bf059
          - $ref: '#/components/schemas/error-response'
    solution-type.json:
      title: SolutionType
      enum:
      - Cvent Video Conferencing
      - External Platform
      - Cvent Studio
      - Embedded Cvent Video Conferencing
      - Cvent Studio Lite
      - Embedded Cvent Studio
      type: string
      description: This is used to denote the solution type to be used for webcast. The 'Cvent Video Conferencing' refers to the video experience which links out the Attendee hub whereas 'Embedded Cvent Video Conferencing' refers to the video experience within the Attendee hub.
      readOnly: true
      example: External Platform
    player-type.json:
      title: PlayerType
      enum:
      - Cvent Video Player
      - Brightcove
      - Vimeo
      - Weblink
      type: string
      description: This is used to denote the type of a video player
      example: Cvent Video Player
    webcast-paginated-response:
      title: WebcastPaginatedResponse
      description: The response from a request to get the list of webcasts.  This includes the paging object as well as the collection of webcasts.
      required:
      - paging
      - data
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/paging.json'
        data:
          type: array
          items:
            $ref: '#/components/schemas/existing-webcast'
          description: Collection of webcasts.
    uuid.json:
      title: UUID
      description: The reference to the related entity. Contains only the ID of the related entity.
      required:
      - id
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid-property'
    player-type-provider.json:
      title: PlayerTypeProvider
      enum:
      - Brightcove
      - Amazon IVS
      - Cvent VOD
      type: string
      description: This is used to denote the type of a video player used for the Cvent Video Player
      example: Amazon IVS
      readOnly: true
    schedule.json:
      title: Schedule
      description: A scheduled action.
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique ID of the scheduled task.
        scheduledExecution:
          type: string
          format: date-time
          description: 'The ISO 8601 zoned date time when the session will be moved to the next stage: provisioning, activation, deactivation or archival'
          example: '2024-03-05T09:00:00Z'
          readOnly: true
        action:
          $ref: '#/components/schemas/schedule-action.json'
    webcast-host-link.json:
      title: WebcastHostLink
      description: Link details for a webcast host.
      type: object
      properties:
        href:
          type: string
          description: A url to the webcast.
          maxLength: 2000
          example: https://cvent.zoom.us/j/7566652259
        code:
          type: string
          description: Access code of webcast link.
          maxLength: 100
          example: 1456ZS78
        key:
          type: string
          description: Host key for the webcast.
          maxLength: 100
          example: abcd1234
    live-stream-recording-status.json:
      title: LiveStreamRecordingStatus
      enum:
      - error
      - waiting
      - waiting_finish_live
      - processing
      - cancelling
      - cancelled
      - finished
      - failed
      - creating_asset
      type: string
      description: This is used to denote the status of the live stream recording job
      example: finished
      readOnly: true
    webcast-type.json:
      title: WebcastType
      enum:
      - Meeting
      - Webinar
      - Presentation
      type: string
      description: This is used to denote the type of a webcast
      example: Meeting
    existing-attendee-link:
      title: ExistingAttendeeLink
      description: An existing attendee link.
      type: object
      required:
      - id
      allOf:
      - title: AttendeeLink
        description: An attendee link.
        type: object
        required:
        - webcast
        - attendee
        allOf:
        - $ref: '#/components/schemas/webcast/allOf/0'
        properties:
          webcast:
            $ref: '#/components/schemas/uuid.json'
          event:
            $ref: '#/components/schemas/uuid.json'
          session:
            $ref: '#/components/schemas/uuid.json'
          attendee:
            $ref: '#/components/schemas/uuid.json'
          sourceId:
            type: string
            description: Source Id of the webcast provider
            maxLength: 50
            example: kBBBAAcccdddd8U==
          join:
            $ref: '#/components/schemas/webcast-link.json'
      properties:
        id:
          type: string
          format: uuid
          description: Attendee-link ID
          readOnly: true
    pagination-links.json:
      title: PaginationLinks
      type: object
      description: Represents pagination links for navigating between pages of data.
      properties:
        next:
          $ref: '#/components/schemas/link.json'
        self:
          $ref: '#/components/schemas/link.json'
        prev:
          $ref: '#/components/schemas/link.json'
    webcast-links.json:
      title: WebcastLinks
      description: webcast link references
      type: object
      properties:
        join:
          $ref: '#/components/schemas/webcast-link.json'
        speaker:
          $ref: '#/components/schemas/webcast-link.json'
        host:
          $ref: '#/components/schemas/webcast-host-link.json'
        recording:
          $ref: '#/components/schemas/webcast-link.json'
    ErrorResponse:
      title: ErrorResponse
      description: Represents an error response with additional details of cascading error messages.
      allOf:
      - $ref: '#/components/schemas/ErrorResponseBase'
      type: object
      required:
      - code
      - message
      properties:
        details:
          type: array
          items:
            $ref: '#/components/schemas/ErrorResponseBase'
          description: Additional details of cascading error messages.
    bulk-attendee-link:
      title: AttendeeLinkBulk
      description: Collection of attendee links.
      type: array
      items:
        $ref: '#/components/schemas/existing-attendee-link/allOf/0'
    paging.json:
      title: Paging
      required:
      - _links
      type: object
      description: Represents pagination information for a collection of resources.
      properties:
        previousToken:
          type: string
          description: The pagination token for the previous page, if one exists. You can use this token to navigate to the previous page of data.
          example: 1a2b3c4d5e6f7g8h9i10j11k
        nextToken:
          type: string
          description: The pagination token for the next page. If this value is present in the response, there is another page of data you can fetch.
          example: 1a2b3c4d5e6f7g8h9i10j11k
        currentToken:
          type: string
          description: The pagination token for the current page.
          example: 1a2b3c4d5e6f7g8h9i10j11k
        limit:
          type: integer
          description: The number of records to return on the page. Not to exceed 200.
          example: 100
        totalCount:
          type: integer
          description: The total number of records available. This field may return blank, even if there are more records. To confirm if there are more records, check the `nextToken` field.
          example: 2
        _links:
          $ref: '#/components/schemas/pagination-links.json'
    format.json:
      title: Format
      enum:
      - Live
      - Pre-recorded
      type: string
      default: Live
      description: This is used to denote the format of a webcast
      example: Pre-recorded
    live-stream-session.json:
      title: LiveStreamSession
      type: object
      properties:
        id:
          type: string
          description: An identifier for the current streaming session
          example: st-1A2b3c4D5e6F78ghij9Klmn
      description: Provides information about the livestream's current streaming session
    existing-webcast:
      title: ExistingWebcast
      description: An existing webcast.
      type: object
      allOf:
      - title: Webcast
        description: A webcast
        type: object
        allOf:
        - $ref: '#/components/schemas/webcast/allOf/0'
        properties:
          event:
            $ref: '#/components/schemas/uuid.json'
          session:
            $ref: '#/components/schemas/uuid.json'
          appointment:
            $ref: '#/components/schemas/uuid.json'
          solutionType:
            $ref: '#/components/schemas/solution-type.json'
          exhibitor:
            $ref: '#/components/schemas/uuid.json'
          format:
            $ref: '#/components/schemas/format.json'
          type:
            $ref: '#/components/schemas/webcast-type.json'
          provider:
            $ref: '#/components/schemas/webcast-provider.json'
          status:
            $ref: '#/components/schemas/webcast-status.json'
          playerType:
            $ref: '#/components/schemas/player-type.json'
          simulatedLive:
            type: boolean
            description: Indicates if the webcast is simulated live or not
            example: false
          recordLiveStream:
            type: boolean
            description: Indicates if the live stream recording is enabled
            example: false
          autoAddToLibrary:
            type: boolean
            description: Indicates if the live stream recording will be added to the library automatically
            example: false
            default: false
          onDemandVideo:
            type: boolean
            description: Indicates if the on demand video is available
            example: false
          sourceId:
            type: string
            description: Source Id of the webcast provider
            maxLength: 50
            example: kBBBAAcccdddd8U==
          title:
            type: string
            description: Title of the webcast
            maxLength: 500
            example: Webinar Connect Event
          meetingId:
            type: string
            description: Id of meeting within a webcast.
            maxLength: 300
            example: 123ERt
          _links:
            $ref: '#/components/schemas/webcast-links.json'
          details:
            type: string
            description: Additional information related to the webcast
            maxLength: 2000
            example: This is free of cost event
          video:
            type: object
            description: Video for the webcast.
            readOnly: true
            properties:
              id:
                type: string
                format: uuid
                description: The unique identifier of the video.
                example: 35b43fce-e87f-4a52-8685-2ba09fb53f53
                readOnly: true
      properties:
        id:
          type: string
          format: uuid
          description: Webcast ID
          readOnly: true
    bulk-existing-attendee-link:
      title: ExistingAttendeeLinkBulk
      description: Collection of existing attendee links.
      type: array
      items:
        $ref: '#/components/schemas/existing-attendee-link'
    webcast-status.json:
      title: WebcastStatus
      enum:
      - Not Started
      - Started
      - Finished
      - Cancelled
      type: string
      description: This is used to denote the status of a webcast
      example: Started
    existing-player:
      title: ExistingPlayer
      description: An existing webcast player.
      type: object
     

# --- truncated at 32 KB (84 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cvent-registration/refs/heads/main/openapi/cvent-registration-webcasts-api-openapi.yml