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: Email
    • grafana: Grafana
    • irc: IRC
    • mattermost: Mattermost
    • pagerduty: Pagerduty
    • rocketchat: Rocket.Chat
    • slack: Slack
    • twilio: Twilio
    • webhook: Webhook
  • notification_configuration: (json)
  • messages: Optional custom messages for notification template. (json)

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

Body ()
Root Schema : NotificationTemplate
Type: object
Show Source
Nested Schema : Messages
Type: object
Title: Messages
Optional custom messages for notification template.
Default Value: { }
Nested Schema : Notification configuration
Type: object
Title: Notification configuration
Back to Top