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 Webhook Endpoint API

Configure where operational webhooks are sent to.

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

Tagged areas include Webhook Endpoint. 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 9 operations across 5 paths, and defines 12 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.

9 operations 5 paths 12 schemas 1 DELETE4 GET2 POST2 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 Webhook 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 9

Across 5 paths, the API surfaces 9 operations — 1 DELETE, 4 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Webhook Endpoint 9

Configure where operational webhooks are sent to.

GET
/api/v1/operational-webhook/endpoint
List Operational Webhook Endpoints
v1.operational-webhook.endpoint.list 3 params → 200400401403404409422429
POST
/api/v1/operational-webhook/endpoint
Create Operational Webhook Endpoint
v1.operational-webhook.endpoint.create 1 param body → 201400401403404409422429
GET
/api/v1/operational-webhook/endpoint/{endpoint_id}
Get Operational Webhook Endpoint
v1.operational-webhook.endpoint.get 1 param → 200400401403404409422429
PUT
/api/v1/operational-webhook/endpoint/{endpoint_id}
Upsert Operational Webhook Endpoint
v1.operational-webhook.endpoint.update 1 param body → 200400401403404409422429
DELETE
/api/v1/operational-webhook/endpoint/{endpoint_id}
Delete Operational Webhook Endpoint
v1.operational-webhook.endpoint.delete 1 param → 204400401403404409422429
GET
/api/v1/operational-webhook/endpoint/{endpoint_id}/secret
Get Operational Webhook Endpoint Secret
v1.operational-webhook.endpoint.get-secret 1 param → 200400401403404409422429
POST
/api/v1/operational-webhook/endpoint/{endpoint_id}/secret/rotate
Rotate Operational Webhook Endpoint Secret
v1.operational-webhook.endpoint.rotate-secret 2 params body → 204400401403404409422429
GET
/api/v1/operational-webhook/endpoint/{endpoint_id}/headers
Get Operational Webhook Endpoint Headers
v1.operational-webhook.endpoint.get-headers 1 param → 200400401403404409422429
PUT
/api/v1/operational-webhook/endpoint/{endpoint_id}/headers
Set Operational Webhook Endpoint Headers
v1.operational-webhook.endpoint.update-headers 1 param body → 204400401403404409422429

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are OperationalWebhookEndpointOut (11 properties), OperationalWebhookEndpointIn (9 properties), OperationalWebhookEndpointUpdate (8 properties), ListResponse_OperationalWebhookEndpointOut_ (4 properties). Each schema is shown below with its type and property counts.

OperationalWebhookEndpointHeadersIn
object
1 property 1 required
ListResponse_OperationalWebhookEndpointOut_
object
4 properties 3 required
HttpErrorOut
object
2 properties 2 required
OperationalWebhookEndpointSecretOut
object
1 property 1 required
OperationalWebhookEndpointIn
object
9 properties 1 required
OperationalWebhookEndpointOut
object
11 properties 6 required
OperationalWebhookEndpointHeadersOut
object
2 properties 2 required
HTTPValidationError
object
1 property 1 required
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
OperationalWebhookEndpointUpdate
object
8 properties 1 required
Ordering
string
Defines the ordering in a listing of results.
OperationalWebhookEndpointSecretIn
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

svix-webhook-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 Endpoint API
Svix Environment API
Svix Event API
Svix Event Type API
Svix Health API
Svix Ingest Endpoint API
Svix Ingest Source API
Where this information came from

This is an independent, third-party profile of Svix Webhook 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.