Skip to main content

Create Alert

POST/compliance/alertsOpen in the API playground →
Info

Manual alert creation for suspicious activity observed by agents or support staff.

Request​

Authorizationstringheaderrequired

Bearer olive_live_xxx

Body Parameters​

subscriber_idstringbodyrequired

Subscriber UUID involved

alert_typestringbodyrequired

e.g., SUSPICIOUS_BEHAVIOR, AGENT_REPORT

detailsstringbodyrequired

Description of the incident

rule_idintegerbody

Optional ID of rule violated

Response​

successboolean

Creation status

alert_idinteger

ID of created alert

Examples​

Request
cURL
curl -X POST "https://demo.api.vultlocal.com/api/v1/compliance/alerts" \
  -H "Authorization: Bearer olive_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "subscriber_id": "sub_abc123",
    "alert_type": "SUSPICIOUS_BEHAVIOR",
    "details": "User attempted multiple PIN guesses at agent location"
  }'
Response
201 Created
{
  "success": true,
  "message": "Alert created",
  "alert_id": 101
}