kubiya_external_knowledge
resource manages external knowledge integrations in the Kubiya platform. This resource allows you to connect external systems to the Kubiya RAG (Retrieval-Augmented Generation) system through a vendor-agnostic interface, enabling agents to access and learn from external data sources like Slack conversations, documentation systems, and other knowledge repositories.
External knowledge integrations supercharge your agents by providing access to historical conversations, institutional knowledge, and contextual information that makes responses more accurate and relevant.
Prerequisites
Before using this resource, ensure you have:- A Kubiya account with API access
- An API key (generated from Kubiya dashboard under Admin → Kubiya API Keys)
- Access to the external system you want to integrate (e.g., Slack workspace)
- Appropriate permissions in the external system
Quick Start
Configuration Examples
Set up knowledge integration for incident response and post-mortem analysis:
Advanced Configurations
Compliance and Security Knowledge
Compliance and Security Knowledge
Set up secure knowledge integration for compliance and security teams:
Multi-Vendor Knowledge Strategy
Multi-Vendor Knowledge Strategy
Plan for future multi-vendor integrations:
Knowledge Governance and Monitoring
Knowledge Governance and Monitoring
Implement governance and monitoring for knowledge integrations:
Arguments Reference
Required Arguments
The vendor/provider for the knowledge integration. Currently supported values:
slack
- Slack channel integrations
Dynamic configuration map with vendor-specific keys and values. The structure depends on the vendor being used.
Vendor-Specific Configuration
Slack Configuration
Forvendor = "slack"
, the config object requires:
List of Slack channel IDs to integrate. Each ID should be in the format “C1234567890”. You can find channel IDs in Slack by:
- Right-clicking on a channel
- Selecting “Copy link”
- The ID is the part after “/channels/” in the URL
Attributes Reference
In addition to all arguments above, the following attributes are exported:The unique identifier of the external knowledge integration.
The organization associated with the integration.
The start date from which knowledge is indexed.
The type of integration (matches the vendor).
The timestamp when the integration was created.
The timestamp when the integration was last updated.
How to Find Slack Channel IDs
Import
External knowledge integrations can be imported using their ID:Best Practices
Channel Selection
- Choose channels with valuable, relevant knowledge content
- Avoid extremely high-volume channels that may create noise
- Select channels with good signal-to-noise ratio
- Consider the longevity and relevance of channel content
Privacy & Compliance
- Ensure compliance with data privacy policies and regulations
- Review channel content for sensitive information before integration
- Implement appropriate access controls for sensitive knowledge
- Regular audit of integrated channels and their content
Access Control
- Limit agent access to sensitive knowledge integrations
- Use groups to control which users can access specific knowledge
- Regularly review and update access permissions
- Implement least-privilege access principles
Performance & Maintenance
- Monitor knowledge usage and relevance over time
- Regular cleanup of obsolete or irrelevant integrations
- Update channel lists as organizational structure changes
- Test knowledge retrieval effectiveness in non-production environments
Knowledge Integration Patterns
Compatibility
Requirements:
- Kubiya Terraform Provider version >= 1.0.0
- Terraform >= 1.0
- Slack integration requires OAuth setup in Kubiya dashboard
- Channel IDs must be valid and accessible
Processing Time:
- Knowledge indexing may take time after initial creation
- Historical data retrieval limits may apply based on platform tier
- Large channels may require additional processing time
- Changes to channel content are indexed incrementally
Important Considerations:
- Ensure proper permissions in Slack workspace
- Be aware of data privacy and compliance requirements
- Monitor for sensitive information in indexed content
- Consider impact on system performance with large integrations
Troubleshooting
Integration Setup Issues
Integration Setup Issues
- Verify Slack OAuth setup is completed in Kubiya dashboard
- Check that channel IDs are correctly formatted (start with ‘C’)
- Ensure the Kubiya bot has access to specified channels
- Confirm workspace permissions allow external integrations
Knowledge Indexing Problems
Knowledge Indexing Problems
- Allow time for initial indexing to complete (can take hours for large channels)
- Verify channels contain accessible content
- Check that historical data limits haven’t been exceeded
- Monitor indexing status through Kubiya dashboard
Agent Access Issues
Agent Access Issues
- Confirm agents have appropriate group memberships
- Verify knowledge integration is properly configured
- Check that agents’ instructions reference the available knowledge
- Test knowledge queries with simple, known information