Ringover · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ringover Public Webhook API

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

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/webhooks'].get
$.paths['/webhooks'].post
$.paths['/webhooks/{webhookId}'].get
$.paths['/webhooks/{webhookId}'].delete
$.paths['/webhooks/{webhookId}/events'].put
$.paths['/webhooks/{webhookId}/events'].patch

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 Ringover Public Webhook API
  version: 1.0.0
extends: openapi/ringover-webhook-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-11-20'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List my webhook subscriptions
      effect: read
      questions:
      - Which URLs am I currently receiving Ringover events at?
      - How many webhook subscriptions do I have?
      instructions:
      - text: List all my webhook subscriptions.
      - text: Show every target URL and event type I'm subscribed to.
      method: generated
      generated: '2026-11-20'
- target: $.paths['/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a URL to events
      effect: write
      questions:
      - How do I start receiving Ringover events at my own URL?
      - Can I add more events to a target URL that is already subscribed?
      instructions:
      - text: Subscribe {target_url} to events {events}.
        slots:
          target_url: requestBody.target_url
          events: requestBody.events
      - text: Send webhook events {events} to my endpoint {target_url}.
        slots:
          events: requestBody.events
          target_url: requestBody.target_url
      method: generated
      generated: '2026-11-20'
- target: $.paths['/webhooks/{webhookId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one webhook subscription
      effect: read
      questions:
      - What events is a particular webhook currently subscribed to?
      - Can I look up a webhook by its UUID?
      instructions:
      - text: Show webhook {webhookId}.
        slots:
          webhookId: path.webhookId
      - text: Get the target URL and events of webhook {webhookId}.
        slots:
          webhookId: path.webhookId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/webhooks/{webhookId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe a webhook
      effect: destructive
      questions:
      - How do I stop Ringover from delivering events to a URL?
      - What happens to other webhooks when I delete one?
      instructions:
      - text: Delete webhook {webhookId}.
        slots:
          webhookId: path.webhookId
      - text: Unsubscribe webhook {webhookId} from all events.
        slots:
          webhookId: path.webhookId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/webhooks/{webhookId}/events'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a webhook's events
      effect: write
      questions:
      - How do I replace the full list of events a webhook receives?
      - Can I unsubscribe a webhook from events I no longer care about?
      instructions:
      - text: Replace the events of webhook {webhookId} with {events}.
        slots:
          webhookId: path.webhookId
          events: requestBody.events
      - text: Make webhook {webhookId} deliver only {events}.
        slots:
          webhookId: path.webhookId
          events: requestBody.events
      method: generated
      generated: '2026-11-20'
- target: $.paths['/webhooks/{webhookId}/events'].patch
  update:
    x-apievangelist-phrasing:
      intent: Add events to a webhook
      effect: write
      questions:
      - How do I subscribe an existing webhook to a new event type?
      - Can I keep the events a webhook already receives while adding more?
      instructions:
      - text: Add events {events} to webhook {webhookId}.
        slots:
          events: requestBody.events
          webhookId: path.webhookId
      - text: Subscribe webhook {webhookId} to {events} without touching its existing events.
        slots:
          webhookId: path.webhookId
          events: requestBody.events
      method: generated
      generated: '2026-11-20'

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/ringover-webhook-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.