Talon.One · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Talon One Events API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v2/events'].post
$.paths['/v3/events'].post
$.paths['/v3/events/{integrationId}'].get
$.paths['/v1/event_types'].get

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 Talon One Events API
  version: 1.0.0
extends: openapi/talon-one-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['/v2/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Track a custom event
      effect: write
      questions:
      - How do I send a custom event like 'newsletter signup' so a rule can reward it?
      - Can I test a custom event with a dry run that doesn't persist anything?
      instructions:
      - text: Track a custom event through the v2 events endpoint.
      - text: 'Send a v2 custom event as a dry run: {dry}.'
        slots:
          dry: query.dry
      - text: Track a v2 event including loyalty cards {loyaltyCards}.
        slots:
          loyaltyCards: requestBody.loyaltyCards
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Track an advanced, idempotent event
      effect: write
      questions:
      - How do I send an idempotent event that can reference a session that's already closed?
      - What's different about tracking an advanced event versus a regular custom event?
      instructions:
      - text: Track an advanced idempotent event through the v3 events endpoint.
      - text: 'Send an advanced v3 event silently: {silent}.'
        slots:
          silent: query.silent
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/events/{integrationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an advanced event
      effect: read
      questions:
      - Can I look up an advanced event I already sent by its identifier?
      - What did Talon.One record for a specific v3 event?
      instructions:
      - text: Get advanced event {integrationId}.
        slots:
          integrationId: path.integrationId
      - text: Retrieve the v3 event with identifier {integrationId}.
        slots:
          integrationId: path.integrationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/event_types'].get
  update:
    x-apievangelist-phrasing:
      intent: List event type definitions
      effect: read
      questions:
      - What custom event types have been defined in my account?
      - Can I see older versions of an event type definition?
      instructions:
      - text: List all event type definitions in my account.
      - text: Show event type {name} including old versions.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'