Freigeben über


Webhook-Benachrichtigungsressource

Die Benachrichtigungsressource definiert die Form der Daten, die Ihrem Dienst bereitgestellt werden, wenn eine Webhook-Benachrichtigungsanforderung an die registrierte URL gesendet wird.

JSON-Darstellung

Jede vom Dienst generierte Benachrichtigung wird in eineWebhookNotification-Instanz serialisiert:

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

Da in einer einzigen Anforderung mehrere Benachrichtigungen an den Dienst gesendet werden können, werden diese in einem Objekt mit einem einzigen Array-Wert zusammengefasst:

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

Eigenschaften

Eigenschaftenname Typ description
subscriptionId Zeichenfolge Der eindeutige Bezeichner für die Subscription-Ressource.
expirationDateTime DateTime Datum und Uhrzeit des Ablaufs des Abonnements, wenn dies nicht aktualisiert oder erneuert wird.
resource Relative URL Die URL des Elements, in dem das Abonnement registriert ist.
clientState Zeichenfolge – optional Ein optionaler Zeichenfolgenwert, der in der Benachrichtigungsmitteilung für Ihr Abonnement zurückgegeben wird.
changeType String Gibt den Typ der Änderung an, die die Benachrichtigung generiert hat. Für OneDrive ist dies immer updated.