Microsoft Copilot · Example Payload

Microsoft Copilot Copilotchangenotificationscreatesubscription Example

AgentsAI AssistantArtificial IntelligenceChatbotCopilotExtensibilityGenerative AIMicrosoft 365Productivity

Microsoft Copilot Copilotchangenotificationscreatesubscription Example is an example object payload from Microsoft Copilot, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "copilot.changeNotifications.createSubscription",
  "method": "POST",
  "path": "/subscriptions",
  "summary": "Microsoft Copilot Create Subscription for Copilot Interaction Notifications",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "copilotInteractionSubscription",
      "example": {
        "changeType": "created",
        "notificationUrl": "https://contoso.azurewebsites.net/api/notifications",
        "resource": "/copilot/interactionHistory/getAllEnterpriseInteractions",
        "expirationDateTime": "2025-04-01T11:00:00.0000000Z",
        "clientState": "secretClientState"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "201",
      "contentType": "application/json",
      "name": "CopilotChangenotificationsCreatesubscription201Example",
      "example": {
        "id": "abc123",
        "resource": "example_value",
        "changeType": "example_value",
        "notificationUrl": "https://www.example.com",
        "expirationDateTime": "2026-01-15T10:30:00Z",
        "clientState": "example_value"
      }
    }
  ]
}