Send a notification to one or more targets

POST 
https://demo.openremote.io/api/master/notification/alert

Send a notification to one or more targets

Request

Header Parameters

Authorization string
X-Forwarded-Proto string
X-Forwarded-Host string

application/json

Body

namestring

message

object

typestring

targets

object[]

Array [

typestring

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

idstring

localestring

allowedLocalesstring[]

dataobject

]

repeatFrequencystring

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

repeatIntervalstring

Responses

default

default response

*/*

Schema

Schema

any

Authorization: oauth2

name: openidtype: oauth2flows: {
  "clientCredentials": {
    "tokenUrl": "/auth/realms/master/protocol/openid-connect/token",
    "refreshUrl": "/auth/realms/master/protocol/openid-connect/token",
    "scopes": {
      "profile": "profile"
    }
  },
  "authorizationCode": {
    "authorizationUrl": "/auth/realms/master/protocol/openid-connect/auth",
    "tokenUrl": "/auth/realms/master/protocol/openid-connect/token",
    "refreshUrl": "/auth/realms/master/protocol/openid-connect/token",
    "scopes": {
      "profile": "profile"
    }
  }
}

• curl
• nodejs
• java
• python
• ruby
• csharp
• go
• php
• powershell

• CURL

curl -L 'https://demo.openremote.io/api/master/notification/alert' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
  "name": "string",
  "message": {
    "type": "string"
  },
  "targets": [
    {
      "type": "REALM",
      "id": "string",
      "locale": "string",
      "allowedLocales": [
        "string"
      ],
      "data": {}
    }
  ],
  "repeatFrequency": "ALWAYS",
  "repeatInterval": "string"
}'

Request Collapse all

Base URL

https://demo.openremote.io/api/master

Auth

Bearer Token

Parameters

Authorization — header

X-Forwarded-Proto — header

X-Forwarded-Host — header

Body

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

ResponseClear

Click the Send API Request button above and see the response here!