Microsoft Copilot · Schema

SubscriptionRequest

AgentsAI AssistantArtificial IntelligenceChatbotCopilotExtensibilityGenerative AIMicrosoft 365Productivity

Properties

Name Type Description
changeType string The type of change to subscribe to.
notificationUrl string The URL to receive change notifications.
resource string The resource path to subscribe to. For Copilot interactions use /copilot/interactionHistory/getAllEnterpriseInteractions.
expirationDateTime string The date and time when the subscription expires.
clientState string Optional client state value included in each notification for validation.
View JSON Schema on GitHub

JSON Schema

microsoft-copilot-subscription-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "SubscriptionRequest",
  "type": "object",
  "properties": {
    "changeType": {
      "type": "string",
      "description": "The type of change to subscribe to."
    },
    "notificationUrl": {
      "type": "string",
      "description": "The URL to receive change notifications."
    },
    "resource": {
      "type": "string",
      "description": "The resource path to subscribe to. For Copilot interactions use /copilot/interactionHistory/getAllEnterpriseInteractions."
    },
    "expirationDateTime": {
      "type": "string",
      "description": "The date and time when the subscription expires."
    },
    "clientState": {
      "type": "string",
      "description": "Optional client state value included in each notification for validation."
    }
  }
}