Notification Channels API
Contents
POST /v2/notifications/
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/"
Parameters:
- type[REQUIRED]The type of notification channel to create.
- description[REQUIRED]A name for the channel.
- destination[REQUIRED]The destination for the notification. ie the email address for email, slack webhook URL for slack, etc.
- auto_resolveOnly used by VictorOps and PagerDuty channels. Defaults to false. More info here.
Response format:
HTTP/1.1 201
Content-Type: application/json
{
"id": "id",
"url": "/v2/notifications/<notification_id>"
}
Parameters:
- idAn id that uniquely identifies this notification.
- urlURL endpoint that can used to identify and manipulate this notification.
Status Codes:
- 201 - Created
- 404 - Invalid form data.
- 409 - Channel with the description already exists.
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.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.Available query parameters (default values in brackets):
- typeFormat:
&type=<type_1>&type=<type_2>
The notification type to search for. Can specify multiple types to search for more than 1. - descriptionFormat:
&descriptions=<descriptions_1>&descriptions=<descriptions_2>
The descriptions to search for. Can specify multiple descriptions to search for more than 1. - idFormat:
&id=<id_1>&id=<id_2>
The notification id to search for. Can specify multiple ids to search for more than 1. - page (1)Format:
&page=1
The page number to query. Used if there are more items than can be displayed in a single request. - max (100)Format:
&max=50
The maximum number of items to display. Limit of 100.
Response format:
HTTP/1.1 200
Content-Type: application/json
{
"notifications": [
{
"type": "email" | "pagerduty" | "slack" | "webhook" | "victorops" | "opsgenie",
"destination": "The destination for the notification",
"description": "Descriptive name for channel",
"id": "notification channel id",
"auto_resolve": True | False
}
]
"next_page": False | page number
}
Parameters:
- notificationsThe list of notifications is formatted in the following.
- pageURL endpoint that can be used to perform actions on this notification.
Status Codes:
- 200 - OK
- 400 - Invalid form data.
Notes
auto_resolve
is for use with VictorOps and PagerDuty channels only.
GET /v2/notifications/<notification_id>/
- Returns a single notification identified by the notification id.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
.Response 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."
"id": "notification channel id",
"auto_resolve": True | False
}
Status Codes:
- 200 - OK
- 404 - Notification doesn’t exist
Notes
auto_resolve
is for use with VictorOps and PagerDuty channels only.
PUT /v2/notifications/<notification_id>/
- Updates a notification channel identified by the notification id.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
.Request format:
{
"type": "email" | "pagerduty" | "slack" | "webhook" | "victorops" | "opsgenie",
"description": "descriptive name for channel",
"destination": "Destination key of the channel.",
"auto_resolve": True | False
}
Each field is optional and only the specified fields are updated.
Status Codes:
200 - OK 400 - Invalid form data. 404 - Alert doesn’t exist. 409 - Notification channel with the description already exists.
Notes
auto_resolve
is for use with VictorOps and PagerDuty channels only.
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 modified 1mo ago