Webhook は、自動処理のように、イベント種別、トリガー条件、リクエスト内容の設定を行うことで、Canbus. のアプリに蓄積されたデータを Canbus. から外部プログラムに送り、活用することができます。
Canbus. アプリ内のテーブルや外部ツールに、レコード情報を自由に組み合わせて、データ活用の幅を広げることができます。
例えば、Webhook通知の送信先をGoogle chatにすることでレコードの追加・更新・削除時や指定した日時にGoogle chatへ通知を送信することができます。
これにより、承認ルートが有効のテーブルでは、ステータスが変更した時に通知を送信するなどの利用用途にあった設定が可能です。
Webhookの設定画面は、テーブル設定画面のメニューから進むことができます。
① タイトル / 説明
トリガー名や処理の内容などを記入することができます
② イベント種別
イベントの実行タイミングやトリガーとなる操作を選択することができます
➂ イベント条件
レコードの値を条件に設定することができます
条件に合致しない場合は設定した Webhook が実行されません
④ 本文内容を申請する
Webhook の実行内容を設定することができます
| 設定項目 | 説明 |
| フォーマット選択 | 設定されているフォーマットを選択することができます |
| メソッド の選択 | HTTP メソッドを選択することができます |
| エンドポイント URL | 処理の実行対象となる URL を設定できます |
| ヘッダー | リクエストヘッダーを設定できます |
| ボディ | リクエストボディを記載し、処理の内容を設定します |
ボディデータ では埋め込み用変数を使用して通知文を作成することが可能です。
【埋め込み用変数】
通知の件名・本文では、以下の変更を使用できます。変数は、通知が送信されるときに実際の値に置き換えられます。
${title_application} アプリ名
${title_record} レコードタイトル
${creator} レコード作成者の表示名
${update_user} レコード更新者の表示名
${worker} 作業者の表示名
${url_record} レコード編集の URL
${url_record_view} レコード詳細の URL
${url_application} アプリの URL
${項目 ID} 対象の項目の値
${title_table} テーブル名
例として、レコードが追加された際に Google Chat にメッセージを送る設定を記載いたします。
- イベント種別 - レコードの追加
- メソッド - POST
- エンドポイント URL - Google Chat のスペースで作成した Webhook の URL
※画面上のスペース名 > [アプリと統合] 内にあります
リクエストボディの形式
{
"text":"${Text}
これは文字列項目の値となります。"
}
上記設定にて実行すると、このようなメッセージが Google Chat へ送られます。（文字列項目に「テスト」と打ち込んだ場合になります。）
また、アプリ管理者は管理画面＞アプリ管理より、Webhook テンプレートを作成することが可能です。
テンプレートを作成することで、テーブル内の Webhook 設定で作成したテンプレートが使用可能になります。
テンプレートで設定できるのは、リクエスト内容の設定のみのため、
イベント種別、トリガー条件などは各テーブルごとに自由に設定可能です。