Svix Webhook Sink API
The Webhook Sink API from Svix — 10 operation(s) for webhook sink.
The Webhook Sink API from Svix — 10 operation(s) for webhook sink.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/svix-webhook-sink-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
title: Svix Webhook Sink API
description: 'Welcome to the Svix API documentation!
Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/)
# Introduction
This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com).
## Main concepts
In Svix you have four important entities you will be interacting with:
- `messages`: these are the webhooks being sent. They can have contents and a few other properties.
- `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform.
- `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type).
- `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint.
## Authentication
Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`. For more information on authentication, please refer to the [authentication token docs](https://docs.svix.com/api-keys).
<SecurityDefinitions />
## Code samples
The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/).
## Idempotency
Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response.
To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions. Your idempotency key should not begin with the string `auto_`, which is reserved for internal use by the client libraries.
Svix''s idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result for a period of up to 12 hours.
Please note that idempotency is only supported for `POST` requests.
## Cross-Origin Resource Sharing
This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
'
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: Webhook Sink
paths:
/api/v1/app/{app_id}/stream/sink:
get:
tags:
- Webhook Sink
summary: List Sinks
description: List of all the stream's sinks.
operationId: v1.app.stream.sink.list
parameters:
- in: path
name: app_id
description: The Application's ID or UID.
required: true
schema:
description: The Application's ID or UID.
type: string
maxLength: 256
minLength: 1
pattern: ^[a-zA-Z0-9\-_.]+$
example: unique-identifier
style: simple
- in: query
name: limit
description: Limit the number of returned items
schema:
description: Limit the number of returned items
type: integer
format: uint64
maximum: 250
minimum: 1.0
style: form
- in: query
name: iterator
description: The iterator returned from a prior invocation
schema:
description: The iterator returned from a prior invocation
type: string
maxLength: 27
minLength: 26
pattern: ^sink_[A-Za-z0-9]{21,22}$
nullable: true
example: sink_2yZwUhtgs5Ai8T9yRQJXA
style: form
- in: query
name: order
description: The sorting order of the returned items
schema:
description: The sorting order of the returned items
$ref: '#/components/schemas/Ordering'
nullable: true
style: form
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ListResponse_StreamSinkOut_'
'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
post:
tags:
- Webhook Sink
summary: Create Sink
description: Creates a new sink.
operationId: v1.app.stream.sink.create
parameters:
- in: path
name: app_id
description: The Application's ID or UID.
required: true
schema:
description: The Application's ID or UID.
type: string
maxLength: 256
minLength: 1
pattern: ^[a-zA-Z0-9\-_.]+$
example: unique-identifier
style: simple
- in: header
name: idempotency-key
description: The request's idempotency key
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StreamSinkIn'
required: true
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/StreamSinkOut'
'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
/api/v1/app/{app_id}/stream/sink/{sink_id}:
get:
tags:
- Webhook Sink
summary: Get Sink
description: Get a sink by id or uid.
operationId: v1.app.stream.sink.get
parameters:
- in: path
name: app_id
description: The Application's ID or UID.
required: true
schema:
description: The Application's ID or UID.
type: string
maxLength: 256
minLength: 1
pattern: ^[a-zA-Z0-9\-_.]+$
example: unique-identifier
style: simple
- in: path
name: sink_id
description: The StreamSink's ID or UID.
required: true
schema:
description: The StreamSink's ID or UID.
type: string
maxLength: 60
minLength: 1
example: unique-identifier
style: simple
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/StreamSinkOut'
'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
put:
tags:
- Webhook Sink
summary: Upsert Sink
description: Create or update a sink.
operationId: v1.app.stream.sink.upsert
parameters:
- in: path
name: app_id
description: The Application's ID or UID.
required: true
schema:
description: The Application's ID or UID.
type: string
maxLength: 256
minLength: 1
pattern: ^[a-zA-Z0-9\-_.]+$
example: unique-identifier
style: simple
- in: path
name: sink_id
description: The StreamSink's ID or UID.
required: true
schema:
description: The StreamSink's ID or UID.
type: string
maxLength: 60
minLength: 1
example: unique-identifier
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StreamSinkIn'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/StreamSinkOut'
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/StreamSinkOut'
'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
delete:
tags:
- Webhook Sink
summary: Delete Sink
description: Delete a sink.
operationId: v1.app.stream.sink.delete
parameters:
- in: path
name: app_id
description: The Application's ID or UID.
required: true
schema:
description: The Application's ID or UID.
type: string
maxLength: 256
minLength: 1
pattern: ^[a-zA-Z0-9\-_.]+$
example: unique-identifier
style: simple
- in: path
name: sink_id
description: The StreamSink's ID or UID.
required: true
schema:
description: The StreamSink's ID or UID.
type: string
maxLength: 60
minLength: 1
example: unique-identifier
style: simple
responses:
'204':
description: no content
'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
patch:
tags:
- Webhook Sink
summary: Patch Sink
description: Partially update a sink.
operationId: v1.app.stream.sink.patch
parameters:
- in: path
name: app_id
description: The Application's ID or UID.
required: true
schema:
description: The Application's ID or UID.
type: string
maxLength: 256
minLength: 1
pattern: ^[a-zA-Z0-9\-_.]+$
example: unique-identifier
style: simple
- in: path
name: sink_id
description: The StreamSink's ID or UID.
required: true
schema:
description: The StreamSink's ID or UID.
type: string
maxLength: 60
minLength: 1
example: unique-identifier
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StreamSinkPatch'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/StreamSinkOut'
'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
/api/v1/app/{app_id}/stream/sink/{sink_id}/transformation:
get:
tags:
- Webhook Sink
summary: Get Sink Transformation
description: Get the transformation code associated with this endpoint.
operationId: v1.app.stream.sink-transformation-get
parameters:
- in: path
name: app_id
description: The Application's ID or UID.
required: true
schema:
description: The Application's ID or UID.
type: string
maxLength: 256
minLength: 1
pattern: ^[a-zA-Z0-9\-_.]+$
example: unique-identifier
style: simple
- in: path
name: sink_id
description: The StreamSink's ID or UID.
required: true
schema:
description: The StreamSink's ID or UID.
type: string
maxLength: 60
minLength: 1
example: unique-identifier
style: simple
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SinkTransformationOut'
'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
patch:
tags:
- Webhook Sink
summary: Set Sink Transformation
description: Set or unset the transformation code associated with this sink.
operationId: v1.app.stream.sink.transformation-partial-update
parameters:
- in: path
name: app_id
description: The Application's ID or UID.
required: true
schema:
description: The Application's ID or UID.
type: string
maxLength: 256
minLength: 1
pattern: ^[a-zA-Z0-9\-_.]+$
example: unique-identifier
style: simple
- in: path
name: sink_id
description: The StreamSink's ID or UID.
required: true
schema:
description: The StreamSink's ID or UID.
type: string
maxLength: 60
minLength: 1
example: unique-identifier
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SinkTransformIn'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/EmptyResponse'
'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
/api/v1/app/{app_id}/stream/sink/{sink_id}/secret:
get:
tags:
- Webhook Sink
summary: Get Sink Secret
description: 'Get the sink''s signing secret (only supported for http sinks)
This is used to verify the authenticity of the delivery
For more information please refer to [the consuming webhooks docs](https://docs.svix.com/consuming-webhooks/).'
operationId: v1.app.stream.sink.get-secret
parameters:
- in: path
name: app_id
description: The Application's ID or UID.
required: true
schema:
description: The Application's ID or UID.
type: string
maxLength: 256
minLength: 1
pattern: ^[a-zA-Z0-9\-_.]+$
example: unique-identifier
style: simple
- in: path
name: sink_id
description: The StreamSink's ID or UID.
required: true
schema:
description: The StreamSink's ID or UID.
type: string
maxLength: 60
minLength: 1
example: unique-identifier
style: simple
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SinkSecretOut'
'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
/api/v1/app/{app_id}/stream/sink/{sink_id}/secret/rotate:
post:
tags:
- Webhook Sink
summary: Rotate Sink Secret
description: Rotates the signing secret (only supported for http sinks).
operationId: v1.app.stream.sink.rotate-secret
parameters:
- in: path
name: app_id
description: The Application's ID or UID.
required: true
schema:
description: The Application's ID or UID.
type: string
maxLength: 256
minLength: 1
pattern: ^[a-zA-Z0-9\-_.]+$
example: unique-identifier
style: simple
- in: path
name: sink_id
description: The StreamSink's ID or UID.
required: true
schema:
description: The StreamSink's ID or UID.
type: string
maxLength: 60
minLength: 1
example: unique-identifier
style: simple
- in: header
name: idempotency-key
description: The request's idempotency key
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EndpointSecretRotateIn'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/EmptyResponse'
'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
/api/v1/app/{app_id}/stream/sink/{sink_id}/headers:
get:
tags:
- Webhook Sink
summary: Get Sink Headers
description: Get the HTTP sink headers
operationId: v1.app.stream.sink.headers-get
parameters:
- in: path
name: app_id
description: The Application's ID or UID.
required: true
schema:
description: The Application's ID or UID.
type: string
maxLength: 256
minLength: 1
pattern: ^[a-zA-Z0-9\-_.]+$
example: unique-identifier
style: simple
- in: path
name: sink_id
description: The StreamSink's ID or UID.
required: true
schema:
description: The StreamSink's ID or UID.
type: string
maxLength: 60
minLength: 1
example: unique-identifier
style: simple
responses:
'200':
description: 'The value of the headers is returned in the `headers` field.
Sensitive headers that have been redacted are returned in the sensitive field.'
content:
application/json:
schema:
$ref: '#/components/schemas/EndpointHeadersOut'
'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
patch:
tags:
- Webhook Sink
summary: Patch Sink Headers
description: Patch the HTTP sink headers
operationId: v1.app.stream.sink.headers-patch
parameters:
- in: path
name: app_id
description: The Application's ID or UID.
required: true
schema:
description: The Application's ID or UID.
type: string
maxLength: 256
minLength: 1
pattern: ^[a-zA-Z0-9\-_.]+$
example: unique-identifier
style: simple
- in: path
name: sink_id
description: The StreamSink's ID or UID.
required: true
schema:
description: The St
# --- truncated at 32 KB (89 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/svix/refs/heads/main/openapi/svix-webhook-sink-api-openapi.yml