ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Webhook Operations API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/operations/webhooks/{id}'].get
$.paths['/operations/webhooks/{id}'].put
$.paths['/operations/webhooks/{id}'].delete
$.paths['/operations/webhooks'].get
$.paths['/operations/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 ThousandEyes Webhook Operations API
  version: 1.0.0
extends: openapi/thousandeyes-webhook-operations-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['/operations/webhooks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook operation
      effect: read
      questions:
      - What payload and headers does a webhook operation send?
      - Can I look up one webhook operation by ID?
      instructions:
      - text: Show webhook operation {id}.
        slots:
          id: path.id
      - text: Get the details of webhook operation {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/operations/webhooks/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a webhook operation
      effect: write
      questions:
      - How do I change the payload template of a webhook operation?
      - Can I disable a webhook operation without deleting it?
      instructions:
      - text: Update webhook operation {id} with payload {payload}.
        slots:
          id: path.id
          payload: requestBody.payload
      - text: Rename webhook operation {id} to {name} in category {category} with status {status}.
        slots:
          id: path.id
          name: requestBody.name
          category: requestBody.category
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/operations/webhooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook operation
      effect: destructive
      questions:
      - Is there a way to delete a webhook operation?
      - Can I remove a webhook I set up for alert notifications?
      instructions:
      - text: Delete webhook operation {id}.
        slots:
          id: path.id
      - text: Remove webhook operation {id} from account group {aid}.
        slots:
          id: path.id
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/operations/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhook operations
      effect: read
      questions:
      - What webhook operations are configured in my account group?
      - Which webhooks does ThousandEyes have set up for my account?
      instructions:
      - text: List all webhook operations.
      - text: Show the webhook operations in account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/operations/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook operation
      effect: write
      questions:
      - How do I send alert notifications to my own webhook?
      - What category and status are required when creating a webhook operation?
      instructions:
      - text: Create a webhook operation named {name} in category {category} with status {status}.
        slots:
          name: requestBody.name
          category: requestBody.category
          status: requestBody.status
      - text: Create an enabled webhook operation {name} posting payload {payload}.
        slots:
          name: requestBody.name
          payload: requestBody.payload
      method: generated
      generated: '2026-09-26'