Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V2 Webhook Triggers API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/management/v2/webhooks/trigger'].post
$.paths['/management/v2/webhooks/trigger:bulk'].post

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 Deputy V2 Webhook Triggers API
  version: 1.0.0
extends: openapi/deputy-webhook-triggers-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-11-17'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/management/v2/webhooks/trigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger a webhook for an entity
      effect: write
      questions:
      - How do I fire a webhook for a single employee or location?
      - Can I add a reason when triggering a webhook for an entity?
      instructions:
      - text: Trigger the {webhookTopic} webhook for {entityIds}.
        slots:
          webhookTopic: requestBody.webhookTopic
          entityIds: requestBody.entityIds
      - text: Fire a {webhookTopic} webhook on {entityIds} because {reason}.
        slots:
          webhookTopic: requestBody.webhookTopic
          entityIds: requestBody.entityIds
          reason: requestBody.reason
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/webhooks/trigger:bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger many webhooks at once
      effect: write
      questions:
      - Can I send several webhook requests in one call?
      - Is there a way to limit how many webhooks go out in parallel?
      instructions:
      - text: 'Trigger these webhook requests in bulk: {requests}.'
        slots:
          requests: requestBody.requests
      - text: Fire {requests} as webhooks with at most {maxConcurrent} running at once.
        slots:
          requests: requestBody.requests
          maxConcurrent: requestBody.maxConcurrent
      method: generated
      generated: '2026-11-17'

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/deputy-webhook-triggers-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.