Get started with webhooks

To enable early access to scheduled reporting webhooks, please get in touch!

Reading and verifying webhook events

To be certain that a webhook has originated from Vizzly servers, the POST request body will be a Json Web Token (JWT) (opens in a new tab) signed with a private key owned by Vizzly.

To securely access the information sent in the webhook event, you should verify the request body using the Vizzly webhook public key. You can do this using our NPM auth package @vizzly/auth (opens in a new tab).

The content of each webhook message will vary depending on the type of webhook we send to you. Every webhook will contain a type value, which you can use to understand what the event is that we've sent.