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.
For information on configuring and self-hosting the server, please refer to the README.
Our simple yet powerful webhook API provides you with everything you need to offer a world-class webhooks experience.
const svix = new Svix("sk_IrlFPEh3VYctuyHhKTCxamGV");
// Send an event to Rock Inc's webhook endpoints
await svix.message.create("app_Xzx8bQeOB1D1XEYmAJaRGoj0", {
eventType: "user.created",
payload: {
username: "new_user",
email: "new_user@example.com",
},
});
⚡️ Feature Breakdown ⚡️ | |||
---|---|---|---|
Language | Officially Supported | API Support | Webhook Verification |
Go | ✅ | ✅ | ✅ |
Python | ✅ | ✅ | ✅ |
Typescript/Javascript | ✅ | ✅ | ✅ |
Java | ✅ | ✅ | ✅ |
Kotlin | ✅ | ✅ | ✅ |
Ruby | ✅ | ✅ | ✅ |
C# (dotnet) | ✅ | ✅ | ✅ |
Rust | ✅ | ✅ | ✅ |
PHP | ✅ | Coming soon | ✅ |
The Svix hosted service and the open source project are API compatible, and you can use the same libraries with either. There are, however, a few differences between the open source version and the hosted service.
We have reduced a lot of the complexity and infrastructure required to run the Svix hosted service. While this complexity is needed for the scale the Svix hosted service deals with, it's not useful for the vast majority of people and it would have made this project much harder to deploy, and thus to use.
We are here for you.