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.
AnsibleTowerNotificationConfig objectConfiguration of the Ansible Tower notification.
Accept any, including self-signed and invalid, SSL certificate (true) or only trusted (false) certificates.
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.The ID of the target Ansible Tower job template.
The URL of the target Ansible Tower job template.
The password for the Ansible Tower account.
The username of the Ansible Tower account.
{"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}"}
EmailNotificationConfig objectConfiguration of the email notification.
The list of the email BCC-recipients.
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.The list of the email CC-recipients.
The list of the email recipients.
The subject of the email notifications.
{"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"]}
JiraNotificationConfig objectConfiguration of the Jira notification.
The description of the Jira issue to be created by this notification.
You can use same placeholders as in issue summary.
The type of the Jira issue to be created by this notification.
The password for the Jira profile.
The project key of the Jira issue to be created by this notification.
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.The URL of the Jira API endpoint.
The username of the Jira profile.
{"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"}
OpsGenieNotificationConfig objectConfiguration of the OpsGenie notification.
The API key to access OpsGenie.
The region domain of the OpsGenie.
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.{"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}"}
PagerDutyNotificationConfig objectConfiguration of the PagerDuty notification.
The name of the PagerDuty account.
The API key to access PagerDuty.
The name of the service.
{"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"}
ServiceNowNotificationConfig objectConfiguration of the ServiceNow notification.
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.
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.The username to the ServiceNow account
Send events into ServiceNow ITOM (true).
Send incidents into ServiceNow ITSM (true).
The URL of the on-premise ServiceNow installation.
This field is mutually exclusive with the instanceName field. You can only use one of them.
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.
{"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}
SlackNotificationConfig objectConfiguration of the Slack notification.
The channel (for example, #general) or the user (for example, @john.smith) to send the message to.
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.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.
{"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}"}
TrelloNotificationConfig objectConfiguration of the Trello notification.
The application key for the Trello account.
The application token for the Trello account.
The Trello board to which the card should be assigned.
The description of the Trello card.
You can use same placeholders as in card text.
The Trello list to which the card should be assigned.
The Trello list to which the card of the resolved problem should be assigned.
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.{"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}"}
VictorOpsNotificationConfig objectConfiguration of the VictorOps notification.
The API key for the target VictorOps account.
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.The routing key, defining the group to be notified.
{"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}"}
WebHookNotificationConfig objectConfiguration of the custom WebHook notification.
Accept any, including self-signed and invalid, SSL certificate (true) or only trusted (false) certificates.
Call webhook if new events merge into existing problems.
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.The URL of the WebHook endpoint.
HttpHeader objectThe HTTP header.
The name of the HTTP header.
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.
{"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}]}
XMattersNotificationConfig objectConfiguration of the xMatters notification.
Accept any, including self-signed and invalid, SSL certificate (true) or only trusted (false) certificates.
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.The URL of the xMatters WebHook.
HttpHeader objectThe HTTP header.
The name of the HTTP header.
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.
{"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}"}