Integration Maintenance Mode
Note: Integration Maintenance Mode is a planned feature. The functionality described below is not yet available in the current platform release.
Maintenance Mode allows administrators to schedule planned downtime windows for integrations, communicate upcoming maintenance to users, and ensure AI Employees gracefully handle periods when an integration is unavailable.
Scheduling a Maintenance Window
To schedule maintenance for an integration:
- Navigate to Settings > Integrations.
- Locate the integration and open its configuration panel.
- Select Schedule Maintenance.
- Set the start time and end time for the maintenance window.
- Optionally compose a maintenance message to explain the downtime to users (displayed when the integration is invoked during the window).
- Save the maintenance schedule.
Bulk Scheduling
When multiple integrations share the same maintenance window (e.g., a provider-wide outage), you can select multiple integrations and schedule them together to avoid repetitive configuration.
Maintenance Communication
Each maintenance window supports a custom message that is surfaced to users when they interact with an AI Employee that depends on the affected integration. The message editor supports basic formatting so you can include:
- The reason for the maintenance.
- Expected duration.
- Alternative actions or workarounds.
Integration Maintenance Cards
On the Integrations page, integrations with an active or upcoming maintenance window display a maintenance card showing:
- Status -- Whether the integration is currently in maintenance or has a scheduled window.
- Window -- The start and end time of the maintenance period.
- Message preview -- A snippet of the custom maintenance message.
Behavior During Maintenance
When an integration is in maintenance mode:
- AI Employees that depend on the integration will receive a maintenance notification instead of attempting to call the integration.
- Workflow steps that require the integration will be gracefully skipped or queued, depending on the workflow configuration.
- The custom maintenance message is displayed to end users who trigger the affected workflow.
Schedule maintenance windows during low-traffic periods to minimize user impact. Use the Metrics page to identify your lowest-traffic hours.
Related Pages
- Workspaces & Tenants -- Integration configurations are scoped to individual tenants.