DeployTeq Batch (CanopyDeploy Batch, Clang Batch) setup for Data Activation

The Data Activation connector for CanopyDeploy Batch (also known as Clang Batch) enables you to synchronize customer segments with the CanopyDeploy (Deployteq) marketing automation platform using batch processing. This connector is optimized for handling larger volumes of data and is the recommended approach for most integrations.

Here's how this integration delivers value:

• Handle large volumes efficiently: Batch processing is designed to handle bigger volumes of data compared to real-time integrations.

• Segment-based marketing: Sync customer segments to CanopyDeploy for targeted email campaigns and automated marketing workflows.

• Flexible data mapping: Send customer identifiers along with custom profile data fields to CanopyDeploy for personalized campaigns.

• Automatic status management: Automatically add, modify, or remove profiles from segments based on audience or journey actions.

• Support for profile variables: Send additional data fields from the Data Activation to CanopyDeploy for dynamic content personalization.

When added to an audience or journey step, the CanopyDeploy Batch:

1. Collects profiles that enter or exit the audience/journey step.

2. Batches profiles together (up to 500-600 profiles per batch).

3. Sends data to CanopyDeploy every 20 minutes or when the batch is full.

4. Includes the following status for each profile:

   • NEW: Profile has entered the audience/journey

   • MODIFIED: Profile data has been updated

   • REMOVED: Profile has exited the audience/journey

Destination connector overview

Before you begin

Before configuring the CanopyDeploy Batch, make sure you have the following details ready:

• An active CanopyDeploy (Deployteq) account

• Webhook Receiver installed from the Deployteq Store

• Webhook URL and Token from the Deployteq platform

• Identifier type determined (Hashed Email or Customer ID)

Use the Batch (REST) connector when:

• You need to handle larger volumes of data

• A short delay (up to 20 minutes) is acceptable

• You want more reliable data delivery

For real-time requirements where immediate email sending is mandatory, use the real-time SOAP connector instead.

Configure Webhook in Deployteq

Before creating the connector in the Data Activation, set up a webhook in Deployteq:

1. Log in to your CanopyDeploy (Deployteq) account.

2. Go to Deployteq Store → Webhook.

3. Follow the installation wizard:

   1. Choose the authentication method Token for the Data Activation connector.

   2. After configuration, Deployteq shows:

      • The endpoint URL

      • Authentication details (Token)

   3. Copy the endpoint URL and token—you'll need them when creating the connector.

For detailed instructions, see the Deployteq Webhook documentation.

Configure data mapping in Deployteq

Click Open data mapping in Deployteq to map incoming JSON fields to Deployteq fields:

• Customer fields

• Customer option fields

• Data model fields

• Environment fields

Mapping rules:

• All fields in the same group must follow the same path structure

• Gender must be: MAN, WOMAN, FAMILY, NONBINARY, UNKNOWN

• Opt-in expects: Y or N (default = Y)

• Yes/No expects: 1 or 0

For additional mapping documentation, see Deployteq Webhook Mapping.

Instructions

Step 1: Configure destination

1. On the Data Activation platform, select Connectors in the left-side navigation bar.

2. Select Server to Server and click New Connector.

3. Select CanopyDeploy (Batch version). The form requires the following information:

   • Name: Display name of the partner Server to server integration, used throughout the Data Activation system

   • Endpoint: The webhook URL from Deployteq. Enter the URL without the "?token=" part (for example, https://webhook.myclang.com/app/api/rest/public/v2/project/datahook/data-receiver/32-your-webhook-id)

   • Token: The authentication token from Deployteq. This is the value after "?token=" in the full webhook URL

   • Identifier type: Customer ID (internal identifier) or Hashed Email (SHA256 hashed email)

Important

When copying the webhook URL from CanopyDeploy, separate the URL and token. The token should go in the Token field, not in the URL field.

Partner numbers:

• 1020: Default when using Customer ID

• 1022: Default when using Hashed Email

Advanced settings allow you to set a custom partner number instead of the default.

Step 2: Add the destination connector to an Audience/Journey

When adding the CanopyDeploy Batch connector to an audience or journey, configure the following:

• Segment Name: A free text field for the segment name that will be sent to CanopyDeploy. This name identifies the segment in the CanopyDeploy platform

Any profile variables configured in the audience or journey will automatically be sent to CanopyDeploy as customer parameters.

Sample payload

The connector sends data in the following format:

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "customerType": "HASHED_EMAIL",
  "campaigns": [
    {
      "segmentName": "WelcomeFlow",
      "customers": [
        {
          "customerId": "c9f0f895fb98ab9159f51fd0297e236d",
          "r42Status": "NEW",
          "params": [
            {
              "name": "firstName",
              "type": "string",
              "value": "Alice"
            }
          ]
        }
      ]
    }
  ]
}

customerType values:

• CLANG_ID: Customer ID identifier

• HASHED_EMAIL: SHA256 hashed email

r42Status values:

• NEW: Profile added to segment

• MODIFIED: Profile data updated

• REMOVED: Profile removed from segment

Connector limitations and known issues

• Daily request limit: Standard webhook allows 50,000 requests per day per brand. If exceeded, HTTP 429 is returned. Install Webhook Pro to avoid limits.

• Batch processing delay: Data is sent every 20 minutes or when the batch reaches 500-600 profiles.

• Endpoint validation: The connector validates that the endpoint is a valid URL format.

• Token security: Store the token in the Token field, not in the URL, for security.

Error handling

Error codes are displayed in the Data Exchange section of the audience/journey.

For CanopyDeploy-specific errors, see the CanopyDeploy API documentation (chapter 4.3 onwards).

FAQ

What is the difference between CanopyDeploy (Clang) and CanopyDeploy Batch (Clang Batch)?

CanopyDeploy (Clang) uses the SOAP API for real-time sending. CanopyDeploy Batch uses the REST API with batch processing. The Batch connector is recommended for most use cases as it handles larger volumes more reliably.

How do I configure the endpoint correctly?

Copy the webhook URL from CanopyDeploy and separate it into two parts: the URL (without the token) goes in the Endpoint field, and the token value goes in the Token field. For example, if your full URL is https://webhook.myclang.com/...?token=abc123, enter https://webhook.myclang.com/... in Endpoint and abc123 in Token.

What identifier should I use?

Use Hashed Email (SHA256) if you're collecting email addresses. Use Customer ID if you have a separate internal customer identifier. The identifier must be collected and stored in the Data Activation before using the connector.

How often is data sent to CanopyDeploy?

Data is batched and sent every 20 minutes, or when the batch reaches 500-600 profiles, whichever comes first.