Skip to main content
The Alerts API enables you to create, retrieve, update, and manage alerts programmatically within your application. This allows you to integrate alerting capabilities directly into your workflows, automate monitoring, and trigger alerts based on application logic or external events. While you can create alerts manually through the Blnk Cloud dashboard, the API provides the flexibility to build alerting into your application’s core functionality.

​
Create alerts

Create a new alert by flagging a balance, transaction, or identity. Send a POST request to the /alerts/flag/{id} endpoint, where {id} is the identifier of the entity you want to flag. 
curl -X POST 'https://api.cloud.blnkfinance.com/alerts/flag/bal_1234567890abcdef' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Balance threshold exceeded",
    "description": "Account balance has exceeded the maximum allowed limit."
  }'

​
Update alerts

Modify alert details, update status, or add additional context after investigation. 
curl -X PUT 'https://api.cloud.blnkfinance.com/alerts/flag/ano_8a380fd1-0289-46d1-bc76-aa17a510a64e' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Balance threshold exceeded - Resolved",
    "description": "Account balance has been adjusted and is now within acceptable limits."
  }'

​
Get alerts

Fetch a specific alert by ID or retrieve all alerts in your workspace. 
# Get all alerts
curl -X GET 'https://api.cloud.blnkfinance.com/alerts' \
  -H 'Authorization: Bearer YOUR_API_KEY'

# Get specific alert by ID
curl -X GET 'https://api.cloud.blnkfinance.com/alerts/ano_8a380fd1-0289-46d1-bc76-aa17a510a64e' \
  -H 'Authorization: Bearer YOUR_API_KEY'

​
Need help?

If you’re having trouble with Blnk Cloud, don’t hesitate to send us a message via email at support@blnkfinance.com or send us a message here.