# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Dolby Webhooks API
  version: 1.0.0
extends: openapi/dolby-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: 13
- target: $.paths['/api/webhooks/{webhookId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a streaming webhook's details
      effect: read
      questions:
      - What URL and event types is one of my streaming webhooks set to?
      - Can I look up a streaming account webhook by its webhook ID?
      instructions:
      - text: Read streaming webhook {webhook_id}.
        slots:
          webhook_id: path.webhookId
      - text: Show the URL and settings of webhook {webhook_id} on my streaming account.
        slots:
          webhook_id: path.webhookId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/webhooks/{webhookId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a streaming webhook or rotate its secret
      effect: write
      questions:
      - How do I refresh the signing secret on a streaming webhook?
      - Can I turn on recording or transcoder events for an existing streaming webhook?
      - Is there a way to re-enable a streaming webhook that got disabled?
      instructions:
      - text: Point streaming webhook {webhook_id} at {url}.
        slots:
          webhook_id: path.webhookId
          url: requestBody.url
      - text: 'Rotate the signing secret on streaming webhook {webhook_id}: set refreshSecret to {refresh_secret}.'
        slots:
          webhook_id: path.webhookId
          refresh_secret: requestBody.refreshSecret
      - text: Re-enable streaming webhook {webhook_id} with reEnable {re_enable}.
        slots:
          webhook_id: path.webhookId
          re_enable: requestBody.reEnable
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/webhooks/{webhookId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a streaming webhook
      effect: destructive
      questions:
      - How do I delete a streaming account webhook by its webhook ID?
      - Does removing a streaming webhook erase all its data?
      instructions:
      - text: Remove streaming webhook {webhook_id}.
        slots:
          webhook_id: path.webhookId
      - text: Delete all data for streaming webhook {webhook_id}.
        slots:
          webhook_id: path.webhookId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/webhooks/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List streaming account webhooks
      effect: read
      questions:
      - Which webhooks are registered on my streaming account?
      - Can I page through streaming webhooks starting after a given ID?
      instructions:
      - text: List the webhooks on my streaming account.
      - text: List {item_count} streaming webhooks starting from ID {starting_id}.
        slots:
          item_count: query.itemCount
          starting_id: query.startingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a streaming account webhook
      effect: write
      questions:
      - How do I get notified when a feed starts or stops on my streaming account?
      - Which event types can a streaming webhook subscribe to, like recordings or thumbnails?
      instructions:
      - text: Add a streaming webhook at {url} with feed hooks {is_feed_hooks}.
        slots:
          url: requestBody.url
          is_feed_hooks: requestBody.isFeedHooks
      - text: Register {url} for feed hooks {is_feed_hooks} and recording hooks {is_recording_hooks}.
        slots:
          url: requestBody.url
          is_feed_hooks: requestBody.isFeedHooks
          is_recording_hooks: requestBody.isRecordingHooks
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/webhooks/test/{webhookType}'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test webhook event
      effect: write
      questions:
      - Can I fire a sample event to check my webhook endpoint works?
      - What webhook types can I send a test event for?
      instructions:
      - text: Send a test {webhook_type} webhook event.
        slots:
          webhook_type: path.webhookType
      - text: Fire a test {webhook_type} event for stream {stream_name}.
        slots:
          webhook_type: path.webhookType
          stream_name: requestBody.streamName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List live channel platform webhooks
      effect: read
      questions:
      - What webhooks exist on the channel management platform?
      - Can I see every channel platform webhook in one list?
      instructions:
      - text: Get all channel platform webhooks.
      - text: Show every webhook configured for my channels and engines.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a channel platform webhook
      effect: write
      questions:
      - How do I create a named webhook for channel events?
      - Can I create a channel platform webhook that starts out inactive?
      instructions:
      - text: Create webhook {name} posting events {events} to {url}.
        slots:
          name: requestBody.name
          events: requestBody.events
          url: requestBody.url
      - text: Set up webhook {name} at {url} for {events}, active {active}.
        slots:
          name: requestBody.name
          url: requestBody.url
          events: requestBody.events
          active: requestBody.active
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhooks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a channel platform webhook
      effect: read
      questions:
      - What events and URL does a specific channel platform webhook have?
      - Is a given channel webhook active?
      instructions:
      - text: Get channel platform webhook {id}.
        slots:
          id: path.id
      - text: Show configuration for channel webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a channel platform webhook
      effect: destructive
      questions:
      - How do I delete a channel platform webhook by ID?
      - Can I stop a channel webhook permanently instead of just deactivating it?
      instructions:
      - text: Delete channel platform webhook {id}.
        slots:
          id: path.id
      - text: Permanently remove channel webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhooks/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a channel platform webhook
      effect: write
      questions:
      - Can I change which events a channel webhook listens for?
      - How do I deactivate a channel platform webhook without deleting it?
      instructions:
      - text: Change channel webhook {id} to send events {events}.
        slots:
          id: path.id
          events: requestBody.events
      - text: Set channel webhook {id} active to {active}.
        slots:
          id: path.id
          active: requestBody.active
      - text: Move channel webhook {id} to URL {url}.
        slots:
          id: path.id
          url: requestBody.url
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhooks/{id}/secret'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a channel webhook's signing secret
      effect: read
      questions:
      - Where do I find the secret to verify channel webhook payloads?
      - Can I retrieve the signing secret for a channel platform webhook?
      instructions:
      - text: Get the secret for channel webhook {id}.
        slots:
          id: path.id
      - text: Show the signing secret of channel platform webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhooks/{id}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get delivery logs for a channel webhook
      effect: read
      questions:
      - Did my channel webhook deliveries succeed recently?
      - Can I filter channel webhook logs to a date range?
      instructions:
      - text: Get delivery logs for channel webhook {id}.
        slots:
          id: path.id
      - text: Show logs for channel webhook {id} between {start_date} and {end_date}, up to {limit} entries.
        slots:
          id: path.id
          start_date: query.startDate
          end_date: query.endDate
          limit: query.limit
      method: generated
      generated: '2026-10-01'