# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for act.web.api Webhooks API
  version: 1.0.0
extends: openapi/act-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: 9
- target: $.paths['/api/webhooks/{id}/continue'].put
  update:
    x-apievangelist-phrasing:
      intent: Resume a suspended webhook
      effect: write
      questions:
      - Can I restart a webhook that was suspended?
      - My webhook stopped firing; how do I turn it back on?
      instructions:
      - text: Resume webhook {id}.
        slots:
          id: path.id
      - text: Continue the suspended webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/webhooks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook
      effect: read
      questions:
      - What is a particular webhook monitoring and where does it call back?
      - Can I check one webhook's configuration by id?
      instructions:
      - text: Get webhook {id}.
        slots:
          id: path.id
      - text: Show the settings of webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/webhooks/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a webhook's configuration
      effect: write
      questions:
      - How do I fully redefine an existing webhook's monitor and callback?
      - Can I swap the entity and trigger event a webhook watches?
      instructions:
      - text: Replace webhook {id} to monitor {monitor} on {triggerEvent} and call {callbackUrl}.
        slots:
          id: path.id
          monitor: requestBody.monitor
          triggerEvent: requestBody.triggerEvent
          callbackUrl: requestBody.callbackUrl
      - text: Do a full update of webhook {id} with description {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/webhooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - Can I permanently remove a webhook registration?
      - What's the difference between deleting and suspending a webhook?
      instructions:
      - text: Delete webhook {id}.
        slots:
          id: path.id
      - text: Remove webhook registration {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/webhooks/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change selected settings on a webhook
      effect: write
      questions:
      - Can I change only a webhook's callback URL?
      - Is there a partial update for webhooks?
      instructions:
      - text: Change just the callback URL of webhook {id} to {callbackUrl}.
        slots:
          id: path.id
          callbackUrl: requestBody.callbackUrl
      - text: Patch webhook {id} with a new callback token {callbackToken}.
        slots:
          id: path.id
          callbackToken: requestBody.callbackToken
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhooks
      effect: read
      questions:
      - Which webhooks are registered in my Act! database?
      - Can I filter my webhooks with an OData query?
      instructions:
      - text: List all my webhooks.
      - text: Show every registered webhook.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook
      effect: write
      questions:
      - How do I get notified when a contact is created or updated?
      - Can a webhook send events to my own callback URL?
      instructions:
      - text: Create a webhook on {monitor} for {triggerEvent} that calls {callbackUrl}.
        slots:
          monitor: requestBody.monitor
          triggerEvent: requestBody.triggerEvent
          callbackUrl: requestBody.callbackUrl
      - text: Register a webhook named {monitorName} posting to {callbackUrl}.
        slots:
          monitorName: requestBody.monitorName
          callbackUrl: requestBody.callbackUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/webhooks/reset-token'].put
  update:
    x-apievangelist-phrasing:
      intent: Reset the token on my webhooks
      effect: write
      questions:
      - Can I rotate the token used by all my webhook registrations?
      - My webhook token may have leaked; what refreshes it?
      instructions:
      - text: Reset the token on my webhook registrations.
      - text: Issue a new token for all of my webhooks.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/webhooks/{id}/suspend'].put
  update:
    x-apievangelist-phrasing:
      intent: Suspend a webhook
      effect: write
      questions:
      - Can I pause a webhook without deleting it?
      - What stops a webhook from firing temporarily?
      instructions:
      - text: Suspend webhook {id}.
        slots:
          id: path.id
      - text: Pause webhook {id} until I resume it.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'