SAIBARU

webhook設定

概要

webhook

　webhook機能を使って他のサービスと連携することができます。

　webhook用のURL（送信先endpoint）を登録すると、データ受信時、もしくはアラート発生時に登録したURL先へデータを通知します。

　下記のイベント発生時にwebhookが実行されます。

  • データ受信時(モジュールからデータをサーバーが受信した時)
  • アラート発生時(受信したデータがアラート設定の上限値及び下限値を超過した時)

　※登録URLは最大で2URLまでです。

送信データ

温湿度ロガー（ST001）のデータ受信時及びアラート発生時の送信データ例になります。

parameterは各モジュールによって異なります。各モジュールのparameterはこちらに詳しく載せています。

METHOD POST
データ形式 JSON
データ受信時　送信データ 
{
	"uuid":"5ST0010000000002",
	"event":"data",
	"module":"ST001",
	"memo":"メモ",
	"gettime":"2019-06-12T10:01:06",
	"parameters":[
		{
			"parameter":"temperature",
			"parameter_name":"気温",
			"unit":"°C",
			"value":25.435
		},
		{
			"parameter":"humidity",
			"parameter_name":"湿度",
			"unit":"%",
			"value":58.2236
		},
		{
			"parameter":"battery",
			"parameter_name":"電池",
			"unit":"v",
			"value":4.2324
		}
	]
}
アラート発生時　送信データ 
{
	"uuid":"5ST0010000000002",
	"event":"alert",
	"module":"ST001",
	"memo":"メモ",
	"gettime":"2019-06-12T10:01:06",
	"parameters":[
		{
			"parameter":"humidity",
			"parameter_name":"湿度",
			"unit":"%",
			"value":58.2236,
			"limitstatus":"上限",
			"limitvalue":"50"
		},
		{
			"parameter":"battery",
			"parameter_name":"電池",
			"unit":"v",
			"value":3.254,
			"limitstatus":"下限",
			"limitvalue":"3.3"
		}
	]
}