Attentive · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Attentive Custom Events API

2 actions 2 updates phrasing extends openapi/attentive-custom-events-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 2

$.info
$.paths['/events/custom'].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 Custom Events API
  version: 1.0.0
extends: openapi/attentive-custom-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: 1
- target: $.paths['/events/custom'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a custom event for a user action
      effect: write
      questions:
      - How do I send a custom event like order shipped to Attentive?
      - Are custom event type names case sensitive?
      - Can I backdate a custom event with the time it actually happened?
      instructions:
      - text: Record a {type} custom event for user {user}.
        slots:
          type: requestBody.type
          user: requestBody.user
      - text: Send custom event {type} for {user} that occurred at {occurredAt} with properties {properties}.
        slots:
          type: requestBody.type
          user: requestBody.user
          occurredAt: requestBody.occurredAt
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'