Share via

Ressource de notification webhook

  • Article

La ressource de notification définit la forme des données fournies dans votre service lorsqu’une demande de notification webhook est soumise à l’URL enregistrée.

Représentation JSON

Chaque notification générée par le service est sérialisée dans une instance webhookNotification.

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

Étant donné que plusieurs notifications peuvent être envoyées à votre service au sein d’une même demande, elles sont combinées dans un objet avec une seule valeur collective.

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

Propriétés

Nom de la propriété Type description
subscriptionId Chaîne Identificateur unique pour la ressource faisant l’objet de l’abonnement.
expirationDateTime Date/heure Date et heure d’expiration de l’abonnement s’il n’est pas mis à jour ou renouvelé.
resource URL relative URL de l’élément où l’abonnement est enregistré.
clientState Chaîne - facultatif Valeur de chaîne facultative qui est renvoyée dans le message de notification associé à cet abonnement.
changeType Chaîne Indique le type de modification qui a généré la notification. Pour OneDrive, il s’agit toujours de updated.