Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 0 additions & 4 deletions cdk/lambda/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -421,8 +421,6 @@ exports.handler = async (event) => {
"/docs/tagoio/getting-started/how-it-works",
"/portal/en/kb/articles/7-beagle-bone-black":
"/docs/tagoio/tutorials/beagle-bone-black",
"/portal/en/kb/articles/75-thinxtra-xkit-for-sigfox":
"/docs/tagoio/tutorials/thinxtra-xkit-for-sigfox",
"/portal/en/kb/articles/8-raspberry-pi":
"/docs/tagoio/tutorials/raspberry-pi",
"/portal/en/kb/articles/83-connecting-zen15-power-using-smartthings-hub":
Expand Down Expand Up @@ -526,8 +524,6 @@ exports.handler = async (event) => {
"/portal/en/kb/articles/tagoio-mqtt-relay":
"/docs/tagoio/integrations/networks/mqtt/connecting-your-mqtt-broker-to-tagoio",
"/portal/en/kb/articles/tags": "/docs/tagoio/getting-started/tags-system",
"/portal/en/kb/articles/ticket-severity-options":
"/docs/tagoio/support/ticket-severity-options",
"/portal/en/kb/articles/trigger-by-geofence":
"/docs/tagoio/actions/trigger-by-geofence",
"/portal/en/kb/articles/trigger-by-usage-alert":
Expand Down
2 changes: 1 addition & 1 deletion docs/api/login-as-user.api.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: login-as-user
title: "Get User Token"
description: "Get TagoRUN User Token and allow to perform request to TagoRUN specific endpoints (not available)."
description: "Get TagoRUN User Token and allow performing requests to TagoRUN specific endpoints (not available)."
sidebar_label: "Get User Token"
hide_title: true
hide_table_of_contents: true
Expand Down
8 changes: 4 additions & 4 deletions docs/api/tagoio-api.info.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ The documentation is split by which token you're required to use in the request.
TagoIO provides 4 different tokens:
- **Device-Token**: The token from your device, which you can get from the device's page.

- **Profile-Token**: Also know as Account-Token. You get from your profile settings page.
- **Profile-Token**: Also known as Account-Token. You can retreive this from your profile settings page.

- **Network-Token**: Is the token from your Network. Only available if you're owner of the network in your integrations page.
- **Network-Token**: This is the token from your Network. Only available if you're the owner of the network in your integrations page.

- **Analysis-Token:** The token from your analysis, available in the analysis page.
- **Analysis-Token:** The token from your analysis, available on the analysis page.
---
#### Setting the API Endpoint Region
When making a request to the TagoIO API, you must also specify the appropriate regional endpoint. Choose one of the following endpoints based on your geographical region:
Expand All @@ -52,7 +52,7 @@ When making a request to the TagoIO API, you must also specify the appropriate r
**URL:** `https://api.eu-w1.tago.io/`

- **Tago Deploy:**
You should use your own API URL that is available in your Domains section of the TagoDeploy.
You should use your own API URL that is available in the Domains section of TagoDeploy.

<div
style={{"marginBottom":"2rem"}}
Expand Down
2 changes: 1 addition & 1 deletion docs/tagoio/actions/action-cron.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Inside TagoIO, cron is used to define when a Schedule Action will be triggered.

To modify the cron of the Action, select the Advanced property in the top-right of the Recurrence options panel.

![Recurrence options screenshot with cron fields and visual explanation](/docs_imagem/tagoio/action-cron-2.png)
![Recurrence options screenshot with cron fields and visual explanation](/docs_imagem/tagoio/rounded-image-1769103294865.png)

## Cron example and visual preview

Expand Down
34 changes: 22 additions & 12 deletions docs/tagoio/actions/defining-actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ section at the end of this page.
Please note that the notification is only sent to the account where it was
created.

![Push notification action configuration](/docs_imagem/tagoio/defining-actions-2.png)
![Push notification action configuration](/docs_imagem/tagoio/rounded-image-1761748581641.png)

## Push Notifications to Run Users

Expand All @@ -34,7 +34,7 @@ In the message field, you can use variables to dynamically include information
in your text. For more details on how to use message variables, refer to the
"Message Variables" section at the end of this page.

![Image 2](/docs_imagem/tagoio/1576606566858-r_Q.png)
![Image 2](/docs_imagem/tagoio/rounded-image-1761748615221.png)

## Send Email

Expand All @@ -46,11 +46,13 @@ In the message field, you can use variables to dynamically include information
in your text. For more details on how to use message variables, refer to the
"Message Variables" section at the end of this page.

![Image 3](/docs_imagem/tagoio/1576606418570-3DI.png)
![Image 3](/docs_imagem/tagoio/rounded-image-1761748510973.png)

**Attention:** starting **January 1st, 2025**, TagoIO will discontinue its email
:::warning
Starting **January 1st, 2025**, TagoIO will discontinue its email
services. We recommend integrating with external providers to send emails using
the "Send Email using SMTP/SendGrid" action.
:::

## Send Email using SMTP

Expand All @@ -68,6 +70,8 @@ In the message field, you can use variables to dynamically include information
in your text. For more details on how to use message variables, refer to the
"Message Variables" section at the end of this page.

![Send Email using SMTP action configuration](/docs_imagem/tagoio/rounded-image-1761748797456.png)

## Send Email with SendGrid

An email will be sent via SendGrid when a specific condition is met. To
Expand All @@ -78,7 +82,7 @@ Secrets beforehand so it appears in the dropdown menu.
Learn here how to create this secret:
[Secrets](/docs/tagoio/getting-started/secrets.md).

![Image 5](/docs_imagem/tagoio/external-da256072.png)
![Image 5](/docs_imagem/tagoio/rounded-image-1767014262674.png)

## Send Message to AWS SQS

Expand All @@ -89,6 +93,8 @@ access key id and secret access key.
Learn how to create this secret:
[Secrets](/docs/tagoio/getting-started/secrets.md).

![Send Message to AWS SQS action configuration](/docs_imagem/tagoio/rounded-image-1761749001761.png)

## Send SMS

Sends SMS messages when certain conditions are met. You can specify one or
Expand All @@ -100,7 +106,7 @@ In the message field, you can use variables to dynamically include information
in your text. For more details on how to use message variables, refer to the
"Message Variables" section at the end of this page.

![Image 7](/docs_imagem/tagoio/1576605304356-hps.png)
![Image 7](/docs_imagem/tagoio/rounded-image-1761749278409.png)

Some costs may occur when using the SMS service, which varies based on the
country of operation. Check the [pricing](https://tago.io/pricing/),
Expand All @@ -123,7 +129,7 @@ beforehand for them to appear in the dropdown menu. Use a Secret of type
**Text**. Learn how to create this secret:
[Secrets](/docs/tagoio/getting-started/secrets.md).

![Image 9](/docs_imagem/tagoio/external-ef92af1a.png)
![Image 9](/docs_imagem/tagoio/rounded-image-1761749322927.png)

If you're using Twilio Long Code for messaging, be aware that it requires a
Toll‑Free verification process. Please consult Twilio's documentation for
Expand All @@ -150,7 +156,7 @@ beforehand for them to appear in the dropdown menu. Use a Secret of type
**Text**. Learn how to create this secret:
[Secrets](/docs/tagoio/getting-started/secrets.md).

![Image 12](/docs_imagem/tagoio/external-01a6551b.png)
![Image 12](/docs_imagem/tagoio/rounded-image-1767014361018.png)

You can send WhatsApp messages directly from scripts within the
[Analysis](/docs/tagoio/analysis/creating-analysis.md) using the Twilio service.
Expand All @@ -174,6 +180,8 @@ define exactly when your code will run.
Learn more about
[Running Analysis via Action](/docs/tagoio/actions/running-analysis-via-action.md).

![Run Analysis Script action configuration](/docs_imagem/tagoio/rounded-image-1767014455919.png)

## Publish to TagoIO MQTT Broker

This action can publish to an MQTT topic defined by the developer. This means
Expand All @@ -185,7 +193,7 @@ To set the MQTT action up, select the option **Publish to MQTT**, select the
device which will receive that topic and type in the topic. The content of the
MQTT payload that subscribed devices will receive can be defined as well.

![Image 13](/docs_imagem/tagoio/1576605830665-DPI.png)
![Image 13](/docs_imagem/tagoio/rounded-image-1767014507673.png)

TagoIO [MQTT Broker](/docs/tagoio/integrations/networks/mqtt/mqtt.md) is available
exclusively for **Starter** and **Scale** accounts in the **US database
Expand All @@ -201,13 +209,13 @@ action is triggered, it will POST the entire data payload received from the
device to the configured HTTP endpoint address using the
[TagoIO Standard Data Format](/docs/tagoio/devices/sending-data-to-device.md).

![Image 15](/docs_imagem/tagoio/1628001560181-oQ.png)
![Image 15](/docs_imagem/tagoio/rounded-image-1767014557842.png)

> You can use payload fields in the HTTP endpoint, like the example above but
> with a variable (`https://myapi.io/endpoint/$VALUE$`), or even in the HTTP
> Headers like in the example below:

![Image 16](/docs_imagem/tagoio/1628001652255-dcw.png)
![Image 16](/docs_imagem/tagoio/rounded-image-1767014631018.png)

The `TagoIO-Retries` header is managed by the TagoIO API and sent in every Post
request for this Action type, and indicates the number of attempts to post the
Expand All @@ -223,7 +231,7 @@ fails to receive it.
To set up a fallback device, enable it in the bottom part of the HTTP Post
action settings and put the token for the device you intend to hold the data.

![Image 17](/docs_imagem/tagoio/1628001764337-3t4.png)
![Image 17](/docs_imagem/tagoio/rounded-image-1767014751312.png)

After 10 unsuccessful attempts, the data will be sent to the fallback device
with some information added to the `metadata` in the `_http_*` properties
Expand Down Expand Up @@ -254,6 +262,8 @@ with some information added to the `metadata` in the `_http_*` properties
This option is only available if your Action is of the type **MQTT Topic**. This
action will insert the data directly into the device's data storage.

![Insert to Device's data storage action configuration](/docs_imagem/tagoio/rounded-image-1767014904194.png)

## Message Variables

In some action types, the message body can be as simple as a text like _Hi, your
Expand Down
10 changes: 8 additions & 2 deletions docs/tagoio/actions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ Learn about [Defining Actions](/docs/tagoio/actions/defining-actions.md).

To create a new Action, click the "Action" button in the sidebar, then click the + button in the top right.

![Actions screen showing the Add Action button and Actions list](/docs_imagem/tagoio/actions-2.png)
![Actions screen showing the Add Action button and Actions list](/docs_imagem/tagoio/rounded-image-1769103195000.png)

### Type of trigger

There are 5 types of triggers you can use:
There are 6 types of triggers you can use:

* **Variable** – The action will be triggered when one variable meets certain conditions. If your device has sent data and the variables are meeting those conditions, this action will be triggered. Learn more about [Trigger by Variable](/docs/tagoio/actions/trigger-by-variable.md).

Expand All @@ -35,5 +35,11 @@ There are 5 types of triggers you can use:

* **Geofence** – This action will be triggered whenever a variable containing location data meets specific geofence conditions—either inside or outside a predefined area. Learn more about [Trigger by Geofence](/docs/tagoio/actions/trigger-by-geofence.md).

* **MQTT Topic** – This action will be triggered when a message is received on an MQTT topic. Learn more about [Trigger by MQTT Topic](/docs/tagoio/actions/trigger-by-mqtt-topic.md).

:::warning
Note that the **TagoIO MQTT Broker** is available exclusively for Starter and Scale accounts in the US database region. Free accounts and accounts hosted in the European database region may use third-party MQTT services with TagoIO via the [MQTT Relay](/docs/tagoio/integrations/networks/mqtt/connecting-your-mqtt-broker-to-tagoio.md) feature.
:::

To prevent your action from continuously activating when a trigger condition is met, it is advisable to define a reset trigger condition. Ensure you check the “[Trigger Unlock]” option to avoid potential issues with your logic and account:
[Trigger Unlock](/docs/tagoio/actions/trigger-unlock.md).
4 changes: 2 additions & 2 deletions docs/tagoio/actions/running-analysis-via-action.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ To run an Analysis from an Action:
2. Set the field "Type of action" to "Run Analysis".
3. Select one or more Analyses to run.

![Action Run Analysis UI](/docs_imagem/tagoio/running-analysis-via-action-2.png)
![Action Run Analysis UI](/docs_imagem/tagoio/rounded-image-1767033430352.png)

Notes about the UI shown above:
- The "Type of action" field should be set to "Run Analysis".
- Use the "Run one or more analyses" area to add the Analyses you want to execute (e.g., Analysis 1, Analysis 2).
- Use the plus (+) and minus (−) controls to add or remove Analyses from the Action's list.
- Use the plus and trash can icons to add or remove Analyses from the Action's list.
- You can specify up to **10 Analyses** that will run in parallel when the Action is triggered.

## Action Context Variables
Expand Down
4 changes: 2 additions & 2 deletions docs/tagoio/actions/trigger-by-geofence.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ The “Trigger by Geofence” feature allows you to execute an [Action](/docs/
## Setting the Trigger Conditions

To set up this trigger, you need to draw geofences on the map. Geofences can be either polygons or circles, and you must select a variable that contains the location data.
For each condition you can only set one geofence, so if you need multiple geofences you will have to create additional conditions—up to 10 in total.
For each condition, you can only set one geofence, so if you need multiple geofences, you will have to create additional conditions—up to 10 in total.

You must define whether the trigger should activate when the chosen variable is **inside** or **outside** the geofence. When the selected variable receives new location data, the system checks if this location meets the specified geofence condition.

![Image 2](/docs_imagem/tagoio/external-bef9d9d6.png)
![Image 2](/docs_imagem/tagoio/external-notanymore.gif)

### Editing Geofence

Expand Down
18 changes: 11 additions & 7 deletions docs/tagoio/actions/trigger-by-mqtt-topic.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ messages are published to the topics they are subscribed to. To learn more about
the MQTT infrastructure used by TagoIO, see
[MQTT](/docs/tagoio/integrations/networks/mqtt/mqtt.md).

:::info
:::warning

The TagoIO MQTT Broker is available exclusively for Starter and Scale accounts
in the US database region. Free accounts and accounts hosted in the European
Expand All @@ -31,22 +31,22 @@ There are 2 categories for this trigger type:
that device will be tested against your topics to determine whether this
action should be triggered.

![Single-device selection UI](/docs_imagem/tagoio/trigger-by-mqtt-topic-2.png)
![Single-device selection UI](/docs_imagem/tagoio/rounded-image-1767016336359.png)

2. **Multiple devices**\
Allows you to watch multiple devices. Any data sent by those devices will be
tested against your topics to determine whether the action should be
triggered. For this type, you must supply the tag keys and tag values of the
devices you want to watch.

![Multiple-devices tag selection UI](/docs_imagem/tagoio/trigger-by-mqtt-topic-2.png)
![Multiple-devices tag selection UI](/docs_imagem/tagoio/rounded-image-1767016364577.png)

## Trigger Conditions

After setting up the device, you should set a condition for your action to be
executed. To do so, you must head over to the **Trigger** section.

![Image 4](/docs_imagem/tagoio/1588075755429-J4Y.png)
![Image 4](/docs_imagem/tagoio/rounded-image-1767016482525.png)

For each row, you need to set the topic that will be listened to. You may use
MQTT [wildcards](/docs/tagoio/integrations/networks/mqtt/mqtt.md) for the topic if
Expand All @@ -56,9 +56,13 @@ You can set multiple conditions in an action; if at least one of them results in
a match, the action will be executed.

:::info
When you set up multiple conditions, the action will execute only once per MQTT
message, even if that message matches multiple conditions. For example, if you
have two conditions:

Note that setting up multiple conditions will execute the action only once if
any of the conditions are matched. This means that if you send two variables
that would trigger the action at the same time, it will only trigger one action.
- Condition 1: Topic `sensors/+/temperature`
- Condition 2: Topic `sensors/+/+`

And you receive a message on topic `sensors/device1/temperature`, it matches
both conditions, but the action will trigger only once for that single message.
:::
4 changes: 2 additions & 2 deletions docs/tagoio/actions/trigger-by-resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ After setting up the device, you should set a condition that causes your Action

:::tip

You can set multiple conditions in an Action. If at least one condition matches, the Action will be executed.
You can set multiple conditions for different resource types in a single Action. If at least one condition matches, the Action will be executed.

:::

![Trigger panel — "If one of the conditions match, the action will be triggered."](/docs_imagem/tagoio/trigger-by-resource-2.png)
![Trigger panel — "If one of the conditions match, the action will be triggered."](/docs_imagem/tagoio/rounded-image-1767016776767.png)

1. **Resource** – Select a resource to be tested.
2. **Tag key** – The tag key of the resource to be tested.
Expand Down
4 changes: 2 additions & 2 deletions docs/tagoio/actions/trigger-by-schedule.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ There are two categories within this trigger type:
1. By Interval
Allows you to specify a time interval to trigger the Action automatically. Choose the time interval on the right side of the interface; the minimum allowed time is 1 minute.

![By Interval selector showing an interval selection (e.g., 15 Minutes)](/docs_imagem/tagoio/trigger-by-schedule-2.png)
![By Interval selector showing an interval selection (e.g., 15 Minutes)](/docs_imagem/tagoio/rounded-image-1767018081996.png)

2. By Date
Allows you to specify a date or a recurring date rule to trigger the Action. For example, you can choose to run an Action on the second Wednesday of each month.

![By Date selector showing date-based scheduling options](/docs_imagem/tagoio/trigger-by-schedule-2.png)
![By Date selector showing date-based scheduling options](/docs_imagem/tagoio/rounded-image-1767018166748.png)

## Customizing By Date

Expand Down
Loading
Loading