@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

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

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

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

deleteEventNotification

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

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

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

getEventNotification

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

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

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

getEventNotifications

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

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

const data =
  await eventNotificationsClient.getEventNotifications();

patchEventNotification

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

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

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

updateEventNotification

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

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

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

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

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

deleteResourceNotification

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

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

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

deleteResourceNotificationByTypeAndResource

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

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

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

getResourceNotification

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

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

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

getResourceNotifications

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

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

const data =
  await resourceNotificationsClient.getResourceNotifications();

Types

DavisEventConfig

| Name | Type | Description | | --- | --- | --- | |customFilter|string|Additional DQL matcher expression to further filter events to match. | |entityTags|EntityTags|Entity tags to match by key and (optional) values. For example {"foo": [], "bar": ["a", "b", "c"]} | |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|Entity tags to match by key and (optional) values. For example {"foo": [], "bar": ["a", "b", "c"]} | |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, string | string[] | undefined>

Error

| Name | Type | Description | | --- | --- | --- | |code*required|number| | |details|ErrorDetails|Error response details according to API Guidelines | |message*required|string| |

ErrorDetails

Error response details according to API Guidelines

| 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|string| |subject|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*required|EventTriggerConfig| |

EventQuery

| Name | Type | Description | | --- | --- | --- | |eventType|"events" | "bizevents" | "dt.system.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. | |id|string| | |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. |

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