Retrieve a Notification Template
get
/api/v2/notification_templates/{id}/
Make GET request to this resource to retrieve a single notification template record containing the following fields:
id
: Database ID for this notification template. (integer)type
: Data type for this notification template. (choice)url
: URL for this notification template. (string)related
: Data structure with URLs of related resources. (object)summary_fields
: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created
: Timestamp when this notification template was created. (datetime)modified
: Timestamp when this notification template was last modified. (datetime)name
: Name of this notification template. (string)description
: Optional description of this notification template. (string)organization
: (id)notification_type
: (choice)email
: Emailgrafana
: Grafanairc
: IRCmattermost
: Mattermostpagerduty
: Pagerdutyrocketchat
: Rocket.Chatslack
: Slacktwilio
: Twiliowebhook
: Webhook
notification_configuration
: (json)messages
: Optional custom messages for notification template. (json)
Request
Supported Media Types
- application/json
Path Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
Root Schema : NotificationTemplate
Type:
Show Source
object
-
created:
string
Title:
Created
Read Only:true
-
description:
string
Title:
Description
-
id:
integer
Title:
ID
Read Only:true
-
messages:
object Messages
Title:
Messages
Optional custom messages for notification template. -
modified:
string
Title:
Modified
Read Only:true
-
name(required):
string
Title:
Name
Minimum Length:1
Maximum Length:512
-
notification_configuration:
object Notification configuration
Title:
Notification configuration
-
notification_type(required):
string
Title:
Notification type
Allowed Values:[ "email", "grafana", "irc", "mattermost", "pagerduty", "rocketchat", "slack", "twilio", "webhook" ]
-
organization(required):
integer
Title:
Organization
- related: string
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true
Nested Schema : Messages
Type:
object
Title:
Messages
Optional custom messages for notification template.
Default Value:
{
}
Nested Schema : Notification configuration
Type:
object
Title:
Notification configuration