Skip to main content
GET
Get a single alert rule template

Authorizations

X-API-KEY
string
header
required

Authorization method required to allow user to access the api endpoints.

Path Parameters

template_id
string
required

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

Example:

"1"

Response

200 - application/json
id
string
required

Unique identifier of the alert rule template.

Example:

"1"

type
string
required

Internal rule type identifier used by the alert engine.

Example:

"large_transfer"

label
string
required

Short display name for the template.

Example:

"Large Transfer"

description
string
required

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

Example:

"A large transfer was detected on {{network}}"

network
string
required

Network slug this template targets.

Example:

"eth"

severity
enum<string>
required

Risk severity of alerts produced by this template.

Available options:
low,
medium,
high
Example:

"high"

tags
string[]
required

Categorisation tags for filtering and discovery.

Example:
trigger
enum<string>
required

Whether the template is evaluated per block or per tick.

Available options:
BLOCK,
TICK
Example:

"BLOCK"

parameters
object[]
required

Parameters the user must supply when creating an alert rule from this template.

Last modified on July 22, 2026