SupportLogic – UWF CRM Integration Architecture Overview

Introduction: 

This document provides a high-level overview of the integration architecture and workflow between SupportLogic UI, Background Services, API Data Access layer, UWF (Workflow Orchestration Service), Pipe DB (metadata repository), and external Customer CRM systems.

The objective of this solution is to enable controlled, scalable, and configurable interactions between SupportLogic workflows and multiple CRM platforms through CRM-specific REST APIs for creating and updating records.

High-Level Architecture

Architecture Diagram

Architecture Components

End-to-End Workflow

Step-by-Step Flow

1. A workflow request is initiated from either:
   • SupportLogic UI
   • Background Services
2. The request is routed to the API Data Access layer.
3. API Data Access validates the request and prepares the action payload required for workflow execution.
4. API Data Access invokes UWF with the processed payload.
5. UWF retrieves workflow metadata and configuration details from Pipe DB.
6. Based on metadata, UWF determines:
   • Target CRM system
   • Required API mappings
   • Workflow rules and conditions
7. UWF performs the following operations:
   • Determines required CRM action
   • Dynamically maps fields
   • Identifies CRM-specific API endpoints
   • Constructs CRM-specific REST API requests
8. UWF invokes CRM APIs to perform operations such as:
   • Create records
   • Update records
   • Add comments or activity logs
   • Perform other configured CRM actions
9. The CRM processes the request and returns a response.
10. UWF handles:

• Response processing
• Logging
• Error handling

11. Final execution status is returned to the originating system.

Key Design Principles

Metadata-Driven Architecture

The integration is fully driven by metadata stored in Pipe DB, enabling:

• Dynamic field mappings
• Configurable workflows
• Reduced hardcoded logic
• Faster onboarding of new use cases

Loose Coupling

Each component has a clearly defined responsibility:

• API Data Access → Request validation and preparation
• UWF → Workflow orchestration and execution
• Pipe DB → Configuration and metadata management

This improves maintainability, scalability, and flexibility.

Extensibility

The architecture supports future enhancements including:

• Additional CRM platform integrations
• New workflow actions
• Event-driven processing capabilities

Integration Approach

CRM Integration

UWF interacts with CRM systems using CRM-specific REST APIs.

Supported operations include:

• Create records
• Update records
• Change ownership or assignment
• Update priority or status
• Add comments or notes

Authentication

Authentication methods vary depending on CRM platform and may include:

• OAuth 2.0
• API Tokens
• Access Tokens
• Refresh Tokens
• CRM-specific authentication mechanisms

Error Handling and Reliability

The system ensures enterprise-grade reliability through:

• Centralized logging and monitoring
• API response validation
• Metadata validation
• Graceful error propagation
• Timeout handling for external API calls

Conclusion

This architecture provides a scalable, configurable, and maintainable framework for orchestrating CRM operations through UWF.

The metadata-driven design enables rapid onboarding of new CRM platforms and workflows while maintaining loose coupling, operational reliability, and extensibility.