Skip to content

Latest commit

 

History

History
87 lines (71 loc) · 4.13 KB

share-point-events.md

File metadata and controls

87 lines (71 loc) · 4.13 KB
Raw
title description ms.topic ms.date
Microsoft Sharepoint events
This article describes Microsoft Sharepoint event types and provides event samples.
conceptual
12/6/2023

Microsoft Sharepoint events

This article provides the properties and schema for Microsoft Sharepoint events, which are published by Microsoft Graph API. For an introduction to event schemas, see CloudEvents schema.

Available event types

These events are triggered when a listItem is updated by operating over those resources using Microsoft Graph API.

Event name Description
Microsoft.Graph.ListUpdated Triggered when a list in Microsoft Sharepoint is updated.

Example event

When an event is triggered, the Event Grid service sends data about that event to subscribing destinations. This section contains an example of what that data would look like for each Microsoft Sharepoint event.

Microsoft.Graph.ListUpdated event

{
  "id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
  "type": "Microsoft.Graph.ListUpdated",
  "source": "/tenants/<tenant-id>/applications/<application-id>",
  "subject": "listItem/<listItem-id>",
  "time": "2022-05-24T22:24:31.3062901Z",
  "datacontenttype": "application/json",
  "specversion": "1.0",
  "data": {
    "subscriptionId": "<microsoft-graph-subscription-id>",
    "tenantId": "<tenant-id>",
    "clientState": "<user-provided secret>",
    "expirationDateTime": "2023-10-05T18:11:08.587Z",
    "resource": "<guid>",
    "siteUrl": "<relative path>",
    "webId": "<guid>",
    "resourceData": {
      "@odata.type": "#Microsoft.Graph.listItem"
    },    
  }
}

Event properties

An event has the following top-level data:

Property Type Description
source string The tenant event source. This field isn't writeable. Microsoft Graph API provides this value.
subject string Publisher-defined path to the event subject.
type string One of the event types for this event source.
time string The time the event is generated based on the provider's UTC time
id string Unique identifier for the event.
data object Event payload that provides the data about the resource state change.
specversion string CloudEvents schema specification version.

The data object has the following properties:

Property Type Description
changeType string The type of resource state change.
resource string The resource identifier for which the event was raised.
tenantId string The organization ID where the list is kept.
clientState string A secret provided by the user at the time of the Graph API subscription creation.
@odata.type string The Graph API change type.
@odata.id string The Graph API resource identifier for which the event was raised.
id string The resource identifier for which the event was raised.
subscriptionExpirationDateTime string The time in RFC 3339 format at which the Graph API subscription expires.
subscriptionId string The Graph API subscription identifier.
tenantId string The Microsoft Entra tenant identifier.

Next steps