# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Svix Message Attempt API
  version: 1.0.0
extends: openapi/svix-message-attempt-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: 9
- target: $.paths['/api/v1/app/{app_id}/attempt/endpoint/{endpoint_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List delivery attempts to an endpoint
      effect: read
      questions:
      - What delivery attempts were made to a specific endpoint recently?
      - Can I see only the failed attempts to an endpoint that got 4xx responses?
      - How far back can I list an endpoint's attempts by default?
      instructions:
      - text: List delivery attempts to endpoint {endpoint_id} in app {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: Show attempts to endpoint {endpoint_id} of app {app_id} with status {status} and response class {status_code_class}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          status: query.status
          status_code_class: query.status_code_class
      - text: List endpoint {endpoint_id}'s attempts on app {app_id} after {after}, including the message payload.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/attempt/endpoint/{endpoint_id}/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count delivery attempts to an endpoint
      effect: read
      questions:
      - How many failed delivery attempts has an endpoint had?
      - Can I just get a count of an endpoint's attempts instead of the full list?
      instructions:
      - text: Count the delivery attempts to endpoint {endpoint_id} in app {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: Count attempts to endpoint {endpoint_id} of app {app_id} with status {status} before {before}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          status: query.status
          before: query.before
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/attempt/msg/{msg_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List delivery attempts for a message
      effect: read
      questions:
      - Was a particular webhook message delivered, and how many tries did it take?
      - Can I see a message's attempts to just one of its endpoints?
      instructions:
      - text: List all delivery attempts for message {msg_id} in app {app_id}.
        slots:
          msg_id: path.msg_id
          app_id: path.app_id
      - text: Show attempts of message {msg_id} on app {app_id} to endpoint {endpoint_id}.
        slots:
          msg_id: path.msg_id
          app_id: path.app_id
          endpoint_id: query.endpoint_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/msg'].get
  update:
    x-apievangelist-phrasing:
      intent: List messages sent to an endpoint
      effect: read
      questions:
      - Which messages has an endpoint been sent, with the latest attempt result for each?
      - Can I list an endpoint's messages on one channel or tag?
      instructions:
      - text: List the messages sent to endpoint {endpoint_id} in app {app_id} with their latest attempt.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: Show messages on channel {channel} delivered to endpoint {endpoint_id} of app {app_id}.
        slots:
          channel: query.channel
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/msg/{msg_id}/endpoint'].get
  update:
    x-apievangelist-phrasing:
      intent: List endpoints a message was sent to
      effect: read
      questions:
      - Which endpoints did a given webhook message go out to?
      - What was the latest delivery result at each destination for one message?
      instructions:
      - text: List the endpoints message {msg_id} in app {app_id} was sent to.
        slots:
          msg_id: path.msg_id
          app_id: path.app_id
      - text: Show every destination of message {msg_id} on app {app_id} with its latest attempt status.
        slots:
          msg_id: path.msg_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/msg/{msg_id}/attempt/{attempt_id}/headers'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the headers used on a delivery attempt
      effect: read
      questions:
      - What HTTP headers were sent with a specific webhook delivery attempt?
      - Can I see the signature headers used on one attempt to debug verification?
      instructions:
      - text: Show the headers sent on attempt {attempt_id} of message {msg_id} in app {app_id}.
        slots:
          attempt_id: path.attempt_id
          msg_id: path.msg_id
          app_id: path.app_id
      - text: Get the request headers for delivery attempt {attempt_id} of message {msg_id} on app {app_id}.
        slots:
          attempt_id: path.attempt_id
          msg_id: path.msg_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/msg/{msg_id}/attempt/{attempt_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single delivery attempt
      effect: read
      questions:
      - What response code and body did one delivery attempt get back?
      - Can I look up an attempt using the message's eventId instead of its ID?
      instructions:
      - text: Show attempt {attempt_id} of message {msg_id} in app {app_id}.
        slots:
          attempt_id: path.attempt_id
          msg_id: path.msg_id
          app_id: path.app_id
      - text: Fetch the result of delivery attempt {attempt_id} for message {msg_id} on app {app_id}.
        slots:
          attempt_id: path.attempt_id
          msg_id: path.msg_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/msg/{msg_id}/attempt/{attempt_id}/content'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a delivery attempt's response body
      effect: destructive
      questions:
      - An endpoint returned sensitive data in its response — how do I delete that stored body?
      - Can a message still be resent after I delete an attempt's response content?
      instructions:
      - text: Delete the response body stored for attempt {attempt_id} of message {msg_id} in app {app_id}.
        slots:
          attempt_id: path.attempt_id
          msg_id: path.msg_id
          app_id: path.app_id
      - text: Expunge the sensitive response content from attempt {attempt_id} on message {msg_id}, app {app_id}.
        slots:
          attempt_id: path.attempt_id
          msg_id: path.msg_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/msg/{msg_id}/endpoint/{endpoint_id}/resend'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend one message to an endpoint
      effect: write
      questions:
      - How do I resend a single webhook message to one endpoint?
      - Can I retry one specific message after the customer fixed their server?
      instructions:
      - text: Resend message {msg_id} to endpoint {endpoint_id} in app {app_id}.
        slots:
          msg_id: path.msg_id
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: Deliver message {msg_id} again to endpoint {endpoint_id} of application {app_id}.
        slots:
          msg_id: path.msg_id
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'