Welcome
Administration
Learn about how to configure, manage, and maintain HCL Detect environments. It includes details on system setup, user management, and permissions, ensuring seamless operation and efficient deployment of your continuous delivery processes.
Destination Management
Use CLI commands to configure, validate, and manage destination endpoints for Detect event delivery.
API (HTTP REST) Connector for Destinations
Send detected events to an external system over HTTP by configuring an API (HTTP REST) connector on a destination.

Getting Started
Welcome to the documentation for HCL Detect, where you can find information about how to install, maintain, and use this service.
Installation
Learn more about HCL Detect installation and deploying core components of the product.
Administration
Learn about how to configure, manage, and maintain HCL Detect environments. It includes details on system setup, user management, and permissions, ensuring seamless operation and efficient deployment of your continuous delivery processes.
- Introduction
  Use this guide to administer HCL Detect, including user and role access, CLI-based configuration and management tasks, DEL reference topics, and support resources.
- User & Role Management
  This page explains how to manage roles and permission in HCL Detect.
- Configuration Management
  Use CLI commands to query and validate the infrastructure settings required for Detect operations.
- Metadata Management
  Use CLI commands to discover data sources, search tables, and retrieve column metadata for Detect integrations.
- Profile Management
  Manage profile definitions and attributes through the HCL Detect UI or CLI.
- Feed Application
  Create and manage feed applications through the HCL Detect UI or CLI.
- About derived attribute functions
  Derived attribute functions enable you to offload complex calculations involving multiple tuple attributes to custom Python scripts.
- Feed Parser Mapping
  Use CLI commands to define and maintain feed parser mappings between incoming feed fields and Detect target attributes.
- Destination Management
  Use CLI commands to configure, validate, and manage destination endpoints for Detect event delivery.
  - What is a Destination?
  - Available Commands
  - API (HTTP REST) Connector for Destinations
    Send detected events to an external system over HTTP by configuring an API (HTTP REST) connector on a destination.
  - Best Practices
    Recommendations for naming and validating destinations.
  - Complete Example: End-to-End Destination Setup
  - Sample JSON Payloads Reference
  - FAQ
  - Appendix: Field Reference
- Crypto Management
  Use CLI crypto utilities to encrypt and decrypt sensitive values used in Detect configuration workflows.
- Troubleshooting & Common Errors
- Detect Expression Language
- Detect Expression Language Built-in Functions
Working with the System
The section provides comprehensive instructions for creating, configuring, and managing marketing events. It covers topics such as defining audience conditions, setting up triggers, deploying events, and tracking their performance. Additionally, this section includes explanations of key terminology and offers advanced options to optimize event management.
System Data Model
This section provides detailed information about the internal tables used within the Detect module. It includes descriptions of each table's structure, purpose, and relationships, aiding administrators and developers in understanding and managing the underlying database schema effectively.

API (HTTP REST) Connector for Destinations

Send detected events to an external system over HTTP by configuring an API (HTTP REST) connector on a destination.

A destination defines where Detect sends detected events. Previously, destinations supported two connector types: Kafka and database (DataSource). Starting with 26.1.0.0.IF2, destinations also support an API (HTTP REST) connector. The API connector publishes detected events as JSON over HTTP POST to a REST endpoint that you provide, such as a webhook, a microservice, or a third-party platform.

As with Kafka clusters and data sources, you define the connection details for an API connector once in Unica Platform, as an API configuration. A destination then refers to that configuration by name.

How event delivery works

The Detect engine does not call the external endpoint directly. Instead:

The engine processes an event and sends them to the target endpoint as HTTP POST requests, reusing a shared pool of HTTP connections.
Each request carries a unique Idempotency-Key header so the receiving system can detect and ignore duplicate deliveries.
If a message still fails after the configured number of retries, it is removed from the normal processing path so that it does not block later events.

Prerequisites

Unica Platform and HCL Detect 26.1.0.0.IF2 or later are installed.
You have administrator access to Unica Platform configuration and to Detect destinations.
The Detect engine host can reach the target endpoint, and the token endpoint if you use bearer token authentication, through any firewalls or proxies in between.
The target endpoint accepts HTTP POST requests with a JSON body.
You have the credentials for the authorization type you plan to use: a user name and password for basic authentication, or a token URL, client ID, and client secret for bearer token authentication.
For HTTPS endpoints, the endpoint's certificate is trusted by the Java truststore used by the Detect engine JVM.