Cvent Event Cloud · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Cvent REST Webcasts API
12 actions
12 updates
phrasing
extends
openapi/cvent-event-cloud-webcasts-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Cvent Event Cloud's API. It is a proposal applied on top of the contract, not a document Cvent Event Cloud publishes.
What the actions change
x-apievangelist-phrasing
Targets 12
$.info
$.paths['/webcasts'].get
$.paths['/webcasts'].post
$.paths['/webcasts/attendee-links'].get
$.paths['/webcasts/players'].get
$.paths['/webcasts/{id}'].get
$.paths['/webcasts/{id}'].put
$.paths['/webcasts/{id}'].delete
$.paths['/webcasts/{id}/attendee-links'].get
$.paths['/webcasts/{id}/attendee-links'].put
$.paths['/webcasts/{id}/attendee-links'].post
$.paths['/webcasts/{id}/attendee-links/{attendeeLinkId}'].delete
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Cvent REST Webcasts API
version: 1.0.0
extends: openapi/cvent-event-cloud-webcasts-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 11
- target: $.paths['/webcasts'].get
update:
x-apievangelist-phrasing:
intent: List webcasts
effect: read
questions:
- What webcasts are set up for my virtual event?
- Can I filter webcasts or list ones changed after a date?
instructions:
- text: List webcasts matching {filter}.
slots:
filter: query.filter
- text: List webcasts updated after {after}.
slots:
after: query.after
method: generated
generated: '2026-09-26'
- target: $.paths['/webcasts'].post
update:
x-apievangelist-phrasing:
intent: Create a webcast for an event
effect: write
questions:
- How do I set up a live stream for a session at my event?
- Can a new webcast be simulated live or recorded automatically?
instructions:
- text: Create a webcast titled {title} for session {session} in event {event}.
slots:
title: requestBody.title
session: requestBody.session
event: requestBody.event
- text: Set up a webcast for event {event} using provider {provider} with recording of the live stream set to {recordLiveStream}.
slots:
event: requestBody.event
provider: requestBody.provider
recordLiveStream: requestBody.recordLiveStream
method: generated
generated: '2026-09-26'
- target: $.paths['/webcasts/attendee-links'].get
update:
x-apievangelist-phrasing:
intent: List attendee links across webcasts
effect: read
questions:
- Which personal join links have been issued to attendees across all webcasts?
- Can I filter attendee join links account-wide?
instructions:
- text: List all webcast attendee links.
- text: List attendee links across webcasts matching {filter}.
slots:
filter: query.filter
method: generated
generated: '2026-09-26'
- target: $.paths['/webcasts/players'].get
update:
x-apievangelist-phrasing:
intent: List webcast players
effect: read
questions:
- What video player details are configured for my webcasts?
- Can I filter the list of webcast players?
instructions:
- text: List webcast player details.
- text: List webcast players matching {filter}.
slots:
filter: query.filter
method: generated
generated: '2026-09-26'
- target: $.paths['/webcasts/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a webcast
effect: read
questions:
- Can I see the settings of a single webcast, like its format and status?
- Which session is a particular webcast attached to?
instructions:
- text: Get webcast {webcast}.
slots:
webcast: path.id
- text: Show the configuration of webcast {webcast}.
slots:
webcast: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/webcasts/{id}'].put
update:
x-apievangelist-phrasing:
intent: Update a webcast
effect: write
questions:
- Can I change a webcast's title or status after it is created?
- How do I switch a webcast to on-demand video?
instructions:
- text: Rename webcast {webcast} to {title}.
slots:
webcast: path.id
title: requestBody.title
- text: Set the status of webcast {webcast} to {status}.
slots:
webcast: path.id
status: requestBody.status
method: generated
generated: '2026-09-26'
- target: $.paths['/webcasts/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a webcast
effect: destructive
questions:
- Can I delete a webcast from my event?
- Is removing a webcast by ID permanent?
instructions:
- text: Delete webcast {webcast}.
slots:
webcast: path.id
- text: Remove webcast {webcast} from the event.
slots:
webcast: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/webcasts/{id}/attendee-links'].get
update:
x-apievangelist-phrasing:
intent: List attendee links for one webcast
effect: read
questions:
- Which attendees have join links for a particular webcast?
- Can I filter the attendee links of just one webcast?
instructions:
- text: List attendee links for webcast {webcast}.
slots:
webcast: path.id
- text: List links in webcast {webcast} matching {filter}.
slots:
webcast: path.id
filter: query.filter
method: generated
generated: '2026-09-26'
- target: $.paths['/webcasts/{id}/attendee-links'].put
update:
x-apievangelist-phrasing:
intent: Bulk update a webcast's attendee links
effect: write
questions:
- Can I update many existing attendee links for a webcast in one call?
- How do I change the data on attendee join links in bulk?
instructions:
- text: Bulk update the existing attendee links on webcast {webcast}.
slots:
webcast: path.id
- text: Apply these changes to attendee links already issued for webcast {webcast}.
slots:
webcast: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/webcasts/{id}/attendee-links'].post
update:
x-apievangelist-phrasing:
intent: Bulk create attendee links for a webcast
effect: write
questions:
- Can I generate join links for a batch of attendees on a webcast?
- How do I issue new attendee links for a webcast in bulk?
instructions:
- text: Create attendee links in bulk for webcast {webcast}.
slots:
webcast: path.id
- text: Issue new join links for these attendees on webcast {webcast}.
slots:
webcast: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/webcasts/{id}/attendee-links/{attendeeLinkId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an attendee link from a webcast
effect: destructive
questions:
- Can I revoke one attendee's join link for a webcast?
- How do I delete a single attendee link?
instructions:
- text: Delete attendee link {attendeeLinkId} from webcast {webcast}.
slots:
attendeeLinkId: path.attendeeLinkId
webcast: path.id
- text: Revoke join link {attendeeLinkId} on webcast {webcast}.
slots:
attendeeLinkId: path.attendeeLinkId
webcast: path.id
method: generated
generated: '2026-09-26'