# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for GetResponse APIv3 Custom Events API
  version: 1.0.0
extends: openapi/getresponse-custom-events-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['/custom-events/{customEventId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom event
      effect: read
      questions:
      - What attributes does one of my custom events define?
      - Can I look up a custom event definition by ID?
      instructions:
      - text: Show custom event {customEventId}.
        slots:
          customEventId: path.customEventId
      - text: Get the attributes defined on custom event {customEventId}.
        slots:
          customEventId: path.customEventId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-events/{customEventId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a custom event
      effect: write
      questions:
      - Can I rename a custom event or change its attributes?
      - Do I need to resend all attributes when editing a custom event?
      instructions:
      - text: Update custom event {customEventId} to name {name} with attributes {attributes}.
        slots:
          customEventId: path.customEventId
          name: requestBody.name
          attributes: requestBody.attributes
      - text: Rename custom event {customEventId} to {name} and set its attributes to {attributes}.
        slots:
          customEventId: path.customEventId
          name: requestBody.name
          attributes: requestBody.attributes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-events/{customEventId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom event
      effect: destructive
      questions:
      - How do I remove a custom event definition I no longer track?
      - Can a custom event be permanently deleted?
      instructions:
      - text: Delete custom event {customEventId}.
        slots:
          customEventId: path.customEventId
      - text: Remove the custom event definition {customEventId}.
        slots:
          customEventId: path.customEventId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-events'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom events
      effect: read
      questions:
      - Which custom events are defined on my account?
      - Can I list only custom events that have attributes?
      instructions:
      - text: List all my custom events.
      - text: Find custom events named {name}.
        slots:
          name: query.query[name]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-events'].post
  update:
    x-apievangelist-phrasing:
      intent: Define a new custom event
      effect: write
      questions:
      - Can I define my own event type to use in automation workflows?
      - What attributes can a new custom event carry?
      instructions:
      - text: Create a custom event named {name} with attributes {attributes}.
        slots:
          name: requestBody.name
          attributes: requestBody.attributes
      - text: Define a new event type {name} carrying attributes {attributes}.
        slots:
          name: requestBody.name
          attributes: requestBody.attributes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-events/trigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger a custom event for a contact
      effect: write
      questions:
      - How do I fire a custom event for a specific contact?
      - Can I pass attribute values when triggering an event?
      instructions:
      - text: Trigger custom event {name} for contact {contactId}.
        slots:
          name: requestBody.name
          contactId: requestBody.contactId
      - text: Fire event {name} for contact {contactId} with attributes {attributes}.
        slots:
          name: requestBody.name
          contactId: requestBody.contactId
          attributes: requestBody.attributes
      method: generated
      generated: '2026-09-26'