# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for GoToWebinar Webhooks Management User Subscriptions API
  version: 1.0.0
extends: openapi/gotowebinar-user-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: 5
- target: $.paths['/userSubscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List my webhook user subscriptions
      effect: read
      questions:
      - Which webhook subscriptions do I currently have set up on GoTo Webinar?
      - Can I see every user subscription and the callback each one points to?
      instructions:
      - text: List all my webhook user subscriptions.
      - text: Show every user subscription I have and its callback URL.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/userSubscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a callback URL to a webhook
      effect: write
      questions:
      - How do I start receiving webhook events at my own endpoint?
      - Can I create a user subscription that starts out inactive?
      instructions:
      - text: Subscribe {callbackUrl} to webhook {webhookKey}.
        slots:
          callbackUrl: requestBody.callbackUrl
          webhookKey: requestBody.webhookKey
      - text: Create a user subscription for webhook {webhookKey} sending to {callbackUrl} with state {userSubscriptionState}.
        slots:
          webhookKey: requestBody.webhookKey
          callbackUrl: requestBody.callbackUrl
          userSubscriptionState: requestBody.userSubscriptionState
      method: generated
      generated: '2026-10-01'
- target: $.paths['/userSubscriptions/{subscriptionKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one webhook user subscription
      effect: read
      questions:
      - What callback URL and state does a particular user subscription have?
      - Can I look up a single user subscription by its key?
      instructions:
      - text: Get user subscription {subscriptionKey}.
        slots:
          subscriptionKey: path.subscriptionKey
      - text: Show the callback and status of subscription {subscriptionKey}.
        slots:
          subscriptionKey: path.subscriptionKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/userSubscriptions/{subscriptionKey}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a user subscription's callback or state
      effect: write
      questions:
      - How do I point an existing webhook subscription at a new callback URL?
      - Can I pause a user subscription without deleting it?
      instructions:
      - text: Change subscription {subscriptionKey} to deliver to {callbackUrl}.
        slots:
          subscriptionKey: path.subscriptionKey
          callbackUrl: requestBody.callbackUrl
      - text: Set user subscription {subscriptionKey} to state {userSubscriptionState}.
        slots:
          subscriptionKey: path.subscriptionKey
          userSubscriptionState: requestBody.userSubscriptionState
      method: generated
      generated: '2026-10-01'
- target: $.paths['/userSubscriptions/{subscriptionKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook user subscription
      effect: destructive
      questions:
      - How do I stop receiving webhook events for one subscription for good?
      - What's the way to remove a user subscription I no longer need?
      instructions:
      - text: Delete user subscription {subscriptionKey}.
        slots:
          subscriptionKey: path.subscriptionKey
      - text: Unsubscribe and remove subscription {subscriptionKey} permanently.
        slots:
          subscriptionKey: path.subscriptionKey
      method: generated
      generated: '2026-10-01'