Tabby · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tabby API Reference Webhooks API

6 actions 6 updates phrasing extends openapi/tabby-webhooks-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

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

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

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

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

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

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 Tabby API Reference Webhooks API
  version: 1.0.0
extends: openapi/tabby-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: 5
- target: $.paths['/api/v1/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List registered webhooks
      effect: read
      questions:
      - Which webhooks have I registered for payment notifications?
      - Can I see all the webhooks set up for one of my stores?
      instructions:
      - text: List all webhooks for merchant {X-Merchant-Code}.
        slots:
          X-Merchant-Code: header.X-Merchant-Code
      - text: Show every notification endpoint registered under store {X-Merchant-Code}.
        slots:
          X-Merchant-Code: header.X-Merchant-Code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a webhook endpoint
      effect: write
      questions:
      - How do I get notified at my server when a payment changes?
      - Does a new webhook URL need to be HTTPS and publicly reachable?
      - Can I add a custom header that gets sent with each notification?
      instructions:
      - text: Register webhook {url} for merchant {X-Merchant-Code}.
        slots:
          url: requestBody.url
          X-Merchant-Code: header.X-Merchant-Code
      - text: Add a new webhook at {url} for store {X-Merchant-Code} sending auth header {header}.
        slots:
          url: requestBody.url
          X-Merchant-Code: header.X-Merchant-Code
          header: requestBody.header
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/webhooks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one webhook's settings
      effect: read
      questions:
      - What URL and header is a particular webhook configured with?
      - How can I check the setup of one specific webhook by its ID?
      instructions:
      - text: Get webhook {id} for merchant {X-Merchant-Code}.
        slots:
          id: path.id
          X-Merchant-Code: header.X-Merchant-Code
      - text: Show the configuration of webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/webhooks/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a webhook's URL or header
      effect: write
      questions:
      - How do I point an existing webhook at a new server URL?
      - Can I change the auth header on a webhook I already registered?
      instructions:
      - text: Update webhook {id} for merchant {X-Merchant-Code} to send to {url}.
        slots:
          id: path.id
          X-Merchant-Code: header.X-Merchant-Code
          url: requestBody.url
      - text: Change the header on existing webhook {id} to {header}, keeping URL {url}.
        slots:
          id: path.id
          header: requestBody.header
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/webhooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a webhook
      effect: destructive
      questions:
      - How do I stop notifications going to an old endpoint?
      - What's the way to delete a webhook I no longer use?
      instructions:
      - text: Delete webhook {id} for merchant {X-Merchant-Code}.
        slots:
          id: path.id
          X-Merchant-Code: header.X-Merchant-Code
      - text: Unregister webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'