# @dynatrace-sdk/client-notification-v2 [![npm](https://img.shields.io/badge/npm-v2.5.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-notification-v2/v/2.5.0) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) Manage resource/event notifications with the Notification Service API. ## Installation ```bash npm install @dynatrace-sdk/client-notification-v2 ``` ## Getting help - Visit [SDK for Typescript](https://developer.dynatrace.com/reference/sdks/) guide in the [Dynatrace Developer](https://developer.dynatrace.com/) - Ask a question in the [Dynatrace Community](https://community.dynatrace.com/) ## License This SDK is distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-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](https://developer.dynatrace.com/reference/sdks/client-notification-v2/). ## eventNotificationsClient ```js 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](#eventnotification)|201|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts 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](https://developer.mozilla.org/en-US/docs/Glossary/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

```ts 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](https://developer.mozilla.org/en-US/docs/Glossary/String)|A UUID string identifying this self notification. | #### Returns | Return type | Status code | Description | |---|---|---| |[EventNotification](#eventnotification)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts 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](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of results to return per page. | |config.notificationType|[string](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The initial index from which to return the results. | |config.ordering|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Which field to use when ordering the results. | |config.owner|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |config.resourceId|[string](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/String)|A search term. | #### Returns | Return type | Status code | Description | |---|---|---| |[PaginatedEventNotificationList](#paginatedeventnotificationlist)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts 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](https://developer.mozilla.org/en-US/docs/Glossary/String)|A UUID string identifying this self notification. | #### Returns | Return type | Status code | Description | |---|---|---| |[EventNotification](#eventnotification)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts 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

Code example

```ts import { eventNotificationsClient } from "@dynatrace-sdk/client-notification-v2"; const data = await eventNotificationsClient.updateEventNotification({ id: "...", body: { triggerConfiguration: { type: "event", value: { query: "..." }, }, }, }); ```

## resourceNotificationsClient ```js 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](#resourcenotification)|201|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts 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

Code example

```ts 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

Code example

```ts 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

Code example

```ts 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](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of results to return per page. | |config.notificationType|[string](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The initial index from which to return the results. | |config.ordering|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Which field to use when ordering the results. | |config.resourceId|[string](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/String)|A search term. | #### Returns | Return type | Status code | Description | |---|---|---| |[PaginatedResourceNotificationList](#paginatedresourcenotificationlist)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { resourceNotificationsClient } from "@dynatrace-sdk/client-notification-v2"; const data = await resourceNotificationsClient.getResourceNotifications(); ```

## Types ### DavisEventConfig | Name | Type | Description | | --- | --- | --- | |customFilter|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/String)>| | ### DavisEventName | Name | Type | Description | | --- | --- | --- | |match^*required|"equals" | "contains"|Davis event name must equal or contain the string provided. | |name^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | ### DavisEventTriggerConfig | Name | Type | | --- | --- | |type^*required|"davis-event"| |value^*required|DavisEventConfig| ### DavisProblemCategories | Name | Type | Default | | --- | --- | --- | |availability|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| false| |custom|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| false| |error|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| false| |info|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| false| |monitoringUnavailable|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| false| |resource|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| false| |slowdown|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| false| ### DavisProblemConfig | Name | Type | Description | | --- | --- | --- | |analysisReady|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Run only after first root cause analysis run completed. default: false| |categories^*required|DavisProblemCategories| | |customFilter|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Additional DQL matcher expression to further filter events to match. default: ""| |entityTags|null | EntityTags| | |entityTagsMatch|null | "all" | "any"| | |~~onProblemClose~~^{**DEPRECATED**}|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |details|ErrorDetails| |message^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| ### ErrorDetails | Name | Type | | --- | --- | |errorCode|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |errorRef|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| ### ErrorEnvelope | Name | Type | | --- | --- | |error^*required|Error| ### EventNotification | Name | Type | Description | | --- | --- | --- | |appId|[string](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |resourceId^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |triggerConfiguration^*required|EventTriggerConfig| | ### EventNotificationInput | Name | Type | | --- | --- | |content|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |subject|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| ### EventNotificationRequest | Name | Type | Description | | --- | --- | --- | |appId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|App id for registered notification. Optional, by default automatically inferred from the request. Only relevant for manual testing purposes via swagger. | |id|[string](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |triggerConfiguration^*required|EventTriggerConfig| | ### EventNotificationUpdate | Name | Type | Description | | --- | --- | --- | |appId|[string](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |triggerConfiguration|EventTriggerConfig| | ### EventQuery | Name | Type | Description | | --- | --- | --- | |eventType|"events" | "bizevents" | "dt.system.events" | "security.events"|Grail event type. | |query^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/String)| |createdTime^*required|Date| |lastModifiedBy^*required|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |lastModifiedTime^*required|Date| ### PaginatedEventNotificationList | Name | Type | | --- | --- | |count^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |results^*required|Array<EventNotification>| ### PaginatedResourceNotificationList | Name | Type | | --- | --- | |count^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |results^*required|Array<ResourceNotification>| ### ResourceNotification | Name | Type | Description | | --- | --- | --- | |appId|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |modificationInfo^*required|ModificationInfo| | |notificationType^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |resourceId^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/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](https://developer.mozilla.org/en-US/docs/Glossary/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~~ > ⚠️ **Deprecated** > Use literal values.

Davis event name must equal or contain the string provided. #### Enum keys

`Contains` | `Equals`

### ~~DavisEventTriggerConfigType~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`DavisEvent`

### ~~DavisProblemConfigProblemOpenDuration~~ > ⚠️ **Deprecated** > Use literal values.

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~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`DavisProblem`

### ~~EntityTagsMatch~~ > ⚠️ **Deprecated** > Use literal values.

Event must match all or any of the entity tags. #### Enum keys

`All` | `Any`

### ~~EventQueryTriggerConfigType~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`Event`

### ~~EventType~~ > ⚠️ **Deprecated** > Use literal values.

Grail event type. #### Enum keys

`Bizevents` | `DtSystemEvents` | `Events` | `SecurityEvents`

### ~~MaintenanceWindowTriggerBehaviorType~~ > ⚠️ **Deprecated** > Use literal values.

Specifies when to trigger based on maintenance window status. #### Enum keys

`Always` | `Inside` | `Outside`

### ~~TriggerOn~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`Close` | `Open` | `OpenAndClose`

### ~~TriggerOnUpdateFields~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys