Configure notifications for risk signals

If you want to get notified when a new risk signal triggers for an account holder, you can add a webhook notification.

This works the same way as adding other webhook notifications. The event type for risk signals is SCORE_SIGNAL_TRIGGERED.

You can add a new notification configuration, or you can update your existing configuration.

Once you have completed your setup, notify us so that we can turn on the webhook notification.

Create a notification configuration

Make a POST /createNotificationConfiguration call, pass the URL where the notifications should be sent, and the notification type.

curl https://cal-test.adyen.com/cal/services/Notification/v6/createNotificationConfiguration \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "configurationDetails":{
    "active": false,
    "eventConfigs":[
      {
        "eventType":"SCORE_SIGNAL_TRIGGERED",
        "includeMode":"INCLUDE"
      }
    ],
    "notifyURL":"https://www.merchant-domain.com/notification-handler"
  }
}'

{
    "pspReference": "XB7XNCQ8HXSKGK82",
    "configurationDetails": {
        "active": true,
        "eventConfigs": [
            {
                "eventType": "SCORE_SIGNAL_TRIGGERED",
                "includeMode": "INCLUDE"
            }
        ],
        "notificationId": 12345,
        "notifyURL": "https://www.merchant-domain.com/notification-handler",
    }
}

Update a notification configuration

If you have already have an existing notification configuration, you can update your notification setup.

Make a POST /updateNotificationConfiguration call and pass the new setting as its parameters. The notification to be updated is specified by the notificationId value.

curl https://cal-test.adyen.com/cal/services/Notification/v6/updateNotificationConfiguration \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
   "configurationDetails":{
      "active":false,
      "eventConfigs":[
         {
            "eventType":"ACCOUNT_CREATED",
            "includeMode":"INCLUDE"
         },
         {
           "eventType":"SCORE_SIGNAL_TRIGGERED",
           "includeMode":"INCLUDE"
         }
      ],
      "notificationId":12345,
      "notifyURL":"https://www.merchant-domain.com/notification-handler"      
   }
}'

{
   "pspReference":"R5CZ2NWPJTGV9D82",
   "configurationDetails":{
      "active":false,
      "eventConfigs":[
         {
               "eventType":"ACCOUNT_CREATED",
               "includeMode":"INCLUDE"
         },
         {
               "eventType":"SCORE_SIGNAL_TRIGGERED",
               "includeMode":"INCLUDE"
         }
      ],
      "notificationId":12345,
      "notifyURL":"https://www.merchant-domain.com/notification-handler",
   }
}

Example notification

The following is an example notification body for the SCORE_SIGNAL_TRIGGERED event type, triggered by the EmailSyntaxCheck risk signal.

  {
    "eventDate": "2022-04-05T13:29:15+02:00",
    "eventType": "SCORE_SIGNAL_TRIGGERED",
    "executingUserKey": "IdentityRisk",
    "live": "false",
    "mimeType": "genericNotification",
    "pspReference": "JDD6LKT8MBLZNN84",
    "content": {
        "accountHolderCode": "YOUR_ACCOUNT_HOLDER_CODE",
        "riskScore": 80,
        "scoreSignalsTriggered": [
          "EmailSyntaxCheck"]
        }
  }