Versions Compared

Old Version 20

changes.mady.by.user 二宮力也

Saved on

compared with

New Version 21

changes.mady.by.user 二宮力也

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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


WebHookについて

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

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

Tip

現在、ベータ環境でのみ送信するWebHookのバージョンを指定することが出来ます。



WebHookの種類

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

Version1

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

Version2

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

サブスクリプションの課金サイクルが更新された場合に発行されるWebHookです。
ユーザーが新しく契約を結んだ際にも発行されます。

paymentsrequest-usage-record

使用量タイプの料金プランで契約しているユーザーがいる場合に、使用量を送信するように要求するWebHookです。
このWebHookkは、毎日4:00（JST）を目途に順次発行します。

subscriptioncreate/update/deleteサブスクリプションの作成,更新,削除時に発行されるWebHookです。


Note

現在、subscription.create/update/deleteのWebHookはベータ環境でのみ使用可能です。


　

WebHookの発行タイミング

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

タイミング

発行されるWebHookのイベントタイプ

サービスの申し込み

squareprovisioning.ADD、idprovisioning.ADD、payments.change-billing-period
subscription.create(β環境のみ)、user.provisioning(β環境のみ)

サービス利用者による契約プランの更新

squareprovisioning.UPDATE
subscription.update(β環境のみ)

サービスの解約

squareprovisioning.DELETE、idprovisioning.DELETE
subscription.delete(β環境のみ)、user.provisioning(β環境のみ)

スクエアにユーザーを招待

Note

招待されたユーザーがスクエアへの参加を承認した段階で発行されます。


Version1

  • idprovisioning.ADD

Version2

  • user.provisioning

スクエアからユーザーを削除

Version1

  • idprovisioning.DELETE.

Version2

  • user.provisioning
契約管理者の任命

Version2のみ
user.role-assign

契約管理者の解任Version2のみ
user.role-assign
ユーザー情報の更新Version2のみ
profile.update
サブスクリプションの課金サイクルの終了

Version2のみ
payments.change-billing-period

使用量タイプの料金プランを持つサブスクリプションに対して使用量を要求Version2のみ
payments.request-usage-record


　

WebHookの実装

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

Child pages (Children Display)
alltrue
styleh3