- integration
- patterns
- azure-devops
- saas
Integration Overview¶
This document provides a map of integration stories: where and how ConnectSoft typically integrates with other systems. It is written for architects, engineers, and platform owners who need to understand ConnectSoft's integration patterns and capabilities.
ConnectSoft systems integrate with a wide range of external systems, from Azure DevOps for code generation to external SaaS platforms for business operations. This overview categorizes these integrations and helps you choose the right pattern for your needs.
Note
Integration patterns are designed to be reusable and consistent across all ConnectSoft products. The Factory generates integration code following these patterns, ensuring consistency and maintainability.
Integration Categories¶
| Category | Examples | Typical Consumers |
|---|---|---|
| DevOps | Azure DevOps (Repos, Pipelines, Boards, Artifacts) | Factory, Engineering teams |
| Identity/Access | Azure AD, Google, GitHub, custom IdPs | Identity Platform, all microservices |
| Audit/Compliance | SIEM systems, analytics platforms, compliance tools | Audit Platform, all microservices |
| Data/Analytics | Data warehouses, BI tools, analytics platforms | All platforms, ETL pipelines |
| External SaaS | CRMs (Salesforce, HubSpot), ATS systems, marketing tools (Braze, Segment) | Customer applications, integration services |
| Messaging/Events | Azure Service Bus, RabbitMQ, webhooks | All microservices, event-driven systems |
Factory Integrations¶
The AI Factory integrates with several systems to generate and manage code:
Azure DevOps¶
- Repos - Factory creates repositories and commits generated code
- Pipelines - Factory generates CI/CD pipeline definitions
- Boards - Factory creates work items (Epics, Features, Tasks) and links code
- Artifacts - Factory uses NuGet feeds for ConnectSoft.Extensions.* libraries
See: Azure DevOps Integration for detailed patterns.
Source Control Providers¶
- Azure DevOps Git - Primary source control (fully integrated)
- GitHub - Conceptual support (via Azure DevOps integration)
- GitLab - Conceptual support (via Azure DevOps integration)
Observability Stack¶
- Application Insights - Factory execution metrics and traces
- OpenTelemetry - Distributed tracing for agent execution
- Logging - Structured logs for Factory operations
Platform Integrations¶
Identity Platform¶
Integrates With: - External IdPs - Azure AD, Google, GitHub, custom providers - Applications - Microservices using OIDC/OAuth2 - Admin Tools - Management consoles and APIs
Integration Patterns: - OIDC/OAuth2 flows (authorization code, client credentials) - Token validation and introspection - User federation and SSO
See: Identity Platform API Overview
Audit Platform¶
Integrates With: - Emitting Services - Microservices writing audit events - SIEM Systems - Security information and event management - Analytics Platforms - Business intelligence and reporting tools
Integration Patterns: - Event ingestion via API - Webhook delivery to external systems - ETL pipelines to data warehouses
See: Audit Platform API Overview, Webhooks and Events
Config Platform¶
Integrates With: - Consumer Services - Microservices fetching configuration - Admin Tools - Configuration management interfaces - CI/CD Systems - Pipeline configuration management
Integration Patterns: - REST API for configuration retrieval - Webhook notifications for config changes - Feature flag evaluation
See: Config Platform API Overview
Bot Platform¶
Integrates With: - Channels - Slack, Teams, web chat, custom channels - External APIs - Third-party services and APIs - Backend Services - Microservices providing business logic
Integration Patterns: - Channel adapters for messaging platforms - Webhook endpoints for external services - API clients for backend integration
See: Bot Platform API Overview
Data and Analytics Integrations¶
Typical Data Flows¶
ConnectSoft platforms generate data that flows to analytics systems:
- Audit Events → Data Warehouse → BI Tools
- Identity Events → Analytics Platform → User Behavior Analysis
- Config Changes → Change Log → Compliance Reporting
- Bot Conversations → Analytics → Customer Support Metrics
ETL Patterns¶
- Batch ETL - Periodic extraction and transformation
- Streaming ETL - Real-time event processing
- Change Data Capture - Capturing incremental changes
See: Data Pipelines and ETL for detailed patterns.
Choosing the Right Pattern¶
Use these guidelines to select the appropriate integration pattern:
Use Webhooks When:¶
- External systems need real-time notifications
- You need to push data to external systems
- Event-driven integration is required
- Low latency is important
Use Periodic ETL When:¶
- Large volumes of historical data
- Batch processing is acceptable
- Data warehouse synchronization
- Compliance and reporting needs
Use Real-Time Event Bus When:¶
- Internal service-to-service communication
- Event-driven architecture
- Decoupled microservices
- High throughput requirements
Use REST APIs When:¶
- Synchronous request/response patterns
- Simple CRUD operations
- Standard HTTP-based integration
- External API consumption
Use OAuth2/OIDC When:¶
- User authentication and authorization
- Service-to-service authentication
- Third-party identity federation
- Token-based access control
Tip
Pattern Selection Guide: 1. Internal Services → Use event bus (MassTransit + Azure Service Bus) 2. External Push → Use webhooks 3. External Pull → Use REST APIs 4. Authentication → Use OAuth2/OIDC 5. Analytics/Reporting → Use ETL pipelines
Related Documents¶
- Azure DevOps Integration - Factory integration with Azure DevOps
- External SaaS Integration Patterns - Integrating with external SaaS systems
- Webhooks and Events - Webhook and event patterns
- Data Pipelines and ETL - Data pipeline patterns
- Event-Driven Mindset - Event-driven architecture principles
- Factory Overview - Factory capabilities
- Product Portfolio Overview - Platform capabilities