Soracom

Users

ドキュメント
Home ドキュメント SORACOM Flux (Public beta) アクションリファレンス

Webhook アクション

Webhook アクションは、指定した URL に HTTP リクエストを送信します。

Webhook アクションの設定

CONDITION

[アクションの実行条件] に、アクションを実行する条件を指定できます。

  • この入力欄では、Flux アプリが起動するトリガーに関するデータを表す式 (例: event.payload.temp) や、アクションを追加したチャネルに関するデータを表す式 (例: payload.temp) を入力できます。入力できる式について詳しくは、アクション、コンディションの記法 を参照してください。

CONFIG

送信する HTTP リクエストを設定します。

項目説明
[HTTP メソッド]Webhook の HTTP メソッドを選択します。
[URL]

Webhook の送信先の URL を入力します。

  • この入力欄では、Flux アプリが起動するトリガーに関するデータを表す式 (例: ${event.payload.temp}) や、アクションを追加したチャネルに関するデータを表す式 (例: ${payload.temp}) を入力できます。入力できる式について詳しくは、アクション、コンディションの記法 を参照してください。
[認証方法]

Webhook の送信時の HTTP ヘッダーに認証情報を追加できます。選択する項目によって、ヘッダーに追加される内容が異なります。

項目説明
なしHTTP ヘッダーに認証情報を追加しません。
AWS Signature V4AWS 署名バージョン 4 を追加します。設定内容について詳しくは、AWS Signature V4 を参照してください。
Basic 認証RFC 7617 で定義されている Basic 認証を利用するための Authorization: Basic {credentials} ヘッダーを追加します。なお、{credentials} には、[認証情報] で選択した ユーザ名・パスワード認証情報 で設定したユーザー名とパスワードから生成された Base64 文字列が挿入されます。
Bearer トークンRFC 6750 で定義されている Bearer スキームを利用するための Authorization: Bearer {token} ヘッダーを追加します。なお、{token} には、[認証情報] で選択した API トークン認証情報 または 事前共有鍵 が挿入されます。
Bearer トークン (JWT)RFC 6750 で定義されている Bearer スキームを利用するための Authorization: Bearer {token} ヘッダーを追加します。なお、{token} には、[認証情報] で選択した Google Service Account (JSON)、または 秘密鍵 (PEM) を利用して発行された JSON Web Token (JWT) が挿入されます。[署名アルゴリズム] および [JWT Claims] については、Cloud Endpoints に送信する を参照してください。
[HTTP ヘッダー]

[+追加] をクリックして、HTTP ヘッダーの [ヘッダー名][値] を入力します。

  • この入力欄では、Flux アプリが起動するトリガーに関するデータを表す式 (例: ${event.payload.temp}) や、アクションを追加したチャネルに関するデータを表す式 (例: ${payload.temp}) を入力できます。入力できる式について詳しくは、アクション、コンディションの記法 を参照してください。
[HTTP ボディ]

HTTP ボディを設定します。

  • HTTP ボディの Content Type を選択します。
    • [Body なし]: HTTP ボディを送信しません。
    • [application/json]: content-type: application/json を送信します。
    • [text/plain]: content-type: text/plain を送信します。
    • [その他]: 任意の Content Type を指定します。必要に応じて、[HTTP ヘッダー][+追加] をクリックして、HTTP ヘッダーを設定します。
    • [元データのまま転送]: Webhook アクションの入力データをそのまま HTTP ボディとして送信します。
  • この入力欄では、Flux アプリが起動するトリガーに関するデータを表す式 (例: ${event.payload.temp}) や、アクションを追加したチャネルに関するデータを表す式 (例: ${payload.temp}) を入力できます。入力できる式について詳しくは、アクション、コンディションの記法 を参照してください。

AWS Signature V4

[CONFIG][認証方法] で「AWS Signature V4」を選択すると、Webhook 送信時の Authorization ヘッダーに AWS 署名バージョン 4 を追加できます。

項目説明
[認証方法]「AWS Signature V4」を選択します。
[認証情報]AWS 署名バージョン 4 の署名プロセスで利用する AWS 認証情報 または AWS IAM ロール認証情報 を選択します。
[リージョン]AWS の各サービスを利用するリージョンを選択します。
[サービス]

AWS の各サービスに対応するサービスコードを入力します。

AWS の各サービスに対応するサービスコードは、AWS の API エンドポイントから読み取ります。具体的には https://{service-code}.{region}.amazonaws.com の形式で指定する API エンドポイントの、{service-code} の部分がサービスコードです。詳しくは、AWS API リクエスト署名の要素 および サービスエンドポイントとクォータ を参照してください。

AWS 署名バージョン 4 を利用する場合は AWS STS エンドポイントをアクティブ化してください

AWS 署名バージョン 4 を利用する場合は、AWS が提供する AWS STS エンドポイントをアクティブ化してください。

なお、アクティブ化する AWS STS エンドポイントは、Beam を利用する カバレッジタイプ および ランデブーポイント によって異なります。

SORACOM のカバレッジタイプSORACOM のランデブーポイントAWS リージョンAWS STS エンドポイント
グローバルカバレッジオレゴン (米国)米国西部 (オレゴン)sts.us-west-2.amazonaws.com
シドニー (オーストラリア)アジアパシフィック (シドニー)sts.ap-southeast-2.amazonaws.com
東京 (日本)アジアパシフィック (東京)sts.ap-northeast-1.amazonaws.com
フランクフルト (ドイツ)欧州 (フランクフルト)sts.eu-central-1.amazonaws.com
日本カバレッジ東京 (日本)アジアパシフィック (東京)sts.ap-northeast-1.amazonaws.com

たとえば、日本カバレッジの Beam で AWS 署名バージョン 4 を利用する場合は、sts.ap-northeast-1.amazonaws.com をアクティブ化します。

AWS STS エンドポイントのアクティブ化について詳しくは、AWS リージョン での AWS STS のアクティブ化と非アクティブ化 を参照してください。

OUTPUT

アクションの出力データの取り扱いを設定します。

項目説明
[アクションのアウトプットを別のチャネルに送信する]「有効」にすると、アクションの出力データを別のチャネルに送信できます。
[送信先チャネル]
  • [新しくチャネルを作成する] を選択して、[チャネル名] にチャネルの名前を入力します。
  • [既存のチャネルを選択する] を選択して、既存のチャネルを選択します。

Webhook アクションの出力データ

Webhook の送信先からのレスポンスです。

  • Webhook アクションの処理は、10 秒でタイムアウトします。Webhook の送信先からレスポンスが返ってくるまでに 10 秒以上かかるサービスは利用できません。
  • Webhook の送信先からのレスポンスは、32,768 バイトで切り捨てられます。