Webhooks

Webhooks

Webhooks are a simple, powerful and flexible way to interact with your bank account and transactions we're excited to see what you build with them!

You can configure webhook endpoints via the API to be notified about events that happen in your HMBradley account or plans and connected accounts.

Most users configure webhooks from the routines dashboard, which provides a user interface for registering and testing your webhook endpoints.

Sample Payload

The following is a sample payload for a webhook event. The payload is sent as a POST request to the webhook endpoint you configure.

payload.json
{
    "depositTransactionTrigger": {
        "balance": {
            "available_balance": "439.21",
            "pending_balance": "0.00",
            "total_balance": "8.35",
            "total_plans_balance": "0.00"
        },
        "transaction": {
            "amount": "10.00",
            "balance": "12.20",
            "category": "GAS",
            "description": "Transfer to Example Account",
            "from_account_type": "EXTERNAL",
            "id": "uuid",
            "initiated_at": "2023-07-20",
            "initiated_by": "SYSTEM:HMB",
            "is_credit": false,
            "is_direct_deposit": false,
            "posted_at": "2023-07-20",
            "status": "POSTED",
            "to_account_type": "DEPOSIT"
        }
    },
    "description": "",
    "initiated_at": "2023-07-20T19:10:32.891305Z",
    "name": "PipeDream",
    "url": "https://enhvnf0usor1g.x.pipedream.net/",
    "webhook_id": "0cee1674-3db7-43b6-a6ad-9ef38d3ce3cd"
}