契約管理者を解任した際に発行されるWebHookについて説明します。

2020年1月8日の本番リリース(予定)より、既存のWebHookの一部パラメータが変更され、新たなWebHookが追加されます。
β環境では変更が適用されている為、β環境をご利用の場合は、概要(ベータ環境)をご覧ください。

概要

契約管理者は、契約内容の変更や契約の破棄を行うことはできません。

リクエストボディ

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

event="user", type="role-assign"

{
  "event": "user",
  "type": "role-assign",
  "data": {
    "square_id": "square_id", // 実行対象になるスクエアID
    "users": [{
      "uid": "user1@unirita.co.jp", // 実行対象になるユーザーのUID
      "service_roles": [{}],
      "subscription_roles": [{
        "type": "DELETE",
        "role_id": "admin"
      }]
    }]
  }
}

概要(ベータ環境)

サブスクリプションを管理するユーザーを解任した際に発行されます。

管理者解任のWebHookは、バージョン2のみ送信されます。

契約管理者は、契約内容の変更や契約の破棄を行うことはできません。

リクエストボディ

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

event="user", type="role_assign"

{
　"id": "91018c24-4182-4e20-8509-501471b6304f", // UUID
  "event": "user",
  "type": "role-assign",
  "created_at": 1576200980964, // 作成日時
  "version": 2, // WebHookのバージョン
  "data": {
    "square_id": "square_id", // 実行対象になるスクエアID
    "service_id": 1, // サービスID
    "subscription_id": "subscription_id", // 契約ID
    "users": [{
      "uid": "user1@unirita.co.jp", // 実行対象になるユーザーのUID
      "service_roles": [{}],
      "subscription_roles": [{
        "type": "DELETE",
        "role_id": "admin"
      }]
    }]
  }
}

契約管理者の解任

概要

リクエストボディ

概要(ベータ環境)

リクエストボディ