API Overview

The Integrations & API's section provides comprehensive guidance on integrating and customizing the TrueEngage SDK within your applications. Whether you're looking to extend the capabilities of your TrueEngage widget, manage visitor data, or interact with Genesys Cloud, this documentation will walk you through the necessary APIs and best practices.

Key Features

• Custom Attributes API: Attach custom data to interactions in Genesys Cloud, enhancing context for agents.
• Visitor Data API: Retrieve and store visitor-related data to improve engagement tracking.
• Visitor Identification API: Set custom visitor IDs to maintain interaction continuity across sessions.
• Custom Callback Data Webhook: Extend callback data processing by adding custom logic to TrueEngage callbacks.
• JavaScript SDK: Gain programmatic control over the TrueEngage widget with event listeners and data retrieval methods.
• Cookie Consent API: Manage cookie consent settings programmatically.
• Custom Remote Name API: Personalize remote names for audio and video streams in Genesys Cloud.

Getting Started

To begin integrating TrueEngage into your platform, follow these steps:

1. Include the SDK in your web application.
2. Initialize TrueEngage and configure required settings.
3. Use API Methods to interact with visitor data, customize interactions, and handle callbacks.
4. Monitor Events using the Events API to trigger actions based on user activity.
5. Ensure Security Best Practices when handling sensitive visitor information.

For a detailed breakdown of each API and implementation example, refer to the corresponding sections within this documentation.