Cvent Registration · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Hooks API

5 actions 5 updates phrasing extends openapi/cvent-registration-hooks-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Cvent Registration's API. It is a proposal applied on top of the contract, not a document Cvent Registration publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/contacts/hooks'].get

$.paths['/contacts/hooks'].post

$.paths['/contacts/hooks/{id}'].put

$.paths['/contacts/hooks/{id}'].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 Hooks API
  version: 1.0.0
extends: openapi/cvent-registration-hooks-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: 4
- target: $.paths['/contacts/hooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List contact hooks
      effect: read
      questions:
      - What contact hooks are configured in my account?
      - Can I filter the list of contact callback hooks?
      instructions:
      - text: List contact hooks.
      - text: Show contact hooks matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contacts/hooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a contact hook
      effect: write
      questions:
      - How do I have Cvent call my system to fetch contact information?
      - What security settings does a new contact hook need?
      instructions:
      - text: Create a contact hook {name} calling back to {callback}.
        slots:
          name: requestBody.name
          callback: requestBody.callback
      - text: Register a new contact hook {name} at {callback} secured with {security}.
        slots:
          name: requestBody.name
          callback: requestBody.callback
          security: requestBody.security
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contacts/hooks/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a contact hook's callback
      effect: write
      questions:
      - Can I change the callback URI of an existing contact hook?
      - Is it possible to rotate the security settings on a contact hook?
      instructions:
      - text: Point contact hook {id} at callback {callback}.
        slots:
          id: path.id
          callback: requestBody.callback
      - text: Update existing contact hook {id} security to {security}.
        slots:
          id: path.id
          security: requestBody.security
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contacts/hooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a contact hook
      effect: destructive
      questions:
      - How do I stop Cvent from calling a contact hook?
      - Can I remove a contact hook I no longer use?
      instructions:
      - text: Delete contact hook {id}.
        slots:
          id: path.id
      - text: Remove the contact callback hook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'