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

40169ccdec5c

notification-target-controller

Save notification target (saveNotificationTarget)

Creates or updates notification target.

Available configuration types are PLATFORM_USERS and SLACK. For PLATFORM_USERS the usersFilter must be specified. For tenant, there are following users filter types available: USER_LIST, CUSTOMER_USERS, TENANT_ADMINISTRATORS, ALL_USERS, ORIGINATOR_ENTITY_OWNER_USERS, AFFECTED_USER. For sysadmin: TENANT_ADMINISTRATORS, AFFECTED_TENANT_ADMINISTRATORS, SYSTEM_ADMINISTRATORS, ALL_USERS.

Here is an example of tenant-level notification target to send notification to customer's users:

{
  "name": "Users of Customer A",
  "configuration": {
    "type": "PLATFORM_USERS",
    "usersFilter": {
      "type": "CUSTOMER_USERS",
      "customerId": "32499a20-d785-11ed-a06c-21dd57dd88ca"
    },
    "description": "Users of Customer A"
  }
}

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

post/api/notification/target

Request body

createdTimeinteger

Entity creation timestamp in milliseconds since Unix epoch

namestring required

Example request

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

Response

OK

createdTimeinteger

Entity creation timestamp in milliseconds since Unix epoch

namestring required

Example response

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