In order to call these endpoints your token must have write_webhooks scope.

To set a webhook URL, make a POST request to /webhook with a body payload:

  • url: the URL you would like to set for your webhook.
  • secret: optional. If provided, the secret will be used to generate an HMAC signature that will be passed as a header

Any subsequent calls to this URL will overwrite the webhook URL for your account.

Ziina will deliver events by making a POST request to your webhook URL. In the event of a non-ok status code, Ziina will retry 3 times to delivery the event. The webhook request will contain a body with the following fields:

  • event: the name of the event being delivered
  • data: the event data

Currently the event and data options are:

If a secret was provided when configuring the webhook, the HTTP request will contain a header X-Hmac-Signature that can be used to confirm the authenticity of the request. The value of this field will be the hexadecimal encoded SHA-256 HMAC signature of the request body.

Webhooks will come from one of the following IP addresses. Do not accept the webhook if it comes from a different IP address:

  • 3.29.184.186
  • 3.29.190.95
  • 20.233.47.127

Was this page helpful?

Create refundCreate Webhook