Notifications API - JSON models

Parameters JSON example

The AnsibleTowerNotificationConfig object

Configuration of the Ansible Tower notification.

Element	Type	Description	Required
id	string	The ID of the notification configuration.	optional
name	string	The name of the notification configuration.	required
alertingProfile	string	The ID of the associated alerting profile.	required
active	boolean	The configuration is enabled (`true`) or disabled (`false`).	required
type	string	Defines the actual set of fields depending on the value: EMAIL -> EmailNotificationConfig PAGER_DUTY -> PagerDutyNotificationConfig WEBHOOK -> WebHookNotificationConfig SLACK -> SlackNotificationConfig HIPCHAT -> HipChatNotificationConfig VICTOROPS -> VictorOpsNotificationConfig SERVICE_NOW -> ServiceNowNotificationConfig XMATTERS -> XMattersNotificationConfig ANSIBLETOWER -> AnsibleTowerNotificationConfig OPS_GENIE -> OpsGenieNotificationConfig JIRA -> JiraNotificationConfig TRELLO -> TrelloNotificationConfig The type element can hold these values.	required
jobTemplateURL	string	The URL of the target Ansible Tower job template.	required
acceptAnyCertificate	boolean	Accept any, including self-signed and invalid, SSL certificate (`true`) or only trusted (`false`) certificates.	required
username	string	The username of the Ansible Tower account.	required
password	string	The password for the Ansible Tower account.	optional
jobTemplateID	integer	The ID of the target Ansible Tower job template.	required
customMessage	string	The custom message of the notification. This message will be displayed in the extra variables Message field of your job template. You can use the following placeholders: `{ImpactedEntities}`: Details about the entities impacted by the problem in form of a JSON array. `{ImpactedEntity}`: The entity impacted by the problem or X impacted entities. `{PID}`: The ID of the reported problem. `{ProblemDetailsText}`: All problem event details, including root cause, as a text-formatted string. `{ProblemID}`: The display number of the reported problem. `{ProblemImpact}`: The impact level of the problem. Possible values are `APPLICATION`, `SERVICE`, and `INFRASTRUCTURE`. `{ProblemSeverity}`: The severity level of the problem. Possible values are `AVAILABILITY`, `ERROR`, `PERFORMANCE`, `RESOURCE_CONTENTION`, and `CUSTOM_ALERT`. `{ProblemTitle}`: A short description of the problem. `{ProblemURL}`: The URL of the problem within DESK. `{State}`: The state of the problem. Possible values are `OPEN` and `RESOLVED`. If the problem has been merged into another problem, it has the `MERGED` value. `{Tags}`: The list of tags that are defined for all impacted entities, separated by commas.	required

Possible values

Possible values for the type element:

EMAIL
PAGER_DUTY
WEBHOOK
SLACK
HIPCHAT
VICTOROPS
SERVICE_NOW
XMATTERS
ANSIBLETOWER
OPS_GENIE
JIRA
TRELLO

{
  "type": "ANSIBLETOWER",
  "id": "da08eb4e-29c2-4bf2-be24-7e424959e8ab",
  "name": "My AnsibleTower notification",
  "alertingProfile": "c21f969b-5f03-333d-83e0-4f8f136e7682",
  "active": true,
  "jobTemplateURL": "https://myDomain.compute.amazonaws.com/#/templates/job_template/10",
  "acceptAnyCertificate": true,
  "username": "jsmith",
  "password": null,
  "jobTemplateID": 10,
  "customMessage": "{ImpactedEntity} Problem {ProblemID}: {State}"
}

Parameters JSON example

The EmailNotificationConfig object

Configuration of the email notification.

Element	Type	Description	Required
id	string	The ID of the notification configuration.	optional
name	string	The name of the notification configuration.	required
alertingProfile	string	The ID of the associated alerting profile.	required
active	boolean	The configuration is enabled (`true`) or disabled (`false`).	required
type	string	Defines the actual set of fields depending on the value: EMAIL -> EmailNotificationConfig PAGER_DUTY -> PagerDutyNotificationConfig WEBHOOK -> WebHookNotificationConfig SLACK -> SlackNotificationConfig HIPCHAT -> HipChatNotificationConfig VICTOROPS -> VictorOpsNotificationConfig SERVICE_NOW -> ServiceNowNotificationConfig XMATTERS -> XMattersNotificationConfig ANSIBLETOWER -> AnsibleTowerNotificationConfig OPS_GENIE -> OpsGenieNotificationConfig JIRA -> JiraNotificationConfig TRELLO -> TrelloNotificationConfig The type element can hold these values.	required
subject	string	The subject of the email notifications.	required
body	string	The template of the email notification. You can use the following placeholders: `{ImpactedEntities}`: Details about the entities impacted by the problem in form of a JSON array. `{ImpactedEntity}`: The entity impacted by the problem or X impacted entities. `{PID}`: The ID of the reported problem. `{ProblemDetailsHTML}`: All problem event details, including root cause, as an HTML-formatted string. `{ProblemDetailsJSON}`: All problem event details, including root cause, as a JSON object. `{ProblemDetailsMarkdown}`: All problem event details, including root cause, as a Markdown-formatted string. `{ProblemDetailsText}`: All problem event details, including root cause, as a text-formatted string. `{ProblemID}`: The display number of the reported problem. `{ProblemImpact}`: The impact level of the problem. Possible values are `APPLICATION`, `SERVICE`, and `INFRASTRUCTURE`. `{ProblemSeverity}`: The severity level of the problem. Possible values are `AVAILABILITY`, `ERROR`, `PERFORMANCE`, `RESOURCE_CONTENTION`, and `CUSTOM_ALERT`. `{ProblemTitle}`: A short description of the problem. `{ProblemURL}`: The URL of the problem within DESK. `{State}`: The state of the problem. Possible values are `OPEN` and `RESOLVED`. If the problem has been merged into another problem, it has the `MERGED` value. `{Tags}`: The list of tags that are defined for all impacted entities, separated by commas.	required
receivers	string[]	The list of the email recipients.	required
ccReceivers	string[]	The list of the email CC-recipients.	optional
shouldSendForResolvedProblems	boolean	Send (`true`) or doesn't send (`false`) an email, confirming problem resolution.	required

Possible values

Possible values for the type element:

EMAIL
PAGER_DUTY
WEBHOOK
SLACK
HIPCHAT
VICTOROPS
SERVICE_NOW
XMATTERS
ANSIBLETOWER
OPS_GENIE
JIRA
TRELLO

{
  "type": "EMAIL",
  "id": "9972ea44-1e51-4567-a10b-8687b0c6d92c",
  "name": "My email notification",
  "alertingProfile": "c21f969b-5f03-333d-83e0-4f8f136e7682",
  "active": true,
  "subject": "{State} Problem {ProblemID}: {ImpactedEntity}",
  "body": "{ProblemDetailsHTML}",
  "receivers": [
    "john.smith@company.com"
  ],
  "ccReceivers": [
    "james.brownh@company.com"
  ],
  "shouldSendForResolvedProblems": true
}

Parameters JSON example

The HipChatNotificationConfig object

Configuration of the HipChat notification.

Element	Type	Description	Required
id	string	The ID of the notification configuration.	optional
name	string	The name of the notification configuration.	required
alertingProfile	string	The ID of the associated alerting profile.	required
active	boolean	The configuration is enabled (`true`) or disabled (`false`).	required
type	string	Defines the actual set of fields depending on the value: EMAIL -> EmailNotificationConfig PAGER_DUTY -> PagerDutyNotificationConfig WEBHOOK -> WebHookNotificationConfig SLACK -> SlackNotificationConfig HIPCHAT -> HipChatNotificationConfig VICTOROPS -> VictorOpsNotificationConfig SERVICE_NOW -> ServiceNowNotificationConfig XMATTERS -> XMattersNotificationConfig ANSIBLETOWER -> AnsibleTowerNotificationConfig OPS_GENIE -> OpsGenieNotificationConfig JIRA -> JiraNotificationConfig TRELLO -> TrelloNotificationConfig The type element can hold these values.	required
url	string	The URL of the HipChat WebHook. This is confidential information, therefore GET requests return this field with the `null` value, and it is optional for PUT requests.	optional
message	string	The content of the notification message. You can use the following placeholders: `{ImpactedEntity}`: The entity impacted by the problem or X impacted entities. `{PID}`: The ID of the reported problem. `{ProblemDetailsText}`: All problem event details, including root cause, as a text-formatted string. `{ProblemID}`: The display number of the reported problem. `{ProblemImpact}`: The impact level of the problem. Possible values are `APPLICATION`, `SERVICE`, and `INFRASTRUCTURE`. `{ProblemSeverity}`: The severity level of the problem. Possible values are `AVAILABILITY`, `ERROR`, `PERFORMANCE`, `RESOURCE_CONTENTION`, and `CUSTOM_ALERT`. `{ProblemTitle}`: A short description of the problem. `{ProblemURL}`: The URL of the problem within DESK. `{State}`: The state of the problem. Possible values are `OPEN` and `RESOLVED`. If the problem has been merged into another problem, it has the `MERGED` value. `{Tags}`: The list of tags that are defined for all impacted entities, separated by commas.	required

Possible values

Possible values for the type element:

EMAIL
PAGER_DUTY
WEBHOOK
SLACK
HIPCHAT
VICTOROPS
SERVICE_NOW
XMATTERS
ANSIBLETOWER
OPS_GENIE
JIRA
TRELLO

{
  "type": "HIPCHAT",
  "id": "ada688e4-216a-421e-91e6-76d1a56230c0",
  "name": "My HipChat notification",
  "alertingProfile": "4f5e00f4-39b3-455a-820b-3514843615f3",
  "active": true,  
  "url": "https://my.hipch.at/v2/room/myID/notification?auth_token=abcd1234 ",  
  "message": "Problem {ProblemID}: {ProblemTitle} \n\n {ProblemDetailsText}"
}

Parameters JSON example

The JiraNotificationConfig object

Configuration of the Jira notification.

Element	Type	Description	Required
id	string	The ID of the notification configuration.	optional
name	string	The name of the notification configuration.	required
alertingProfile	string	The ID of the associated alerting profile.	required
active	boolean	The configuration is enabled (`true`) or disabled (`false`).	required
type	string	Defines the actual set of fields depending on the value: EMAIL -> EmailNotificationConfig PAGER_DUTY -> PagerDutyNotificationConfig WEBHOOK -> WebHookNotificationConfig SLACK -> SlackNotificationConfig HIPCHAT -> HipChatNotificationConfig VICTOROPS -> VictorOpsNotificationConfig SERVICE_NOW -> ServiceNowNotificationConfig XMATTERS -> XMattersNotificationConfig ANSIBLETOWER -> AnsibleTowerNotificationConfig OPS_GENIE -> OpsGenieNotificationConfig JIRA -> JiraNotificationConfig TRELLO -> TrelloNotificationConfig The type element can hold these values.	required
username	string	The username of the Jira profile.	required
password	string	The password for the Jira profile.	optional
url	string	The URL of the Jira API endpoint.	required
projectKey	string	The project key of the Jira issue to be created by this notification.	required
issueType	string	The type of the Jira issue to be created by this notification.	required
summary	string	The summary of the Jira issue to be created by this notification. You can use the following placeholders: `{ImpactedEntity}`: The entity impacted by the problem or X impacted entities. `{PID}`: The ID of the reported problem. `{ProblemDetailsText}`: All problem event details, including root cause, as a text-formatted string. `{ProblemID}`: The display number of the reported problem. `{ProblemImpact}`: The impact level of the problem. Possible values are `APPLICATION`, `SERVICE`, and `INFRASTRUCTURE`. `{ProblemSeverity}`: The severity level of the problem. Possible values are `AVAILABILITY`, `ERROR`, `PERFORMANCE`, `RESOURCE_CONTENTION`, and `CUSTOM_ALERT`. `{ProblemTitle}`: A short description of the problem. `{ProblemURL}`: The URL of the problem within DESK. `{State}`: The state of the problem. Possible values are `OPEN` and `RESOLVED`. If the problem has been merged into another problem, it has the `MERGED` value. `{Tags}`: The list of tags that are defined for all impacted entities, separated by commas.	required
description	string	The description of the Jira issue to be created by this notification. You can use same placeholders as in issue summary.	required

Possible values

Possible values for the type element:

EMAIL
PAGER_DUTY
WEBHOOK
SLACK
HIPCHAT
VICTOROPS
SERVICE_NOW
XMATTERS
ANSIBLETOWER
OPS_GENIE
JIRA
TRELLO

{
  "type": "JIRA",
  "id": "acbed0c4-4ef1-4303-991f-102510a69322",
  "name": "My Jira notification",
  "alertingProfile": "4f5e00f4-39b3-455a-820b-3514843615f3",
  "active": true,
  "username": "john.smith",
  "password": "",
  "url": "https://my-jira.atlassian.net/rest/api/2/",
  "projectKey": "DEV",
  "issueType": "Task",
  "summary": "Problem {ProblemID}: {ProblemTitle}",
  "description": "{ProblemDetailsText}\n"
}

Parameters JSON example

The OpsGenieNotificationConfig object

Configuration of the OpsGenie notification.

Element	Type	Description	Required
id	string	The ID of the notification configuration.	optional
name	string	The name of the notification configuration.	required
alertingProfile	string	The ID of the associated alerting profile.	required
active	boolean	The configuration is enabled (`true`) or disabled (`false`).	required
type	string	Defines the actual set of fields depending on the value: EMAIL -> EmailNotificationConfig PAGER_DUTY -> PagerDutyNotificationConfig WEBHOOK -> WebHookNotificationConfig SLACK -> SlackNotificationConfig HIPCHAT -> HipChatNotificationConfig VICTOROPS -> VictorOpsNotificationConfig SERVICE_NOW -> ServiceNowNotificationConfig XMATTERS -> XMattersNotificationConfig ANSIBLETOWER -> AnsibleTowerNotificationConfig OPS_GENIE -> OpsGenieNotificationConfig JIRA -> JiraNotificationConfig TRELLO -> TrelloNotificationConfig The type element can hold these values.	required
apiKey	string	The API key to access OpsGenie.	optional
domain	string	The region domain of the OpsGenie.	required
message	string	The content of the message. You can use the following placeholders: `{ProblemID}`: The display number of the reported problem. `{ProblemImpact}`: The impact level of the problem. Possible values are `APPLICATION`, `SERVICE`, and `INFRASTRUCTURE`. `{ProblemSeverity}`: The severity level of the problem. Possible values are `AVAILABILITY`, `ERROR`, `PERFORMANCE`, `RESOURCE_CONTENTION`, and `CUSTOM_ALERT`. `{ProblemTitle}`: A short description of the problem.	required

Possible values

Possible values for the type element:

EMAIL
PAGER_DUTY
WEBHOOK
SLACK
HIPCHAT
VICTOROPS
SERVICE_NOW
XMATTERS
ANSIBLETOWER
OPS_GENIE
JIRA
TRELLO

{
  "type": "OPS_GENIE",
  "id": "bc805303-4c7e-416e-80ca-aa0d9f608fd4",
  "name": "My Opsgenie notification",
  "alertingProfile": "c21f969b-5f03-333d-83e0-4f8f136e7682",
  "active": false,
  "apiKey": null,
  "domain": "api.opsgenie.com",
  "message": "{ProblemImpact} Problem {ProblemID}"
}

Parameters JSON example

The PagerDutyNotificationConfig object

Configuration of the PagerDuty notification.

Element	Type	Description	Required
id	string	The ID of the notification configuration.	optional
name	string	The name of the notification configuration.	required
alertingProfile	string	The ID of the associated alerting profile.	required
active	boolean	The configuration is enabled (`true`) or disabled (`false`).	required
type	string	Defines the actual set of fields depending on the value: EMAIL -> EmailNotificationConfig PAGER_DUTY -> PagerDutyNotificationConfig WEBHOOK -> WebHookNotificationConfig SLACK -> SlackNotificationConfig HIPCHAT -> HipChatNotificationConfig VICTOROPS -> VictorOpsNotificationConfig SERVICE_NOW -> ServiceNowNotificationConfig XMATTERS -> XMattersNotificationConfig ANSIBLETOWER -> AnsibleTowerNotificationConfig OPS_GENIE -> OpsGenieNotificationConfig JIRA -> JiraNotificationConfig TRELLO -> TrelloNotificationConfig The type element can hold these values.	required
account	string	The name of the PagerDuty account.	required
serviceApiKey	string	The API key to access PagerDuty.	optional
serviceName	string	The name of the service.	required

Possible values

Possible values for the type element:

EMAIL
PAGER_DUTY
WEBHOOK
SLACK
HIPCHAT
VICTOROPS
SERVICE_NOW
XMATTERS
ANSIBLETOWER
OPS_GENIE
JIRA
TRELLO

{
  "type": "PAGER_DUTY",
  "id": "993213e1-a77b-4c76-80aa-044e073fd1bb",
  "name": "My PagerDuty notification",
  "alertingProfile": "c21f969b-5f03-333d-83e0-4f8f136e7682",
  "active": true,
  "account": "myPagerDuty",
  "serviceApiKey": "9876zyxw",
  "serviceName": "myService"
}

Parameters JSON example

The ServiceNowNotificationConfig object

Configuration of the ServiceNow notification.

Element	Type	Description	Required
id	string	The ID of the notification configuration.	optional
name	string	The name of the notification configuration.	required
alertingProfile	string	The ID of the associated alerting profile.	required
active	boolean	The configuration is enabled (`true`) or disabled (`false`).	required
type	string	Defines the actual set of fields depending on the value: EMAIL -> EmailNotificationConfig PAGER_DUTY -> PagerDutyNotificationConfig WEBHOOK -> WebHookNotificationConfig SLACK -> SlackNotificationConfig HIPCHAT -> HipChatNotificationConfig VICTOROPS -> VictorOpsNotificationConfig SERVICE_NOW -> ServiceNowNotificationConfig XMATTERS -> XMattersNotificationConfig ANSIBLETOWER -> AnsibleTowerNotificationConfig OPS_GENIE -> OpsGenieNotificationConfig JIRA -> JiraNotificationConfig TRELLO -> TrelloNotificationConfig The type element can hold these values.	required
instanceName	string	The ServiceNow instance identifier. It refers to the first part of your own ServiceNow URL. This field is mutually exclusive with the url field. You can only use one of them.	optional
url	string	The URL of the on-premise ServiceNow installation. This field is mutually exclusive with the instanceName field. You can only use one of them.	optional
username	string	The username of the ServiceNow account. Make sure that your user account has the `rest_service`, `web_request_admin`, and `x_dynat_ruxit.Integration` roles.	required
password	string	The username to the ServiceNow account	optional
message	string	The content of the ServiceNow description. It is limited to 80 characters. You can use the following placeholders: `{ImpactedEntity}`: The entity impacted by the problem or X impacted entities. `{PID}`: The ID of the reported problem. `{ProblemDetailsHTML}`: All problem event details, including root cause, as an HTML-formatted string. `{ProblemID}`: The display number of the reported problem. `{ProblemImpact}`: The impact level of the problem. Possible values are `APPLICATION`, `SERVICE`, and `INFRASTRUCTURE`. `{ProblemSeverity}`: The severity level of the problem. Possible values are `AVAILABILITY`, `ERROR`, `PERFORMANCE`, `RESOURCE_CONTENTION`, and `CUSTOM_ALERT`. `{ProblemTitle}`: A short description of the problem. `{ProblemURL}`: The URL of the problem within DESK. `{State}`: The state of the problem. Possible values are `OPEN` and `RESOLVED`. If the problem has been merged into another problem, it has the `MERGED` value. `{Tags}`: The list of tags that are defined for all impacted entities, separated by commas.	required
sendIncidents	boolean	Send incidents into ServiceNow ITSM (`true`).	required
sendEvents	boolean	Send events into ServiceNow ITOM (`true`).	required

Possible values

Possible values for the type element:

EMAIL
PAGER_DUTY
WEBHOOK
SLACK
HIPCHAT
VICTOROPS
SERVICE_NOW
XMATTERS
ANSIBLETOWER
OPS_GENIE
JIRA
TRELLO

{
  "type": "SERVICE_NOW",
  "id": "4e006117-6cb7-4eb5-a080-0ec96cc2fad0",
  "name": "My ServiceNow notification",
  "alertingProfile": "c21f969b-5f03-333d-83e0-4f8f136e7682",
  "active": false,
  "instanceName": "myServiceNowInstance",
  "url": null,
  "username": "john.smith",
  "password": null,
  "message": "{ProblemImpact} Problem {ProblemID}: {ProblemTitle}",
  "sendIncidents": true,
  "sendEvents": true
}

Parameters JSON example

The SlackNotificationConfig object

Configuration of the Slack notification.

Element	Type	Description	Required
id	string	The ID of the notification configuration.	optional
name	string	The name of the notification configuration.	required
alertingProfile	string	The ID of the associated alerting profile.	required
active	boolean	The configuration is enabled (`true`) or disabled (`false`).	required
type	string	Defines the actual set of fields depending on the value: EMAIL -> EmailNotificationConfig PAGER_DUTY -> PagerDutyNotificationConfig WEBHOOK -> WebHookNotificationConfig SLACK -> SlackNotificationConfig HIPCHAT -> HipChatNotificationConfig VICTOROPS -> VictorOpsNotificationConfig SERVICE_NOW -> ServiceNowNotificationConfig XMATTERS -> XMattersNotificationConfig ANSIBLETOWER -> AnsibleTowerNotificationConfig OPS_GENIE -> OpsGenieNotificationConfig JIRA -> JiraNotificationConfig TRELLO -> TrelloNotificationConfig The type element can hold these values.	required
url	string	The URL of the Slack WebHook. This is confidential information, therefore GET requests return this field with the `null` value, and it is optional for PUT requests.	optional
channel	string	The channel (for example, `#general`) or the user (for example, `@john.smith`) to send the message to.	required
title	string	The content of the message. You can use the following placeholders: `{ImpactedEntity}`: The entity impacted by the problem or X impacted entities. `{PID}`: The ID of the reported problem. `{ProblemDetailsText}`: All problem event details, including root cause, as a text-formatted string. `{ProblemID}`: The display number of the reported problem. `{ProblemImpact}`: The impact level of the problem. Possible values are `APPLICATION`, `SERVICE`, and `INFRASTRUCTURE`. `{ProblemSeverity}`: The severity level of the problem. Possible values are `AVAILABILITY`, `ERROR`, `PERFORMANCE`, `RESOURCE_CONTENTION`, and `CUSTOM_ALERT`. `{ProblemTitle}`: A short description of the problem. `{ProblemURL}`: The URL of the problem within DESK. `{State}`: The state of the problem. Possible values are `OPEN` and `RESOLVED`. If the problem has been merged into another problem, it has the `MERGED` value. `{Tags}`: The list of tags that are defined for all impacted entities, separated by commas.	required

Possible values

Possible values for the type element:

EMAIL
PAGER_DUTY
WEBHOOK
SLACK
HIPCHAT
VICTOROPS
SERVICE_NOW
XMATTERS
ANSIBLETOWER
OPS_GENIE
JIRA
TRELLO

{
  "type": "SLACK",
  "id": "cebe8a38-ddfd-4062-aa9f-2f1a0562bd88",
  "name": "MySlack 1",
  "alertingProfile": "c21f969b-5f03-333d-83e0-4f8f136e7682",
  "active": false,
  "url": "https://hooks.slack.com/services/T000/B000/ZZZ",
  "channel": "@john.smith",
  "title": "Problem {ProblemID} is {State}: \n\n {ProblemDetailsText}"
}

Parameters JSON example

The TrelloNotificationConfig object

Configuration of the Trello notification.

Element	Type	Description	Required
id	string	The ID of the notification configuration.	optional
name	string	The name of the notification configuration.	required
alertingProfile	string	The ID of the associated alerting profile.	required
active	boolean	The configuration is enabled (`true`) or disabled (`false`).	required
type	string	Defines the actual set of fields depending on the value: EMAIL -> EmailNotificationConfig PAGER_DUTY -> PagerDutyNotificationConfig WEBHOOK -> WebHookNotificationConfig SLACK -> SlackNotificationConfig HIPCHAT -> HipChatNotificationConfig VICTOROPS -> VictorOpsNotificationConfig SERVICE_NOW -> ServiceNowNotificationConfig XMATTERS -> XMattersNotificationConfig ANSIBLETOWER -> AnsibleTowerNotificationConfig OPS_GENIE -> OpsGenieNotificationConfig JIRA -> JiraNotificationConfig TRELLO -> TrelloNotificationConfig The type element can hold these values.	required
applicationKey	string	The application key for the Trello account.	required
authorizationToken	string	The application token for the Trello account.	optional
boardId	string	The Trello board to which the card should be assigned.	required
listId	string	The Trello list to which the card should be assigned.	required
resolvedListId	string	The Trello list to which the card of the resolved problem should be assigned.	required
text	string	The text of the generated Trello card. You can use the following placeholders: `{ImpactedEntity}`: The entity impacted by the problem or X impacted entities. `{PID}`: The ID of the reported problem. `{ProblemDetailsMarkdown}`: All problem event details, including root cause, as a Markdown-formatted string. `{ProblemID}`: The display number of the reported problem. `{ProblemImpact}`: The impact level of the problem. Possible values are `APPLICATION`, `SERVICE`, and `INFRASTRUCTURE`. `{ProblemSeverity}`: The severity level of the problem. Possible values are `AVAILABILITY`, `ERROR`, `PERFORMANCE`, `RESOURCE_CONTENTION`, and `CUSTOM_ALERT`. `{ProblemTitle}`: A short description of the problem. `{ProblemURL}`: The URL of the problem within DESK. `{State}`: The state of the problem. Possible values are `OPEN` and `RESOLVED`. If the problem has been merged into another problem, it has the `MERGED` value. `{Tags}`: The list of tags that are defined for all impacted entities, separated by commas.	required
description	string	The description of the Trello card. You can use same placeholders as in card text.	required

Possible values

Possible values for the type element:

EMAIL
PAGER_DUTY
WEBHOOK
SLACK
HIPCHAT
VICTOROPS
SERVICE_NOW
XMATTERS
ANSIBLETOWER
OPS_GENIE
JIRA
TRELLO

{
  "type": "TRELLO",
  "id": "b999e4ab-6293-486f-b083-5b5d737f5052",
  "name": "My Trello notification",
  "alertingProfile": "c21f969b-5f03-333d-83e0-4f8f136e7682",
  "active": false,
  "applicationKey": "",
  "authorizationToken": "",
  "boardId": "",
  "listId": "",
  "resolvedListId": "",
  "text": "Problem {ProblemID} is {State}",
  "description": "{ProblemDetailsMarkdown}"
}

Parameters JSON example

The VictorOpsNotificationConfig object

Configuration of the VictorOps notification.

Element	Type	Description	Required
id	string	The ID of the notification configuration.	optional
name	string	The name of the notification configuration.	required
alertingProfile	string	The ID of the associated alerting profile.	required
active	boolean	The configuration is enabled (`true`) or disabled (`false`).	required
type	string	Defines the actual set of fields depending on the value: EMAIL -> EmailNotificationConfig PAGER_DUTY -> PagerDutyNotificationConfig WEBHOOK -> WebHookNotificationConfig SLACK -> SlackNotificationConfig HIPCHAT -> HipChatNotificationConfig VICTOROPS -> VictorOpsNotificationConfig SERVICE_NOW -> ServiceNowNotificationConfig XMATTERS -> XMattersNotificationConfig ANSIBLETOWER -> AnsibleTowerNotificationConfig OPS_GENIE -> OpsGenieNotificationConfig JIRA -> JiraNotificationConfig TRELLO -> TrelloNotificationConfig The type element can hold these values.	required
apiKey	string	The API key for the target VictorOps account.	optional
routingKey	string	The routing key, defining the group to be notified.	required
message	string	The content of the message. You can use the following placeholders: `{ImpactedEntity}`: The entity impacted by the problem or X impacted entities. `{ProblemDetailsText}`: All problem event details, including root cause, as a text-formatted string. `{ProblemID}`: The display number of the reported problem. `{ProblemImpact}`: The impact level of the problem. Possible values are `APPLICATION`, `SERVICE`, and `INFRASTRUCTURE`. `{ProblemSeverity}`: The severity level of the problem. Possible values are `AVAILABILITY`, `ERROR`, `PERFORMANCE`, `RESOURCE_CONTENTION`, and `CUSTOM_ALERT`. `{ProblemTitle}`: A short description of the problem. `{ProblemURL}`: The URL of the problem within DESK. `{State}`: The state of the problem. Possible values are `OPEN` and `RESOLVED`. If the problem has been merged into another problem, it has the `MERGED` value.	required

Possible values

Possible values for the type element:

EMAIL
PAGER_DUTY
WEBHOOK
SLACK
HIPCHAT
VICTOROPS
SERVICE_NOW
XMATTERS
ANSIBLETOWER
OPS_GENIE
JIRA
TRELLO

{
  "type": "VICTOROPS",
  "id": "3e21c269-00d8-4cd2-a4d5-c53263f23f76",
  "name": "My VictorOps notification",
  "alertingProfile": "c21f969b-5f03-333d-83e0-4f8f136e7682",
  "active": false,
  "apiKey": null,
  "routingKey": "myTeam",
  "message": "Problem {ProblemID} - {ProblemTitle} is {State}"
}

Parameters JSON example

The WebHookNotificationConfig object

Configuration of the custom WebHook notification.

Element	Type	Description	Required
id	string	The ID of the notification configuration.	optional
name	string	The name of the notification configuration.	required
alertingProfile	string	The ID of the associated alerting profile.	required
active	boolean	The configuration is enabled (`true`) or disabled (`false`).	required
type	string	Defines the actual set of fields depending on the value: EMAIL -> EmailNotificationConfig PAGER_DUTY -> PagerDutyNotificationConfig WEBHOOK -> WebHookNotificationConfig SLACK -> SlackNotificationConfig HIPCHAT -> HipChatNotificationConfig VICTOROPS -> VictorOpsNotificationConfig SERVICE_NOW -> ServiceNowNotificationConfig XMATTERS -> XMattersNotificationConfig ANSIBLETOWER -> AnsibleTowerNotificationConfig OPS_GENIE -> OpsGenieNotificationConfig JIRA -> JiraNotificationConfig TRELLO -> TrelloNotificationConfig The type element can hold these values.	required
url	string	The URL of the WebHook endpoint.	required
acceptAnyCertificate	boolean	Accept any, including self-signed and invalid, SSL certificate (`true`) or only trusted (`false`) certificates.	required
payload	string	The content of the notification message. You can use the following placeholders: `{ImpactedEntities}`: Details about the entities impacted by the problem in form of a JSON array. `{ImpactedEntity}`: The entity impacted by the problem or X impacted entities. `{PID}`: The ID of the reported problem. `{ProblemDetailsHTML}`: All problem event details, including root cause, as an HTML-formatted string. `{ProblemDetailsJSON}`: All problem event details, including root cause, as a JSON object. `{ProblemDetailsMarkdown}`: All problem event details, including root cause, as a Markdown-formatted string. `{ProblemDetailsText}`: All problem event details, including root cause, as a text-formatted string. `{ProblemID}`: The display number of the reported problem. `{ProblemImpact}`: The impact level of the problem. Possible values are `APPLICATION`, `SERVICE`, and `INFRASTRUCTURE`. `{ProblemSeverity}`: The severity level of the problem. Possible values are `AVAILABILITY`, `ERROR`, `PERFORMANCE`, `RESOURCE_CONTENTION`, and `CUSTOM_ALERT`. `{ProblemTitle}`: A short description of the problem. `{ProblemURL}`: The URL of the problem within DESK. `{State}`: The state of the problem. Possible values are `OPEN` and `RESOLVED`. If the problem has been merged into another problem, it has the `MERGED` value. `{Tags}`: The list of tags that are defined for all impacted entities, separated by commas.	required
headers	HttpHeader[]	A list of the additional HTTP headers.	optional

The HttpHeader object

The HTTP header.

Element Type Description Required

name

string

Element	Type	Description	Required
name	string	The name of the HTTP header.	required
value	string	The value of the HTTP header. May contain an empty value. Required when creating a new notification. For the Authorization header, GET requests return the `null` value. If you want update a notification configuration with an Authorization header which you want to remain intact, set the Authorization header with the `null` value.	optional

The name of the HTTP header.

required

value

string

The value of the HTTP header. May contain an empty value.

Required when creating a new notification.

For the Authorization header, GET requests return the null value.

If you want update a notification configuration with an Authorization header which you want to remain intact, set the Authorization header with the null value.

optional

Possible values

Possible values for the type element:

EMAIL
PAGER_DUTY
WEBHOOK
SLACK
HIPCHAT
VICTOROPS
SERVICE_NOW
XMATTERS
ANSIBLETOWER
OPS_GENIE
JIRA
TRELLO

{
  "type": "WEBHOOK",
  "id": "fbaf6757-2123-483a-a44e-3aac006128da",
  "name": "My custom notification",
  "alertingProfile": "c21f969b-5f03-333d-83e0-4f8f136e7682",
  "active": true,
  "url": "https://sample.free.beeceptor.com",
  "acceptAnyCertificate": false,
  "payload": "{\n\"State\":\"{State}\",\n\"ProblemID\":\"{ProblemID}\",\n\"ProblemTitle\":\"{ProblemTitle}\"\n}",
  "headers": [
    {
      "name": "Authorization",
      "value": null
    }
  ]
}

Parameters JSON example

The XMattersNotificationConfig object

Configuration of the xMatters notification.

Element	Type	Description	Required
id	string	The ID of the notification configuration.	optional
name	string	The name of the notification configuration.	required
alertingProfile	string	The ID of the associated alerting profile.	required
active	boolean	The configuration is enabled (`true`) or disabled (`false`).	required
type	string	Defines the actual set of fields depending on the value: EMAIL -> EmailNotificationConfig PAGER_DUTY -> PagerDutyNotificationConfig WEBHOOK -> WebHookNotificationConfig SLACK -> SlackNotificationConfig HIPCHAT -> HipChatNotificationConfig VICTOROPS -> VictorOpsNotificationConfig SERVICE_NOW -> ServiceNowNotificationConfig XMATTERS -> XMattersNotificationConfig ANSIBLETOWER -> AnsibleTowerNotificationConfig OPS_GENIE -> OpsGenieNotificationConfig JIRA -> JiraNotificationConfig TRELLO -> TrelloNotificationConfig The type element can hold these values.	required
url	string	The URL of the xMatters WebHook.	required
acceptAnyCertificate	boolean	Accept any, including self-signed and invalid, SSL certificate (`true`) or only trusted (`false`) certificates.	required
headers	HttpHeader[]	A list of the additional HTTP headers.	optional
payload	string	The content of the message. You can use the following placeholders: `{ImpactedEntities}`: Details about the entities impacted by the problem in form of a JSON array. `{ImpactedEntity}`: The entity impacted by the problem or X impacted entities. `{PID}`: The ID of the reported problem. `{ProblemDetailsHTML}`: All problem event details, including root cause, as an HTML-formatted string. `{ProblemDetailsJSON}`: All problem event details, including root cause, as a JSON object. `{ProblemDetailsMarkdown}`: All problem event details, including root cause, as a Markdown-formatted string. `{ProblemDetailsText}`: All problem event details, including root cause, as a text-formatted string. `{ProblemID}`: The display number of the reported problem. `{ProblemImpact}`: The impact level of the problem. Possible values are `APPLICATION`, `SERVICE`, and `INFRASTRUCTURE`. `{ProblemSeverity}`: The severity level of the problem. Possible values are `AVAILABILITY`, `ERROR`, `PERFORMANCE`, `RESOURCE_CONTENTION`, and `CUSTOM_ALERT`. `{ProblemTitle}`: A short description of the problem. `{ProblemURL}`: The URL of the problem within DESK. `{State}`: The state of the problem. Possible values are `OPEN` and `RESOLVED`. If the problem has been merged into another problem, it has the `MERGED` value. `{Tags}`: The list of tags that are defined for all impacted entities, separated by commas.	required

The HttpHeader object

The HTTP header.

Element Type Description Required

name

string

Element	Type	Description	Required
name	string	The name of the HTTP header.	required
value	string	The value of the HTTP header. May contain an empty value. Required when creating a new notification. For the Authorization header, GET requests return the `null` value. If you want update a notification configuration with an Authorization header which you want to remain intact, set the Authorization header with the `null` value.	optional

The name of the HTTP header.

required

value

string

The value of the HTTP header. May contain an empty value.

Required when creating a new notification.

For the Authorization header, GET requests return the null value.

If you want update a notification configuration with an Authorization header which you want to remain intact, set the Authorization header with the null value.

optional

Possible values

Possible values for the type element:

EMAIL
PAGER_DUTY
WEBHOOK
SLACK
HIPCHAT
VICTOROPS
SERVICE_NOW
XMATTERS
ANSIBLETOWER
OPS_GENIE
JIRA
TRELLO

{
  "type": "XMATTERS",
  "id": "07ced25a-dff4-4431-ab3a-571a5eab8562",
  "name": "My xMatters notification",
  "alertingProfile": "c21f969b-5f03-333d-83e0-4f8f136e7682",
  "active": false,
  "url": "https://acmecorp.xmatters.com/api/integration/1/functions/3744c145-47fd-9ab7/triggers",
  "acceptAnyCertificate": false,
  "headers": [
    {
      "name": "Authorization",
      "value": null
    }
  ],
  "payload": "{\n    \"impactedEntity\": \"{ImpactedEntity}\",\n    \"pid\": \"{PID}\",\n  \"problemId\": \"{ProblemID}\",\n  \"problemDetailsText\": \"{ProblemDetailsText}\",\n  \"problemImpact\": \"{ProblemImpact}\",\n    \"problemSeverity\": \"{ProblemSeverity}\",\n    \"problemTitle\": \"{ProblemTitle}\",\n   \"problemURL\": \"{ProblemURL}\",\n    \"state\": \"{State}\",\n    \"tags\": \"{Tags}\"\n}"
}

Ansible Tower notification

The AnsibleTowerNotificationConfig object

Possible values

Possible values for the type element:

Email notification

The EmailNotificationConfig object

Possible values

Possible values for the type element:

HipChat notification

The HipChatNotificationConfig object

Possible values

Possible values for the type element:

Jira notification

The JiraNotificationConfig object

Possible values

Possible values for the type element:

Opsgenie notification

The OpsGenieNotificationConfig object

Possible values

Possible values for the type element:

PagerDuty notification

The PagerDutyNotificationConfig object

Possible values

Possible values for the type element:

ServiceNow notification

The ServiceNowNotificationConfig object

Possible values

Possible values for the type element:

Slack notification

The SlackNotificationConfig object

Possible values

Possible values for the type element:

Trello notification

The TrelloNotificationConfig object

Possible values

Possible values for the type element:

VictorOps notification

The VictorOpsNotificationConfig object

Possible values

Possible values for the type element:

Webhook notification

The WebHookNotificationConfig object

The HttpHeader object

Possible values

Possible values for the type element:

xMatters notification

The XMattersNotificationConfig object

The HttpHeader object

Possible values

Possible values for the type element: