Notifications API - JSON models

The actual set of fields in the JSON model of a notification configuration depends on the type of the notification.

This page lists parameters and examples of JSON models for different notification types.

Ansible Tower notification

ParametersJSON example

The `AnsibleTowerNotificationConfig` object

Element	Type	Description
jobTemplateURL	string	The URL of the target Ansible Tower job template. Can be `null`.
acceptAnyCertificate	boolean	Accept any, including self-signed and invalid, SSL certificate (`true`) or only trusted (`false`) certificates. Can be `null`.
username	string	The username of the Ansible Tower account. Can be `null`.
password	string	The password for the Ansible Tower account. Can be `null`.
jobTemplateID	integer	The ID of the target Ansible Tower job template. Can be `null`.
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 Dynatrace. `{State}`: The state of the problem. Possible values are `OPEN` and `RESOLVED`. `{Tags}`: The list of tags that are defined for all impacted entities, separated by commas. Can be `null`.

The `NotificationConfig` object

Configuration of a notification. The actual set of fields depends on the type of the notification. See Notifications API - JSON models in Dynatrace Documentation for example models of every notification type.

Element	Type	Description
id	string	The ID of the notification configuration. Can be `null`.
name	string	The name of the notification configuration.
alertingProfile	string	The ID of the associated alerting profile.
active	boolean	The configuration is enabled (`true`) or disabled (`false`).
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `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 element can hold these values `ANSIBLETOWER` `EMAIL` `HIPCHAT` `JIRA` `OPS_GENIE` `PAGER_DUTY` `SERVICE_NOW` `SLACK` `TRELLO` `VICTOROPS` `WEBHOOK` `XMATTERS`

json
{
  "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}"
}

Email notification

ParametersJSON example

The `EmailNotificationConfig` object

Element	Type	Description
subject	string	The subject of the email notifications. Can be `null`.
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 Dynatrace. `{State}`: The state of the problem. Possible values are `OPEN` and `RESOLVED`. `{Tags}`: The list of tags that are defined for all impacted entities, separated by commas. Can be `null`.
receivers	string[]	The list of the email recipients. Can be `null`.
ccReceivers	string[]	The list of the email CC-recipients. Can be `null`.
bccReceivers	string[]	The list of the email BCC-recipients. Can be `null`.

The `NotificationConfig` object

Element	Type	Description
id	string	The ID of the notification configuration. Can be `null`.
name	string	The name of the notification configuration.
alertingProfile	string	The ID of the associated alerting profile.
active	boolean	The configuration is enabled (`true`) or disabled (`false`).
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `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 element can hold these values `ANSIBLETOWER` `EMAIL` `HIPCHAT` `JIRA` `OPS_GENIE` `PAGER_DUTY` `SERVICE_NOW` `SLACK` `TRELLO` `VICTOROPS` `WEBHOOK` `XMATTERS`

json
{
  "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"
  ],
  "bccReceivers": [
    "james.brownh@company.com"
  ]
}

HipChat notification

HIPCHAT

ParametersJSON example

The `HipChatNotificationConfig` object

Element Type Description

url

string

Element	Type	Description
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. Can be `null`.
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 Dynatrace. `{State}`: The state of the problem. Possible values are `OPEN` and `RESOLVED`. `{Tags}`: The list of tags that are defined for all impacted entities, separated by commas. Can be `null`.

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.

Can be null.

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 Dynatrace.
{State}: The state of the problem. Possible values are OPEN and RESOLVED.
{Tags}: The list of tags that are defined for all impacted entities, separated by commas.

Can be null.

The `NotificationConfig` object

Element	Type	Description
id	string	The ID of the notification configuration. Can be `null`.
name	string	The name of the notification configuration.
alertingProfile	string	The ID of the associated alerting profile.
active	boolean	The configuration is enabled (`true`) or disabled (`false`).
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `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 element can hold these values `ANSIBLETOWER` `EMAIL` `HIPCHAT` `JIRA` `OPS_GENIE` `PAGER_DUTY` `SERVICE_NOW` `SLACK` `TRELLO` `VICTOROPS` `WEBHOOK` `XMATTERS`

json
{
  "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}"
}

Jira notification

JIRA

ParametersJSON example

The `JiraNotificationConfig` object

Element	Type	Description
username	string	The username of the Jira profile. Can be `null`.
password	string	The password for the Jira profile. Can be `null`.
url	string	The URL of the Jira API endpoint. Can be `null`.
projectKey	string	The project key of the Jira issue to be created by this notification. Can be `null`.
issueType	string	The type of the Jira issue to be created by this notification. Can be `null`.
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 Dynatrace. `{State}`: The state of the problem. Possible values are `OPEN` and `RESOLVED`. `{Tags}`: The list of tags that are defined for all impacted entities, separated by commas. Can be `null`.
description	string	The description of the Jira issue to be created by this notification. You can use same placeholders as in issue summary. Can be `null`.

The `NotificationConfig` object

Element	Type	Description
id	string	The ID of the notification configuration. Can be `null`.
name	string	The name of the notification configuration.
alertingProfile	string	The ID of the associated alerting profile.
active	boolean	The configuration is enabled (`true`) or disabled (`false`).
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `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 element can hold these values `ANSIBLETOWER` `EMAIL` `HIPCHAT` `JIRA` `OPS_GENIE` `PAGER_DUTY` `SERVICE_NOW` `SLACK` `TRELLO` `VICTOROPS` `WEBHOOK` `XMATTERS`

json
{
  "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"
}

Opsgenie notification

OPS_GENIE

ParametersJSON example

The `OpsGenieNotificationConfig` object

Element Type Description

apiKey

string

Element	Type	Description
apiKey	string	The API key to access OpsGenie. Can be `null`.
domain	string	The region domain of the OpsGenie. Can be `null`.
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. Can be `null`.

The API key to access OpsGenie.

Can be null.

domain

string

The region domain of the OpsGenie.

Can be null.

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.

Can be null.

The `NotificationConfig` object

Element	Type	Description
id	string	The ID of the notification configuration. Can be `null`.
name	string	The name of the notification configuration.
alertingProfile	string	The ID of the associated alerting profile.
active	boolean	The configuration is enabled (`true`) or disabled (`false`).
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `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 element can hold these values `ANSIBLETOWER` `EMAIL` `HIPCHAT` `JIRA` `OPS_GENIE` `PAGER_DUTY` `SERVICE_NOW` `SLACK` `TRELLO` `VICTOROPS` `WEBHOOK` `XMATTERS`

json
{
  "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}"
}

PagerDuty notification

ParametersJSON example

The `PagerDutyNotificationConfig` object

Element Type Description

account

string

Element	Type	Description
account	string	The name of the PagerDuty account. Can be `null`.
serviceApiKey	string	The API key to access PagerDuty. Can be `null`.
serviceName	string	The name of the service. Can be `null`.

The name of the PagerDuty account.

Can be null.

serviceApiKey

string

The API key to access PagerDuty.

Can be null.

serviceName

string

The name of the service.

Can be null.

The `NotificationConfig` object

Element	Type	Description
id	string	The ID of the notification configuration. Can be `null`.
name	string	The name of the notification configuration.
alertingProfile	string	The ID of the associated alerting profile.
active	boolean	The configuration is enabled (`true`) or disabled (`false`).
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `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 element can hold these values `ANSIBLETOWER` `EMAIL` `HIPCHAT` `JIRA` `OPS_GENIE` `PAGER_DUTY` `SERVICE_NOW` `SLACK` `TRELLO` `VICTOROPS` `WEBHOOK` `XMATTERS`

json
{
  "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"
}

ServiceNow notification

SERVICE_NOW

ParametersJSON example

The `ServiceNowNotificationConfig` object

Element	Type	Description
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. Can be `null`.
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. Can be `null`.
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. Can be `null`.
password	string	The username to the ServiceNow account Can be `null`.
message	string	The content of the ServiceNow description. 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 Dynatrace. `{State}`: The state of the problem. Possible values are `OPEN` and `RESOLVED`. `{Tags}`: The list of tags that are defined for all impacted entities, separated by commas. Can be `null`.
sendIncidents	boolean	Send incidents into ServiceNow ITSM (`true`). Can be `null`.
sendEvents	boolean	Send events into ServiceNow ITOM (`true`). Can be `null`.

The `NotificationConfig` object

Element	Type	Description
id	string	The ID of the notification configuration. Can be `null`.
name	string	The name of the notification configuration.
alertingProfile	string	The ID of the associated alerting profile.
active	boolean	The configuration is enabled (`true`) or disabled (`false`).
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `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 element can hold these values `ANSIBLETOWER` `EMAIL` `HIPCHAT` `JIRA` `OPS_GENIE` `PAGER_DUTY` `SERVICE_NOW` `SLACK` `TRELLO` `VICTOROPS` `WEBHOOK` `XMATTERS`

json
{
  "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
}

Slack notification

SLACK

ParametersJSON example

The `SlackNotificationConfig` object

Element Type Description

url

string

Element	Type	Description
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. Can be `null`.
channel	string	The channel (for example, `#general`) or the user (for example, `@john.smith`) to send the message to. Can be `null`.
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 Dynatrace. `{State}`: The state of the problem. Possible values are `OPEN` and `RESOLVED`. `{Tags}`: The list of tags that are defined for all impacted entities, separated by commas. Can be `null`.

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.

Can be null.

channel

string

The channel (for example, #general) or the user (for example, @john.smith) to send the message to.

Can be null.

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 Dynatrace.
{State}: The state of the problem. Possible values are OPEN and RESOLVED.
{Tags}: The list of tags that are defined for all impacted entities, separated by commas.

Can be null.

The `NotificationConfig` object

Element	Type	Description
id	string	The ID of the notification configuration. Can be `null`.
name	string	The name of the notification configuration.
alertingProfile	string	The ID of the associated alerting profile.
active	boolean	The configuration is enabled (`true`) or disabled (`false`).
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `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 element can hold these values `ANSIBLETOWER` `EMAIL` `HIPCHAT` `JIRA` `OPS_GENIE` `PAGER_DUTY` `SERVICE_NOW` `SLACK` `TRELLO` `VICTOROPS` `WEBHOOK` `XMATTERS`

json
{
  "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}"
}

Trello notification

TRELLO

ParametersJSON example

The `TrelloNotificationConfig` object

Element	Type	Description
applicationKey	string	The application key for the Trello account. Can be `null`.
authorizationToken	string	The application token for the Trello account. Can be `null`.
boardId	string	The Trello board to which the card should be assigned. Can be `null`.
listId	string	The Trello list to which the card should be assigned. Can be `null`.
resolvedListId	string	The Trello list to which the card of the resolved problem should be assigned. Can be `null`.
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 Dynatrace. `{State}`: The state of the problem. Possible values are `OPEN` and `RESOLVED`. `{Tags}`: The list of tags that are defined for all impacted entities, separated by commas. Can be `null`.
description	string	The description of the Trello card. You can use same placeholders as in card text. Can be `null`.

The `NotificationConfig` object

Element	Type	Description
id	string	The ID of the notification configuration. Can be `null`.
name	string	The name of the notification configuration.
alertingProfile	string	The ID of the associated alerting profile.
active	boolean	The configuration is enabled (`true`) or disabled (`false`).
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `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 element can hold these values `ANSIBLETOWER` `EMAIL` `HIPCHAT` `JIRA` `OPS_GENIE` `PAGER_DUTY` `SERVICE_NOW` `SLACK` `TRELLO` `VICTOROPS` `WEBHOOK` `XMATTERS`

json
{
  "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}"
}

VictorOps notification

VICTOROPS

ParametersJSON example

The `VictorOpsNotificationConfig` object

Element Type Description

apiKey

string

Element	Type	Description
apiKey	string	The API key for the target VictorOps account. Can be `null`.
routingKey	string	The routing key, defining the group to be notified. Can be `null`.
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 Dynatrace. `{State}`: The state of the problem. Possible values are `OPEN` and `RESOLVED`. Can be `null`.

The API key for the target VictorOps account.

Can be null.

routingKey

string

The routing key, defining the group to be notified.

Can be null.

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 Dynatrace.
{State}: The state of the problem. Possible values are OPEN and RESOLVED.

Can be null.

The `NotificationConfig` object

Element	Type	Description
id	string	The ID of the notification configuration. Can be `null`.
name	string	The name of the notification configuration.
alertingProfile	string	The ID of the associated alerting profile.
active	boolean	The configuration is enabled (`true`) or disabled (`false`).
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `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 element can hold these values `ANSIBLETOWER` `EMAIL` `HIPCHAT` `JIRA` `OPS_GENIE` `PAGER_DUTY` `SERVICE_NOW` `SLACK` `TRELLO` `VICTOROPS` `WEBHOOK` `XMATTERS`

json
{
  "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}"
}

Webhook notification

WEBHOOK

ParametersJSON example

The `WebHookNotificationConfig` object

Element	Type	Description
url	string	The URL of the WebHook endpoint. Can be `null`.
acceptAnyCertificate	boolean	Accept any, including self-signed and invalid, SSL certificate (`true`) or only trusted (`false`) certificates. Can be `null`.
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 Dynatrace. `{State}`: The state of the problem. Possible values are `OPEN` and `RESOLVED`. `{Tags}`: The list of tags that are defined for all impacted entities, separated by commas. Can be `null`.
headers	HttpHeader[]	A list of the additional HTTP headers. Can be `null`.
notifyEventMergesEnabled	boolean	Call webhook if new events merge into existing problems. Can be `null`.

The `NotificationConfig` object

Element	Type	Description
id	string	The ID of the notification configuration. Can be `null`.
name	string	The name of the notification configuration.
alertingProfile	string	The ID of the associated alerting profile.
active	boolean	The configuration is enabled (`true`) or disabled (`false`).
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `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 element can hold these values `ANSIBLETOWER` `EMAIL` `HIPCHAT` `JIRA` `OPS_GENIE` `PAGER_DUTY` `SERVICE_NOW` `SLACK` `TRELLO` `VICTOROPS` `WEBHOOK` `XMATTERS`

json
{
  "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
    }
  ]
}

xMatters notification

XMATTERS

ParametersJSON example

The `XMattersNotificationConfig` object

Element	Type	Description
url	string	The URL of the xMatters WebHook. Can be `null`.
acceptAnyCertificate	boolean	Accept any, including self-signed and invalid, SSL certificate (`true`) or only trusted (`false`) certificates. Can be `null`.
headers	HttpHeader[]	A list of the additional HTTP headers. Can be `null`.
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 Dynatrace. `{State}`: The state of the problem. Possible values are `OPEN` and `RESOLVED`. `{Tags}`: The list of tags that are defined for all impacted entities, separated by commas. Can be `null`.

The `NotificationConfig` object

Element	Type	Description
id	string	The ID of the notification configuration. Can be `null`.
name	string	The name of the notification configuration.
alertingProfile	string	The ID of the associated alerting profile.
active	boolean	The configuration is enabled (`true`) or disabled (`false`).
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `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 element can hold these values `ANSIBLETOWER` `EMAIL` `HIPCHAT` `JIRA` `OPS_GENIE` `PAGER_DUTY` `SERVICE_NOW` `SLACK` `TRELLO` `VICTOROPS` `WEBHOOK` `XMATTERS`

json
{
  "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}"
}

Notifications API - JSON models

Ansible Tower notification

The AnsibleTowerNotificationConfig object

The NotificationConfig object

Email notification

The EmailNotificationConfig object

The NotificationConfig object

HipChat notification

The HipChatNotificationConfig object

The NotificationConfig object

Jira notification

The JiraNotificationConfig object

The NotificationConfig object

Opsgenie notification

The OpsGenieNotificationConfig object

The NotificationConfig object

PagerDuty notification

The PagerDutyNotificationConfig object

The NotificationConfig object

ServiceNow notification

The ServiceNowNotificationConfig object

The NotificationConfig object

Slack notification

The SlackNotificationConfig object

The NotificationConfig object

Trello notification

The TrelloNotificationConfig object

The NotificationConfig object

VictorOps notification

The VictorOpsNotificationConfig object

The NotificationConfig object

Webhook notification

The WebHookNotificationConfig object

The NotificationConfig object

xMatters notification

The XMattersNotificationConfig object

The NotificationConfig object

The `AnsibleTowerNotificationConfig` object

The `NotificationConfig` object

The `EmailNotificationConfig` object

The `NotificationConfig` object

The `HipChatNotificationConfig` object

The `NotificationConfig` object

The `JiraNotificationConfig` object

The `NotificationConfig` object

The `OpsGenieNotificationConfig` object

The `NotificationConfig` object

The `PagerDutyNotificationConfig` object

The `NotificationConfig` object

The `ServiceNowNotificationConfig` object

The `NotificationConfig` object

The `SlackNotificationConfig` object

The `NotificationConfig` object

The `TrelloNotificationConfig` object

The `NotificationConfig` object

The `VictorOpsNotificationConfig` object

The `NotificationConfig` object

The `WebHookNotificationConfig` object

The `NotificationConfig` object

The `XMattersNotificationConfig` object

The `NotificationConfig` object