# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ZoomInfo Monitoring API/Webhooks API
  version: 1.0.0
extends: openapi/zoominfo-monitoring-api-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: 7
- target: $.paths['/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List my webhooks
      effect: read
      questions:
      - Which webhooks have I set up for monitoring?
      - Can I see all my webhooks and whether they're enabled?
      instructions:
      - text: List my webhooks.
      - text: Show every monitoring webhook on my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a monitoring webhook
      effect: write
      questions:
      - How do I get notified when records I follow change?
      - Can I create a webhook switched off so I can test it first?
      instructions:
      - text: Create a webhook {title} posting to {targetUrl} for {subscriptions}.
        slots:
          title: requestBody.title
          targetUrl: requestBody.targetUrl
          subscriptions: requestBody.subscriptions
      - text: Create a disabled webhook to {targetUrl} with enabled set to {enabled}.
        slots:
          targetUrl: requestBody.targetUrl
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/967763288'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing webhook
      effect: write
      questions:
      - How do I enable a webhook after testing it?
      - Can I change the subscriptions on an existing webhook?
      instructions:
      - text: Update the webhook title to {title} and set enabled to {enabled}.
        slots:
          title: requestBody.title
          enabled: requestBody.enabled
      - text: Replace the webhook's subscriptions with {subscriptions}.
        slots:
          subscriptions: requestBody.subscriptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/570575403'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - Can I delete a webhook I no longer need?
      - What happens to notifications after I remove a webhook?
      instructions:
      - text: Delete the webhook.
      - text: Remove the monitoring webhook permanently.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a webhook target URL
      effect: write
      questions:
      - Is my webhook endpoint reachable before I turn the webhook on?
      - Can I send a sample payload to my URL to check it works?
      instructions:
      - text: Validate target URL {targetUrl} for {objectType} payloads.
        slots:
          targetUrl: requestBody.targetUrl
          objectType: requestBody.objectType
      - text: Ping {targetUrl} with a full sample payload set to {fullPayload}.
        slots:
          targetUrl: requestBody.targetUrl
          fullPayload: requestBody.fullPayload
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/849814821/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate a webhook's verification token
      effect: destructive
      questions:
      - How do I rotate the verification token on a webhook?
      - Does generating a new token invalidate the old one right away?
      instructions:
      - text: Generate a new verification token for the webhook.
      - text: Rotate the webhook's signing token.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/subscriptiontypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhook subscription types
      effect: read
      questions:
      - Which object and event types can a webhook subscribe to?
      - What events can I be notified about?
      instructions:
      - text: List the webhook subscription types.
      - text: Show the object types and event types I can subscribe to.
      method: generated
      generated: '2026-09-26'