Stax · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for stax-api Webhook API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/webhook'].get
$.paths['/webhook'].post
$.paths['/webhook/{id}'].delete

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 stax-api Webhook API
  version: 1.0.0
extends: openapi/stax-webhook-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['/webhook'].get
  update:
    x-apievangelist-phrasing:
      intent: List my webhooks
      effect: read
      questions:
      - Which webhooks have I set up for my merchants?
      - Can I page through my webhooks more than 20 at a time?
      instructions:
      - text: List all my webhooks.
      - text: Show page {page} of my webhooks, {per_page} per page.
        slots:
          page: query.page
          per_page: query.per_page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhook'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook for all my merchants
      effect: write
      questions:
      - Can I get notified at my own URL when a transaction event happens on any of my merchants?
      - Is it possible to register one webhook that covers every merchant my user has?
      instructions:
      - text: Create a webhook to {target_url} for event {event} across all my merchants.
        slots:
          target_url: query.target_url
          event: query.event
      - text: Send {event} events from every merchant I have to {target_url}.
        slots:
          event: query.event
          target_url: query.target_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhook/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - Can I stop a webhook from firing?
      - Is deleting a webhook a soft delete?
      instructions:
      - text: Delete webhook {id}.
        slots:
          id: path.id
      - text: Remove webhook {id} so it stops sending events.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'