Microsoft Office Integration · Schema
Subscription
An Office 365 Management Activity API subscription to a content type for receiving audit activity data.
Microsoft 365Microsoft Office IntegrationOffice 365
Properties
| Name | Type | Description |
|---|---|---|
| contentType | string | The content type of the subscription. |
| status | string | The status of the subscription. |
| webhook | objectnull | The webhook configuration associated with the subscription. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "subscription.json",
"title": "Subscription",
"description": "An Office 365 Management Activity API subscription to a content type for receiving audit activity data.",
"type": "object",
"properties": {
"contentType": {
"type": "string",
"description": "The content type of the subscription.",
"enum": [
"Audit.AzureActiveDirectory",
"Audit.Exchange",
"Audit.SharePoint",
"Audit.General",
"DLP.All"
]
},
"status": {
"type": "string",
"description": "The status of the subscription.",
"enum": ["enabled", "disabled"]
},
"webhook": {
"type": ["object", "null"],
"description": "The webhook configuration associated with the subscription.",
"properties": {
"status": {
"type": "string",
"description": "The status of the webhook.",
"enum": ["enabled", "disabled", "expired"]
},
"address": {
"type": "string",
"format": "uri",
"description": "The HTTPS endpoint that receives notifications."
},
"authId": {
"type": "string",
"description": "String included as Webhook-AuthID header in notifications."
},
"expiration": {
"type": ["string", "null"],
"format": "date-time",
"description": "Datetime after which notifications are no longer sent to the webhook."
}
},
"required": ["status", "address"]
}
},
"required": ["contentType", "status"]
}