Svix · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Svix Webhooks AutoConfig API

5 actions 5 updates phrasing extends openapi/svix-webhooks-autoconfig-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Svix's API. It is a proposal applied on top of the contract, not a document Svix publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/api/v1/app/{app_id}/auto-config'].post

$.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/auto-config'].get

$.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/auto-config'].put

$.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/auto-config/rotate'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Svix Webhooks AutoConfig API
  version: 1.0.0
extends: openapi/svix-webhooks-autoconfig-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: 4
- target: $.paths['/api/v1/app/{app_id}/auto-config'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an endpoint auto-config flow
      effect: write
      questions:
      - How do I let a customer finish configuring their own webhook endpoint later?
      - Can I create a placeholder endpoint that waits for its details?
      instructions:
      - text: Start an auto-config flow on application {app_id}.
        slots:
          app_id: path.app_id
      - text: Create an endpoint awaiting configuration for app {app_id}.
        slots:
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/auto-config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an endpoint's auto-config token
      effect: read
      questions:
      - Can I see the auto-config token issued for an endpoint?
      - Is an endpoint's auto-config token shown in full or masked?
      instructions:
      - text: Show the censored auto-config token for endpoint {endpoint_id} in app {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: Get the auto-config subscription of endpoint {endpoint_id} on app {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/auto-config'].put
  update:
    x-apievangelist-phrasing:
      intent: Complete an auto-config endpoint's details
      effect: write
      questions:
      - How do I fill in the destination for an endpoint created through auto-config?
      - Can an auto-config endpoint be pointed at a sink instead of a URL?
      instructions:
      - text: Configure auto-config endpoint {endpoint_id} in app {app_id} with endpoint details {endpoint}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          endpoint: requestBody.endpoint
      - text: Point auto-config endpoint {endpoint_id} of app {app_id} at sink {sink}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          sink: requestBody.sink
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/auto-config/rotate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate an auto-config endpoint's auth token
      effect: write
      questions:
      - How do I issue a new auth token for an auto-config endpoint?
      - Can I set a signing secret while rotating an auto-config token?
      instructions:
      - text: Rotate the auto-config auth token for endpoint {endpoint_id} in app {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: Rotate auto-config for endpoint {endpoint_id} on app {app_id} using signing secret {signingSecret}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          signingSecret: requestBody.signingSecret
      method: generated
      generated: '2026-09-26'