summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAlbin Suresh <albin.suresh@softwareag.com>2022-02-25 19:42:33 +0530
committerAlbin Suresh <albin.suresh@softwareag.com>2022-03-11 12:40:05 +0530
commitc02fd97270b026536ed4d3e12f793299e9e76b70 (patch)
tree1cf3717254fd2a51f48b0e8c0482179e181eadfd /docs
parent77408c75a7f62a80a9d6a43e9757d9980e845798 (diff)
Rename message field to text in Thin Edge JSON events payload
Diffstat (limited to 'docs')
-rw-r--r--docs/src/tutorials/send-events.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/src/tutorials/send-events.md b/docs/src/tutorials/send-events.md
index db5dde06..b4c1263b 100644
--- a/docs/src/tutorials/send-events.md
+++ b/docs/src/tutorials/send-events.md
@@ -21,7 +21,7 @@ The payload format must be as follows:
```json
{
- "message": "<event message text>",
+ "text": "<event text>",
"time": "<Timestamp in ISO-8601 format>"
}
```
@@ -35,12 +35,12 @@ Payload:
```json
{
- "message": "A user just logged in",
+ "text": "A user just logged in",
"time": "2021-01-01T05:30:45+00:00"
}
```
-> Note: Both the `message` field and the `time` field are optional.
+> Note: Both the `text` field and the `time` field are optional.
When the `message` field is not provided, the `event-type` from the MQTT topic will be used as the message as well if the connected cloud mandates one.
When the `time` field is not provided, thin-edge.io will use the current system time as the `time` of the event.