SORACOM Flux のチャネルに Incoming Webhook を作成すると、チャネルにイベントを送信するための専用の URL が発行されます。当 URL にリクエストを送信するとチャネルにデータを送信できます。
API/マニュアル実行イベントソースを利用してチャネルにデータを送信する場合、API キーと API トークンが必要となります。これに対して、Incoming Webhook を作成するとランダムで予測不可能な文字列を含む URL が発行され、API キーと API トークンを付与することなくチャネルにデータを送信できます。外部システムと SORACOM Flux を容易に連携できます。
Incoming Webhook はすべてのチャネルで作成できます。
Incoming Webhook の作成と Webhook URL の確認
Incoming Webhook を作成し、Webhook URL を確認する手順は以下のとおりです。
SORACOM Flux Studio からチャネルをクリックし、チャネルの詳細を開きます。
のからをクリックします。
Incoming Webhook の名前と説明を入力します。
をクリックします。
Webhook の
IDおよびWebhook URLを確認できます。
チャネルにデータを送信する
Incoming Webhook を使用してチャネルにデータを送信するには、Incoming Webhook の URL に HTTP POST のリクエストを実行します。
POST https://api.soracom.io/v1/flux/incoming_webhooks/<webhook id>/<ランダムな文字列>
チャネルに {"temperature": 25} を送信する例:
$ curl -X POST "https://jp-prod-standby.api.soracom.io/v1/flux/incoming_webhooks/01234567890ABCDEF/01VWXYZABCDEFGHIJKLM" \
-H "Content-Type: application/json" \
-d '{"temperature": 25}'
チャネルに送信されるデータ
Incoming Webhook を使用した場合にチャネルに送信されるデータは、MESSAGE と CONTEXT です。
実際に Flux アプリに送信されたデータは、SORACOM Flux Studio の タブで確認できます。詳しくは、実行履歴 (ログ) を参照してください。
MESSAGE
Incoming Webhook で送信されたデータです。
CONTEXT
{
"eventType": "incoming-webhook",
"webhookId": "<Incoming Webhook の Id>"
}
| 項目 | 説明 |
|---|---|
eventType | イベントの種類。Incoming Webhook で送信されたデータが、Flux アプリが起動するトリガーになった場合は、incoming-webhook です。 |
webhookId | 送信された Incoming Webhook の Id |