Svix

Svix Webhook Sink API

The Webhook Sink API from Svix — 10 operation(s) for webhook sink.

GitHub OpenAPI
Business capability
Webhook & Event Subscription Management BC-4270.80

Operations 16

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/app/{app_id}/stream/sink List an application's stream sinks · List Sinks #
Ask an LLM
“Which stream sinks are batching events out of one of my applications?”
“Can I page through an app's stream sinks with a limit and order?”
Tell an agent
List all stream sinks for application {app_id}.
Show the first {limit} stream sinks of app {app_id}.
POST /api/v1/app/{app_id}/stream/sink Create a stream sink for an application · Create Sink #
Ask an LLM
“How do I set up a stream sink that delivers events in batches?”
“Can a stream sink wait a few seconds to fill a batch before sending?”
Tell an agent
Create a stream sink on application {app_id}.
Create a stream sink for app {app_id} that sends batches of {batchSize} events, waiting at most {maxWaitSecs} seconds.
GET /api/v1/app/{app_id}/stream/sink/{sink_id} Get a stream sink · Get Sink #
Ask an LLM
“What batch size and status does a particular stream sink have?”
“Can I look up a stream sink by its uid instead of its ID?”
Tell an agent
Show stream sink {sink_id} of application {app_id}.
Fetch the configuration of app {app_id}'s stream sink {sink_id}.
PUT /api/v1/app/{app_id}/stream/sink/{sink_id} Create or replace a stream sink · Upsert Sink #
Ask an LLM
“Can I upsert a stream sink so it's created if that ID doesn't exist?”
“How do I replace a stream sink's entire configuration?”
Tell an agent
Upsert stream sink {sink_id} on app {app_id}.
Create or fully replace stream sink {sink_id} of app {app_id} with status {status} and batch size {batchSize}.
DELETE /api/v1/app/{app_id}/stream/sink/{sink_id} Delete a stream sink · Delete Sink #
Ask an LLM
“How do I remove a stream sink I no longer need?”
“Can I permanently delete a stream sink from an application?”
Tell an agent destructive · confirm first
Delete stream sink {sink_id} from application {app_id}.
Remove app {app_id}'s stream sink {sink_id} for good.
PATCH /api/v1/app/{app_id}/stream/sink/{sink_id} Change some settings of a stream sink · Patch Sink #
Ask an LLM
“Can I pause a stream sink by changing only its status?”
“How do I adjust a stream sink's batch wait time without resending everything?”
Tell an agent
Set the status of stream sink {sink_id} on app {app_id} to {status}.
Partially update stream sink {sink_id} of app {app_id} to wait up to {maxWaitSecs} seconds per batch.
GET /api/v1/app/{app_id}/stream/sink/{sink_id}/transformation Get a stream sink's transformation code · Get Sink Transformation #
Ask an LLM
“What transformation code runs on events before a stream sink sends them?”
“Does a given stream sink have a transformation attached?”
Tell an agent
Show the transformation code for stream sink {sink_id} in app {app_id}.
Fetch the transformation attached to app {app_id}'s stream sink {sink_id}.
PATCH /api/v1/app/{app_id}/stream/sink/{sink_id}/transformation Set or remove a stream sink's transformation · Set Sink Transformation #
Ask an LLM
“How do I attach transformation code to a stream sink?”
“Can I clear the transformation from a stream sink?”
Tell an agent
Set the transformation code of stream sink {sink_id} on app {app_id} to {code}.
Unset the transformation on app {app_id}'s stream sink {sink_id}.
GET /api/v1/app/{app_id}/stream/sink/{sink_id}/secret Get an HTTP stream sink's signing secret · Get Sink Secret #
Ask an LLM
“Where do I find the secret to verify deliveries from an HTTP stream sink?”
“Do non-HTTP stream sinks have a signing secret I can read?”
Tell an agent
Get the signing secret of HTTP stream sink {sink_id} in app {app_id}.
Show the verification secret for app {app_id}'s stream sink {sink_id}.
POST /api/v1/app/{app_id}/stream/sink/{sink_id}/secret/rotate Rotate an HTTP stream sink's signing secret · Rotate Sink Secret #
Ask an LLM
“How do I rotate the signing secret on an HTTP stream sink?”
“Can the old stream sink secret keep working for a grace period after rotation?”
Tell an agent
Rotate the signing secret of stream sink {sink_id} in app {app_id}.
Rotate stream sink {sink_id}'s secret on app {app_id} with a {gracePeriodSeconds}-second grace period.
GET /api/v1/app/{app_id}/stream/sink/{sink_id}/headers Get an HTTP stream sink's headers · Get Sink Headers #
Ask an LLM
“Which HTTP headers does a stream sink send with each batch?”
“Can I see the custom headers on an HTTP stream sink?”
Tell an agent
Show the HTTP headers configured on stream sink {sink_id} in app {app_id}.
List the headers app {app_id}'s stream sink {sink_id} sends.
PATCH /api/v1/app/{app_id}/stream/sink/{sink_id}/headers Update an HTTP stream sink's headers · Patch Sink Headers #
Ask an LLM
“How do I add an auth header to an HTTP stream sink's deliveries?”
“Can I change a stream sink's headers without recreating the sink?”
Tell an agent
Patch the headers of stream sink {sink_id} in app {app_id} with {headers}.
Add headers {headers} to the HTTP deliveries of app {app_id}'s stream sink {sink_id}.
POST /api/v1/app/{app_id}/stream/sink/{sink_id}/force-retry Force a paused stream sink to retry now · Force Retry Sink #
Ask an LLM
“My stream sink paused after errors — how do I make it retry immediately?”
“Can I skip the backoff wait on a stream sink whose dispatch is paused?”
Tell an agent
Force stream sink {sink_id} in app {app_id} to retry right away.
Resume dispatch now on app {app_id}'s paused stream sink {sink_id}.
GET /api/v1/app/{app_id}/stream/sink/{sink_id}/last-acked-event Get the last event a stream sink acknowledged · Get Last Acked Event #
Ask an LLM
“What was the most recent event a stream sink successfully acknowledged?”
“How far has a stream sink gotten through the event stream?”
Tell an agent
Show the latest acked event for stream sink {sink_id} in app {app_id}.
Tell me the last event app {app_id}'s stream sink {sink_id} acknowledged.
GET /api/v1/app/{app_id}/stream/sink/{sink_id}/next-event Get the next unacknowledged event for a sink · Get Next Stream Sink Event #
Ask an LLM
“Which event is a stream sink stuck on?”
“What is the oldest event a stream sink hasn't acknowledged yet?”
Tell an agent
Show the oldest unacked event waiting for stream sink {sink_id} in app {app_id}.
Get the next event app {app_id}'s stream sink {sink_id} still has to deliver.
POST /api/v1/app/{app_id}/stream/sink/{sink_id}/skip Skip events a stream sink is stuck on · Skip N Events #
Ask an LLM
“How do I move a stream sink past events it keeps failing on?”
“Can I advance a stream sink's position to a given iterator?”
Tell an agent destructive · confirm first
Skip the pending events on stream sink {sink_id} in app {app_id}.
Advance app {app_id}'s stream sink {sink_id} past events up to iterator {iterator}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/svix/refs/heads/main/openapi/svix-webhook-sink-api-openapi.yml

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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/svix:svix-webhook-sink-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

svix-webhook-sink-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Svix Webhook Sink 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:


# --- truncated at 32 KB (86 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/svix/refs/heads/main/openapi/svix-webhook-sink-api-openapi.yml