# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Iterable Events API
  version: 1.0.0
extends: openapi/iterable-events-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 17
- target: $.paths['/api/embedded-messaging/events/click'].post
  update:
    x-apievangelist-phrasing:
      intent: Track a click on an embedded message
      effect: write
      questions:
      - How do I record that a user clicked a button in an embedded message?
      - Can I log which URL was opened from an embedded message click?
      instructions:
      - text: Track a click on embedded message {messageId} by {email}.
        slots:
          messageId: requestBody.messageId
          email: requestBody.email
      - text: Record button {buttonIdentifier} clicked on embedded message {messageId} to {targetUrl}.
        slots:
          buttonIdentifier: requestBody.buttonIdentifier
          messageId: requestBody.messageId
          targetUrl: requestBody.targetUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/embedded-messaging/events/received'].post
  update:
    x-apievangelist-phrasing:
      intent: Track an embedded message received
      effect: write
      questions:
      - Can I log that an embedded message arrived on a user's device?
      - What creates an embeddedReceived event?
      instructions:
      - text: Mark embedded message {messageId} as received for {email}.
        slots:
          messageId: requestBody.messageId
          email: requestBody.email
      - text: Track receipt of embedded message {messageId} on device {deviceInfo}.
        slots:
          messageId: requestBody.messageId
          deviceInfo: requestBody.deviceInfo
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/embedded-messaging/events/session'].post
  update:
    x-apievangelist-phrasing:
      intent: Track an embedded session and impressions
      effect: write
      questions:
      - How do I report how long a user viewed embedded messages in a session?
      - Can I send impressions for several embedded messages in one session event?
      instructions:
      - text: Track embedded session {session} with impressions {impressions} for {email}.
        slots:
          session: requestBody.session
          impressions: requestBody.impressions
          email: requestBody.email
      - text: Log an embedded messaging session {session} for user {userId}.
        slots:
          session: requestBody.session
          userId: requestBody.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/events/byUserId/{userId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's events by userId
      effect: read
      questions:
      - Can I pull the event history for a user identified by userId?
      - How many recent events can I fetch for one userId?
      instructions:
      - text: Get events for user ID {userId}.
        slots:
          userId: path.userId
      - text: Show the last {limit} events for user ID {userId}.
        slots:
          limit: query.limit
          userId: path.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/events/inAppConsume'].post
  update:
    x-apievangelist-phrasing:
      intent: Consume or delete an in-app message
      effect: destructive
      questions:
      - How do I remove an in-app message from a user's inbox without the mobile SDK?
      - Can I record why an in-app message was deleted?
      instructions:
      - text: Consume in-app message {messageId} for {email}.
        slots:
          messageId: requestBody.messageId
          email: requestBody.email
      - text: Delete in-app message {messageId} for user {userId} with delete action {deleteAction}.
        slots:
          messageId: requestBody.messageId
          userId: requestBody.userId
          deleteAction: requestBody.deleteAction
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/events/track'].post
  update:
    x-apievangelist-phrasing:
      intent: Track a custom event
      effect: write
      questions:
      - Can I track a custom event and create new fields on the fly under /api/events?
      - Are single tracked events processed in order with bulk ones?
      instructions:
      - text: Track event {eventName} for {email}.
        slots:
          eventName: requestBody.eventName
          email: requestBody.email
      - text: Track event {eventName} for user {userId} with data {dataFields}, creating new fields.
        slots:
          eventName: requestBody.eventName
          userId: requestBody.userId
          dataFields: requestBody.dataFields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/events/trackBulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Track many custom events at once
      effect: write
      questions:
      - Can I send a batch of events in one /api/events call?
      - Are bulk events processed separately from single-event tracking?
      instructions:
      - text: Bulk track events {events}.
        slots:
          events: requestBody.events
      - text: 'Send this batch of events to /api/events/trackBulk: {events}.'
        slots:
          events: requestBody.events
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/events/trackInAppClick'].post
  update:
    x-apievangelist-phrasing:
      intent: Track an in-app message click
      effect: write
      questions:
      - How do I log a tap on a link inside an in-app message?
      - Which URL did the user click in an in-app message, and how do I record it?
      instructions:
      - text: Track a click on in-app message {messageId} to {clickedUrl}.
        slots:
          messageId: requestBody.messageId
          clickedUrl: requestBody.clickedUrl
      - text: Record in-app click on message {messageId} by {email}.
        slots:
          messageId: requestBody.messageId
          email: requestBody.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/events/trackInAppClose'].post
  update:
    x-apievangelist-phrasing:
      intent: Track the closing of an in-app message
      effect: write
      questions:
      - Can I record when a user dismisses an in-app message, and how they closed it?
      - Is there an event for closing an in-app message inside an inbox session?
      instructions:
      - text: Track that {email} closed in-app message {messageId}.
        slots:
          email: requestBody.email
          messageId: requestBody.messageId
      - text: Log close of in-app message {messageId} with action {closeAction} in inbox session {inboxSessionId}.
        slots:
          messageId: requestBody.messageId
          closeAction: requestBody.closeAction
          inboxSessionId: requestBody.inboxSessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/events/trackInAppDelivery'].post
  update:
    x-apievangelist-phrasing:
      intent: Track in-app message delivery
      effect: write
      questions:
      - How do I record that an in-app message was delivered to a device?
      - What event marks an in-app message as delivered?
      instructions:
      - text: Track delivery of in-app message {messageId} to {email}.
        slots:
          messageId: requestBody.messageId
          email: requestBody.email
      - text: Mark in-app message {messageId} delivered on device {deviceInfo}.
        slots:
          messageId: requestBody.messageId
          deviceInfo: requestBody.deviceInfo
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/events/trackInAppOpen'].post
  update:
    x-apievangelist-phrasing:
      intent: Track an in-app message open
      effect: write
      questions:
      - Does tracking an in-app open also mark the message as read?
      - Where do I log that a user opened an in-app message?
      instructions:
      - text: Track that {email} opened in-app message {messageId}.
        slots:
          email: requestBody.email
          messageId: requestBody.messageId
      - text: Record an open of in-app message {messageId} for user {userId}.
        slots:
          messageId: requestBody.messageId
          userId: requestBody.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/events/trackPushOpen'].post
  update:
    x-apievangelist-phrasing:
      intent: Track a mobile push open
      effect: write
      questions:
      - Can I record that a user opened a mobile push notification?
      - What campaign and message IDs do I need to log a push open?
      instructions:
      - text: Track a push open of message {messageId} from campaign {campaignId} by {email}.
        slots:
          messageId: requestBody.messageId
          campaignId: requestBody.campaignId
          email: requestBody.email
      - text: Log mobile push open for campaign {campaignId}, message {messageId}.
        slots:
          campaignId: requestBody.campaignId
          messageId: requestBody.messageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/events/trackWebPushClick'].post
  update:
    x-apievangelist-phrasing:
      intent: Track a web push click
      effect: write
      questions:
      - How do I record a click on a browser web push notification?
      - Can I tie a web push click to its campaign?
      instructions:
      - text: Track a web push click on message {messageId} by {email}.
        slots:
          messageId: requestBody.messageId
          email: requestBody.email
      - text: Record web push click for message {messageId} in campaign {campaignId}.
        slots:
          messageId: requestBody.messageId
          campaignId: requestBody.campaignId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/events/{email}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's events by email
      effect: read
      questions:
      - Can I see recent events for a user under /api/events by their email?
      - What events has this email address generated?
      instructions:
      - text: Get /api/events history for {email}.
        slots:
          email: path.email
      - text: Show up to {limit} events for {email} from /api/events.
        slots:
          limit: query.limit
          email: path.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/events/track'].post
  update:
    x-apievangelist-phrasing:
      intent: Track a custom event via the simple endpoint
      effect: write
      questions:
      - Is there a basic /events/track call that requires the user's email?
      - Can a custom event tracked by email trigger campaigns and segments?
      instructions:
      - text: Using /events/track, record {eventName} for {email}.
        slots:
          eventName: requestBody.eventName
          email: requestBody.email
      - text: Via the simple events endpoint, log {eventName} for {email} with data {dataFields}.
        slots:
          eventName: requestBody.eventName
          email: requestBody.email
          dataFields: requestBody.dataFields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/events/trackBulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Track events in bulk via the simple endpoint
      effect: write
      questions:
      - Can I post many custom events to the plain /events/trackBulk path?
      - What does each event in a basic bulk tracking request need?
      instructions:
      - text: Post events {events} to /events/trackBulk.
        slots:
          events: requestBody.events
      - text: Use the simple bulk endpoint to log events {events}.
        slots:
          events: requestBody.events
      method: generated
      generated: '2026-10-01'
- target: $.paths['/events/{email}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get events by email via the simple endpoint
      effect: read
      questions:
      - Can I fetch a user's tracked events with the plain /events path by email?
      - Which basic endpoint lists events for an email address?
      instructions:
      - text: Get events for {email} from the plain /events endpoint.
        slots:
          email: path.email
      - text: Fetch {limit} tracked events for {email} via the simple endpoint.
        slots:
          limit: query.limit
          email: path.email
      method: generated
      generated: '2026-10-01'