Gumlet · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gumlet Webhooks API

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

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

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

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

$.paths['/org/webhooks/{webhook_id}'].post

$.paths['/org/webhooks/{webhook_id}'].delete

$.paths['/org/webhook/{webhook_id}/history'].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 Gumlet Webhooks API
  version: 1.0.0
extends: openapi/gumlet-webhooks-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/org/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhooks
      effect: read
      questions:
      - Which webhook endpoints have I registered?
      - Can I see every webhook listener on my organization?
      instructions:
      - text: List my webhooks.
      - text: Show all registered webhook listeners.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/org/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a webhook
      effect: write
      questions:
      - How do I get notified when a video finishes processing?
      - Can I limit a webhook to certain workspaces and events?
      instructions:
      - text: Create a webhook to {url} for {triggers} on sources {sources}, signed with {secret_token}.
        slots:
          url: requestBody.url
          triggers: requestBody.triggers
          sources: requestBody.sources
          secret_token: requestBody.secret_token
      - text: Register {url} as a webhook listener for events {triggers} from {sources} using secret {secret_token}.
        slots:
          url: requestBody.url
          triggers: requestBody.triggers
          sources: requestBody.sources
          secret_token: requestBody.secret_token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/org/webhooks/{webhook_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a webhook
      effect: write
      questions:
      - Can I change the URL or events on an existing webhook?
      - Is it possible to rotate a webhook's secret token?
      instructions:
      - text: Point webhook {webhook_id} at {url}.
        slots:
          webhook_id: path.webhook_id
          url: requestBody.url
      - text: Change webhook {webhook_id} to fire on {triggers}.
        slots:
          webhook_id: path.webhook_id
          triggers: requestBody.triggers
      - text: Rotate the secret on webhook {webhook_id} to {secret_token}.
        slots:
          webhook_id: path.webhook_id
          secret_token: requestBody.secret_token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/org/webhooks/{webhook_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - Can I stop a webhook from sending events entirely?
      - What's the way to remove a webhook listener?
      instructions:
      - text: Delete webhook {webhook_id}.
        slots:
          webhook_id: path.webhook_id
      - text: Remove webhook listener {webhook_id}.
        slots:
          webhook_id: path.webhook_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/org/webhook/{webhook_id}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: View a webhook's delivery history
      effect: read
      questions:
      - Did my webhook deliveries succeed or fail recently?
      - Can I see the delivery log for one webhook?
      instructions:
      - text: Show delivery history for webhook {webhook_id}.
        slots:
          webhook_id: path.webhook_id
      - text: Get the logs for webhook {webhook_id}.
        slots:
          webhook_id: path.webhook_id
      method: generated
      generated: '2026-10-01'