Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource Webhook API
17 actions
17 updates
phrasing
extends
openapi/deputy-webhook-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.
What the actions change
x-apievangelist-phrasing
Targets 17 · first 16 shown; the file carries all of them
$.info
$.paths['/resource/Webhook'].get
$.paths['/resource/Webhook'].put
$.paths['/resource/Webhook'].post
$.paths['/resource/Webhook/BULK'].post
$.paths['/resource/Webhook/INFO'].get
$.paths['/resource/Webhook/PREDICT'].post
$.paths['/resource/Webhook/QUERY'].post
$.paths['/resource/Webhook/{id}'].get
$.paths['/resource/Webhook/{id}'].put
$.paths['/resource/Webhook/{id}'].post
$.paths['/resource/Webhook/{id}'].delete
$.paths['/resource/Webhook/{id}/COMMENTS'].get
$.paths['/resource/Webhook/{id}/COMMENTS'].post
$.paths['/resource/Webhook/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/Webhook/{id}/HISTORY'].get
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 Deputy V1 Resource Webhook API
version: 1.0.0
extends: openapi/deputy-webhook-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: 16
- target: $.paths['/resource/Webhook'].get
update:
x-apievangelist-phrasing:
intent: List webhook subscriptions
effect: read
questions:
- Which webhooks are subscribed to a given topic?
- Can I see all webhook subscriptions on my account?
instructions:
- text: List all webhook subscriptions.
- text: Show every webhook subscription on this account.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Webhook'].put
update:
x-apievangelist-phrasing:
intent: Create or replace a webhook subscription
effect: write
questions:
- How do I create a webhook that posts to a URL when a record changes?
- Can I replace an existing webhook subscription with a new one?
instructions:
- text: Create a webhook subscription for topic {topic} posting to {address}.
slots:
topic: requestBody.Topic
address: requestBody.Address
- text: Replace the existing webhook subscription {id} with a new one for {topic} at {address}.
slots:
id: requestBody.Id
topic: requestBody.Topic
address: requestBody.Address
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Webhook'].post
update:
x-apievangelist-phrasing:
intent: Create a webhook for resource events
effect: write
questions:
- How do I send resource change events to my server by webhook?
- Can I filter which resource events trigger a webhook?
- Which event types can I choose for a resource webhook?
instructions:
- text: Create a {type} webhook for {topic} at {address}.
slots:
type: requestBody.Type
topic: requestBody.Topic
address: requestBody.Address
- text: Create a {type} webhook for {topic} at {address} filtered by {filters}.
slots:
type: requestBody.Type
topic: requestBody.Topic
address: requestBody.Address
filters: requestBody.Filters
- text: Create a {type} webhook for {topic} at {address} sending only {enabled} events.
slots:
type: requestBody.Type
topic: requestBody.Topic
address: requestBody.Address
enabled: requestBody.Enabled
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Webhook/BULK'].post
update:
x-apievangelist-phrasing:
intent: Create or update many webhooks at once
effect: write
questions:
- Can I create or update several webhooks in a single request?
- How do I bulk upsert webhook subscriptions?
instructions:
- text: Bulk create or update these webhook subscriptions.
- text: Process this array of webhook records in one request.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Webhook/INFO'].get
update:
x-apievangelist-phrasing:
intent: Get webhook field metadata
effect: read
questions:
- Which fields can I query on webhook subscriptions?
- What field types and associations does the webhook resource have?
instructions:
- text: Get the field metadata for webhook subscriptions.
- text: Show which webhook fields are queryable.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Webhook/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing webhook for a payload
effect: read
questions:
- Can I find the existing webhook subscription that matches a partial payload?
- How do I upsert a webhook by matching its address and topic?
instructions:
- text: Predict the existing webhook for topic {topic} posting to {address}.
slots:
topic: requestBody.Topic
address: requestBody.Address
- text: Find the webhook subscription matching {topic} at {address} with filters {filters}.
slots:
topic: requestBody.Topic
address: requestBody.Address
filters: requestBody.Filters
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Webhook/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search webhook subscriptions
effect: read
questions:
- Can I search webhook subscriptions by topic or address?
- How do I sort and page through webhook subscriptions?
instructions:
- text: Search webhook subscriptions where {search}.
slots:
search: requestBody.search
- text: Find webhooks matching {search} sorted by {sort}.
slots:
search: requestBody.search
sort: requestBody.sort
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Webhook/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a webhook subscription
effect: read
questions:
- What topic and address does a specific webhook subscription have?
- Can I look up one webhook by its id?
instructions:
- text: Get webhook subscription {id}.
slots:
id: path.id
- text: Show the topic and address of webhook {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Webhook/{id}'].put
update:
x-apievangelist-phrasing:
intent: Update a webhook subscription
effect: write
questions:
- How do I change the address or topic of an existing webhook?
- Can I fully replace a webhook subscription's settings?
instructions:
- text: Replace webhook {id} with topic {topic} posting to {address}.
slots:
id: path.id
topic: requestBody.Topic
address: requestBody.Address
- text: Fully update webhook {id} to {topic} at {address} with filters {filters}.
slots:
id: path.id
topic: requestBody.Topic
address: requestBody.Address
filters: requestBody.Filters
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Webhook/{id}'].post
update:
x-apievangelist-phrasing:
intent: Patch a webhook subscription
effect: write
questions:
- Can I turn an existing webhook on or off without resending all its fields?
- How do I change just the enabled state of a webhook?
instructions:
- text: Update webhook {id} to enabled {enabled}.
slots:
id: path.id
enabled: requestBody.Enabled
- text: Patch webhook {id} with filters {filters}.
slots:
id: path.id
filters: requestBody.Filters
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Webhook/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a webhook subscription
effect: destructive
questions:
- How do I stop a webhook from receiving notifications?
- Can I delete a webhook subscription entirely?
instructions:
- text: Delete webhook subscription {id}.
slots:
id: path.id
- text: Remove the webhook {id} so it stops posting.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Webhook/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on a webhook
effect: read
questions:
- What comments have been left on a webhook subscription?
- Can I see the notes on a webhook?
instructions:
- text: List comments on webhook {id}.
slots:
id: path.id
- text: Show the notes left on webhook subscription {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Webhook/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Comment on a webhook
effect: write
questions:
- Can I annotate a webhook subscription with a note?
- How do I add a comment to a webhook?
instructions:
- text: Add comment {comment} to webhook {id}.
slots:
comment: requestBody.Comment
id: path.id
- text: Comment on webhook subscription {id} saying {comment}.
slots:
id: path.id
comment: requestBody.Comment
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Webhook/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment on a webhook
effect: destructive
questions:
- How do I remove a comment from a webhook?
- Can I delete one note on a webhook subscription?
instructions:
- text: Delete comment {commentId} from webhook {id}.
slots:
commentId: path.commentId
id: path.id
- text: Remove note {commentId} on webhook subscription {id}.
slots:
commentId: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Webhook/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get a webhook's change history
effect: read
questions:
- Who changed a webhook subscription and when?
- Can I see the full edit history of a webhook?
instructions:
- text: Show the change history of webhook {id}.
slots:
id: path.id
- text: List every edit made to webhook subscription {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Webhook/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: See a webhook as it was at a past time
effect: read
questions:
- What did a webhook subscription look like at a specific moment in the past?
- Can I travel back to a webhook's state before a change?
instructions:
- text: Show webhook {id} as it existed at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Travel back to webhook subscription {id} at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
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.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/deputy-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.