Svix

Delete an application. via DELETE /api/v1/app/{app_id}

Delete a destination. via DELETE /api/v1/app/{app_id}/destination/{destination_id}

Delete an endpoint. via DELETE /api/v1/app/{app_id}/endpoint/{endpoint_id}

Delete an integration. via DELETE /api/v1/app/{app_id}/integration/{integ_id}

Deletes the given attempt's response body. Useful when an endpoint accidentally returned sensitive content. The message can't be replayed or resent once its payload has been deleted or expired. via DELETE /api/v1/app/{app_id}/msg/{msg_id}/attempt/{attempt_id}/content

Delete the given message's payload. Useful in cases when a message was accidentally sent with sensitive content. The message can't be replayed or resent once its payload has been deleted (or has expired). via DELETE /api/v1/app/{app_id}/msg/{msg_id}/content

Delete a connector. via DELETE /api/v1/connector/{connector_id}

Archive an event type. Endpoints already configured to filter on an event type will continue to do so after archival. However, new messages can not be sent with it and endpoints can not filter on it. An event type can be unarchived with the create operation. via DELETE /api/v1/event-type/{event_type_name}

Delete an operational webhook endpoint. via DELETE /api/v1/operational-webhook/endpoint/{endpoint_id}

Delete a stream. via DELETE /api/v1/stream/{stream_id}

Delete a sink. via DELETE /api/v1/stream/{stream_id}/sink/{sink_id}

Delete an event type. via DELETE /api/v1/stream/event-type/{name}

Delete an Ingest Source. via DELETE /ingest/api/v1/source/{source_id}

Delete an ingest endpoint. via DELETE /ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}

List of all the organization's applications. via GET /api/v1/app

Get an application. via GET /api/v1/app/{app_id}

List attempts by endpoint id Note that by default this endpoint is limited to retrieving 90 days' worth of data relative to now or, if an iterator is provided, 90 days before/after the time indicated by the iterator ID. If you require data beyond those time ranges, you will need to explicitly set the `before` or `after` parameter as appropriate. via GET /api/v1/app/{app_id}/attempt/endpoint/{endpoint_id}

List attempts by message ID. Note that by default this endpoint is limited to retrieving 90 days' worth of data relative to now or, if an iterator is provided, 90 days before/after the time indicated by the iterator ID. If you require data beyond those time ranges, you will need to explicitly set the `before` or `after` parameter as appropriate. via GET /api/v1/app/{app_id}/attempt/msg/{msg_id}

List of all the application's destinations. via GET /api/v1/app/{app_id}/destination

Get a destination by id or uid. via GET /api/v1/app/{app_id}/destination/{destination_id}

Get the transformation code associated with this destination. via GET /api/v1/app/{app_id}/destination/{destination_id}/transformation

List the application's endpoints. via GET /api/v1/app/{app_id}/endpoint

Get an endpoint. via GET /api/v1/app/{app_id}/endpoint/{endpoint_id}

Get the additional headers to be sent with the webhook. via GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/headers

List messages for a particular endpoint. Additionally includes metadata about the latest message attempt. The `before` parameter lets you filter all items created before a certain date and is ignored if an iterator is passed. Note that by default this endpoint is limited to retrieving 90 days' worth of data relative to now or, if an iterator is provided, 90 days before/after the time indicated by the iterator ID. If you require data beyond those time ranges, you will need to explicitly set the `before` or `after` parameter as appropriate. via GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/msg

Get the endpoint's signing secret. This is used to verify the authenticity of the webhook. For more information please refer to the consuming webhooks docs. via GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/secret

Get basic statistics for the endpoint. via GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/stats

Get the transformation code associated with this endpoint. via GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/transformation

List the application's integrations. via GET /api/v1/app/{app_id}/integration

Get an integration. via GET /api/v1/app/{app_id}/integration/{integ_id}

List all of the application's messages. The `before` and `after` parameters let you filter all items created before or after a certain date. These can be used alongside an iterator to paginate over results within a certain window. Note that by default this endpoint is limited to retrieving 90 days' worth of data relative to now or, if an iterator is provided, 90 days before/after the time indicated by the iterator ID. If you require data beyond those time ranges, you will need to explicitly set the `before` or `after` parameter as appropriate. via GET /api/v1/app/{app_id}/msg

Get a message by its ID or eventID. via GET /api/v1/app/{app_id}/msg/{msg_id}

`msg_id`: Use a message id or a message `eventId` via GET /api/v1/app/{app_id}/msg/{msg_id}/attempt/{attempt_id}

List endpoints attempted by a given message. Additionally includes metadata about the latest message attempt. By default, endpoints are listed in ascending order by ID. via GET /api/v1/app/{app_id}/msg/{msg_id}/endpoint

Reads the stream of created messages for an application, filtered on the Sink's event types and Channels. Plan: polling endpoints are an Enterprise feature (svix.com/pricing, fetched 2026-09-13). via GET /api/v1/app/{app_id}/poller/{sink_id}

Reads the stream of created messages for an application, filtered on the Sink's event types and Channels, using server-managed iterator tracking. Plan: polling endpoints are an Enterprise feature (svix.com/pricing, fetched 2026-09-13). via GET /api/v1/app/{app_id}/poller/{sink_id}/consumer/{consumer_id}

Get the current auth token for the stream poller. via GET /api/v1/auth/stream/{stream_id}/sink/{sink_id}/poller/token

List background tasks executed in the past 90 days. via GET /api/v1/background-task

Get a background task by ID. via GET /api/v1/background-task/{task_id}

List all connectors for an application. via GET /api/v1/connector

Get a connector. via GET /api/v1/connector/{connector_id}

Return the list of event types. via GET /api/v1/event-type

Get an event type. via GET /api/v1/event-type/{event_type_name}

Verify the API server is up and running. via GET /api/v1/health

List operational webhook endpoints. via GET /api/v1/operational-webhook/endpoint

Get an operational webhook endpoint. via GET /api/v1/operational-webhook/endpoint/{endpoint_id}

Get the additional headers to be sent with the operational webhook. via GET /api/v1/operational-webhook/endpoint/{endpoint_id}/headers

Get an operational webhook endpoint's signing secret. This is used to verify the authenticity of the webhook. For more information please refer to the consuming webhooks docs. via GET /api/v1/operational-webhook/endpoint/{endpoint_id}/secret

List of all the organization's streams. via GET /api/v1/stream

Get a stream by id or uid. via GET /api/v1/stream/{stream_id}

List of all the stream's sinks. via GET /api/v1/stream/{stream_id}/sink

Get a sink by id or uid. via GET /api/v1/stream/{stream_id}/sink/{sink_id}

Iterate over a stream of events. The sink must be of type `poller` to use the poller endpoint. via GET /api/v1/stream/{stream_id}/sink/{sink_id}/events

Get the HTTP sink headers. Only valid for `http` or `otelTracing` sinks. via GET /api/v1/stream/{stream_id}/sink/{sink_id}/headers

Get the sink's signing secret (only supported for http sinks) This is used to verify the authenticity of the delivery. For more information please refer to the consuming webhooks docs. via GET /api/v1/stream/{stream_id}/sink/{sink_id}/secret

Get the transformation code associated with this sink. via GET /api/v1/stream/{stream_id}/sink/{sink_id}/transformation

List of all the organization's event types for streaming. via GET /api/v1/stream/event-type

Get an event type. via GET /api/v1/stream/event-type/{name}

List of all the organization's Ingest Sources. via GET /ingest/api/v1/source

Get an Ingest Source by id or uid. via GET /ingest/api/v1/source/{source_id}

List ingest endpoints. via GET /ingest/api/v1/source/{source_id}/endpoint

Get an ingest endpoint. via GET /ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}

Get the additional headers to be sent with the ingest. via GET /ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}/headers

Get an ingest endpoint's signing secret. This is used to verify the authenticity of the webhook. For more information please refer to the consuming webhooks docs. via GET /ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}/secret

Get the transformation code associated with this ingest endpoint. via GET /ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}/transformation

Partially update an application. via PATCH /api/v1/app/{app_id}

Partially update a destination. Plan: polling, FIFO, message-broker and database destination types are Enterprise features (svix.com/pricing, fetched 2026-09-13); the error a lower plan receives is unmeasured. via PATCH /api/v1/app/{app_id}/destination/{destination_id}

Set or unset the transformation code associated with this destination. via PATCH /api/v1/app/{app_id}/destination/{destination_id}/transformation

Partially update an endpoint. via PATCH /api/v1/app/{app_id}/endpoint/{endpoint_id}

Partially set the additional headers to be sent with the webhook. via PATCH /api/v1/app/{app_id}/endpoint/{endpoint_id}/headers

Set or unset the transformation code associated with this endpoint. via PATCH /api/v1/app/{app_id}/endpoint/{endpoint_id}/transformation

Partially update a connector. via PATCH /api/v1/connector/{connector_id}

Partially update an event type. via PATCH /api/v1/event-type/{event_type_name}

Partially update a stream. via PATCH /api/v1/stream/{stream_id}

Partially update a sink. via PATCH /api/v1/stream/{stream_id}/sink/{sink_id}

Updates the Sink's headers. Only valid for `http` or `otelTracing` sinks. via PATCH /api/v1/stream/{stream_id}/sink/{sink_id}/headers

Set or unset the transformation code associated with this sink. via PATCH /api/v1/stream/{stream_id}/sink/{sink_id}/transformation

Patch an event type for Streams. via PATCH /api/v1/stream/event-type/{name}

Set or unset the transformation code associated with this ingest endpoint. via PATCH /ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}/transformation

Create a new application. via POST /api/v1/app

Create an AutoConfig subscription. via POST /api/v1/app/{app_id}/autoconfig

Rotate the auth token and signing secret for an AutoConfig subscription. via POST /api/v1/app/{app_id}/autoconfig/{autoconfig_id}/rotate

Creates a new destination. Plan: polling, FIFO, message-broker and database destination types are Enterprise features (svix.com/pricing, fetched 2026-09-13); the error a lower plan receives is unmeasured. via POST /api/v1/app/{app_id}/destination

Create a new endpoint for the application. When `secret` is `null` the secret is automatically generated (recommended). via POST /api/v1/app/{app_id}/endpoint

Bulk replay messages sent to the endpoint. Only messages that were created after `since` will be sent. This will replay both successful, and failed messages A completed task will return a payload like the following: { "id": "qtask_33qen93MNuelBAq1T9G7eHLJRsF", "status": "finished", "task": "endpoint.bulk-replay", "data": { "messagesSent": 2 } } via POST /api/v1/app/{app_id}/endpoint/{endpoint_id}/bulk-replay

Resend all failed messages since a given time. Messages that were sent successfully, even if failed initially, are not resent. A completed task will return a payload like the following: { "id": "qtask_33qen93MNuelBAq1T9G7eHLJRsF", "status": "finished", "task": "endpoint.recover", "data": { "messagesSent": 2 } } via POST /api/v1/app/{app_id}/endpoint/{endpoint_id}/recover

Replays messages to the endpoint. Only messages that were created after `since` will be sent. Messages that were previously sent to the endpoint are not resent. A completed task will return a payload like the following: { "id": "qtask_33qen93MNuelBAq1T9G7eHLJRsF", "status": "finished", "task": "endpoint.replay", "data": { "messagesSent": 2 } } via POST /api/v1/app/{app_id}/endpoint/{endpoint_id}/replay-missing

Rotates the endpoint's signing secret. The previous secret will remain valid for the specified grace period (default 24 hours). via POST /api/v1/app/{app_id}/endpoint/{endpoint_id}/secret/rotate

Send an example message for an event. via POST /api/v1/app/{app_id}/endpoint/{endpoint_id}/send-example

Create an integration. via POST /api/v1/app/{app_id}/integration

Rotate the integration's key. The previous key will be immediately revoked. via POST /api/v1/app/{app_id}/integration/{integ_id}/key/rotate

Creates a new message and dispatches it to all of the application's endpoints. The `eventId` is an optional custom unique ID. It's verified to be unique only up to a day, after that no verification will be made. If a message with the same `eventId` already exists for the application, a 409 conflict error will be returned. The `eventType` indicates the type and schema of the event. All messages of a certain `eventType` are expected to have the same schema. Endpoints can choose to only listen to specific event types. Messages can also have `channels`, which similar to event types let endpoints filter by them. Unlike event types, messages can have multiple channels, and channels don't imply a specific message content or schema. The `payload` property is the webhook's body (the actual webhook message). Svix supports payload sizes of up to 1MiB, though it's generally a good idea to keep webhook payloads small, probably no larger than 40kb. via POST /api/v1/app/{app_id}/msg

Delete the payloads from the given messages under the current application Useful in cases when a message was accidentally sent with sensitive content. A message can't be replayed or resent once its payload has been deleted (or has expired). via POST /api/v1/app/{app_id}/msg/bulk-expunge

Resend a message to the specified endpoint. via POST /api/v1/app/{app_id}/msg/{msg_id}/endpoint/{endpoint_id}/resend

Delete all message payloads for the application. This operation is only available in the Enterprise plan. A completed task will return a payload like the following: { "id": "qtask_33qen93MNuelBAq1T9G7eHLJRsF", "status": "finished", "task": "application.purge_content", "data": { "messagesPurged": 150 } } via POST /api/v1/app/{app_id}/msg/expunge-all-contents

A pre-check call for `message.create` that checks whether any active endpoints are listening to this message. Note: most people shouldn't be using this API. Svix doesn't bill you for messages not actually sent, so using this API doesn't save money. If unsure, please ask Svix support before using this API. via POST /api/v1/app/{app_id}/msg/precheck/active

Sets the starting offset for the consumer of a polling endpoint. Plan: polling endpoints are an Enterprise feature (svix.com/pricing, fetched 2026-09-13). via POST /api/v1/app/{app_id}/poller/{sink_id}/consumer/{consumer_id}/seek

Expire all of the tokens associated with a specific application. via POST /api/v1/auth/app/{app_id}/expire-all

Use this function to get magic links (and authentication codes) for connecting your users to the Consumer Application Portal. via POST /api/v1/auth/app-portal-access/{app_id}

Logout an app token. Trying to log out other tokens will fail. via POST /api/v1/auth/logout. WITHHELD: Svix only lets that token log itself out, and this connection holds an environment API key (Svix answers 403), so this call is refused before any request is made.

Expire all of the tokens associated with a specific stream. via POST /api/v1/auth/stream/{stream_id}/expire-all

Create a new auth token for the stream poller API. via POST /api/v1/auth/stream/{stream_id}/sink/{sink_id}/poller/token/rotate

Logout a stream token. Trying to log out other tokens will fail. via POST /api/v1/auth/stream-logout. WITHHELD: Svix only lets that token log itself out, and this connection holds an environment API key (Svix answers 403), so this call is refused before any request is made.

Use this function to get magic links (and authentication codes) for connecting your users to the Stream Consumer Portal. via POST /api/v1/auth/stream-portal-access/{stream_id}

Create a new connector. via POST /api/v1/connector

Download a JSON file containing all org-settings and event types. Note that the schema for [`EnvironmentOut`] is subject to change. The fields herein are provided for convenience but should be treated as JSON blobs. via POST /api/v1/environment/export

Import a configuration into the active organization. It doesn't delete anything, only adds / updates what was passed to it. Note that the schema for [`EnvironmentIn`] is subject to change. The fields herein are provided for convenience but should be treated as JSON blobs. via POST /api/v1/environment/import

Create new or unarchive existing event type. Unarchiving an event type will allow endpoints to filter on it and messages to be sent with it. Endpoints filtering on the event type before archival will continue to filter on it. This operation does not preserve the description and schemas. via POST /api/v1/event-type

Given an OpenAPI spec, create new or update existing event types. If an existing `archived` event type is updated, it will be unarchived. The importer will convert all webhooks found in the either the `webhooks` or `x-webhooks` top-level. via POST /api/v1/event-type/import/openapi

Create an operational webhook endpoint. via POST /api/v1/operational-webhook/endpoint

Rotates an operational webhook endpoint's signing secret. The previous secret will remain valid for the specified grace period (default 24 hours). via POST /api/v1/operational-webhook/endpoint/{endpoint_id}/secret/rotate

Creates a background task to calculate the number of message attempts (`messageDestinations`) made for all applications in the environment. Note that this endpoint is asynchronous. You will need to poll the `Get Background Task` endpoint to retrieve the results of the operation. The completed background task will return a payload like the following: { "id": "qtask_33qe39Stble9Rn3ZxFrqL5ZSsjT", "status": "finished", "task": "application.stats", "data": { "appStats": [ { "messageDestinations": 2, "appId": "app_33W1An2Zz5cO9SWbhHsYyDmVC6m", "appUid": null } ] } } via POST /api/v1/stats/usage/app

Creates a new stream. via POST /api/v1/stream

Creates events on the Stream. via POST /api/v1/stream/{stream_id}/events

Creates a new sink. via POST /api/v1/stream/{stream_id}/sink

Rotates the signing secret (only supported for http sinks). via POST /api/v1/stream/{stream_id}/sink/{sink_id}/secret/rotate

Create an event type for Streams. via POST /api/v1/stream/event-type

Create Ingest Source. via POST /ingest/api/v1/source

Get access to the Ingest Source Consumer Portal. via POST /ingest/api/v1/source/{source_id}/dashboard

Create an ingest endpoint. via POST /ingest/api/v1/source/{source_id}/endpoint

Rotates an ingest endpoint's signing secret. The previous secret will remain valid for the specified grace period (default 24 hours). via POST /ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}/secret/rotate

Rotate the Ingest Source's Url Token. This will rotate the ingest source's token, which is used to construct the unique `ingestUrl` for the source. Previous tokens will remain valid for 48 hours after rotation. The token can be rotated a maximum of three times within the 48-hour period. via POST /ingest/api/v1/source/{source_id}/token/rotate

Create or update an application. via PUT /api/v1/app/{app_id}

Create or update a destination. Plan: polling, FIFO, message-broker and database destination types are Enterprise features (svix.com/pricing, fetched 2026-09-13); the error a lower plan receives is unmeasured. via PUT /api/v1/app/{app_id}/destination/{destination_id}

Create or update an endpoint. via PUT /api/v1/app/{app_id}/endpoint/{endpoint_id}

Set the additional headers to be sent with the webhook. via PUT /api/v1/app/{app_id}/endpoint/{endpoint_id}/headers

Update an integration. via PUT /api/v1/app/{app_id}/integration/{integ_id}

Create or update a connector. via PUT /api/v1/connector/{connector_id}

Create or update an event type. via PUT /api/v1/event-type/{event_type_name}

Create or update an operational webhook endpoint. via PUT /api/v1/operational-webhook/endpoint/{endpoint_id}

Set the additional headers to be sent with the operational webhook. via PUT /api/v1/operational-webhook/endpoint/{endpoint_id}/headers

Creates a background task to calculate the listed event types for all apps in the organization. Note that this endpoint is asynchronous. You will need to poll the `Get Background Task` endpoint to retrieve the results of the operation. The completed background task will return a payload like the following: { "id": "qtask_33qe39Stble9Rn3ZxFrqL5ZSsjT", "status": "finished", "task": "event-type.aggregate", "data": { "event_types": [ { "appId": "app_33W1An2Zz5cO9SWbhHsYyDmVC6m", "explicitlySubscribedEventTypes": ["user.signup", "user.deleted"], "hasCatchAllEndpoint": false } ] } } via PUT /api/v1/stats/usage/event-types

Create or update a stream. via PUT /api/v1/stream/{stream_id}

Create or update a sink. via PUT /api/v1/stream/{stream_id}/sink/{sink_id}

Create or update or create a event type for Streams. via PUT /api/v1/stream/event-type/{name}

Create or update an Ingest Source. via PUT /ingest/api/v1/source/{source_id}

Create or update an ingest endpoint. via PUT /ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}

Set the additional headers to be sent to the endpoint. via PUT /ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}/headers