How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Svix Endpoint API

Endpoints are the URLs messages will be sent to. Each application can have up to 50 endpoints and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type).

Svix Endpoint API is one of 29 APIs that Svix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

This API exposes 35 operations across 22 paths, and defines 52 schemas. It is described by OpenAPI 3.2.0, at version 1.922.0.

Requests are made against 5 base URLs: https://api.eu.svix.com, https://api.us.svix.com, https://api.ca.svix.com, https://api.au.svix.com, https://api.in.svix.com.

35 operations 22 paths 52 schemas 3 DELETE15 GET3 PATCH9 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.922.0
Base URL
https://api.svix.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Svix Endpoint API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

  • HTTPBearer — HTTP Bearer token passed in the Authorization header

Paths & Operations 35

Across 22 paths, the API surfaces 35 operations — 3 DELETE, 15 GET, 3 PATCH, 9 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Endpoint 35

Endpoints are the URLs messages will be sent to. Each message sent to an application will be sent to all its endpoints (unless they are not subscribed to the sent event type).

GET
/api/v1/app/{app_id}/endpoint
List Endpoints
v1.endpoint.list 4 params → 200400401403404409422429
POST
/api/v1/app/{app_id}/endpoint
Create Endpoint
v1.endpoint.create 2 params body → 201400401403404409422429
GET
/api/v1/app/{app_id}/endpoint/{endpoint_id}
Get Endpoint
v1.endpoint.get 2 params → 200400401403404409422429
PUT
/api/v1/app/{app_id}/endpoint/{endpoint_id}
Upsert Endpoint
v1.endpoint.update 2 params body → 200201400401403404409422
DELETE
/api/v1/app/{app_id}/endpoint/{endpoint_id}
Delete Endpoint
v1.endpoint.delete 2 params → 204400401403404409422429
PATCH
/api/v1/app/{app_id}/endpoint/{endpoint_id}
Patch Endpoint
v1.endpoint.patch 2 params body → 200400401403404409422429
GET
/api/v1/app/{app_id}/endpoint/{endpoint_id}/connector
Get Endpoint Connector
v1.endpoint.get_connector 2 params → 200204400401403404409422
GET
/api/v1/app/{app_id}/sink
List Sinks
v1.sink.list 4 params → 200400401403404409422429
POST
/api/v1/app/{app_id}/sink
Create Sink
v1.sink.create 2 params body → 201400401403404409422429
GET
/api/v1/app/{app_id}/sink/{sink_id}
Get Sink
v1.sink.get 2 params → 200400401403404409422429
POST
/api/v1/app/{app_id}/endpoint/{endpoint_id}/cancel-msgs
Cancel Msgs
v1.endpoint.cancel-msgs 3 params body → 204400401403404409422429
GET
/api/v1/app/{app_id}/endpoint/{endpoint_id}/secret
Get Endpoint Secret
v1.endpoint.get-secret 2 params → 200400401403404409422429
POST
/api/v1/app/{app_id}/endpoint/{endpoint_id}/secret/rotate
Rotate Endpoint Secret Handler
v1.endpoint.rotate-secret 3 params body → 204400401403404409422429
GET
/api/v1/app/{app_id}/endpoint/{endpoint_id}/headers
Get Endpoint Headers
v1.endpoint.get-headers 2 params → 200400401403404409422429
PUT
/api/v1/app/{app_id}/endpoint/{endpoint_id}/headers
Set Endpoint Headers
v1.endpoint.update-headers 2 params body → 204400401403404409422429
PATCH
/api/v1/app/{app_id}/endpoint/{endpoint_id}/headers
Patch Endpoint Headers
v1.endpoint.patch-headers 2 params body → 204400401403404409422429
GET
/api/v1/app/{app_id}/endpoint/{endpoint_id}/transformation
Get Endpoint Transformation
v1.endpoint.transformation-get 2 params → 200400401403404409422429
PATCH
/api/v1/app/{app_id}/endpoint/{endpoint_id}/transformation
Patch Endpoint Transformation
v1.endpoint.patch-transformation 2 params body → 204400401403404409422429
POST
/api/v1/app/{app_id}/endpoint/{endpoint_id}/transformation/simulate
Simulate
v1.endpoint.transformation-simulate 3 params body → 200400401403404409422429
POST
/api/v1/app/{app_id}/endpoint/{endpoint_id}/replay-missing
Replay Missing Webhooks
v1.endpoint.replay-missing 3 params body → 202400401403404409422429
POST
/api/v1/app/{app_id}/endpoint/{endpoint_id}/bulk-replay
Bulk Replay Messages
v1.endpoint.bulk-replay 3 params body → 202400401403404409422429
GET
/api/v1/app/{app_id}/endpoint/{endpoint_id}/oauth
Get Endpoint Oauth Config
v1.endpoint.get-oauth 2 params → 200400401403404409422429
PUT
/api/v1/app/{app_id}/endpoint/{endpoint_id}/oauth
Set Endpoint Oauth Config
v1.endpoint.set-oauth-config 2 params body → 204400401403404409422429
DELETE
/api/v1/app/{app_id}/endpoint/{endpoint_id}/oauth
Delete Endpoint Oauth Config
v1.endpoint.delete-oauth-config 2 params → 204400401403404409422429
GET
/api/v1/app/{app_id}/endpoint/{endpoint_id}/oauth-config
Get Endpoint Oauth Config 2
v1.endpoint.get-oauth-2 2 params → 200400401403404409422429
GET
/api/v1/app/{app_id}/endpoint/{endpoint_id}/ca
Get Endpoint Server Ca
v1.endpoint.get-server-ca 2 params → 200400401403404409422429
PUT
/api/v1/app/{app_id}/endpoint/{endpoint_id}/ca
Set Endpoint Server Ca
v1.endpoint.set-server-ca 2 params body → 204400401403404409422429
GET
/api/v1/app/{app_id}/endpoint/{endpoint_id}/mtls
Get Endpoint Mtls Config
v1.endpoint.get-mtls 2 params → 200400401403404409422429
PUT
/api/v1/app/{app_id}/endpoint/{endpoint_id}/mtls
Set Endpoint Mtls Config
v1.endpoint.set-mtls-config 2 params body → 204400401403404409422429
DELETE
/api/v1/app/{app_id}/endpoint/{endpoint_id}/mtls
Delete Endpoint Mtls Config
v1.endpoint.delete-mtls-config 2 params → 204400401403404409422429
GET
/api/v1/app/{app_id}/endpoint/{endpoint_id}/mtls-config
Get Endpoint Mtls Config 2
v1.endpoint.get-mtls-2 2 params → 200400401403404409422429
GET
/api/v1/app/{app_id}/endpoint/{endpoint_id}/stats
Endpoint Stats
v1.endpoint.get-stats 4 params → 200400401403404409422429
GET
/api/v1/app/{app_id}/endpoint/{endpoint_id}/rate-limit-status
Get Throttling Status
v1.endpoint.get-throttling-status 2 params → 200400401403404409422429
POST
/api/v1/app/{app_id}/endpoint/{endpoint_id}/recover
Recover Failed Webhooks
v1.endpoint.recover 3 params body → 202400401403404409422429
POST
/api/v1/app/{app_id}/endpoint/{endpoint_id}/send-example
Send Event Type Example Message
v1.endpoint.send-example 3 params body → 202400401403404409422429

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are ConnectorOut (15 properties), EndpointOut (13 properties), EndpointIn (12 properties), SinkOut (11 properties). Each schema is shown below with its type and property counts.

TransformationSimulateIn
object
4 properties 3 required
EndpointMtlsConfigOut
object
RecoverOut
object
4 properties 4 required
Oauth2GrantTypeInOut
string
ListResponse_EndpointOut_
object
4 properties 3 required
EndpointIn
object
12 properties 1 required
EndpointOauthConfigIn
object
10 properties 4 required
ConnectorOut
object
15 properties 11 required
SinkOut
object
11 properties 5 required
EndpointSecretOut
object
1 property 1 required
EndpointPatch
object
11 properties
EndpointTransformationPatch
object
3 properties
EndpointMtlsConfigIn
object
1 property 1 required
EndpointRateLimitStatus
string
EndpointOut
object
13 properties 7 required
EndpointHeadersOut
object
The value of the headers is returned in the headers field. Sensitive headers that have been redacted are returned in the sensitive field.
2 properties 2 required
BulkReplayIn
object
7 properties 1 required
EndpointUpdate
object
10 properties 1 required
EndpointRateLimitStatusOut
object
2 properties 1 required
TransformationHttpMethod
string
SinkIn
object
9 properties
BackgroundTaskStatus
string
CancelMsgsIn
object
1 property 1 required
EventExampleIn
object
2 properties 1 required
ReplayIn
object
2 properties 1 required
EndpointServerCaIn
object
1 property
TransformationSimulateOut
object
4 properties 3 required
ReplayOut
object
4 properties 4 required
HttpErrorOut
object
2 properties 2 required
MessageStatus
integer
The sending status of the message: - Success = 0 - Pending = 1 - Fail = 2 - Sending = 3 - Canceled = 4
ClientSecretJwtParamsIn
object
4 properties 2 required
ListResponse_SinkOut_
object
4 properties 3 required
EndpointSecretRotateIn
object
2 properties
RecoverIn
object
2 properties 1 required
HTTPValidationError
object
1 property 1 required
BackgroundTaskType
string
ValidationError
object
Validation errors have their own schema to provide context for invalid requests eg. mismatched types and out of bounds values. There may be any number of these…
3 properties 3 required
EndpointOauthConfigOut
object
7 properties 4 required
StatusCodeClass
integer
The different classes of HTTP status codes: - CodeNone = 0 - Code1xx = 100 - Code2xx = 200 - Code3xx = 300 - Code4xx = 400 - Code5xx = 500
Ordering
string
Defines the ordering in a listing of results.
Oauth2AuthMethodInOut
string
The method used for authenticating to the OAuth authorization server. clientSecretJwt will construct a JWT used for authentication with the oauth authorization…
EndpointStats
object
5 properties 5 required
EndpointTransformationOut
object
4 properties
EndpointHeadersPatchIn
object
2 properties 1 required
EndpointHeadersIn
object
1 property 1 required
ConnectorKind
string
OauthJwsSigningAlgorithm
string
EndpointMtlsOut
object
2 properties 1 required
ConnectorProduct
string
EndpointOauthOut
object
2 properties 1 required
MessageOut
object
8 properties 4 required
EndpointServerCaOut
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

svix-endpoint-api-openapi.yml Raw ↑

Other APIs Svix publishes across the network.

Svix Open Source Server API
Svix Application API
Svix Authentication API
Svix Background Task API
Svix Connector API
Svix Environment API
Svix Event API
Svix Event Type API
Svix Health API
Svix Ingest Endpoint API
Svix Ingest Source API
Svix Integration API
Where this information came from

This is an independent, third-party profile of Svix Endpoint API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.