# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for VirtoCommerce. Webhooks API
  version: 1.0.0
extends: openapi/virto-commerce-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: 9
- target: $.paths['/api/webhooks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook by its ID
      effect: read
      questions:
      - What URL and events is a specific webhook configured with?
      - Can I look up one webhook's settings and success and error counts?
      instructions:
      - text: Show the configuration of webhook {id}.
        slots:
          id: path.id
      - text: Get webhook {id} with its subscribed events.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/webhooks/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search webhooks
      effect: read
      questions:
      - Which webhooks are currently active in my Virto Commerce platform?
      - How do I find the webhooks subscribed to a given event?
      - Can I list inactive webhooks only?
      instructions:
      - text: List all active webhooks.
      - text: Find webhooks subscribed to events {eventIds}.
        slots:
          eventIds: requestBody.eventIds
      - text: Search webhooks named like {keyword}.
        slots:
          keyword: requestBody.keyword
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/webhooks/feed/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search webhook delivery logs
      effect: read
      questions:
      - Why did a webhook delivery fail, and where are the logs?
      - Can I filter webhook delivery records by status?
      - What deliveries has a particular webhook sent recently?
      instructions:
      - text: Show the delivery log for webhook {webHookIds}.
        slots:
          webHookIds: requestBody.webHookIds
      - text: Find webhook log records with status {statuses}.
        slots:
          statuses: requestBody.statuses
      - text: List webhook deliveries triggered by event {eventIds}.
        slots:
          eventIds: requestBody.eventIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/webhooks/feed'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete webhook log entries
      effect: destructive
      questions:
      - How do I clear old webhook delivery log entries?
      - Can I delete specific webhook feed records by ID?
      instructions:
      - text: Delete webhook log entries {ids}.
        slots:
          ids: query.ids
      - text: Purge the webhook feed records with IDs {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update webhooks
      effect: write
      questions:
      - How do I register a new webhook for platform events?
      - Can I update several webhook definitions in one request?
      instructions:
      - text: Create a webhook that posts order events to my endpoint.
      - text: Save these webhook definitions, updating any that already exist.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/webhooks'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete webhooks
      effect: destructive
      questions:
      - How do I remove a webhook subscription entirely?
      - Can I delete multiple webhooks in one call?
      instructions:
      - text: Delete webhooks {ids}.
        slots:
          ids: query.ids
      - text: Unregister the webhook with ID {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/webhooks/send'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test request to a webhook
      effect: write
      questions:
      - Can I fire a webhook manually to test my receiving endpoint?
      - How do I check that a webhook URL with bearer auth responds correctly?
      instructions:
      - text: Send a test call to webhook URL {url} and show the result.
        slots:
          url: requestBody.url
      - text: Test-fire webhook {name} at {url} using bearer token {bearerToken}.
        slots:
          name: requestBody.name
          url: requestBody.url
          bearerToken: requestBody.bearerToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/webhooks/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List events that can trigger webhooks
      effect: read
      questions:
      - What events can I subscribe a webhook to?
      - Which platform events are registered for webhook notifications?
      instructions:
      - text: List every event available for webhook subscriptions.
      - text: Show me the registered webhook trigger events.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/webhooks/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List properties of a webhook event object
      effect: read
      questions:
      - Which fields can I include in a webhook payload for an object type?
      - What properties does an event object expose to webhooks?
      instructions:
      - text: Show the payload properties available for object type {objectType}.
        slots:
          objectType: query.objectType
      - text: List webhook event fields for {objectType}.
        slots:
          objectType: query.objectType
      method: generated
      generated: '2026-09-26'