post https://api.eu.mesh.complyadvantage.com/v2/webhooks
This endpoint enables you to create a webhook that will monitor an event type and send updates to the URL you specify.
There are three event types you can listen to:
CASE_CREATED
Receive an update whenever a new case is created.
Note that case_state
is deprecated. Please use case_stage
instead.
Example:
{
"api_version": "v2",
"case_identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"case_state": "ONBOARDING_NOT_STARTED",
"case_type": "CUSTOMER_ONBOARDING",
"customer": {
"identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"external_identifier": "your unique customer identifier",
"version": 1
},
"case_stage": {
"identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"display_name": "Not Started",
"display_order": 1,
"stage_type": "INITIAL",
"decision_type": null
}
}
CASE_STATE_UPDATED
Receive an update whenever a case changes its stage, e.g. from "Not Started" to "In Progress".
Note that case_state
is deprecated. Please use case_stage
instead.
Example:
{
"api_version": "v2",
"case_identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"case_state": "CASE_STATE_POSITIVE_END_STATE",
"case_type": "CUSTOMER_ONBOARDING",
"customer": {
"identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"external_identifier": "your unique customer identifier",
"version": 1
},
"note": {
"contents": "note left at the time the case state was updated"
},
"case_stage": {
"identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"display_name": "False Positive",
"display_order": 4,
"stage_type": "DECISION",
"decision_type": "POSITIVE"
}
}
WORKFLOW_COMPLETED
Receive an update when an onboarding workflow completes.
Example:
{
"api_version": "v2",
"workflow_instance_identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "COMPLETED",
"step_details": {
"alerting": {
"identifier": null,
"status": "COMPLETED",
"step_output": {
"alerts": [
{
"identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
]
}
},
"customer-creation": {
"identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "COMPLETED",
"step_output": {
"customer_identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
},
"customer-screening": {
"identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "COMPLETED",
"step_output": {
"screening_result": "HAS_PROFILES"
}
},
"initial-risk-scoring": {
"identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "COMPLETED",
"step_output": {
"overall_level": "LOW-RISK",
"overall_value": 0
}
}
},
"steps": [
"customer-creation",
"initial-risk-scoring",
"customer-screening",
"alerting"
],
"workflow_type": "create-and-screen"
}