Compartilhar via

Recursos de notificação de webhook

  • Artigo

O recurso de notificação define o formato dos dados fornecidos ao serviço quando uma solicitação de notificação de webhook é enviada à URL registrada.

Representação JSON

Cada notificação gerada pelo serviço é serializada em uma instância webhookNotifiation:

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

Como várias notificações podem ser enviadas ao serviço em uma única solicitação, elas são combinadas em um objeto com um único valor de matriz:

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

Propriedades

Nome da propriedade Tipo description
subscriptionId Cadeia de caracteres O identificador exclusivo do recurso de assinatura
expirationDateTime DateTime Data e hora em que a assinatura expirará se não for atualizada ou renovada.
recurso URL relativa URL para o item em que a assinatura está registrada.
clientState Cadeia de caracteres – opcional Um valor de cadeia de caracteres opcional é passado novamente na mensagem de notificação para essa assinatura.
changeType String Indica o tipo de alteração que gerou a notificação. Para o OneDrive, sempre será updated.