Klaviyo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Klaviyo Webhooks API

8 actions 8 updates phrasing extends openapi/klaviyo-webhooks-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Klaviyo's API. It is a proposal applied on top of the contract, not a document Klaviyo publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info

$.paths['/api/webhooks'].get

$.paths['/api/webhooks'].post

$.paths['/api/webhooks/{id}'].get

$.paths['/api/webhooks/{id}'].delete

$.paths['/api/webhooks/{id}'].patch

$.paths['/api/webhook-topics'].get

$.paths['/api/webhook-topics/{id}'].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 Klaviyo Webhooks API
  version: 1.0.0
extends: openapi/klaviyo-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: 7
- target: $.paths['/api/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhooks in the account
      effect: read
      questions:
      - What webhooks have I registered in Klaviyo?
      - Can I see which topics each webhook is subscribed to?
      instructions:
      - text: List all my webhooks.
      - text: Show my webhooks with their {include}.
        slots:
          include: query.include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook
      effect: write
      questions:
      - How do I get notified at my own endpoint when certain events happen?
      - What do I need to supply to register a new webhook?
      instructions:
      - text: 'Create a webhook with these settings: {webhook}.'
        slots:
          webhook: requestBody.data
      - text: Register my endpoint URL and topics {webhook} as a new webhook.
        slots:
          webhook: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/webhooks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one webhook by ID
      effect: read
      questions:
      - Where is a specific webhook sending its payloads?
      - Can I fetch a single webhook with its topics?
      instructions:
      - text: Get webhook {webhook_id}.
        slots:
          webhook_id: path.id
      - text: Show webhook {webhook_id} with its {include}.
        slots:
          webhook_id: path.id
          include: query.include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/webhooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - How do I stop a webhook from sending any more notifications?
      - Can I remove a webhook by its ID?
      instructions:
      - text: Delete webhook {webhook_id}.
        slots:
          webhook_id: path.id
      - text: Remove the obsolete webhook {webhook_id}.
        slots:
          webhook_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/webhooks/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a webhook
      effect: write
      questions:
      - Can I change the endpoint URL or topics of an existing webhook?
      - Is it possible to pause a webhook by updating it?
      instructions:
      - text: Update webhook {webhook_id} with {changes}.
        slots:
          webhook_id: path.id
          changes: requestBody.data
      - text: 'Point webhook {webhook_id} at a new URL: {changes}.'
        slots:
          webhook_id: path.id
          changes: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/webhook-topics'].get
  update:
    x-apievangelist-phrasing:
      intent: List available webhook topics
      effect: read
      questions:
      - Which event topics can a webhook subscribe to?
      - What kinds of notifications are available for webhooks?
      instructions:
      - text: List all available webhook topics.
      - text: Show the webhook topics available under API revision {revision}.
        slots:
          revision: header.revision
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/webhook-topics/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one webhook topic
      effect: read
      questions:
      - What does a particular webhook topic cover?
      - Can I look up a single topic by its ID?
      instructions:
      - text: Get webhook topic {topic_id}.
        slots:
          topic_id: path.id
      - text: Describe the webhook topic {topic_id}.
        slots:
          topic_id: path.id
      method: generated
      generated: '2026-09-26'