Hilt · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Hilt So Webhooks API
10 actions
10 updates
phrasing
extends
openapi/hilt-so-webhooks-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Hilt's API. It is a proposal applied on top of the contract, not a document Hilt publishes.
What the actions change
x-apievangelist-phrasing
Targets 10
$.info
$.paths['/v1/webhooks/endpoints'].get
$.paths['/v1/webhooks/endpoints'].post
$.paths['/v1/webhooks/endpoints/{endpoint_id}'].delete
$.paths['/v1/webhooks/endpoints/{endpoint_id}'].patch
$.paths['/v1/webhooks/endpoints/{endpoint_id}/test'].post
$.paths['/v1/webhooks/deliveries'].get
$.paths['/v1/webhooks/deliveries/{delivery_id}/replay'].post
$.paths['/v1/webhooks/timeline'].get
$.paths['/v1/webhooks/events'].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 Hilt So Webhooks API
version: 1.0.0
extends: openapi/hilt-so-webhooks-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 9
- target: $.paths['/v1/webhooks/endpoints'].get
update:
x-apievangelist-phrasing:
intent: List webhook endpoints
effect: read
questions:
- Which webhook endpoints have I set up?
- Where are my webhooks being sent?
instructions:
- text: List my webhook endpoints.
- text: Show all my configured webhooks.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/webhooks/endpoints'].post
update:
x-apievangelist-phrasing:
intent: Create a webhook endpoint
effect: write
questions:
- How do I get notified when someone pays?
- Can a webhook only fire for certain products?
instructions:
- text: Create webhook {label} pointing to {url}.
slots:
label: requestBody.label
url: requestBody.url
- text: Add webhook {label} at {url} for events {subscribed_events}.
slots:
label: requestBody.label
url: requestBody.url
subscribed_events: requestBody.subscribed_events
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/webhooks/endpoints/{endpoint_id}'].delete
update:
x-apievangelist-phrasing:
intent: Disable a webhook endpoint
effect: destructive
questions:
- How do I turn off a webhook endpoint?
- Can I stop events going to an old URL?
instructions:
- text: Disable webhook endpoint {endpoint_id}.
slots:
endpoint_id: path.endpoint_id
- text: Stop sending events to endpoint {endpoint_id}.
slots:
endpoint_id: path.endpoint_id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/webhooks/endpoints/{endpoint_id}'].patch
update:
x-apievangelist-phrasing:
intent: Update a webhook endpoint
effect: write
questions:
- Can I change the URL of an existing webhook?
- Is it possible to rotate a webhook's signing secret?
instructions:
- text: Change the URL of webhook {endpoint_id} to {url}.
slots:
endpoint_id: path.endpoint_id
url: requestBody.url
- text: Rotate the signing secret on webhook {endpoint_id}.
slots:
endpoint_id: path.endpoint_id
- text: Update webhook {endpoint_id} to listen for {subscribed_events}.
slots:
endpoint_id: path.endpoint_id
subscribed_events: requestBody.subscribed_events
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/webhooks/endpoints/{endpoint_id}/test'].post
update:
x-apievangelist-phrasing:
intent: Send a test webhook event
effect: write
questions:
- Can I send a signed test event to check my webhook works?
- Can I choose which event type the test sends?
instructions:
- text: Send a test event to webhook {endpoint_id}.
slots:
endpoint_id: path.endpoint_id
- text: Fire a test {event_type} event at endpoint {endpoint_id}.
slots:
event_type: requestBody.event_type
endpoint_id: path.endpoint_id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/webhooks/deliveries'].get
update:
x-apievangelist-phrasing:
intent: List webhook deliveries
effect: read
questions:
- Which webhook deliveries failed?
- Can I see delivery attempts for one endpoint?
instructions:
- text: List webhook deliveries for endpoint {endpoint_id}.
slots:
endpoint_id: query.endpoint_id
- text: Show {status} webhook deliveries.
slots:
status: query.status
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/webhooks/deliveries/{delivery_id}/replay'].post
update:
x-apievangelist-phrasing:
intent: Replay a webhook delivery
effect: write
questions:
- Can I resend a webhook delivery my server missed?
- What's the way to replay a single failed delivery?
instructions:
- text: Replay webhook delivery {delivery_id}.
slots:
delivery_id: path.delivery_id
- text: Resend delivery {delivery_id} to its endpoint.
slots:
delivery_id: path.delivery_id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/webhooks/timeline'].get
update:
x-apievangelist-phrasing:
intent: View the webhook timeline for a payment or membership
effect: read
questions:
- Which webhooks fired for a specific payment?
- Can I see the event history of one membership?
instructions:
- text: Show the webhook timeline for payment {payment_id}.
slots:
payment_id: query.payment_id
- text: Show webhook events for membership {membership_id}.
slots:
membership_id: query.membership_id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/webhooks/events'].get
update:
x-apievangelist-phrasing:
intent: List emitted webhook events
effect: read
questions:
- What webhook events has my account emitted?
- Can I list only one type of webhook event?
instructions:
- text: List emitted webhook events.
- text: List webhook events of type {event_type}.
slots:
event_type: query.event_type
method: generated
generated: '2026-09-26'
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/hilt-so-webhooks-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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.
A second provider on the same verified email joins the account you already have.