Akahu · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Akahu Webhooks API

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

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/keys/{id}'].get
$.paths['/webhook-events'].get
$.paths['/webhooks'].get
$.paths['/webhooks'].post
$.paths['/webhooks/{id}'].delete
$.paths['/v1/webhooks/keys/{keyId}'].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 Akahu Webhooks API
  version: 1.0.0
extends: openapi/akahu-webhooks-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-11-18'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/keys/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook signing key
      effect: read
      questions:
      - How do I get the public key Akahu uses to sign webhooks?
      - Can I fetch a webhook signing key by its ID?
      instructions:
      - text: Get webhook signing key {id}.
        slots:
          id: path.id
      - text: Fetch the public key {id} used to sign webhooks.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/webhook-events'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhook events
      effect: read
      questions:
      - Which webhook events has Akahu sent to my app recently?
      - Can I list only failed webhook events within a date range?
      instructions:
      - text: List webhook events with status {status}.
        slots:
          status: query.status
      - text: Show webhook events from {start} to {end}.
        slots:
          start: query.start
          end: query.end
      method: generated
      generated: '2026-11-18'
- target: $.paths['/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List my active webhook subscriptions
      effect: read
      questions:
      - Which webhook subscriptions has my app created for a user?
      - What webhooks are active on my app?
      instructions:
      - text: List all active webhook subscriptions for my app.
      - text: Show my webhook subscriptions using token {token}.
        slots:
          token: header.X-Akahu-Id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to webhook events
      effect: write
      questions:
      - How do I start receiving webhook events for a user?
      - Do I need a new webhook subscription for each event type per user?
      instructions:
      - text: Subscribe to webhook type {webhook_type}.
        slots:
          webhook_type: requestBody.webhook_type
      - text: Create a webhook subscription for {webhook_type} with state {state}.
        slots:
          webhook_type: requestBody.webhook_type
          state: requestBody.state
      method: generated
      generated: '2026-11-18'
- target: $.paths['/webhooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe from a webhook
      effect: destructive
      questions:
      - How do I stop receiving webhook events for a user?
      - Can I delete a webhook subscription by its ID?
      instructions:
      - text: Delete webhook subscription {id}.
        slots:
          id: path.id
      - text: Unsubscribe from webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v1/webhooks/keys/{keyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a one-off payment webhook signing key
      effect: read
      questions:
      - How do I verify a one-off payment webhook signature?
      - Where do I get the PEM public key for a payment webhook?
      instructions:
      - text: Get the one-off payment webhook signing key {keyId}.
        slots:
          keyId: path.keyId
      - text: Fetch the PEM signing key {keyId} for verifying payment webhooks.
        slots:
          keyId: path.keyId
      method: generated
      generated: '2026-11-18'

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/akahu-webhooks-api-phrasing-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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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