Modified on Fri, 18 Aug 2023 at 11:23 AM

Webhooks are a tool that allows your organization to receive updates on the status of users and transactions. This allows you to automate your next call to action depending on the status of the payment or user.

Enabling webooks

You can enable webhooks directly from your portal.

1. Click on Settings > Webhook & API Settings


2. Define your webhook URL 


3. Use the dropdowns to select which status changes you would like to receive instant notifications for.


3. Click Save


You can also view your webhook secret which is used for HMAC verification. For more information, visit our article on HMAC.



When your webhook URL is defined, Zūm Rails will send a POST request each time there is a status change for:

  • Users (only available for customers)
  • Transactions (only available for customers)
  • Customers (only available for partners)
  • Recurrent Transactions (only available for customers)
  • Subscriptions & Invoices (only available for customers)
  • Products (only available for customers)
  • Shipping & Tax (only available for customers)

If you do not have a webhook URL, you can use webhook.site to generate a one for test purposes, until yours is active.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article