Поделиться через

Ресурс уведомлений веб-перехватчиков

  • Статья

В ресурсе уведомлений определяется форма данных, предоставляемых службе при отправке запроса уведомления веб-перехватчика на зарегистрированный URL-адрес.

Представление JSON

Каждое уведомление, созданное службой, сериализуется в экземпляр webhookNotifiation:

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

Так как в одном запросе службе может отправляться несколько уведомлений, они объединяются в объект с одним массивом value:

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

Свойства

Имя свойства Тип description
subscriptionId String Уникальный идентификатор ресурса подписки
expirationDateTime DateTime Дата и время окончания срока подписки, если она не будет обновлена или продлена.
resource Относительный URL-адрес URL-адрес элемента, в котором зарегистрирована подписка.
clientState String (необязательный) Необязательное строковое значение, возвращаемое в сообщении уведомления для подписки.
changeType Строка Указывает тип изменения, вызвавшего уведомление. Для OneDrive это всегда будет updated.