> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.cail.health/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cail.health/_mcp/server.

# Get the alert-rule event catalogue

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

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.

Reference: https://docs.cail.health/api-references/api-reference/configure-access-policy/catalog

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: cail-api
  version: 1.0.0
paths:
  /v1/alert-rules/catalog:
    get:
      operationId: catalog
      summary: Get the alert-rule event catalogue
      description: >-
        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.
      tags:
        - subpackage_configureAccessPolicy
      parameters:
        - name: Authorization
          in: header
          description: Bearer authentication
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The catalogue.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertRuleCatalogResponse'
servers:
  - url: https://staging.cail.health
    description: https://staging.cail.health
components:
  schemas:
    AlertRuleConditionOperator:
      type: string
      enum:
        - <
        - '>'
        - <=
        - '>='
        - '='
      description: Comparison operator.
      title: AlertRuleConditionOperator
    AlertRuleCondition:
      type: object
      properties:
        field:
          type: string
          description: Field name on the alert event the condition evaluates against.
        operator:
          $ref: '#/components/schemas/AlertRuleConditionOperator'
          description: Comparison operator.
        value:
          type: number
          format: double
          description: Numeric threshold the field is compared against.
      required:
        - field
        - operator
        - value
      title: AlertRuleCondition
    AlertRuleCatalogEntrySupportedChannelsItems:
      type: string
      enum:
        - in-app
        - email
        - both
      title: AlertRuleCatalogEntrySupportedChannelsItems
    AlertRuleCatalogEntry:
      type: object
      properties:
        eventType:
          type: string
          description: Event-type code this catalogue entry describes.
        label:
          type: string
          description: Human-readable label for the event type.
        description:
          type: string
          description: Free-text description of the event type.
        defaultCondition:
          oneOf:
            - $ref: '#/components/schemas/AlertRuleCondition'
            - type: 'null'
          description: >-
            Catalogue-recommended default condition. May be null when no default
            applies.
        supportedChannels:
          type: array
          items:
            $ref: '#/components/schemas/AlertRuleCatalogEntrySupportedChannelsItems'
          description: Delivery channels the event supports.
      required:
        - eventType
        - label
        - description
        - defaultCondition
        - supportedChannels
      title: AlertRuleCatalogEntry
    AlertRuleCatalogResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AlertRuleCatalogEntry'
          description: Available alert-rule event types and their defaults.
      required:
        - data
      title: AlertRuleCatalogResponse
  securitySchemes:
    auth0Bearer:
      type: http
      scheme: bearer

```

## Examples



**Response**

```json
{
  "data": [
    {
      "eventType": "a_and_e_diversion_rate",
      "label": "A&E diversion rate",
      "description": "Fires when the diversion rate falls below the configured threshold.",
      "defaultCondition": {
        "field": "avoidanceRate",
        "operator": "<",
        "value": 0.6
      },
      "supportedChannels": [
        "in-app",
        "email",
        "both"
      ]
    },
    {
      "eventType": "prem_satisfaction",
      "label": "PREM satisfaction",
      "description": "Fires when average PREM rating falls below the configured threshold.",
      "defaultCondition": {
        "field": "averageRating",
        "operator": "<",
        "value": 3
      },
      "supportedChannels": [
        "in-app",
        "email",
        "both"
      ]
    }
  ]
}
```

**SDK Code**

```python A two-entry catalogue
import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript A two-entry catalogue
const url = 'https://staging.cail.health/v1/alert-rules/catalog';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go A two-entry catalogue
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby A two-entry catalogue
require 'uri'
require 'net/http'

url = URI("https://staging.cail.health/v1/alert-rules/catalog")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java A two-entry catalogue
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://staging.cail.health/v1/alert-rules/catalog")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php A two-entry catalogue
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://staging.cail.health/v1/alert-rules/catalog', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp A two-entry catalogue
using RestSharp;

var client = new RestClient("https://staging.cail.health/v1/alert-rules/catalog");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift A two-entry catalogue
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://staging.cail.health/v1/alert-rules/catalog")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```