Manage Webhooks

Client Dashboard makes it easy to set up, test, and manage webhooks. MX provides webhooks that send HTTPS callback requests to the URL of your choice. This enables you to subscribe to events so you are notified when events occur. You can also have information related to that event delivered to you.

Create a Webhook

Webhooks available to you vary depending on whether you are using the Nexus or Platform API. Here are a few webhooks that are always available:

• Balance: You are notified when any new data is available after a successful balance aggregation.
• History: You are notified when any new data is available after a successful extended history fetch.
• Statement: You are notified when any new data is available after a successful statement fetch.

Once a webhook is created, you can enable or disable it from the Webhooks page by selecting the switch next to the webhook you want to modify:

1. In Client Dashboard, select Developers, then Webhooks in the dropdown.
2. If you are setting up a production webhook, in the Production webhooks section, select Add production webhook below the list of webhooks.
3. For development webhooks, select Add development webhook in the Development webhooks section.
4. Select the webhook type you want to create.
5. Select Continue.
6. In the Destination URL section, enter your callback URL. The callback URL is the address you provide where you want to receive data.
7. Select Continue.
8. In the Security Settings section, choose your security type by toggling the switch next to the type you want to use. You can optionally skip adding a security type.
9. Select Create Webhook on the top right.

Delete a Webhook

1. In Client Dashboard, navigate to the Webhooks page.
2. Find the production or development webhook you want to delete. Select the menu icon in the Actions column, then select Delete.
3. Select Confirm. This immediately deletes the selected webhook and can't be undone.

Edit a Webhook

1. In Client Dashboard, navigate to the Webhooks page.
2. Find the production or development webhook you want to edit.
3. Select the menu icon in the Actions column, then select Edit.
4. In webhook settings, select Edit on the section you would like to change. For example, if you want to modify the callback URL, select Edit in the Destination URL section.
5. After making the change, select Save Webhook.

Test a Webhook

1. In Client Dashboard, navigate to the Webhooks page.
2. Find the production or development webhook you want to test.
3. Select the menu icon in the Actions column, then select Test. A test starts automatically, and results display in a drawer on the right side of the screen.