ウェブフックをカスタマイズして拡張活用
SuperSaaSはウェブフックを活用できます。
SuperSaaS上でのアクションをトリガーとして、対応する情報がプッシュされますので、システムの構築や他サービスとの連携など自己構築することが可能です。
有料版に限定されるのはウェブフックをSuperSaaSでカスタマイズするウェブフックの管理機能であり、ウェブフック機能自体は無料版でも随時利用できるようでもあります。
SuperSaaSのウェブフック機能
SuperSaaSのウェブフック機能は大きく2つあります。
一つ目は、ごく簡単にカレンダーサービスやスケジュールサービスと連携できる機能で、各スケジュール管理の同期やシステムメニューの連携から設定できます。
もう一つは、少し高度なウェブフックカスタマイズ機能です。
規定のトリガーに対して独自のURLに対してプッシュしたり、独自にカスタマイズしたデータをプッシュするなどウェブフック自体をもカスタマイズできる機能です。
システムメニューの連携にあるWebhooksから設定できます。
ウェブフックのカスタマイズ管理
ウェブフック管理画面で、登録実装中のウェブフック一覧と、新規のウェブフックの登録ができます。
ウェブフック一覧
ウェブフック管理画面では登録実装中のウェブフックが一覧として確認できます。
| 設定 | 概要 |
|---|---|
| ID | ウェブフック管理用のユニーク番号です。 |
| Trigger | 情報がプッシュされるトリガーとなる条件です。 |
| Target URL | 情報のプッシュ先のURLです。 |
| 作成日時 | ウェブフックの作成日時です。 |
| Errors | ウェブフック処理でエラーが発生した場合カウントされます。 |
| アイコン | 名称 | 概要 |
|---|---|---|
 | 編集 | ウェブフックの編集画面を開きます。 |
 | 消去 | ウェブフックを削除します。 |
新規ウェブフック登録
管理画面から新規にウェブフックを登録できます。
利用可能なトリガーを選択し、データのプッシュ先URLを指定してwebhook作成をクリックするだけで登録実装されます。
トリガーによっては、対象となるスケジュールやフォームの選択肢が追加されます。
登録すると、ウェブフックの編集画面に遷移します。
ウェブフックの編集
登録したウェブフックをカスタマイズできます。
Payloadはプッシュされるデータの設定です。
- 全てのフィールド
- トリガーに関わる全てのフィールドデータがプッシュされます。
- 不使用
- フィールドデータをプッシュしません。
- カスタム
- プッシュ内容を任意のフォーマットにカスタマイズできます。
| メニュー | 概要 |
|---|---|
| webhookのテスト | 設定中のウェブフックを実際にテストできます。 |
| webhook更新 | 編集内容を確定して管理画面に戻ります。 |
| webhook削除 | ウェブフックを削除します。 |
| 戻る | ウェブフック管理画面に戻ります。 |
ウェブフックのテストで実際にプッシュされるデータを確認しましょう。
ウェブフックのテスト
ウェブフックのテストで実際にポストされる情報を確認できます。
Post payload nowで実行にターゲットURLまでポストします。プッシュ先の挙動の動確も合わせて行いましょう。
公式に公開されている仕様定義が少ないので、思いつきのような仕様改修が行われる可能性もありますので、そのつもりで活用することを推奨します。
ビジネス活用される場合は、仕様詳細などを公式に問い合わせながらの設計が安心かもしれません。
