Svix · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Svix Broadcast API

2 actions 2 updates phrasing extends openapi/svix-broadcast-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 2

$.info
$.paths['/api/v1/msg/broadcast'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Svix Broadcast API
  version: 1.0.0
extends: openapi/svix-broadcast-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: 1
- target: $.paths['/api/v1/msg/broadcast'].post
  update:
    x-apievangelist-phrasing:
      intent: Broadcast a message to every application
      effect: write
      questions:
      - How do I send the same webhook event to all of my customers at once?
      - Can a broadcast message be limited to certain channels?
      - How long is a broadcast payload kept, and can I change it?
      instructions:
      - text: Broadcast a {eventType} event with payload {payload} to every application.
        slots:
          eventType: requestBody.eventType
          payload: requestBody.payload
      - text: Send {eventType} with payload {payload} to all apps on channels {channels}.
        slots:
          eventType: requestBody.eventType
          payload: requestBody.payload
          channels: requestBody.channels
      - text: Broadcast event {eventType} carrying {payload} to all customers, keeping the payload for {payloadRetentionHours} hours.
        slots:
          eventType: requestBody.eventType
          payload: requestBody.payload
          payloadRetentionHours: requestBody.payloadRetentionHours
      method: generated
      generated: '2026-09-26'