# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ThriveCart Event subscriptions API
  version: 1.0.0
extends: openapi/thrivecart-event-subscriptions-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: 2
- target: $.paths['/subscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe an endpoint to webhook events
      effect: write
      questions:
      - How do I get webhook notifications sent to my endpoint?
      - Does my target URL need to be registered with my app before subscribing?
      - Can I choose which fields trigger an event notification?
      instructions:
      - text: Subscribe {target_url} to the {event} event.
        slots:
          target_url: requestBody.target_url
          event: requestBody.event
      - text: Send {event} webhooks to {target_url} filtered by trigger fields {trigger_fields}.
        slots:
          event: requestBody.event
          target_url: requestBody.target_url
          trigger_fields: requestBody.trigger_fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/unsubscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe an endpoint from webhooks
      effect: destructive
      questions:
      - How do I stop webhook notifications going to an endpoint?
      - Can I remove a webhook subscription by its URL?
      instructions:
      - text: Unsubscribe {url} from event notifications.
        slots:
          url: requestBody.url
      - text: Stop sending webhooks to {url}.
        slots:
          url: requestBody.url
      method: generated
      generated: '2026-10-01'