svix.com

Welcome to the Svix API documentation! Useful links: Homepage | Support email | Blog | Slack Community Introduction This is the reference documentation and schemas for the [Svix

🔑 bearer 52 endpoints

📄 Docs 📋 OpenAPI spec 🔬 Try in Swagger UI

SDKs by language (4 total)

svix-python-sdk

pip install svix-python-sdk

GitHub integration →

svix-typescript-sdk

npm install svix-typescript-sdk

GitHub integration →

svix-java-sdk

# Maven: see https://github.com/konfig-sdks/svix-java-sdk

GitHub integration →

svix-php

composer require svix-php

GitHub integration →

curl examples

List Applications

curl \
  -H "Authorization: Bearer $API_KEY" \
  /api/v1/app/

Health

curl \
  -H "Authorization: Bearer $API_KEY" \
  /api/v1/health/

List Event Types

curl \
  -H "Authorization: Bearer $API_KEY" \
  /api/v1/event-type/

Endpoints (52 total)

GET

/api/v1/app/

List Applications

GET

/api/v1/health/

Health

GET

/api/v1/event-type/

List Event Types

GET

/api/v1/app/{app_id}/

Get Application

GET

/api/v1/background-task/

List Background Tasks

GET

/api/v1/app/{app_id}/msg/

List Messages

GET

/api/v1/app/{app_id}/endpoint/

List Endpoints

GET

/api/v1/app/{app_id}/integration/

List Integrations

GET

/api/v1/app/{app_id}/msg/{msg_id}/

Get Message

GET

/api/v1/background-task/{task_id}/

Get Background Task

GET

/api/v1/event-type/{event_type_name}/

Get Event Type

GET

/api/v1/app/{app_id}/attempt/msg/{msg_id}/

List Attempts By Msg