CORE MODULE

Connect to your Core Platforms via API

What you'll learn in this guide

How to connect CX Platform to your existing business systems using the API — from getting your credentials to integrating your first data flow and keeping things running smoothly over time.

Overview

CX Platform is built to work alongside the systems you already rely on. Whether that's a customer relationship management (CRM) tool, an enterprise resource planning (ERP) system, or a data warehouse, you can connect them to CX Platform using a secure, scalable set of RESTful application programming interfaces (APIs) and Webhooks.

Once connected, you can automate data flows between systems — things like triggering a communication when a record changes in your CRM, syncing contact data, or capturing form submissions in real time. No manual exports, no delays, no filing a ticket every time you need data to move.

This guide walks you through the three stages of getting connected: obtaining your credentials, integrating your platform, and keeping an eye on things once it's live.

‍

Obtain API credentials

Before you can make any API calls, you'll need credentials and the right access permissions. Your CX Platform administrator or implementation team can provide both.

  1. Request your API keys and endpoint URLs from your CX Platform administrator or implementation team.
  2. Confirm that your account has developer or API access permissions enabled for your tenant.
  3. Review the API documentation provided to your team — it covers available endpoints, authentication methods, data models, and example requests.
‍CX Platform APIs are RESTful and support standard HTTP methods (GET, POST, and so on). All endpoints are protected with TLS encryption by default, and API keys must be passed as specified in the documentation to authenticate each request.

‍

Connect and integrate

Once you have your credentials, you can start building the integration into your core platform. The exact setup will depend on your systems and what you want to automate, but here are the most common things people configure at this stage:

  • Trigger document generation or e-delivery — fire a communication from your CRM or ERP the moment a relevant event occurs, without any manual intervention.
  • Sync contact, case, or event data — keep your recipient data in CX Platform up to date by pulling it directly from your source systems.
  • Automate digital forms or capture real-time workflow events — use Webhooks to push data back into CX Platform as things happen in your other tools.
  • Map your business data to CX Platform data models — make sure the fields coming in from your systems align with the fields your Applications and templates expect.

If you're unsure how your data should be mapped, your implementation team can help you match your source fields to the right CX Platform data models before you go live.

‍

Monitor and iterate

After your integration is live, it's worth keeping a regular eye on how it's performing — especially in the early days. As your business requirements evolve, you can update your integration flows without rebuilding from scratch. Most adjustments are a matter of updating your field mappings or endpoint configuration.

That's the core of it. Once your credentials are in place and your first data flow is connected, CX Platform and your business systems work together automatically — so your team can focus on the communications themselves, not the plumbing behind them.