Skip to main content

Setup

Svix offers a REST API to interact with the service, and easy to use libraries to interact with the API.

Svix also has an API reference and OpenAPI (formerly Swagger) specifications at the API documentation page which you can always refer to the exact schemas and endpoints available in our API.

When working with Svix you can either use our REST API directly, or using any of our libraries. In this document we'll cover how to install them for each platform.

Install the libraries#

npm install svix// Oryarn add svix

Then you can just use them as follows

import { Svix } from "svix";
const svix = new Svix("AUTH_TOKEN");const app = await svix.application.create({ name: "Application name" });