# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Svix Ingest Endpoint API
  version: 1.0.0
extends: openapi/svix-ingest-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: 11
- target: $.paths['/ingest/api/v1/source/{source_id}/endpoint'].get
  update:
    x-apievangelist-phrasing:
      intent: List an ingest source's endpoints
      effect: read
      questions:
      - Which endpoints are forwarding webhooks from my ingest source?
      - Can I page through the destinations of one Svix Ingest source?
      instructions:
      - text: List the ingest endpoints on source {source_id}.
        slots:
          source_id: path.source_id
      - text: Show the first {limit} endpoints for ingest source {source_id}.
        slots:
          limit: query.limit
          source_id: path.source_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ingest/api/v1/source/{source_id}/endpoint'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an endpoint to an ingest source
      effect: write
      questions:
      - How do I forward incoming webhooks from an ingest source to my own URL?
      - Can I rate-limit deliveries to a new ingest endpoint?
      instructions:
      - text: Create an ingest endpoint at {url} on source {source_id}.
        slots:
          url: requestBody.url
          source_id: path.source_id
      - text: Add ingest endpoint {url} to source {source_id} with a rate limit of {rateLimit} per second.
        slots:
          url: requestBody.url
          source_id: path.source_id
          rateLimit: requestBody.rateLimit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an ingest endpoint
      effect: read
      questions:
      - What URL and settings does a particular ingest endpoint have?
      - Is a given ingest endpoint currently disabled?
      instructions:
      - text: Get ingest endpoint {endpoint_id} on source {source_id}.
        slots:
          endpoint_id: path.endpoint_id
          source_id: path.source_id
      - text: Show the configuration of source {source_id}'s ingest endpoint {endpoint_id}.
        slots:
          source_id: path.source_id
          endpoint_id: path.endpoint_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace an ingest endpoint
      effect: write
      questions:
      - How do I change the destination URL of an existing ingest endpoint?
      - Can I disable an ingest endpoint without deleting it?
      instructions:
      - text: Point ingest endpoint {endpoint_id} on source {source_id} at {url}.
        slots:
          endpoint_id: path.endpoint_id
          source_id: path.source_id
          url: requestBody.url
      - text: Upsert ingest endpoint {endpoint_id} in {source_id} with URL {url} and disabled set to {disabled}.
        slots:
          endpoint_id: path.endpoint_id
          source_id: path.source_id
          url: requestBody.url
          disabled: requestBody.disabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an ingest endpoint
      effect: destructive
      questions:
      - How do I stop an ingest source from forwarding to one of its endpoints?
      - Can I remove an ingest endpoint for good?
      instructions:
      - text: Delete ingest endpoint {endpoint_id} from source {source_id}.
        slots:
          endpoint_id: path.endpoint_id
          source_id: path.source_id
      - text: Remove source {source_id}'s ingest endpoint {endpoint_id}.
        slots:
          source_id: path.source_id
          endpoint_id: path.endpoint_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}/secret'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an ingest endpoint's signing secret
      effect: read
      questions:
      - Where's the secret I need to verify webhooks forwarded by an ingest endpoint?
      - Can I read the signing key for an ingest endpoint?
      instructions:
      - text: Get the signing secret for ingest endpoint {endpoint_id} on source {source_id}.
        slots:
          endpoint_id: path.endpoint_id
          source_id: path.source_id
      - text: Show source {source_id} ingest endpoint {endpoint_id}'s verification secret.
        slots:
          source_id: path.source_id
          endpoint_id: path.endpoint_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}/secret/rotate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate an ingest endpoint's signing secret
      effect: write
      questions:
      - How do I rotate the signing secret on an ingest endpoint?
      - Does the old ingest endpoint secret keep working after I rotate it?
      instructions:
      - text: Rotate the secret for ingest endpoint {endpoint_id} on source {source_id}.
        slots:
          endpoint_id: path.endpoint_id
          source_id: path.source_id
      - text: Rotate source {source_id} ingest endpoint {endpoint_id}'s secret to {key}.
        slots:
          source_id: path.source_id
          endpoint_id: path.endpoint_id
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}/headers'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an ingest endpoint's extra headers
      effect: read
      questions:
      - What additional headers are sent when an ingest endpoint forwards a webhook?
      - Can I check the custom headers on an ingest endpoint?
      instructions:
      - text: Get the headers for ingest endpoint {endpoint_id} on source {source_id}.
        slots:
          endpoint_id: path.endpoint_id
          source_id: path.source_id
      - text: Show the extra headers source {source_id}'s ingest endpoint {endpoint_id} sends.
        slots:
          source_id: path.source_id
          endpoint_id: path.endpoint_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}/headers'].put
  update:
    x-apievangelist-phrasing:
      intent: Set an ingest endpoint's extra headers
      effect: write
      questions:
      - How do I add an authorization header to what an ingest endpoint forwards?
      - Can I replace all custom headers on an ingest endpoint at once?
      instructions:
      - text: Set headers {headers} on ingest endpoint {endpoint_id} in source {source_id}.
        slots:
          headers: requestBody.headers
          endpoint_id: path.endpoint_id
          source_id: path.source_id
      - text: Replace source {source_id} ingest endpoint {endpoint_id}'s headers with {headers}.
        slots:
          source_id: path.source_id
          endpoint_id: path.endpoint_id
          headers: requestBody.headers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}/transformation'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an ingest endpoint's transformation
      effect: read
      questions:
      - What transformation code runs on webhooks before an ingest endpoint forwards them?
      - Is the transformation on my ingest endpoint enabled?
      instructions:
      - text: Get the transformation for ingest endpoint {endpoint_id} on source {source_id}.
        slots:
          endpoint_id: path.endpoint_id
          source_id: path.source_id
      - text: Show source {source_id} ingest endpoint {endpoint_id}'s transformation code.
        slots:
          source_id: path.source_id
          endpoint_id: path.endpoint_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}/transformation'].patch
  update:
    x-apievangelist-phrasing:
      intent: Set or toggle an ingest endpoint's transformation
      effect: write
      questions:
      - How do I reshape incoming webhooks with code on an ingest endpoint?
      - Can I turn off an ingest endpoint's transformation but keep the code?
      instructions:
      - text: Set the transformation on ingest endpoint {endpoint_id} in source {source_id} to {code}.
        slots:
          endpoint_id: path.endpoint_id
          source_id: path.source_id
          code: requestBody.code
      - text: Set enabled to {enabled} for source {source_id} ingest endpoint {endpoint_id}'s transformation.
        slots:
          enabled: requestBody.enabled
          source_id: path.source_id
          endpoint_id: path.endpoint_id
      method: generated
      generated: '2026-09-26'