create-destination

Description

Creates a new destination using one of the pre-configured message templates (Journey, Interact, CDP, Generic). This command is used when you want to publish events using a standard message format to Kafka topics or databases.

Syntax

Windows:

CliTool.bat create-destination -f <path-to-json-file>

Linux:

./CliTool.sh create-destination -f <path-to-json-file>

Example Execution

Windows:

CliTool.bat create-destination -f "C:\destinations\create-journey-destination.json"

Linux:

./CliTool.sh create-destination -f /home/user/destinations/create-journey-destination.json

Sample Output

Success:

Destination created successfully with ID: 42

Error:

Error creating destination: Validation failed - Kafka cluster 'invalid-cluster' not found in Platform

JSON Payload Examples

Example 1: Journey Destination with Kafka Connector

{
  "name": "Customer Journey Events",
  "description": "Publishes journey events to HCL Journey via Kafka",
  "templateId": 1,
  "messageConfig": {
    "payloadEntrySourceCode": "ES-001"
  },
  "feedAttributeMapping": [
    {
      "feedId": 1,
      "attributes": {
        "profile": {
          "customerId": "CUSTOMER_ID",
          "customerName": "CUSTOMER_NAME",
          "email": "EMAIL_ADDRESS"
        },
        "tuple": {
          "eventId": "EVENT_ID",
          "timestamp": "EVENT_TIMESTAMP",
          "eventType": "EVENT_TYPE"
        }
      }
    }
  ],
  "connectorConfig": {
    "kafka": {
      "connectorType": "KAFKA",
      "topic": "journey-events-topic",
      "clusterName": "primary-kafka-cluster"
    }
  }
}

Example 2: Interact Destination with Kafka Connector

{
  "name": "Real-Time Offers to Interact",
  "description": "Sends real-time offer requests to HCL Interact",
  "templateId": 2,
  "messageConfig": {
    "audienceIdAttributeName": "ACCOUNTID",
    "campaignIdAttributeName": "offerCode",
    "customerKeyFieldName": "MSISDN",
    "dateTimeAttributeName" : "ts",
    "eventParamEventName": "event",
    "eventParamInboundChannelName": "inbound_channel",
    "eventParamInboundChannelValue": "hcl",
    "payloadChDebugValue": "false",
    "payloadGatewayValue": "InboundGateway",
    "payloadIcNameValue": "InteractRuntime"
  },
  "feedAttributeMapping": [
    {
      "feedId": 1,
      "attributes": {
        "profile": {
          "accountId": "ACCOUNT_ID",
          "msisdn": "MSISDN"
        },
        "tuple": {
          "eventId": "EVENT_ID",
          "offerCode": "OFFER_CODE"
        }
      }
    }
  ],
  "connectorConfig": {
    "kafka": {
      "connectorType": "KAFKA",
      "topic": "interact-offers-topic",
      "clusterName": "primary-kafka-cluster"
    }
  }
}

Example 3: Destination with Multiple Connectors (Kafka + Database)

{
  "name": "Multi-Connector Event Publisher",
  "description": "Publishes events to both Kafka and MariaDB database",
  "templateId": 1,
  "messageConfig": {
    "payloadEntrySourceCode": "ES-002"
  },
  "feedAttributeMapping": [
    {
      "feedId": "TransactionFeed",
      "attributes": {
        "profile": {
          "userId": "USER_ID",
          "userName": "USER_NAME"
        },
        "tuple": {
          "transactionId": "TRANSACTION_ID",
          "amount": "AMOUNT",
          "currency": "CURRENCY"
        }
      }
    }
  ],
  "connectorConfig": {
    "kafka": {
      "connectorType": "KAFKA",
      "topic": "transaction-events",
      "clusterName": "primary-kafka-cluster"
    },
    "db": {
      "connectorType": "MARIADB",
      "datasourceName": "detect_datasource",
      "databaseName": "detect_audit_db"
    }
  }
}

JSON Schema Breakdown

Root Level Fields

messageConfig Object (Template-Specific)

The messageConfig object contains key-value pairs that configure the message template. Required fields vary by template type.

Journey Template (templateId: 1)

Interact Template (templateId: 2)

CDP Template (templateId: 3)

Generic Template (templateId: 4)

feedAttributeMapping Array

An optional array of objects that map feed attributes to message template fields. Each mapping defines which profile and event attributes to include for a specific feed.

Optional: The feedAttributeMapping field may be omitted, null, or an empty array ([]). When absent or empty, no feed-to-attribute mapping validation is performed and the destination is saved without any feed mappings.

When provided, the following rules apply:

• Each feedId must be unique within the array — duplicates are rejected.
• Each feedId must reference an existing, enabled feed application that has at least one enabled feed parser mapping.
• Within a mapping, attributes object, its profile / tuple sub-maps are each individually optional. null or empty maps are accepted and skipped during validation.
• Every non-blank value in the profile map must be a name of an attribute belonging to the customer's profile.
• Every non-blank value in the tuple map must be a name of an attribute defined on the referenced feed (including its enriched attributes).

Array Item Schema:

Example Mapping:

{
  "feedId": 1,
  "attributes": {
    "profile": {
      "customerId": "CUSTOMER_ID",        // Template field: customerId ' Profile attribute: CUSTOMER_ID
      "customerName": "CUSTOMER_NAME",
      "email": "EMAIL_ADDRESS"
    },
    "tuple": {
      "eventId": "EVENT_ID",              // Template field: eventId ' Event attribute: EVENT_ID
      "timestamp": "EVENT_TIMESTAMP",
      "eventType": "EVENT_TYPE"
    }
  }
}

Understanding the Mapping:

• Left side (keys): Field names to be sent to downstream system.
• Right side (values): Attribute names from Detect profile or event feed
• Profile attributes: Retrieved from customer profile storage (database tables)
• Tuple attributes: Retrieved from the incoming event record (feed data) and defined enriched attributes for feed

connectorConfig Object

Defines where and how to publish destination messages. You can configure one or multiple connectors.

Kafka Connector Schema

Example:

"kafka": {
  "connectorType": "KAFKA",
  "topic": "customer-events",
  "clusterName": "prod-kafka-cluster"
}

Validation:

• Kafka cluster must exist in Platform configuration
• Topic accessibility is validated during destination creation
• Bootstrap servers are retrieved automatically from Platform cluster config

Database Connector Schema

Example:

"db": {
  "connectorType": "DB",
  "datasourceName": "detect_datasource",
  "databaseName": "event_audit_db"
}

Validation:

• Datasource must exist in Platform and be accessible to user
• Database connectivity is validated during destination creation
• Database name must follow naming pattern (no special characters except underscore)

Complete JSON Schema Table (All Fields)

Message Config by Template

Each message template requires different configuration fields in messageConfig:

Template ID 1: Journey

Template ID 2: Interact

Template ID 3: CDP

Template ID 4: Generic

Custom templates may require different fields. Contact your Detect administrator for custom template configuration requirements.