README

Svix - Webhooks as a service
    


  Website | Documentation | Community Slack


!GitHub tag









 Svix is the enterprise ready webhook service

Svix makes it easy for developers to send webhooks. Developers make one API call, and Svix takes care of deliverability, retries, security, and more. For more information, please refer to the Svix homepage.






![Maven Central (Java))](https://search.maven.org/artifact/com.svix/svix)
![Maven Central (Kotlin))](https://search.maven.org/artifact/com.svix.kotlin/svix-kotlin)




 Documentation

You can find general usage documentation at . 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 .

 Support & Community

  - GitHub Issues - report issues and make suggestions.
  - Community Forum - ask questions, and start discussions!
  - Slack - come and chat with us!

To stay up-to-date with new features and improvements be sure to watch our repo!

!Watch & Star our repo

 Client Library Overview


  ⚡️ Feature Breakdown ⚡️
  
    Language
    Officially Supported
    API Support
    Webhook Verification
    Other Notes
  
  
    Go
    ✅
    ✅
    ✅
    
  
  
    
    Python
    ✅
    ✅
    ✅
    
  
    
    
    Typescript/Javascript
    ✅
    ✅
    ✅
    
  
  
    Java
    ✅
    ✅
    ✅
    Async support planned. (If you use kotlin, checkout our kotlin library for coroutine support.)
  
  
    Kotlin
    ✅
    ✅
    ✅
    
  
  
    Ruby
    ✅
    ✅
    ✅
    
  
  
    C (dotnet)
    ✅
    ✅
    ✅
    
  
  
    Rust
    ✅
    ✅
    ✅
    
  
  
    PHP
    ✅
    ✅
    ✅
    
  
  
    Terraform
    ✅
    ✅
    N/A
    
  




 Trying out the CLI

The Svix CLI is published on npm as svix-cli. You can run it directly with npx without installing anything:

sh
npx svix-cli --help


Or install it globally:

sh
npm install -g svix-cli
svix-cli --help




 Running the server

There are multiple ways to get the Svix server up running. Docker is probably the most common one, but you can choose the one that works best for you.

The Svix server is written in Rust 🦀, which means you can compile it into a static library for a variety of targets. Please refer to the building from source section below for more information.

Please refer to the server configuration section below for more information regarding the available settings.

 Deployment

 Docker

You can use the official Svix Docker image from Docker Hub. You can either use the latest tag, or one of the versioned tags instead.

You can either use the example docker-compose.yml file with docker compose (easiest), docker swarm (advanced), or run the container standalone.

 With Docker Compose

This alternative is the easiest because it will also boot up and configure redis and postgresql.

This assumes you have Docker Compose v2 installed.


cd server
docker compose up


 Standalone container

Running a standalone container is slightly more advanced, as it r