subscription.md

title	description	ms.localizationpriority	author	doc_type	ms.subservice
subscription resource type	Represents a subscription that allows a client app to receive change notifications about changes to data in Microsoft Graph.	medium	keylimesoda	resourcePageType	change-notifications

subscription resource type

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

[!INCLUDE todo-deprecate-basetaskapi-sharedfeature]

Represents a subscription that allows a client app to receive change notifications about changes to data in Microsoft Graph.

For more information about subscriptions and change notifications, including resources that support change notifications, see Set up notifications for changes in resource data.

Methods

Method	Return Type	Description
List	subscription	List active subscriptions.
Create	subscription	Subscribe a listener application to receive change notifications when Microsoft Graph data changes.
Get	subscription	Read properties and relationships of subscription object.
Update	subscription	Renew a subscription by updating its expiration time.
Delete	None	Delete a subscription object.
Reauthorize	None	Reauthorize a subscription when you receive a reauthorizationRequired challenge.

Properties

Property	Type	Description
applicationId	String	Optional. Identifier of the application used to create the subscription. Read-only.
changeType	String	Required. Indicates the type of change in the subscribed resource that raises 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. Use updated to receive notifications when user or group is created, updated, or soft deleted. Use deleted to receive notifications when user or group is permanently deleted.
clientState	String	Optional. Specifies the value of the clientState property sent by the service in each change notification. The maximum length is 255 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.
creatorId	String	Optional. 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.
encryptionCertificate	String	Optional. A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications. Optional but required when includeResourceData is true.
encryptionCertificateId	String	Optional. A custom app-provided identifier to help identify the certificate needed to decrypt resource data. Required when includeResourceData is true.
expirationDateTime	DateTimeOffset	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. For the maximum supported subscription length of time, see Subscription lifetime.
id	String	Optional. Unique identifier for the subscription. Read-only.
includeResourceData	Boolean	Optional. When set to true, change notifications include resource data (such as content of a chat message).
latestSupportedTlsVersion	String	Optional. 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.
lifecycleNotificationUrl	String	Required for Teams resources if the expirationDateTime value is more than 1 hour from now; optional otherwise. The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved, reauthorizationRequired, and missed notifications. This URL must make use of the HTTPS protocol. For more information, see Reduce missing subscriptions and change notifications.
notificationContentType	String	Optional. Desired content-type for Microsoft Graph change notifications for supported resource types. The default content-type is application/json.
notificationQueryOptions	String	Optional. OData query options for specifying the value for the targeting resource. Clients receive notifications when the resource reaches the state matching the query options provided here. With this new property in the subscription creation payload along with all existing properties, Webhooks deliver notifications whenever a resource reaches the desired state mentioned in the notificationQueryOptions property. For example, when the print job is completed or when a print job resource isFetchable property value becomes true etc. Supported only for Universal Print Service. For more information, see Subscribe to change notifications from cloud printing APIs using Microsoft Graph.
notificationUrl	String	Required. The URL of the endpoint that receives the change notifications. This URL must make use of the HTTPS protocol. Any query string parameter included in the notificationUrl property is included in the HTTP POST request when Microsoft Graph sends the change notifications.
notificationUrlAppId	String	Optional. The app ID that the subscription service can use to generate the validation token. The value allows the client to validate the authenticity of the notification received.
resource	String	Required. Specifies the resource that is monitored for changes. Don't include the base URL (https://graph.microsoft.com/beta/). See the possible resource path values for each supported resource.

Subscription lifetime

Subscriptions have a limited lifetime. Apps need to renew their subscriptions before the expiration time; otherwise, they need to create a new subscription. Apps can also unsubscribe at any time to stop getting change notifications.

The following table shows the maximum expiration times for subscriptions per resource in Microsoft Graph.

[!INCLUDE change-notifications-subscription-lifetime]

Latency

[!INCLUDE change-notifications-delivery-latency]

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.subscription",
  "applicationId": "String",
  "changeType": "String",
  "clientState": "String",
  "creatorId": "String",
  "encryptionCertificate": "String",
  "encryptionCertificateId": "String",
  "expirationDateTime": "String (timestamp)",
  "id": "String (identifier)",
  "includeResourceData": "Boolean",
  "latestSupportedTlsVersion": "String",
  "lifecycleNotificationUrl": "String",
  "notificationContentType": "String",
  "notificationQueryOptions": "String",
  "notificationUrl": "String",
  "notificationUrlAppId": "String",
  "resource": "String"
}