Skip to main content
GET
/
alert_templates
/
{alert_template_id}
Get an alert template
curl --request GET \
  --url https://api.togai.com/alert_templates/{alert_template_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "abcd-efgh-ijkl-mnop",
  "name": "Alert1",
  "desc": "Alert1 Description",
  "entitySchema": "{\"type\":\"object\",\"properties\":{\"usageMeterId\":{\"type\":\"string\"}}}",
  "entityType": "UsageMeter",
  "interval": "30",
  "parametersSchema": "{\"type\":\"object\",\"properties\":{\"threshold\":{\"type\":\"number\"}}}",
  "ownerSchema": "{\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\"}}}",
  "ownerType": "Account",
  "createdAt": "2020-01-01T00:00:00Z",
  "updatedAt": "2020-01-01T00:00:00Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
alert_template_id
string
required
Example:

"abcd-efgh-ijkl-mnop"

Response

Response for getting alert template

​
id
string
required

Alert Template ID

​
name
string
required

Alert Template Name

​
interval
integer
required

Cron Interval

​
createdAt
string<date-time>
required

Created At

​
description
string

Alert Template Description

​
entitySchema
string

Entity Schema

​
entityType
string

Entity Type

​
ownerSchema
string

Owner Schema

​
ownerType
string

Owner Type

​
parametersSchema
string

Parameters Schema

​
updatedAt
string<date-time>

Updated At