Jump to

• Request
• Response

Retrieve a Notification

get

/api/v2/notifications/{id}/

Make GET request to this resource to retrieve a single notification record containing the following fields:

• id: Database ID for this notification. (integer)
• type: Data type for this notification. (choice)
• url: URL for this notification. (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 was created. (datetime)
• modified: Timestamp when this notification was last modified. (datetime)
• notification_template: (id)
• error: (string)
• status: (choice)
  • pending: Pending
  • successful: Successful
  • failed: Failed
• notifications_sent: (integer)
• notification_type: (choice)
  • email: Email
  • grafana: Grafana
  • irc: IRC
  • mattermost: Mattermost
  • pagerduty: Pagerduty
  • rocketchat: Rocket.Chat
  • slack: Slack
  • twilio: Twilio
  • webhook: Webhook
• recipients: (string)
• subject: (string)
• body: Notification body (json)

Request

Supported Media Types

• application/json

Path Parameters

• id: string

Query Parameters

• search(optional): string
  A search term.

Back to Top

Response

200 Response

Back to Top