This section covers all the APIs relating to our webhooks.

For an overview of our webhooks service, please refer to the Webhooks guide.

These APIs have the same method of authentication. Both your Live (production) and Pre-live (sandbox) platforms can be managed by accessing the Zai Dashboard at https://dashboard.hellozai.com/.
For more details, see our Environments guide.


Please note

When you go to the Zai Dashboard, you'll need to select either Live or Pre-live. The Live environment is for production use only. Use Pre-live to test your integration.

API endpoints

To access the Live (production) environment, use the following endpoint:

To access the Pre-live (sandbox) environment, use the following endpoint:


This section contains the Webhooks specifications in JSON and YAML formats.