Create Notificant

Create Notificant

Create a notification target

Request
URI
POST
https://{api_host}/api/v2/notificant
COPY
Request Body
Notificant of type(s) application/json
Optional 
{
    "method": "string",
    "id": "string",
    "contentType": "string",
    "description": "string",
    "createdEpochMillis": 0,
    "updatedEpochMillis": 0,
    "title": "string",
    "customerId": "string",
    "triggers": [
        "string"
    ],
    "template": "string",
    "recipient": "string",
    "emailSubject": "string",
    "isHtmlContent": false,
    "routes": [
        {
            "method": "string",
            "target": "string",
            "filter": "string"
        }
    ],
    "creatorId": "string",
    "updaterId": "string"
}
string
method
Required

The notification method used for notification target.

Possible values are : WEBHOOK, EMAIL, PAGERDUTY,
string
id
Optional

id

string
contentType
Optional

The value of the Content-Type header of the webhook POST request.

Possible values are : application/json, text/html, text/plain, application/x-www-form-urlencoded, ,
string
description
Required

Description

integer As int64 As int64
createdEpochMillis
Optional

createdEpochMillis

integer As int64 As int64
updatedEpochMillis
Optional

updatedEpochMillis

string
title
Required

Title

string
customerId
Optional

customerId

array of string
triggers
Required

A list of occurrences on which this webhook will be fired. Valid values are ALERT_OPENED, ALERT_UPDATED, ALERT_RESOLVED, ALERT_MAINTENANCE, ALERT_SNOOZED

Possible values are : ALERT_OPENED, ALERT_UPDATED, ALERT_RESOLVED, ALERT_MAINTENANCE, ALERT_SNOOZED, ALERT_INVALID, ALERT_NO_LONGER_INVALID, ALERT_TESTING, ALERT_RETRIGGERED, ALERT_NO_DATA, ALERT_NO_DATA_RESOLVED, ALERT_NO_DATA_MAINTENANCE, ALERT_SEVERITY_UPDATE, ALERT_NOTIFICATION_PREVIEW,
string
template
Required

A mustache template that will form the body of the POST request, email and summary of the PagerDuty.

string
recipient
Required

The end point for the notification target.EMAIL: email address. PAGERDUTY: PagerDuty routing Key. WEBHOOK: URL end point

object
customHttpHeaders
Optional

A string->string map specifying the custom HTTP header key / value pairs that will be sent in the requests of this web hook

string
emailSubject
Optional

The subject title of an email notification target

boolean
isHtmlContent
Optional

Determine whether the email alert target content is sent as html or text.

array of AlertRoute
routes
Optional

List of routing targets that this notificant will notify.

string
creatorId
Optional

creatorId

string
updaterId
Optional

updaterId

Authentication
This operation uses the following authentication methods.
Responses
200

successful operation

Returns ResponseContainerNotificant of type(s) application/json 
{
    "status": {
        "result": "string",
        "message": "string",
        "code": 0
    },
    "response": {
        "method": "string",
        "id": "string",
        "contentType": "string",
        "description": "string",
        "createdEpochMillis": 0,
        "updatedEpochMillis": 0,
        "title": "string",
        "customerId": "string",
        "triggers": [
            "string"
        ],
        "template": "string",
        "recipient": "string",
        "emailSubject": "string",
        "isHtmlContent": false,
        "routes": [
            {
                "method": "string",
                "target": "string",
                "filter": "string"
            }
        ],
        "creatorId": "string",
        "updaterId": "string"
    }
}
ResponseStatus
status
Required

status

Notificant
response
Optional

response


On This Page
Notificant Operations
POST
Create Notificant
DELETE
Delete Notificant
GET
Get All Notificants
GET
Get Notificant
POST
Test Notificant
PUT
Update Notificant