Svix Broadcast API
The Broadcast API from Svix — 1 operation(s) for broadcast.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/svix-broadcast-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Svix Broadcast API
description: Welcome to the Svix API documentation!
version: 1.922.0
x-logo:
url: https://www.svix.com/static/img/brand-padded.svg
altText: Svix Logo
servers:
- url: https://api.eu.svix.com
description: The Svix EU region
- url: https://api.us.svix.com
description: The Svix US region
- url: https://api.ca.svix.com
description: The Svix Canada region
- url: https://api.au.svix.com
description: The Svix Australia region
- url: https://api.in.svix.com
description: The Svix India region
tags:
- name: Broadcast
paths:
/api/v1/msg/broadcast:
post:
tags:
- Broadcast
summary: Create Broadcast Message
description: 'Creates a background task to send the same message to each application in your organization.
A completed task will return a payload like the following:
```json
{
"id": "qtask_33qen93MNuelBAq1T9G7eHLJRsF",
"status": "finished",
"task": "message.broadcast",
"data": {
"messagesCreated": [
{
"appId": "app_33s1An2Zz5cO9SWbhHsYyDmVC6m",
"msgId": "msg_33s1An2Zz5cO9SWbhHsYyDmVC6m"
},
{
"appId": "app_33sXYjcO6bkWeZIXDI8w6ZYMivz",
"msgId": "msg_33sZJfmYMOQGApyIgRdteOX0xlX"
}
]
}
}
```'
operationId: v1.message.broadcast
parameters:
- in: header
name: idempotency-key
description: The request's idempotency key
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MessageBroadcastIn'
required: true
responses:
'202':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MessageBroadcastOut'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/HttpErrorOut'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/HttpErrorOut'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/HttpErrorOut'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/HttpErrorOut'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/HttpErrorOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/HttpErrorOut'
security:
- HTTPBearer: []
x-internal: true
components:
schemas:
ValidationError:
description: Validation errors have their own schema to provide context for invalid requests eg. mismatched types and out of bounds values. There may be any number of these per 422 UNPROCESSABLE ENTITY error.
type: object
properties:
loc:
description: The location as a [`Vec`] of [`String`]s -- often in the form `["body", "field_name"]`, `["query", "field_name"]`, etc. They may, however, be arbitrarily deep.
type: array
items:
type: string
msg:
description: The message accompanying the validation error item.
type: string
type:
description: The type of error, often "type_error" or "value_error", but sometimes with more context like as "value_error.number.not_ge"
type: string
required:
- loc
- msg
- type
MessageBroadcastIn:
type: object
properties:
eventId:
description: Optional unique identifier for the message.
type: string
maxLength: 256
minLength: 1
pattern: ^[a-zA-Z0-9\-_.]+$
example: unique-identifier
nullable: true
eventType:
description: The event type's name
type: string
maxLength: 256
pattern: ^[a-zA-Z0-9\-_.]+$
example: user.signup
payload:
type: object
additionalProperties: true
example:
type: user.created
email: test@example.com
username: test_user
channels:
description: List of free-form identifiers that endpoints can filter by.
type: array
nullable: true
items:
type: string
maxLength: 128
pattern: ^[a-zA-Z0-9\-_.:+]+$
example: project_1337
maxItems: 10
minItems: 1
uniqueItems: true
example:
- project_123
- group_2
payloadRetentionPeriod:
description: Optional number of days to retain the message payload. Defaults to 90. Note that this is mutually exclusive with `payloadRetentionHours`.
type: integer
format: int64
default: 90
nullable: true
maximum: 90
minimum: 1
example: 90
payloadRetentionHours:
description: Optional number of hours to retain the message payload. Note that this is mutually exclusive with `payloadRetentionPeriod`.
type: integer
format: int64
default: null
maximum: 2160
minimum: 1
nullable: true
required:
- eventType
- payload
HttpErrorOut:
title: HttpError
type: object
properties:
code:
type: string
detail:
type: string
required:
- code
- detail
MessageBroadcastOut:
type: object
properties:
id:
description: The QueueBackgroundTask's ID.
type: string
maxLength: 33
minLength: 33
pattern: ^qtask_[A-Za-z0-9]{27}$
example: qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2
status:
$ref: '#/components/schemas/BackgroundTaskStatus'
task:
$ref: '#/components/schemas/BackgroundTaskType'
updatedAt:
type: string
format: date-time
required:
- id
- status
- task
- updatedAt
BackgroundTaskType:
type: string
enum:
- endpoint.replay
- endpoint.recover
- application.stats
- message.broadcast
- sdk.generate
- event-type.aggregate
- application.purge_content
- endpoint.bulk-replay
BackgroundTaskStatus:
type: string
enum:
- running
- finished
- failed
HTTPValidationError:
type: object
properties:
detail:
type: array
items:
$ref: '#/components/schemas/ValidationError'
required:
- detail
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
description: HTTP Bearer token passed in the `Authorization` header
x-tagGroups:
- name: General
tags:
- Background Task
- Environment
- name: Dispatch
tags:
- Application
- Event Type
- Authentication
- Endpoint
- Message
- Message Attempt
- Integration
- Connector
- name: Stream
tags:
- Stream
- Sink
- Event
- Stream Event Type
- Stream Authentication
- name: Ingest
tags:
- Ingest Source
- Ingest Endpoint
- name: Operational Webhooks
tags:
- Webhook
- Webhook Endpoint
- name: Statistics
tags:
- Statistics
- name: Utility
tags:
- Health
x-webhooks:
endpoint.created:
post:
tags:
- Webhook
summary: endpoint.created
description: Sent when an endpoint is created.
operationId: endpoint.created
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EndpointCreatedEvent'
example:
data:
appId: app_1srOrx2ZWZBpBUvZwXKQmoEYga2
appUid: unique-app-identifier
endpointId: ep_1srOrx2ZWZBpBUvZwXKQmoEYga2
endpointUid: unique-endpoint-identifier
type: endpoint.created
responses:
2XX:
description: Return any 2XX status to indicate that the data was received successfully
x-svix-group-name: dispatch
endpoint.deleted:
post:
tags:
- Webhook
summary: endpoint.deleted
description: Sent when an endpoint is deleted.
operationId: endpoint.deleted
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EndpointDeletedEvent'
example:
data:
appId: app_1srOrx2ZWZBpBUvZwXKQmoEYga2
appUid: unique-app-identifier
endpointId: ep_1srOrx2ZWZBpBUvZwXKQmoEYga2
endpointUid: unique-endpoint-identifier
type: endpoint.deleted
responses:
2XX:
description: Return any 2XX status to indicate that the data was received successfully
x-svix-group-name: dispatch
endpoint.disabled:
post:
tags:
- Webhook
summary: endpoint.disabled
description: Sent when an endpoint has been automatically disabled after continuous failures, or manually via an API call.
operationId: endpoint.disabled
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EndpointDisabledEvent'
example:
data:
appId: app_1srOrx2ZWZBpBUvZwXKQmoEYga2
appUid: unique-app-identifier
endpointId: ep_1srOrx2ZWZBpBUvZwXKQmoEYga2
endpointUid: unique-endpoint-identifier
failSince: '2022-11-06T15:04:05Z'
trigger: automatic
type: endpoint.disabled
responses:
2XX:
description: Return any 2XX status to indicate that the data was received successfully
x-svix-group-name: dispatch
endpoint.enabled:
post:
tags:
- Webhook
summary: endpoint.enabled
description: Sent when an endpoint has been enabled.
operationId: endpoint.enabled
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EndpointEnabledEvent'
example:
data:
appId: app_1srOrx2ZWZBpBUvZwXKQmoEYga2
appUid: unique-app-identifier
endpointId: ep_1srOrx2ZWZBpBUvZwXKQmoEYga2
endpointUid: unique-endpoint-identifier
type: endpoint.enabled
responses:
2XX:
description: Return any 2XX status to indicate that the data was received successfully
x-svix-group-name: dispatch
endpoint.updated:
post:
tags:
- Webhook
summary: endpoint.updated
description: Sent when an endpoint is updated.
operationId: endpoint.updated
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EndpointUpdatedEvent'
example:
data:
appId: app_1srOrx2ZWZBpBUvZwXKQmoEYga2
appUid: unique-app-identifier
endpointId: ep_1srOrx2ZWZBpBUvZwXKQmoEYga2
endpointUid: unique-endpoint-identifier
type: endpoint.updated
responses:
2XX:
description: Return any 2XX status to indicate that the data was received successfully
x-svix-group-name: dispatch
message.attempt.exhausted:
post:
tags:
- Webhook
summary: message.attempt.exhausted
description: Sent when a message delivery has failed (all of the retry attempts have been exhausted).
operationId: message.attempt.exhausted
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MessageAttemptExhaustedEvent'
example:
data:
appId: app_1srOrx2ZWZBpBUvZwXKQmoEYga2
appUid: unique-app-identifier
msgId: msg_1srOrx2ZWZBpBUvZwXKQmoEYga2
msgEventId: unique-msg-identifier
endpointId: ep_1srOrx2ZWZBpBUvZwXKQmoEYga2
lastAttempt:
id: atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2
responseStatusCode: 500
timestamp: '2022-11-06T15:04:05Z'
type: message.attempt.exhausted
responses:
2XX:
description: Return any 2XX status to indicate that the data was received successfully
x-svix-group-name: dispatch
message.attempt.failing:
post:
tags:
- Webhook
summary: message.attempt.failing
description: 'Sent after a message has been failing for a few times.
It''s sent on the fourth failure. It complements `message.attempt.exhausted` which is sent after the last failure.'
operationId: message.attempt.failing
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MessageAttemptFailingEvent'
example:
data:
appId: app_1srOrx2ZWZBpBUvZwXKQmoEYga2
appUid: unique-app-identifier
msgId: msg_1srOrx2ZWZBpBUvZwXKQmoEYga2
msgEventId: unique-msg-identifier
endpointId: ep_1srOrx2ZWZBpBUvZwXKQmoEYga2
lastAttempt:
id: atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2
responseStatusCode: 500
timestamp: '2022-11-06T15:04:05Z'
type: message.attempt.failing
responses:
2XX:
description: Return any 2XX status to indicate that the data was received successfully
x-svix-group-name: dispatch
message.attempt.recovered:
post:
tags:
- Webhook
summary: message.attempt.recovered
description: Sent on a successful dispatch after an earlier failure op webhook has already been sent.
operationId: message.attempt.recovered
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MessageAttemptRecoveredEvent'
example:
data:
appId: app_1srOrx2ZWZBpBUvZwXKQmoEYga2
appUid: unique-app-identifier
msgId: msg_1srOrx2ZWZBpBUvZwXKQmoEYga2
msgEventId: unique-msg-identifier
endpointId: ep_1srOrx2ZWZBpBUvZwXKQmoEYga2
lastAttempt:
id: atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2
responseStatusCode: 200
timestamp: '2022-11-06T15:04:05Z'
type: message.attempt.recovered
responses:
2XX:
description: Return any 2XX status to indicate that the data was received successfully
x-svix-group-name: dispatch
background_task.finished:
post:
tags:
- Webhook
summary: background_task.finished
description: Sent when a background task is finished.
operationId: background_task.finished
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundTaskFinishedEvent'
example:
data:
taskId: qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2
task: application.stats
status: finished
data:
appStats:
- messageDestinations: 343
appId: app_1srOrx2ZWZBpBUvZwXKQmoEYga2
appUid: null
type: background_task.finished
responses:
2XX:
description: Return any 2XX status to indicate that the data was received successfully
ingest.endpoint.disabled:
post:
tags:
- Webhook
summary: ingest.endpoint.disabled
description: Sent when an ingest endpoint has been automatically disabled after continuous failures, or manually via an API call.
operationId: ingest.endpoint.disabled
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IngestEndpointDisabledEvent'
example:
data:
sourceId: src_30HT9jb8WZXKVWIO44ZDr
endpointId: ep_1srOrx2ZWZBpBUvZwXKQmoEYga2
endpointUid: unique-endpoint-identifier
failSince: '2022-11-06T15:04:05Z'
trigger: automatic
type: ingest.endpoint.disabled
responses:
2XX:
description: Return any 2XX status to indicate that the data was received successfully
ingest.message.attempt.exhausted:
post:
tags:
- Webhook
summary: ingest.message.attempt.exhausted
description: Sent when a message delivery has failed (all of the retry attempts have been exhausted).
operationId: ingest.message.attempt.exhausted
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IngestMessageAttemptExhaustedEvent'
example:
data:
sourceId: src_30HT9jb8WZXKVWIO44ZDr
msgId: msg_1srOrx2ZWZBpBUvZwXKQmoEYga2
msgEventId: unique-msg-identifier
endpointId: ep_1srOrx2ZWZBpBUvZwXKQmoEYga2
lastAttempt:
id: atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2
responseStatusCode: 500
timestamp: '2022-11-06T15:04:05Z'
type: ingest.message.attempt.exhausted
responses:
2XX:
description: Return any 2XX status to indicate that the data was received successfully
ingest.message.attempt.failing:
post:
tags:
- Webhook
summary: ingest.message.attempt.failing
description: 'Sent after a message has been failing for a few times.
It''s sent on the fourth failure. It complements `ingest.message.attempt.exhausted` which is sent after the last failure.'
operationId: ingest.message.attempt.failing
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IngestMessageAttemptFailingEvent'
example:
data:
sourceId: src_30HT9jb8WZXKVWIO44ZDr
msgId: msg_1srOrx2ZWZBpBUvZwXKQmoEYga2
msgEventId: unique-msg-identifier
endpointId: ep_1srOrx2ZWZBpBUvZwXKQmoEYga2
lastAttempt:
id: atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2
responseStatusCode: 500
timestamp: '2022-11-06T15:04:05Z'
type: ingest.message.attempt.failing
responses:
2XX:
description: Return any 2XX status to indicate that the data was received successfully
ingest.message.attempt.recovered:
post:
tags:
- Webhook
summary: ingest.message.attempt.recovered
description: Sent on a successful dispatch after an earlier failure op webhook has already been sent.
operationId: ingest.message.attempt.recovered
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IngestMessageAttemptRecoveredEvent'
example:
data:
sourceId: src_30HT9jb8WZXKVWIO44ZDr
msgId: msg_1srOrx2ZWZBpBUvZwXKQmoEYga2
msgEventId: unique-msg-identifier
endpointId: ep_1srOrx2ZWZBpBUvZwXKQmoEYga2
lastAttempt:
id: atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2
responseStatusCode: 200
timestamp: '2022-11-06T15:04:05Z'
type: ingest.message.attempt.recovered
responses:
2XX:
description: Return any 2XX status to indicate that the data was received successfully
message.attempt.log:
post:
tags:
- Webhook
summary: message.attempt.log
description: Sent after message attempts are made. Contains metadata about message attempts and their results. In order to reduce the frequency of webhooks, these are sent in batches periodically.
operationId: message.attempt.log
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MessageAttemptLogEvent'
example:
data:
- orgId: env_1srOrx2ZWZBpBUvZwXKQmoEYga2
appId: app_1srOrx2ZWZBpBUvZwXKQmoEYga2
appUid: unique-app-identifier
endpointId: ep_1srOrx2ZWZBpBUvZwXKQmoEYga2
msgId: msg_1srOrx2ZWZBpBUvZwXKQmoEYga2
msgEventId: unique-msg-identifier
msgCreated: '2022-11-06T15:04:05Z'
attemptStart: '2022-11-06T15:04:06Z'
attemptEnd: '2022-11-06T15:04:07Z'
attemptId: atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2
responseStatusCode: 200
attemptCount: 1
status: 0
eventType: user.signup
type: message.attempt.log
responses:
2XX:
description: Return any 2XX status to indicate that the data was received successfully
x-svix-group-name: dispatch
x-svix-feature-flags:
- attempt_log
x-internal: true