Explorium · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Service Webhooks API

5 actions 5 updates phrasing extends openapi/explorium-webhooks-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

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

$.paths['/v1/webhooks/{partner_id}'].get

$.paths['/v1/webhooks/{partner_id}'].delete

$.paths['/v1/webhooks/check_connectivity'].post

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 Partner Service Webhooks API
  version: 1.0.0
extends: openapi/explorium-webhooks-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/v1/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a webhook for event enrollments
      effect: write
      questions:
      - How do I get enrollment events pushed to my own URL?
      - Can I add custom headers to the webhook calls I receive?
      instructions:
      - text: Add webhook {webhook_url} for partner {partner_id}.
        slots:
          webhook_url: requestBody.webhook_url
          partner_id: requestBody.partner_id
      - text: Register {webhook_url} for partner {partner_id} with payload format {payload_format}.
        slots:
          webhook_url: requestBody.webhook_url
          partner_id: requestBody.partner_id
          payload_format: requestBody.payload_format
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/webhooks/{partner_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a partner's webhook
      effect: read
      questions:
      - Which URL are my event notifications being sent to?
      - Can I view the webhook configured for a partner?
      instructions:
      - text: Get the webhook for partner {partner_id}.
        slots:
          partner_id: path.partner_id
      - text: Show the events webhook set up for {partner_id}.
        slots:
          partner_id: path.partner_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/webhooks/{partner_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a partner's webhook
      effect: destructive
      questions:
      - How do I stop event notifications going to my webhook?
      - Can I remove a partner's webhook?
      instructions:
      - text: Delete the webhook for partner {partner_id}.
        slots:
          partner_id: path.partner_id
      - text: Remove the events webhook of {partner_id}.
        slots:
          partner_id: path.partner_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/webhooks/check_connectivity'].post
  update:
    x-apievangelist-phrasing:
      intent: Test webhook connectivity
      effect: write
      questions:
      - Can I verify my webhook endpoint is reachable before events start?
      - Is there a way to send a simulated call to my webhook?
      instructions:
      - text: Test webhook connectivity for partner {partner_id}.
        slots:
          partner_id: requestBody.partner_id
      - text: Send a simulated webhook call for partner {partner_id} with {simulation}.
        slots:
          partner_id: requestBody.partner_id
          simulation: requestBody.simulation
      method: generated
      generated: '2026-10-01'

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/explorium-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. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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