Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

notification-rule-controller

Save notification rule (saveNotificationRule)

Creates or updates notification rule.

Mandatory properties are name, templateId (of a template with notificationType matching to rule's triggerType), triggerType, triggerConfig and recipientConfig. Additionally, you may specify rule description inside of additionalConfig.

Trigger type of the rule cannot be changed. Available trigger types for tenant: ENTITY_ACTION, ALARM, ALARM_COMMENT, ALARM_ASSIGNMENT, DEVICE_ACTIVITY, RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT. For sysadmin, there are following trigger types available: ENTITIES_LIMIT, API_USAGE_LIMIT, NEW_PLATFORM_VERSION.

Here is an example of notification rule to send notification when a device, asset or customer is created or deleted:

{
  "name": "Entity action",
  "templateId": {
    "entityType": "NOTIFICATION_TEMPLATE",
    "id": "32117320-d785-11ed-a06c-21dd57dd88ca"
  },
  "triggerType": "ENTITY_ACTION",
  "triggerConfig": {
    "entityTypes": [
      "CUSTOMER",
      "DEVICE",
      "ASSET"
    ],
    "created": true,
    "updated": false,
    "deleted": true,
    "triggerType": "ENTITY_ACTION"
  },
  "recipientsConfig": {
    "targets": [
      "320f2930-d785-11ed-a06c-21dd57dd88ca"
    ],
    "triggerType": "ENTITY_ACTION"
  },
  "additionalConfig": {
    "description": "Send notification to tenant admins or customer users when a device, asset or customer is created"
  },
  "templateName": "Entity action notification",
  "deliveryMethods": [
    "WEB"
  ]
}

Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority.

post/api/notification/rule

Request body

createdTimeinteger

Entity creation timestamp in milliseconds since Unix epoch

namestring required
enabledboolean
triggerType'ENTITY_ACTION' | 'ALARM' | 'ALARM_COMMENT' | 'ALARM_ASSIGNMENT' | 'DEVICE_ACTIVITY' | 'RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT' | 'EDGE_CONNECTION' | 'EDGE_COMMUNICATION_FAILURE' | 'NEW_PLATFORM_VERSION' | 'ENTITIES_LIMIT' | 'API_USAGE_LIMIT' | 'RATE_LIMITS' | 'TASK_PROCESSING_FAILURE' | 'RESOURCES_SHORTAGE' required

Example request

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "NOTIFICATION_RULE"
  },
  "createdTime": 1746028547220,
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "templateId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "NOTIFICATION_TEMPLATE"
  }
}

Response

OK

createdTimeinteger

Entity creation timestamp in milliseconds since Unix epoch

namestring required
enabledboolean
triggerType'ENTITY_ACTION' | 'ALARM' | 'ALARM_COMMENT' | 'ALARM_ASSIGNMENT' | 'DEVICE_ACTIVITY' | 'RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT' | 'EDGE_CONNECTION' | 'EDGE_COMMUNICATION_FAILURE' | 'NEW_PLATFORM_VERSION' | 'ENTITIES_LIMIT' | 'API_USAGE_LIMIT' | 'RATE_LIMITS' | 'TASK_PROCESSING_FAILURE' | 'RESOURCES_SHORTAGE' required

Example response

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "NOTIFICATION_RULE"
  },
  "createdTime": 1746028547220,
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "templateId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "NOTIFICATION_TEMPLATE"
  }
}