Webhooks: SuperSaaSを他サイトへ接続

Webhooksを利用してSuperSaaSアカウント上で何かイベントが発生した時にその他のアプリケーションやウェブサイトにリアルタイムで通知する事が可能です。 こちらのページは中上級者向けの説明です。サポートは一切出来かねますのでご注意下さい。

ebhookを利用したいくつかの例

Webhooks logos

Zapier.comを使用して自動設定

ウェブサービスのZapier.comを利用すれば有名な多くのウェブサイトへプログラミング不要で接続可能です。 Zapierは試用版を提供しています。

以下例を見てみましょう。

新規ユーザーをMailChimpメーリングリストへ新規ユーザーをMailChimpメーリングリストへ
新規予約をGoogle Calendarへ新規予約をGoogle Calendarへ
新規予約の請求書をQuickBooks Invoiceで作成新規予約の請求書をQuickBooks Invoiceで作成
新規予約をemailフィルターへ新規予約をemailフィルターへ

サポートしているトリガー

3つのカテゴリーがあります。“new” イベント, または “change” イベント。 “change”は“new” と “delete”等の変更が含まれます。

Trigger発動要因…
新規ユーザーユーザーがアカウント登録した場合
ユーザーの変更ユーザー又は管理者がユーザーの情報を変更した時
新規予約特定のスケジュールでユーザー又は管理者が予約をした場合
変更 予約次を含む予約の変更があった場合“新規”, “消去”, “キャンセル待ちから正規リストへ”, “支払い受領”, etc. (下記の全リストをご覧下さい。)
新stand-aloneフォームstand-aloneフォームに情報が入力された時。 フォーオムが予約に添付された時にはトリガーが発動しません。
stand-aloneフォームのアップデートstand-aloneフォームで変更があった場合(統合型のフォームでは“予約の変更”があった場合)

もしあなたのスケジュールでユーザー登録が必須ではない場合"新規ユーザー"トリガーは発動しません。 "新規予約"トリガーのみ発動されます。

イベントのフィルタリング

Zapier上で2つのサービスを接続する場合イベントのフィルターを設定する事が出来ます。:

新規に"Zap"を作成した時、ZapierはSuperSaaSからのオブジェクトを要求します。 オブジェクトリスト例と利用可能なフィールドの例 フィールドには“trigger” と “role”は常に含まれイベントのフィルターに有用です。 例としてフィールドの"event"内で “delete”の値が含まれた場合にトリガーが発動する等。

Trigger"event"フィールド内で利用可能な値
新規ユーザー
ユーザーの変更新, 変更, 消去
新規予約作成
予約の変更作成, 編集, 場所, 審査中, 消去, 復元, 承認, 戻る
新規フォーム
フォームの変更新, 変更, 消去, 復元

"Role" fieldWho triggered the event…
0AnonymousNot logged in
1共通パスワードによりログイン
2IP range checkにより有効
3通常ユーザー
4Superuser
5管理者又は再販業者
7システム又はPayment gateway

課金が完了した予約の作成時又は変更時にはフィールド上の"status" と "status message"で確認が出来ます。ステータスコード. 例として返金がされた場合のみといったフィルターの設定も可能です。

webhooksを手動で設定

この機能は定期契約者のみ利用可能です。 webhooks上の"試用を開始"ボタンより1週間のトライアルスタートが出来ます。

Zapierを利用せずにwebhookを作成するには高いweb developmentスキルが必要です。 プログラマーに対しての説明を以下で紹介して行きます。

webhooksを手動で作成したりアップデートする事も可能です。 Webhooks アカウントのスクリーン内。
webhookはデータを送信するのでウェブサービスはデータを受信出来る必要があります。

webhookが送信したメッセージのカスタマイズ

デフォルトではwebhookはJSONエンコードとして関連のあるフィールに送信されます。 オブジェクトにカスタムフォームが含まれる場合はそのフォームも含まれます。 送信するデータの設定も可能です。 例としてAPI key等をメッセージに含めたい場合等

新規のwebhookを作成後に"payload"を編集出来る画面へ自動的に移動します。 "Custom"をクリックするとJSON editorが見えますので特定のフィールドの追加等が可能です。 画面下には利用可能な"magic words"リストがあります。 マジックワードはオブジェクトを適用可能なフィールドによって変更されます。

webhookをテスト

webhookのdebugに次のサイトは有用です。RequestBin. ターゲットURLをモニタリング可能なので送信データを把握可能です。

“Test”リンクがwebhookの編集画面でご覧頂けますのでカスタマイズが可能です。

作成後に平均して5秒後に送信されます。 "410 Gone"ステータスコードを受け取った場合はwebhookは即座に排除されます。