SuperSaaSでのウェブフック管理やカスタマイズ

ウェブフックをカスタマイズして拡張活用
1. SuperSaaSのウェブフック機能
2. ウェブフックのカスタマイズ管理

ウェブフックをカスタマイズして拡張活用

SuperSaaSはウェブフックを活用できます。
SuperSaaS上でのアクションをトリガーとして、対応する情報がプッシュされますので、システムの構築や他サービスとの連携など自己構築することが可能です。

ウェブフック機能は試用版として1ヶ月間限定でテスト利用できますが、無料版では継続して利用できません。

有料版に限定されるのはウェブフックをSuperSaaSでカスタマイズするウェブフック機能であり、ウェブフック自体は無料版でも随時利用できます。

SuperSaaSのウェブフック機能

SuperSaaSのウェブフック機能は大きく2つあります。

一つ目は、ごく簡単にカレンダーサービスやスケジュールサービスと連携できる機能で、各スケジュール管理の同期から設定できます。

もう一つは、少し高度なウェブフックカスタマイズ機能です。
規定のトリガーに対して独自のURLに対してプッシュしたり、独自にカスタマイズしたデータをプッシュするなどウェブフック自体をもカスタマイズできる機能です。
ウェブフックのカスタマイズは以下のURLから行えます。ウェブフック管理画面（https://www.supersaas.jp/hooks）

管理メニューのどこかにリンクがあってもいいと思うのですが、URLを直接入力して活用しています（汗

ウェブフックのカスタマイズ管理

ウェブフック管理画面で、登録実装中のウェブフック一覧と、新規のウェブフックの登録ができます。

ウェブフック一覧

ウェブフック管理画面では登録実装中のウェブフックが一覧として確認できます。

設定	概要
ID	ウェブフック管理用のユニーク番号です。
Trigger	情報がプッシュされるトリガーとなる条件です。
Target URL	情報のプッシュ先のURLです。
作成日時	ウェブフックの作成日時です。
Errors	ウェブフック処理でエラーが発生した場合カウントされます。

操作
アイコン	名称	概要
	編集	ウェブフックの編集画面を開きます。
	消去	ウェブフックを削除します。

ゴミ箱機能がないので削除したウェブフックは元に戻せません。

新規ウェブフック登録

管理画面から新規にウェブフックを登録できます。

利用可能なトリガーを選択し、データのプッシュ先URLを指定してwebhook作成をクリックするだけで登録実装されます。

トリガーによっては、対象となるスケジュールやフォームの選択肢が追加されます。
登録すると、ウェブフックの編集画面に遷移します。

ウェブフックの編集

登録したウェブフックをカスタマイズできます。

Payloadはプッシュされるデータの設定です。

データフォーマットはJSON形式です。

全てのフィールド: トリガーに関わる全てのフィールドデータがプッシュされます。
不使用: フィールドデータをプッシュしません。
カスタム: プッシュ内容を任意のフォーマットにカスタマイズできます。

操作
メニュー	概要
webhookのテスト	設定中のウェブフックを実際にテストできます。
webhook更新	編集内容を確定して管理画面に戻ります。
webhook削除	ウェブフックを削除します。
戻る	ウェブフック管理画面に戻ります。