Svix

Svix Application API

Consumer Applications are where messages are sent to. In most cases you would want to have one application for each of your users.

Documentation GitHub OpenAPI

Operations 9

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 List my applications · List Applications #

Ask an LLM

“Which applications — one per customer — exist in my Svix environment?”

“Can I leave out applications that have no endpoints yet?”

Tell an agent

List all my applications.

List applications, excluding those with no endpoints: {exclude_apps_with_no_endpoints}.

POST /api/v1/app Create an application for a customer · Create Application #

Ask an LLM

“How do I create an application to hold one customer's webhook endpoints?”

“Can creating an application return the existing one if that uid is already taken?”

Tell an agent

Create an application named {name}.

Create application {name} with uid {uid}, returning it if it already exists ({get_if_exists}).

GET /api/v1/app/{app_id} Get an application · Get Application #

Ask an LLM

“What name, uid and metadata does a given application have?”

“Can I fetch an application by my own uid rather than its Svix ID?”

Tell an agent

Show application {app_id}.

Fetch the details of app {app_id}.

PUT /api/v1/app/{app_id} Create or replace an application · Upsert Application #

Ask an LLM

“Can I upsert an application by ID so it's created if missing?”

“How do I replace all of an application's settings at once?”

Tell an agent

Upsert application {app_id} with the name {name}.

Create or fully replace app {app_id} as {name} with metadata {metadata}.

DELETE /api/v1/app/{app_id} Delete an application · Delete Application #

Ask an LLM

“How do I remove an application when a customer leaves?”

“Can I permanently delete an app and stop all its webhooks?”

Tell an agent destructive · confirm first

Delete application {app_id}.

Remove app {app_id} permanently.

PATCH /api/v1/app/{app_id} Change some fields of an application · Patch Application #

Ask an LLM

“Can I rename an application without resending its other settings?”

“How do I update just an app's metadata?”

Tell an agent

Rename application {app_id} to {name}.

Partially update app {app_id} with metadata {metadata}.

PATCH /api/v1/app/{app_id}/alert-email Set an application's alert email · Patch Alert Email #

Ask an LLM

“Where do delivery alerts for an application get emailed, and can I change it?”

“How do I set the alert email address for one customer's app?”

Tell an agent

Set the alert email of application {app_id} to {email}.

Send alerts for app {app_id} to {email}.

GET /api/v1/app/stats/count-active Count applications with an active endpoint · Count Active Apps #

Ask an LLM

“How many of my applications have at least one active endpoint?”

“Can I count active apps while ignoring Svix Play and disabled endpoints?”

Tell an agent

Count the apps that have at least one active endpoint.

Count active applications, excluding Svix Play endpoints: {exclude_svix_play}.

GET /api/v1/app/{app_id}/stats/attempts Get message attempt stats for an application · Get App Attempts Stats #

Ask an LLM

“How many delivery attempts did one application make over a time range?”

“Can I break an app's attempt statistics down to specific event types?”

Tell an agent

Show message attempt stats for app {app_id} from {since} to {until}.

Get attempt statistics for application {app_id} between {since} and {until}, only for {event_types}.

Svix Application API

Operations 9

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification