Svix

Svix Endpoint API

Endpoints are the URLs messages will be sent to. Each application can have up to 50 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).

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

Operations 35

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}/endpoint List an application's webhook endpoints · List Endpoints #
Ask an LLM
“Which webhook endpoints are registered for one of my Svix applications?”
“Can I page through an application's endpoints newest first?”
Tell an agent
List all webhook endpoints for application {app_id}.
Show the first {limit} endpoints of app {app_id} in {order} order.
POST /api/v1/app/{app_id}/endpoint Add a webhook endpoint to an application · Create Endpoint #
Ask an LLM
“How do I register a new webhook URL for one of my applications?”
“Can a new endpoint only receive certain event types or channels?”
Tell an agent
Add a new webhook endpoint at {url} to application {app_id}.
Create an endpoint {url} on app {app_id} that only receives the {filterTypes} event types.
GET /api/v1/app/{app_id}/endpoint/{endpoint_id} Get a webhook endpoint's details · Get Endpoint #
Ask an LLM
“What URL, filters and settings does a specific webhook endpoint have?”
“Is a particular endpoint currently disabled?”
Tell an agent
Show me endpoint {endpoint_id} in application {app_id}.
Fetch the configuration of webhook endpoint {endpoint_id} for app {app_id}.
PUT /api/v1/app/{app_id}/endpoint/{endpoint_id} Create or replace a webhook endpoint · Upsert Endpoint #
Ask an LLM
“Can I upsert an endpoint by its ID so it's created if it doesn't exist yet?”
“How do I replace an endpoint's whole configuration, including its URL?”
Tell an agent
Upsert endpoint {endpoint_id} in app {app_id} with URL {url}.
Replace the full settings of endpoint {endpoint_id} on app {app_id}: URL {url}, description {description}.
DELETE /api/v1/app/{app_id}/endpoint/{endpoint_id} Delete a webhook endpoint · Delete Endpoint #
Ask an LLM
“How do I remove a webhook endpoint a customer no longer uses?”
“Can I permanently delete an endpoint from an application?”
Tell an agent destructive · confirm first
Delete endpoint {endpoint_id} from application {app_id}.
Remove the webhook endpoint {endpoint_id} of app {app_id} for good.
PATCH /api/v1/app/{app_id}/endpoint/{endpoint_id} Change some settings of a webhook endpoint · Patch Endpoint #
Ask an LLM
“Can I disable an endpoint without resending its whole configuration?”
“How do I change just the event type filter on an existing endpoint?”
Tell an agent
Disable endpoint {endpoint_id} in app {app_id} by setting disabled to {disabled}.
Partially update endpoint {endpoint_id} on app {app_id} so it only gets channels {channels}.
GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/connector Get the connector linked to an endpoint · Get Endpoint Connector #
Ask an LLM
“Which connector is an endpoint built from?”
“Can I see the connector behind a specific webhook endpoint?”
Tell an agent
Show the connector associated with endpoint {endpoint_id} in app {app_id}.
Look up which connector endpoint {endpoint_id} of application {app_id} uses.
GET /api/v1/app/{app_id}/sink List an application's sinks · List Sinks #
Ask an LLM
“What sinks are set up for an application alongside its endpoints?”
“Can I page through an app's sinks with a limit?”
Tell an agent
List the sinks configured on application {app_id}.
Show up to {limit} sinks for app {app_id}.
POST /api/v1/app/{app_id}/sink Create a sink for an application · Create Sink #
Ask an LLM
“How do I add a sink to an application instead of an HTTP endpoint?”
“Can a sink be limited to certain channels when I create it?”
Tell an agent
Create a new sink on application {app_id}.
Add a sink to app {app_id} described as {description} that listens only to channels {channels}.
GET /api/v1/app/{app_id}/sink/{sink_id} Get a sink on an application · Get Sink #
Ask an LLM
“What is the configuration of a specific sink on my app?”
“Can I check whether a given application sink is disabled?”
Tell an agent
Show sink {sink_id} of application {app_id}.
Fetch the details of app {app_id}'s sink {sink_id}.
POST /api/v1/app/{app_id}/endpoint/{endpoint_id}/cancel-msgs Cancel pending messages to an endpoint · Cancel Msgs #
Ask an LLM
“How do I stop pending webhooks created before a certain time from being delivered?”
“Is cancelling queued messages to an endpoint immediate?”
Tell an agent destructive · confirm first
Cancel all pending messages to endpoint {endpoint_id} in app {app_id} created before {createdBefore}.
Drop the backlog of unsent webhooks for endpoint {endpoint_id} on app {app_id} older than {createdBefore}.
GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/secret Get an endpoint's signing secret · Get Endpoint Secret #
Ask an LLM
“Where do I find the secret to verify webhook signatures for an endpoint?”
“What signing secret is my receiver supposed to check payloads against?”
Tell an agent
Get the signing secret for endpoint {endpoint_id} in application {app_id}.
Show me the webhook verification secret of endpoint {endpoint_id} on app {app_id}.
POST /api/v1/app/{app_id}/endpoint/{endpoint_id}/secret/rotate Rotate an endpoint's signing secret · Rotate Endpoint Secret Handler #
Ask an LLM
“How do I rotate a webhook endpoint's signing secret without breaking verification?”
“How long does the old endpoint secret stay valid after rotation?”
Tell an agent
Rotate the signing secret of endpoint {endpoint_id} in app {app_id}.
Rotate endpoint {endpoint_id}'s secret on app {app_id} and keep the old one valid for {gracePeriodSeconds} seconds.
GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/headers Get custom headers sent to an endpoint · Get Endpoint Headers #
Ask an LLM
“Which extra HTTP headers are added to webhooks sent to an endpoint?”
“Can I see the custom headers configured on a webhook endpoint?”
Tell an agent
Show the additional headers sent with webhooks to endpoint {endpoint_id} in app {app_id}.
List the custom headers on endpoint {endpoint_id} of application {app_id}.
PUT /api/v1/app/{app_id}/endpoint/{endpoint_id}/headers Replace the custom headers on an endpoint · Set Endpoint Headers #
Ask an LLM
“How do I set the full list of extra headers sent with an endpoint's webhooks?”
“Can I overwrite every custom header on an endpoint in one call?”
Tell an agent
Set the headers of endpoint {endpoint_id} in app {app_id} to exactly {headers}.
Replace all custom webhook headers on endpoint {endpoint_id} of application {app_id} with {headers}.
PATCH /api/v1/app/{app_id}/endpoint/{endpoint_id}/headers Add or remove some custom headers on an endpoint · Patch Endpoint Headers #
Ask an LLM
“Can I add one header to an endpoint without wiping the others?”
“How do I delete a single custom header from a webhook endpoint?”
Tell an agent
Add headers {headers} to endpoint {endpoint_id} in app {app_id}, keeping the existing ones.
On endpoint {endpoint_id} of app {app_id}, merge in headers {headers} and remove {deleteHeaders}.
GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/transformation Get an endpoint's transformation code · Get Endpoint Transformation #
Ask an LLM
“What transformation code runs on payloads before they reach an endpoint?”
“Is a payload transformation enabled on a given webhook endpoint?”
Tell an agent
Show the transformation code for endpoint {endpoint_id} in app {app_id}.
Fetch the payload transformation attached to endpoint {endpoint_id} of application {app_id}.
PATCH /api/v1/app/{app_id}/endpoint/{endpoint_id}/transformation Set or remove an endpoint's transformation · Patch Endpoint Transformation #
Ask an LLM
“How do I attach JavaScript transformation code to a webhook endpoint?”
“Can I turn off an endpoint's transformation without deleting the code?”
Tell an agent
Set the transformation code of endpoint {endpoint_id} in app {app_id} to {code}.
Set the transformation on endpoint {endpoint_id} of app {app_id} to enabled={enabled}.
POST /api/v1/app/{app_id}/endpoint/{endpoint_id}/transformation/simulate Test an endpoint transformation on a sample payload · Simulate #
Ask an LLM
“Can I dry-run transformation code against a sample payload for one of my endpoints?”
“What would a webhook look like after my endpoint's transformation runs?”
Tell an agent
Simulate transformation {code} on endpoint {endpoint_id} of app {app_id} for a {eventType} event with payload {payload}.
Preview what endpoint {endpoint_id} in app {app_id} would receive if code {code} transformed {payload} as event {eventType}.
POST /api/v1/app/{app_id}/endpoint/{endpoint_id}/replay-missing Replay messages an endpoint never received · Replay Missing Webhooks #
Ask an LLM
“How do I send an endpoint the webhooks it missed while it was offline?”
“Will replaying missing messages resend ones the endpoint already got?”
Tell an agent
Replay all messages endpoint {endpoint_id} in app {app_id} never received since {since}.
Send endpoint {endpoint_id} of app {app_id} the webhooks it missed between {since} and {until}.
POST /api/v1/app/{app_id}/endpoint/{endpoint_id}/bulk-replay Bulk replay successful and failed messages · Bulk Replay Messages #
Ask an LLM
“Can I replay every message sent to an endpoint in a time window, including successful ones?”
“Is it possible to bulk replay only one event type or tag to an endpoint?”
Tell an agent
Bulk replay every message sent to endpoint {endpoint_id} in app {app_id} since {since}, successes included.
Bulk replay {eventTypes} messages to endpoint {endpoint_id} of app {app_id} created since {since}.
GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/oauth Get an endpoint's OAuth configuration · Get Endpoint Oauth Config #
Ask an LLM
“What OAuth client and token URL does an endpoint use to authenticate deliveries?”
“Does fetching an endpoint's OAuth settings return a 404 when OAuth isn't set up?”
Tell an agent
Get the OAuth configuration of endpoint {endpoint_id} in app {app_id}.
Show the OAuth grant type and token URL set on endpoint {endpoint_id} of application {app_id}.
PUT /api/v1/app/{app_id}/endpoint/{endpoint_id}/oauth Configure OAuth for webhook deliveries · Set Endpoint Oauth Config #
Ask an LLM
“How do I make webhook deliveries to an endpoint fetch an OAuth access token first?”
“Which OAuth grant types and client auth methods can an endpoint use?”
Tell an agent
Set OAuth on endpoint {endpoint_id} in app {app_id} using client {clientId}, token URL {tokenUrl}, grant {grantType} and auth method {authMethod}.
Configure endpoint {endpoint_id} of app {app_id} for OAuth grant {grantType} via {authMethod} with client {clientId} at {tokenUrl}, scopes {scopes}.
DELETE /api/v1/app/{app_id}/endpoint/{endpoint_id}/oauth Remove OAuth from an endpoint · Delete Endpoint Oauth Config #
Ask an LLM
“How do I stop an endpoint from using OAuth for its webhook deliveries?”
“Can I delete the OAuth client settings stored on an endpoint?”
Tell an agent destructive · confirm first
Delete the OAuth configuration from endpoint {endpoint_id} in app {app_id}.
Turn off OAuth-authenticated delivery for endpoint {endpoint_id} of application {app_id}.
GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/oauth-config Check whether OAuth is enabled on an endpoint · Get Endpoint Oauth Config 2 #
Ask an LLM
“Is OAuth enabled on an endpoint, without getting an error if it isn't?”
“How can I read an endpoint's OAuth status as enabled true or false?”
Tell an agent
Check whether OAuth is enabled on endpoint {endpoint_id} in app {app_id}.
Get the OAuth status and config for endpoint {endpoint_id} of app {app_id}, returning enabled false if unset.
GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/ca Get an endpoint's custom CA certificate · Get Endpoint Server Ca #
Ask an LLM
“Which custom CA certificate is trusted when delivering to a given endpoint?”
“Does my endpoint have a custom server CA set?”
Tell an agent
Show the custom CA certificate for endpoint {endpoint_id} in app {app_id}.
Fetch the server CA cert used to verify endpoint {endpoint_id} of application {app_id}.
PUT /api/v1/app/{app_id}/endpoint/{endpoint_id}/ca Set or clear an endpoint's custom CA certificate · Set Endpoint Server Ca #
Ask an LLM
“How do I deliver webhooks to an endpoint that uses a self-signed or private CA?”
“Can I clear a custom CA certificate from an endpoint?”
Tell an agent
Trust CA certificate {cert} for deliveries to endpoint {endpoint_id} in app {app_id}.
Unset the custom CA certificate on endpoint {endpoint_id} of application {app_id}.
GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/mtls Get an endpoint's mTLS configuration · Get Endpoint Mtls Config #
Ask an LLM
“What client certificate is presented when delivering to an endpoint over mTLS?”
“Does reading an endpoint's mTLS settings fail with a 404 if mTLS isn't configured?”
Tell an agent
Get the mTLS configuration of endpoint {endpoint_id} in app {app_id}.
Show the mutual TLS client identity set on endpoint {endpoint_id} of application {app_id}.
PUT /api/v1/app/{app_id}/endpoint/{endpoint_id}/mtls Configure mutual TLS for an endpoint · Set Endpoint Mtls Config #
Ask an LLM
“How do I make webhook deliveries present a client certificate for mTLS?”
“Can I give an endpoint its own mTLS identity?”
Tell an agent
Set mTLS on endpoint {endpoint_id} in app {app_id} with client identity {identity}.
Enable mutual TLS for deliveries to endpoint {endpoint_id} of app {app_id} using identity {identity}.
DELETE /api/v1/app/{app_id}/endpoint/{endpoint_id}/mtls Remove mutual TLS from an endpoint · Delete Endpoint Mtls Config #
Ask an LLM
“How do I stop presenting a client certificate to an endpoint?”
“Can I delete the mTLS identity configured on an endpoint?”
Tell an agent destructive · confirm first
Delete the mTLS configuration from endpoint {endpoint_id} in app {app_id}.
Turn off mutual TLS for endpoint {endpoint_id} of application {app_id}.
GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/mtls-config Check whether mTLS is enabled on an endpoint · Get Endpoint Mtls Config 2 #
Ask an LLM
“Is mutual TLS turned on for an endpoint, without an error when it's off?”
“Rather than a 404, can I get back a simple on/off flag for an endpoint's client-certificate setup?”
Tell an agent
Check whether mTLS is enabled on endpoint {endpoint_id} in app {app_id}.
Report whether endpoint {endpoint_id} of app {app_id} has a client certificate configured, with its mTLS config if so.
GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/stats Get delivery statistics for an endpoint · Endpoint Stats #
Ask an LLM
“How many webhooks to an endpoint succeeded, failed or are still pending?”
“Can I see an endpoint's delivery stats for a specific date range?”
Tell an agent
Show delivery statistics for endpoint {endpoint_id} in app {app_id}.
Get endpoint {endpoint_id}'s stats on app {app_id} from {since} to {until}.
GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/rate-limit-status Check if an endpoint's rate limit is throttling it · Get Throttling Status #
Ask an LLM
“Is an endpoint's rate limit slowing down delivery to it right now?”
“Why are webhooks to one endpoint arriving late — is it being throttled?”
Tell an agent
Check the throttling status of endpoint {endpoint_id} in app {app_id}.
Tell me if the rate limit is impacting delivery to endpoint {endpoint_id} of application {app_id}.
POST /api/v1/app/{app_id}/endpoint/{endpoint_id}/recover Resend failed webhooks to an endpoint · Recover Failed Webhooks #
Ask an LLM
“How do I retry all the webhooks that failed for an endpoint after fixing it?”
“Will recovering failed messages resend ones that eventually succeeded?”
Tell an agent
Recover all failed messages to endpoint {endpoint_id} in app {app_id} since {since}.
Resend only the failed webhooks for endpoint {endpoint_id} of app {app_id} between {since} and {until}.
POST /api/v1/app/{app_id}/endpoint/{endpoint_id}/send-example Send an example event to an endpoint · Send Event Type Example Message #
Ask an LLM
“Can I send a test webhook of a specific event type to an endpoint?”
“How do I check a receiver works using an event type's example payload?”
Tell an agent
Send an example {eventType} message to endpoint {endpoint_id} in app {app_id}.
Fire example number {exampleIndex} of event type {eventType} at endpoint {endpoint_id} on app {app_id}.

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-endpoint-api-openapi.yml

Other Resources

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