Customer.io · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Customer.io Track Track Events API

5 actions 5 updates phrasing extends openapi/customer-io-track-events-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Customer.io's API. It is a proposal applied on top of the contract, not a document Customer.io publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/api/v1/customers/{identifier}/events'].post
$.paths['/api/v1/events'].post
$.paths['/api/v1/metrics'].post
$.paths['/api/v1/push/events'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Customer.io Track Track Events API
  version: 1.0.0
extends: openapi/customer-io-track-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/customers/{identifier}/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Track an event for an identified person
      effect: write
      questions:
      - How do I send an event for a person I've already identified?
      - Can I send page and screen events through the person event endpoint?
      instructions:
      - text: Track an event for person {identifier}.
        slots:
          identifier: path.identifier
      - text: Record a purchase event on {identifier}'s profile.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Track an event for an anonymous visitor
      effect: write
      questions:
      - How do I record events for visitors who haven't signed up yet?
      - Will anonymous events merge into the profile once someone is identified?
      instructions:
      - text: Track an anonymous event for a visitor.
      - text: Send an event with an anonymous ID before the user logs in.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/metrics'].post
  update:
    x-apievangelist-phrasing:
      intent: Report delivery metrics from any channel
      effect: write
      questions:
      - How do I report opens or clicks from a channel you don't natively support?
      - Can I send delivery metrics back using the CIO-Delivery-ID?
      instructions:
      - text: Report an opened metric for a delivery.
      - text: Send a clicked metric back for a message we delivered.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/push/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Report push notification metrics (legacy)
      effect: write
      questions:
      - How do I report push opens with the older push events endpoint?
      - Can I mark a push as delivered on a specific device?
      instructions:
      - text: Report {event} for push delivery {delivery_id}.
        slots:
          event: requestBody.event
          delivery_id: requestBody.delivery_id
      - text: Mark push {delivery_id} as {event} on device {device_id} using the legacy endpoint.
        slots:
          delivery_id: requestBody.delivery_id
          event: requestBody.event
          device_id: requestBody.device_id
      method: generated
      generated: '2026-09-26'