Create a balance threshold notification

You can create an account balance threshold and get an event notification when a given account's balance reaches a specified amount. See our Data and reporting overview for more information on events and event notifications.


One-time trigger

A trigger is one-time and not continuous. Once the notification is delivered, an event trigger is deleted. If an additional trigger is needed, you must create a new one.

No more API calls are needed for this feature to work.

Body parameters

account_idID of account for balance threshold.NumberYes
thresholdTarget balance amountFloatYes
operatorMathematical operator enum, e.g., gt (greater than)StringYes


curl --request POST \
     --url \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '
     "account_id": 123,
     "threshold": 100,
     "operator": "eq"


HTTP Status: 201 Created

{ "id": "32d78fd4-de63-4e21-acdc-34bfb8869414" }

Once the account's balance achieves the desired threshold, an event will be emitted. The event schema can be seen in this page: Balance Threshold Achieved Schema.