Notification

Notification submission containing a typed message, one or more targets, and optional repeat scheduling.

message object

Typed notification message; its discriminator selects email, push, or another installed message subtype.

type string

Typed notification message; its discriminator selects email, push, or another installed message subtype.

Possible values: []

namestring

Optional human-readable notification name used in delivery records.

Example: High temperature alert

repeatFrequencystring

Optional repeat cadence for scheduled delivery.

Possible values: [ALWAYS, ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, ANNUALLY]

repeatIntervalstring

Repeat interval expression interpreted with repeatFrequency.

targets object[]

One or more recipients. Authorization is checked for the complete set before anything is queued.

Array [

allowedLocalesstring[]

dataobject

idstring

localestring

typestring

Possible values: [REALM, USER, ASSET, CUSTOM]

]

Notification

{
  "message": {
    "type": "string"
  },
  "name": "High temperature alert",
  "repeatFrequency": "ALWAYS",
  "repeatInterval": "string",
  "targets": [
    {
      "allowedLocales": [
        "string"
      ],
      "data": {},
      "id": "string",
      "locale": "string",
      "type": "REALM"
    }
  ]
}