Webhook アクションは、指定した URL に HTTP リクエストを送信します。チャットサービスを初めとしたさまざまな通知サービスを利用することで、Flux で処理した内容をヒトに通知することもできます。
チャネルにアクションを追加する手順については、チャネルにアクションを追加する (処理を分岐する) を参照してください。
Webhook アクションの設定
ここでは、Webhook アクションの CONFIG について説明します。そのほかの項目については、アクションリファレンスの 「新しいアクションを作成」画面 を参照してください。
CONFIG
送信する HTTP リクエストを設定します。
| 項目 | 説明 | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Webhook の HTTP メソッドを選択します。 | |||||||||||||||||
Webhook の送信先の URL を入力します。
| |||||||||||||||||
Webhook の送信時の HTTP ヘッダーに認証情報を追加できます。選択する項目によって、ヘッダーに追加される内容が異なります。
| |||||||||||||||||
をクリックして、HTTP ヘッダーの と を入力します。
| |||||||||||||||||
HTTP ボディを設定します。
|
AWS Signature V4
の で「AWS Signature V4」を選択すると、Webhook 送信時の Authorization ヘッダーに AWS 署名バージョン 4 を追加できます。
| 項目 | 説明 |
|---|---|
| 「AWS Signature V4」を選択します。 | |
| AWS 署名バージョン 4 の署名プロセスで利用する AWS 認証情報 または AWS IAM ロール認証情報 を選択します。 | |
| AWS の各サービスを利用するリージョンを選択します。 | |
AWS の各サービスに対応するサービスコードを入力します。 AWS の各サービスに対応するサービスコードは、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 のアクティブ化と非アクティブ化 を参照してください。
Google Service Account
の で「Google Service Account」を選択すると、Google Service Account (JSON) を利用して Google の OAuth 2.0 トークンエンドポイントからアクセストークンを取得し、Webhook 送信時の Authorization ヘッダーに Bearer トークンを追加できます。
Bearer トークン (JWT) との違い
「Google Service Account」は、Google の OAuth 2.0 トークンエンドポイントでアクセストークンを取得してから Webhook を送信します。
一方、「Bearer トークン (JWT)」は、生成した JWT 自体を Authorization: Bearer {token} ヘッダーとして送信します。Google Service Account (JSON) を使う新しい Google API 連携では、通常は「Google Service Account」を選択してください。
| 項目 | 説明 |
|---|---|
| 「Google Service Account」を選択します。 | |
| Google Service Account (JSON) を選択します。 | |
Google API にアクセスするための OAuth 2.0 スコープを入力します。複数のスコープを指定する場合は、半角スペースで区切ります。指定できるスコープについて詳しくは、Google for Developers の OAuth 2.0 Scopes for Google APIs を参照してください。
| |
Google Workspace のドメイン全体の委任を利用する場合は、委任対象のユーザーを入力します。ドメイン全体の委任を利用しない場合は、空欄のままにします。
|
カスタムヘッダー
の で「カスタムヘッダー」を選択すると、Webhook 送信時に任意の HTTP ヘッダーに認証情報を追加できます。
| 項目 | 説明 |
|---|---|
| 「カスタムヘッダー」を選択します。 | |
| ヘッダーの値として利用する API トークン認証情報 または 事前共有鍵 を選択します。 | |
認証情報を追加する HTTP ヘッダー名を入力します。たとえば、送信先のサービスが
|
Webhook アクションの出力データ
Webhook の送信先からのレスポンスです。
- Webhook アクションの処理は、10 秒でタイムアウトします。Webhook の送信先からレスポンスが返ってくるまでに 10 秒以上かかるサービスは利用できません。
- Webhook の送信先からのレスポンスは、32,768 バイトで切り捨てられます。
Webhook アクションを通知に利用する
Flux で処理した内容をヒトに通知する場合などは、チャットサービスを初めとしたさまざまな通知サービスの Webhook 連携機能を利用します。Microsoft Teams や Google Chat などの Webhook 連携機能については 通知サービスを利用する を参照してください。
