Webhook is an API concept that allows applications to communicate between themselves automatically without polling. Whenever an action/event happens on App A, it can automatically send updates to App B without App B polling constantly.

Whenever certain events take place on Monnify such as payment being received, or settlement being made to your account, we can automatically send a notification to your application so it can take further actions e.g. providing value to your user or sending an email to a user. The destination of this notification is a URL on your server, that accepts a POST request.


Webhook Events Supported on Monnify

An event is any action that is done on your integration that you are notified of. Events triggered on Monnify are:

  1. Card transaction completed or account transfer payment received. Check here to view more.

  2. A settlement made to your wallet or account.  Check here to view more.

  3. Disbursement completed. Check here to view more.

  4. An initiated refund is completed. Check here to view more.


Event-Based Notification

Monnify had an old transaction completion structure called legacy notification webhook and modified it to an event-based notification webhook. This event-based notification webhook has more information about transactions and can also be managed on the Monnify web UI.  

 

How to know if you are on the Legacy Notification System

To know if you’re on legacy notification, you’d see the image below when you navigate to the developer section on your dashboard and click on the Webhook URL tab.

Why should I migrate to Event-Based Notification?

The Event-Based notification provides a uniform notification structure and a UI management tool is available on the Monnify dashboard.

Migrating from Legacy Notification to Event-Based Notification

This section describes the process of migrating from legacy webhook notification systems to event-based notification systems. Below are the steps to be taken to implement the Event-Based Notification feature:

Step 1:

In order for you to be able to use the event-based notification feature, implement an endpoint on your system which can process the event notification structure. See samples of all events here.

Once this is done, you can easily migrate from the legacy notification to the event-based notification for both transactions and settlements.

Step 2:

Configure your endpoint on the Monnify UI. Once you are done implementing your callback endpoint, you’d need to fill in the text fields below with the configured URLs for the corresponding boxes on your monnify dashboard. 

Graphical user interface, application

Description automatically generated

Step 3: 

Once step 2 is done, you’d need to scroll down on the webhook URLs tab to where you can see Legacy Webhooks. Here you’d see your previously configured transaction and settlement notification URLs.

Graphical user interface, application

Description automatically generated

You’d have to click on the upgrade to event-based notification link to begin to receive event-based notifications from Monnify and this will be done through the URLs you provided in Step 2.

Graphical user interface, application, Teams

Description automatically generated

Once the above steps are completed, you are good to go to enjoy Monnify’s event-based notification feature.