Svix

Svix Message API

Messages are the webhook events being sent.

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

Operations 15

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}/msg List an application's messages · List Messages #
Ask an LLM
“How do I list the webhook messages sent for one application?”
“Can I list only messages created within a date window?”
Tell an agent
List messages for application {app_id}.
List app {app_id} messages created after {after} and before {before}.
POST /api/v1/app/{app_id}/msg Send a webhook message to an application · Create Message #
Ask an LLM
“How do I send a webhook event to all of a customer's endpoints with Svix?”
“Can I schedule a message to be delivered at a later time?”
Tell an agent
Send a {eventType} message to application {app_id} with payload {payload}.
Send event {eventType} to app {app_id} with payload {payload}, delivered at {deliverAt}.
POST /api/v1/app/{app_id}/msg/precheck/active Check if any endpoint listens for an event · Create Message Precheck #
Ask an LLM
“Is any active endpoint actually listening for this event type before I send it?”
“Can I check whether a message would reach anyone on a given channel?”
Tell an agent
Check whether app {app_id} has active endpoints for event type {eventType}.
Precheck if a {eventType} message to app {app_id} on channels {channels} would be delivered.
GET /api/v1/app/{app_id}/events Read the stream of created messages for an app · Message Events #
Ask an LLM
“How do I consume the feed of messages created for an application in order?”
“Can I read an app's message event stream from a certain point in time?”
Tell an agent
Read the message event stream for application {app_id}.
Read app {app_id}'s created-message feed from iterator {iterator}.
GET /api/v1/app/{app_id}/msg/{msg_id} Get a message by ID or event ID · Get Message #
Ask an LLM
“How do I look up a single message I sent?”
“Can I fetch a message using my own eventId instead of the Svix message id?”
Tell an agent
Get message {msg_id} in application {app_id}.
Fetch message {msg_id} from app {app_id} with its content.
DELETE /api/v1/app/{app_id}/msg/{msg_id}/content Delete one message's payload · Delete message payload #
Ask an LLM
“I sent a message with sensitive data by mistake — how do I wipe its payload?”
“Can a message still be replayed after its payload is deleted?”
Tell an agent destructive · confirm first
Delete the payload of message {msg_id} in application {app_id}.
Wipe the sensitive content from app {app_id} message {msg_id}.
POST /api/v1/app/{app_id}/msg/search Search an application's messages · Search Messages #
Ask an LLM
“How do I search an app's messages by tag, channel and date range in one request?”
“Can I search messages with criteria in a request body rather than query params?”
Tell an agent
Search app {app_id} messages tagged {tag}.
Search application {app_id} for messages on channel {channel} of event types {event_types}.
POST /api/v1/app/{app_id}/msg/expunge-all-contents Delete every message payload in an app · Expunge all message contents #
Ask an LLM
“How do I purge all message payloads stored for an application?”
“Which plan do I need to expunge all message contents at once?”
Tell an agent destructive · confirm first
Expunge all message contents for application {app_id}.
Start a background task to wipe every message payload in app {app_id}.
GET /api/v1/app/{app_id}/msg/{msg_id}/raw Get a message's raw payload · Get Raw Message Payload #
Ask an LLM
“How do I get the exact raw body that was sent for a message?”
“Can I pull just the unparsed payload of a message by its eventId?”
Tell an agent
Get the raw payload of message {msg_id} in application {app_id}.
Show the unparsed body for app {app_id} message {msg_id}.
POST /api/v1/app/{app_id}/endpoint/{endpoint_id}/msg/test-attempt Send a message to one endpoint and see the result · Create Message Attempt For Endpoint #
Ask an LLM
“How do I send a test message to a single endpoint and get its response back?”
“Can I deliver a message to just one endpoint instead of all of an app's endpoints?”
Tell an agent
Send a {eventType} test message with payload {payload} to endpoint {endpoint_id} in app {app_id}.
Try delivering {payload} as {eventType} to only endpoint {endpoint_id} of app {app_id} and show the response.
GET /api/v1/app/{app_id}/poller/{sink_id} Poll messages from a polling endpoint · Poller Poll #
Ask an LLM
“How do I pull messages from a polling endpoint instead of receiving pushes?”
“Can I poll only one event type from a polling endpoint?”
Tell an agent
Poll messages from polling endpoint {sink_id} in app {app_id}.
Poll app {app_id} polling endpoint {sink_id} for {event_type} messages from iterator {iterator}.
POST /api/v1/app/{app_id}/poller/{sink_id}/consumer/{consumer_id}/seek Set where a polling consumer starts reading · Poller Consumer Seek #
Ask an LLM
“How do I rewind a polling consumer to read messages from an earlier time?”
“Can I set the starting offset for a named consumer on a polling endpoint?”
Tell an agent
Seek consumer {consumer_id} on polling endpoint {sink_id} in app {app_id} to after {after}.
Reset app {app_id} poller {sink_id} consumer {consumer_id} to start from {after}.
GET /api/v1/app/{app_id}/poller/{sink_id}/consumer/{consumer_id} Poll messages with a server-tracked consumer · Poller Consumer Poll #
Ask an LLM
“How do I poll a polling endpoint and let the server remember my position?”
“Can several named consumers each track their own place on one polling endpoint?”
Tell an agent
Poll as consumer {consumer_id} from polling endpoint {sink_id} in app {app_id}.
Fetch the next {limit} messages for consumer {consumer_id} on app {app_id} poller {sink_id}.
GET /api/v1/app/{app_id}/polling-endpoint/{sink_id}/consumer/{consumer_id} Poll a sink with the v2 leased consumer · Pollerv2 Consumer Poll #
Ask an LLM
“How do I poll messages with a lease so they're redelivered if I don't commit?”
“Can the v2 polling endpoint start from the earliest or latest position?”
Tell an agent
Poll v2 polling endpoint {sink_id} in app {app_id} as consumer {consumer_id}.
Lease messages for {lease_duration_ms} ms as consumer {consumer_id} on app {app_id} polling endpoint {sink_id}.
POST /api/v1/app/{app_id}/polling-endpoint/{sink_id}/consumer/{consumer_id}/commit Acknowledge an offset for a v2 polling consumer · Pollerv2 Consumer Commit #
Ask an LLM
“How do I ack the messages I've processed from a v2 polling endpoint?”
“Can I commit an offset so my consumer doesn't get those messages again?”
Tell an agent
Commit offset {offset} for consumer {consumer_id} on polling endpoint {sink_id} in app {app_id}.
Ack up to offset {offset} for app {app_id} v2 poller {sink_id} consumer {consumer_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-message-api-openapi.yml

Other Resources

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