# 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-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?
      - Which callback URLs does Cvent call to fetch contact data?
      instructions:
      - text: List my 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 request contact information from my system?
      - 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} with security {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
      effect: write
      questions:
      - Can I point an existing contact hook to a new callback URL?
      - Is it possible to rotate the security settings on a contact hook?
      instructions:
      - text: Change contact hook {id}'s callback to {callback}.
        slots:
          id: path.id
          callback: requestBody.callback
      - text: Rename existing contact hook {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      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 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 hook {id} from my account.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'