Generated by API Evangelist
Written by API Evangelist tooling for Ghost's API. It is a proposal applied on top of the contract, not a document Ghost publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Ghost Admin Webhooks API
version: 1.0.0
extends: openapi/ghost-org-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: 3
- target: $.paths['/webhooks/'].post
update:
x-apievangelist-phrasing:
intent: Create a webhook subscription
effect: write
questions:
- How do I get an HTTP POST to my server when a post is published?
- Does a webhook need to belong to an integration?
instructions:
- text: Create webhook {webhooks}.
slots:
webhooks: requestBody.webhooks
- text: Subscribe my target URL to an event using {webhooks}.
slots:
webhooks: requestBody.webhooks
method: generated
generated: '2026-09-26'
- target: $.paths['/webhooks/{id}/'].put
update:
x-apievangelist-phrasing:
intent: Update a webhook subscription
effect: write
questions:
- How do I change the event or target URL of a webhook?
- Can I edit an existing webhook subscription?
instructions:
- text: Update webhook {id} with {webhooks}.
slots:
id: path.id
webhooks: requestBody.webhooks
- text: Change the target URL of webhook {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/webhooks/{id}/'].delete
update:
x-apievangelist-phrasing:
intent: Delete a webhook subscription
effect: destructive
questions:
- How do I stop a webhook from sending notifications?
- Can a deleted webhook be restored?
instructions:
- text: Delete webhook {id}.
slots:
id: path.id
- text: Permanently remove webhook {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
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.