README.md

Svix - Webhooks as a service

Website | Documentation | Community Slack

Kotlin library for interacting with the Svix API and verifying webhook signatures

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

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.svix.kotlin</groupId>
  <artifactId>svix-kotlin</artifactId>
  <version>1.26.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

implementation "com.svix.kotlin:svix-kotlin:1.26.0"

Development

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

Requirements

• Kotlin 1.9.00+
• Gradle

Building the library

./gradlew build

Running Tests

Simply run:

./gradlew test

Publishing to Maven

./gradlew publishToSonatype closeAndReleaseSonatypeStagingRepository