このセクションでは、CloudGearアプリケーションがCloudGearのWebHookを受け取る為の実装について説明いたします。

WebHookについて

WebHookは、CloudGearに契約またはサービススクエアが作成/削除されたときや、ユーザーがスクエアに加入/脱退したときなどに、CloudGearアプリケーションのバックエンドサーバーにその情報を伝えるための仕組みです。

送信されるWebHookには、バージョンが設定されています。
バージョンによって、送信されるJSONインタフェースが異なります。（後方互換のため、Version1で送信されていた内容も別途送信いたします）

WebHookの種類

WebHookは、いくつかのタイプを持ちます。

タイプ	説明
idprovisioning	ユーザーの追加・削除などユーザーに関連した変更が発生した場合に発行されるWebHookです。
squareprovisioning	スクエアに対する変更、または契約状態の変更によって発行されるWebHookです。

イベント	タイプ	説明
user	provisioning	ユーザーの追加・削除などユーザーの存在に関連した変更が発生した場合に発行されるWebHookです。
user	role-assign	サブスクリプションを管理する契約管理者の任命・解任が発生した場合に発行されるWebHookです。
profile	update	ユーザー情報の変更が発生した場合に発行されるWebHookです。このWebHookは、ユーザーが契約しているサービスあたり1回しか発行されません。

WebHookは、以下のタイミングで発行されます。

タイミング	発行されるWebHookのイベントタイプ
サービスの申し込み	squareprovisioning.ADD、idprovisioning.ADD
サービス利用者による契約プランの更新	squareprovisioning.UPDATE
サービスの解約	squareprovisioning.DELETE、idprovisioning.DELETE
スクエアにユーザーを招待招待されたユーザーがスクエアへの参加を承認した段階で発行されます。	Version1 idprovisioning.ADD Version2 user.provisioning
スクエアからユーザーを削除	Version1 idprovisioning.DELETE. Version2 user.provisioning
契約管理者の任命	user.role-assign
契約管理者の解任	user.role-assign
ユーザー情報の更新	profile.update

以下のページにて、具体的なWebHookの設定方法ならびに各タイミングで発行されるWebHookのリクエストボディに関して説明します。