@dynatrace-sdk/client-notification-v2

中文文档

2.5.0发布于 2026/07/29Apache-2.0TypeScriptESM + CJS近 30 天下载 1.4万

文档目录50 节

Installation
Getting help
License
eventNotificationsClient
createEventNotification
deleteEventNotification
getEventNotification
getEventNotifications
patchEventNotification
updateEventNotification
resourceNotificationsClient
createResourceNotification
deleteResourceNotification
deleteResourceNotificationByTypeAndResource
getResourceNotification
getResourceNotifications
Types
DavisEventConfig
DavisEventName
DavisEventTriggerConfig
DavisProblemCategories
DavisProblemConfig
DavisProblemTriggerConfig
EntityTags
Error
ErrorDetails
ErrorEnvelope
EventNotification
EventNotificationInput
EventNotificationRequest
EventNotificationUpdate
EventQuery
EventQueryTriggerConfig
ModificationInfo
PaginatedEventNotificationList
PaginatedResourceNotificationList
ResourceNotification
ResourceNotificationRequest
EventTriggerConfig
Enums
DavisEventNameMatch
DavisEventTriggerConfigType
DavisProblemConfigProblemOpenDuration
DavisProblemTriggerConfigType
EntityTagsMatch
EventQueryTriggerConfigType
EventType
MaintenanceWindowTriggerBehaviorType
TriggerOn
TriggerOnUpdateFields

@dynatrace-sdk/client-notification-v2

Manage resource/event notifications with the Notification Service API.

Installation

npm install @dynatrace-sdk/client-notification-v2

Getting help

Visit SDK for Typescript guide in the Dynatrace Developer
Ask a question in the Dynatrace Community

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

API reference

Full API reference for the latest version of the SDK is also available at the Dynatrace Developer.

eventNotificationsClient

import { eventNotificationsClient } from '@dynatrace-sdk/client-notification-v2';

createEventNotification

eventNotificationsClient.createEventNotification(config): Promise<EventNotification>

Required scope: notification:notifications:write

Parameters

Name	Type
config.body^*required	EventNotificationRequest

Returns

Return type	Status code	Description
EventNotification	201

Throws

Error Type	Error Message
ErrorEnvelopeError

Code example

import { eventNotificationsClient } from "@dynatrace-sdk/client-notification-v2";

const data =
  await eventNotificationsClient.createEventNotification({
    body: {
      resourceId: "...",
      notificationType: "...",
      triggerConfiguration: {
        type: "event",
        value: { query: "..." },
      },
    },
  });

deleteEventNotification

eventNotificationsClient.deleteEventNotification(config): Promise<void>

Required scope: notification:notifications:write

Parameters

Name	Type	Description
config.id^*required	string	A UUID string identifying this self notification.

Returns

Return type	Status code	Description
void	204	No response body

Throws

Error Type	Error Message
ErrorEnvelopeError

Code example

import { eventNotificationsClient } from "@dynatrace-sdk/client-notification-v2";

const data =
  await eventNotificationsClient.deleteEventNotification({
    id: "...",
  });

getEventNotification

eventNotificationsClient.getEventNotification(config): Promise<EventNotification>

Required scope: notification:notifications:read

Parameters

Name	Type	Description
config.id^*required	string	A UUID string identifying this self notification.

Returns

Return type	Status code	Description
EventNotification	200

Throws

Error Type	Error Message
ErrorEnvelopeError

Code example

import { eventNotificationsClient } from "@dynatrace-sdk/client-notification-v2";

const data =
  await eventNotificationsClient.getEventNotification({
    id: "...",
  });

getEventNotifications

eventNotificationsClient.getEventNotifications(config): Promise<PaginatedEventNotificationList>

Required scope: notification:notifications:read

Parameters

Name	Type	Description
config.appId	string	Application id associated with the notification. Optional, by default automatically inferred from the request header. Only relevant for manual testing purposes via swagger.
config.limit	number	Number of results to return per page.
config.notificationType	string	String that defines the type of a notification in context of an app. Allows to differentiate between multiple types of notifications in context of one app.
config.offset	number	The initial index from which to return the results.
config.ordering	string	Which field to use when ordering the results.
config.owner	string
config.resourceId	string	Unique identifier of resource to notify on. Used to determine if there is a notification registered for a resource in context of the app and notification type for a user.
config.search	string	A search term.

Returns

Return type	Status code	Description
PaginatedEventNotificationList	200

Throws

Error Type	Error Message
ErrorEnvelopeError

Code example

import { eventNotificationsClient } from "@dynatrace-sdk/client-notification-v2";

const data =
  await eventNotificationsClient.getEventNotifications();

patchEventNotification

eventNotificationsClient.patchEventNotification(config): Promise<EventNotification>

Required scope: notification:notifications:write

Parameters

Name	Type	Description
config.body^*required	EventNotificationUpdate
config.id^*required	string	A UUID string identifying this self notification.

Returns

Return type	Status code	Description
EventNotification	200

Throws

Error Type	Error Message
ErrorEnvelopeError

Code example

import { eventNotificationsClient } from "@dynatrace-sdk/client-notification-v2";

const data =
  await eventNotificationsClient.patchEventNotification({
    id: "...",
    body: {
      triggerConfiguration: {
        type: "event",
        value: { query: "..." },
      },
    },
  });

updateEventNotification

eventNotificationsClient.updateEventNotification(config): Promise<EventNotification>

Required scope: notification:notifications:write

Parameters

Name	Type	Description
config.body^*required	EventNotificationUpdate
config.id^*required	string	A UUID string identifying this self notification.

Returns

Return type	Status code	Description
EventNotification	200

Throws

Error Type	Error Message
ErrorEnvelopeError

Code example

import { eventNotificationsClient } from "@dynatrace-sdk/client-notification-v2";

const data =
  await eventNotificationsClient.updateEventNotification({
    id: "...",
    body: {
      triggerConfiguration: {
        type: "event",
        value: { query: "..." },
      },
    },
  });

resourceNotificationsClient

import { resourceNotificationsClient } from '@dynatrace-sdk/client-notification-v2';

createResourceNotification

resourceNotificationsClient.createResourceNotification(config): Promise<ResourceNotification>

Required scope: notification:notifications:write

Parameters

Name	Type
config.body^*required	ResourceNotificationRequest

Returns

Return type	Status code	Description
ResourceNotification	201

Throws

Error Type	Error Message
ErrorEnvelopeError

Code example

import { resourceNotificationsClient } from "@dynatrace-sdk/client-notification-v2";

const data =
  await resourceNotificationsClient.createResourceNotification(
    {
      body: { notificationType: "...", resourceId: "..." },
    },
  );

deleteResourceNotification

resourceNotificationsClient.deleteResourceNotification(config): Promise<void>

Required scope: notification:notifications:write

Parameters

Name	Type	Description
config.appId	string	Application id associated with the notification. Optional, by default automatically inferred from the request header. Only relevant for manual testing purposes via swagger.
config.id^*required	string	A UUID string identifying this resource notification.

Returns

Return type	Status code	Description
void	204	No response body

Throws

Error Type	Error Message
ErrorEnvelopeError

Code example

import { resourceNotificationsClient } from "@dynatrace-sdk/client-notification-v2";

const data =
  await resourceNotificationsClient.deleteResourceNotification(
    { id: "..." },
  );

deleteResourceNotificationByTypeAndResource

resourceNotificationsClient.deleteResourceNotificationByTypeAndResource(config): Promise<void>

Required scope: notification:notifications:write

Parameters

Name	Type	Description
config.appId	string	Application id associated with the notification. Optional, by default automatically inferred from the request header. Only relevant for manual testing purposes via swagger.
config.notificationType^*required	string	String that defines the type of a notification in context of an app. Allows to differentiate between multiple types of notifications in context of one app.
config.resourceId^*required	string	Unique identifier of resource to notify on. Used to determine if there is a notification registered for a resource in context of the app and notification type for a user.

Returns

Return type	Status code	Description
void	204	No response body

Throws

Error Type	Error Message
ErrorEnvelopeError

Code example

import { resourceNotificationsClient } from "@dynatrace-sdk/client-notification-v2";

const data =
  await resourceNotificationsClient.deleteResourceNotificationByTypeAndResource(
    { notificationType: "...", resourceId: "..." },
  );

getResourceNotification

resourceNotificationsClient.getResourceNotification(config): Promise<ResourceNotification>

Required scope: notification:notifications:read

Parameters

Name	Type	Description
config.appId	string	Application id associated with the notification. Optional, by default automatically inferred from the request header. Only relevant for manual testing purposes via swagger.
config.id^*required	string	A UUID string identifying this resource notification.

Returns

Return type	Status code	Description
ResourceNotification	200

Throws

Error Type	Error Message
ErrorEnvelopeError

Code example

import { resourceNotificationsClient } from "@dynatrace-sdk/client-notification-v2";

const data =
  await resourceNotificationsClient.getResourceNotification(
    { id: "..." },
  );

getResourceNotifications

resourceNotificationsClient.getResourceNotifications(config): Promise<PaginatedResourceNotificationList>

Required scope: notification:notifications:read

Parameters

Name	Type	Description
config.appId	string	Application id associated with the notification. Optional, by default automatically inferred from the request header. Only relevant for manual testing purposes via swagger.
config.limit	number	Number of results to return per page.
config.notificationType	string	String that defines the type of a notification in context of an app. Allows to differentiate between multiple types of notifications in context of one app.
config.offset	number	The initial index from which to return the results.
config.ordering	string	Which field to use when ordering the results.
config.resourceId	string	Unique identifier of resource to notify on. Used to determine if there is a notification registered for a resource in context of the app and notification type for a user.
config.search	string	A search term.

Returns

Return type	Status code	Description
PaginatedResourceNotificationList	200

Throws

Error Type	Error Message
ErrorEnvelopeError

Code example

import { resourceNotificationsClient } from "@dynatrace-sdk/client-notification-v2";

const data =
  await resourceNotificationsClient.getResourceNotifications();

Types

DavisEventConfig

Name	Type	Description
customFilter	null \| string	Additional DQL matcher expression to further filter events to match. default: `""`
entityTags	null \| EntityTags
entityTagsMatch	null \| "all" \| "any"
maintenanceWindowTriggerBehavior	"always" \| "inside" \| "outside"	default: `"always"`
names	null \| Array<DavisEventName>
~~onProblemClose~~^DEPRECATED	boolean	Trigger on Davis event open only or also on close. Deprecated — use triggerOn instead. default: `false`
triggerOn	null \| "open" \| "open-and-close" \| "close"	Event state to trigger on. "open" (active only), "open-and-close" (both phases), or "close" (closure only). When unset, falls back to onProblemClose for backward compatibility.
~~types~~^DEPRECATED	null \| Array<string>

DavisEventName

Name	Type	Description
match^*required	"equals" \| "contains"	Davis event name must equal or contain the string provided.
name^*required	string

DavisEventTriggerConfig

Name	Type
type^*required	"davis-event"
value^*required	DavisEventConfig

DavisProblemCategories

Name	Type	Default
availability	boolean	`false`
custom	boolean	`false`
error	boolean	`false`
info	boolean	`false`
monitoringUnavailable	boolean	`false`
resource	boolean	`false`
slowdown	boolean	`false`

DavisProblemConfig

Name	Type	Description
analysisReady	boolean	Run only after first root cause analysis run completed. default: `false`
categories^*required	DavisProblemCategories
customFilter	null \| string	Additional DQL matcher expression to further filter events to match. default: `""`
entityTags	null \| EntityTags
entityTagsMatch	null \| "all" \| "any"
~~onProblemClose~~^DEPRECATED	boolean	Trigger on Davis problem open only or also on close. Deprecated — use triggerOn instead. default: `false`
problemOpenDuration	null \| 5 \| 10 \| 15 \| 30 \| 60 \| 120 \| 240 \| 1440 \| 10080	Minimum problem duration in minutes before the trigger fires.
severityThreshold	null \| number	Triggers only for problems whose severity is this value or more severe. Lower numbers are more severe (1 = critical, 5 = informational), so 3 matches severities 1, 2, and 3.
triggerOn	null \| "open" \| "open-and-close" \| "close"	Problem state to trigger on. "open" (active only), "open-and-close" (both phases), or "close" (closure only). When unset, falls back to onProblemClose for backward compatibility.
triggerOnUpdateFields	Array<"dt.davis.affected_users_count" \| "dt.davis.impact_level" \| "event.category" \| "event.severity" \| "root_cause_entity_id" \| "smartscape.affected_entities">	Problem event fields tracked for value changes. Changes to any selected field cause re-triggering.

DavisProblemTriggerConfig

Name	Type
type^*required	"davis-problem"
value^*required	DavisProblemConfig

EntityTags

Entity tags to match by key and (optional) values. For example {"foo": [], "bar": ["a", "b", "c"]}

type: Record<string, string | string[]>

Error

Name	Type
code^*required	number
details	ErrorDetails
message^*required	string

ErrorDetails

Name	Type
errorCode	string
errorRef	string

ErrorEnvelope

Name	Type
error^*required	Error

EventNotification

Name	Type	Description
appId	string	App id for registered notification. Optional, by default automatically inferred from the request. Only relevant for manual testing purposes via swagger.
id^*required	string
input	EventNotificationInput	Input object consisting of subject and content. Supports automation expressions https://dt-url.net/workflows-expression-reference and markdown syntax. A template provided with an app ({notification_type}.notification-template.json) will take precedence over the input provided here.
modificationInfo^*required	ModificationInfo
notificationType^*required	string	String that defines the type of a notification in context of an app. Allows to differentiate between multiple types of notifications in context of one app.
owner^*required	string
resourceId^*required	string	Unique identifier of resource to notify on. Used to determine if there is a notification registered for a resource in context of the app and notification type for a user.
title	string
triggerConfiguration^*required	EventTriggerConfig

EventNotificationInput

Name	Type
content	null \| string
subject	null \| string

EventNotificationRequest

Name	Type	Description
appId	string	App id for registered notification. Optional, by default automatically inferred from the request. Only relevant for manual testing purposes via swagger.
id	string
input	EventNotificationInput	Input object consisting of subject and content. Supports automation expressions https://dt-url.net/workflows-expression-reference and markdown syntax. A template provided with an app ({notification_type}.notification-template.json) will take precedence over the input provided here.
notificationType^*required	string	String that defines the type of a notification in context of an app. Allows to differentiate between multiple types of notifications in context of one app.
resourceId^*required	string	Unique identifier of resource to notify on. Used to determine if there is a notification registered for a resource in context of the app and notification type for a user.
title	string
triggerConfiguration^*required	EventTriggerConfig

EventNotificationUpdate

Name	Type	Description
appId	string	App id for registered notification. Optional, by default automatically inferred from the request. Only relevant for manual testing purposes via swagger.
input	EventNotificationInput	Input object consisting of subject and content. Supports automation expressions https://dt-url.net/workflows-expression-reference and markdown syntax. A template provided with an app ({notification_type}.notification-template.json) will take precedence over the input provided here.
notificationType	string	String that defines the type of a notification in context of an app. Allows to differentiate between multiple types of notifications in context of one app.
resourceId	string	Unique identifier of resource to notify on. Used to determine if there is a notification registered for a resource in context of the app and notification type for a user.
title	string
triggerConfiguration	EventTriggerConfig

EventQuery

Name	Type	Description
eventType	"events" \| "bizevents" \| "dt.system.events" \| "security.events"	Grail event type.
query^*required	string	DQL matcher expression defining which events to match.

EventQueryTriggerConfig

Name	Type
type^*required	"event"
value^*required	EventQuery

ModificationInfo

Name	Type
createdBy^*required	null \| string
createdTime^*required	Date
lastModifiedBy^*required	null \| string
lastModifiedTime^*required	Date

PaginatedEventNotificationList

Name	Type
count^*required	number
results^*required	Array<EventNotification>

PaginatedResourceNotificationList

Name	Type
count^*required	number
results^*required	Array<ResourceNotification>

ResourceNotification

Name	Type	Description
appId	null \| string	App id for registered notification. Optional, by default automatically inferred from the request. Only relevant for manual testing purposes via swagger.
id^*required	string
modificationInfo^*required	ModificationInfo
notificationType^*required	string	String that defines the type of a notification in context of an app. Allows to differentiate between multiple types of notifications in context of one app.
owningUser^*required	string
resourceId^*required	string	Unique identifier of resource to notify on. Used to determine if there is a notification registered for a resource in context of the app and notification type for a user.

ResourceNotificationRequest

Name	Type	Description
appId	null \| string	App id for registered notification. Optional, by default automatically inferred from the request. Only relevant for manual testing purposes via swagger.
notificationType^*required	string	String that defines the type of a notification in context of an app. Allows to differentiate between multiple types of notifications in context of one app.
resourceId^*required	string	Unique identifier of resource to notify on. Used to determine if there is a notification registered for a resource in context of the app and notification type for a user.

EventTriggerConfig

type: <a href="#eventquerytriggerconfig">EventQueryTriggerConfig</a> | <a href="#davisproblemtriggerconfig" target="_blank" rel="noopener noreferrer">DavisProblemTriggerConfig</a> | <a href="#daviseventtriggerconfig">DavisEventTriggerConfig</a>

Enums

DavisEventNameMatch

Davis event name must equal or contain the string provided.

Enum keys

Contains | Equals

DavisEventTriggerConfigType

Enum keys

DavisEvent

DavisProblemConfigProblemOpenDuration

Minimum problem duration in minutes before the trigger fires.

Enum keys

DavisProblemConfigProblemOpenDuration_10 | DavisProblemConfigProblemOpenDuration_10080 | DavisProblemConfigProblemOpenDuration_120 | DavisProblemConfigProblemOpenDuration_1440 | DavisProblemConfigProblemOpenDuration_15 | DavisProblemConfigProblemOpenDuration_240 | DavisProblemConfigProblemOpenDuration_30 | DavisProblemConfigProblemOpenDuration_5 | DavisProblemConfigProblemOpenDuration_60

DavisProblemTriggerConfigType

Enum keys

DavisProblem

EntityTagsMatch

Event must match all or any of the entity tags.

Enum keys

All | Any

EventQueryTriggerConfigType

Enum keys

Event

EventType

Grail event type.

Enum keys

Bizevents | DtSystemEvents | Events | SecurityEvents

MaintenanceWindowTriggerBehaviorType

Specifies when to trigger based on maintenance window status.

Enum keys

Always | Inside | Outside

TriggerOn

Enum keys

Close | Open | OpenAndClose

TriggerOnUpdateFields

Enum keys

版本与发布记录

@dynatrace-sdk/client-notification-v2 共发布 4 个版本，首次发布于 2025/08/12；过去 12 个月发布了 3 个版本。

版本	发布日期	距今
`2.5.0`latest	2026/07/29	3 个月前
`2.4.1`	2026/06/30	4 个月前
`2.2.0`	2026/06/03	5 个月前
`1.0.0`	2025/08/12	1.3 年前

关于 @dynatrace-sdk/client-notification-v2 的常见问题

如何安装 @dynatrace-sdk/client-notification-v2？

在项目目录运行 npm install @dynatrace-sdk/client-notification-v2，或使用 pnpm add / yarn add / bun add。

@dynatrace-sdk/client-notification-v2 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

@dynatrace-sdk/client-notification-v2 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require() 都可以使用，打包工具会自动选择合适的版本。

@dynatrace-sdk/client-notification-v2 可以商用吗？

@dynatrace-sdk/client-notification-v2 使用 Apache-2.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

@dynatrace-sdk/client-notification-v2 的下载量有多少？

根据 npm 官方下载统计，@dynatrace-sdk/client-notification-v2 在 2026/10/13 – 2026/11/11 这 30 天内被下载 14,440 次，日均约 481 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

@dynatrace-sdk/client-notification-v2 还在维护吗？

最新版本 2.5.0 发布于 2026/07/29（3 个月前）；至今共发布 4 个版本，其中过去 12 个月发布了 3 个；首次发布于 2025/08/12。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。