Home > Configure System Settings > Workspace and Service Management
Export to PDFWorkspace and service management provides centralized settings to control how workspaces and services are configured, secured, and maintained in AvePoint Cloud Governance. These options allow administrators to manage authentication, notifications, integrations, metadata, reporting, and advanced workspace behaviors to ensure consistent governance and efficient administration across the environment.
To consume AvePoint Cloud Governance API, you need an access token. An access token can be generated via a client ID and a client secret. To obtain a client ID and a client secret, configure an API authentication profile. To manage API authentication profiles, click the API authentication profiles card on the System settings page and go to the API authentication profiles page.
To create API authentication profiles, click Create on the ribbon, and then configure the following settings:
When you finish, click Save to save all your configurations.
After you click Save, the Note window appears for you to view the API authentication details. Note that the client secret will only be displayed one time, and you cannot retrieve it after you close the window. You can click the copy (
) button to copy the client secret to your clipboard.
With the client ID and client secret, you can generate an access token to call the AvePoint Cloud Governance API. For details, see AvePoint Cloud Governance API.
Administrator notification allows you to configure a notification to inform the administrator contact if any service request encounter an error.
To configure administrator notification settings, click the Administrator notification card on the System settings page, and complete the following configurations:
Click Save to save the configurations.
You can manage the state and related tasks of archived teams. To configure the setting for managing the archived teams, click Archived team governance card on the System settings page, you can choose to turn on or off the Enable archived team governance toggle. Note that the setting only takes effect on teams that have applied modern team renewal profiles.
Click Save to save all your configurations.
You can manage the scope of provisioning services and questionnaires that are available for users when they click Create a workspace. To manage available services/questionnaires, click the Available services/questionnaires card on the System settings page. Then, complete the following steps:
Select one or more services and questionnaires under the various categories, and your selected services and questionnaires will be available after users click Create a workspace. You can click Select all to select all services and questionnaires under each category, as well as click Clear all to deselect all selected services and questionnaires.
*Note: If there are no available services and questionnaires in this setting, you can go to configure the services and questionnaires in the classic Cloud Governance admin center at first.
Click Save to save your configurations.
Note the following:
You can configure to show a confirmation pop-up before executing bulk actions in the Workspace report, highlighting the object count that will be affected by the actions. To configure the bulk action confirmation, click the Bulk action confirmation card on the System settings page.
To enable the bulk action confirmation, turn on the Show a confirmation pop-up with the selected object count before executing action in workspace report toggle, and enter a number as the confirmation threshold. Bulk action confirmations will be shown when the number of affected objects for the action exceed the entered number.
When you finish, click Save to save your configurations.
You can manage categories which are used to organize services, approval processes, policies, questionnaires, etc., into logical groupings. To manage categories, click the Category management card on the System settings page and go to the Category management page.
To create categories, click Create on the ribbon, and then configure the following settings:
When you finish, click Save to save your configurations.
To configure whether to allow channels to follow the settings of the policy or profile of their parent teams, click the Channel settings card on the System settings page to open the Channel settings panel. In this panel, you can configure settings for private channels and shared channels.
Select the corresponding checkboxes in the Private channel settings or Shared channel settings section if you want to allow channels to follow the external sharing settings, access settings, or site storage of their parent teams, and click Save to save your configurations.
For site collections, Microsoft 365 Groups, Microsoft Entra groups, teams, Viva Engage communities, guest users, shared mailboxes, and Power BI workspaces managed by AvePoint Cloud Governance, you can now configure the automatic management of the contact membership through the management process in Cloud Governance. To manage the contact membership, click the Contact membership card on the System settings page. In the Contact membership panel, configure the following settings:
When you finish, click Save to save all your configurations.
To configure Microsoft 365 Groups or Microsoft Teams advanced settings, such as classification or restriction of the group or team provisioning, click the Group/Team advanced settings card on the System settings page to open the Microsoft 365 Groups/Microsoft Teams advancedsettings panel. Then, configure the following settings in the panel:
When you finish, click Save to save all your configurations.
AvePoint Cloud Governance uses Microsoft Graph API as the default and recommended method for Microsoft 365 Groups and Microsoft Teams provisioning and management. However, you can choose to use Exchange Web Services API in the classic Cloud Governance admin center if you have the following requirements for group/team management:
For more details, refer to Appendix H - About Microsoft Graph API (Recommended Method for Microsoft 365 Groups and Microsoft Teams Management) and Appendix I - About Exchange Web Services API.
With impersonation accounts configured, AvePoint Cloud Governance will use the credentials of the impersonation accounts to invoke the Exchange Web Services API and manage groups/teams. To configure impersonation accounts to enable Exchange Web Services API, click the Impersonation account card on the System settings page.
In the Impersonation account panel, turn on the toggle (
) for the tenant that you want to enable the impersonation account, and then configure the following settings:
*Note: To ensure your Microsoft 365 tenant can be retrieved, a Microsoft 365 (All permissions) app profile must be created in AvePoint Online Services > Management > App management.
When you finish, click Save to save your configurations.
You can define the news and updates that are shown to end users in the portal. To configure news and updates, click the News & updates card on the System settings page, and complete the following configurations in the News & updates panel:
When you finish, click Save to save your configurations.
By default, workspace metadata is saved in the workspace-connected site property bag. Open extensions provide an efficient way of retrieving metadata for AvePoint Online Services Auto Discovery and Cloud Governance management processes. For more instructions about open extensions, refer to What are open extensions.
To optimize the performance of retrieving metadata, click the Open extensions configuration card on the System settings page. In the Open extensions configuration page, you can choose to Save metadata in the site property bag and as open extensions to the group resource, then click Save. Note the following if you choose to sync metadata as open extensions to the group resource:
If you want to sync existing workspace metadata as open extensions to the group resource and immediately start the sync process, complete the following steps:
Click Add to open the Add metadata panel.
Select one or more metadata and click Add to list.
Note the following:
You can add up to 10 metadata to the list.
The table below lists the metadata types that can be synced to open extension and how metadata values are stored:
| Metadata Type | Sample Metadata Value | Sample Extension Value |
|---|---|---|
| Yes/No (checkbox) | Yes | 1 |
| Yes/No (checkbox) | No | 0 |
| Choice (menu to choose from) | Value | Value |
| Choice (checkbox) | Value 1,Value 2 | Value 1;Value 2 |
| Managed metadata (single value) | Term 1 | Term 1 |
| Managed metadata (multiple values) | Term 1,Term 2 | Term 1;Term 2 |
| Microsoft Entra property (text) | Value | Value |
| Microsoft Entra property (user) | {User login name} | {User login name} |
Integration with AvePoint Insights will retrieve user and group permissions on demand for newly generated workspace renewal tasks. This integration will ensure the renewal task assignees are always reviewing the latest permissions changes when completing the workspace renewal tasks. To enable integration with Insights, click the Renewal permission index card on the System settings page.
For the tenants that you want to enable the site permission index for workspace renewals with Insights, turn on the toggle (
) for the tenants and click Save when you finish your configuration. With the option enabled, the renewal process will have an updated user experience and additional configuration options available.
Note the following if you want to enable the renewal permission index with Insights:
By default, AvePoint Cloud Governance retains up to two years of report data displayed in the workspace management timeline and four years of request data displayed in the request report. You can also customize the retention period for report data. If you want to store historical report data older than the retention period, select a storage location to automatically archive the data.
To manage Report data retention management, click the Report data retention management card on the System settings page, and then complete the following configurations:
When you finish, click Save to save your configurations.
To delegate out the management of workspaces to help balance the management workload, you can share the report in the Cloud Governance admin center to end users by configuring a report permission group and granting specific report permissions to the group. Users in the group can access the report and perform allowed management actions based on applied permissions. To create the group, click the Report permission group card on the System settings page.
To create a report permission group, click Create on the ribbon to open the Create group panel and configure the following settings:
Name – Enter a name for the group.
Description – Enter an optional description for the group.
Group owner – Specify one or more users to be the group owner.
User condition – Configure conditions to dynamically choose what users are included in the group by clicking Add condition. Then, complete the following steps in the Add condition panel:
Select one of the following conditions:
Microsoft 365 users/groups – Microsoft 365 users or users in specific Microsoft 365 Groups will be included in the group.
Microsoft Entra property – Users whose Microsoft Entra property values match specific values will be included in the group.
Then, configure the Allowed values for the corresponding condition:
If you select Microsoft 365 users/groups as the condition, enter the usernames or group names in the text box, and then select your desired one from the suggested values.
If you select Microsoft Entra property as the condition, select a Microsoft 365 tenant first. Select from the Built-in properties or Custom properties, and then enter property values in the text box. If you enter multiple values, make sure to separate each value with a semicolon.
Click Save to save your configurations.
You can add multiple conditions to the table. If you add multiple conditions, choose one of the following options to define the logic option for these conditions:
Match any single condition – If you choose this option, the users who conform to any of the conditions in the table will be included in the group.
Match all conditions – If you choose this option, the users who conform to all conditions in the table will be included in the group.
Report permission – Assign report permissions to the group to determine what actions users can execute by clicking Add permission. Then, complete the following steps in the Add permission panel. Note that a group can have only one permission to a report.
Report – Select a report that users can access.
Report view – Click Add view to select built-in or published views that users can access in the Add view panel, and then click Save to save the configurations.
Allowed action – Select the report actions that users in the group are allowed to execute in the report.
Click Save to save the permissions.
Click Save to save your configurations.
You can enable the integration with sensitivity labels for site collections, Microsoft 365 Groups, and Microsoft Teams in your organization that are managed by Cloud Governance. Integration with sensitivity labels will allow the Create Team, Create Group, Create Site Collection, and Create Viva Engage Community services to leverage these labels when a business user submits the request form. To enable the sensitivity label integration, click the Sensitivity labels card on the System settings page.
For the tenants that you want to enable the integration with sensitivity labels, turn on the toggle (
) for the tenants and click Save when you finish your configuration. If you want to enable sensitivity labels, the Microsoft Entra ID Premium license is required in your tenant.
With the sensitivity labels enabled, note the following:
You can define whether to automatically grant the "Send as" permission to shared mailbox members in shared mailbox related services, renewal, and settings. To configure shared mailbox delegate settings, click the Shared mailbox delegate settings card on the System settings page. Then, you can choose to turn on or off the Automatically grant the "Send as" permission to shared mailbox members toggle.
Click Save to save all your configurations.
The Site Information Card App allows business users to view governance details and initiate service requests directly within their Microsoft 365 workspace through a redesigned, in-context information card.
Note the following:
To configure what information will be displayed on the Site Information Card App, click the Site Information Card management card on the System settings page. In the Site Information Card management panel, select the information to display for site collections, Microsoft 365 Groups, Microsoft Teams, and Viva Engage communities:
To display all information above in the Site Information Card, select Select all.
Click Save to save your configurations.
Complete the following steps to install the Site Information Card App:
If your tenant has installed the classic Cloud Governance Panel App, uninstall it first before installing the upgraded Site Information Card App using the following steps. Otherwise, you can go to step 2 directly.
Go to the More features page in the SharePoint admin center and select Open under Apps. The Manage apps page appears.
Select the Cloud Governance Panel App and click Delete on the ribbon.
*Note: Make sure that you delete the correct app with one of the following product ID:
A0B9484F-DB7D-48C1-A074-D702FFECA74F
8142967A-1048-4DC0-A0B1-87E17AC181B1
If you cannot find the product ID column from the table, click Apps > Add or remove fields in the upper-right corner of the table, select Product ID, and click Apply.
Install the Site Information Card App and approve required permission.
Download the app package via the following links based on the Cloud Governance environment you are using:
*Note: The product ID of the downloaded app is 8142967A-1048-4DC0-A0B1-87E17AC181B1.
| Environment | Download link | Version | Released Time |
|---|---|---|---|
| Commercial Production Environment | ModernSitePanelExtension_Commercial.sppkg | 2.0.0.3 | January 2026 |
| Microsoft 365 US Government GCC Environment | ModernSitePanelExtension_GovProd_GCC.sppkg | 2.0.0.3 | January 2026 |
| Microsoft 365 US Government GCC High Environment | ModernSitePanelExtension_GovProd_GCCH.sppkg | 2.0.0.3 | January 2026 |
| 21Vianet Production Environment | ModernSitePanelExtension_21v_Prod.sppkg | 2.0.0.3 | January 2026 |
| PH Production GCC Environment | ModernSitePanelExtension_PH_Prod_GCC.sppkg | 2.0.0.0 | June 2025 |
| PH Production GCC High Environment | ModernSitePanelExtension_PH_Prod_GCCH.sppkg | 2.0.0.0 | June 2025 |
Download the new app package using the download link in the Install Site Information Card App section above. You can optionally customize the Site Information Card icon with instructions in the section.
Upload the new app package and approve required permission.
Go to the More features page in the SharePoint admin center and select Open under Apps. The Manage apps page appears.
Click Upload on the ribbon, select the new app package, and click Open to upload the package.
A window appears reminding that a file with the same name already exists. Click Replace in the window.
After the app is successfully uploaded, the Enable app panel appears.
Select Enable this app and add it to all sites and click Enable app.
The Approve access so this app works as designed panel appears, click Go to API access page.
In Pending requests > Organization-wide, select the cloudgovernance_users_impersonation permission and click Approve on the ribbon.
You can set custom site collection locked messages by configuring the header and/or footer, which will be displayed on modern pages in locked site collections. To customize site collection lock messages, click the Site collection lock messages card. Then, complete the following steps:
Turn on the toggle (
) to Show custom site collection lock messages on locked site collections. Note that make sure the app catalog site collection has already been configured in a tenant. Once configured, AvePoint Cloud Governance will deploy a tenant level app, AvePoint Cloud Governance Customized Site Banner, to the app catalog site collection. For detailed instructions, see Use the site collection app catalog. Then, configure the following settings:
Header and footer messages – Customize the header and footer messages to your desired languages by performing the following steps:
Click the edit (
) button of your desired languages.
In the Edit message panel, enter the custom content in the text box to customize the header and footer messages that will be displayed on your site collections. You can insert one or more of the following references to be included in the lock messages by clicking Insert reference: Lock reason, Lock time (UTC), Primary contact, Secondary contact, Administrator contact, and Locked by.
Click Save to save the messages.
Default language – Select a default language. Only the languages that have been enabled (
) are available to be selected. When SharePoint’s display language is not among any of the eight languages, the header/footer messages will be shown in the default language.
Background color of header and footer – There is a default color with the hex triplet in the text box. You can enter the custom hex triplet in the text box, and the header/footer will be displayed in your custom color.
Choose whether to Show custom lock messages on the classic site pages. With the checkbox selected, note the following:
The footer message is not supported on the classic site pages. The footer message that you configured will be shown in the header as well.
The custom background color of the header is not supported on the classic site pages. The default background color is yellow.
Click Save to save all your configurations.
You can configure a webhook to listen for specific events in AvePoint Cloud Governance. AvePoint Cloud Governance will send a request with data to the webhook URL that you specify when an event happens.
For details on how to prepare a webhook URL, see the instructions in How to Integrate Webhooks Into ServiceNow and Add an incoming webhook to a Teams channel as examples.
To configure the webhooks, click the Webhook Management card on the System settings page. Click Create and then configure the following settings:
Name ‒ Enter the name and for the webhook.
Description ‒ Enter an optional description for the webhook.
Webhook URL ‒ Enter the URL of your webhook. AvePoint Cloud Governance will send a request with data to this URL to trigger the webhook.
HTTP header – Add one or more HTTP headers to be sent with the request. Enter a secret token and it will be sent with the request in the X-CloudGovernance-Token HTTP / HTTPS header. Your webhook endpoint can check the token to verify that the request is legitimate.
To add an HTTP header, click Add custom header, and configure the following information in the Add custom header panel.
HTTP Header – Enter the HTTP header.
Header value – Enter the HTTP header value.
Choose whether to Encrypt sensitive data.
Action execution method ‒ Select a method to execute the actions in AvePoint Cloud Governance.
Asynchronous ‒ When you select the asynchronous method, Cloud Governance will continue executing the actions after sending the request to the webhook URL.
Synchronous ‒ When you select the synchronous method, Cloud Governance will not continue executing the actions until the custom actions defined in the webhook URL have been completed.
Trigger ‒ Select the AvePoint Cloud Governance events whose occurrence will trigger this webhook.
Request related events
When a request is submitted
When a request is completed
When a request is canceled
Limit the services that can trigger the webhooks – When you select at least one request-related event, you can choose whether to limit the services that can trigger the webhooks. With this option selected, you can limit Cloud Governance to only send request events for services that are added to the list.
Task related events
When an approval task is assigned
When a request is approved
When a request is rejected
When an error task is generated
When an error task is retried
When an error task is skipped
Renewal process related events
When a renewal task is completed
When a renewal process encounters exception
When a renewal task is overdue
Automated import process related events
When an import process with predefined governance details is completed
When an end user completes a confirm governance details task
Election process related events
When an election process is completed or a contact is manually specified
When all stages of an election process are overdue
After creating a webhook, you can test the validity of the webhook that you configured. To test the webhook, complete the following steps:
In the Webhook Management list, select a webhook, and then click Test on the ribbon.
In the Test panel, select an event type test your webhook.
Click Test trigger a test for your webhook immediately.
You can also configure anomaly monitoring of the webhook that you configured. To configure anomaly monitoring for the webhook, complete the following steps:
In the Webhook Management list, select a webhook, and then click Anomaly monitoring on the ribbon.
In the Anomaly monitoring panel, specify the number of times for communication failures to automatically stop sending messages to the webhook URL.
Choose whether to Send an email notification.
Click Save to save the configurations.
After you configure a webhook, when the event occurs in Cloud Governance, your webhook endpoint will receive the event relevant data returned by Cloud Governance. Refer to the tables in the sections below for detailed information about the data.
| Property | Description | Type | Sample Data |
|---|---|---|---|
| TriggerType | This webhook will be triggered when a request is submitted in Cloud Governance. | String | RequestSubmitted |
| TriggerTime | The time that the webhook is triggered. | DateTime | 2020-09-04T02:20:03Z |
| ObjectUrl | The URL of the workspace that is requested to be managed. | String | https://contoso.com/sites/marketing |
| Summary | The request summary. | String | I submit this request to create a site collection. |
| ServiceType | The type of the service that is used to submit this request. | String | Create Site Collection |
| RequestId | The ticket number of the request. | Int32 | 2155 |
| RequestGuid | The unique ID of the request. | Guid | e3b273a1-3838-4470-a0d4-f84f6c4a3dda |
| Requester | The display name of the requester. | String | Megan Bowen |
| RequesterIdentityName | The user principal name of the requester. | String | MeganB@contoso.com |
| ServiceName | The name of the service that is used to submit this request. | String | Create Site Collection Service |
| ServiceId | The unique ID of the service that is used to submit this request. | Guid | b3e20d7d-e770-4382-a290-f157b346eb21 |
| Property | Description | Type | Sample Data |
|---|---|---|---|
| TriggerType | This webhook will be triggered when a submitted request is completed in Cloud Governance. | String | RequestCompleted |
| TriggerTime | The time that the webhook is triggered. | DateTime | 2020-09-04T02:20:03Z |
| ObjectUrl | The URL of the workspace that is requested to be managed. | String | https://contoso.com/sites/marketing |
| Summary | The request summary. | String | I submit this request to create a site collection. |
| ServiceType | The type of the service that is used to submit this request. | String | Create Site Collection |
| RequestId | The ticket number of the request. | Int32 | 2155 |
| RequestGuid | The unique ID of the request. | Guid | e3b273a1-3838-4470-a0d4-f84f6c4a3dda |
| Requester | The display name of the requester. | String | Megan Bowen |
| RequesterIdentityName | The user principal name of the requester. | String | MeganB@contoso.com |
| ServiceName | The name of the service that is used to submit this request. | String | Create Site Collection Service |
| ServiceId | The unique ID of the service that is used to submit this request. | Guid | b3e20d7d-e770-4382-a290-f157b346eb21 |
| Property | Description | Type | Sample Data |
|---|---|---|---|
| TriggerType | This webhook will be triggered when a submitted request is canceled in Cloud Governance. | String | RequestCancelled |
| TriggerTime | The time that the webhook is triggered. | DateTime | 2020-09-04T02:20:03Z |
| ObjectUrl | The URL of the workspace that is requested to be managed. | String | https://contoso.com/sites/marketing |
| Summary | The request summary. | String | I submit this request to create a site collection. |
| ServiceType | The type of service that is used to submit this request. | String | Create Site Collection |
| RequestId | The ticket number of the request. | Int32 | 2155 |
| RequestGuid | The unique ID of the request. | Guid | e3b273a1-3838-4470-a0d4-f84f6c4a3dda |
| Requester | The display name of the requester. | String | Megan Bowen |
| RequesterIdentityName | The user principal name of the requester. | String | MeganB@contoso.com |
| ServiceName | The name of the service that is used to submit this request. | String | Create Site Collection Service |
| ServiceId | The unique ID of the service that is used to submit this request. | Guid | b3e20d7d-e770-4382-a290-f157b346eb21 |
| Property | Description | Type | Sample Data |
|---|---|---|---|
| TriggerType | This webhook will be triggered when an approval task is assigned in Cloud Governance. | String | TaskCreated |
| TriggerTime | The time that the webhook is triggered. | DateTime | 2020-09-04T02:20:03Z |
| ObjectUrl | The URL of the workspace that is requested to be managed. | String | https://contoso.com/sites/marketing |
| Summary | The request summary. | String | I submit this request to create a site collection. |
| ServiceType | The type of service that is used to submit this request. | String | Create Site Collection |
| RequestId | The ticket number of the request. | Int32 | 2155 |
| RequestGuid | The unique ID of the request. | Guid | e3b273a1-3838-4470-a0d4-f84f6c4a3dda |
| Requester | The display name of the requester. | String | Megan Bowen |
| RequesterIdentityName | The user principal name of the requester. | String | MeganB@contoso.com |
| Message | Not Applicable | String | |
| AssigneeDisplayName | The display name of the task assignee. | String | Alex Wilber |
| AssigneeIdentityName | The user principal name of the task assignee. | String | AlexW@contoso.com |
| TaskId | The unique ID of the task. | Guid | be28f54-0f6f-48be-ad2c-515aed7272d5 |
| TaskLink | The link of the task. | String | https://myhub.avepointonlineservices.com /#/tasks/filters?batchId=abe28f54-0f6f-48be-ad2c-515aed7272d5 |
| Property | Description | Type | Sample Data |
|---|---|---|---|
| TriggerType | This webhook will be triggered when a submitted request is approved. | String | TaskApproved |
| TriggerTime | The time that the webhook is triggered. | DateTime | 2020-09-04T02:31:26Z |
| ObjectUrl | The URL of the workspace that is requested to be managed. | String | https://contoso.com/sites/marketing |
| Summary | The request summary. | String | I submit this request to create a site collection. |
| ServiceType | The type of service that is used to submit this request. | String | Create Site Collection |
| RequestId | The ticket number of the request. | Int32 | 2215 |
| RequestGuid | The unique ID of the request. | Guid | e3b273a1-3838-4470-a0d4-f84f6c4a3dda |
| Requester | The display name of the requester. | String | Megan Bowen |
| RequesterIdentityName | The user principal name of the requester. | String | MeganB@contoso.com |
| Message | Not Applicable | String | |
| AssigneeDisplayName | The display name of the task assignee. | String | Alex Wilber |
| AssigneeIdentityName | The user principal name of the task assignee. | String | AlexW@contoso.com |
| TaskId | The unique ID of the task. | Guid | be28f54-0f6f-48be-ad2c-515aed7272d5 |
| TaskLink | The link of the task. | String | https://myhub.avepointonlineservices.com /#/tasks/filters?batchId=abe28f54-0f6f-48be-ad2c-515aed7272d5 |
| ApproverDisplayName | The display name of the approver. | String | Alex Wilber |
| ApproverIdentityName | The user principal name of the approver. | String | AlexW@contoso.com |
| Property | Description | Type | Sample Data |
|---|---|---|---|
| TriggerType | This webhook will be triggered when a request is rejected. | String | TaskRejected |
| TriggerTime | The time that the webhook is triggered. | DateTime | 2020-09-04T02:31:26Z |
| ObjectUrl | The URL of the workspace that is requested to be managed. | String | https://contoso.com/sites/marketing |
| Summary | The request summary. | String | I submit this request to change the site collection contacts. |
| ServiceType | The type of service that is used to submit this request. | String | Change Site Collection Contact or Administrator |
| RequestId | The ticket number of the request. | Int32 | 2155 |
| RequestGuid | The unique ID of the request. | Guid | e3b273a1-3838-4470-a0d4-f84f6c4a3dda |
| Requester | The display name of the requester. | String | Megan Bowen |
| RequesterIdentityName | The user principal name of the requester. | String | MeganB@contoso.com |
| Message | The approver’s comment. | String | I do not agree to change the site collection contacts. |
| AssigneeDisplayName | The display name of the task assignee. | String | Alex Wilber |
| AssigneeIdentityName | The user principal name of the task assignee. | String | AlexW@contoso.com |
| TaskId | The unique ID of the task. | Guid | be28f54-0f6f-48be-ad2c-515aed7272d5 |
| TaskLink | The link of the task. | String | https://myhub.avepointonlineservices.com/#/tasks/filters?batchId=abe28f54-0f6f-48be-ad2c-515aed7272d5 |
| ApproverDisplayName | The display name of the approver. | String | Alex Wilber |
| ApproverIdentityName | The user principal name of the approver. | String | AlexW@contoso.com |
| Property | Description | Type | Sample Data |
|---|---|---|---|
| TriggerType | This webhook will be triggered when an error task is generated. | String | ErrorTaskCreated |
| TriggerTime | The time that the webhook is triggered. | DateTime | 2020-09-04T02:20:03Z |
| ObjectUrl | The URL of the workspace that is requested to be managed. | String | https://contoso.com/sites/marketing |
| Summary | The request summary. | String | I submit this request to create a site collection. |
| ServiceType | The type of service that is used to submit this request. | String | Create Site Collection |
| RequestId | The ticket number of the request. | Int32 | 2155 |
| RequestGuid | The unique ID of the request. | Guid | e3b273a1-3838-4470-a0d4-f84f6c4a3dda |
| Requester | The display name of the requester. | String | Megan Bowen |
| RequesterIdentityName | The user principal name of the requester. | String | MeganB@contoso.com |
| Message | The error details of the error task. | String | Cannot find the assignee. The user does not exist or is disabled. |
| AssigneeDisplayName | The display name of the task assignee. | String | Megan Bowen |
| AssigneeIdentityName | The user principal name of the task assignee. | String | MeganB@contoso.com |
| TaskId | The unique ID of the error task. | Guid | be28f54-0f6f-48be-ad2c-515aed7272d5 |
| TaskLink | The link of the error task. | String | https://myhub.avepointonlineservices.com/#/tasks/filters?batchId=abe28f54-0f6f-48be-ad2c-515aed7272d5 |
| Property | Description | Type | Sample Data |
|---|---|---|---|
| TriggerType | This webhook will be triggered when an error task is retried. | String | TaskRetried |
| TriggerTime | The time that the webhook is triggered. | DateTime | 2020-09-04T02:31:26Z |
| ObjectUrl | The URL of the workspace that is requested to be managed. | String | https://contoso.com/sites/marketing |
| Summary | The request summary. | String | I submit this request to create a site collection. |
| ServiceType | The type of service that is used to submit this request. | String | Create Site Collection |
| RequestId | The ticket number of the request. | Int32 | 2155 |
| RequestGuid | The unique ID of the request. | Guid | e3b273a1-3838-4470-a0d4-f84f6c4a3dda |
| Requester | The display name of the requester. | String | Megan Bowen |
| RequesterIdentityName | The user principal name of the requester. | String | MeganB@contoso.com |
| Message | Not Applicable | String | |
| AssigneeDisplayName | The display name of the task assignee. | String | Alex Wilber |
| AssigneeIdentityName | The user principal name of the task assignee. | String | AlexW@contoso.com |
| TaskId | The unique ID of the task. | Guid | be28f54-0f6f-48be-ad2c-515aed7272d5 |
| TaskLink | The link of the task. | String | https://myhub.avepointonlineservices.com/#/tasks/filters?batchId=abe28f54-0f6f-48be-ad2c-515aed7272d5 |
| ApproverDisplayName | The display name of the approver. | String | Alex Wilber |
| ApproverIdentityName | The user principal name of the approver. | String | AlexW@contoso.com |
| Property | Description | Type | Sample Data |
|---|---|---|---|
| TriggerType | This webhook will be triggered when an error task is skipped. | String | TaskSkipped |
| TriggerTime | The time that the webhook is triggered. | DateTime | 2020-09-04T02:31:26Z |
| ObjectUrl | The URL of the workspace that is requested to be managed. | String | https://contoso.com/sites/marketing |
| Summary | The request summary. | String | I submit this request to create a site collection. |
| ServiceType | The type of service that is used to submit this request. | String | Create Site Collection |
| RequestId | The ticket number of the request. | Int32 | 2155 |
| RequestGuid | The unique ID of the request. | Guid | e3b273a1-3838-4470-a0d4-f84f6c4a3dda |
| Requester | The display name of the requester. | String | Megan Bowen |
| RequesterIdentityName | The user principal name of the requester. | String | MeganB@contoso.com |
| Message | Not Applicable | String | |
| AssigneeDisplayName | The display name of the task assignee. | String | Alex Wilber |
| AssigneeIdentityName | The user principal name of the task assignee. | String | AlexW@contoso.com |
| TaskId | The unique ID of the task. | Guid | be28f54-0f6f-48be-ad2c-515aed7272d5 |
| TaskLink | The link of the task. | String | https://myhub.avepointonlineservices.com/#/tasks/filters?batchId=abe28f54-0f6f-48be-ad2c-515aed7272d5 |
| ApproverDisplayName | The display name of the approver. | String | Alex Wilber |
| ApproverIdentityName | The user principal name of the approver. | String | AlexW@contoso.com |
| Property | Description | Type | Sample Data |
|---|---|---|---|
| TriggerType | This webhook will be triggered when a workspace reaches its inactivity threshold. | String | LifecycleInactiveTaskCreated |
| TaskType | The type of the task. | String | GroupInactivityThreshold |
| TriggerTime | The time that the webhook is triggered. | DateTime | 2020-09-04T02:31:26Z |
| ObjectUrl | The URL of the workspace. | String | https://contoso.com/sites/marketing |
| ObjectType | The type of the workspace. | String | Microsoft 365 Group |
| ObjectId | The unique ID of the workspace. | Guid | 379ff54e-b062-40ea-bceb-a6f13c50a054 |
| ObjectTitle | The name of the workspace. | String | Marketing |
| GroupEmail | The email address of the workspace. | String | marketing@contoso.com |
| TaskLink | The link of the inactivity threshold task. | String | |
| ReachedTime | The time that the workspace inactivity threshold reaches. | DateTime | 2020-09-04T02:31:26Z |
| PolicyId | The ID of the policy. | Guid | 81bbf505-0718-4c6a-a25a-170a03346ea8 |
| PolicyName | The name of the policy. | String | GroupPolicy |
| Assignee | The username of the task assignee. | String | MeganB@contoso.com |
| Property | Description | Type | Sample Data |
|---|---|---|---|
| TriggerType | This webhook will be triggered when the workspace lease expires. | String | LifecycleLeaseTaskCreated |
| TaskType | The type of the task. | String | GroupExpired |
| TriggerTime | The time that the webhook is triggered. | DateTime | 2020-09-04T02:31:26Z |
| ObjectUrl | The URL of the workspace. | String | https://contoso.com/sites/marketing |
| ObjectType | The type of the workspace. | String | Microsoft 365 Group |
| ObjectId | The unique ID of the workspace. | Guid | 379ff54e-b062-40ea-bceb-a6f13c50a054 |
| ObjectTitle | The name of the workspace. | String | Marketing |
| GroupEmail | The email address of the workspace. | String | marketing@contoso.com |
| TaskLink | The link of the lease expiration task. | String | |
| ReachedTime | The time that the workspace lease expires. | DateTime | 2020-09-04T02:31:26Z |
| PolicyId | The ID of the policy. | Guid | 81bbf505-0718-4c6a-a25a-170a03346ea8 |
| PolicyName | The name of the policy. | String | GroupPolicy |
| Assignee | The username of the task assignee. | String | MeganB@contoso.com |
| Property | Description | Type | Sample Data |
|---|---|---|---|
| TriggerType | This webhook will be triggered when a renewal task is completed. | String | RenewalSuccess |
| TriggerTime | The time that the webhook is triggered. | DateTime | 2020-09-04T02:31:26Z |
| ObjectUrl | The URL of the workspace. | String | https://contoso.com/sites/marketing |
| Summary | Not Applicable | String | |
| RenewalProfileId | The unique ID of the renewal profile. | Guid | 66bfab5a-e8e4-42b6-9103-310bdb1de894 |
| RenewalProfileName | The name of the renewal profile. | String | Renewal profile for groups |
| TaskLink | Not Applicable | String | |
| ObjectType | The type of the workspace. | String | Microsoft 365 Group |
| ObjectId | The unique ID of the workspace. | Guid | e15ff8a8-3fa1-473e-bee6-f1ea40e3cccb |
| ObjectTitle | The name of the workspace. | String | Marketing |
| PhaseStartTime | The start time of the renewal process. | DateTime | 2020-09-04T03:03:53Z |
| DueDate | Not Applicable | DateTime | |
| AssigneeDisplayName | Not Applicable | String | |
| AssigneeIdentityName | Not Applicable | String | |
| Message | Not Applicable | String | |
| GroupEmail | The email address of the workspace. | String | marketing@contoso.com |
| Property | Description | Type | Sample Data |
|---|---|---|---|
| TriggerType | This webhook will be triggered when a renewal process encounters an exception. | String | RenewalException |
| TriggerTime | The time that the webhook is triggered. | DateTime | 2020-09-04T02:31:26Z |
| ObjectUrl | The URL of the workspace. | String | https://contoso.com/sites/marketing |
| Summary | Not Applicable | String | |
| RenewalProfileId | The unique ID of the renewal profile. | Guid | d0e829dc-6c0b-448d-b110-f78e47d84220 |
| RenewalProfileName | The name of the renewal profile. | String | Renewal profile for teams |
| TaskLink | The link of the renewal task. | String | https://myhub.avepointonlineservices.com/#/tasks/filters?ObjectId=1f5b4fe6-6485-420c-becb-335c0510bc91&Type=61 |
| ObjectType | The type of the workspace. | String | Microsoft Team |
| ObjectId | The unique ID of the workspace. | Guid | 379ff54e-b062-40ea-bceb-a6f13c50a054 |
| ObjectTitle | The name of the workspace. | String | Marketing |
| PhaseStartTime | The start time of the renewal process. | DateTime | 2020-09-04T03:03:53Z |
| DueDate | The due date of the renewal process. | DateTime | 2020-09-12T03:03:53Z |
| AssigneeDisplayName | The display name of the renewal task assignee. | String | Megan Bowen |
| AssigneeIdentityName | The user principal name of the renewal task assignee. | String | MeganB@contoso.com |
| Message | The details of the renewal exception. | String | The following users cannot be found in your organization’s directory: AlexW@contoso.com |
| GroupEmail | The email address of the workspace. | String | marketing@contoso.com |
| Property | Description | Type | Sample Data |
|---|---|---|---|
| TriggerType | This webhook will be triggered when a renewal task is overdue. | String | RenewalOverdue |
| TriggerTime | The time that the webhook is triggered. | DateTime | 2020-09-04T02:31:26Z |
| ObjectUrl | The URL of the workspace. | String | https://contoso.com/sites/marketing |
| Summary | Not Applicable | String | |
| RenewalProfileId | The unique ID of the renewal profile. | Guid | 66bfab5a-e8e4-42b6-9103-310bdb1de894 |
| RenewalProfileName | The name of the renewal profile. | String | Renewal profile for groups |
| TaskLink | The link of the renewal task. | String | https://myhub.avepointonlineservices.com/#/tasks/filters?ObjectId=1f5b4fe6-6485-420c-becb-335c0510bc91&Type=61 |
| ObjectType | The type of the workspace. | String | Microsoft 365 Group |
| ObjectId | The unique ID of the workspace. | Guid | e15ff8a8-3fa1-473e-bee6-f1ea40e3cccb |
| ObjectTitle | The name of the workspace. | String | Marketing |
| PhaseStartTime | The start time of the renewal process. | DateTime | 2020-09-04T03:03:53Z |
| DueDate | The due date for the task assignee to complete the renewal task. | DateTime | 2020-09-12T03:03:53Z |
| AssigneeDisplayName | The display name of the renewal task assignee. | String | Megan Bowen |
| AssigneeIdentityName | The user principal name of the renewal task assignee. | String | MeganB@contoso.com |
| Message | Not Applicable | String | |
| GroupEmail | The email address of the workspace. | String | marketing@contoso.com |
| Property | Description | Type | Sample Data |
|---|---|---|---|
| TriggerType | This webhook will be triggered when an import process with predefined governance details is completed. | String | FullyAutoImportSuccess |
| TriggerTime | The time that the renewal task is triggered. | DateTime | 2020-09-04T02:31:26Z |
| ObjectUrl | The URL of the workspace. | String | https://contoso.com/sites/marketing |
| Summary | Not Applicable | String | |
| AutoImportProfileId | The unique ID of the import job. | Guid | 7c8a50ba-31f8-4740-866f-69b8dbcb95a6 |
| AutoImportProfileName | The name of the import job. | String | Automatic import for groups |
| TaskLink | Not Applicable | String | |
| ObjectType | The type of the workspace. | String | Microsoft 365 Group |
| ObjectId | The unique ID of the workspace. | Guid | 4ae8dea3-f79a-4de0-8392-84058f9ee37d |
| ObjectTitle | The name of the workspace. | String | Marketing |
| Message | Not Applicable | String | |
| GroupEmail | The email address of the workspace. | String | marketing@contoso.com |
| Property | Description | Type | Sample Data |
|---|---|---|---|
| TriggerType | This webhook will be triggered when an end user completes a confirm governance details task. | String | ConfirmDetailSuccess |
| TriggerTime | The time that the webhook is triggered. | DateTime | 2020-09-04T02:31:26Z |
| ObjectUrl | The URL of the workspace. | String | https://contoso.com/sites/marketing |
| Summary | Not Applicable | String | |
| AutoImportProfileId | The unique ID of the import job. | Guid | 7c8a50ba-31f8-4740-866f-69b8dbcb95a6 |
| AutoImportProfileName | The name of the import job. | String | Automatic import for groups |
| TaskLink | Not Applicable | String | |
| ObjectType | The type of the workspace. | String | Microsoft 365 Group |
| ObjectId | The unique ID of the workspace. | Guid | 4ae8dea3-f79a-4de0-8392-84058f9ee37d |
| ObjectTitle | The name of the workspace. | String | Marketing |
| Message | Not Applicable | String | |
| GroupEmail | The email address of the workspace. | String | marketing@contoso.com |
| Property | Description | Type | Sample Data |
|---|---|---|---|
| TriggerType | This webhook will be triggered when an election process is completed or when a contact is manually specified. | String | ElectionCompleted |
| TriggerTime | The time that the webhook is triggered. | DateTime | 2020-09-04T02:31:26Z |
| ObjectUrl | The URL of the workspace. | String | https://contoso.com/sites/marketing |
| ObjectType | The type of the workspace. | String | Microsoft 365 Group |
| ObjectId | The unique ID of the workspace. | Guid | 4ae8dea3-f79a-4de0-8392-84058f9ee37d |
| ObjectTitle | The name of the workspace. | String | Marketing |
| ServiceType | The type of service. | Guid | Specify contact |
| GroupEmail | The email address of the workspace. | String | marketing@contoso.com |
| IsPrimaryContactDeactived | If the primary workspace contact is deactivated. | Boolean | FALSE |
| OriginalPrimaryContact | The display name of the original primary workspace contact. | String | Megan Bowen |
| OriginalPrimaryContactIdentityName | The user principal name of the original primary workspace contact. | String | MeganB@contoso.com |
| IsPrimaryContactChanged | If the primary workspace contact is changed. | Boolean | FALSE |
| NewPrimaryContact | The display name of the new primary workspace contact. | String | Alex Wilber |
| NewPrimaryContactIdentityName | The user principal name of the new primary workspace contact. | String | AlexW@contoso.com |
| IsSecondaryContactDeactived | If the secondary workspace contact is deactivated. | Boolean | TRUE |
| OriginalSecondaryContact | The display name of the original secondary workspace contact. | String | Alex Wilber |
| OriginalSecondaryContactIdentityName | The user principal name of the original secondary workspace contact. | String | AlexW@contoso.com |
| IsSecondaryContactChanged | If the secondary workspace contact is changed. | Boolean | TRUE |
| NewSecondaryContact | The display name of the new secondary workspace contact. | String | Megan Bowen |
| NewSecondaryContactIdentityName | The user principal name of the new secondary workspace contact. | String | MeganB@contoso.com |
| Property | Description | Type | Sample Data |
|---|---|---|---|
| TriggerType | This webhook will be triggered when all stages of an election process are overdue. | String | ElectionOverdue |
| TriggerTime | The time that the webhook is triggered. | DateTime | 2020-09-04T02:31:26Z |
| ObjectUrl | The URL of the workspace. | String | https://contoso.com/sites/marketing |
| ObjectType | The type of the workspace. | String | Microsoft Team |
| ObjectId | The unique ID of the workspace. | Guid | 4ae8dea3-f79a-4de0-8392-84058f9ee37d |
| ObjectTitle | The name of the workspace. | String | Marketing |
| ServiceType | The type of service. | Guid | Specify contact |
| GroupEmail | The email address of the workspace. | String | marketing@contoso.com |
| IsPrimaryContactDeactived | If the primary workspace contact is deactivated. | Boolean | FALSE |
| OriginalPrimaryContact | The display name of the original primary workspace contact. | String | Megan Bowen |
| OriginalPrimaryContactIdentityName | The user principal name of the original primary workspace contact. | String | MeganB@contoso.com |
| IsPrimaryContactChanged | If the primary workspace contact is changed. | Boolean | FALSE |
| NewPrimaryContact | The display name of the new primary workspace contact. | String | Alex Wilber |
| NewPrimaryContactIdentityName | The user principal name of the new primary workspace contact. | String | AlexW@contoso.com |
| IsSecondaryContactDeactived | If the secondary workspace contact is deactivated. | Boolean | TRUE |
| OriginalSecondaryContact | The display name of the original secondary workspace contact. | String | Alex Wilber |
| OriginalSecondaryContactIdentityName | The user principal name of the original secondary workspace contact. | String | AlexW@contoso.com |
| IsSecondaryContactChanged | If the secondary workspace contact is changed. | Boolean | TRUE |
| NewSecondaryContact | The display name of the new secondary workspace contact. | String | Megan Bowen |
| NewSecondaryContactIdentityName | The user principal name of the new secondary workspace contact. | String | MeganB@contoso.com |
You can configure whether to automatically apply new profiles when converting an object type from Microsoft 365 Group to Team, or from Site collection to Microsoft 365 Group. To configure the workspace type conversion, click the Workspace type conversion card on the System settings page. In the Workspace type conversion panel, configure the following settings:
Click Save to save your configuration.