Alerts

Alert statuses

Manage custom alert statuses with names and colours.

Alert statuses let you define custom names and colours for the statuses you use on alerts. You can create statuses like “Pending”, “In Review”, or “Fraud review” and assign each a colour so they’re easy to spot in your Alerts table and details.

You can find it in Settings > Alert statuses.

View alert statuses

The Alert statuses page lists all custom statuses for your organization. For each status you can see:

• Name: The display name (e.g. “Fraud review”, “In Review”, “Pending”).
• Colour: A colour swatch and hex code (e.g. #3B82F6, #84CC16). Colours must be one of the allowed values.

Use the Actions menu (three dots) on a row to edit or delete that status.

Using the API

Call List alert statuses. data is your statuses. allowed_colours is the hex codes you can set on create or update.

curl -X GET 'https://api.cloud.blnkfinance.com/alerts/statuses' \
  -H 'X-blnk-key: CLOUD_API_KEY'

Each status has a key, such as PENDING_REVIEW. Use that key when you set an alert’s status. Field details are on List alert statuses.

Add a status

Click + Add status in the top-right corner.

• Name: a name for the status (for example, “Pending Review” or “In Progress”)
• Colour: one of the allowed options

Click Add status.

The new status will appear in the list and can be used when updating alerts.

Using the API

Call Create alert status. name and colour are required. colour has to be one of allowed_colours from List alert statuses.

If you omit key, Blnk derives one from the name. “Pending Review” becomes PENDING_REVIEW.

curl -X POST 'https://api.cloud.blnkfinance.com/alerts/statuses' \
  -H 'X-blnk-key: CLOUD_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Pending Review",
    "colour": "#3B82F6"
  }'

Edit a status

1. On the Alert statuses page, open the Actions menu (three dots) for the status you want to change.
2. Select Edit.
3. Update the Name and/or Colour.
4. Click Save.

Using the API

Call Update alert status with the status key. The key is case-insensitive. The key stays the same when the name or colour changes.

curl -X PUT 'https://api.cloud.blnkfinance.com/alerts/statuses/PENDING_REVIEW' \
  -H 'X-blnk-key: CLOUD_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Awaiting Review",
    "colour": "#10B981"
  }'

Delete a status

1. On the Alert statuses page, open the Actions menu (three dots) for the status.
2. Select Delete.
3. Confirm the deletion.

If any alerts still use this status, you must reassign them to another status before you can delete it.

Using the API

Call Delete alert status with the status key. The delete fails while any alert still uses that status. Reassign those alerts with Update alert, then delete the status again.

curl -X DELETE 'https://api.cloud.blnkfinance.com/alerts/statuses/PENDING_REVIEW' \
  -H 'X-blnk-key: CLOUD_API_KEY'