Skip to content

Commit

Permalink
MCS-4334: change log, tutorial for webhook. (#118)
Browse files Browse the repository at this point in the history
  • Loading branch information
dariachen authored Aug 22, 2018
1 parent 3f0cd2d commit 8737f1a
Show file tree
Hide file tree
Showing 15 changed files with 44 additions and 6 deletions.
1 change: 1 addition & 0 deletions content/en/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,5 +67,6 @@
* [2.22](change_log/2.22.md)
* [2.23](change_log/2.23.md)
* [2.25](change_log/2.25.md)
* [2.26](change_log/2.26.md)


4 changes: 4 additions & 0 deletions content/en/change_log/2.26.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# 2018/08/23

## New Features
1. Users are allowed to compose a customized HTTP request in Trigger & Action. This request will be sent out to the specified server when the trigger criteria are met. [more information](../tutorial/setting_notification)
6 changes: 6 additions & 0 deletions content/en/change_log/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# MCS Change log Summary

## 2018/08/23

### v2.26

[Users are allowed to compose a customized HTTP request in Trigger & Action.](./2.26)


## 2018/07/25

Expand Down
Binary file modified content/en/images/Trigger/img_trigger_08.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 4 additions & 2 deletions content/en/tutorial/setting_notification.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,13 @@ In the **Trigger & Action** tab in the test device page, expand the **Manage you

### Configuring the Webhook

There is no extra setting for webhook. To use webhook trigger, you only have to select the **webhook** as the action in the trigger & action setting and provide the callback URL that MCS makes an HTTP request to.
The webhook action allows you to compose a custom HTTP request to send to a server.

To use webhook trigger, you only need select the **webhook** as the action type in the trigger & action setting and then specify the server **URL**, **request method**, **HTTP headers** and **HTTP body**. You can use the pre-defined variables in URL, value of HTTP header and Body fields.

![](../images/Trigger/img_trigger_08.png)

There is a Test button for you to test if the trigger has been sent to the URL. The device name, deviceId and the triggered value will be sent to the triggered URL.
There is a Send webhook button for you to test if this HTTP request is able to sent to the destination along with the correct settings.


### Configuring the Console Alert
Expand Down
1 change: 1 addition & 0 deletions content/zh-CN/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,5 @@
* [2.22](change_log/2.22.md)
* [2.23](change_log/2.23.md)
* [2.25](change_log/2.25.md)
* [2.26](change_log/2.26.md)

4 changes: 4 additions & 0 deletions content/zh-CN/change_log/2.26.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# 2018/08/23

## 新功能
1. 允许用户在 Trigger&Action 中编写自定义的 HTTP 请求。当触发条件符合时,此请求将发送到指定的服务器。[更多详情](../tutorial/setting_notification)
6 changes: 6 additions & 0 deletions content/zh-CN/change_log/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# MCS 更新日志总览

## 2018/08/23

### v2.26

[允许用户在 Trigger&Action 中编写自定义的 HTTP 请求。](./2.26)

## 2018/07/25

### v2.25
Expand Down
Binary file modified content/zh-CN/images/Trigger/img_trigger_08.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 4 additions & 2 deletions content/zh-CN/tutorial/setting_notification.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,13 @@

### 设置 Webhook

要使用 webhook 触发动作,您只需要在设定触发条件时,选择 webhook 作为触发动作,并且输入您欲收到此触发通知之网址。当触发条件成立时,MCS 会发送一个 HTTP 请求到您提供的网址。
触发动作中的 webhook,让您可以自行组合一个 HTTP 的请求,并在触发条件成立后发送到指定的服务器。

要使用此功能,您只需要在设定触发条件时,选择**webhook** 作为触发动作,并且指定服务器**网址****请求方法****HTTP 标头****请求内文**。此外,您也可以在网址、标头的值以及请求内文中使用系统预设的变数。(详细用法请参考后面章节)

![](../images/Trigger/img_trigger_08.png)

当您选择 webhook 触发动作后,您可以使用测试按钮,来测试是否通知有被送出。送出之资讯包含 装置名称, device ID 和触发值
当您选择 webhook 触发动作后,您可以使用测试按钮,来测试此 HTTP 请求是否有正确的被送出

### 设定网页警报

Expand Down
1 change: 1 addition & 0 deletions content/zh-TW/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,5 @@
* [2.22](change_log/2.22.md)
* [2.23](change_log/2.23.md)
* [2.25](change_log/2.25.md)
* [2.26](change_log/2.26.md)

4 changes: 4 additions & 0 deletions content/zh-TW/change_log/2.26.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# 2018/08/23

## 新功能
1. 允許用戶在 Trigger&Action 中編寫自定義的 HTTP 請求。當觸發條件符合時,此請求將發送到指定的服務器。[更多詳情](../tutorial/setting_notification)
5 changes: 5 additions & 0 deletions content/zh-TW/change_log/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# MCS 更新日誌總覽

## 2018/08/23

### v2.26

[允許用戶在 Trigger&Action 中編寫自定義的 HTTP 請求。](./2.26)

## 2018/07/25

Expand Down
Binary file modified content/zh-TW/images/Trigger/img_trigger_08.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 4 additions & 2 deletions content/zh-TW/tutorial/setting_notification.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,13 @@

### 設定 Webhook

要使用 webhook 觸發動作,您只需要在設定觸發條件時,選擇 webhook 作為觸發動作,並且輸入您欲收到此觸發通知之網址。當觸發條件成立時,MCS 會發送一個 HTTP 請求到您提供的網址。
觸發動作中的 webhook,讓您可以自行組合一個 HTTP 的請求,並在觸發條件成立後發送到指定的服務器。

要使用此功能,您只需要在設定觸發條件時,選擇 **webhook** 作為觸發動作,並且指定服務器**網址****請求方法****HTTP 標頭****請求內文**。此外,您也可以在網址、標頭的值以及請求內文中使用系統預設的變數。(詳細用法請參考後面章節)

![](../images/Trigger/img_trigger_08.png)

當您選擇 webhook 觸發動作後,您可以使用測試按鈕,來測試是否通知有被送出。送出之資訊包含 裝置名稱, device ID 和觸發值
當您選擇 webhook 觸發動作後,您可以使用測試按鈕,來測試此 HTTP 請求是否有正確的被送出

### 設定網頁警告

Expand Down

0 comments on commit 8737f1a

Please sign in to comment.