Ghost · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ghost Content and Admin Admin - Webhooks API

4 actions 4 updates phrasing extends openapi/ghost-org-admin-webhooks-api-openapi.yml
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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/admin/webhooks/'].post
$.paths['/admin/webhooks/{id}/'].put
$.paths['/admin/webhooks/{id}/'].delete

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 Ghost Content and Admin Admin - Webhooks API
  version: 1.0.0
extends: openapi/ghost-org-admin-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['/admin/webhooks/'].post
  update:
    x-apievangelist-phrasing:
      intent: Register an outbound webhook
      effect: write
      questions:
      - How do I get notified when a post is published on my site?
      - Can I trigger a webhook when a new member is added?
      instructions:
      - text: Create a webhook from {webhooks}.
        slots:
          webhooks: requestBody.webhooks
      - text: Register a webhook that fires on post.published.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admin/webhooks/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a webhook
      effect: write
      questions:
      - Can I change the target URL or event of an existing webhook?
      - How do I edit a webhook I already registered?
      instructions:
      - text: Update webhook {id} with {webhooks}.
        slots:
          id: path.id
          webhooks: requestBody.webhooks
      - text: Point webhook {id} at a new target URL.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admin/webhooks/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - How do I stop a webhook from firing?
      - Can I remove a webhook I no longer need?
      instructions:
      - text: Delete webhook {id}.
        slots:
          id: path.id
      - text: Remove the webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'