Svix

Svix Sink API

The Sink API from Svix — 6 operation(s) for sink.

GitHub OpenAPI

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/stream/{stream_id}/sink/{sink_id}/last-acked-event Get the last event a sink acknowledged · Get Last Acked Event #
Ask an LLM
“How far has my stream sink gotten — what's the last event it acked?”
“Can I see the most recent acknowledged event for a sink?”
Tell an agent
Get the last acked event for sink {sink_id} on stream {stream_id}.
Show where sink {sink_id} in stream {stream_id} last acknowledged.
GET /api/v1/stream/{stream_id}/sink/{sink_id}/next-event Get a sink's oldest unacknowledged event · Get Next Stream Sink Event #
Ask an LLM
“What's the next event my sink hasn't acked yet?”
“Which is the oldest pending event waiting on a stream sink?”
Tell an agent
Get the next unacked event for sink {sink_id} on stream {stream_id}.
Show the oldest event stream {stream_id} sink {sink_id} still has to acknowledge.
GET /api/v1/stream/{stream_id}/sink List a stream's sinks · List Sinks #
Ask an LLM
“Which sinks are attached to my stream?”
“Can I page through all the destinations a stream delivers to?”
Tell an agent
List all sinks on stream {stream_id}.
Show the first {limit} sinks for stream {stream_id}.
POST /api/v1/stream/{stream_id}/sink Create a sink on a stream · Create Sink #
Ask an LLM
“How do I add a new sink to a Svix stream?”
“Can a new sink receive only certain event types and batch them?”
Tell an agent
Create a new sink on stream {stream_id}.
Add a sink to stream {stream_id} for event types {eventTypes} with batch size {batchSize}.
GET /api/v1/stream/{stream_id}/sink/{sink_id} Get a sink's configuration · Get Sink #
Ask an LLM
“What is the configuration of a specific sink on my stream?”
“Can I look up a sink by its uid instead of its id?”
Tell an agent
Get sink {sink_id} on stream {stream_id}.
Show the settings for stream {stream_id}'s sink {sink_id}.
PUT /api/v1/stream/{stream_id}/sink/{sink_id} Create or fully replace a sink · Upsert Sink #
Ask an LLM
“How do I upsert a sink so it's created if it doesn't exist yet?”
“Can I replace a sink's whole configuration in one call?”
Tell an agent
Upsert sink {sink_id} on stream {stream_id}.
Replace sink {sink_id} on {stream_id} with status {status} and max wait {maxWaitSecs} seconds.
DELETE /api/v1/stream/{stream_id}/sink/{sink_id} Delete a sink · Delete Sink #
Ask an LLM
“How do I remove a sink from a stream?”
“What happens to a stream when I delete one of its sinks?”
Tell an agent destructive · confirm first
Delete sink {sink_id} from stream {stream_id}.
Remove stream {stream_id}'s sink {sink_id} permanently.
PATCH /api/v1/stream/{stream_id}/sink/{sink_id} Partially update a sink · Patch Sink #
Ask an LLM
“How do I pause a sink by changing just its status?”
“Can I tweak a sink's batch size without resending its full config?”
Tell an agent
Set sink {sink_id} on stream {stream_id} to status {status}.
Patch only the batch size of sink {sink_id} in {stream_id} to {batchSize}.
GET /api/v1/stream/{stream_id}/sink/{sink_id}/transformation Get a sink's transformation code · Get Sink Transformation #
Ask an LLM
“What transformation code is running on my sink?”
“Can I read back the script that reshapes events before a sink delivers them?”
Tell an agent
Get the transformation code for sink {sink_id} on stream {stream_id}.
Show stream {stream_id} sink {sink_id}'s transformation.
PATCH /api/v1/stream/{stream_id}/sink/{sink_id}/transformation Set or clear a sink's transformation code · Set Sink Transformation #
Ask an LLM
“How do I attach transformation code to a stream sink?”
“Can I remove a sink's transformation so events pass through unchanged?”
Tell an agent
Set the transformation on sink {sink_id} in stream {stream_id} to {code}.
Unset the transformation code on stream {stream_id} sink {sink_id}.
GET /api/v1/stream/{stream_id}/sink/{sink_id}/secret Get an HTTP sink's signing secret · Get Sink Secret #
Ask an LLM
“Where do I find the signing secret to verify deliveries from an HTTP sink?”
“Does every sink type have a signing secret?”
Tell an agent
Get the signing secret for HTTP sink {sink_id} on stream {stream_id}.
Show stream {stream_id} sink {sink_id}'s secret so I can verify its deliveries.
POST /api/v1/stream/{stream_id}/sink/{sink_id}/secret/rotate Rotate an HTTP 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 sink secret stay valid for a grace period after rotation?”
Tell an agent
Rotate the signing secret for sink {sink_id} on stream {stream_id}.
Rotate stream {stream_id} sink {sink_id}'s secret with a {gracePeriodSeconds}-second grace period.
GET /api/v1/stream/{stream_id}/sink/{sink_id}/headers Get the HTTP headers a sink sends · Get Sink Headers #
Ask an LLM
“Which custom HTTP headers does my sink send with deliveries?”
“Can I view headers configured on an OpenTelemetry tracing sink?”
Tell an agent
Get the headers for sink {sink_id} on stream {stream_id}.
Show the custom headers stream {stream_id} sink {sink_id} is sending.
PATCH /api/v1/stream/{stream_id}/sink/{sink_id}/headers Update the HTTP headers a sink sends · Patch Sink Headers #
Ask an LLM
“How do I add an auth header to every delivery from an HTTP sink?”
“Can I change headers on a sink that isn't http or otelTracing?”
Tell an agent
Update sink {sink_id} on stream {stream_id} to send headers {headers}.
Patch stream {stream_id} sink {sink_id}'s headers with {headers}.
POST /api/v1/stream/{stream_id}/sink/{sink_id}/force-retry Force a retrying sink to dispatch now · Force Retry #
Ask an LLM
“My sink is backing off after failures — can I make it retry right away?”
“How do I skip the wait on a sink that's currently retrying?”
Tell an agent
Force sink {sink_id} on stream {stream_id} to retry immediately.
Kick stream {stream_id} sink {sink_id} out of its retry backoff now.
POST /api/v1/stream/{stream_id}/sink/{sink_id}/skip Skip a sink ahead past a given event · Skip To Event #
Ask an LLM
“How do I make a sink skip events it's stuck on?”
“Can I move a sink's position to just after a specific iterator?”
Tell an agent destructive · confirm first
Skip sink {sink_id} on stream {stream_id} to after iterator {iterator}.
Move stream {stream_id} sink {sink_id}'s consumer position past {iterator}, dropping earlier events.

Documentation

📖
Documentation
https://docs.svix.com
📖
APIReference
https://api.svix.com/docs
📖
Authentication
https://docs.svix.com/api-keys
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/svix/refs/heads/main/rate-limits/svix-rate-limits.yml
📖
Documentation
https://www.svix.com/ingest/
📖
Documentation
https://www.svix.com/stream/

Specifications

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

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/svix/refs/heads/main/overlays/svix-sink-api-overlay.yaml
🔗
ErrorCodes
https://docs.svix.com/retries

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-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-sink-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Svix 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 (134 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/svix/refs/heads/main/openapi/svix-sink-api-openapi.yml