Soracom

Incoming Webhook は、チャネルにイベントを送信するための専用の Webhook URL を発行する機能です。発行した Webhook URL を利用すると、外部システムと Flux アプリを簡単に接続できます。

API/マニュアル実行イベントソース を利用してチャネルにデータを送信して Flux アプリを起動する場合、API キーと API トークン が必要です。

これに対して、Incoming Webhook を利用すると、API キーと API トークンを発行することなく、チャネルにデータを送信して Flux アプリを起動できます。また、Incoming Webhook は任意のチャネルで発行できるため、イベントソースに連結していない任意のチャネルから Flux アプリを起動できます。

Incoming Webhook を作成する

1. Flux アプリの SORACOM Flux Studio の [Studio] タブを表示します。

   詳しくは、Flux アプリの SORACOM Flux Studio を表示する を参照してください。

2. Incoming Webhook を作成するチャネルをクリックします。

   

3. [イベントソース] → [＋Incoming Webhook を作成する] の順にクリックします。

   

4. Incoming Webhook の [名前] と [説明] を入力して、[作成する] をクリックします。

   Incoming Webhook が作成されます。

5. [Webhook URL を表示する] をクリックします。

   

   Webhook URL が表示されます。

   

   Webhook URL は漏洩しないように注意してください

   Webhook URL を利用すると、API キーや API トークンなどの認証情報なしにデータを送信し、Flux アプリを起動できます。第三者に漏洩しないように注意してください。

   非表示にするには、[Webhook URL を非表示にする] をクリックします。

   Incoming Webhook は Flux アプリごとに 10 件まで発行できます

   Incoming Webhook を区別するために ID が発行されます。ID は、Incoming Webhook の右下に表示されます。

   

Webhook URL にデータを送信して Flux アプリを起動する

Webhook URL に HTTP POST リクエストを送信すると、Flux アプリが起動して、Webhook URL を発行したチャネルから実行が開始されます。

Webhook URL に {"temperature": 25} を送信する例:

$ curl -X POST "https://g.api.soracom.io/v1/flux/incoming_webhooks/XXXXXXXXXXXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "Content-Type: application/json" \
  -d '{"temperature": 25}'

{
  "messageId": "XXXXXXXXXXXXXXXXXXXXXXXXXX",
  "eventId": "XXXXXXXXXXXXXXXXXXXXXXXXXX",
  "appId": "XXXXXXXXXXXXXXXXXXXXXXXXXX",
  "channelId": "XXXXXXXXXXXXXXXXXXXXXXXXXX",
  "payload": {
    "contentType": "application/json",
    "content": "{\"temperature\":25}",
    "isBase64Encoded": false
  },
  "context": {
    "eventType": "incoming-webhook",
    "webhookId": "XXXXXXXXXXXXXXXXXXXXXXXXXX"
  },
  "timestamp": 1735689600000
}

レスポンスには、以下の値が含まれます。

チャネルに送信されるデータ

Incoming Webhook を使用した場合にチャネルに送信されるデータは、MESSAGE と CONTEXT です。

MESSAGE

Webhook URL に送信されたデータ (ボディ) です。

CONTEXT

{
  "eventType": "incoming-webhook",
  "webhookId": "XXXXXXXXXXXXXXXXXXXXXXXXXX"
}