User Documentation
Start typing to search…

Integration

To begin the integration, create a Jira ticket for the Capillary Customer Success team. The configuration activities are handled by the Capillary Customer Success team.

The integration involves:

Prerequisites

CategoryRequirement
Access and AccountsActive Capillary organisation account with Connect+ access
Active Adobe Experience Platform (AEP) account with access to Schemas, Datasets, Sources, and Destinations
Valid Adobe Org ID and Sandbox name
Authentication and CredentialsAdobe API credentials: API Key, Client ID, Client Secret, Scope, Grant Type, Auth URL
SFTP credentials for historical data migration: Hostname, Port, Username, Private key or password
Configuration SetupJSON payload samples from Capillary (Profiles and Events)
- Adobe schemas: one for Profiles (with IdentityMap) and one for Events (XDM-compliant)
Datasets mapped to each schema in AEP
Field mapping reference (see sample mappings)

Migrating historical data from Capillary to Adobe

If you already use Adobe and need to align your existing Capillary data with customer profiles in Adobe Experience Platform (AEP), you can perform a one-time historical data migration. This process ensures continuity from day one by syncing past data with Adobe profiles.

Capillary uses the Data Connectors framework in the Insights+ application to export data, which is then securely transferred to Adobe Experience Platform (AEP) over an SFTP connection configured on the Adobe source connector. The exported data is provided in CSV format and delivered as compressed .zip files to ensure both efficiency and security.

Steps to perform migration

  1. Launch your SFTP server (for example, SFTP Cloud) and locate connection details such as username, port, and host.

  2. Enter the SFTP connection details in Capillary’s Insights+ Data Connectors. You can also schedule exports. Data is sent as CSV files in compressed .zip format.using data connectors. Refer to Insights+ documentation for more information.

  3. Check the status of your export schedule. The application displays if a transfer is completed. Review logs to verify the file path and details. Exported data arrives as a ZIP file.

  4. In AEP, go to Sources and add or select your SFTP account. Specify the repository and folder containing the exported files.

  5. Choose the target datasets, select Delimited as the file format, and set compression type to zipdeplet.

  6. Select or create a dataset in AEP and map source fields (e.g., username → customer ID).

  7. Review and activate data flow. Review your setup, schedule the data flow, and start the import.

  8. Monitor data flow status, confirm records in the target dataset, and preview profiles to ensure attributes were updated correctly.

This process exports data from Capillary to SFTP and then imports it into Adobe Experience Platform, making customer profiles up to date with the latest data. You can also watch the video below for a walkthrough of the process.


Configuring Capillary → Adobe sync

To configure the Capillary - Adobe data sync, perform the following:

  1. Create schemas

    1. Create one schema for Profiles and another for Events.
    2. Define both standard fields and client-specific custom fields.
    3. Add IdentityMap as the identifier. You can use email, phone number, or external ID as the key without changing the configuration.
    4. Ensure both schemas are XDM-compatible with enhancements for standard fields.

    Generic Profile Schema

  2. Create datasets

    1. Create one dataset for Profiles and one for Events.

    2. Associate each dataset with the correct schema.

  3. Create a connection account

    1. In Adobe Experience Platform, go to Sources > Accounts.

    2. Create a connection account between Capillary and Adobe using the Streaming HTTP API option.

    3. Use this account for secure, real-time data transfer.

  4. Create data flows and field mappings

    1. Create one data flow for Profiles and one for Events.
    2. Upload a JSON payload in the Capillary format.
    3. Map the Capillary fields (for example, customerId, points, tier) to the related Adobe fields (for example, userID, loyaltyPoints, loyaltyTier).
    4. Select the appropriate dataset as the target for each data flow.

Note: Refer to the provided sample mappings for guidance.



You can view the sample mappings, Postman collection, and profile schema samples in the linked folder.

  1. Step Perform One-time Setup in Capillary Connect+

After the Adobe setup, configure the integration in Capillary Connect+. This step is performed once per organisation.

  1. Open Connect+ > Adobe Integration template section and in the API Configuration section, enter the required Adobe API configuration details.

    • Org ID
    • Sandbox Name
    • API Key
    • Client ID
    • Client Secret
    • Scope
    • Grant Type
    • Auth URL

  2. Click "Save Configuration".

Once this setup is complete, profile and transaction data will begin to flow from Capillary to Adobe.


Updated 3 days ago