Skip to main content

How to handle webhooks for alerts

Jaye Hackett avatar
Written by Jaye Hackett
Updated this week

Alerts is an automated monitoring feature that performs daily checks against anti-money laundering databases and alerts you if things change.

How it works

If a new hit is found, an alert will be:

  • added to the team dashboard for you to acknowledge

  • sent to your specified webhook URL (if set) containing the relevant verification ID, so you can follow up

Response format

When a hit is found, a POST request is sent to your webhook URL with a webhook payload.

Example response

{
"event": "Alert"
"id": "123",
"email": "[email protected]",
"redirect_url": "http://example.com",
"status": "Verified",
"created_at": "2024-01-09T10:30:00Z",
"expires_at": "2024-01-09T10:30:00Z",
"workflow_id": "abc",
"external_id": "xyz",
}

Important notes

  • You will be alerted once, the first time an entity is found in the databases, and will only be re-alerted if they are added/removed in further lists.

  • Webhook payloads are deliberately lightweight, and don't currently include the reason for the alert. We recommend that checking the dashboard to understand the details before taking action.

Did this answer your question?