Cvent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Attendee Activities API

7 actions 7 updates phrasing extends openapi/cvent-attendee-activities-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Cvent's API. It is a proposal applied on top of the contract, not a document Cvent publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/attendees/activities'].get
$.paths['/attendees/activities'].post
$.paths['/attendees/activities/external/metadata'].get
$.paths['/attendees/activities/external/metadata'].post
$.paths['/attendees/activities/external/metadata/{id}'].put
$.paths['/attendees/activities/external/metadata/{id}'].delete

OpenAPI Overlay

Raw ↑
# 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 Attendee Activities API
  version: 1.0.0
extends: openapi/cvent-attendee-activities-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: 6
- target: $.paths['/attendees/activities'].get
  update:
    x-apievangelist-phrasing:
      intent: List attendee activities
      effect: read
      questions:
      - What have attendees been doing at my events, like check-ins or session views?
      - Can I get attendee activities recorded after a certain time?
      instructions:
      - text: List all attendee activities.
      - text: List attendee activities after {after}.
        slots:
          after: query.after
      - text: List attendee activities matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/attendees/activities'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an external attendee activity
      effect: write
      questions:
      - How do I push an activity from another system into an attendee's Cvent timeline?
      - What fields does an external attendee activity need?
      instructions:
      - text: Record external activity {name} of type {type} for attendee {attendee} at event {event} with data {data}.
        slots:
          name: requestBody.name
          type: requestBody.type
          attendee: requestBody.attendee
          event: requestBody.event
          data: requestBody.data
      - text: Log activity {name} ({type}) for attendee {attendee} in event {event} at {time} with data {data}.
        slots:
          name: requestBody.name
          type: requestBody.type
          attendee: requestBody.attendee
          event: requestBody.event
          time: requestBody.time
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/attendees/activities/external/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: List external activity type definitions
      effect: read
      questions:
      - Which external activity types have been defined for attendee tracking?
      - Can I filter the metadata for external attendee activities?
      instructions:
      - text: List external attendee activity metadata.
      - text: List external activity definitions matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/attendees/activities/external/metadata'].post
  update:
    x-apievangelist-phrasing:
      intent: Define a new external activity type
      effect: write
      questions:
      - How do I register a new kind of external activity before sending attendee activities?
      - Can I define custom fields for an external activity type?
      instructions:
      - text: Define external activity type {type} named {name}.
        slots:
          type: requestBody.type
          name: requestBody.name
      - text: Create external activity metadata {name} of type {type} with fields {fields}.
        slots:
          name: requestBody.name
          type: requestBody.type
          fields: requestBody.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/attendees/activities/external/metadata/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an external activity type definition
      effect: write
      questions:
      - How do I change the fields on an external activity type I defined?
      - Can I rename an external activity definition?
      instructions:
      - text: Rename external activity definition {id} to {name} with type {type}.
        slots:
          id: path.id
          name: requestBody.name
          type: requestBody.type
      - text: Update the fields of external activity metadata {id} to {fields}.
        slots:
          id: path.id
          fields: requestBody.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/attendees/activities/external/metadata/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an external activity type definition
      effect: destructive
      questions:
      - How do I delete an external activity type I no longer track?
      - Can I remove external activity metadata by ID?
      instructions:
      - text: Delete external activity metadata {id}.
        slots:
          id: path.id
      - text: Remove external activity definition {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'