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 Sink API

The Webhook Sink API from Svix — 10 operation(s) for webhook sink.

Svix Webhook Sink 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 Sink. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 16 operations across 10 paths, and defines 47 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.

16 operations 10 paths 47 schemas 1 DELETE7 GET3 PATCH4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.922.0
Base URL
http://localhost:8071
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Svix Webhook Sink 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 16

Across 10 paths, the API surfaces 16 operations — 1 DELETE, 7 GET, 3 PATCH, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Webhook Sink 16
GET
/api/v1/app/{app_id}/stream/sink
List Sinks
v1.app.stream.sink.list 4 params → 200400401403404409422429
POST
/api/v1/app/{app_id}/stream/sink
Create Sink
v1.app.stream.sink.create 2 params body → 201400401403404409422429
GET
/api/v1/app/{app_id}/stream/sink/{sink_id}
Get Sink
v1.app.stream.sink.get 2 params → 200400401403404409422429
PUT
/api/v1/app/{app_id}/stream/sink/{sink_id}
Upsert Sink
v1.app.stream.sink.upsert 2 params body → 200201400401403404409422
DELETE
/api/v1/app/{app_id}/stream/sink/{sink_id}
Delete Sink
v1.app.stream.sink.delete 2 params → 204400401403404409422429
PATCH
/api/v1/app/{app_id}/stream/sink/{sink_id}
Patch Sink
v1.app.stream.sink.patch 2 params body → 200400401403404409422429
GET
/api/v1/app/{app_id}/stream/sink/{sink_id}/transformation
Get Sink Transformation
v1.app.stream.sink-transformation-get 2 params → 200400401403404409422429
PATCH
/api/v1/app/{app_id}/stream/sink/{sink_id}/transformation
Set Sink Transformation
v1.app.stream.sink.transformation-partial-update 2 params body → 200400401403404409422429
GET
/api/v1/app/{app_id}/stream/sink/{sink_id}/secret
Get Sink Secret
v1.app.stream.sink.get-secret 2 params → 200400401403404409422429
POST
/api/v1/app/{app_id}/stream/sink/{sink_id}/secret/rotate
Rotate Sink Secret
v1.app.stream.sink.rotate-secret 3 params body → 200400401403404409422429
GET
/api/v1/app/{app_id}/stream/sink/{sink_id}/headers
Get Sink Headers
v1.app.stream.sink.headers-get 2 params → 200400401403404409422429
PATCH
/api/v1/app/{app_id}/stream/sink/{sink_id}/headers
Patch Sink Headers
v1.app.stream.sink.headers-patch 2 params body → 200400401403404409422429
POST
/api/v1/app/{app_id}/stream/sink/{sink_id}/force-retry
Force Retry Sink
v1.app.stream.sink.force-retry 3 params → 204400401403404409422429
GET
/api/v1/app/{app_id}/stream/sink/{sink_id}/last-acked-event
Get Last Acked Event
v1.app.stream.sink.get-last-acked-event 2 params → 200400401403404409422429
GET
/api/v1/app/{app_id}/stream/sink/{sink_id}/next-event
Get Next Stream Sink Event
v1.app.stream.sink.next-event 2 params → 200400401403404409422429
POST
/api/v1/app/{app_id}/stream/sink/{sink_id}/skip
Skip N Events
v1.app.stream.sink.skip 4 params body → 204400401403404409422429

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are StreamSinkOut (12 properties), RedshiftConfig (9 properties), StreamSinkIn (6 properties), SnowflakeConfig (6 properties). Each schema is shown below with its type and property counts.

HttpPatchConfig
object
1 property
RedshiftPatchConfig
object
6 properties
AmazonS3PatchConfig
object
5 properties
BigQueryConfig
object
Configuration for a Google Cloud BigQuery sink.
4 properties 4 required
SnsConfig
object
Configuration for a SNS sink.
5 properties 4 required
RabbitMqConfig
object
Configuration for a RabbitMq sink.
2 properties 2 required
SqsConfig
object
Configuration for an SQS sink.
5 properties 4 required
SinkHttpConfig
object
3 properties 1 required
StreamSinkOut
object
12 properties 8 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
S3Config
object
5 properties 4 required
SinkStatusIn
string
RedshiftConfig
object
Configuration parameters for defining a Redshift sink. For provisioned clusters, set clusteridentifier and dbuser. For Redshift Serverless, set workgroupname.
9 properties 3 required
GoogleCloudPubSubPatchConfig
object
3 properties
GoogleCloudPubSubConfig
object
3 properties 3 required
SnsPatchConfig
object
5 properties
SinkTransformIn
object
1 property
OtelTracingPatchConfig
object
1 property
EventBridgePatchConfig
object
5 properties
SinkOtelV1Config
object
2 properties 1 required
SqsPatchConfig
object
5 properties
ClickhouseConfig
object
5 properties 4 required
AzureBlobStoragePatchConfig
object
3 properties
RabbitMqPatchConfig
object
2 properties
AzureBlobStorageConfig
object
3 properties 3 required
SnowflakePatchConfig
object
6 properties
EmptyResponse
object
ClickhousePatchConfig
object
5 properties
SinkSecretOut
object
1 property
StreamSinkPatch
object
6 properties
HttpErrorOut
object
2 properties 2 required
SinkStatus
string
EventBridgeConfig
object
5 properties 4 required
SinkTransformationOut
object
2 properties 1 required
EndpointSecretRotateIn
object
2 properties
GoogleCloudStorageConfig
object
Configuration for a Google Cloud Storage sink. Write stream events into the named bucket using the supplied Google Cloud credentials.
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
Ordering
string
Defines the ordering in a listing of results.
GoogleCloudStoragePatchConfig
object
2 properties
EventOut
object
3 properties 3 required
HttpSinkHeadersPatchIn
object
1 property 1 required
SnowflakeConfig
object
Configuration parameters for defining a Snowflake sink.
6 properties 3 required
BigQueryPatchConfig
object
4 properties
SkipParams
object
1 property
ListResponse_StreamSinkOut_
object
4 properties 3 required
StreamSinkIn
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

svix-webhook-sink-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 Sink 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.