Overview
The Hudu integration allows you to seamlessly link your Hudu documentation platform with ChangeBreeze, enabling you to reference passwords, websites, knowledge base articles, and processes directly within your change controls and standard change templates. This integration provides quick access to critical documentation and credentials during change implementation.
Prerequisites
Before setting up the Hudu integration, ensure you have:
Hudu Account: An active Hudu subscription with administrative access
API Access: Ability to generate API keys in your Hudu instance
ChangeBreeze Admin Rights: Organisation administrator or superuser access in ChangeBreeze
Hudu Instance URL: Your Hudu cloud URL (e.g., https://your-company.huducloud.com)
Initial Setup
Generate a Hudu API Key
1. Log in to your Hudu instance as an administrator
2. Navigate to Admin → API Keys
3. Click New API Key
4. Provide a descriptive name (e.g., ChangeBreeze Integration)
(Set View Passwords to enabled to allow linking of passwords)
Then press Create.
5. Copy the generated API key immediately (it will only be shown once)
6. Store the API key securely
Security Note: Treat your Hudu API key like a password. It provides full access to your Hudu data.
Enable Hudu Integration in ChangeBreeze
1. Log in to ChangeBreeze as an organisation administrator
2. Navigate to Org Settings → Integrations → Hudu
3. Toggle Enable Hudu Integration to ON
4. Enter your Hudu Instance URL (e.g., https://your-company.huducloud.com)
5. Paste your API Key from Step 1
6. Select Save Settings
7. Click Test Connection to verify the credentials
Configure Feature Toggles
Choose which Hudu features you want to enable:
Enable Password Linking: Allow users to link Hudu passwords to changes
Enable Website Linking: Allow users to link Hudu websites to changes
Enable Article Linking: Allow users to link Hudu KB articles and processes to changes
Enable Asset Sync: Sync Hudu assets into ChangeBreeze device inventory (optional)
Recommendation: Enable all linking features for maximum flexibility. Asset sync is optional and primarily useful if you use Hudu as your primary asset management system.
Configuration
Feature Settings
Password Linking
When enabled, users can reference Hudu passwords using the @<search> syntax in change descriptions, implementation plans, and templates.
Use Cases:
- Link to admin credentials needed for server changes
- Reference application passwords required during deployments
- Document which credentials are affected by password rotation changes
Website Linking
When enabled, users can reference Hudu websites using the @<search> syntax.
Use Cases:
- Reference customer-facing websites affected by the change
- Document web applications being updated
Article Linking
When enabled, users can reference Hudu knowledge base articles and processes using the @<search> syntax.
Use Cases:
- Link to standard operating procedures (SOPs)
- Reference troubleshooting guides
- Include rollback documentation
- Link to vendor-specific procedures
Company Mapping
If you manage multiple companies (MSP mode), you need to map each ChangeBreeze company to its corresponding Hudu company.
1. Navigate to Settings → Integrations → Hudu → Company Mapping
2. For each ChangeBreeze company:
- Select the company from the dropdown
- Choose the corresponding Hudu company
- Click Add Mapping
3. Verify all mappings are correct
4. Click Save Mappings
Asset Sync (Advanced)
When enabled, Hudu assets are synchronized into the ChangeBreeze device inventory, allowing you to manage all infrastructure from a single platform.
Company mapping ensures that users only see Hudu items relevant to their specific company, maintaining proper data isolation in multi-tenant environments.
Configuration Steps:
1. Navigate to Settings → Integrations → Hudu → Import Rules
2. Map Hudu asset layouts to ChangeBreeze device types
3. Set up field-based filtering rules (optional)
4. Run initial sync
Using Hudu Links in Changes
The @ Mention Syntax
ChangeBreeze uses an @mention syntax to link Hudu items. As you type @ in any text field, an autocomplete dropdown will appear showing available Hudu items.
Linking Hudu Passwords
How to Use:
1. In any change text field (Description, Implementation Plan, Test Plan, Rollback Plan), type @ followed by the name of the password in Hudu
2. Start typing the password name
3. Select the password from the autocomplete dropdown
4. The password will be linked and displayed as a blue chip
Example:
What Gets Linked:
- Password name
- Direct link to view the password in Hudu
Security: The actual password value is not stored in ChangeBreeze. Users must click through to Hudu to view sensitive credentials.
Linking Hudu Websites
How to Use:
1. Type @ in any text field
2. Start typing the website name
3. Select from the autocomplete dropdown
Example:
Linking Hudu Articles/Processes
How to Use:
1. Type @ in any text field
2. Start typing the article or process name
3. Select from the autocomplete dropdown
Example:
Linking Devices
How to Use:
1. Type @ followed by the device hostname
2. Select from the autocomplete dropdown
Example:
Apply Windows updates to @PROD-WEB-01 and @PROD-WEB-02
Viewing Linked Items
All linked Hudu items appear in two places:
- Inline in Text: As clickable blue chips within the description and plans
- Linked Items Sidebar: A dedicated section showing all linked passwords, websites, and articles with direct links to Hudu
To Access a Linked Item:
- Click any blue chip in the text to open the item in Hudu (new tab)
- Or use the "Linked Items" sidebar on the change detail page
Using Hudu Links in Templates
Standard change templates support the same @mention syntax, allowing you to create reusable templates with pre-linked Hudu documentation.
Creating Templates with Hudu Links
Benefits of Templates with Hudu Links
Consistency: Every change created from the template automatically includes the correct documentation links
Efficiency: No need to manually search for and link documentation each time
Compliance: Ensures all required procedures and credentials are referenced
Knowledge Transfer: New team members can easily find relevant documentation