# Active channel Alerts
API call format
GET /channels/{<workflow_id>}/alerts
Description
List all active channels alerts (active at the momment of invoke). Every alert has corresponding alarmId, alert type and text message.
Precondition
- Authorization token is needed.
- Mandatory elements (should be specified):
- <workflow_id> - valid workflow id. Take a workflow id using Workflow List API call.
- We have existing workflow channel.
Postcondition
- On success response code should be 200
- On success all active failures(If any) registered will be listed.
- On failure an error will be returned with the right error code and description.
Example:
[Request] GET https://<base_api_url>/channels/<workflow_id>/alerts
[Request Headers] {"Content-Type":"application/json","Accept":"application/json","Authorization":"<IdToken>"}
[Response]200
[Request Cookies] []
[Response Headers] {"Content-Type":["application/json"],"Connection":["keep-alive"],....}
[Response]
{
"items": [
{
"alarmId": "c16ae8b3ff67073e3b550dae796914a174133aea",
"workflowId": "d9ba8302-45e7-49a2-983c-74a0dc9c0fe9",
"sortKey": "40fab054-6e84-49bc-a217-45740068a7dc",
"state": "SET",
"type": "Audio Not Detected",
"pipeline": "0",
"message": "[1] Audio not detected: Check input signal"
},
{
"alarmId": "414f07f477fd8dcb26e552efd3449704f9ec901f",
"workflowId": "d9ba8302-45e7-49a2-983c-74a0dc9c0fe9",
"sortKey": "49e9a499-3100-46a0-8956-723722b81262",
"state": "SET",
"type": "RTMP channel Not Found",
"pipeline": "0",
"message": "Searching for RTMP Push channel [channel], which does not exist at this time"
},
.......
]
}