# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Events Event API
  version: 1.0.0
extends: openapi/brevo-event-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: 3
- target: $.paths['/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom events
      effect: read
      questions:
      - Which custom events has a particular contact triggered?
      - Can I pull all events of one name within a date range?
      instructions:
      - text: List events for contact {contact_id}.
        slots:
          contact_id: query.contact_id
      - text: List {event_name} events between {startDate} and {endDate}.
        slots:
          event_name: query.event_name
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Track a contact event
      effect: write
      questions:
      - How do I record that a contact did something on my site, like viewing a page?
      - Can I attach custom properties to a tracked event?
      instructions:
      - text: Track event {event_name} for contact {identifiers}.
        slots:
          event_name: requestBody.event_name
          identifiers: requestBody.identifiers
      - text: Record event {event_name} for {identifiers} at {event_date} with properties {event_properties}.
        slots:
          event_name: requestBody.event_name
          identifiers: requestBody.identifiers
          event_date: requestBody.event_date
          event_properties: requestBody.event_properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Track many contact events at once
      effect: write
      questions:
      - Can I send a bulk batch of tracked events in one request?
      - Is there a batch endpoint for backfilling contact activity?
      instructions:
      - text: 'Track these events in one batch: {events}.'
        slots:
          events: requestBody.events
      - text: Backfill contact activity with the event batch {events}.
        slots:
          events: requestBody.events
      method: generated
      generated: '2026-09-26'