Auvik Integration Overview

1) What this integration does

The Auvik integration lets your organisation:

1. Connect ChangeBreeze to your Auvik account using API credentials

2. Map each ChangeBreeze company to an Auvik tenant/site

3. Sync devices from mapped Auvik tenants into ChangeBreeze Device Inventory

4. Optionally sync managed devices only

5. Open each company’s Auvik Maintenance Window directly from Change pages

6. While an engineer is mid-change, any device tagged in the implementation steps should be clickable and jump straight to that device’s live management page in Auvik.
   

2) Where users access it

Go to: Organisation Settings > Integrations >Auvik

Auvik appears as a branded integration card in the integrations page.

3) Permissions

Only users with organisation settings permissions can manage Auvik settings, mappings, and sync.

If a user lacks permission, they are blocked from integration management APIs/views.

4) Initial setup (step-by-step)

Step 1 - Enable the integration

In Auvik settings:

• Tick Enable Auvik integration

• Save settings

Step 2 - Enter credentials

Provide:

• API Username (Auvik email/username)

• API Key

• API Region (us1, eu1, au1)
  
  

Step 3 - Test connection

Click Test Connection to validate credentials before syncing.

5) Sync settings

Managed Devices Only (currently the only sync filter)

When enabled, ChangeBreeze only imports Auvik devices where manage status is true.

• ON = include only managed devices

• OFF = include all devices returned by Auvik

6) Company → Auvik tenant mapping

For each company:

1. Pick a tenant from the dropdown

2. Click Save

3. Status updates to “Mapped”

You can also remove a mapping with Remove.

Unmapped companies are skipped during sync.

7) Device sync behavior

Click Sync Devices Now to pull devices from all mapped tenants.

Sync result shows:

• Created

• Updated

• Skipped

• Total Synced

8) What happens during sync

For each mapped company/tenant:

1. ChangeBreeze requests devices from Auvik

2. Existing mapped devices are updated

3. New devices are created and mapped

4. Invalid/blank device IDs are skipped

9) Tenant remap behavior

If a tenant is moved from one company to another:

• Existing synced devices for that Auvik device ID are now reassigned to the new company on next sync

• Associated AuvikDeviceMapping is also updated to the new company/tenant

• If hostname conflicts in the target company, hostname is auto-adjusted to avoid collision

10) Auvik Maintenance Window quick-access button

Auvik maintenance links are available directly from change workflow pages when mapping data exists:

1. Change Detail page (action buttons area)

2. Change Create/Edit form (Scheduling section)

URL format generated dynamically:

https://{domain_prefix}.{region}.my.auvik.com/#admin/alerts/maintenanceWindows

Button only appears when required Auvik mapping/region data is available.