Stax · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for stax-api Webhookadmin API

5 actions 5 updates phrasing extends openapi/stax-webhookadmin-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 5

$.info

$.paths['/webhookadmin/webhook/brand'].get

$.paths['/webhookadmin/webhook/brand'].post

$.paths['/webhookadmin/webhook/brand/{webhook_id}'].get

$.paths['/webhookadmin/webhook/brand/{webhook_id}'].delete

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 stax-api Webhookadmin API
  version: 1.0.0
extends: openapi/stax-webhookadmin-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: 4
- target: $.paths['/webhookadmin/webhook/brand'].get
  update:
    x-apievangelist-phrasing:
      intent: List partner-level brand webhooks
      effect: read
      questions:
      - Which partner-level webhooks are registered for my brand?
      - Can I see the brand-wide webhooks that fire for all my merchants?
      instructions:
      - text: List my brand's partner-level webhooks.
      - text: Show every webhook configured at the partner brand level.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhookadmin/webhook/brand'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a partner-level brand webhook
      effect: write
      questions:
      - Can I create one webhook that triggers for every merchant under my partner brand?
      - Is it possible to set retry frequency and retry count on a brand webhook?
      instructions:
      - text: Create a brand-level webhook to {target_url} for event {event_name}.
        slots:
          target_url: requestBody.target_url
          event_name: requestBody.event_name
      - text: Add a partner webhook for {event_name} at {target_url} retrying every {retry_frequency}.
        slots:
          event_name: requestBody.event_name
          target_url: requestBody.target_url
          retry_frequency: requestBody.meta.webhook_retry_frequency
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhookadmin/webhook/brand/{webhook_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a partner-level brand webhook
      effect: read
      questions:
      - What URL and event is a particular brand webhook set to?
      - Can I look up one partner-level webhook by ID?
      instructions:
      - text: Get brand webhook {webhook_id}.
        slots:
          webhook_id: path.webhook_id
      - text: Show the target URL and event of partner webhook {webhook_id}.
        slots:
          webhook_id: path.webhook_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhookadmin/webhook/brand/{webhook_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a partner-level brand webhook
      effect: destructive
      questions:
      - Can I remove a webhook that fires for my whole partner brand?
      - What happens to merchants' notifications when a brand webhook is deleted?
      instructions:
      - text: Delete brand webhook {webhook_id}.
        slots:
          webhook_id: path.webhook_id
      - text: Remove partner-level webhook {webhook_id} from my brand.
        slots:
          webhook_id: path.webhook_id
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This overlay

curl "https://apis.io/api/v1/overlays/stax-webhookadmin-api-phrasing-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.