# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for qTest Manager API Version 3.0 Webhook API
  version: 1.0.0
extends: openapi/tricentis-webhook-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: 6
- target: $.paths['/api/v3/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List registered webhooks
      effect: read
      questions:
      - Which webhooks are currently registered?
      - Can I see every webhook subscription on the instance?
      instructions:
      - text: List all registered webhooks.
      - text: Show me every webhook subscription we have.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a webhook
      effect: write
      questions:
      - How do I get notified at my own URL when test events happen in qTest?
      - Can a webhook be limited to certain projects and signed with a secret?
      instructions:
      - text: Register a webhook {name} that posts {events} to {url}.
        slots:
          name: requestBody.name
          events: requestBody.events
          url: requestBody.url
      - text: Create a webhook to {url} for projects {projects} with secret key {secret}.
        slots:
          url: requestBody.url
          projects: requestBody.projectIds
          secret: requestBody.secretKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/webhooks/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhook event names
      effect: read
      questions:
      - What events can a webhook subscribe to?
      - Is there a list of available event names for webhooks?
      instructions:
      - text: List the event names available for webhooks.
      - text: Show which events I can subscribe a webhook to.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/webhooks/{webhookId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook
      effect: read
      questions:
      - How can I check the URL and events of one webhook?
      - What projects is a particular webhook scoped to?
      instructions:
      - text: Get webhook {webhook}.
        slots:
          webhook: path.webhookId
      - text: Show the configuration of webhook {webhook}.
        slots:
          webhook: path.webhookId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/webhooks/{webhookId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a webhook
      effect: write
      questions:
      - Can I change the target URL of an existing webhook?
      - How do I add more events to a webhook I already registered?
      instructions:
      - text: Point webhook {webhook} at {url}.
        slots:
          webhook: path.webhookId
          url: requestBody.url
      - text: Change the events of webhook {webhook} to {events}.
        slots:
          webhook: path.webhookId
          events: requestBody.events
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/webhooks/{webhookId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - Can I unregister a webhook so it stops sending events?
      - What's the way to remove a webhook I no longer need?
      instructions:
      - text: Delete webhook {webhook}.
        slots:
          webhook: path.webhookId
      - text: Unregister webhook {webhook} permanently.
        slots:
          webhook: path.webhookId
      method: generated
      generated: '2026-10-01'