Welcome
Working with Platform
This section describes the Data Pipeline for streamlined data flow, leveraging Customer One View for unified profiles, and orchestrating campaigns to drive targeted engagement.
Campaigns
Campaigns in HCL CDP are Engagements, designed to boost brand awareness, enabling you to reach and convert users into potential customers.
Campaign Channels
Overview of supported channels in HCL CDP and core elements used during campaign setup.
External API
This page explains the simplified ways to configure External APIs and create engagement.
Test your API Configuration

Getting Started
Welcome to the documentation for HCL CDP, where you can find information about how to install, maintain, and use this service.
Installation
Learn more about HCL CDP installation and deploying core components of the product.
Administration
Learn about how to configure, manage, and maintain HCL CDP environments. It includes details on system setup, user management, permissions, integrations, and troubleshooting, ensuring seamless operation and efficient deployment of your continuous delivery processes.
Working with Platform
This section describes the Data Pipeline for streamlined data flow, leveraging Customer One View for unified profiles, and orchestrating campaigns to drive targeted engagement.
- CDP Overview
  This page talks about the importance of CDP and its benefits.
- Data Pipeline
  Data Pipeline enables seamless data flow by managing events, integrating data sources, and configuring destinations for unified and actionable customer insights.
- Customer One View
  This page introduces Customer One View, a feature designed to provide a comprehensive analysis of customer traits, actions, and engagement history for enhanced understanding and efficiency.
- Campaigns
  Campaigns in HCL CDP are Engagements, designed to boost brand awareness, enabling you to reach and convert users into potential customers.
  - Segments Overview
    This page provides a detailed explanation of segments, their use cases, and types in the HCL CDP Marketing Automation platform. Segments allow marketers to automate user targeting, reduce manual errors, and drive higher conversions through precise audience categorization.
  - Campaign Channels
    Overview of supported channels in HCL CDP and core elements used during campaign setup.
    - SMS
      This page explains about the SMS channel in HCL CDP.
    - Email
      This page talks about the Email channel in HCL CDP and what are the prerequisites to run Email campaigns.
    - App Push Notification
      This page talks about App Push Notification channel in HCL CDP and what are the pre-requisites to run App Push Notification campaigns.
    - WhatsApp
      This page talks about Whatsapp channel in HCL CDP and what are the pre-requisites to run Whatsapp campaigns.
    - Web Push Notification
      This page talks about Web Push Notification channel in HCL CDP and what are the pre-requisites to run Web Push Notification campaigns.
    - External API
      This page explains the simplified ways to configure External APIs and create engagement.
      - Add External API Engagement
        This page explains how to create an engagement with External API.
      - Test your API Configuration
      - Use Cases of External APIs
        This page explains the use cases of three different APIs and demonstrates the configuration and engagement creation of those APIs.
  - Advanced Campaign Features
    This section provides an overview of advanced functionalities in the Customer Data Platform (CDP), including A/B testing to compare campaign effectiveness, and exporting audience data to channels like Facebook and Google Ads. It offers detailed guidance on setup, configuration, and integration to enhance campaign performance and data management.
Insights and Actions
This section details unify real-time dashboards and AI-driven intelligence to transform data into impactful outcomes.
Integrations
HCL CDP comes with predefined APIs like get profile and data ingestion APIs.
Settings
This section allows configuring product label, setting frequency caps, and so on.
PDF

Test your API Configuration

Testing your external API is a crucial step in the configuration process. When setting up and customizing the payload, various issues can arise, such as syntax errors or incorrect parameter values. Proper testing helps identify and resolve these common errors, ensuring seamless integration and functionality. This guide provides valuable insights and tips to help you effectively test your API and address potential challenges during configuration.

To test your API configuration, follow the steps below:

Navigate to Channels > External API.
Select any engagement that you configured, and navigate to Test API.
Configure the payload.
Click Test Configuration. You can check the response of your payload and your communication status in the response section.

Note:

Ensure the sender ID is a verified ID provided by the API vendor.
Always enclose the variables in double quotes as required.
You can edit the payload either through the payload editor or by using the input box in the tree view.

To add feedback about this topic, select the following checkbox:

By clicking this box, you acknowledge that you are NOT a U.S. Federal Government employee or agency, nor are you submitting information with respect to or on behalf of one. HCL provides software and services to U.S. Federal Government customers through its partners Four, Inc. Contact this team at https://hcltechsw.com/resources/us-government-contact. Do not include any personal data in this Comment box. Note: To report a problem or question about the product software, do not use this form. Instead, go to the HCL Software Support site. Personal data should not be shared in this comment box. See our Privacy Statement to understand how personal data is used.