Synchronous rules

For select customers, a synchronous version of the rules engine is available.

The synchronous rules engine executes a series of dynamically-configured, user-defined rules, and runs in real-time on transactional data points sent via API.

Currently, the service runs on transactions and entities that are passed into the system.

Synchronous rules can only be configured by an administrator (specific permissions are required).

Request

From an API perspective, there are endpoints that allow triggering of synchronous rules

  • /events/create
  • /entities/create

Both of these will require sending a {options: {"synchronous_rules": true}} section in the json body of the request.

In addition, there are a couple of more points to keep in mind:

  • Synchronous rules are not compatible with the bulk API. They can only be run on a single event or entity
  • All synchronous rules will currently run on each event/entity passed in

Response

The response for a synchronous rule request will return the result (PASS/FAIL) for each rule that was executed in the request.

Sample response:

{
  "rule_executions": {
    "152111": {
      "rule_name": "High Risk Country (Event)",
      "status": "PASS"
    },
    "152818": {
      "rule_name": "Windowed Lookback - 10K in P2P transfers in last 7 days",
      "status": "FAIL"
    }
  }
}

In addition to this, it is possible to enable an option per rule to trigger alerts on the dashboard for each rule execution that triggered a FAIL. Note that these alerts will be created on the dashboard asynchronously (on average will take a couple of minutes).

Rule Types

There is 1 current offering -- Simple Filters - simple standalone filters for example:

  • Transaction over 10K
  • User risk score > 90

Limitations

Customers can have up to 10 active synchronous rules in the environment at once.


Did this page help you?