Notifications API - PUT a notification configuration

Updates the specified notification configuration.

If a notification configuration with the specified ID doesn't exist, a new configuration is created.

The request consumes and produces an application/json payload.

PUT
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/notifications/{id}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/notifications/{id}

Parameters

Parameter Type Description In Required
body NotificationConfig

The JSON body of the request. Contains updated parameters of the notification configuration.

body optional
id string

The ID of the notification configuration to be updated.

If you also set the ID in the body, it must match this ID.

path required

The NotificationConfig object

Configuration of a notification. The actual set of fields depends on the type of the notification. Find the additional fields in one of these objects:

  • ANSIBLETOWER -> AnsibleTowerNotificationConfig
  • EMAIL -> EmailNotificationConfig
  • HIPCHAT -> HipChatNotificationConfig
  • JIRA -> JiraNotificationConfig
  • OPS_GENIE -> OpsGenieNotificationConfig
  • PAGER_DUTY -> PagerDutyNotificationConfig
  • SERVICE_NOW -> ServiceNowNotificationConfig
  • SLACK -> SlackNotificationConfig
  • TRELLO -> TrelloNotificationConfig
  • VICTOROPS -> VictorOpsNotificationConfig
  • WEBHOOK -> WebHookNotificationConfig
  • XMATTERS -> XMattersNotificationConfig
Element Type Description Required
id string

The ID of the notification configuration.

optional
name string

The name of the notification configuration.

required
alertingProfile string

The ID of the associated alerting profile.

required
active boolean

The configuration is enabled (true) or disabled (false).

required

The AnsibleTowerNotificationConfig object

Configuration of the Ansible Tower notification.

Element Type Description Required
id string

The ID of the notification configuration.

optional
name string

The name of the notification configuration.

required
alertingProfile string

The ID of the associated alerting profile.

required
active boolean

The configuration is enabled (true) or disabled (false).

required
jobTemplateURL string

The URL of the target Ansible Tower job template.

required
acceptAnyCertificate boolean

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

required
username string

The username of the Ansible Tower account.

required
password string

The password for the Ansible Tower account.

optional
jobTemplateID integer

The ID of the target Ansible Tower job template.

required
customMessage string

The custom message of the notification.

This message will be displayed in the extra variables Message field of your job template.

required

The EmailNotificationConfig object

Configuration of the email notification.

Element Type Description Required
id string

The ID of the notification configuration.

optional
name string

The name of the notification configuration.

required
alertingProfile string

The ID of the associated alerting profile.

required
active boolean

The configuration is enabled (true) or disabled (false).

required
subject string

The subject of the email notifications.

required
body string

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. If the problem has been merged into another problem, it has the MERGED value.
  • {Tags}: The list of tags that are defined for all impacted entities, separated by commas.
required
receivers string[]

The list of the email recipients.

required
ccReceivers string[]

The list of the email CC-recipients.

optional
shouldSendForResolvedProblems boolean

Send (true) or doesn't send (false) an email, confirming problem resolution.

required

The HipChatNotificationConfig object

Configuration of the HipChat notification.

Element Type Description Required
id string

The ID of the notification configuration.

optional
name string

The name of the notification configuration.

required
alertingProfile string

The ID of the associated alerting profile.

required
active boolean

The configuration is enabled (true) or disabled (false).

required
url string

The URL of the HipChat WebHook.

This is confidential information, therefore GET requests return this field with the null value, and it is optional for PUT requests.

optional
message string

The content of the notification 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. If the problem has been merged into another problem, it has the MERGED value.
  • {Tags}: The list of tags that are defined for all impacted entities, separated by commas.
required

The JiraNotificationConfig object

Configuration of the Jira notification.

Element Type Description Required
id string

The ID of the notification configuration.

optional
name string

The name of the notification configuration.

required
alertingProfile string

The ID of the associated alerting profile.

required
active boolean

The configuration is enabled (true) or disabled (false).

required
username string

The username of the Jira profile.

required
password string

The password for the Jira profile.

optional
url string

The URL of the Jira API endpoint.

required
projectKey string

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

required
issueType string

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

required
summary string

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. If the problem has been merged into another problem, it has the MERGED value.
  • {Tags}: The list of tags that are defined for all impacted entities, separated by commas.
required
description string

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

You can use same placeholders as in issue summary.

required

The OpsGenieNotificationConfig object

Configuration of the OpsGenie notification.

Element Type Description Required
id string

The ID of the notification configuration.

optional
name string

The name of the notification configuration.

required
alertingProfile string

The ID of the associated alerting profile.

required
active boolean

The configuration is enabled (true) or disabled (false).

required
apiKey string

The API key to access OpsGenie.

optional
domain string

The region domain of the OpsGenie.

required
message string

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

The PagerDutyNotificationConfig object

Configuration of the PagerDuty notification.

Element Type Description Required
id string

The ID of the notification configuration.

optional
name string

The name of the notification configuration.

required
alertingProfile string

The ID of the associated alerting profile.

required
active boolean

The configuration is enabled (true) or disabled (false).

required
account string

The name of the PagerDuty account.

required
serviceApiKey string

The API key to access PagerDuty.

optional
serviceName string

The name of the service.

required

The ServiceNowNotificationConfig object

Configuration of the ServiceNow notification.

Element Type Description Required
id string

The ID of the notification configuration.

optional
name string

The name of the notification configuration.

required
alertingProfile string

The ID of the associated alerting profile.

required
active boolean

The configuration is enabled (true) or disabled (false).

required
instanceName string

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.

optional
url string

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
username string

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.

required
password string

The username to the ServiceNow account

optional
message string

The content of the ServiceNow description.

It is limited to 80 characters.

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. If the problem has been merged into another problem, it has the MERGED value.
  • {Tags}: The list of tags that are defined for all impacted entities, separated by commas.
required
sendIncidents boolean

Send incidents into ServiceNow ITSM (true).

required
sendEvents boolean

Send events into ServiceNow ITOM (true).

required

The SlackNotificationConfig object

Configuration of the Slack notification.

Element Type Description Required
id string

The ID of the notification configuration.

optional
name string

The name of the notification configuration.

required
alertingProfile string

The ID of the associated alerting profile.

required
active boolean

The configuration is enabled (true) or disabled (false).

required
url string

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.

optional
channel string

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

required
title string

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. If the problem has been merged into another problem, it has the MERGED value.
  • {Tags}: The list of tags that are defined for all impacted entities, separated by commas.
required

The TrelloNotificationConfig object

Configuration of the Trello notification.

Element Type Description Required
id string

The ID of the notification configuration.

optional
name string

The name of the notification configuration.

required
alertingProfile string

The ID of the associated alerting profile.

required
active boolean

The configuration is enabled (true) or disabled (false).

required
applicationKey string

The application key for the Trello account.

required
authorizationToken string

The application token for the Trello account.

optional
boardId string

The Trello board to which the card should be assigned.

required
listId string

The Trello list to which the card should be assigned.

required
resolvedListId string

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

required
text string

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. If the problem has been merged into another problem, it has the MERGED value.
  • {Tags}: The list of tags that are defined for all impacted entities, separated by commas.
required
description string

The description of the Trello card.

You can use same placeholders as in card text.

required

The VictorOpsNotificationConfig object

Configuration of the VictorOps notification.

Element Type Description Required
id string

The ID of the notification configuration.

optional
name string

The name of the notification configuration.

required
alertingProfile string

The ID of the associated alerting profile.

required
active boolean

The configuration is enabled (true) or disabled (false).

required
apiKey string

The API key for the target VictorOps account.

optional
routingKey string

The routing key, defining the group to be notified.

required
message string

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. If the problem has been merged into another problem, it has the MERGED value.
required

The WebHookNotificationConfig object

Configuration of the custom WebHook notification.

Element Type Description Required
id string

The ID of the notification configuration.

optional
name string

The name of the notification configuration.

required
alertingProfile string

The ID of the associated alerting profile.

required
active boolean

The configuration is enabled (true) or disabled (false).

required
url string

The URL of the WebHook endpoint.

required
acceptAnyCertificate boolean

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

required
payload string

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. If the problem has been merged into another problem, it has the MERGED value.
  • {Tags}: The list of tags that are defined for all impacted entities, separated by commas.
required
headers HttpHeader[]

A list of the additional HTTP headers.

optional

The HttpHeader object

The HTTP header.

Element Type Description Required
name string

The name of the HTTP header.

required
value string

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.

optional

The XMattersNotificationConfig object

Configuration of the xMatters notification.

Element Type Description Required
id string

The ID of the notification configuration.

optional
name string

The name of the notification configuration.

required
alertingProfile string

The ID of the associated alerting profile.

required
active boolean

The configuration is enabled (true) or disabled (false).

required
url string

The URL of the xMatters WebHook.

required
acceptAnyCertificate boolean

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

required
headers HttpHeader[]

A list of the additional HTTP headers.

optional
payload string

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. If the problem has been merged into another problem, it has the MERGED value.
  • {Tags}: The list of tags that are defined for all impacted entities, separated by commas.
required

The HttpHeader object

The HTTP header.

Element Type Description Required
name string

The name of the HTTP header.

required
value string

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.

optional

Response codes

Code Description
201 Success. The new notification configuration has been created. The response contains the ID of the new notification configuration.
204 Success. The notification configuration has been updated. Response doesn't have a body.
400 Failed. The input is invalid.

Response format

The NotificationConfigStub object

The short representation of a notification.

Element Type Description
id string

The ID of the Dynatrace entity.

name string

The name of the Dynatrace entity.

description string

A short description of the Dynatrace entity.

type string

The type of the notification.

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/notifications/{id}/validator
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/notifications/{id}/validator

Response codes

Code Description
204 Validated. The submitted configuration is valid. Response does not have a body
400 Failed. The input is invalid.