Assembly Payments · OpenAPI Overlay 1.0.0

Webhooks API enhancements (API Evangelist)

10 actions 10 updates update extends openapi/assembly-payments-webhooks-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-agent-safetyx-providerx-api-evangelist-profiledx-docsx-llms-txt

Targets 10

$.info

$.paths['/status'].get

$.paths['/webhooks'].post

$.paths['/webhooks'].get

$.paths['/webhooks/secret_key'].post

$.paths['/webhooks/{uuid}'].get

$.paths['/webhooks/{uuid}'].patch

$.paths['/webhooks/{uuid}'].delete

$.paths['/webhooks/{uuid}/jobs'].get

$.paths['/webhooks/{uuid}/jobs/{jobUUID}'].get

OpenAPI Overlay

overlay: 1.0.0
info:
  title: Webhooks API enhancements (API Evangelist)
  version: 1.0.0
extends: openapi/assembly-payments-webhooks-api-openapi.yml
x-generated: '2026-10-22'
x-method: generated
x-description: Adds provider/docs metadata and per-operation agent-safety hints (derived from HTTP method only) without mutating the original
  contract.
actions:
- target: $.info
  update:
    x-provider: Assembly Payments (now Zai)
    x-api-evangelist-profiled: '2026-10-22'
    x-docs: https://developer.hellozai.com/docs/introduction
    x-llms-txt: https://developer.hellozai.com/llms.txt
- target: $.paths['/status'].get
  update:
    x-agent-safety: read-only
- target: $.paths['/webhooks'].post
  update:
    x-agent-safety: mutating
- target: $.paths['/webhooks'].get
  update:
    x-agent-safety: read-only
- target: $.paths['/webhooks/secret_key'].post
  update:
    x-agent-safety: mutating
- target: $.paths['/webhooks/{uuid}'].get
  update:
    x-agent-safety: read-only
- target: $.paths['/webhooks/{uuid}'].patch
  update:
    x-agent-safety: mutating
- target: $.paths['/webhooks/{uuid}'].delete
  update:
    x-agent-safety: destructive
- target: $.paths['/webhooks/{uuid}/jobs'].get
  update:
    x-agent-safety: read-only
- target: $.paths['/webhooks/{uuid}/jobs/{jobUUID}'].get
  update:
    x-agent-safety: read-only

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/assembly-payments-webhooks-api-overlay"

All openapi overlays

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

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.