Alerts
Get alert
Retrieve one alert, or every alert when the id is omitted.
/alerts/{alert_id}Retrieve alerts from your workspace. If you don’t include an alert ID in the path, the endpoint returns all alerts.
Enterprise authentication
Send these requests to https://api.cloud.blnkfinance.com on Blnk Cloud. On a self-hosted Enterprise deployment, send them to ENTERPRISE_PUBLIC_URL.
Pass an Enterprise API key, or an OAuth access token, in the X-blnk-key header. Create the key in Enterprise API keys, or issue a token with Enterprise OAuth.
This credential comes from the Cloud or Enterprise workspace. A Core API key belongs to the Core instance.
X-blnk-keystring
Enterprise API key, or an OAuth access token.
Path
alert_idstring
Optional. Unique identifier for a specific alert to retrieve. Omit to retrieve all alerts.
Response
anomaly_idstring
Unique identifier for the alert.
titlestring
The title of the alert, if provided.
descriptionstring
The description of the alert.
typestring
The type or category of the alert (e.g., “Balance”, “Transaction”, “Identity”).
assigned_tostring
The name or identifier of the user assigned to handle the alert.
escalated_toarray
Array of user identifiers to whom the alert has been escalated.
statusstring
The current status of the alert (e.g., “FLAGGED”).
created_attimestamp
ISO 8601 formatted timestamp of when the alert was created.
updated_attimestamp
ISO 8601 formatted timestamp of when the alert was last updated.
affected_balancesarray
Array of balance IDs affected by this alert.
affected_identitiesarray
Array of identity IDs affected by this alert.
affected_transactionsarray
Array of transaction IDs affected by this alert.