このセクションでは、CloudGearアプリケーションがCloudGearのWebHookを受け取る為の実装について説明いたします。
WebHookの種類
WebHookは、いくつかのタイプを持ちます。
Version1
| タイプ | 説明 |
|---|---|
| idprovisioning | ユーザーの追加・削除などユーザーに関連した変更が発生した場合に発行されるWebHookです。 |
| squareprovisioning | スクエアに対する変更、または契約状態の変更によって発行されるWebHookです。 |
Version2
| イベント | タイプ | 説明 |
|---|---|---|
| user | provisioning | ユーザーの追加・削除などユーザーに関連した変更が発生した場合に発行されるWebHookです。 |
| user | role-assign | サブスクリプションを管理する契約管理者の任命・解任が発生した場合に発行されるWebHookです。 |
| profile | update | ユーザー情報の変更が発生した場合に発行されるWebHookです。 このWebHookは、ユーザーが契約しているサービスあたり1回しか発行されません。 |
| payments | change-billing-period | サブスクリプションの課金サイクルが更新された場合に発行されるWebHookです。 |
| payments | request-usage-record | 使用量タイプの料金プランで契約しているユーザーがいる場合に、使用量を送信するように要求するWebHookです。 |
| subscription | create/update/delete | サブスクリプションの作成,更新,削除時に発行されるWebHookです。 |
| Note |
|---|
現在、subscription.create/update/deleteのWebHookはベータ環境でのみ使用可能です。 |
WebHookの発行タイミング
WebHookは、以下のタイミングで発行されます。
タイミング | 発行されるWebHookのイベントタイプ | ||
|---|---|---|---|
サービスの申し込み | squareprovisioning.ADD、idprovisioning.ADD、payments.change-billing-period | ||
サービス利用者による契約プランの更新 | squareprovisioning.UPDATE | ||
サービスの解約 | squareprovisioning.DELETE、idprovisioning.DELETE | ||
スクエアにユーザーを招待
| Version1
Version2
| ||
スクエアからユーザーを削除 | Version1
Version2
| ||
| 契約管理者の任命 | Version2のみ user.role-assign | ||
| 契約管理者の解任 | Version2のみ user.role-assign | ||
| ユーザー情報の更新 | Version2のみ profile.update | ||
| サブスクリプションの課金サイクルの終了 | Version2のみ | ||
| 使用量タイプの料金プランを持つサブスクリプションに対して使用量を要求 | Version2のみ payments.request-usage-record |
WebHookの実装
以下のページにて、具体的なWebHookの設定方法ならびに各タイミングで発行されるWebHookのリクエストボディに関して説明します。
| Child pages (Children Display) | ||||
|---|---|---|---|---|
|