# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Svix Webhook Endpoint API
  version: 1.0.0
extends: openapi/svix-webhook-endpoint-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/v1/operational-webhook/endpoint'].get
  update:
    x-apievangelist-phrasing:
      intent: List operational webhook endpoints
      effect: read
      questions:
      - Which URLs receive my Svix operational webhooks about my account?
      - Can I page through operational webhook endpoints?
      instructions:
      - text: List my operational webhook endpoints.
      - text: Show the first {limit} operational webhook endpoints.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/operational-webhook/endpoint'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an operational webhook endpoint
      effect: write
      questions:
      - How do I get notified when something happens in my account, like an endpoint being disabled?
      - Can an operational webhook endpoint subscribe to only some event types?
      instructions:
      - text: Create an operational webhook endpoint at {url}.
        slots:
          url: requestBody.url
      - text: Add operational webhook endpoint {url} that only receives {filterTypes}.
        slots:
          url: requestBody.url
          filterTypes: requestBody.filterTypes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/operational-webhook/endpoint/{endpoint_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an operational webhook endpoint
      effect: read
      questions:
      - What are the settings of one operational webhook endpoint?
      - Which event types is a specific operational webhook endpoint filtered to?
      instructions:
      - text: Get operational webhook endpoint {endpoint_id}.
        slots:
          endpoint_id: path.endpoint_id
      - text: Show the URL and filters for operational endpoint {endpoint_id}.
        slots:
          endpoint_id: path.endpoint_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/operational-webhook/endpoint/{endpoint_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace an operational webhook endpoint
      effect: write
      questions:
      - How do I change the URL of an operational webhook endpoint?
      - Can I disable an operational webhook endpoint temporarily?
      instructions:
      - text: Point operational webhook endpoint {endpoint_id} at {url}.
        slots:
          endpoint_id: path.endpoint_id
          url: requestBody.url
      - text: Upsert operational endpoint {endpoint_id} with URL {url} and disabled {disabled}.
        slots:
          endpoint_id: path.endpoint_id
          url: requestBody.url
          disabled: requestBody.disabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/operational-webhook/endpoint/{endpoint_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an operational webhook endpoint
      effect: destructive
      questions:
      - How do I stop receiving operational webhooks at a URL?
      - Can I delete an operational webhook endpoint I no longer use?
      instructions:
      - text: Delete operational webhook endpoint {endpoint_id}.
        slots:
          endpoint_id: path.endpoint_id
      - text: Remove the operational endpoint {endpoint_id} permanently.
        slots:
          endpoint_id: path.endpoint_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/operational-webhook/endpoint/{endpoint_id}/secret'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an operational webhook endpoint's secret
      effect: read
      questions:
      - Where is the secret to verify operational webhooks from Svix?
      - Can I read the signing key of an operational webhook endpoint?
      instructions:
      - text: Get the signing secret for operational webhook endpoint {endpoint_id}.
        slots:
          endpoint_id: path.endpoint_id
      - text: Show operational endpoint {endpoint_id}'s verification secret.
        slots:
          endpoint_id: path.endpoint_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/operational-webhook/endpoint/{endpoint_id}/secret/rotate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate an operational webhook endpoint's secret
      effect: write
      questions:
      - How do I rotate the signing secret for my operational webhooks?
      - How long does the previous operational webhook secret stay valid after rotation?
      instructions:
      - text: Rotate the secret on operational webhook endpoint {endpoint_id}.
        slots:
          endpoint_id: path.endpoint_id
      - text: Rotate operational endpoint {endpoint_id}'s signing secret to {key}.
        slots:
          endpoint_id: path.endpoint_id
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/operational-webhook/endpoint/{endpoint_id}/headers'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an operational webhook endpoint's headers
      effect: read
      questions:
      - What extra headers are sent with my operational webhooks?
      - Can I check custom headers on an operational webhook endpoint?
      instructions:
      - text: Get the headers for operational webhook endpoint {endpoint_id}.
        slots:
          endpoint_id: path.endpoint_id
      - text: Show the additional headers operational endpoint {endpoint_id} sends.
        slots:
          endpoint_id: path.endpoint_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/operational-webhook/endpoint/{endpoint_id}/headers'].put
  update:
    x-apievangelist-phrasing:
      intent: Set an operational webhook endpoint's headers
      effect: write
      questions:
      - How do I add a custom header to operational webhook deliveries?
      - Can I replace all headers on an operational webhook endpoint?
      instructions:
      - text: Set headers {headers} on operational webhook endpoint {endpoint_id}.
        slots:
          headers: requestBody.headers
          endpoint_id: path.endpoint_id
      - text: Replace operational endpoint {endpoint_id}'s additional headers with {headers}.
        slots:
          endpoint_id: path.endpoint_id
          headers: requestBody.headers
      method: generated
      generated: '2026-09-26'