Svix

Svix Event Type API

Event types are identifiers denoting the type of message being sent. Event types are primarily used to decide which events are sent to which endpoint.

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

Operations 10

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/event-type List webhook event types · List Event Types #
Ask an LLM
“What event types have I defined for my webhooks?”
“Can I include archived event types when listing them?”
Tell an agent
List my webhook event types.
List event types including archived ones, up to {limit}.
POST /api/v1/event-type Create or unarchive an event type · Create Event Type #
Ask an LLM
“How do I register a new webhook event type like invoice.paid in Svix?”
“Can I bring back an archived event type so messages can use it again?”
Tell an agent
Create event type {name} described as {description}.
Create event type {name} with description {description} in group {groupName}.
POST /api/v1/event-type/import/openapi Import event types from an OpenAPI spec · Event Type Import From Openapi #
Ask an LLM
“How do I create event types from the webhooks section of my OpenAPI document?”
“Can I dry-run an OpenAPI import to see which event types would change?”
Tell an agent
Import event types from OpenAPI spec {spec}.
Dry-run an event type import from this raw OpenAPI spec: {specRaw}.
GET /api/v1/event-type/{event_type_name} Get an event type · Get Event Type #
Ask an LLM
“What schema and description does a given event type have?”
“Is a specific event type archived or deprecated?”
Tell an agent
Get event type {event_type_name}.
Show the details and schemas of event type {event_type_name}.
PUT /api/v1/event-type/{event_type_name} Create or replace an event type · Upsert Event Type #
Ask an LLM
“How do I upsert an event type by name, creating it if it's missing?”
“Can I replace an event type's description and schemas in one call?”
Tell an agent
Upsert event type {event_type_name} with description {description}.
Replace event type {event_type_name} with description {description} and schemas {schemas}.
DELETE /api/v1/event-type/{event_type_name} Archive or expunge an event type · Delete Event Type #
Ask an LLM
“How do I retire an event type so no new messages can be sent with it?”
“Can I permanently expunge an event type instead of just archiving it?”
Tell an agent destructive · confirm first
Archive event type {event_type_name}.
Permanently expunge event type {event_type_name}.
PATCH /api/v1/event-type/{event_type_name} Partially update an event type · Patch Event Type #
Ask an LLM
“How do I mark an existing event type as deprecated?”
“Can I change only an event type's group name?”
Tell an agent
Mark event type {event_type_name} deprecated.
Patch event type {event_type_name} to move it into group {groupName}.
GET /api/v1/event-type/{event_type_name}/retry-schedule Get an event type's retry schedule · Get Retry Schedule #
Ask an LLM
“How often are failed deliveries of a particular event type retried?”
“Does this event type have its own retry schedule?”
Tell an agent
Get the retry schedule for event type {event_type_name}.
Show how messages of {event_type_name} get retried.
PUT /api/v1/event-type/{event_type_name}/retry-schedule Set an event type's retry schedule · Set Retry Schedule #
Ask an LLM
“How do I give one event type a custom retry schedule?”
“Can I make failed messages of a specific event type retry faster?”
Tell an agent
Set the retry schedule for event type {event_type_name} to {retrySchedule}.
Retry {event_type_name} messages on the schedule {retrySchedule}.
POST /api/v1/event-type/export/openapi Export event types as an OpenAPI document · Event Type Export From Openapi #
Ask an LLM
“How do I export all my event type schemas as an OpenAPI file?”
“Can I generate an OpenAPI document from the event types I've defined?”
Tell an agent
Export my event types to OpenAPI.
Start a background task that builds an OpenAPI spec from my event type schemas.

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

Other Resources

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