# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Boom CDP Events API
  version: 1.0.0
extends: openapi/boom-ai-cdp-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: 4
- target: $.paths['/api/v1/cdp/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List behavioral events
      effect: read
      questions:
      - Which events has a particular customer triggered recently?
      - Can I filter recorded events by name and a time range?
      instructions:
      - text: List events for person {personExternalId}.
        slots:
          personExternalId: query.personExternalId
      - text: Show {name} events between {start} and {end}.
        slots:
          name: query.name
          start: query.start
          end: query.end
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/cdp/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Record one event in real time
      effect: write
      questions:
      - How do I send a checkout event so it can trigger a journey right away?
      - What happens if I record the same event id twice?
      instructions:
      - text: Record a {name} event {externalId} for person {personExternalId}.
        slots:
          name: requestBody.name
          externalId: requestBody.externalId
          personExternalId: requestBody.personExternalId
      - text: Log event {name} with id {externalId} at {timestamp} and properties {properties}.
        slots:
          name: requestBody.name
          externalId: requestBody.externalId
          timestamp: requestBody.timestamp
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/cdp/events/{externalId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read one event
      effect: read
      questions:
      - What payload was stored for a specific event?
      - Can I look up an event by the id I sent it with?
      instructions:
      - text: Get event {externalId}.
        slots:
          externalId: path.externalId
      - text: Show the details of recorded event {externalId}.
        slots:
          externalId: path.externalId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/cdp/events/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk load historical events
      effect: write
      questions:
      - How do I backfill historical events without enrolling people in journeys?
      - What is the limit on events per bulk ingest request?
      instructions:
      - text: 'Bulk record these events: {items}.'
        slots:
          items: requestBody.items
      - text: 'Backfill up to 1000 historical events: {items}.'
        slots:
          items: requestBody.items
      method: generated
      generated: '2026-09-26'