beehiiv · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Automations API

4 actions 4 updates phrasing extends openapi/beehiiv-automations-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/publications/{publicationId}/automations'].get

$.paths['/publications/{publicationId}/automations/{automationId}'].get

$.paths['/publications/{publicationId}/automations/{automationId}/emails'].get

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 Reference Automations API
  version: 1.0.0
extends: openapi/beehiiv-automations-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['/publications/{publicationId}/automations'].get
  update:
    x-apievangelist-phrasing:
      intent: List a publication's automations
      effect: read
      questions:
      - What automations are set up on my newsletter?
      - Can I see all my welcome sequences and other automated flows in one list?
      instructions:
      - text: List the automations on publication {publication}.
        slots:
          publication: path.publicationId
      - text: Show page {page} of automations for {publication}.
        slots:
          page: query.page
          publication: path.publicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/automations/{automationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one automation
      effect: read
      questions:
      - How is a specific automation configured?
      - Can I pull the details of a single automated flow by its ID?
      instructions:
      - text: Get automation {automation} from publication {publication}.
        slots:
          automation: path.automationId
          publication: path.publicationId
      - text: Show how automation {automation} is set up, with {expand} expanded.
        slots:
          automation: path.automationId
          expand: query.expand[]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/automations/{automationId}/emails'].get
  update:
    x-apievangelist-phrasing:
      intent: List an automation's emails with stats
      effect: read
      questions:
      - How are the emails inside my welcome automation performing?
      - Which emails belong to an automation, and what are their open and click stats?
      instructions:
      - text: List the emails in automation {automation} on publication {publication} with their engagement stats.
        slots:
          automation: path.automationId
          publication: path.publicationId
      - text: Show open and click stats for each email in automation {automation}.
        slots:
          automation: path.automationId
      method: generated
      generated: '2026-09-26'