Campaign Enable Hook

接客サービスの公開・非公開時に起動するHookです。

ご利用いただく場合は、「hook設定」から「KARTE Action: 接客サービスの公開・非公開時」を選択してください。

注意事項

処理が無限ループになることを避けるため、 Toggle campaign's enabled status. ではこのHookは発火しません。管理画面からの公開・非公開操作のみに対応しています。

Required Scope

beta.action.campaign.findById

Request Body

{
  "id": "{ユニークなID}",
  "api_key": "{Api Key}",
  "event_type": "action/campaign/changeEnable",
  "client_id": "{Client Id}",
  "data": {
    "ret": {
      "campaign":
        {
          "id": "{接客のID}",
          "title": "{接客の名前}",
          "enabled": "{接客の公開/非公開設定}",
          // 詳細はFind by Id APIのResponseを参照してください
        }
    }
  },
  "extra": {}
}

Name	Type	Description
id	String	hookの実行ごとに割り振られるユニークな ID
api_key	String	プロジェクトのAPI Key
event_type	String	hook のトリガーを表す文字列。
client_id	String	アプリの Client ID
data.ret.campaign	Object	接客情報※
data.ret.campaign.id	String	接客の識別用ID
data.ret.campaign.title	String	接客の名前
data.ret.campaign.enabled	Boolean	接客の公開/非公開設定。公開の場合は `true` が、非公開の場合は `false` が入る。
...	...	...

campaignのフィールドの詳細はFind by Id APIの200 Responseを参照してください