Talon.One · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Management Webhooks API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/v1/webhooks'].get
$.paths['/v1/webhooks/{webhookId}'].get

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 Management Webhooks API
  version: 1.0.0
extends: openapi/talon-one-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: 2
- target: $.paths['/v1/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhooks
      effect: read
      questions:
      - What webhooks are configured in my account?
      - Can I list only the webhooks used by specific Applications?
      instructions:
      - text: List all webhooks.
      - text: Show webhooks for Applications {applicationIds}.
        slots:
          applicationIds: query.applicationIds
      - text: Find webhooks titled {title}.
        slots:
          title: query.title
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/webhooks/{webhookId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook
      effect: read
      questions:
      - What URL and payload does a specific webhook send?
      - Can I look up one webhook's configuration by ID?
      instructions:
      - text: Get webhook {webhookId}.
        slots:
          webhookId: path.webhookId
      - text: Show the configuration of webhook {webhookId}.
        slots:
          webhookId: path.webhookId
      method: generated
      generated: '2026-09-26'