Notification Channels API
Contents
POST
/v2/notifications/
Path Parameters
type*
String
The type of notification channel to create.
description*
String
A name for the channel.
destination*
String
The destination for the notification. ie the email address for email, slack webhook URL for slack, etc.
auto_resolve
String
Only used by VictorOps and PagerDuty channels. Defaults to false. More info here.
HTTP/1.1 201
Content-Type: application/json
{
"id": "id",
"url": "/v2/notifications/<notification_id>"
}
Request format:
HTTP/1.1 200
Content-Type: application/json
{
"type": "email" | "pagerduty" | "slack" | "webhook" | "victorops" | "opsgenie",
"description": "Descriptive name for channel",
"destination": "Destination key of the channel.",
"auto_resolve": True | False
}
Curl example
curl -H "Content-Type: application/json" -X POST -d \
'{"type": "email", "description": "A test notification", "destination": "[email protected]"}' \
"https://[email protected]/v2/notifications/"
GET
/v2/notifications/?query
Returns a JSON object containing information on notification channels matching the search query. Returns all the notifications if the parameter is left empty.
Path Parameters
type
String
Format: &type=<type_1>&type=<type_2>
The notification type to search for. Can specify multiple types to search for more than 1.
description
String
Format: &descriptions=<descriptions_1>&descriptions=<descriptions_2>
The descriptions to search for. Can specify multiple descriptions to search for more than 1.
id
String
Format: &id=<id_1>&id=<id_2>
The notification id to search for. Can specify multiple ids to search for more than 1.
page
String
Format: &page=1
The page number to query. Used if there are more items than can be displayed in a single request (default: 1).
max
String
Format: &max=50
The maximum number of items to display. Limit of 100 (default: 100).
auto_resolve
String
For use with VictorOps and PagerDuty channels only.
HTTP/1.1 200
Content-Type: application/json
{
"notifications": [
{
"type": "email",
"destination": "[email protected]",
"description": "Email notification channel",
"id": "notification_channel_1",
"auto_resolve": true
},
{
"type": "slack",
"destination": "https://slack-webhook-url.com",
"description": "Slack notification channel",
"id": "notification_channel_2",
"auto_resolve": false
}
],
"next_page": false
}
Curl example
curl -X GET "https://[email protected]/v2/notifications/?type=email&type=slack"
Specifying multiple fields performs an OR
operation and returns notifications that match either criteria.
GET
/v2/notifications/<notification_id>/
Returns a single notification identified by the notification id.
Path Parameters
type*
String
The type of notification channel to create.
description*
String
A name for the channel.
destination*
String
The destination for the notification. ie the email address for email, slack webhook URL for slack, etc.
auto_resolve
String
Only used by VictorOps and PagerDuty channels. Defaults to false.
HTTP/1.1 200
Content-Type: application/json
{
"type": "email",
"description": "Primary email notification channel",
"destination": "[email protected]",
"id": "notification_channel_1",
"auto_resolve": true
}
Curl example
curl -X GET "https://[email protected]/v2/notification/123-456-789/"
Obtain information of the notification channel identified by the id 123-456-789
.
PUT
/v2/notifications/<notification_id>/
Updates a notification channel identified by the notification id.
Path Parameters
type
String
The type of notification channel to create.
description
String
A name for the channel.
destination
String
The destination for the notification. ie the email address for email, slack webhook URL for slack, etc.
auto_resolve
String
Only used by VictorOps and PagerDuty channels. Defaults to false.
HTTP/1.1 200
Content-Type: application/json
{
"type": "slack",
"description": "Slack notification channel",
"destination": "https://slack-webhook-url.com",
"id": "notification_channel_2",
"auto_resolve": false
}
Curl example
curl -H "Content-Type: application/json" -X PUT \
-d '{"destination": "[email protected]"}' \
"https://[email protected]/v2/notifications/123-456-789/"
Updates the destination of notification 123-456-789
. Each field is optional and only the specified fields are updated.
DELETE /v2/notifications/<notification_id>/
- Deletes a notification channel identified by the notification id.
Curl example
curl -X DELETE "https://[email protected]/v2/notifications/123-456-789/"
Delete the notification channel identified by the id 123-456-789
.
Status Codes:
200 - OK
404 - Notification channel doesn’t exist.
Last updated
Was this helpful?