• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Problem notifications

Settings API - Problem notifications schema table

Problem notifications (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 IDSchema groupsScope
builtin:problem.notifications
  • group:integration
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:problem.notifications
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:problem.notifications
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:problem.notifications

Authentication

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.

Parameters

PropertyLabelTypeDescriptionRequired
enabledEnabledboolean-required
typeNotification typeenum-required
displayNameDisplay nametext

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
alertingProfileAlerting profilesetting

Select an alerting profile to control the delivery of problem notifications related to this integration.

required

Request body objects

The FlagDefaultTrue object
PropertyLabelTypeDescriptionRequired
enabledEnabledboolean-required
The EmailNotification object
PropertyLabelTypeDescriptionRequired
recipientsToset-required
ccRecipientsCCset-required
bccRecipientsBCCset-required
subjectSubjecttext

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
notifyClosedProblemsSend email if problem is closedboolean-required
bodyBodytext

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
The SlackNotification object
PropertyLabelTypeDescriptionRequired
urlURLsecret

Set up an incoming WebHook integration within your Slack account. Copy and paste the generated WebHook URL into the field above.

required
channelChanneltext

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

required
messageMessagetext

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
The JiraNotification object
PropertyLabelTypeDescriptionRequired
urlJira endpoint URLtext

The URL of the Jira API endpoint.

required
usernameUsernametext

The username of the Jira profile.

required
apiTokenAPI tokensecret

The API token for the Jira profile. Using password authentication was deprecated by Jira

required
projectKeyProject keytext

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

required
issueTypeIssue typetext

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
summarySummarytext

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
descriptionIssue descriptiontext

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
The AnsibleTowerNotification object
PropertyLabelTypeDescriptionRequired
jobTemplateURLJob template URLtext

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
acceptAnyCertificateAccept any SSL certificate (including self-signed and invalid certificates)boolean-required
usernameUsernametext

Account username.

required
passwordPasswordsecret

Account password.

required
customMessageCustom message (optional)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
The OpsGenieNotification object
PropertyLabelTypeDescriptionRequired
apiKeyOpsGenie API keysecret

The API key to access OpsGenie.

Go to OpsGenie-Integrations and create a new Dynatrace integration. Copy the newly created API key.

required
domainOpsGenie region domaintext

The region domain of the OpsGenie.

For example, api.opsgenie.com for US or api.eu.opsgenie.com for EU.

required
messageMessagetext

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
The PagerDutyNotification object
PropertyLabelTypeDescriptionRequired
accountAccounttext

The name of the PagerDuty account.

required
serviceNameService nametext

The name of the service.

required
serviceApiKeyService keysecret

The API key to access PagerDuty.

required
The VictorOpsNotification object
PropertyLabelTypeDescriptionRequired
apiKeyAPI keysecret

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
routingKeyRouting keytext

The routing key, defining the group to be notified.

required
messageMessagetext

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
The WebHookNotificationHeader object
PropertyLabelTypeDescriptionRequired
nameNametext

The name of the HTTP header.

required
secretSecret HTTP header valueboolean-required
valueValuetext

The value of the HTTP header. May contain an empty value.

required
secretValueValuesecret

The secret value of the HTTP header. May contain an empty value.

required
The WebHookNotification object
PropertyLabelTypeDescriptionRequired
urlWebhook URLtext

The URL of the WebHook endpoint.

required
acceptAnyCertificateAccept any SSL certificate (including self-signed and invalid certificates)boolean-required
notifyEventMergesEnabledCall webhook if new events merge into existing problemsboolean-required
notifyClosedProblemsCall webhook if problem is closedboolean-required
useOAuth2Use OAuth 2.0 for authenticationboolean-optional
oAuth2CredentialsOAuth 2.0 credentialsOAuth2Credentials

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
headersAdditional HTTP headersset

A list of the additional HTTP headers.

required
payloadCustom payloadtext

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
The XMattersNotification object
PropertyLabelTypeDescriptionRequired
urlxMatters URLtext

The URL of the xMatters webhook.

required
acceptAnyCertificateAccept any SSL certificate (including self-signed and invalid certificates)boolean-required
headersAdditional HTTP headersset

A list of the additional HTTP headers.

required
payloadCustom payloadtext

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
The TrelloNotification object
PropertyLabelTypeDescriptionRequired
applicationKeyTrello application keytext

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
authorizationTokenTrello authorization tokensecret

The authorization token for the Trello account.

required
boardIdTrello board ID problem cards should be assigned totext-required
listIdTrello list ID new problem cards should be assigned totext-required
resolvedListIdTrello list ID resolved problem cards should be assigned totext-required
textCard texttext

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
descriptionCard descriptiontext

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
The ServiceNowNotification object
PropertyLabelTypeDescriptionRequired
instanceNameServiceNow instance identifiertext

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
urlOnPremise URLtext

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
usernameUsernametext

The username of the ServiceNow account.

Make sure that your user account has the web_service_admin and x_dynat_ruxit.Integration roles.

required
passwordPasswordsecret

The password to the ServiceNow account.

required
messageDescriptiontext

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. 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
sendIncidentsSend incidents into ServiceNow ITSM.boolean-required
sendEventsSend events into ServiceNow ITOM.boolean-required
The OAuth2Credentials object
PropertyLabelTypeDescriptionRequired
accessTokenUrlAccess token URLtext-required
clientIdClient IDtext-required
clientSecretClient secretsecret-required
scopeScopetext

The scope of access you are requesting

optional