webhookNotifiation.md

Webhook notification resource

The notification resource defines the shape of the data provided to your service when a webhook notification request is submitted to your registered URL.

JSON representation

Each notification generated by the service is serialized into a webhookNotifiation instance:

{
  "context": "string optional",
  "expirationDateTime": "datetime",
  "resource": "url",
  "subscriptionId": "string",
  "tenantId": "string",
  "userId": "string"
}

Since multiple notifications may be submitted to your service in a single request, these are combined together in an object with a single array value:

{
  "value": [
    {
      "subscriptionId": "101010111",
      "userId": "987654321a"
    },
    {
      "subscriptionId": "222020202",
      "userId": "5643428191b"
    }
  ]
}

Properties

Property Name	Type	description
context	String - optional	An optional string value that is passed back in the notification message for this subscription.
expirationDateTime	DateTime	The date and time when the subscription will expire if not updated or renewed.
resource	URL	URL to the item where the subscription is registered.
subscriptionId	String	The unique identifier for the subscription resource
tenantId	String	Unique identifier for the tenant which generated this notification. This is only returned for OneDrive for Business and SharePoint.
userId	String	Unique identifier for the drive which generated this notification.