Action object

Events support a wide variety of types for the action object based on a: email, sms, web-hook, set-variable, slack-webhook, voice, ubifunction, user and incident. This causes the JSON action object to be highly nested and have many variants in order to support all the above types.

In its base form, the action object follows this structure:

{
	  "data": {},
    "name": "", // String
    "type": "Type of action", // Options: ["email", "sms", "web-hook", "set-variable", "slack-webhook", "voice", "ubifunction", "user", "incident"]
    "isGeneric": true, // Options: [true, false]. Defaults to true
    "repeatAction": false, // Options: [true, false]. Defaults to false
    "idGroupAction": "", // String. Recommendation: at least 5 characters
    "back_to_normal": false, // Options: [true, false]. Defaults to false
    "maxRepetitions": "", // String or Integer. Defaults to none
    "repeatInterval": {} // Object containing value and unit for the repeated action
}

Each key represents the following:

Property	Type	Description
data	Object	Object containing data about the action (please see below)
name	String	Name of Action
type	String	Type of action, valid values are: `email`, `sms`, `web-hook`, `set-variable`, `slack-webhook`, `voice`, `ubifunction`, `user` and `incident`
isGeneric	Boolean	True if Action is generic
repeatAction	Boolean	True if Action should be repeated. If repeatAction is False, maxRepetitions and repeatInterval are hidden
maxRepetitions	Number	Number of maximum repetitions of the Action. Required when repeatAction is active
repeatInterval	Object	Object containing value and unit for the repeated action. Required when repeatAction is active. unit: can be `T` (minutes), `H` (hours) or `D` (days). The maximum values per unit are as follows: `{"T": 43200, "H": 168, "D": 90}`
idGroupAction	String	ID of the Group Action
back_to_normal	Boolean	True if action has a "Back to Normal" action configured

`data` Object - Attribute of `actions` Array

The data key within an action object holds an object as well, which has the below structure based on the value of the type key:

📘
Fields marked Bookmarks: Yes in the tables below accept template variables. See Bookmarks for the full reference.

Email

{
  "emails": [], // Array or string separated by ",". Defaults to []
  "message": "", // String
  "subject": "" // String
}

Property	Type	Bookmarks	Description
emails	Array	Yes	Array of email addresses the email should be sent to
message	String	Yes	Content of the email
subject	String	Yes	Subject line of the email

{
  "emails": [
    "[email protected]"
  ],
  "message": "Hey there, {{variable.name}} was {{last_value}} at {{trigger_timestamp|timestampformat('America/Bogota')}}.",
  "subject": "{{variable.name}} alert!"
}

SMS

{
  "message": "", // String
  "numbers": [
    {
      "number": "", // String. Defaults to ""
      "country": {
        "id": "", // String. Defaults to ""
        "label": "", // String. Defaults to ""
        "value": "" // Required field. Country indicative
      }
    }
  ]
}

Property	Type	Bookmarks	Description
message	String	Yes	Content of the SMS
numbers	Array	Yes	Contains objects with information about the phone number. Each object includes `number` and `country` fields

{
  "message": "Hey there, {{variable.name}} was {{last_value}} at {{trigger_timestamp|timestampformat('America/Bogota')}}.",
  "numbers": [
    {
      "number": "+57 3123456789",
      "country": {
        "id": "CO",
        "label": "Colombia",
        "value": "+57"
      }
    }
  ]
}

Webhook

{
  "url": "", // String. URL required field
  "method": "", // Options: ["GET", "HEAD", "POST", "PUT", "PATCH", "DELETE"]
  "headers": {}, // Object for request headers
  "payload": "{}" // String. Decoded payload
}

Property	Type	Bookmarks	Description
url	String	No	URL of the webhook endpoint. Required
method	String	No	HTTP method. Options: `GET`, `HEAD`, `POST`, `PUT`, `PATCH`, `DELETE`
headers	Object	Yes	Request headers object
payload	String	Yes	JSON payload in string format

{
  "url": "http://example.com/?do=foobar",
  "method": "POST",
  "headers": {
    "Content-Type": "application/json"
  },
  "payload": "{ \"name\": \"{{device.name}}\", \"value\": \"{{last_value}}\", \"datetime\": \"{{timestamp|timestampformat('America/Bogota')}}\" }"
}

Set Variable

{
  "value": "", // String or Integer. Defaults to None
  "context": {}, // Object with variable context. Defaults to {}
  "variables": [{}], // Array of objects
  "device_groups": [{}] // Array of objects
}

Property	Type	Bookmarks	Description
value	Number	Yes	Value to send to the Variable
context	Object	Yes	Context of the value to send to the Variable
timestamp	String	Yes	Timestamp in milliseconds of the Variable value to send
variables	Array	No	Contains objects with the `id` and `name` of the Variable
device_groups	Array	No	Contains objects with information about the `id` of the device group, `variable_label`, `isMultipleGlobalEvent`, and `deviceGroup_name`

{
  "value": "100",
  "context": {},
  "variables": [
    {
      "id": "64beb73a404ca2000ddf41d0",
      "name": "Variable 1"
    }
  ]
}

Slack Webhook

{
  "url": "", // String. URL required field
  "message": "", // String
  "icon_url": "", // Optional
  "username": "", // String required
  "icon_emoji": "", // Optional
  "channel_label": "" // String
}

Property	Type	Bookmarks	Description
url	String	No	Slack app webhook URL. Required
message	String	Yes	Content of the Slack message
icon_url	String	Yes	URL of the Slack app icon. Optional
username	String	Yes	Slack username. Required
icon_emoji	String	Yes	Emoji icon for the Slack app. Optional
channel_label	String	No	Channel the message should be sent to

{
  "url": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX",
  "message": "Hey there, {{variable.name}} was {{last_value}} at {{trigger_timestamp|timestampformat('America/Bogota')}}.",
  "icon_url": "",
  "username": "test-ubidots",
  "icon_emoji": "",
  "channel_label": "#example-channel"
}

Voice

{
  "voice": "alice", // String. Defaults to "alice"
  "message": "", // String
  "numbers": [
    {
      "number": "", // String. Defaults to ""
      "country": {
        "id": "", // String. Defaults to ""
        "label": "", // String. Defaults to ""
        "value": "" // Required field. Country indicative
      }
    }
  ],
  "language": "en" // String. Minimum length = 2 and maximum length = 5. Defaults to "en"
}

Property	Type	Bookmarks	Description
voice	String	No	Voice type for the phone call. Defaults to `"alice"`
message	String	Yes	Content of the voice message
numbers	Array	Yes	Contains objects with information about the phone number. Each object includes `number` and `country` fields
language	String	No	2-letter language code for the phone call. Defaults to `"en"`

{
  "voice": "alice",
  "message": "Hey there, {{variable.name}} was {{last_value}} at {{trigger_timestamp|timestampformat('America/Bogota')}}.",
  "numbers": [
    {
      "number": "+57 3123456789",
      "country": {
        "id": "CO",
        "label": "Colombia",
        "value": "+57"
      }
    }
  ],
  "language": "en"
}

UbiFunction

{
  "method": "", // Options: ["get", "post"]
  "headers": {}, // Object for request headers
  "message": "", // String. Required field
  "ubi_function": {
    "id": "", // String
    "url": "" // String. URL required field
  }
}

Property	Type	Bookmarks	Description
method	String	No	HTTP method for the UbiFunction request. Options: `get`, `post`
headers	Object	Yes	Request headers object
message	String	Yes	Payload content sent to the UbiFunction. Required
ubi_function	Object	No	Contains the `id` and `url` of the UbiFunction

{
  "method": "post",
  "headers": {
    "Content-Type": "application/json"
  },
  "message": "{ \"name\": \"{{device.name}}\", \"value\": \"{{last_value}}\", \"datetime\": \"{{timestamp|timestampformat('America/Bogota')}}\" }",
  "ubi_function": {
    "id": "64bec5dc3abcb1000e327b2a",
    "url": "https://parse.ubidots.com/prv/username/test"
  }
}

User

{
  "message": "", // String
  "subject": "", // String
  "userIds": [], // Array containing user ids
  "contactMethods": [] // Options: ["voice", "sms", "email"]. Defaults to []. Choose one or more
}

Property	Type	Bookmarks	Description
message	String	Yes	Content of the notification
subject	String	Yes	Subject line of the notification
userIds	Array	No	Contains all the user IDs to notify. Defaults to `[]`
contactMethods	Array	No	Delivery methods. Options: `"email"`, `"sms"`, `"voice"`. Defaults to `[]`

{
  "message": "Hey there, {{variable.name}} was {{last_value}} at {{trigger_timestamp|timestampformat('America/Bogota')}}.",
  "subject": "{{variable.name}} alert!",
  "userIds": [
    "64d3e8a0433e82000e773bfa"
  ],
  "contactMethods": [
    "voice",
    "sms",
    "email"
  ]
}

Incident

{
  "name": "", // String
  "title": "", // String
  "description": "", // String
  "message": "", // String
  "severity": "", // String. Typical values: "P1", "P2", "P3", "P4"
  "escalationPolicyLabel": "", // String. Label of the escalation policy to trigger
  "autoResolve": false // Boolean. Defaults to false
}

Property	Type	Bookmarks	Description
name	String	Yes	Incident message displayed in the Incidents widget — the primary label users see in the widget list
title	String	Yes	Used in escalation policy notifications (e.g. PagerDuty alert title, email subject). Distinct from `name`
description	String	Yes	Extended description shown in the incident detail view
message	String	Yes	Notification body sent through the escalation policy (e.g. email/SMS body)
severity	String	No	Severity level passed to the escalation policy. Typical values: `P1`, `P2`, `P3`, `P4`
escalationPolicyLabel	String	No	Label of the escalation policy to trigger. If empty or not found, no escalation policy runs
autoResolve	Boolean	No	If `true`, the incident is automatically resolved when the trigger deactivates (requires a paired `back_to_normal` action)

Auto-resolving incidents

To create a self-resolving incident, define two actions sharing the same idGroupAction:

One with back_to_normal: false — fires when the trigger activates
One with back_to_normal: true — fires when the trigger deactivates (returns to normal)

Set autoResolve: true on both to have the system automatically close the incident when the condition clears.

{
  "type": "incident",
  "name": "Create Incident",
  "data": {
    "name": "",
    "title": "{{variable.name}} alert!",
    "message": "Hi there,\n{{variable.name}} was {{'%0.2f'|format(last_value|float)}} at {{trigger_timestamp|timestampformat('America/Bogota')}}.",
    "severity": "P2",
    "autoResolve": true,
    "description": "",
    "escalationPolicyLabel": "escalation-policy-label"
  },
  "back_to_normal": false,
  "idGroupAction": "1EZX9Np"
}

data Object - Attribute of actions Array

Email

SMS

Webhook

Set Variable

Slack Webhook

Voice

UbiFunction

User

Incident

`data` Object - Attribute of `actions` Array