Microsoft Graph Subscription

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://schema.api.gov/microsoft-graph/subscription",
  "title": "Microsoft Graph Subscription",
  "description": "Represents a subscription that allows a client application to receive change notifications about changes to data in Microsoft Graph. Applications create subscriptions specifying the resource to monitor, the types of changes to track, and a notification endpoint URL. When changes occur, Microsoft Graph sends HTTP POST notifications to the specified endpoint. Subscriptions have limited lifetimes that vary by resource type and must be renewed before expiration.",
  "type": "object",
  "required": [
    "changeType",
    "notificationUrl",
    "resource",
    "expirationDateTime"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the subscription. Read-only.",
      "readOnly": true,
      "examples": [
        "7f105c7d-2dc5-4530-97cd-4e7ae6534c07"
      ]
    },
    "resource": {
      "type": "string",
      "description": "Specifies the resource that is monitored for changes. Do not include the base URL (https://graph.microsoft.com/v1.0/). See the supported resource path values for each resource type.",
      "examples": [
        "me/mailFolders('Inbox')/messages",
        "users",
        "groups",
        "teams/allMessages",
        "chats/allMessages"
      ]
    },
    "changeType": {
      "type": "string",
      "description": "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.",
      "examples": [
        "created",
        "updated",
        "deleted",
        "created,updated",
        "created,updated,deleted"
      ]
    },
    "notificationUrl": {
      "type": "string",
      "format": "uri",
      "description": "The URL of the endpoint that receives the change notifications. This URL must use 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.",
      "pattern": "^https://"
    },
    "lifecycleNotificationUrl": {
      "type": ["string", "null"],
      "format": "uri",
      "description": "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 use the HTTPS protocol.",
      "pattern": "^https://"
    },
    "expirationDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "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. Any value under 45 minutes after the time of the request is automatically set to 45 minutes after the request time."
    },
    "clientState": {
      "type": ["string", "null"],
      "description": "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 values.",
      "maxLength": 128
    },
    "applicationId": {
      "type": ["string", "null"],
      "description": "Identifier of the application used to create the subscription. Read-only.",
      "readOnly": true
    },
    "creatorId": {
      "type": ["string", "null"],
      "description": "Identifier of the user or service principal that created the subscription. If the app used delegated permissions, this field contains the ID of the signed-in user. If application permissions were used, this contains the service principal ID. Read-only.",
      "readOnly": true
    },
    "includeResourceData": {
      "type": ["boolean", "null"],
      "description": "When set to true, change notifications include resource data (such as content of a chat message). Requires encryptionCertificate and encryptionCertificateId to be set."
    },
    "encryptionCertificate": {
      "type": ["string", "null"],
      "description": "A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications. Required when includeResourceData is true."
    },
    "encryptionCertificateId": {
      "type": ["string", "null"],
      "description": "A custom app-provided identifier to help identify the certificate needed to decrypt resource data."
    },
    "latestSupportedTlsVersion": {
      "type": ["string", "null"],
      "description": "Specifies the latest version of Transport Layer Security (TLS) that the notification endpoint supports.",
      "enum": ["v1_0", "v1_1", "v1_2", "v1_3", null]
    },
    "notificationQueryOptions": {
      "type": ["string", "null"],
      "description": "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."
    },
    "notificationUrlAppId": {
      "type": ["string", "null"],
      "description": "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."
    }
  }
}