# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for api.peopledatalabs.com Subscription API
  version: 1.0.0
extends: openapi/peopledatalabs-subscription-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['/v5/subscription/{subscription_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook subscription
      effect: read
      questions:
      - How do I check the details and status of one of my subscriptions?
      - Which target URL is a given subscription sending events to?
      instructions:
      - text: Show subscription {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      - text: Get the event type and target URL for subscription {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v5/subscription/{subscription_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a webhook subscription
      effect: write
      questions:
      - Can I change where an existing subscription delivers its events?
      - Is it possible to pause a subscription by changing its status?
      instructions:
      - text: Update subscription {subscription_id} to send {event_type} events to {target_url}.
        slots:
          subscription_id: path.subscription_id
          event_type: requestBody.event_type
          target_url: requestBody.target_url
      - text: Set the status of subscription {subscription_id} to {status}, keeping {event_type} at {target_url}.
        slots:
          subscription_id: path.subscription_id
          status: requestBody.status
          event_type: requestBody.event_type
          target_url: requestBody.target_url
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v5/subscription/{subscription_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook subscription
      effect: destructive
      questions:
      - How do I stop receiving events by removing a subscription?
      - Can a deleted subscription be recovered?
      instructions:
      - text: Delete subscription {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      - text: Remove subscription {subscription_id} so it stops sending events.
        slots:
          subscription_id: path.subscription_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v5/subscription'].get
  update:
    x-apievangelist-phrasing:
      intent: List my webhook subscriptions
      effect: read
      questions:
      - What subscriptions do I currently have set up?
      - Can I see all my subscriptions and their target URLs at once?
      instructions:
      - text: List all my subscriptions.
      - text: Show every subscription on my account with its event type.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v5/subscription'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook subscription
      effect: write
      questions:
      - How do I subscribe a URL to receive People Data Labs events?
      - Can I add custom headers to the requests a new subscription sends?
      instructions:
      - text: Create a subscription for {event_type} events sent to {target_url}.
        slots:
          event_type: requestBody.event_type
          target_url: requestBody.target_url
      - text: Subscribe {target_url} to {event_type} with headers {headers}.
        slots:
          target_url: requestBody.target_url
          event_type: requestBody.event_type
          headers: requestBody.headers
      method: generated
      generated: '2026-10-01'