Kinde · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kinde Management Webhooks API

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

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/api/v1/events/{event_id}'].get
$.paths['/api/v1/event_types'].get
$.paths['/api/v1/webhooks/{webhook_id}'].delete
$.paths['/api/v1/webhooks/{webhook_id}'].patch
$.paths['/api/v1/webhooks'].get
$.paths['/api/v1/webhooks'].post

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 Kinde Management Webhooks API
  version: 1.0.0
extends: openapi/kinde-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: 6
- target: $.paths['/api/v1/events/{event_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook event
      effect: read
      questions:
      - Can I fetch the payload of a specific event that fired?
      - How do I look up an event by its ID?
      instructions:
      - text: Show event {event_id}.
        slots:
          event_id: path.event_id
      - text: Get the details of webhook event {event_id}.
        slots:
          event_id: path.event_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/event_types'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhook event types
      effect: read
      questions:
      - Which event types can a webhook subscribe to?
      - What events does the platform emit, like user created?
      instructions:
      - text: List all event types.
      - text: Show the event types available for webhooks.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/webhooks/{webhook_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - How do I delete a webhook I no longer need?
      - Can I stop events being sent to an endpoint?
      instructions:
      - text: Delete webhook {webhook_id}.
        slots:
          webhook_id: path.webhook_id
      - text: Remove the webhook {webhook_id} permanently.
        slots:
          webhook_id: path.webhook_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/webhooks/{webhook_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a webhook
      effect: write
      questions:
      - Can I change which events an existing webhook listens for?
      - How do I rename a webhook?
      instructions:
      - text: Change webhook {webhook_id} to listen for {event_types}.
        slots:
          webhook_id: path.webhook_id
          event_types: requestBody.event_types
      - text: Rename webhook {webhook_id} to {name}.
        slots:
          webhook_id: path.webhook_id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhooks
      effect: read
      questions:
      - Which webhooks are configured?
      - Can I see every endpoint receiving events?
      instructions:
      - text: List all my webhooks.
      - text: Show every configured webhook endpoint.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook
      effect: write
      questions:
      - How do I get notified at my endpoint when a user signs up?
      - Can I subscribe one webhook to several event types?
      instructions:
      - text: Create webhook {name} sending {event_types} to {endpoint}.
        slots:
          name: requestBody.name
          event_types: requestBody.event_types
          endpoint: requestBody.endpoint
      - text: Send {event_types} events to {endpoint} via a new webhook named {name}.
        slots:
          event_types: requestBody.event_types
          endpoint: requestBody.endpoint
          name: requestBody.name
      method: generated
      generated: '2026-09-26'