Open documentation ↗Overview
Webhooks as a Service
Svix is a development API from svix.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 52 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Development
- Version
- 1.4
- Endpoints
- 52
- OpenAPI
- Specification ↗
- Spec updated
- 2023-03-06
Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /api/v1/app/ | List Applications |
| POST | /api/v1/app/ | Create Application |
| GET | /api/v1/app/{app_id}/ | Get Application |
| PUT | /api/v1/app/{app_id}/ | Update Application |
| DELETE | /api/v1/app/{app_id}/ | Delete Application |
| GET | /api/v1/app/{app_id}/attempt/endpoint/{endpoint_id}/ | List Attempts By Endpoint |
| GET | /api/v1/app/{app_id}/attempt/msg/{msg_id}/ | List Attempts By Msg |
| GET | /api/v1/app/{app_id}/endpoint/ | List Endpoints |
| POST | /api/v1/app/{app_id}/endpoint/ | Create Endpoint |
| GET | /api/v1/app/{app_id}/endpoint/{endpoint_id}/ | Get Endpoint |
| PUT | /api/v1/app/{app_id}/endpoint/{endpoint_id}/ | Update Endpoint |
| DELETE | /api/v1/app/{app_id}/endpoint/{endpoint_id}/ | Delete Endpoint |
| GET | /api/v1/app/{app_id}/endpoint/{endpoint_id}/headers/ | Get Endpoint Headers |
| PUT | /api/v1/app/{app_id}/endpoint/{endpoint_id}/headers/ | Update Endpoint Headers |
| PATCH | /api/v1/app/{app_id}/endpoint/{endpoint_id}/headers/ | Patch Endpoint Headers |
| GET | /api/v1/app/{app_id}/endpoint/{endpoint_id}/msg/ | List Attempted Messages |
| POST | /api/v1/app/{app_id}/endpoint/{endpoint_id}/recover/ | Recover Failed Webhooks |
| POST | /api/v1/app/{app_id}/endpoint/{endpoint_id}/replay-missing/ | Replay Missing Webhooks |
| GET | /api/v1/app/{app_id}/endpoint/{endpoint_id}/secret/ | Get Endpoint Secret |
| POST | /api/v1/app/{app_id}/endpoint/{endpoint_id}/secret/rotate/ | Rotate Endpoint Secret |
| GET | /api/v1/app/{app_id}/endpoint/{endpoint_id}/stats/ | Get Endpoint Stats |
| GET | /api/v1/app/{app_id}/endpoint/{endpoint_id}/transformation/ | Get Endpoint Transformation |
| PATCH | /api/v1/app/{app_id}/endpoint/{endpoint_id}/transformation/ | Set Endpoint Transformation |
| GET | /api/v1/app/{app_id}/integration/ | List Integrations |
| POST | /api/v1/app/{app_id}/integration/ | Create Integration |
| GET | /api/v1/app/{app_id}/integration/{integ_id}/ | Get Integration |
| PUT | /api/v1/app/{app_id}/integration/{integ_id}/ | Update Integration |
| DELETE | /api/v1/app/{app_id}/integration/{integ_id}/ | Delete Integration |
| GET | /api/v1/app/{app_id}/integration/{integ_id}/key/ | Get Integration Key |
| POST | /api/v1/app/{app_id}/integration/{integ_id}/key/rotate/ | Rotate Integration Key |
| GET | /api/v1/app/{app_id}/msg/ | List Messages |
| POST | /api/v1/app/{app_id}/msg/ | Create Message |
| GET | /api/v1/app/{app_id}/msg/{msg_id}/ | Get Message |
| GET | /api/v1/app/{app_id}/msg/{msg_id}/attempt/deprecated | List Attempts |
| GET | /api/v1/app/{app_id}/msg/{msg_id}/attempt/{attempt_id}/ | Get Attempt |
| DELETE | /api/v1/app/{app_id}/msg/{msg_id}/attempt/{attempt_id}/content/ | Delete attempt response body |
| DELETE | /api/v1/app/{app_id}/msg/{msg_id}/content/ | Delete message payload |
| GET | /api/v1/app/{app_id}/msg/{msg_id}/endpoint/ | List Attempted Destinations |
| GET | /api/v1/app/{app_id}/msg/{msg_id}/endpoint/{endpoint_id}/attempt/deprecated | List Attempts For Endpoint |
| POST | /api/v1/app/{app_id}/msg/{msg_id}/endpoint/{endpoint_id}/resend/ | Resend Webhook |
| POST | /api/v1/auth/app-portal-access/{app_id}/ | Get Consumer App Portal Access |
| POST | /api/v1/auth/app/{app_id}/expire-all/ | Expire All |
| POST | /api/v1/auth/dashboard-access/{app_id}/deprecated | Get Dashboard Access |
| POST | /api/v1/auth/logout/ | Logout |
| GET | /api/v1/background-task/ | List Background Tasks |
| GET | /api/v1/background-task/{task_id}/ | Get Background Task |
| GET | /api/v1/event-type/ | List Event Types |
| POST | /api/v1/event-type/ | Create Event Type |
| GET | /api/v1/event-type/{event_type_name}/ | Get Event Type |
| PUT | /api/v1/event-type/{event_type_name}/ | Update Event Type |
| DELETE | /api/v1/event-type/{event_type_name}/ | Archive Event Type |
| GET | /api/v1/health/ | Health |
Questions
Does the Svix API need an API key?
Yes. The Svix API uses API key authentication; the documentation explains how to get credentials.
Does the Svix API support HTTPS?
Yes, the Svix API is served over HTTPS.
How many endpoints does the Svix API have?
Its OpenAPI description lists 52 endpoints in version 1.4. All of them are shown on this page.
What are alternatives to the Svix API?
Other Development APIs include Cloudflare, Azure DevOps, IPify, App Store Connect API, StackExchange.
Similar development APIs
Compare alternatives →Cloudflare
DevelopmentManage DNS, CDN, Workers and other services; documented with an official OpenAPI 3.0 spec
API key
Azure DevOps
DevelopmentThe Azure DevOps basic components of a REST API request/response pair
API key
IPify
DevelopmentA simple IP Address API
No auth
App Store Connect API
DevelopmentThe data structure that represents an app store connect api resource.
Bearer token252 endpoints
StackExchange
DevelopmentQ&A forum for developers
OAuth124 endpoints
IPinfo
DevelopmentAnother simple IP Address API
No auth
Listed from public-apis database (MIT), APIs.guru (CC0).