サービス購入者がサービスを申し込んだタイミングで発行されるWebHookについて説明します。

概要

サービス申し込みが完了するとSquareProvisioningとIDProvisioningの2つのWebHookが発行されます。

SquareProvisioning WebHookには、契約プランの情報と契約によって生成されたスクエアのIDが含まれます。
IDProvisioning WebHookには、契約者の情報が含まれます。

以下の順番でWebHookは発行されます。

SquareProvisioning
IDProvisioning

リクエストボディ

以下のフォーマットの内容でCloudGearからCloudGearアプリケーションにHTTPリクエストが送信されます。

squareprovisioning(ADD)

{
  "data":[{
    "plans":[{
      "id":"UUID", // プランID
      "action":"ADD" // プランへの操作タイプ
    }],
    "squareId":"UUID", // スクエアID
    "serviceId":1, //サービスID
    "action":"ADD", // スクエアへの操作タイプ
    "cause":"execute SPROV." // 操作理由
  }],
  "event":"squareprovisioning"
}

idprovisioning

{
  "event":"idprovisioning",
  "data": [{
    "type":"ADD", // 操作タイプ
    "userinfo": {
      "sub": "user1@unirita.co.jp", // UID
      "name": "ユニリタ太郎", // 名前
      "given_name": "太郎", // 名
      "family_name": "ユニリタ", // 姓
      "preferred_username": "user1@unirita.co.jp", // UID（MUST NOT Unique）
      "email": "user1@unirita.co.jp", // メールアドレス
      "square_id": "12345667890", // 実行対象になるスクエアID
      "square_attrs": { // ユーザのスクエア属性
        "属性名": "属性値",
        ...
      }
    }
  }]
}

サービスの申し込み

概要

リクエストボディ