Attentive · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Attentive E Commerce API

4 actions 4 updates phrasing extends openapi/attentive-ecommerce-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Attentive's API. It is a proposal applied on top of the contract, not a document Attentive publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/events/ecommerce/product-view'].post
$.paths['/events/ecommerce/add-to-cart'].post
$.paths['/events/ecommerce/purchase'].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 Attentive E Commerce API
  version: 1.0.0
extends: openapi/attentive-ecommerce-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/ecommerce/product-view'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a product view event
      effect: write
      questions:
      - How do I tell Attentive that a shopper viewed a product?
      - Does the user need to be a subscriber for me to track product views?
      instructions:
      - text: Record that {user} viewed products {items}.
        slots:
          user: requestBody.user
          items: requestBody.items
      - text: Log a product page view for this visitor's phone number on the item they just browsed.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/ecommerce/add-to-cart'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an add-to-cart event
      effect: write
      questions:
      - How can I track when a customer adds an item to their cart?
      - What item details should I send for an add-to-cart event?
      instructions:
      - text: Record that {user} added {items} to their cart.
        slots:
          user: requestBody.user
          items: requestBody.items
      - text: Log an add-to-cart for this shopper so abandoned cart messages can trigger.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/ecommerce/purchase'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a purchase event
      effect: write
      questions:
      - How do I send completed orders to Attentive as purchase events?
      - Can I include the order ID and sales channel on a purchase event?
      instructions:
      - text: Record purchase of {items} by {user} for order {orderId}.
        slots:
          items: requestBody.items
          user: requestBody.user
          orderId: requestBody.orderId
      - text: Log order {orderId} as a purchase through sales channel {salesChannel}.
        slots:
          orderId: requestBody.orderId
          salesChannel: requestBody.salesChannel
      method: generated
      generated: '2026-09-26'