IMPORTANT: Breaking Changes to the Unit21 API
Unit21 ID and its associated fields (like
previously_existed
) will be deprecated for Entity, Events, and Instrument objects. Additionally, the List Entities, Events, and Instruments endpoints will be deprecated.Your integration may be affected if you utilize any of the APIs, webhooks, or exports listed here: https://docs.unit21.ai/page/api-changes
⏰ Action Required: Please check and update your integration by September 30, 2023.
Webhooks are notifications that Unit21 sends when an event occurs on your platform.
From the Webhooks pane of the Unit21 UI, you can configure what events trigger a webhook, along with the endpoints where notifications are sent.
For example, this webhook sends notifications about any alert activity to a specially designated endpoint.
How to create a webhook
- Go to System>Webhooks, then click Create a Webhook.
- Add the
Endpoint URL
you want to send your webhooks to. - Add the webhook
events
that trigger your webhook. For a description of the events, see the event reference in the following section.
The following list outlines the objects available for Unit21 webhooks, and briefly describes the events that trigger each webhook.
Alerts:
Action Type | Webhook Trigger |
---|---|
ALERT_CREATED | When an alert is triggered |
ALERT_REOPENED | When an agent re-opens a previously closed alert |
ALERT_CLOSED | When an alert is closed |
ALERT_ACTION_TRIGGERED | When an agent clicks an alert's action buttons |
ALERT_GENERATION_LIMIT_HIT | When the alert generation limit has been hit |
ALERT_COMPONENT_ACTION_TRIGGERED | When alert component action buttons are clicked via the alert detail pane |
Cases:
Action Type | Webhook Trigger |
---|---|
CASE_CREATED | When a case is created |
CASE_REOPENED | When a previously closed case is re-opened |
CASE_CLOSED | When a case is closed |
CASE_ACTION_TRIGGERED | When a case action runs |
Entities:
Action Type | Webhook Trigger |
---|---|
ENTITY_ACTION_TRIGGERED | When an entity action runs (executed from an entity's details pane) |
ENTITY_FLAGGED | When an entity is flagged |
Rules / Models:
Action Type | Webhook Trigger |
---|---|
RULE_TRIGGERED | When a rule is executed |
RULE_CREATED | When an agent deploys a rule |
File Exports:
Action Type | Webhook Trigger |
---|---|
FILE_EXPORT_READY | When an export is ready |
Verifications:
Action Type | Webhook Trigger |
---|---|
VERIFICATION_CONTINUOUS_MONITORING_MATCH | When entity is continuously monitored |
VERIFICATION_WORKFLOW_EXECUTED | When a verification workflow is executed |
VERIFICATION_ENTITY_STEP_COMPLETED | When entity verification is completed |
VERIFICATION_ENTITY_INITIATED | When verification initiations for an entity |
VERIFICATION_MANUAL_REVIEW_NEEDED | When verification returns the state "manual review needed" |
VERIFICATION_AUTO_APPROVED | When verification is approved |
VERIFICATION_AUTO_REJECTED | When verification is rejected |
VERIFICATION_RFI_RESPONSE_RECEIVED | Currently unavailable |
Test your webhook
After you create a webhook, you can send a test request. If a request fails, Unit21 tries to resend the webhook. However, Unit21 sends a maximum of three requests.