Alert API

How to Authenticate the APIs

The Alerts API enables users to create, update, delete, and test alert configurations, as well as send notifications through various channels. It supports integrations with platforms like Slack, Discord, Telegram, email, and even custom webhooks, allowing organizations to respond swiftly to critical events while maintaining operational efficiency. The API is secured using a Management API key, which can be found under Settings > API keys in Panorama.

Get all alert configurations

get

Retrieve all alert configurations. This endpoint returns all alerts with filtering information such as name, channel product and so on.

Authorizations

Header parameters

X-Api-Keystringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://validation-api.cube3.ai/api/v2/management/alert-configurations' \
  --header 'X-Api-Key: text'

200

200

{
  "alerts": [
    {
      "alertId": "text",
      "alertName": "text",
      "alertType": "SONAR",
      "alertSentCounter": 1,
      "destinationIds": [
        "text"
      ],
      "transactionFilter": {
        "validationStatusConfiguration": {
          "alertOnSafe": true,
          "alertOnWarning": true,
          "alertOnUnsafe": true
        },
        "validationEnforcementConfiguration": {
          "alertOnPassed": true,
          "alertOnBlocked": true
        },
        "fromScore": 1,
        "toScore": 1,
        "fromTotalLoss": 1,
        "toTotalLoss": 1,
        "categories": [
          "fraud",
          "cyber",
          "compliance"
        ],
        "subCategories": [
          "maliciousInteraction",
          "mixerMaliciousContractInteraction",
          "reentrancy",
          "financialScamInteraction",
          "rugPullInteraction",
          "impersonationScamInteraction",
          "maliciousProtocolUpgrade",
          "addressPoisoning"
        ],
        "chainIds": [
          1,
          10,
          11155111,
          56,
          137,
          42161,
          43114,
          8453
        ]
      },
      "isActive": true
    }
  ]
}

OK

Update alert configuration

put

Update specific alert configuration with filters like: score, block chains, total loss amounts and so on.

Authorizations

Header parameters

X-Api-Keystringrequired

Body

alertIdstringrequired

alertTypestring · enumrequired

Available options:

alertNamestringrequired

isActivebooleanrequired

destinationIdsstring[]optional

transactionFilterobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://validation-api.cube3.ai/api/v2/management/alert-configurations' \
  --header 'X-Api-Key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "alertId": "text",
    "alertType": "SONAR",
    "alertName": "text",
    "isActive": true,
    "destinationIds": [
      "text"
    ],
    "transactionFilter": {
      "validationStatusConfiguration": {
        "alertOnSafe": true,
        "alertOnWarning": true,
        "alertOnUnsafe": true
      },
      "validationEnforcementConfiguration": {
        "alertOnPassed": true,
        "alertOnBlocked": true
      },
      "fromScore": 1,
      "toScore": 1,
      "fromTotalLoss": 1,
      "toTotalLoss": 1,
      "categories": [
        "fraud",
        "cyber",
        "compliance"
      ],
      "subCategories": [
        "maliciousInteraction",
        "mixerMaliciousContractInteraction",
        "reentrancy",
        "financialScamInteraction",
        "rugPullInteraction",
        "impersonationScamInteraction",
        "maliciousProtocolUpgrade",
        "addressPoisoning"
      ],
      "chainIds": [
        1,
        10,
        11155111,
        56,
        137,
        42161,
        43114,
        8453
      ]
    }
  }'

200

200

{
  "alertId": "text",
  "alertName": "text",
  "alertType": "SONAR",
  "alertSentCounter": 1,
  "destinationIds": [
    "text"
  ],
  "transactionFilter": {
    "validationStatusConfiguration": {
      "alertOnSafe": true,
      "alertOnWarning": true,
      "alertOnUnsafe": true
    },
    "validationEnforcementConfiguration": {
      "alertOnPassed": true,
      "alertOnBlocked": true
    },
    "fromScore": 1,
    "toScore": 1,
    "fromTotalLoss": 1,
    "toTotalLoss": 1,
    "categories": [
      "fraud",
      "cyber",
      "compliance"
    ],
    "subCategories": [
      "maliciousInteraction",
      "mixerMaliciousContractInteraction",
      "reentrancy",
      "financialScamInteraction",
      "rugPullInteraction",
      "impersonationScamInteraction",
      "maliciousProtocolUpgrade",
      "addressPoisoning"
    ],
    "chainIds": [
      1,
      10,
      11155111,
      56,
      137,
      42161,
      43114,
      8453
    ]
  },
  "isActive": true
}

OK

Create new alert configuration

post

Create new Alert configuration with detailed filters like: score, block chains, total loss amounts and much more.

Authorizations

Header parameters

X-Api-Keystringrequired

Body

alertNamestringrequired

alertTypestring · enumrequired

Available options:

destinationIdsstring[]optional

transactionFilterobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://validation-api.cube3.ai/api/v2/management/alert-configurations' \
  --header 'X-Api-Key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "alertName": "text",
    "alertType": "SONAR",
    "destinationIds": [
      "text"
    ],
    "transactionFilter": {
      "validationStatusConfiguration": {
        "alertOnSafe": true,
        "alertOnWarning": true,
        "alertOnUnsafe": true
      },
      "validationEnforcementConfiguration": {
        "alertOnPassed": true,
        "alertOnBlocked": true
      },
      "fromScore": 1,
      "toScore": 1,
      "fromTotalLoss": 1,
      "toTotalLoss": 1,
      "categories": [
        "fraud",
        "cyber",
        "compliance"
      ],
      "subCategories": [
        "maliciousInteraction",
        "mixerMaliciousContractInteraction",
        "reentrancy",
        "financialScamInteraction",
        "rugPullInteraction",
        "impersonationScamInteraction",
        "maliciousProtocolUpgrade",
        "addressPoisoning"
      ],
      "chainIds": [
        1,
        10,
        11155111,
        56,
        137,
        42161,
        43114,
        8453
      ]
    }
  }'

200

200

{
  "alertId": "text",
  "alertType": "SONAR",
  "alertName": "text"
}

OK

Change alert configuration status

put

Change alert configuration status from active to inactive or vice versa

Authorizations

Path parameters

alertConfigurationIdstringrequired

Header parameters

X-Api-Keystringrequired

Body

alertTypestring · enumrequired

Available options:

isActivebooleanrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://validation-api.cube3.ai/api/v2/management/alert-configurations/{alertConfigurationId}/status' \
  --header 'X-Api-Key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "alertType": "SONAR",
    "isActive": true
  }'

200

200

{
  "alertId": "text",
  "alertName": "text",
  "alertType": "SONAR",
  "alertSentCounter": 1,
  "destinationIds": [
    "text"
  ],
  "transactionFilter": {
    "validationStatusConfiguration": {
      "alertOnSafe": true,
      "alertOnWarning": true,
      "alertOnUnsafe": true
    },
    "validationEnforcementConfiguration": {
      "alertOnPassed": true,
      "alertOnBlocked": true
    },
    "fromScore": 1,
    "toScore": 1,
    "fromTotalLoss": 1,
    "toTotalLoss": 1,
    "categories": [
      "fraud",
      "cyber",
      "compliance"
    ],
    "subCategories": [
      "maliciousInteraction",
      "mixerMaliciousContractInteraction",
      "reentrancy",
      "financialScamInteraction",
      "rugPullInteraction",
      "impersonationScamInteraction",
      "maliciousProtocolUpgrade",
      "addressPoisoning"
    ],
    "chainIds": [
      1,
      10,
      11155111,
      56,
      137,
      42161,
      43114,
      8453
    ]
  },
  "isActive": true
}

OK

Delete alert configuration

delete

Delete alert configuration by provided alert configuration id

Authorizations

Path parameters

alertConfigurationIdstringrequired

Header parameters

X-Api-Keystringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://validation-api.cube3.ai/api/v2/management/alert-configurations/{alertConfigurationId}' \
  --header 'X-Api-Key: text'

200

200

{
  "configurationId": "text"
}

OK

Get alert destinations

get

Get all alert destinations

Authorizations

Header parameters

X-Api-Keystringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://validation-api.cube3.ai/api/v2/management/alert-configurations/destinations' \
  --header 'X-Api-Key: text'

200

200

[
  {
    "id": "text",
    "name": "text",
    "channel": "SLACK",
    "webhookUrl": "text",
    "state": "ACTIVE",
    "attributes": {
      "chatId": "text",
      "token": "text"
    },
    "errorMessage": "text",
    "createdAt": "2025-04-01T20:00:41.415Z"
  }
]

OK

Create alert destination

post

Create alert destination for specified product

Authorizations

Header parameters

X-Api-Keystringrequired

Body

namestringrequired

webhookUrlstringoptional

channelstring · enumrequired

Available options:

statestring · enumoptional

Available options:

attributesobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://validation-api.cube3.ai/api/v2/management/alert-configurations/destinations' \
  --header 'X-Api-Key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "webhookUrl": "text",
    "channel": "SLACK",
    "state": "ACTIVE",
    "attributes": {
      "chatId": "text",
      "token": "text"
    }
  }'

200

200

{
  "id": "text",
  "name": "text",
  "channel": "SLACK",
  "webhookUrl": "text",
  "state": "ACTIVE",
  "attributes": {
    "chatId": "text",
    "token": "text"
  },
  "active": true,
  "errorMessage": "text",
  "createdAt": "2025-04-01T20:00:41.415Z"
}

OK

Update alert destination

put

Update alert destination for specified channel

Authorizations

Path parameters

destinationIdstringrequired

Header parameters

X-Api-Keystringrequired

Body

namestringrequired

webhookUrlstringoptional

channelstring · enumrequired

Available options:

statestring · enumoptional

Available options:

attributesobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://validation-api.cube3.ai/api/v2/management/alert-configurations/destinations/{destinationId}' \
  --header 'X-Api-Key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "webhookUrl": "text",
    "channel": "SLACK",
    "state": "ACTIVE",
    "attributes": {
      "chatId": "text",
      "token": "text"
    }
  }'

200

200

{
  "id": "text",
  "name": "text",
  "channel": "SLACK",
  "webhookUrl": "text",
  "state": "ACTIVE",
  "attributes": {
    "chatId": "text",
    "token": "text"
  },
  "errorMessage": "text",
  "createdAt": "2025-04-01T20:00:41.415Z"
}

OK

Test alert destination

post

Test alert destination with provided destination id

Authorizations

Path parameters

alertIntegrationIdstringrequired

Header parameters

X-Api-Keystringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://validation-api.cube3.ai/api/v2/management/alert-configurations/integration/{alertIntegrationId}/test' \
  --header 'X-Api-Key: text'

200

200

{
  "webhookUrl": "text",
  "state": "SENT",
  "alertChannel": "SLACK",
  "errorMessage": "text",
  "timestamp": "2025-04-01T20:00:41.415Z"
}

OK

Delete alert destination

delete

Delete alert destination with specified id

Authorizations

Path parameters

idstringrequired

Header parameters

X-Api-Keystringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://validation-api.cube3.ai/api/v2/management/alert-configurations/destinations/{id}' \
  --header 'X-Api-Key: text'

200

200

{
  "destinationId": "text"
}

OK