Omnisend · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Events API

2 actions 2 updates phrasing extends openapi/omnisend-events-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Omnisend's API. It is a proposal applied on top of the contract, not a document Omnisend publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/events'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Events API
  version: 1.0.0
extends: openapi/omnisend-events-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a customer event
      effect: write
      questions:
      - How do I send a customer event so it can trigger an automation?
      - Can I send a custom event with my own properties for a contact?
      - Does including an event ID help prevent duplicate historical events?
      instructions:
      - text: Send event {eventName} for contact {contact} with properties {properties}.
        slots:
          eventName: requestBody.eventName
          contact: requestBody.contact
          properties: requestBody.properties
      - text: Record event {eventName} from origin {origin} at {eventTime} with ID {eventID}.
        slots:
          eventName: requestBody.eventName
          origin: requestBody.origin
          eventTime: requestBody.eventTime
          eventID: requestBody.eventID
      - text: Send recommended event {eventName} version {eventVersion} for contact {contact}.
        slots:
          eventName: requestBody.eventName
          eventVersion: requestBody.eventVersion
          contact: requestBody.contact
      method: generated
      generated: '2026-10-02'