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

  1. Go to System>Webhooks, then click Create a Webhook.
  2. Add the Endpoint URL you want to send your webhooks to.
  3. 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.


Action TypeWebhook Trigger
ALERT_CREATEDWhen an alert is triggered
ALERT_REOPENEDWhen an agent re-opens a previously closed alert
ALERT_CLOSEDWhen an alert is closed
ALERT_ACTION_TRIGGEREDWhen an agent clicks an alert's action buttons
ALERT_GENERATION_LIMIT_HITWhen the alert generation limit has been hit
ALERT_COMPONENT_ACTION_TRIGGEREDWhen alert component action buttons are clicked via the alert detail pane


Action TypeWebhook Trigger
CASE_CREATEDWhen a case is created
CASE_REOPENEDWhen a previously closed case is re-opened
CASE_CLOSEDWhen a case is closed
CASE_ACTION_TRIGGEREDWhen a case action runs


Action TypeWebhook Trigger
ENTITY_ACTION_TRIGGEREDWhen an entity action runs (executed from an entity's details pane)
ENTITY_FLAGGEDWhen an entity is flagged

Rules / Models:

Action TypeWebhook Trigger
RULE_TRIGGEREDWhen a rule is executed
RULE_CREATEDWhen an agent deploys a rule

File Exports:

Action TypeWebhook Trigger
FILE_EXPORT_READYWhen an export is ready


Action TypeWebhook Trigger
VERIFICATION_CONTINUOUS_MONITORING_MATCHWhen entity is continuously monitored
VERIFICATION_WORKFLOW_EXECUTEDWhen a verification workflow is executed
VERIFICATION_ENTITY_STEP_COMPLETEDWhen entity verification is completed
VERIFICATION_ENTITY_INITIATEDWhen verification initiations for an entity
VERIFICATION_MANUAL_REVIEW_NEEDEDWhen verification returns the state "manual review needed"
VERIFICATION_AUTO_APPROVEDWhen verification is approved
VERIFICATION_AUTO_REJECTEDWhen verification is rejected

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.