Postmark · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Postmark Inbound API

4 actions 4 updates phrasing extends openapi/postmark-inbound-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Postmark's API. It is a proposal applied on top of the contract, not a document Postmark publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/messages/inbound/{messageid}/details'].get
$.paths['/messages/inbound/{messageid}/retry'].put
$.paths['/messages/inbound'].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 Postmark Inbound API
  version: 1.0.0
extends: openapi/postmark-inbound-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/messages/inbound/{messageid}/details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a received email
      effect: read
      questions:
      - What did a specific inbound email contain and how was it processed?
      - Can I look up one received message by its ID?
      instructions:
      - text: Show inbound message {messageid}.
        slots:
          messageid: path.messageid
      - text: Get the content and processing details of received email {messageid}.
        slots:
          messageid: path.messageid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/messages/inbound/{messageid}/retry'].put
  update:
    x-apievangelist-phrasing:
      intent: Retry a failed inbound email
      effect: write
      questions:
      - My inbound webhook was down — how do I reprocess a failed message?
      - Can I retry delivery of a failed inbound email to my endpoint?
      instructions:
      - text: Retry processing of failed inbound message {messageid}.
        slots:
          messageid: path.messageid
      - text: Reprocess inbound email {messageid} now that the webhook is back.
        slots:
          messageid: path.messageid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/messages/inbound'].get
  update:
    x-apievangelist-phrasing:
      intent: Search received inbound emails
      effect: read
      questions:
      - Which inbound emails failed processing or got blocked this week?
      - Can I search received mail by subject or mailbox hash?
      - Has anything arrived from a particular sender in my inbound stream?
      instructions:
      - text: Search inbound emails with subject {subject}.
        slots:
          subject: query.subject
      - text: List {count} inbound messages with status {status} since {fromdate}.
        slots:
          count: query.count
          status: query.status
          fromdate: query.fromdate
      - text: Find inbound mail from {fromemail} sent to mailbox hash {mailboxhash}.
        slots:
          fromemail: query.fromemail
          mailboxhash: query.mailboxhash
      method: generated
      generated: '2026-10-01'