@dynatrace-sdk/client-notification

Manage self notifications with the Notification Service API.

Installation

npm install @dynatrace-sdk/client-notification

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.

selfNotificationsClient

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

createSelfNotification

Required scope: notification:self-notifications:write

Parameters

| Name | Type | | --- | --- | |config.body*required|SelfNotificationRequest|

Returns

| Return type | Status code | Description | |---|---|---| |SelfNotification|201||

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError||

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

const data =
  await selfNotificationsClient.createSelfNotification({
    body: {
      resourceId: "...",
      notificationType: "...",
      triggerConfiguration: {
        type: EventQueryTriggerConfigType.Event,
        value: { query: "..." },
      },
    },
  });

deleteSelfNotification

Required scope: notification:self-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||

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

const data =
  await selfNotificationsClient.deleteSelfNotification({
    id: "...",
  });

getSelfNotification

Required scope: notification:self-notifications:read

Parameters

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

Returns

| Return type | Status code | Description | |---|---|---| |SelfNotification|200||

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError||

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

const data =
  await selfNotificationsClient.getSelfNotification({
    id: "...",
  });

getSelfNotifications

Required scope: notification:self-notifications:read

Parameters

| Name | Type | Description | | --- | --- | --- | |config.appId|string| | |config.limit|number|Number of results to return per page. | |config.notificationType|string| | |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| | |config.search|string|A search term. |

Returns

| Return type | Status code | Description | |---|---|---| |PaginatedSelfNotificationList|200||

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError||

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

const data =
  await selfNotificationsClient.getSelfNotifications();

patchSelfNotification

Required scope: notification:self-notifications:write

Parameters

| Name | Type | Description | | --- | --- | --- | |config.body*required|PatchedSelfNotificationRequest| | |config.id*required|string|A UUID string identifying this self notification. |

Returns

| Return type | Status code | Description | |---|---|---| |SelfNotification|200||

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError||

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

const data =
  await selfNotificationsClient.patchSelfNotification({
    id: "...",
    body: {
      triggerConfiguration: {
        type: EventQueryTriggerConfigType.Event,
        value: { query: "..." },
      },
    },
  });

updateSelfNotification

Required scope: notification:self-notifications:write

Parameters

| Name | Type | Description | | --- | --- | --- | |config.body*required|SelfNotificationRequest| | |config.id*required|string|A UUID string identifying this self notification. |

Returns

| Return type | Status code | Description | |---|---|---| |SelfNotification|200||

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError||

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

const data =
  await selfNotificationsClient.updateSelfNotification({
    id: "...",
    body: {
      resourceId: "...",
      notificationType: "...",
      triggerConfiguration: {
        type: EventQueryTriggerConfigType.Event,
        value: { query: "..." },
      },
    },
  });

Types

DavisEventConfig

| Name | Type | Description | | --- | --- | --- | |customFilter|string|Additional DQL matcher expression to further filter events to match. | |entityTags|EntityTags| default: {}| |entityTagsMatch|"all" | "any"|Event must match all or any of the entity tags. | |names|Array<DavisEventName>| | |onProblemClose|boolean|Trigger on Davis event open only or also on close. default: false| |~~types~~DEPRECATED|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 | | --- | --- | |availability|boolean| |custom|boolean| |error|boolean| |info|boolean| |monitoringUnavailable|boolean| |resource|boolean| |slowdown|boolean|

DavisProblemConfig

| Name | Type | Description | | --- | --- | --- | |categories*required|DavisProblemCategories| | |customFilter|string|Additional DQL matcher expression to further filter events to match. | |entityTags|EntityTags| default: {}| |entityTagsMatch|"all" | "any"|Event must match all or any of the entity tags. | |onProblemClose|boolean|Trigger on Davis problem open only or also on close. default: false|

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, MaybeStringArray | undefined>

Error

| Name | Type | | --- | --- | |details|ErrorDetails| |message*required|string|

ErrorDetails

type: Record<string, any>

ErrorEnvelope

| Name | Type | | --- | --- | |error*required|Error|

EventQuery

| Name | Type | Description | | --- | --- | --- | |eventType|"events" | "bizevents" | "dt.system.events"| default: "events"| |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|string| |createdTime*required|Date| |lastModifiedBy*required|string| |lastModifiedTime*required|Date|

PaginatedSelfNotificationList

| Name | Type | | --- | --- | |count*required|number| |results*required|Array<SelfNotification>|

PatchedSelfNotificationRequest

| 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|SendDefaultNotificationInput|SendDefaultNotificationInput 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| |

SelfNotification

| 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|SendDefaultNotificationInput|SendDefaultNotificationInput 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| |

SelfNotificationRequest

| 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|SendDefaultNotificationInput|SendDefaultNotificationInput 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| |

SendDefaultNotificationInput

| Name | Type | | --- | --- | |content*required|string| |subject*required|string|

Enums

DavisEventNameMatch

Davis event name must equal or contain the string provided.

Enum keys

Contains | Equals

DavisEventTriggerConfigType

Enum keys

DavisEvent

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