This page provides guidance on setting up a collection of rules that can be applied to monitoring. Each rule includes specific parameters that allow you to customise notifications based on changes in credit scores, credit limits, company statuses, and other key metrics.
NOTE: This is not a complete list of the available rules, please see the two following endpoints:
- All Event Rules
- Filtered Event Rules (By Country Code)
The following rules require additional parameters (Param 0
, Param 1
, Param 2
) to configure notifications:
These rules apply globally and are not specific to any country.
This rule notifies you when a company's international score band (ranging from A to E) drops or changes based on specific thresholds.
Parameter | Description |
---|---|
param0 | (Optional) The number of score bands the rating must decrease by to trigger a notification. Values: "1" , "2" , "3" , "4" , or "" . Leave empty ("" ) if you only want to use param1 . |
param1 | (Optional) A threshold band for any changes (up or down). Values: "A" , "B" , "C" , "D" , or "Any" . If set to "Any" , the rule monitors both upward and downward movements. If set to a specific band (e.g. "C" ), it only monitors drops into or below that band — upward changes are ignored. |
param2 | (Optional) If set to "true" , the new band will be returned in both the API response and the notification email. If set to "false" , the band will not be returned in the response. |
- Setting only
param0
to"1"
triggers a notification only when the score drops by 1 band (e.g., A → B, B → C). - If you set
param0
to"2"
, you'll only be notified if the score drops by 2 or more bands (e.g., A → C, but not A → B). - To receive any score change, set
param1
to"Any"
— this overridesparam0
and triggers on both increases and decreases. - If you only care about scores dropping below a certain threshold (e.g., band C), set
param1
to"C"
and leaveparam0
empty. - This rule only monitors decreases unless
param1
is set to"Any"
. - There is no equivalent rule for increase-only monitoring.
Goal | param0 | param1 | param2 |
---|---|---|---|
Notify on any score change | "" | Any | true |
Notify if band drops by 1 | 1 | "" | true |
Notify if score drops below B | "" | B | false |
Notify if band drops by 2+ | 2 | "" | true |
Parameter | Description |
---|---|
param0 (boolean) | When set to true , notifications are triggered for any change in the credit limit, regardless of amount or direction (up or down). When set to false or omitted, notifications only trigger based on the thresholds defined by param1 and param2 . |
param1 (number) | The percentage decrease threshold for the credit limit. A notification is triggered when the credit limit reduces by this percentage or more. This only applies to downward changes (reductions). |
param2 (number) | The credit limit value threshold. Notifications trigger when the credit limit falls below this value. This is an absolute threshold, not a change percentage. |
- If
param0
istrue
, the rule ignoresparam1
andparam2
and sends notifications on any credit limit change (up or down). - If
param0
isfalse
or missing, the rule sends notifications only when the credit limit falls by at leastparam1
percent downwards, or falls below the absolute value set byparam2
. - There is no "up only" or "up and down" option unless
param0
is set totrue
. - This means you can either:
- Monitor any change (
param0=true
), or - Monitor downward changes and thresholds (
param0=false
+param1
/param2
).
- Monitor any change (
param0 | param1 | param2 | Behavior |
---|---|---|---|
true | 10 | 1000 | Notify on any credit limit change. |
false | 10 | 1000 | Notify only if credit limit drops by 10% or below 1000. |
false | 20 | 500 | Notify only if credit limit drops by 20% or below 500. |
false | (none) | (none) | Rule will not generate any notifications. |
These rules are specific to certain countries, as indicated by their abbreviations (e.g., US
, DE
, FI
, NL
).
- Param 0: Enter a percentage value indicating the drop in credit score that will trigger a notification.
For example, if the score decreases by 20%, you will receive a notification.
- Param 0: Enter a percentage value indicating the change in the credit limit of a DE-registered company that will trigger a notification.
For example, if the credit limit increases or decreases by 20%, you will be notified.
- Param 0: Enter a percentage value indicating the change in the credit score of a DE-registered company that will trigger a notification.
For example, if the credit score increases or decreases by 20%, you will be notified.
- Param 0: Enter a percentage value indicating the change in the credit limit of a DE non-registered company that will trigger a notification.
For example, if the credit limit increases or decreases by 20%, you will be notified.
- Param 0: Enter a percentage value indicating the change in the credit score of a DE non-registered company that will trigger a notification.
For example, if the credit score increases or decreases by 20%, you will be notified.
- Param 0: Enter a numeric value indicating the amount by which the rating score must increase or decrease to trigger a notification.
For example, if Param 0 = 20, you will be notified if the rating score increases by at least 20 or decreases by 20 or more.
- Param 0: Enter a percentage value indicating the drop in credit score that will trigger a notification.
For example, if the score decreases by 20%, you will receive a notification.
- Param 0: Enter a numeric value indicating the amount by which the rating score must increase or decrease to trigger a notification.
For example, if Param 0 = 20, you will be notified if the rating score increases by at least 20 or decreases by 20 or more.
This rule monitors event changes and does not require additional parameters.
- Set the
"isActive"
parameter to1
to enable notifications for these events.
This rule monitors event changes and does not require additional parameters.
- Set the
"isActive"
parameter to1
to enable notifications for these events.
This rule monitors event changes and does not require additional parameters.
- Set the
"isActive"
parameter to1
to enable notifications for these events.
- Param 0: Enter a percentage value indicating the minimum percentage by which a rating must change to trigger a notification.
- Param 1: Enter a value indicating the minimum increase or decrease in the rating score to trigger a notification.
For example, if the rating increases or decreases by 10% or the value change is greater than 20, you will receive a notification.
This rule is similar to Rule 1601, but instead of monitoring rating changes, it monitors changes in the value of DBT (Days Beyond Terms).
- Param 0: Enter a percentage value indicating the increase or decrease in the filing count that will trigger a notification.
- Param 1: Enter a value indicating the minimum change (increase or decrease) in the filing count that will trigger a notification.
For example, you can set it to get notified if the change is greater than 10% or exceeds 20.
- Param 0: Enter a percentage value indicating the increase or decrease in the outstanding amount that will trigger a notification.
- Param 1: Enter a value indicating the minimum change (increase or decrease) in the outstanding amount that will trigger a notification.
Use this parameter in the same way as Rule 1606.
These rules provide flexibility to monitor various changes in credit scores, credit limits, company statuses, and other metrics. Customize the parameters as needed to align with your business requirements.