Webhooks Overview

Webhooks are a way for Moneyhub to notify your application in real-time about events related to the users that you have created.

You can configure webhook endpoints via the Admin portal when you add or edit your API clients.

Once you start receiving webhooks, you will be able to see a list of them when you drill down to the details of your API users.

Example webhook

{
    "id": "abe168ce-1b2f-4c38-9c92-db5730485cb3",
    "eventType": "newTransactions",
    "userId": "5c79210bbac25ecb5e71ac40",
    "payload": {
        "accounts": [
            {
                "id": "6d0baf11-248e-4c11-9c04-97b7758b4e04",
                "transactions": [
                    "d520402a-d982-43ee-b1d1-bdfd282249ea",
                    "613586bf-dac9-4996-9c03-7194a7d62297"
                ]
            }
        ]
    }
}

Format

From the Client settings in the Admin Portal, you can select either JSON or JWT formatting for the webhook messages that we send you. You can use either format at any time, including for live production clients. This configuration process is outlined in detail here Webhook Format

Schema

Response

We expect a 20x response to mark the webhook as received.

Retries

Currently, we only attempt to send webhooks once to your registered endpoint.

Timeout

When we send webhooks, the request timeout is 5 seconds. Please ensure a 20x response is returned within this time frame.

Best Practices

When receiving transactions webhooks, we recommend fetching them from our API to have the latest changes. Multiple transactions can be retrieved at once using our transactions endpoint.

Please be aware that the API may send multiple transaction webhooks for a single connection if that connection has multiple accounts (the service sends transaction webhooks on a per-account basis).

Webhook size limit

Please note that we limit each webhook event to 6000 transaction IDs. If the triggering event (new/updated/deleted transaction) contains more than 6,000 IDs, the API will automatically batch them into multiple webhook events.

Testing

You can test some of these webhooks using our Test connections as explained in our Test our API section.

Available Webhooks

These are groupings of the currently available webhooks and give context-specific details. The complete list of webhooks is available in the navigation panel.