webhook 通知リソース

この通知リソースでは、登録されている URL に webhook 通知要求が送信されるときに、サービスに提示されるデータの形状を定義します。

JSON 表記

サービスによって生成されるそれぞれの通知は、webhookNotifiation インスタンスにシリアル化されます。

{
  "subscriptionId": "string",
  "expirationDateTime": "datetime",
  "resource": "relative url",
  "clientState": "string optional",
  "changeType": "updated"
}

複数の通知が 1 つの要求としてサービスに送信されることがあるため、複数の通知は 1 つの配列値を持つ 1 つのオブジェクトにまとめられます。

{
  "value": [
    {
      "subscriptionId": "101010111",
      "resource": "/me/drive/root",
      "changeType": "updated",
      "clientState": "sub2"
    },
    {
      "subscriptionId": "222020202",
      "resource": "/me/drive/root",
      "changeType": "updated",
      "clientState": "sub1"
    }
  ]
}

プロパティ

プロパティ名	種類	説明
subscriptionId	文字列	subscription リソースの一意識別子
expirationDateTime	DateTime	サブスクリプションが更新されなかった場合に期限切れになる日時。
resource	相対 URL	サブスクリプションが登録された項目への URL。
clientState	文字列 - 省略可	このサブスクリプションへの通知メッセージに含めて送り返されるオプションの文字列値。
changeType	String	通知を生成した変更の種類を示します。 OneDrive の場合、これは常に updated になります。