Creating and Managing Webhooks

  • Updated

The MX 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.

Creating a webhook

  1. In Client Dashboard, navigate to the Webhooks page.
  2. If you are setting up a production webhook, in the Production webhooks section, click Add production webhook below the list of webhooks. For development webhooks, click Add development webhook in the Development webhooks section.
    2021-11-18_07-59-06.png
  3. Select the type of webhook you want to create.

    Webhook types

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

    • Balance: You will be notified when any new data is available after a successful balance aggregation.
    • History: You will be notified when any new data is available after a successful extended history fetch.
    • Statement: You will be notified when any new data is available after a successful statement fetch.
  4. Click Continue
    2021-11-18_08-14-53.png
  5. In the Destination URL section, enter your callback URL. The callback URL is the address you provide where you want to receive data.
  6. Click Continue.
    2021-11-18_08-18-23.png
  7. In the Security Settings section, choose your security type by clicking the switch next to the type you want to use. You can optionally skip adding a security type.
    2021-11-18_08-21-35.png
  8. Click Create Webhook on the top right.
    2021-11-18_08-22-33.png

 

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

Deleting a webhook

  1. In Client Dashboard, navigate to the Webhooks page.
  2. Find the production or development webhook you want to delete.
  3. Click the menu icon 2021-11-18_11-02-38.png in the Actions column, then click Delete.
    2021-11-18_11-04-23.png
  4. Click Confirm.

    This will immediately delete the selected webhook and cannot be undone.

Editing a webhook

  1. In Client Dashboard, navigate to the Webhooks page
  2. Find the production or development webhook you want to edit.
  3. Click the menu icon 2021-11-18_11-02-38.png in the Actions column, then click Edit
    2021-11-18_11-04-23.png
  4. In webhook settings, click Edit on the section you would like to change. For example, if you want to modify the callback URL, click Edit in the Destination URL section. 
  5. After making the change, click Save Webhook.

Testing a webhook

  1. In Client Dashboard, navigate to the Webhooks page
  2. Find the production or development webhook you want to test.
  3. Click the menu icon 2021-11-18_11-02-38.png in the Actions column, then click Test.
    2021-11-18_11-04-23.png
  4. A test starts automatically, and results will display in a drawer on the right side of the screen.
    2021-11-18_11-22-58.png

Was this article helpful?