CUBE3 Documentation
  • CUBE3 Documentation
  • Detect Products
    • Inspector
    • Monitor
    • Sonar
      • Sonar Feeds
  • Protect Products
    • RASP
      • Quick Start
        • ERC-20 Non-Upgradeable (Foundry)
        • ERC-20 Non-Upgradeable (Hardhat)
        • ERC-20 Upgradeable (Foundry)
        • ERC-20 Upgradeable (Hardhat)
      • RASP Integration
        • 1. Installation
        • 2. Integration
        • 3. Deployment
        • 4. Registration
        • 5. Interaction
        • 6. Inspection
      • CUBE3 Protocol
      • CUBE3 SDK
  • Manage Products
    • Transactions
    • Alerts
      • Email Integration
      • Slack Integration
      • Telegram Integration
      • Discord Integration
      • Webhook Integration
    • Rules
  • API Documentation
    • Inspector API
    • Validation API
      • Troubleshooting
    • Management API
      • Monitor API
      • Alert API
      • Control lists API
    • Authentication
    • API Rate Limits
  • Risk Engine
    • Risk Scoring Introduction
    • Risk Scoring Detailed Overview
  • Settings
    • Billing
    • Organization
    • API Keys
  • Supported Blockchain Networks
    • CUBE3 Detect Products
    • CUBE3 Protect Products
  • Testing Guide
Powered by GitBook
On this page
  1. API Documentation
  2. Management API

Alert API

PreviousMonitor APINextControl lists API

Last updated 4 months ago

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 in Panorama.

How to Authenticate the APIs
Settings > API keys

Delete alert configuration

delete

Delete alert configuration by provided alert configuration id

Authorizations
Path parameters
alertConfigurationIdstringRequired
Header parameters
X-Api-KeystringRequired
Responses
*/*
objectOptional
delete
DELETE /api/v2/management/alert-configurations/{alertConfigurationId} HTTP/1.1
Host: validation-api.cube3.ai
X-Api-Key: text
Accept: */*
200

OK

{
  "configurationId": "text"
}

Get alert destinations

get

Get all alert destinations

Authorizations
Header parameters
X-Api-KeystringRequired
Responses
*/*
object[]Optional
get
GET /api/v2/management/alert-configurations/destinations HTTP/1.1
Host: validation-api.cube3.ai
X-Api-Key: text
Accept: */*
200

OK

[
  {
    "id": "text",
    "name": "text",
    "channel": "SLACK",
    "webhookUrl": "text",
    "state": "ACTIVE",
    "attributes": {
      "chatId": "text",
      "token": "text"
    },
    "errorMessage": "text",
    "createdAt": "2025-04-19T14:42:19.662Z"
  }
]

Test alert destination

post

Test alert destination with provided destination id

Authorizations
Path parameters
alertIntegrationIdstringRequired
Header parameters
X-Api-KeystringRequired
Responses
*/*
objectOptional
post
POST /api/v2/management/alert-configurations/integration/{alertIntegrationId}/test HTTP/1.1
Host: validation-api.cube3.ai
X-Api-Key: text
Accept: */*
200

OK

{
  "webhookUrl": "text",
  "state": "SENT",
  "alertChannel": "SLACK",
  "errorMessage": "text",
  "timestamp": "2025-04-19T14:42:19.662Z"
}

Delete alert destination

delete

Delete alert destination with specified id

Authorizations
Path parameters
idstringRequired
Header parameters
X-Api-KeystringRequired
Responses
*/*
objectOptional
delete
DELETE /api/v2/management/alert-configurations/destinations/{id} HTTP/1.1
Host: validation-api.cube3.ai
X-Api-Key: text
Accept: */*
200

OK

{
  "destinationId": "text"
}
  • GETGet all alert configurations
  • PUTUpdate alert configuration
  • POSTCreate new alert configuration
  • PUTChange alert configuration status
  • DELETEDelete alert configuration
  • GETGet alert destinations
  • POSTCreate alert destination
  • PUTUpdate alert destination
  • POSTTest alert destination
  • DELETEDelete alert destination

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
*/*
objectOptional
get
GET /api/v2/management/alert-configurations HTTP/1.1
Host: validation-api.cube3.ai
X-Api-Key: text
Accept: */*
200

OK

{
  "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
    }
  ]
}

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 · enumRequiredAvailable options:
alertNamestringRequired
isActivebooleanRequired
destinationIdsstring[]Optional
transactionFilterobjectOptional
Responses
*/*
objectOptional
put
PUT /api/v2/management/alert-configurations HTTP/1.1
Host: validation-api.cube3.ai
X-Api-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 669

{
  "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

OK

{
  "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
}

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 · enumRequiredAvailable options:
destinationIdsstring[]Optional
transactionFilterobjectOptional
Responses
*/*
objectOptional
post
POST /api/v2/management/alert-configurations HTTP/1.1
Host: validation-api.cube3.ai
X-Api-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 636

{
  "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

OK

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

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 · enumRequiredAvailable options:
isActivebooleanRequired
Responses
*/*
objectOptional
put
PUT /api/v2/management/alert-configurations/{alertConfigurationId}/status HTTP/1.1
Host: validation-api.cube3.ai
X-Api-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "alertType": "SONAR",
  "isActive": true
}
200

OK

{
  "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
}

Create alert destination

post

Create alert destination for specified product

Authorizations
Header parameters
X-Api-KeystringRequired
Body
namestringRequired
webhookUrlstringOptional
channelstring · enumRequiredAvailable options:
statestring · enumOptionalAvailable options:
attributesobjectOptional
Responses
*/*
objectOptional
post
POST /api/v2/management/alert-configurations/destinations HTTP/1.1
Host: validation-api.cube3.ai
X-Api-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "name": "text",
  "webhookUrl": "text",
  "channel": "SLACK",
  "state": "ACTIVE",
  "attributes": {
    "chatId": "text",
    "token": "text"
  }
}
200

OK

{
  "id": "text",
  "name": "text",
  "channel": "SLACK",
  "webhookUrl": "text",
  "state": "ACTIVE",
  "attributes": {
    "chatId": "text",
    "token": "text"
  },
  "active": true,
  "errorMessage": "text",
  "createdAt": "2025-04-19T14:42:19.662Z"
}

Update alert destination

put

Update alert destination for specified channel

Authorizations
Path parameters
destinationIdstringRequired
Header parameters
X-Api-KeystringRequired
Body
namestringRequired
webhookUrlstringOptional
channelstring · enumRequiredAvailable options:
statestring · enumOptionalAvailable options:
attributesobjectOptional
Responses
*/*
objectOptional
put
PUT /api/v2/management/alert-configurations/destinations/{destinationId} HTTP/1.1
Host: validation-api.cube3.ai
X-Api-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "name": "text",
  "webhookUrl": "text",
  "channel": "SLACK",
  "state": "ACTIVE",
  "attributes": {
    "chatId": "text",
    "token": "text"
  }
}
200

OK

{
  "id": "text",
  "name": "text",
  "channel": "SLACK",
  "webhookUrl": "text",
  "state": "ACTIVE",
  "attributes": {
    "chatId": "text",
    "token": "text"
  },
  "errorMessage": "text",
  "createdAt": "2025-04-19T14:42:19.662Z"
}