A webhook notification gives you details about a specific event that has taken place in your gateway. Instead of having to ask the API if an event has occurred, a webhook can notify an endpoint on your server automatically.

You’ll need to develop a workflow that determines what your server does with this information. For example, if a customer’s subscription has expired, you could set up your server to send an email to your customer reminding them to renew their subscription.

Creating webhooks

note

In order to configure webhooks, your user’s role and privileges must include webhooks permissions.

  1. Log into the Control Panel
  2. Navigate to Settings > Webhooks
  3. Click Create a webhook

Here, you'll need to provide a destination URL, choose which kind of webhook you want to create, and set up your server to parse this webhook. To learn more, head over to our developer docs.

Testing webhooks

Once you’ve set up a webhook, you can send a test webhook to make sure your endpoint is configured correctly. To do this, click Check URL in the Control Panel under Settings > Webhooks.

Be careful when using this button in production- if your webhook handling code doesn’t look for the kind of webhooks it receives, this could lead to unexpected behavior.

Still have questions?

If you can’t find an answer, contact our Support team.


← Back to Previous Page