Get Alert Configuration Details

alertConfigurationDetails returns all alert configurations associated with the authenticated Bolt Cloud account.
This includes alert types, thresholds, enabled status, device associations, and notification rules.

Useful for:

  • Displaying existing alert rules in dashboards

  • Debugging incorrect alert behavior

  • Syncing server-side alert settings with client UI

  • Managing enterprise alert workflows


Endpoint

https://cloud.boltiot.com/remote/{API_KEY}/alertConfigurationDetails

Replace {API_KEY} with your Bolt Cloud API key

Response Format

The response is a JSON object with the following fields:

Field

Type

Description

success

number

1 on success, 0 on failure

value

array

List of alert configuration objects

Each alert configuration object in value contains:

Field

Type

Description

_id

string

Internal alert configuration identifier

name

string

Name of the alert

user_id

string

Account identifier

devices

array

Array of Bolt device IDs this alert applies to

triggers

array

Rules and thresholds for the alert

timezone

string

Timezone used for alert scheduling

days

array

Days on which the alert is active

from_time

string

Start time for alert monitoring

to_time

string

End time for alert monitoring

enabled

boolean

Whether the alert is currently active

Each trigger object includes:

Field

Type

Description

alert_type

string

Notification channel: "email" or "sms"

type

string

Data variable monitored — e.g., CSV1

comparison

string

Condition operator (>, <, etc.)

value

number

Threshold value

message

string

Notification message template

recipients

string

Array of configured recipients

one_time_alert

boolean

Whether alert triggers once or continuously

is_online_status_allowed

boolean

Online/offline status condition

Example:

Request

https://cloud.boltiot.com/remote/44b2de.../alertConfigurationDetails

Response

{
"value": [
{
"_id": "{'$oid': '6667d888f3b3c68455063322'}",
"timezone": "Asia/Kolkata",
"user_id": "453eb1cf-c6d4-5b56-a343-c11d27318e63",
"triggers": [
{
"alert_type": "email",
"is_online_status_allowed": false,
"type": "CSV1",
"message": "Humidity of {device_name} has gone above {trigger_value}. The current value is {value}. Please take action.",
"comparison": ">",
"value": 95,
"recipients": "[\"alert@example.com\"]",
"one_time_alert": true
}
],
"to_time": "23:59",
"devices": ["14619149"],
"days": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"],
"from_time": "00:00",
"enabled": true,
"name": "EMAIL_HUM_HIGH_2"
}
],
"success": 1
}

Notes for Developers and Agents

  • One API call returns all alert configurations for the account

  • Recommended for:

    • Account-level alert audit

    • UI configuration sync

    • Bulk alert review in enterprise deployments

  • Always check success === 1 before reading the value list

  • Alerts returned here match what is visible to the user in Bolt Cloud


Error Handling

If the API key is invalid or the request fails, success will be 0.

Example:

{
"success": 0
}

Recommendation: Check success before evaluating value.


Was this article helpful?
© 2025 Bolt IoT Documentation