サービス購入者がサービスの申し込みが完了した際に発行されるWebHookについて説明します。

概要

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

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

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

SquareProvisioning
IDProvisioning

リクエストボディ

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

squareprovisioning(ADD)

{
  "event":"squareprovisioning",
  "data":[{
    "plans":[{
      "id":"UUID", // プランID
      "action":"ADD" // プランへの操作タイプ
    }],
    "serviceId":1, // サービスID
    "squareId":"UUID", // スクエアID
    "action":"ADD", // スクエアへの操作タイプ
    "cause":"execute SPROV.", // 操作理由
    "userinfo":{ // スクエアオーナーのユーザー情報
      "sub":"cloudgear@cloudgear.services",
      "name":"クラウドギア",
      "email":"cloudgear@cloudgear.services",
      "given_name":"ギア",
      "family_name":"クラウド",
      "preferred_username":"cloudgear@cloudgear.services",
      "square_id":"UUID",
      "square_attrs":{
        "属性名":"属性値",
        ...
      }
    }
  }]
}

idprovisioning(ADD)

{
  "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": { // ユーザのスクエア属性
        "属性名": "属性値",
        ...
      }
    }
  }]
}