Webhook 通知资源

notification 资源定义了在向已注册的 URL 提交 webhook 通知请求后,向服务提供的数据形状。

JSON 表示形式

服务生成的每个通知都会序列化为 webhookNotifiation 实例:

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

由于多个通知可能被提交到单个请求中的服务,它们会一起组合在一个具有单个数组的对象中:

{
  "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 Relative URL 注册订阅的项的 URL。
clientState 字符串 - 可选 此订阅的通知消息中回传的可选字符串值。
changeType String 指明触发通知生成的更改的类型。 对于 OneDrive,此属性始终为 updated