Skip to main content
This guide explains how to set up integrations with external systems in Veratrace.

​
Prerequisites

  • Access to a Veratrace instance
  • Appropriate permissions to create integrations
  • Credentials for the external system you want to integrate
Source: Feature Inventory - UI Flows (Integrations)

​
Supported Integrations

Veratrace supports 40+ integration types across:
  • Contact Center/CX platforms
  • CRM/Sales systems
  • AI Agent/Copilot vendors
  • BPO service providers
  • IDP/HR systems
  • Policy engines
  • Data/Document systems
  • Finance/Billing platforms
  • Observability/SIEM tools
Source: Feature Inventory - Core Objects (Integration)

​
Create an Integration

Navigate to /integrations/create to create a new integration. Source: Feature Inventory - UI Flows (Integrations)

​
Integration Configuration

​
Basic Information

  • Name - Integration name
  • Type - Integration type (select from supported types)
  • Metadata - Integration-specific configuration fields
Source: Feature Inventory - Core Objects (Integration)

​
Configuration Fields

Each integration type has specific configuration fields. For example: Amazon Connect:
  • Instance ID
  • Access Key ID
  • Secret Access Key
  • AWS Region
Salesforce:
  • Instance URL
  • Consumer Key
  • Consumer Secret
  • Username
  • Password + Security Token
Source: /Users/vincentgraham/clearline-ui/src/features/integrations/types/integration.js

​
Create via API

API: POST /instances/:instanceId/integrations Request body: 
{
  "name": "Integration Name",
  "type": "AMAZON_CONNECT",
  "metadata": {
    "instanceId": "...",
    "accessKeyId": "...",
    "secretAccessKey": "...",
    "region": "us-east-1"
  }
}
Source: Feature Inventory - API Surface (Integrations API)

​
Test Connection

After creating an integration, test the connection. API: POST /instances/:instanceId/integrations/:integrationId/test Response: 
{
  "success": true,
  "message": "Connection successful",
  "timestamp": "2024-12-26T..."
}
Source: Feature Inventory - API Surface (Integrations API)

​
Integration Status

Integrations can have the following statuses:
  • active - Integration is operational
  • inactive - Integration is disabled
  • connecting - Integration is being set up
  • error - Integration has encountered an error
Source: Feature Inventory - Core Objects (Integration)

​
Health Checks

Monitor integration health:
  • isHealthy - Whether the integration is currently healthy
  • lastHealthCheck - When the last health check was performed
  • metrics - Additional health metrics
Source: Feature Inventory - Core Objects (Integration)