Notifications API - JSON models

This API is deprecated. Use the Settings API instead. Look for the Problem notifications (builtin:problem.notifications) schema.

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

The AnsibleTowerNotificationConfig object

Configuration of the Ansible Tower notification.

ElementTypeDescription
acceptAnyCertificateboolean

Accept any, including self-signed and invalid, SSL certificate (true) or only trusted (false) certificates.

customMessagestring

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.
jobTemplateIDinteger

The ID of the target Ansible Tower job template.

jobTemplateURLstring

The URL of the target Ansible Tower job template.

passwordstring

The password for the Ansible Tower account.

usernamestring

The username of the Ansible Tower account.

Email notification

The EmailNotificationConfig object

Configuration of the email notification.

ElementTypeDescription
bccReceiversstring[]

The list of the email BCC-recipients.

bodystring

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.
ccReceiversstring[]

The list of the email CC-recipients.

receiversstring[]

The list of the email recipients.

subjectstring

The subject of the email notifications.

Jira notification

The JiraNotificationConfig object

Configuration of the Jira notification.

ElementTypeDescription
descriptionstring

The description of the Jira issue to be created by this notification.

You can use same placeholders as in issue summary.

issueTypestring

The type of the Jira issue to be created by this notification.

passwordstring

The password for the Jira profile.

projectKeystring

The project key of the Jira issue to be created by this notification.

summarystring

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.
urlstring

The URL of the Jira API endpoint.

usernamestring

The username of the Jira profile.

Opsgenie notification

The OpsGenieNotificationConfig object

Configuration of the OpsGenie notification.

ElementTypeDescription
apiKeystring

The API key to access OpsGenie.

domainstring

The region domain of the OpsGenie.

messagestring

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.

PagerDuty notification

The PagerDutyNotificationConfig object

Configuration of the PagerDuty notification.

ElementTypeDescription
accountstring

The name of the PagerDuty account.

serviceApiKeystring

The API key to access PagerDuty.

serviceNamestring

The name of the service.

ServiceNow notification

The ServiceNowNotificationConfig object

Configuration of the ServiceNow notification.

ElementTypeDescription
instanceNamestring

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.

messagestring

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.
passwordstring

The username to the ServiceNow account

sendEventsboolean

Send events into ServiceNow ITOM (true).

sendIncidentsboolean

Send incidents into ServiceNow ITSM (true).

urlstring

The URL of the on-premise ServiceNow installation.

This field is mutually exclusive with the instanceName field. You can only use one of them.

usernamestring

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.

Slack notification

The SlackNotificationConfig object

Configuration of the Slack notification.

ElementTypeDescription
channelstring

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

titlestring

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.
urlstring

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.

Trello notification

The TrelloNotificationConfig object

Configuration of the Trello notification.

ElementTypeDescription
applicationKeystring

The application key for the Trello account.

authorizationTokenstring

The application token for the Trello account.

boardIdstring

The Trello board to which the card should be assigned.

descriptionstring

The description of the Trello card.

You can use same placeholders as in card text.

listIdstring

The Trello list to which the card should be assigned.

resolvedListIdstring

The Trello list to which the card of the resolved problem should be assigned.

textstring

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.

VictorOps notification

The VictorOpsNotificationConfig object

Configuration of the VictorOps notification.

ElementTypeDescription
apiKeystring

The API key for the target VictorOps account.

messagestring

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.
routingKeystring

The routing key, defining the group to be notified.

Webhook notification

The WebHookNotificationConfig object

Configuration of the custom WebHook notification.

ElementTypeDescription
acceptAnyCertificateboolean

Accept any, including self-signed and invalid, SSL certificate (true) or only trusted (false) certificates.

headersHttpHeader[]

A list of the additional HTTP headers.

notifyEventMergesEnabledboolean

Call webhook if new events merge into existing problems.

payloadstring

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.
urlstring

The URL of the WebHook endpoint.

The HttpHeader object

The HTTP header.

ElementTypeDescription
namestring

The name of the HTTP header.

valuestring

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.

xMatters notification

The XMattersNotificationConfig object

Configuration of the xMatters notification.

ElementTypeDescription
acceptAnyCertificateboolean

Accept any, including self-signed and invalid, SSL certificate (true) or only trusted (false) certificates.

headersHttpHeader[]

A list of the additional HTTP headers.

payloadstring

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.
urlstring

The URL of the xMatters WebHook.

The HttpHeader object

The HTTP header.

ElementTypeDescription
namestring

The name of the HTTP header.

valuestring

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.