subscription resource type

Namespace: microsoft.graph

A subscription allows a client app to receive change notifications about changes to data in Microsoft Graph. Currently, subscriptions are enabled for the following resources:

  • An alert from the Microsoft Graph Security API
  • A callRecord produced after a call or meeting in Microsoft Teams
  • A conversation in a Microsoft 365 group
  • Content in the hierarchy of a root folder driveItem in OneDrive for Business, or of a root folder or subfolder driveItem in a user's personal OneDrive
  • A list under a SharePoint site
  • A message, event, or contact in Outlook
  • A user or group in Azure Active Directory

See Use the Microsoft Graph API to get change notifications for the possible resource path values for each supported resource.

Methods

Method Return Type Description
Create subscription subscription Subscribes a listener application to receive change notifications when Microsoft Graph data changes.
Update subscription subscription Renews a subscription by updating its expiration time.
List subscriptions subscription Lists active subscriptions.
Get subscription subscription Reads properties and relationships of subscription object.
Delete subscription None Deletes a subscription object.

Properties

Property Type Description
changeType string Required. Indicates the type of change in the subscribed resource that will raise a change notification. The supported values are: created, updated, deleted. Multiple values can be combined using a comma-separated list.

Note: Drive root item and list change notifications support only the updated changeType. User and group change notifications support updated and deleted changeType.
notificationUrl string Required. The URL of the endpoint that will receive the change notifications. This URL must make use of the HTTPS protocol.
resource string Required. Specifies the resource that will be monitored for changes. Do not include the base URL (https://graph.microsoft.com/v1.0/). See the possible resource path values for each supported resource.
expirationDateTime dateTime Required. Specifies the date and time when the webhook subscription expires. The time is in UTC, and can be an amount of time from subscription creation that varies for the resource subscribed to. See the table below for maximum supported subscription length of time.
clientState string Optional. Specifies the value of the clientState property sent by the service in each change notification. The maximum length is 128 characters. The client can check that the change notification came from the service by comparing the value of the clientState property sent with the subscription with the value of the clientState property received with each change notification.
id string Unique identifier for the subscription. Read-only.
applicationId string Identifier of the application used to create the subscription. Read-only.
creatorId string Identifier of the user or service principal that created the subscription. If the app used delegated permissions to create the subscription, this field contains the id of the signed-in user the app called on behalf of. If the app used application permissions, this field contains the id of the service principal corresponding to the app. Read-only.
latestSupportedTlsVersion String Specifies the latest version of Transport Layer Security (TLS) that the notification endpoint, specified by notificationUrl, supports. The possible values are: v1_0, v1_1, v1_2, v1_3.
For subscribers whose notification endpoint supports a version lower than the currently recommended version (TLS 1.2), specifying this property by a set timeline allows them to temporarily use their deprecated version of TLS before completing their upgrade to TLS 1.2. For these subscribers, not setting this property per the timeline would result in subscription operations failing.

For subscribers whose notification endpoint already supports TLS 1.2, setting this property is optional. In such cases, Microsoft Graph defaults the property to v1_2.

Maximum length of subscription per resource type

Resource Maximum expiration time
User, group, other directory resources 4230 minutes (under 3 days)
Mail 4230 minutes (under 3 days)
Calendar 4230 minutes (under 3 days)
Contacts 4230 minutes (under 3 days)
Group conversations 4230 minutes (under 3 days)
Drive root items 4230 minutes (under 3 days)
SharePoint list 4230 minutes (under 3 days)
Teams callRecord 4230 minutes (under 3 days)
Security alerts 43200 minutes (under 30 days)

Note: Existing applications and new applications should not exceed the supported value. In the future, any requests to create or renew a subscription beyond the maximum value will fail.

Relationships

None

JSON representation

Here is a JSON representation of the resource.

{
  "changeType": "string",
  "notificationUrl": "string",
  "resource": "string",
  "applicationId" : "string",
  "expirationDateTime": "String (timestamp)",
  "id": "string (identifier)",
  "clientState": "string",
  "creatorId": "string",
  "latestSupportedTlsVersion": "string"
}