Skip to content

Latest commit

 

History

History
 
 

README.md

Typescript/Javascript library for interacting with the Svix API and verifying webhook signatures

GitHub tag NPM version

Join our slack

Usage Documentation

You can find general usage documentation at https://docs.svix.com. For complete API documentation with code examples for each endpoint in all of our official client libraries head over to our API documentation site at https://api.svix.com.

Language Support

⚡️ Features ⚡️
Officially Supported
API Support
Signature Verification
Caveats None! 🚀

Installation

npm install svix # or yarn add svix

Usage

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

Development

First checkout the core README for details on how to generate our API bindings, then follow the steps below.

Requirements

  • node
  • yarn

Building the library

yarn yarn build

Contributing

Before opening a PR be sure to format your code!

yarn lint:fix

Running Tests

Simply run:

yarn test