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.
Schema ID | Schema groups | Scope |
---|---|---|
builtin:problem.notifications |
| 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.
Property | Type | Description | Required |
---|---|---|---|
Enabledenabled | boolean | - | required |
Notification typetype | enum |
| required |
Display namedisplayName | text | The name of the notification configuration. | required |
emailNotification | EmailNotification | - | required |
slackNotification | SlackNotification | - | required |
jiraNotification | JiraNotification | - | required |
ansibleTowerNotification | AnsibleTowerNotification | - | required |
opsGenieNotification | OpsGenieNotification | - | required |
pagerDutyNotification | PagerDutyNotification | - | required |
victorOpsNotification | VictorOpsNotification | - | required |
webHookNotification | WebHookNotification | - | required |
xMattersNotification | XMattersNotification | - | required |
trelloNotification | TrelloNotification | - | required |
serviceNowNotification | ServiceNowNotification | - | required |
Alerting profilealertingProfile | setting | Select an alerting profile ( | required |
EmailNotification
objectProperty | Type | Description | Required |
---|---|---|---|
Torecipients | set | - | required |
CCccRecipients | set | - | required |
BCCbccRecipients | set | - | required |
Subjectsubject | text | 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. | required |
Send email if problem is closednotifyClosedProblems | boolean | - | required |
Bodybody | text | 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. | required |
SlackNotification
objectProperty | Type | Description | Required |
---|---|---|---|
URLurl | secret | Set up an incoming WebHook integration within your Slack account. Copy and paste the generated WebHook URL into the field above. | required |
Channelchannel | text | The channel (for example, | required |
Messagemessage | text | 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. | required |
JiraNotification
objectProperty | Type | Description | Required |
---|---|---|---|
Jira endpoint URLurl | text | The URL of the Jira API endpoint. | required |
Usernameusername | text | The username of the Jira profile. | required |
API tokenapiToken | secret | The API token for the Jira profile. Using password authentication was deprecated by Jira | required |
Project keyprojectKey | text | The project key of the Jira issue to be created by this notification. | required |
Issue typeissueType | text | 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. | required |
Summarysummary | text | 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. | required |
Issue descriptiondescription | text | 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. | required |
AnsibleTowerNotification
objectProperty | Type | Description | Required |
---|---|---|---|
Job template URLjobTemplateURL | text | The URL of the target job template. For example, https:///#/templates/job_template/ Note: Be sure to select the Prompt on Launch option in the Extra Variables section of your job template configuration. | required |
Accept any SSL certificate (including self-signed and invalid certificates)acceptAnyCertificate | boolean | - | required |
Usernameusername | text | Account username. | required |
Passwordpassword | secret | Account password. | required |
Custom message (optional)customMessage | text | 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. | required |
OpsGenieNotification
objectProperty | Type | Description | Required |
---|---|---|---|
OpsGenie API keyapiKey | secret | The API key to access OpsGenie. Go to OpsGenie-Integrations and create a new Dynatrace integration. Copy the newly created API key. | required |
OpsGenie region domaindomain | text | The region domain of the OpsGenie. For example, api.opsgenie.com for US or api.eu.opsgenie.com for EU. | required |
Messagemessage | text | 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). | required |
PagerDutyNotification
objectProperty | Type | Description | Required |
---|---|---|---|
Accountaccount | text | The name of the PagerDuty account. | required |
Service nameserviceName | text | The name of the service. | required |
Service keyserviceApiKey | secret | The Events API key to access PagerDuty. | required |
VictorOpsNotification
objectProperty | Type | Description | Required |
---|---|---|---|
API keyapiKey | secret | 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. | required |
Routing keyroutingKey | text | The routing key, defining the group to be notified. | required |
Messagemessage | text | 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. | required |
WebHookNotification
objectProperty | Type | Description | Required |
---|---|---|---|
Secret webhook URLurlContainsSecret | boolean | - | optional |
Webhook URLurl | text | The URL of the webhook endpoint. | required |
Webhook URLsecretUrl | secret | The secret URL of the webhook endpoint. | required |
Accept any SSL certificate (including self-signed and invalid certificates)acceptAnyCertificate | boolean | - | required |
Call webhook if new events merge into existing problemsnotifyEventMergesEnabled | boolean | - | required |
Call webhook if problem is closednotifyClosedProblems | boolean | - | required |
Use OAuth 2.0 for authenticationuseOAuth2 | boolean | - | optional |
OAuth 2.0 credentialsoAuth2Credentials | 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. | required |
Additional HTTP headersheaders | Set<WebHookNotificationHeader> | A list of the additional HTTP headers. | required |
Custom payloadpayload | text | 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. | required |
XMattersNotification
objectProperty | Type | Description | Required |
---|---|---|---|
xMatters URLurl | text | The URL of the xMatters webhook. | required |
Accept any SSL certificate (including self-signed and invalid certificates)acceptAnyCertificate | boolean | - | required |
Additional HTTP headersheaders | Set<WebHookNotificationHeader> | A list of the additional HTTP headers. | required |
Custom payloadpayload | text | 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. | required |
TrelloNotification
objectProperty | Type | Description | Required |
---|---|---|---|
Trello application keyapplicationKey | text | 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 | required |
Trello authorization tokenauthorizationToken | secret | The authorization token for the Trello account. | required |
Trello board ID problem cards should be assigned toboardId | text | - | required |
Trello list ID new problem cards should be assigned tolistId | text | - | required |
Trello list ID resolved problem cards should be assigned toresolvedListId | text | - | required |
Card texttext | 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. | required |
Card descriptiondescription | text | 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. | required |
ServiceNowNotification
objectProperty | Type | Description | Required |
---|---|---|---|
ServiceNow instance identifierinstanceName | text | 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. | required |
OnPremise URLurl | text | The URL of the on-premise ServiceNow installation. This field is mutually exclusive with the instanceName field. You can only use one of them. | optional |
Usernameusername | text | The username of the ServiceNow account. Make sure that your user account has the | required |
Passwordpassword | secret | The password to the ServiceNow account. | required |
Descriptionmessage | text | 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. | required |
Send incidents into ServiceNow ITSM.sendIncidents | boolean | - | required |
Send events into ServiceNow ITOM.sendEvents | boolean | - | required |
Use text format for problem details instead of HTML.formatProblemDetailsAsText | boolean | - | optional |
OAuth2Credentials
objectProperty | Type | Description | Required |
---|---|---|---|
Access token URLaccessTokenUrl | text | - | required |
Client IDclientId | text | - | required |
Client secretclientSecret | secret | - | required |
Scopescope | text | The scope of access you are requesting | optional |
Include the client credentials in the HTTP "Authorization" request header field with the HTTP "Basic" authentication scheme.authenticateViaRequestHeader | boolean | If false, the client credentials are included in the HTTP request body. | optional |
WebHookNotificationHeader
objectProperty | Type | Description | Required |
---|---|---|---|
Namename | text | The name of the HTTP header. | required |
Secret HTTP header valuesecret | boolean | - | required |
Valuevalue | text | The value of the HTTP header. May contain an empty value. | required |
ValuesecretValue | secret | The secret value of the HTTP header. May contain an empty value. | required |