Server Hook 設定ファイル

Server Hook 設定ファイルは、作成した Server Code のプログラムを起動するタイミングを設定したファイルです。設定ファイルを作成後、Server Code と一緒に設置を行います。

Server Hook で定義可能な起動タイミングには次の 2 種類があります（それぞれの機能については Server Code の機能をご覧ください）。

サーバートリガー起動：サーバーで発生したトリガーを契機に Server Code を実行します。
スケジュール起動：指定した時間に Server Code を実行します。

これらの設定は、1 つの JSON 形式のファイル上にまとめて記述します。Server Hook 設定ファイルの全体の例を以下に示します。後で詳細を示すように、このファイルでは、ユーザ作成、アプリケーションスコープの Bucket の作成と削除、毎時 0 分の定期実行、毎日 2:30（UTC：協定世界時）の定期実行の 5 つの実行を定義しています。

{
  "kiicloud://users": [
    {
      "when": "USER_CREATED",
      "what": "EXECUTE_SERVER_CODE",
      "endpoint": "userCreated"
    }
  ],
  "kiicloud://buckets/highScore": [
    {
      "when": "DATA_OBJECT_CREATED",
      "what": "EXECUTE_SERVER_CODE",
      "endpoint": "highScoreCreated"
    },
    {
      "when": "DATA_OBJECT_DELETED",
      "what": "EXECUTE_SERVER_CODE",
      "endpoint": "highScoreDeleted"
    }
  ],
  "kiicloud://scheduler": {
    "HourlyCheck": {
      "what": "EXECUTE_SERVER_CODE",
      "cron": "0 * * * *",
      "endpoint": "checkData",
      "parameters": {
        "executionType": "hourly",
        "target": "user"
      }
    },
    "DailyCheck": {
      "what": "EXECUTE_SERVER_CODE",
      "cron": "30 2 * * *",
      "endpoint": "checkData",
      "parameters": {
        "executionType": "daily",
        "target": "all"
      }
    }
  }
}

Server Hook で指定したエンドポイントは、設定に基づいて自動実行できるほか、クライアント SDK から手動実行することもできます。