Kit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kit Webhooks API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/v4/webhooks'].get
$.paths['/v4/webhooks'].post
$.paths['/v4/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 Kit Webhooks API
  version: 1.0.0
extends: openapi/convertkit-webhooks-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/v4/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhooks
      effect: read
      questions:
      - Which webhooks are currently set up on my account?
      - Can I see what URLs receive my subscriber event notifications?
      instructions:
      - text: List all my webhooks.
      - text: Show my registered webhooks, {per_page} per page.
        slots:
          per_page: query.per_page
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook for a subscriber event
      effect: write
      questions:
      - How do I get notified at my server when someone unsubscribes?
      - Which subscriber events can trigger a webhook?
      instructions:
      - text: Create a webhook that posts {event} events to {target_url}.
        slots:
          event: requestBody.event
          target_url: requestBody.target_url
      - text: Send subscriber event {event} to my endpoint {target_url}.
        slots:
          event: requestBody.event
          target_url: requestBody.target_url
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/webhooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - How do I stop a webhook from sending events to my server?
      - Can I remove a webhook I no longer need?
      instructions:
      - text: Delete webhook {id}.
        slots:
          id: path.id
      - text: Remove the webhook {id} so it stops firing.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'