Alert - Create

POST

Request

This endpoint expects an object.
alertId
stringRequired
createdTimestamp
doubleRequired
caseId
stringRequired
priority
enumRequired
Allowed values: P1P2P3P4
entityDetails
unionRequired
ruleDetails
objectRequired
tags
list of objectsOptional
Generic key-value pair model to append a custom variable being sent to Flagright API
creationReason
objectOptional
assignments
list of objectsOptional

Response

This endpoint returns an object
alertId
string
createdTimestamp
double
caseId
string
priority
enum
Allowed values: P1P2P3P4
entityDetails
union
ruleDetails
object
alertStatus
enum
updatedAt
double
tags
list of objectsOptional
Generic key-value pair model to append a custom variable being sent to Flagright API
creationReason
objectOptional
assignments
list of objectsOptional

Errors

POST
1curl -X POST https://sandbox.api.flagright.com/management/alerts \
2 -H "x-api-key: <apiKey>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "alertId": "string",
6 "createdTimestamp": 1,
7 "caseId": "string",
8 "priority": "P1",
9 "entityDetails": {
10 "type": "TRANSACTION",
11 "transactionIds": [
12 "string"
13 ]
14 },
15 "ruleDetails": {
16 "id": "string",
17 "name": "string",
18 "action": "ALLOW",
19 "description": "string",
20 "instanceId": "string"
21 }
22}'
1{
2 "alertId": "string",
3 "createdTimestamp": 1,
4 "caseId": "string",
5 "priority": "P1",
6 "entityDetails": {
7 "type": "TRANSACTION",
8 "transactionIds": [
9 "string"
10 ]
11 },
12 "ruleDetails": {
13 "id": "string",
14 "name": "string",
15 "action": "ALLOW",
16 "description": "string",
17 "instanceId": "string",
18 "nature": "AML"
19 },
20 "alertStatus": "OPEN",
21 "updatedAt": 1,
22 "tags": [
23 {
24 "key": "string",
25 "value": "string"
26 }
27 ],
28 "creationReason": {
29 "reasons": [
30 "string"
31 ],
32 "comment": "string",
33 "timestamp": 1
34 },
35 "assignments": [
36 {
37 "assigneeEmail": "string",
38 "assignedByEmail": "string",
39 "timestamp": 1
40 }
41 ]
42}