builtin:problem.notifications)
Although the Dynatrace mobile app is the preferred method for receiving real-time notifications related to problems in your environment, if your organization uses email or a different ticket/incident management system for alerting, click Add notification to configure integration with Dynatrace.
Integrate Dynatrace problem notifications with your organization's existing incident-management system or team-collaboration channel. Alerting profiles are used within problem integrations to filter the total number of alerts to a subset that is relevant for your team.
For details see Third-party integrations.
builtin:problem.notifications
group:integration
environment
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:problem.notifications |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:problem.notifications | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:problem.notifications |
To execute this request, you need an access token with Read settings (settings.read
) scope. To learn how to obtain and use it, see Tokens and authentication.
enabled
type
EMAIL
SLACK
JIRA
ANSIBLETOWER
OPS_GENIE
PAGER_DUTY
VICTOROPS
WEBHOOK
XMATTERS
TRELLO
SERVICE_NOW
displayName
The name of the notification configuration.
alertingProfile
Select an alerting profile (<your-dynatrace-url>//ui/settings/builtin:alerting.profile
) to control the delivery of problem notifications related to this integration.
EmailNotification
objectrecipients
ccRecipients
bccRecipients
subject
The subject of the email notifications. Type '{' for placeholder suggestions.
{ImpactedEntity}: A short description of the problem and impacted entity (or multiple impacted entities).
{ImpactedEntityNames}: The entity impacted by the problem.
{NamesOfImpactedEntities}: The names of all entities that are impacted by the problem.
{PID}: Unique system identifier of the reported problem.
{ProblemID}: Display number of the reported problem.
{ProblemImpact}: Impact level of the problem. Possible values are APPLICATION, SERVICE, or INFRASTRUCTURE.
{ProblemSeverity}: Severity level of the problem. Possible values are AVAILABILITY, ERROR, PERFORMANCE, RESOURCE_CONTENTION, or CUSTOM_ALERT.
{ProblemTitle}: Short description of the problem.
{ProblemURL}: URL of the problem within Dynatrace.
{State}: Problem state. Possible values are OPEN or RESOLVED.
{Tags}: Comma separated list of tags that are defined for all impacted entities. To refer to the value of a specific tag, specify the tag's key in square brackets: {Tags[key]}. If the tag does not have any assigned value, the placeholder will be replaced by an empty string. The placeholder will not be replaced if the tag key does not exist.
notifyClosedProblems
body
The template of the email notifications. Type '{' for placeholder suggestions.
{ImpactedEntities}: Details about the entities impacted by the problem in form of a json array.
{ImpactedEntity}: A short description of the problem and impacted entity (or multiple impacted entities).
{ImpactedEntityNames}: The entity impacted by the problem.
{NamesOfImpactedEntities}: The names of all entities that are impacted by the problem.
{PID}: Unique system identifier of the reported problem.
{ProblemDetailsHTML}: All problem event details including root cause as an HTML-formatted string.
{ProblemDetailsJSONv2}: Problem as json object following the structure from the Dynatrace Problems V2 API. The optional fields evidenceDetails and impactAnalysis are included, but recentComments is not.
{ProblemDetailsJSON}: Problem as json object following the structure from the Dynatrace Problems V1 API.
{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}: Display number of the reported problem.
{ProblemImpact}: Impact level of the problem. Possible values are APPLICATION, SERVICE, or INFRASTRUCTURE.
{ProblemSeverity}: Severity level of the problem. Possible values are AVAILABILITY, ERROR, PERFORMANCE, RESOURCE_CONTENTION, or CUSTOM_ALERT.
{ProblemTitle}: Short description of the problem.
{ProblemURL}: URL of the problem within Dynatrace.
{State}: Problem state. Possible values are OPEN or RESOLVED.
{Tags}: Comma separated list of tags that are defined for all impacted entities. To refer to the value of a specific tag, specify the tag's key in square brackets: {Tags[key]}. If the tag does not have any assigned value, the placeholder will be replaced by an empty string. The placeholder will not be replaced if the tag key does not exist.
SlackNotification
objecturl
Set up an incoming WebHook integration within your Slack account. Copy and paste the generated WebHook URL into the field above.
channel
The channel (for example, #general
) or the user (for example, @john.smith
) to send the message to.
message
The content of the message. Type '{' for placeholder suggestions.
{ImpactedEntity}: A short description of the problem and impacted entity (or multiple impacted entities).
{ImpactedEntityNames}: The entity impacted by the problem.
{NamesOfImpactedEntities}: The names of all entities that are impacted by the problem.
{PID}: Unique system identifier of the reported problem.
{ProblemDetailsText}: All problem event details including root cause as a text-formatted string.
{ProblemID}: Display number of the reported problem.
{ProblemImpact}: Impact level of the problem. Possible values are APPLICATION, SERVICE, or INFRASTRUCTURE.
{ProblemSeverity}: Severity level of the problem. Possible values are AVAILABILITY, ERROR, PERFORMANCE, RESOURCE_CONTENTION, or CUSTOM_ALERT.
{ProblemTitle}: Short description of the problem.
{ProblemURL}: URL of the problem within Dynatrace.
{State}: Problem state. Possible values are OPEN or RESOLVED.
{Tags}: Comma separated list of tags that are defined for all impacted entities. To refer to the value of a specific tag, specify the tag's key in square brackets: {Tags[key]}. If the tag does not have any assigned value, the placeholder will be replaced by an empty string. The placeholder will not be replaced if the tag key does not exist.
JiraNotification
objecturl
The URL of the Jira API endpoint.
username
The username of the Jira profile.
apiToken
The API token for the Jira profile. Using password authentication was deprecated by Jira
projectKey
The project key of the Jira issue to be created by this notification.
issueType
The type of the Jira issue to be created by this notification.
To find all available issue types, or to create your own issue type, within JIRA go to Options > Issues.
summary
The summary of the Jira issue to be created by this notification. Type '{' for placeholder suggestions.
{ImpactedEntity}: A short description of the problem and impacted entity (or multiple impacted entities).
{ImpactedEntityNames}: The entity impacted by the problem.
{NamesOfImpactedEntities}: The names of all entities that are impacted by the problem.
{PID}: Unique system identifier of the reported problem.
{ProblemID}: Display number of the reported problem.
{ProblemImpact}: Impact level of the problem. Possible values are APPLICATION, SERVICE, or INFRASTRUCTURE.
{ProblemSeverity}: Severity level of the problem. Possible values are AVAILABILITY, ERROR, PERFORMANCE, RESOURCE_CONTENTION, or CUSTOM_ALERT.
{ProblemTitle}: Short description of the problem.
{ProblemURL}: URL of the problem within Dynatrace.
{State}: Problem state. Possible values are OPEN or RESOLVED.
{Tags}: Comma separated list of tags that are defined for all impacted entities. To refer to the value of a specific tag, specify the tag's key in square brackets: {Tags[key]}. If the tag does not have any assigned value, the placeholder will be replaced by an empty string. The placeholder will not be replaced if the tag key does not exist.
description
The description of the Jira issue to be created by this notification. Type '{' for placeholder suggestions.
{ImpactedEntity}: A short description of the problem and impacted entity (or multiple impacted entities).
{ImpactedEntityNames}: The entity impacted by the problem.
{NamesOfImpactedEntities}: The names of all entities that are impacted by the problem.
{PID}: Unique system identifier of the reported problem.
{ProblemDetailsText}: All problem event details including root cause as a text-formatted string.
{ProblemID}: Display number of the reported problem.
{ProblemImpact}: Impact level of the problem. Possible values are APPLICATION, SERVICE, or INFRASTRUCTURE.
{ProblemSeverity}: Severity level of the problem. Possible values are AVAILABILITY, ERROR, PERFORMANCE, RESOURCE_CONTENTION, or CUSTOM_ALERT.
{ProblemTitle}: Short description of the problem.
{ProblemURL}: URL of the problem within Dynatrace.
{State}: Problem state. Possible values are OPEN or RESOLVED.
{Tags}: Comma separated list of tags that are defined for all impacted entities. To refer to the value of a specific tag, specify the tag's key in square brackets: {Tags[key]}. If the tag does not have any assigned value, the placeholder will be replaced by an empty string. The placeholder will not be replaced if the tag key does not exist.
AnsibleTowerNotification
objectjobTemplateURL
The URL of the target job template.
For example, https://
Note: Be sure to select the Prompt on Launch option in the Extra Variables section of your job template configuration.
acceptAnyCertificate
username
Account username.
password
Account password.
customMessage
This message will be displayed in the Extra Variables Message field of your job template. Type '{' for placeholder suggestions.
{ImpactedEntities}: Details about the entities impacted by the problem in form of a json array.
{ImpactedEntity}: A short description of the problem and impacted entity (or multiple impacted entities).
{ImpactedEntityNames}: The entity impacted by the problem.
{NamesOfImpactedEntities}: The names of all entities that are impacted by the problem.
{PID}: Unique system identifier of the reported problem.
{ProblemDetailsText}: All problem event details including root cause as a text-formatted string.
{ProblemID}: Display number of the reported problem.
{ProblemImpact}: Impact level of the problem. Possible values are APPLICATION, SERVICE, or INFRASTRUCTURE.
{ProblemSeverity}: Severity level of the problem. Possible values are AVAILABILITY, ERROR, PERFORMANCE, RESOURCE_CONTENTION, or CUSTOM_ALERT.
{ProblemTitle}: Short description of the problem.
{ProblemURL}: URL of the problem within Dynatrace.
{State}: Problem state. Possible values are OPEN or RESOLVED.
{Tags}: Comma separated list of tags that are defined for all impacted entities. To refer to the value of a specific tag, specify the tag's key in square brackets: {Tags[key]}. If the tag does not have any assigned value, the placeholder will be replaced by an empty string. The placeholder will not be replaced if the tag key does not exist.
OpsGenieNotification
objectapiKey
The API key to access OpsGenie.
Go to OpsGenie-Integrations and create a new Dynatrace integration. Copy the newly created API key.
domain
The region domain of the OpsGenie.
For example, api.opsgenie.com for US or api.eu.opsgenie.com for EU.
message
The content of the message. Type '{' for placeholder suggestions.
{ProblemID}: Display number of the reported problem.
{ProblemImpact}: Impact level of the problem. Possible values are APPLICATION, SERVICE, or INFRASTRUCTURE.
{ProblemSeverity}: Severity level of the problem. Possible values are AVAILABILITY, ERROR, PERFORMANCE, RESOURCE_CONTENTION, or CUSTOM_ALERT.
{ProblemTitle}: Short description of the problem.
{ImpactedEntityNames}: The entity impacted by the problem (or multiple impacted entities).
PagerDutyNotification
objectaccount
The name of the PagerDuty account.
serviceName
The name of the service.
serviceApiKey
The API key to access PagerDuty.
VictorOpsNotification
objectapiKey
The API key for the target VictorOps account.
Receive your VictorOps API key by navigating to: Settings -> Integrations -> Rest Endpoint -> Dynatrace within your VictorOps account.
routingKey
The routing key, defining the group to be notified.
message
The content of the message. Type '{' for placeholder suggestions.
{ImpactedEntity}: A short description of the problem and impacted entity (or multiple impacted entities).
{ImpactedEntityNames}: The entity impacted by the problem.
{NamesOfImpactedEntities}: The names of all entities that are impacted by the problem.
{ProblemDetailsText}: All problem event details including root cause as a text-formatted string.
{ProblemID}: Display number of the reported problem.
{ProblemImpact}: Impact level of the problem. Possible values are APPLICATION, SERVICE, or INFRASTRUCTURE.
{ProblemSeverity}: Severity level of the problem. Possible values are AVAILABILITY, ERROR, PERFORMANCE, RESOURCE_CONTENTION, or CUSTOM_ALERT.
{ProblemTitle}: Short description of the problem.
{ProblemURL}: URL of the problem within Dynatrace.
{State}: Problem state. Possible values are OPEN or RESOLVED.
WebHookNotification
objecturlContainsSecret
url
The URL of the webhook endpoint.
secretUrl
The secret URL of the webhook endpoint.
acceptAnyCertificate
notifyEventMergesEnabled
notifyClosedProblems
useOAuth2
oAuth2Credentials
To authenticate your integration, the OAuth 2.0 Client Credentials Flow (Grant Type) is used. For details see Client Credentials Flow).
The obtained Access Token is subsequently provided in the Authorization header of the request carrying the notification payload.
headers
A list of the additional HTTP headers.
payload
The content of the notification message. Type '{' for placeholder suggestions.
{ImpactedEntities}: Details about the entities impacted by the problem in form of a json array.
{ImpactedEntity}: A short description of the problem and impacted entity (or multiple impacted entities).
{ImpactedEntityNames}: The entity impacted by the problem.
{NamesOfImpactedEntities}: The names of all entities that are impacted by the problem.
{PID}: Unique system identifier of the reported problem.
{ProblemDetailsHTML}: All problem event details including root cause as an HTML-formatted string.
{ProblemDetailsJSONv2}: Problem as json object following the structure from the Dynatrace Problems V2 API. The optional fields evidenceDetails and impactAnalysis are included, but recentComments is not.
{ProblemDetailsJSON}: Problem as json object following the structure from the Dynatrace Problems V1 API.
{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}: Display number of the reported problem.
{ProblemImpact}: Impact level of the problem. Possible values are APPLICATION, SERVICE, or INFRASTRUCTURE.
{ProblemSeverity}: Severity level of the problem. Possible values are AVAILABILITY, ERROR, PERFORMANCE, RESOURCE_CONTENTION, or CUSTOM_ALERT.
{ProblemTitle}: Short description of the problem.
{ProblemURL}: URL of the problem within Dynatrace.
{State}: Problem state. Possible values are OPEN or RESOLVED.
{Tags}: Comma separated list of tags that are defined for all impacted entities. To refer to the value of a specific tag, specify the tag's key in square brackets: {Tags[key]}. If the tag does not have any assigned value, the placeholder will be replaced by an empty string. The placeholder will not be replaced if the tag key does not exist.
XMattersNotification
objecturl
The URL of the xMatters webhook.
acceptAnyCertificate
headers
A list of the additional HTTP headers.
payload
The content of the notification message. Type '{' for placeholder suggestions.
{ImpactedEntities}: Details about the entities impacted by the problem in form of a json array.
{ImpactedEntity}: A short description of the problem and impacted entity (or multiple impacted entities).
{ImpactedEntityNames}: The entity impacted by the problem.
{NamesOfImpactedEntities}: The names of all entities that are impacted by the problem.
{PID}: Unique system identifier of the reported problem.
{ProblemDetailsHTML}: All problem event details including root cause as an HTML-formatted string.
{ProblemDetailsJSONv2}: Problem as json object following the structure from the Dynatrace Problems V2 API. The optional fields evidenceDetails and impactAnalysis are included, but recentComments is not.
{ProblemDetailsJSON}: Problem as json object following the structure from the Dynatrace Problems V1 API.
{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}: Display number of the reported problem.
{ProblemImpact}: Impact level of the problem. Possible values are APPLICATION, SERVICE, or INFRASTRUCTURE.
{ProblemSeverity}: Severity level of the problem. Possible values are AVAILABILITY, ERROR, PERFORMANCE, RESOURCE_CONTENTION, or CUSTOM_ALERT.
{ProblemTitle}: Short description of the problem.
{ProblemURL}: URL of the problem within Dynatrace.
{State}: Problem state. Possible values are OPEN or RESOLVED.
{Tags}: Comma separated list of tags that are defined for all impacted entities. To refer to the value of a specific tag, specify the tag's key in square brackets: {Tags[key]}. If the tag does not have any assigned value, the placeholder will be replaced by an empty string. The placeholder will not be replaced if the tag key does not exist.
TrelloNotification
objectapplicationKey
The application key for the Trello account.
You must be logged into Trello to have Trello automatically generate an application key for you. Get application key
authorizationToken
The authorization token for the Trello account.
boardId
listId
resolvedListId
text
The card text and problem placeholders to appear on new problem cards. Type '{' for placeholder suggestions.
{ImpactedEntity}: A short description of the problem and impacted entity (or multiple impacted entities).
{ImpactedEntityNames}: The entity impacted by the problem.
{NamesOfImpactedEntities}: The names of all entities that are impacted by the problem.
{PID}: Unique system identifier of the reported problem.
{ProblemID}: Display number of the reported problem.
{ProblemImpact}: Impact level of the problem. Possible values are APPLICATION, SERVICE, or INFRASTRUCTURE.
{ProblemSeverity}: Severity level of the problem. Possible values are AVAILABILITY, ERROR, PERFORMANCE, RESOURCE_CONTENTION, or CUSTOM_ALERT.
{ProblemTitle}: Short description of the problem.
{ProblemURL}: URL of the problem within Dynatrace.
{State}: Problem state. Possible values are OPEN or RESOLVED.
{Tags}: Comma separated list of tags that are defined for all impacted entities. To refer to the value of a specific tag, specify the tag's key in square brackets: {Tags[key]}. If the tag does not have any assigned value, the placeholder will be replaced by an empty string. The placeholder will not be replaced if the tag key does not exist.
description
The description of the Trello card. Type '{' for placeholder suggestions.
{ImpactedEntity}: A short description of the problem and impacted entity (or multiple impacted entities).
{ImpactedEntityNames}: The entity impacted by the problem.
{NamesOfImpactedEntities}: The names of all entities that are impacted by the problem.
{PID}: Unique system identifier of the reported problem.
{ProblemDetailsMarkdown}: All problem event details including root cause as a Markdown-formatted string.
{ProblemID}: Display number of the reported problem.
{ProblemImpact}: Impact level of the problem. Possible values are APPLICATION, SERVICE, or INFRASTRUCTURE.
{ProblemSeverity}: Severity level of the problem. Possible values are AVAILABILITY, ERROR, PERFORMANCE, RESOURCE_CONTENTION, or CUSTOM_ALERT.
{ProblemTitle}: Short description of the problem.
{ProblemURL}: URL of the problem within Dynatrace.
{State}: Problem state. Possible values are OPEN or RESOLVED.
{Tags}: Comma separated list of tags that are defined for all impacted entities. To refer to the value of a specific tag, specify the tag's key in square brackets: {Tags[key]}. If the tag does not have any assigned value, the placeholder will be replaced by an empty string. The placeholder will not be replaced if the tag key does not exist.
ServiceNowNotification
objectinstanceName
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.
url
The URL of the on-premise ServiceNow installation.
This field is mutually exclusive with the instanceName field. You can only use one of them.
username
The username of the ServiceNow account.
Make sure that your user account has the web_service_admin
and x_dynat_ruxit.Integration
roles.
password
The password to the ServiceNow account.
message
The content of the ServiceNow description. Type '{' for placeholder suggestions.
{ImpactedEntity}: A short description of the problem and impacted entity (or multiple impacted entities).
{ImpactedEntityNames}: The entity impacted by the problem.
{NamesOfImpactedEntities}: The names of all entities that are impacted by the problem.
{PID}: Unique system identifier of the reported problem.
{ProblemDetailsHTML}: All problem event details including root cause as an HTML-formatted string.
{ProblemDetailsText}: All problem event details including root cause as a text-formatted string.
{ProblemID}: Display number of the reported problem.
{ProblemImpact}: Impact level of the problem. Possible values are APPLICATION, SERVICE, or INFRASTRUCTURE.
{ProblemSeverity}: Severity level of the problem. Possible values are AVAILABILITY, ERROR, PERFORMANCE, RESOURCE_CONTENTION, or CUSTOM_ALERT.
{ProblemTitle}: Short description of the problem.
{State}: Problem state. Possible values are OPEN or RESOLVED.
{Tags}: Comma separated list of tags that are defined for all impacted entities. To refer to the value of a specific tag, specify the tag's key in square brackets: {Tags[key]}. If the tag does not have any assigned value, the placeholder will be replaced by an empty string. The placeholder will not be replaced if the tag key does not exist.
sendIncidents
sendEvents
formatProblemDetailsAsText
OAuth2Credentials
objectaccessTokenUrl
clientId
clientSecret
scope
The scope of access you are requesting
authenticateViaRequestHeader
If false, the client credentials are included in the HTTP request body.
WebHookNotificationHeader
objectname
The name of the HTTP header.
secret
value
The value of the HTTP header. May contain an empty value.
secretValue
The secret value of the HTTP header. May contain an empty value.