Loops · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Loops OpenAPI Spec Events API

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

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/v1/events/send'].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 Loops OpenAPI Spec Events API
  version: 1.0.0
extends: openapi/loops-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['/v1/events/send'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an event to trigger workflows
      effect: write
      questions:
      - How do I fire an event that kicks off a workflow for a contact?
      - Can I avoid duplicate emails when retrying an event?
      instructions:
      - text: Send event {eventName} for contact {email}.
        slots:
          eventName: requestBody.eventName
          email: requestBody.email
      - text: Trigger {eventName} for user ID {userId} with properties {eventProperties}.
        slots:
          eventName: requestBody.eventName
          userId: requestBody.userId
          eventProperties: requestBody.eventProperties
      - text: Send event {eventName} for {email} using idempotency key {key}.
        slots:
          eventName: requestBody.eventName
          email: requestBody.email
          key: header.Idempotency-Key
      method: generated
      generated: '2026-09-26'