Entity request bodies
{
"unit21_id": 123,
"entity_id": "J8OkZOrZ35TL6zoMdFX4zrxZE60UbevYNL",
"entity_type": "user",
"object_type": "ENTITY",
"change": "ACTION_TRIGGERED",
"change_time": 1570062682,
"changed_by": "[email protected]",
"disposition": "SUSPENDED",
"subdisposition": {
"id": "28",
"name": "Franklin R",
"title": "Reason for Dismissal"
},
"disposition_notes": "User confirmed that she did not initiate transaction",
"tags": ["risk:mid_high", "watchlist:recently_flagged"],
"custom_data": {},
"action_trigger_external_id": "CLOSED"
}
For the webhook ACTION_TRIGGERED, the following fields are sent:
| Field Name | Value Type | Details |
|---|---|---|
| unit21_id | Number | A Unit21 internally-assigned unique identifier for the case within our system |
| entity_id | String | A non-Unit21 identifier for the case |
| entity_type | String | A description of the entity such as user |
| change | String | A Unit21-defined value describing the nature of the change to this entity. For more details on this, see above section Change trigger types |
| changed_by | String | Email address of the agent that triggered the status change (if applicable) |
| object_type | String | ENTITY |
| change_time | Number | Time the change was triggered in [Epoch time format] |
| tags | String[] | A list of tags that are associated with this case, always of the format key:value |
| custom_data | Object | Any custom information that you wish our system to associate with this alert (accepts any valid JSON object) |
| action_trigger_external_id | String | A unique identifier defined at button create time |
| disposition | String | A state that represents either the entity's resolution or a designation for further actions. This field can be defined by an action trigger button, where each action trigger corresponds to one disposition |
| subdisposition | List | A sub-state that represents either the entity's resolution or a designation for further actions. This field can be be defined by an action trigger button, where each action trigger allows for agents to dynamically select a subdisposition during the investigation of an entity from a list of predefined values in the action trigger configuration process |
| disposition_notes | String | A free text field that contains agent-entered elaborations on the entity's disposition. A non-empty value may be required by the action trigger depending on the action trigger configuration |
{
"unit21_id": 625240968,
"entity_id": "u-d8e1d453-c205-4996-a935-ff08be01bcd1",
"entity_type": null,
"change": "FLAGGED",
"change_time": 1661967668,
"changed_by": null,
"object_type": "ENTITY",
"tags": [],
"custom_data": {},
"flagged_in_alerts": [
{
"alert_id": null,
"unit21_id": 11533744,
"alert_type": "tm"
}
]
}
For the webhook FLAGGED, the following fields are sent:
| unit21_id | String | A Unit21 internally-assigned unique identifier for the entity within our system |
| entity_id | String | The ID of the matching entity within your system |
| entity_type | String | A type for the entity defined be your org |
| change | String | A Unit21-defined value describing the nature of the change to this entity. For more details on this, see above section Change trigger types |
| change_time | Number | Time the change was triggered in Epoch time format (number of seconds elapsed since 1 Jan 1970 00:00:00 UTC) |
| changed_by | String | Email address of the agent that triggered the status change (if applicable) |
| object_type | String | ENTITY |
| tags | String[] | A list of tags that are associated with this entity, always of the format key:value |
| custom_data | Object | Any custom information that you wish our system to associate with this alert (accepts any valid JSON object) |
| flagged_in_alerts | Array[] | Array of alerts, each object has "alert_id", "unit21_id", "alert_type" |