Get the alert-rule event catalogue

GET

https://staging.cail.health/v1/alert-rules/catalog

GET

/v1/alert-rules/catalog

$ curl https://staging.cail.health/v1/alert-rules/catalog \
>      -H "Authorization: Bearer <token>"

200A two-entry catalogue

1 {
2   "data": [
3     {
4       "eventType": "a_and_e_diversion_rate",
5       "label": "A&E diversion rate",
6       "description": "Fires when the diversion rate falls below the configured threshold.",
7       "defaultCondition": {
8         "field": "avoidanceRate",
9         "operator": "<",
10         "value": 0.6
11       },
12       "supportedChannels": [
13         "in-app",
14         "email",
15         "both"
16       ]
17     },
18     {
19       "eventType": "prem_satisfaction",
20       "label": "PREM satisfaction",
21       "description": "Fires when average PREM rating falls below the configured threshold.",
22       "defaultCondition": {
23         "field": "averageRating",
24         "operator": "<",
25         "value": 3
26       },
27       "supportedChannels": [
28         "in-app",
29         "email",
30         "both"
31       ]
32     }
33   ]
34 }

Returns the catalogue of alert-rule event types the platform supports, including a default condition and supported delivery channels for each. Use this to populate the alert-rule authoring UI.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

The catalogue.

datalist of objects

Available alert-rule event types and their defaults.