v1

latestOpenAPI 3.0.02026-07-26117198177.4 KB

Alert Templates

Get a single alert rule template

Returns everything about one alert rule template — its message, severity, tags, and the fields you need to fill in when turning it into an active alert rule.

get/v1/risk/alert-templates/{template_id}

Path parameters

template_idstring required

Example:1

The ID of the alert rule template you want to retrieve.

Response

idstring required

Unique identifier of the alert rule template.

typestring required

Internal rule type identifier used by the alert engine.

labelstring required

Short display name for the template.

descriptionstring required

Message template sent when the rule fires. Supports {{variable}} placeholders.

networkstring required

Network slug this template targets.

severity'low' | 'medium' | 'high' required

Risk severity of alerts produced by this template.

tagsstring[] required

Categorisation tags for filtering and discovery.

trigger'BLOCK' | 'TICK' required

Whether the template is evaluated per block or per tick.

Example response

{
  "id": "1",
  "type": "large_transfer",
  "label": "Large Transfer",
  "description": "A large transfer was detected on {{network}}",
  "network": "eth",
  "severity": "high",
  "tags": [
    "defi",
    "transfer"
  ],
  "trigger": "BLOCK",
  "parameters": [
    {
      "label": "Wallet",
      "description": "The address to monitor",
      "field": "address",
      "field_type": "Address"
    }
  ]
}