Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Actions

Registers a new alert action with the account. These alert actions can be used as responses to alerts generated by alert action rules.

post/alertActions

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "id": "f3436b61-94fd-41b6-8f0a-ee6ff55acaa6",
  "createTimestamp": "2021-04-22T00:00:00.000+00:00",
  "type": "notification",
  "enabled": true,
  "name": "Notify all technical support staff.",
  "notes": "Notify everyone with the technical support role. Useful in cases where a device goes offline.",
  "settings": {
    "users": [
      {
        "id": "ca0de584",
        "push": true,
        "email": true
      }
    ],
    "rearmSeconds": 900,
    "maxPerHour": 10
  }
}

Response

Alert action registered.

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example response

{
  "id": "f3436b61-94fd-41b6-8f0a-ee6ff55acaa6",
  "createTimestamp": "2021-04-22T00:00:00.000+00:00",
  "type": "notification",
  "enabled": true,
  "name": "Notify all technical support staff.",
  "notes": "Notify everyone with the technical support role. Useful in cases where a device goes offline.",
  "settings": {
    "users": [
      {
        "id": "ca0de584",
        "push": true,
        "email": true
      }
    ],
    "rearmSeconds": 900,
    "maxPerHour": 10
  }
}