Integration methods comparison
API Integration (Automated)
✨ Recommended - Complete account sync with automation
- Full account export
- Automatic syncing on schedule
- Requires API credentials
- Set-and-forget operation
Runbook Export (Manual)
Alternative - For curated documentation or no API access
- User-friendly PDF format
- Manually upload ZIP files
- Requires periodic re-uploads
- No API setup needed
Detailed comparison
| Feature | Runbook Export | API Integration |
|---|---|---|
| Setup complexity | Simple - just upload | Moderate - requires API key |
| Maintenance | Manual re-upload needed | Fully automated |
| Content format | Structured PDF runbooks | Complete account export |
| IT Glue API support | Not required (runbooks have no API) | Required |
| Update frequency | When you upload | Based on your IT Glue export schedule |
| Best use case | Curated documentation for specific clients | Comprehensive documentation sync |
Which method should you choose?
✨ API Integration (Recommended)
Choose API Integration for the best experience:- ✅ Automatic syncing - Neo stays up-to-date without manual work
- ✅ Comprehensive documentation coverage
- ✅ Set-and-forget operation after initial setup
- ✅ Perfect for teams that update documentation regularly
- ✅ No ongoing maintenance required
The API integration monitors your scheduled exports and processes them automatically. You configure it once, and Neo handles the rest—no manual uploads, no remembering to re-sync.
Runbook Export (Alternative)
Only choose Runbook Export if:- ❌ You don’t have IT Glue API access
- ⚠️ You need to provide only curated, client-specific documentation
- ⚠️ You update your documentation very infrequently (monthly or less)
- ⚠️ You want manual control over exactly what Neo can access
Security considerations
Both integration methods prioritize security:- Runbook Export: You control exactly what gets uploaded. Enable “Mask Passwords” when creating runbooks.
- API Integration: Neo only ingests and processes documents from the export. Passwords are never imported, accessed, or stored by Neo, even though they’re included in IT Glue exports.
Upgrading from Runbook Export to API Integration
If you started with manual runbook uploads, we strongly recommend upgrading to the API integration. The migration is straightforward:- Set up the API integration following the API guide
- Wait for the first scheduled export to complete and sync
- Verify Neo is finding documentation correctly
- Remove the manual runbook integration to avoid duplicates
Both integration types can run simultaneously during the migration period, but remove the manual integration once API sync is confirmed working to avoid duplicate documentation entries.
Next steps
Set up API Integration (Recommended)
Get started with automated, hands-free documentation syncing
Alternative: Set up manual Runbook Export
Alternative: Set up manual Runbook Export
If you don’t have API access or need the manual approach, follow the Runbook Export guide.
