Svix

Svix API

Svix API endpoints from Svix

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Svix API endpoints from Svix

Endpoints 44

Application

  • GETList Applications/api/v1/app?limit=0&iterator=app_1srOrx2ZWZBpBUvZwXKQmoEYga2&order=ascendingList of all the organization's applications.
  • POSTCreate Application/api/v1/app?get_if_exists=falseCreate a new application.
  • GETGet Application/api/v1/app/:app_idGet an application.
  • PUTUpdate Application/api/v1/app/:app_idUpdate an application.
  • DELETEDelete Application/api/v1/app/:app_idDelete an application.
  • PATCHPatch Application/api/v1/app/:app_idPartially update an application.

Message

  • GETList Messages/api/v1/app/:app_id/msg?limit=0&iterator=msg_1srOrx2ZWZBpBUvZwXKQmoEYga2&channel=project_1337&before=2024-01-01T00:00:00Z&after=2024-01-01T00:00:00Z&with_content=true&event_types=user.signupList all of the application's messages. The before parameter lets you filter all items created before a certain date and is ignored if an iterator is passed.…
  • POSTCreate Message/api/v1/app/:app_id/msg?with_content=trueCreates 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…
  • GETGet Message/api/v1/app/:app_id/msg/:msg_id?with_content=trueGet a message by its ID or eventID.
  • DELETEExpunge Message Content/api/v1/app/:app_id/msg/:msg_id/contentDelete 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…
  • POSTBulk Expunge Message Content/api/v1/app/:app_id/msg/bulk-expungeDelete the payloads from the given messages under the current application Useful in cases when a message was accidentally sent with sensitive content. A…

Message Attempt

  • GETGet Messageattempt/api/v1/app/:app_id/msg/:msg_id/attempt/:attempt_idmsg_id: Use a message id or a message eventId
  • DELETEExpunge Attempt Content/api/v1/app/:app_id/msg/:msg_id/attempt/:attempt_id/contentDeletes the given attempt's response body. Useful when an endpoint accidentally returned sensitive content.
  • GETList Attempted Destinations/api/v1/app/:app_id/msg/:msg_id/endpoint?limit=0&iterator=ep_1srOrx2ZWZBpBUvZwXKQmoEYga2msg_id: Use a message id or a message eventId
  • POSTResend Webhook/api/v1/app/:app_id/msg/:msg_id/endpoint/:endpoint_id/resendResend a message to the specified endpoint.
  • GETList Attempted Messages/api/v1/app/:app_id/endpoint/:endpoint_id/msg?limit=0&iterator=msg_1srOrx2ZWZBpBUvZwXKQmoEYga2&channel=project_1337&status=0&before=2024-01-01T00:00:00Z&after=2024-01-01T00:00:00Z&with_content=true&event_types=user.signupList messages for a particular endpoint. Additionally includes metadata about the latest message attempt. The before parameter lets you filter all items…
  • GETList Attempts By Endpoint/api/v1/app/:app_id/attempt/endpoint/:endpoint_id?limit=0&iterator=atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2&status=0&status_code_class=0&channel=project_1337&before=2024-01-01T00:00:00Z&after=2024-01-01T00:00:00Z&with_content=true&event_types=user.signupList attempts by endpoint id
  • GETList Attempts By Msg/api/v1/app/:app_id/attempt/msg/:msg_id?limit=0&iterator=atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2&status=0&status_code_class=0&channel=project_1337&endpoint_id=unique-ep-identifier&before=2024-01-01T00:00:00Z&after=2024-01-01T00:00:00Z&with_content=true&event_types=user.signupList attempts by message id

Endpoint

  • GETList Endpoints/api/v1/app/:app_id/endpoint?limit=0&iterator=ep_1srOrx2ZWZBpBUvZwXKQmoEYga2&order=ascendingList the application's endpoints.
  • POSTCreate Endpoint/api/v1/app/:app_id/endpointCreate a new endpoint for the application. When secret is null the secret is automatically generated (recommended)
  • GETGet Endpoint/api/v1/app/:app_id/endpoint/:endpoint_idGet an endpoint.
  • PUTUpdate Endpoint/api/v1/app/:app_id/endpoint/:endpoint_idUpdate an endpoint.
  • DELETEDelete Endpoint/api/v1/app/:app_id/endpoint/:endpoint_idDelete an endpoint.
  • PATCHPatch Endpoint/api/v1/app/:app_id/endpoint/:endpoint_idPartially update an endpoint.
  • GETGet Endpoint Secret/api/v1/app/:app_id/endpoint/:endpoint_id/secretGet 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.
  • POSTRotate Endpoint Secret/api/v1/app/:app_id/endpoint/:endpoint_id/secret/rotateRotates the endpoint's signing secret. The previous secret will be valid for the next 24 hours.
  • GETEndpoint Stats/api/v1/app/:app_id/endpoint/:endpoint_id/stats?since=2024-01-01T00:00:00Z&until=2024-01-01T00:00:00ZGet basic statistics for the endpoint.
  • POSTSend Event Type Example Message/api/v1/app/:app_id/endpoint/:endpoint_id/send-exampleSend an example message for an event
  • POSTRecover Failed Webhooks/api/v1/app/:app_id/endpoint/:endpoint_id/recoverResend all failed messages since a given time.
  • GETGet Endpoint Headers/api/v1/app/:app_id/endpoint/:endpoint_id/headersGet the additional headers to be sent with the webhook
  • PUTUpdate Endpoint Headers/api/v1/app/:app_id/endpoint/:endpoint_id/headersSet the additional headers to be sent with the webhook
  • PATCHPatch Endpoint Headers/api/v1/app/:app_id/endpoint/:endpoint_id/headersPartially set the additional headers to be sent with the webhook

Event Type

  • GETList Event Types/api/v1/event-type?limit=0&iterator=user.signup&order=ascending&include_archived=false&with_content=falseReturn the list of event types.
  • POSTCreate Event Type/api/v1/event-typeCreate 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…
  • GETGet Event Type/api/v1/event-type/:event_type_nameGet an event type.
  • PUTUpdate Event Type/api/v1/event-type/:event_type_nameUpdate an event type.
  • DELETEDelete Event Type/api/v1/event-type/:event_type_name?expunge=falseArchive 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…
  • PATCHPatch Event Type/api/v1/event-type/:event_type_namePartially update an event type.

Authentication

  • POSTLogout/api/v1/auth/logoutLogout an app token. Trying to log out other tokens will fail.
  • POSTApp Portal Access/api/v1/auth/app-portal-access/:app_idUse this function to get magic links (and authentication codes) for connecting your users to the Consumer Application Portal.

Health

  • GETHealth/api/v1/healthVerify the API server is up and running.
  • HEADHealth/api/v1/healthVerify the API server is up and running.
  • GETGET /api/v1/health/ping/api/v1/health/ping
  • HEADHEAD /api/v1/health/ping/api/v1/health/ping

API details

Authentication
A bearer token in the Authorization header
Operations
44 operations on 27 pathsGET 18POST 11DELETE 5PUT 4PATCH 4HEAD 2
Main resources
Endpoint 14Message Attempt 7Application 6Event Type 6Message 5Authentication 2Health 2
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 1.1.1

How to test the Svix API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Svix API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List Applications” (GET /api/v1/app?limit=0&iterator=app_1srOrx2ZWZBpBUvZwXKQmoEYga2&order=ascending), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Svix API?

Svix API endpoints from Svix It is listed under Developer tools and has 44 endpoints.

Who publishes the Svix API?

It is listed from Svix's public API description (an OpenAPI document), not published by Svix on Swastik Codes. Anyone who controls svix.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the Svix API?

With A bearer token in the Authorization header.

How many endpoints does the Svix API have?

44 operations on 27 paths (18 GET, 11 POST, 5 DELETE, 4 PUT, 4 PATCH, 2 HEAD). The largest groups are Endpoint, Message Attempt, Application, Event Type.

Is forking the Svix API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.