Outgoing Webhooks

Outgoing Webhooksを設定する事で、設定したアクションがあった場合に、任意の外部サービスへ通知を送る事が可能です。

Webhookとは

外部サービスにインターネットを経由して、HTTP/HTTPS でURLを使って機能を呼び出す(WebAPI を利用する）仕組みです。

WebAPI

APIをインターネット経由で利用できるようにしたものです。

HTTP/HTTPS のURLでAPI に命令を送ることが可能です。

Web上のサービスとサービスを繋ぎます。

Webhook でWebAPI を呼び出す

呼び出し

HTTP でWebAPI のURLと必要なパラメーター(データ)を送る。

サーバにデータを送信する際は、リクエストボディにデータを記述

HTTP POST: データを書き込む

HTTP GET: データを受け取る

リクエスト時にサーバへ送信するデータはリクエストURLの後に付け加えられる. http://example.com/foo?name1=value1&name2=value2

相手のデータにアクセスする場合、認証（エンドユーザーログイン、やサーバーへのログイン）の設計が必要です。

Webhook でログインWebAPI を呼び出す場合も相手のサービスと要件により個別に設計が必要となります。

レスポンス

相手のサーバーからレスポンス(返信)としてデータが返ってくる。

データ形式：JSON

Outgoing Webhooks新規追加

[設定]→[Outgoing Webhooks]を選択します。

[追加]を選択します。

下の表に従って入力を行ってください。

タイトル	内容	詳細
タイトル		任意のタイトルを設定してください。
タイプ	新しいユーザーメッセージ（OPモードのみ）	チャットでオペレーター対応が必要な新しいメッセージがお客様から届いた場合通知されます。
	あたらしいコンシェルジュの返信	施設側から返信を行った場合通知されます。
	利用規約に同意する	初めてチャットボットを利用するお客様に対して、利用規約への同意を求める設定を行っている施設様で[同意する]をお客様が選択された場合通知されます。
	新しいチャットが作成されました（新しいユーザー）	[認証]で[メンバーシップ（チャットボット）]を設定している施設様のみ新しいユーザーが追加された場合通知を行う事が可能です。
	認証に失敗しました（カスタム認証のみ）	[認証]で[カスタム認証]を設定している施設様のみ、認証が失敗した場合通知を行う事が可能です。
APIリクエストを送る	GET/POST	対象のURLのドキュメントを参照し、任意のものを設定してください。
	リクエストURL	APIリクエストの送信先を入力してください。
ヘッダー		不要な場合もあります ので対象のURLのドキュメントを参照し必要な場合は入力を行ってください。
パラメーター	GETの場合のみ表示されます。	象のURLのドキュメントを参照し任意のものを入力してください。
ボディ	POSTの場合のみ表示されます	送信を行いたい内容をJSONで入力してください。

権限	作業・閲覧可否
ブランド管理者	作業・閲覧可
施設管理者	作業・閲覧可
施設運営者	作業・閲覧可