Fraud Watch Webhook URL
This is the URL where you can receive real-time notifications when a report that matches a fraud watch you have. You can set this URL in your Fraud Watch configure settings page.
POST request format
The webhook will send a POST request to the specified URL with the a JSON payload similar to the following:
{
"fraud_watch": {
"identifier" : "user1234",
"description" : "your description",
"url" : "https://fraudrecord.com/fraud-watch-details-url/ca8e6098fd725548",
},
"matched_reports" : [
{
"return_id" : "91c280f0bb424a02",
"type" : "hacking",
"severity" : 7,
"keys" : [
{
"type" : "name",
"matched" : "username",
"hash" : "bd1290ec320f477953a742a66e5db3df89eec9bc"
},
{
"type" : "email",
"matched" : "email",
"hash" : "8c9b66244ee68af610fd25ec9da407d07ec62ff4"
}
]
},
{
"return_id" : "037577b1bd0bcb29",
"type" : "spammer",
"severity" : 10,
"keys" : [
{
"type" : "email",
"matched" : "emailaddress",
"hash" : "8c9b66244ee68af610fd25ec9da407d07ec62ff4"
}
]
}
]
}
Payload Explanation
The payload contains the following information:
Fraud Watch Information
Fraud Watch Object
The fraud_watch object contains the details of the fraud watch that triggered the webhook. It includes:
- identifier: The identifier you provided for the fraud watch when you created it.
- description: The description you provided when creating the fraud watch.
- url: The URL where you can view the details of the fraud watch on the report manager. This URL will take you to the fraud watch details page where you can see all the information about the fraud watch. Something similar to https://www.fraudrecord.com/reporter-profiles/123/fraud-watch/456/ will be returned here, with the IDs pre-populated for you.
Matched Reports
The matched_reports array contains the reports that matched the data keys you provided in the fraud watch. Each report object includes:
- return_id: The unique identifier for the report. Individual reports can be viewed at https://www.fraudrecord.com/single-report/return_id
- type: The type of the report, such as "hacking" or "spammer".
- severity: The severity of the report, which is a number from 1 to 10.
- keys: An array of key and data pairs that were matched against the fraud watch keys. Each key object includes:
- type: The key type that your fraud watch has. Only the matching keys are shown.
- matched: The key type that was matched in the report. This can be the same as type or something else the other reporters have chosen.
- hash: The one-way hashed value of the data value that was matched in the report. This matches the hash that you provided in the fraud watch.
Since fraud watch scanning happens every few minutes, it is very likely that only a single report will trigger the fraud watch, unless multiple reports about the same client is submitted within a few minutes. In case of multiple reports matching the fraud watch, all matching reports will be included in the matched_reports array.
Simplified Webhook Payload Use
While we provide almost all the information you need in the webhook payload, realistically you only need the fraud_watch . url field to visit your dashboard and view the fraud watch details, including any alerts and reports. Everything else is optional and can be used to enhance your integration with FraudRecord.