# Zeotap docs > This file is very large and may be truncated. For an index of this content, please refer to https://docs.zeotap.com/llms.txt instead. # Assistant Source: https://docs.zeotap.com/Assistant You are a helpful assistant for Zeotap CDP documentation. Only answer questions based on the Zeotap CDP product documentation — this includes Orchestrate, Profile API, What's New, and general CDP topics. Do not answer questions from or about the Composable CDP section. If a user asks about Composable CDP, politely let them know that the Composable CDP docs are available in the Composable CDP tab but are outside the scope of this assistant. # Delete user profiles Source: https://docs.zeotap.com/api-reference/profile/delete-user-profiles /profileapi.yaml post /cdp/v1/users/_delete Deletes one or more user profiles based on Primary IDs or UCIDs. Supports bulk deletion up to 400 profiles. Requires API Key or Okta JWT authentication. # Search user profiles Source: https://docs.zeotap.com/api-reference/profile/search-user-profiles /profileapi.yaml post /cdp/v1/users/_search Searches for user profiles matching the given identifiers. Requires either an API key or an Okta JWT bearer token. # Write user profile data Source: https://docs.zeotap.com/api-reference/profile/write-user-profile-data /profileapi.yaml post /cdp/v1/users Upserts user profile data into the CDP. Requires either an API key or an Okta JWT bearer token. # Acceptable Use Policy Source: https://docs.zeotap.com/articles/acceptable-use-policy-publication/acceptable-use-policy Use of the System and/or Products are subject to this Acceptable Use Policy (“AUP”). Capitalized terms used but not defined below, shall have the meaning as outlined in the Agreement between the Client (“Client”/”you”) and Zeotap. In the event that Zeotap suspects any breach of the requirements of the Agreement and/or the AUP, Zeotap may suspend Client and/or User access to the System and/or Services without advanced notice, in addition to such other remedies as Zeotap may have. ## Prohibited Use Client agrees not to, and not to allow Users or third parties to use the System and/or Products: * to violate, or encourage the violation of, the legal rights of others; * to reverse engineer, decompile, translate, disassemble, or otherwise attempt to extract any or all of the source code of the Services or System; * to access or use the System in a manner intended to avoid incurring fees or to circumvent Services specific usage limits; * to engage in, promote or encourage illegal activity; * for any unlawful, invasive, defamatory or fraudulent purpose (for example, this may include phishing, creating a pyramid scheme or mirroring a website in order to submit deceptive, fraudulent, obscene, threatening, or harmful contents); * to intentionally distribute viruses, worms, Trojan horses, corrupted files, hoaxes, or other items of a destructive or deceptive nature; * to compromise the integrity of the System, which include, but is not limited to disable, interfere with or circumvent any aspect of the System; * to generate, distribute, publish or facilitate unsolicited mass email, promotions, advertisements or other solicitations; * to use the System, or any interfaces provided with the Services, in a manner that violates the terms of the Agreement; * to sell, resell, sublicense, transfer, or distribute any or all of the Services, unless authorized by Zeotap; * to allow third parties to exploit the System, except as specifically authorized by the Agreement; * to provide the System passwords or other log-in information, including Access Details, to any third party, except as specifically authorized by the Agreement; * to share nonpublic System features or content with any third party, except as specifically authorized by the Agreement; * to access the System in order to build a competitive product or service, to build a product using similar ideas, features, functions or graphics, or to copy any ideas, features, functions or graphics of the System; * to engage in web scraping or data scraping on or related to the System, including without limitation collection of information through any software that simulates human activity or any bot or web crawler; * to access any computer or communications system without authorization, including the computers used to provide the Service; * to attempt to penetrate or disable any security system; * to attempt to access or otherwise interfere with the accounts of other users of the System. ## Utility Limits Please note that the use of the System is subject to the following limits to ensure uninterrupted functioning. If your Order Form includes different limits from any of the limits below, then the Order Form will take precedence. If your usage exceeds the limits listed below or listed in the Order Form, Zeotap reserves the right to take corrective action, including, but not limited to, the throttling of our APIs or temporary suspension. If you require higher limits, please contact a dedicated account manager or reach out to our customer success team to discuss available options. | **Metric** | **Limit** | **UNIT OF MEASURE** | | :- | :- | :- | | Profile API | 150 | qps | | Active models in Predictive Audiences | 10 | Number of models | | Refresh Frequency- Predictive Audiences | 1 | monthly | | Calculated Attributes | 15 | Number of active calculated attributes | | Non-customer entities | 5 | Number of active entities (Sources) | | 1st party Segments | 300 | Number of active Segments | | 3rd party Segments | 25 | Number of active Segments | | Predictive Models | 10 | Number of active models | | Object Attributes | 10 | Number of active object columns per Org | | Object Properties | 15 | Number of properties per object | | Array Attributes | 15 | Number of active array columns per Org | | Array Values | 200 | Number of values per array attributes | | Array of Object Attributes | 10 | Number of array of objects per Org | | Array of Object Values | 50 | Number of object per array of object attributes | | Catalog | 800 | Max number of attributes in a catalog for an Org | Zeotap reserves the right to only accept the following data types as Events: strings, numbers, arrays, objects, timestamps. An Event is a record of data uploaded or integrated into the System for processing. Each record of data, including up to 300 attributes, is considered one Event. An Event may not contain more than 300 columns, with the total number of columns limited to 800. Examples of events include, but are not limited to, any user activity on a website or app, user data uploaded via flat files or from a CRM, cookie syncs, consent syncs, API calls, and non-customer data such as product catalogs, flight information, campaigns, etc.An Event is a record of data uploaded or integrated into the System for processing. Each record of data, including up to 300 attributes, is considered one Event. An Event may not contain more than 300 columns, with the total number of columns limited to 800. Examples of events include, but are not limited to, any user activity on a website or app, user data uploaded via flat files or from a CRM, cookie syncs, consent syncs, API calls, and non-customer data such as product catalogs, flight information, campaigns, etc. ## Usage Client will: (i) monitor its own use of the Client data within the System, including but not limited to, the accuracy, reliability of the Client data and whether or not the Client data can be used within the context of the Services (ii) use commercially reasonable efforts to prevent and terminate any unauthorized use of, or access to, the System and/or Services (including without limitation by protecting its passwords and other log-in information), and (iii) promptly notify Zeotap of any known or suspected unauthorized use of, or access to, the System, or Client’s password, or breach of its security and shall use best efforts to stop said breach. Zeotap reserves the right to investigate any potential violation of the AUP by Client. ## Artificial Intelligence System Clients acknowledge that the AI system (chatbot) developed by Zeotap to assist with audience segment creation may retain a copy of the users' prompts (i.e., the client’s requests when interacting with the AI system) for up to 30 days for the purpose of product improvement and optimization. ## Disclaimer Zeotap may revise this AUP at any time by amending this page. Clients are expected to check this page periodically to take notice of any changes made by Zeotap. **This Policy was last modified in April 2024.** # Access Rules Source: https://docs.zeotap.com/articles/admin-customer/access-rules Control which sources and attributes can be pulled into an audience or journey, and which destinations it can be activated to, folder by folder. Layer 3 of Zeotap's governance model, on top of Folder Access Control and Mandatory Templates. ## What this is Access Rules govern data in both directions inside a folder: which sources and attributes can be pulled **into** an audience or journey, and which destinations that audience or journey can be activated **out** to. An admin sets the rule on a source or a destination, then picks the audience and journey folders it applies to. Without Access Rules, every source connected to the org and every destination configured in it is usable by everyone. Any user can pull any attribute from any source into any audience, and send any audience to any destination. Access Rules let admins narrow that, so each team works with the data it needs and activates only to the channels it should. Access Rules are the third layer in Zeotap's governance model, building on [Folder Access Control](/articles/admin-customer/my-roles#managing-folder-access-for-audience-module) and **Mandatory Templates**. ## How Access Rules fit into your governance model | Layer | Feature | What it controls | | :-: | - | - | | 1 | [Folder Access Control](/articles/admin-customer/my-roles#managing-folder-access-for-audience-module) | Which folders each team can see and work in | | 2 | **Mandatory Templates** | What row-level conditions apply to every audience in a folder | | 3 | **Access Rules** | Which sources, attributes and destinations each folder can use | Together, these three layers let you build a governance structure that matches how your org actually operates — different teams, different data access, different activation rights — all within a single CDP workspace. ## How Access Rules work **Access Rules work on a blocklist basis.** Every source and destination is available across all folders by default. Admins restrict access by explicitly blocking a source, a set of attributes, or a destination from specific folders. Everything not explicitly blocked remains accessible. **Rules are applied at the folder level.** A rule set on a parent folder automatically propagates to all its subfolders, so governance coverage is consistent without requiring repetitive configuration. **Existing work is not disrupted.** When a rule is applied to a folder that contains existing audiences or journeys using the now-restricted source, attribute, or destination, those audiences and journeys continue running without interruption. They are flagged for review, but not stopped. Teams must resolve the conflict before publishing any future changes to affected audiences or journeys — either by removing the restricted attribute or destination from the definition, or by asking an admin to update the rule. > [!NOTE] > > **The two rule types are not equally granular.** A Source Access Rule can block an entire source or only specific attributes within it. A Destination Access Rule applies to the **entire destination** — there is no mapping-level or attribute-level granularity, because the governance concern there is which channels a team can activate to, not the specific data being sent. ### Blocking a source can affect more than that source Zeotap unifies attributes across sources. If two ingested sources both contribute to the same unified attribute and one of them is blocked in a folder, that unified attribute becomes unavailable in the folder even though the second source is still active. Admins are shown a warning before confirming a configuration that has this effect. [Source Access Rules](/articles/integrate-customer/source-access-rules) covers this in full. ## What cannot be restricted * **Archive folders.** Access Rules cannot be applied to them. * **The Join Key in sources tagged as Customer Parent Model.** It cannot be restricted in any folder, because it is the foundation that enables profile unification — restricting it would break identity resolution across the org. ## Moving folders, audiences and journeys When a folder is moved within the folder hierarchy, its permissions update to match those of its new parent folder. This applies in both directions — a restricted subfolder moved into an unrestricted parent loses its restrictions, and an unrestricted subfolder moved into a restricted parent inherits those restrictions. Moving an audience or a journey behaves differently. If the audience or journey uses an attribute or a destination that is restricted in the target folder, the move is prevented. Remove the restricted attribute or destination from the audience or journey first, then move it. ## Who can configure Access Rules The following built-in roles can configure Access Rules: * **CDP Admin** * **CDP Manager** * **Integrations Admin** * **Integrations Manager** See [Role Descriptions](/articles/admin-customer/role-descriptions) for what each of these roles covers more broadly. Alternatively, admins can create a [custom role](/articles/admin-customer/my-roles) and assign the **view/edit access rules** permissions to it from the **My Roles** page in the Admin section. ## Where to configure Access Rules Configuration lives where the workflow happens — you open the individual source or destination and configure the rule there. For step-by-step configuration, including UI screenshots and impact warnings, see the page that matches what you are restricting: * [Source Access Rules](/articles/integrate-customer/source-access-rules) — block sources or specific attributes from audience and journey folders. * [Destination Access Rules](/articles/integrate-customer/destination-access-rules) — block destinations from audience and journey folders. ## Next steps * [Source Access Rules](/articles/integrate-customer/source-access-rules) — configure, edit and delete source and attribute restrictions, and see what users experience when one applies. * [Destination Access Rules](/articles/integrate-customer/destination-access-rules) — configure, edit and delete destination restrictions. * [My Roles](/articles/admin-customer/my-roles) — set up Folder Access Control, the first governance layer. * [Work with Folders](/articles/segment-customer/work-with-folders) and [Journey Folders](/articles/orchestrate-customer/journey-folders) — organise the audience and journey folders that Access Rules are applied to. # My Users Source: https://docs.zeotap.com/articles/admin-customer/add-an-user After creating an organisation, you are required to onboard a user to the organisation. Perform the following steps to create an organisation. **Step 1** Log into the Zeotap CDP App and go to the **Admin** application. **Step 2** Go to the **My Users** and click **Invite User**. ![](https://mintcdn.com/zeotap/vFAAmDAYNzRboQBn/articles/admin-customer/Storage/admin-customer/creating-an-organisation/admin_my_users_1.png?fit=max\&auto=format\&n=vFAAmDAYNzRboQBn\&q=85\&s=b40136b15b06df77596f2a64aedf43c0) **Step 3** Select the Organisation to which this user belongs. **Step 4** Enter the **Email ID**, **First Name** and **Last Name** of the user and click **Next**. ![](https://mintcdn.com/zeotap/vFAAmDAYNzRboQBn/articles/admin-customer/Storage/admin-customer/creating-an-organisation/admin_my_users_2.png?fit=max\&auto=format\&n=vFAAmDAYNzRboQBn\&q=85\&s=f952023625d18305df475f93e0382446) **Step 5** Under the **Product Access** section, provide the following details for the various products: * **Select Admin Portal Access** – Choose the access level for the admin portal of the organisations to which the user belongs. * **Select Organisation** – Choose the Organisation to which the user belongs. * **CDP Products** – Choose the appropriate role for the user for the CDP products. * **Country Specific Product** – Select the list of countries for giving access to Target, Connect and Predictive Audience. ![](https://mintcdn.com/zeotap/vFAAmDAYNzRboQBn/articles/admin-customer/Storage/admin-customer/add-an-user/add-an-user-2023-09-13.png?fit=max\&auto=format\&n=vFAAmDAYNzRboQBn\&q=85\&s=cf08aae1517a1a344f439210c3e3395e) **Step 6** Once you have provided all the necessary details, click **Review**. In this stage, you can verify your selections. **Step 7** If you want to edit the selections, click **Edit**. Otherwise, click **Save** to add the user. ![](https://mintcdn.com/zeotap/vFAAmDAYNzRboQBn/articles/admin-customer/Storage/admin-customer/creating-an-organisation/admin_my_users_3.png?fit=max\&auto=format\&n=vFAAmDAYNzRboQBn\&q=85\&s=8c2f390dd1bea8c003aa44b203b739ef) # Admin Source: https://docs.zeotap.com/articles/admin-customer/admin The Admin module allows you to create an Organisation and then add Users with specific roles and access. You can create one or more organisation and accordingly enable features for each of the organisations. For each product, there is a particular role to be assigned to a user. To get started with creating an Organisation in Admin, refer [here](/articles/admin-customer/creating-an-organisation). ## Relationship Between the Parent and Child Organisation The parent organisation provides flexibility of products. For example, assume that there is a group company (Company `A`) also known as the parent company which has multiple child companies (Company `B` and `C`) under it. While creating the parent organisation, that is Company `A`, grant it the master level configuration. Therefore, while creating the child organisation Company `B` and `C`, they actually inherit those configurations from the parent organisation Company `A`. With the parent-child relationship not defined, Zeotap is chosen as the parent organisation. Also, when the parent-child relationship is defined, Zeotap is considered as the parent organisation for the parent organisation in the parent-child relationship. While creating a User, you have the flexibility while granting access. For example, assume that the General Manager (User `A`) of Company `A` wants to see have a bird’s eye view of all the activities happening across the Company `B` and `C`. These activities can range from the number of segments being created to number of Sources being created. You can grant User `A` the Admin Role with permission to monitor and control activities across the children organisations. ## Related Topics This section provides a step-by-step guidance on how to create an organisation and a user. It covers the following topics: > [card] [How to create an Organisation?](/articles/admin-customer/creating-an-organisation) > [card] [How to add a User?](/articles/admin-customer/add-an-user) > [card] [Feature/Functionalities available for different User Roles](/articles/admin-customer/user-roles-and-access) > [card] [User roles and their descriptions](/articles/admin-customer/role-descriptions) > [card] [How to raise an Access Request?](/articles/admin-customer/request-access) > [card] [Organisation/User creation process for different teams](/articles/admin-customer/process-to-follow-for-org-user-creation-or-access-1) # Alerts & Notifications Source: https://docs.zeotap.com/articles/admin-customer/alerts-and-notifications Monitor the health of your CDP by email. Manage the default alerts for the Audience and Source modules, set thresholds, lookback windows and size-deviation conditions, scope alerts with filters, and choose who gets notified. Alerts & Notifications lets you monitor the health of your CDP without watching dashboards. When something you care about happens — or fails to happen, such as a source missing its scheduled pull — the platform emails the people you nominate. Every alert follows the same shape: > **When** an event occurs or fails to occur → **notify** the recipients you choose → **via** email. Alerts currently cover the **Audience** and **Source** modules, with more to follow in future releases. ![The Alerts & Notifications page showing the Source and Audience tabs and the Create Custom Alert button.](https://mintcdn.com/zeotap/LD3WLKWqCZxZBrqE/articles/admin-customer/Storage/admin-customer/alerts-and-notifications/alerts-page.png?fit=max\&auto=format\&n=LD3WLKWqCZxZBrqE\&q=85\&s=f20b39aa9dc371362d732901b5bddf91) ## Who can manage alerts | Role | What they can do | | - | - | | **Admin** for the Admin module | Create, edit and delete alerts, and change their enabled state. | | **Partner** | Read-only — view existing alerts without changing them. | See [User Roles and Access](/articles/admin-customer/user-roles-and-access) for how roles are assigned. ## Where to find it Go to **Admin → Alerts & Notifications** in the left sidebar. The page opens with two tabs — **Source** and **Audience** — and each tab has its own **Default Alerts** and **Custom Alerts** sections. Use **Search by Alert Name** to jump to an alert once you have a few. ![The Admin section of the left sidebar, with Alerts & Notifications selected below Audit Logs.](https://mintcdn.com/zeotap/LD3WLKWqCZxZBrqE/articles/admin-customer/Storage/admin-customer/alerts-and-notifications/sidebar-nav.png?fit=max\&auto=format\&n=LD3WLKWqCZxZBrqE\&q=85\&s=51e01cce0f113d50b2f7417d4b149a85) ## Default alerts Default alerts are pre-configured by Zeotap, so you have monitoring coverage without setting anything up. The failure alerts are on out of the box; the rest are off until you enable them. You can toggle any of them, change their recipients, or narrow them with filters. ![The Default Alerts list on the Audience tab, with an Enabled or Disabled toggle on each alert card.](https://mintcdn.com/zeotap/LD3WLKWqCZxZBrqE/articles/admin-customer/Storage/admin-customer/alerts-and-notifications/default-alerts.png?fit=max\&auto=format\&n=LD3WLKWqCZxZBrqE\&q=85\&s=17d7b9720d116e9e3103382bba3310b8) ### Audience alerts | Alert | Default state | Fires when | | - | - | - | | **Audience Failure** | Enabled | An audience fails during its processing lifecycle. | | **Audience Refresh Failed** | Enabled | An audience upload to a destination fails, after retries. | | **Audience Refresh Delay** | Disabled | An audience refresh runs late — overdue past its grace period while still in progress. | | **Audience Refresh Missing** | Disabled | A scheduled audience refresh never starts — overdue past its grace period, with the last run having succeeded. | | **Audience Modified** | Disabled | An audience's configuration is modified. | | **Audience Created** | Disabled | A new audience is created. | | **Audience Refresh Completed** | Disabled | An audience refresh completes successfully. | | **Audience Size Change** | Disabled | An audience-destination pair's delivered size drops or spikes away from its usual size. Zeotap detects this automatically by default, or you can set your own threshold. | ### Source alerts | Alert | Default state | Fires when | | - | - | - | | **Source Pull Missing** | Enabled | A source does not start its scheduled pull within the threshold you set after the scheduled start time. | | **Source Pull Failed** | Enabled | A source data pull terminates with an error. | | **Source Created** | Disabled | A new source is created. | > [!NOTE] > > For what each failure scenario means and how to resolve it, see [Audience Alerts](/articles/segment-customer/audience-alerts) and [Source Alerts](/articles/integrate-customer/source-alerts). ### Manage a default alert Each alert card has an **Enabled**/**Disabled** toggle and a menu offering **Edit**, **Duplicate** and **Delete**. The trigger event on a default alert is fixed — on the **Edit Alert** screen, **Alert Name** and **Trigger Alert When** are read-only. You cannot repoint a "Source Pull Failed" alert at a different event. To monitor something else, [create a custom alert](#create-a-custom-alert) or duplicate a default alert and use it as a template. > [!TIP] > > **Duplicate** creates a copy named `[Original Name] (Copy)`, saved **disabled**. That gives you room to adjust the thresholds, filters and recipients before it starts sending anything. ### Set a threshold, lookback window or deviation condition Which condition you get depends on the kind of event the alert watches. This is the part worth understanding before you tune anything. **Absence-type alerts** — such as Audience Refresh Missing, Audience Refresh Delay or Source Pull Missing — take an **Add Missing Threshold**. It sets how long to wait after the scheduled start time before the event counts as missing and the alert fires. ![Edit Alert for Audience Refresh Missing, with Add Missing Threshold set to trigger if not started within 1 hour of the scheduled start time.](https://mintcdn.com/zeotap/LD3WLKWqCZxZBrqE/articles/admin-customer/Storage/admin-customer/alerts-and-notifications/add-missing-threshold.png?fit=max\&auto=format\&n=LD3WLKWqCZxZBrqE\&q=85\&s=4acc6353e15ec37f7860ad633cc7c364) **Failure-type alerts** — such as Audience Failure or Source Pull Failed — take an **Add Lookback Condition** instead. Rather than emailing on every single failure, it bundles repeats into one notification: set a count, a comparison and a window, and you get a single email when the threshold is crossed. For example, **When Count** *Greater Than* **2** *within the last* **24** *Hour(s)* sends one email if an audience fails more than twice in a day. ![Edit Alert for Audience Failure, with Add Lookback Condition set to When Count Greater Than 2 within the last 24 Hours.](https://mintcdn.com/zeotap/LD3WLKWqCZxZBrqE/articles/admin-customer/Storage/admin-customer/alerts-and-notifications/add-lookback-condition.png?fit=max\&auto=format\&n=LD3WLKWqCZxZBrqE\&q=85\&s=8cc48130cd7d9d61af1148138165b9c9) **Size-change alerts** — such as Audience Size Change — compare each refresh against the audience's recent history rather than the previous refresh alone. They give you two ways to decide what counts as unusual; pick one. **Let Zeotap detect anomalies automatically** — Zeotap learns each audience-destination pair's normal size pattern and alerts when a refresh falls outside it. There is nothing to configure, which makes this the quickest way to get coverage. This is the default. ![Edit Alert for the Audience Size Change alert, with Let Zeotap detect anomalies automatically selected and Deviation Condition left unticked.](https://mintcdn.com/zeotap/xQWySGElEHcwlwIP/articles/admin-customer/Storage/admin-customer/alerts-and-notifications/deviation-condition.png?fit=max\&auto=format\&n=xQWySGElEHcwlwIP\&q=85\&s=f5f98d28797cceb7bebf35c251b48a54) **Deviation Condition** — set the rule yourself: > Alert when size **Drops or Spikes** by more than **20** % when compared against the **Mean** of the last **7** refreshes. | Setting | Options | What it controls | | - | - | - | | **Direction** | Drops, Spikes, Drops or Spikes | Which kind of change should alert. | | **Threshold** | A percentage | How far the size must move from the baseline before the alert fires. | | **Baseline** | Mean, Median | How the recent refreshes are averaged. Median ignores one-off outliers; Mean reacts faster to genuine shifts. | | **Refreshes** | A number of past refreshes | How much history forms the baseline. | The comparison is made at audience and destination level, so the same audience sent to two destinations is tracked separately. > [!NOTE] > > Because the alert compares against a baseline of several refreshes, the percentage in the email will not always match the change from the previous refresh alone. ### Scope an alert with filters By default an alert covers your whole organisation. Tick **Add Filter** to narrow it to specific folders, sources or other resources — useful when one team only wants alerts for the audiences it owns. Filters use the same condition builder you know from audiences: pick a field, an operator and a value, combine conditions with **AND**/**OR**, and group them with **+ Add Condition Block**. ![Edit Alert with Add Filter enabled, showing a condition of Folder Name Equal Default and the option to add more condition blocks.](https://mintcdn.com/zeotap/LD3WLKWqCZxZBrqE/articles/admin-customer/Storage/admin-customer/alerts-and-notifications/add-filter.png?fit=max\&auto=format\&n=LD3WLKWqCZxZBrqE\&q=85\&s=3bd96aaccf3b7e90b5ccbc4a6a3620c8) ### Choose who gets notified Under **Send Alerts To**: * **Email** — the delivery channel. This is currently the only channel available. * **Resource Creator** — notifies whoever created the audience or source being monitored. On by default. * **Add Additional Recipients** — add any other email addresses that should receive the alert, up to a maximum of 20 recipients. ![The Send Alerts To panel with Email, Resource Creator and Add Additional Recipients selected, and a note that a maximum of 20 recipients is allowed.](https://mintcdn.com/zeotap/LD3WLKWqCZxZBrqE/articles/admin-customer/Storage/admin-customer/alerts-and-notifications/send-alerts-to.png?fit=max\&auto=format\&n=LD3WLKWqCZxZBrqE\&q=85\&s=8d5cec4e610dd0c43857cd1638c661f9) ### Enable or disable an alert Use the toggle on the alert card. Disabling pauses the notifications but keeps the configuration intact, which is what you want during planned maintenance or a temporary change in how a team works — you can switch it back on without rebuilding anything. ## Create a custom alert Create a custom alert when the defaults do not cover what you need — for example, watching a single source, or pairing an event with your own threshold and recipient list. **1. Open Alerts & Notifications** Go to **Admin → Alerts & Notifications**. **2. Pick the tab** Choose the **Source** or **Audience** tab, depending on what you want to monitor. **3. Start a new alert** In the **Custom Alerts** section, select **Create Custom Alert**. **4. Name the alert** Give it a clear, descriptive name. The name identifies the alert in the list and in the notification emails, so something like `Source Pull - Brand Team` beats `Alert 3`. **5. Choose the trigger event** Under **Trigger Alert When**, select the event to watch — for example **Audience Refresh Failed**, **Audience Failure** or **Source Pull Missing**. ![The Create Custom Alert dialog with the Trigger Alert When dropdown open, listing events such as Audience Refresh Failed, Audience Failure and Source Pull Missing.](https://mintcdn.com/zeotap/LD3WLKWqCZxZBrqE/articles/admin-customer/Storage/admin-customer/alerts-and-notifications/create-custom-alert-trigger.png?fit=max\&auto=format\&n=LD3WLKWqCZxZBrqE\&q=85\&s=68d94bb082bbb81090d71bcd7ba273ea) **6. Set the condition, if the event has one** Depending on the event you picked, you get an **Add Missing Threshold** field (absence-type events), an **Add Lookback Condition** field (failure-type events), or a **Deviation Condition** with the option to **Let Zeotap detect anomalies automatically** (size-change events). Some events have none of these. **7. Add filters (optional)** Tick **Add Filter** to scope the alert to particular resources instead of the whole organisation. On the Audience tab you can filter on **Audience ID**, **Audience Name** or **Folder Name**. ![The Create Custom Alert dialog with Add Filter enabled and the field dropdown open, showing Audience ID, Audience Name and Folder Name.](https://mintcdn.com/zeotap/LD3WLKWqCZxZBrqE/articles/admin-customer/Storage/admin-customer/alerts-and-notifications/create-custom-alert-filter.png?fit=max\&auto=format\&n=LD3WLKWqCZxZBrqE\&q=85\&s=850fadcc19fdd0b3f63ad5580dbf8bf9) **8. Choose the recipients** Email is on by default, and so is **Resource Creator** — clear it if the creator should not be notified. Add any other addresses under **Add Additional Recipients**. **9. Save** Save the configuration. The alert starts working immediately, according to its enabled state. ### Field reference | Field | Description | | - | - | | **Alert Name** | Free text. Shown in the alert list and in the subject and header of the notification emails. | | **Trigger Alert When** | The event this alert watches for. Fixed on default alerts; selectable on custom alerts. | | **Add Missing Threshold** | Absence-type events only. How long to wait after the scheduled start time before the event counts as missing. | | **Add Lookback Condition** | Failure-type events only. Bundles repeated occurrences into a single notification within the window you set. | | **Deviation Condition** | Size-change events only. Alerts when a refresh's size moves more than the set percentage away from the Mean or Median of the last N refreshes, in the direction you choose. | | **Let Zeotap detect anomalies automatically** | Size-change events only. Zeotap decides what counts as an anomaly from the audience's history; no threshold to set. The default for size-change alerts. | | **Add Filter** | Optional. Scopes the alert to specific resources instead of triggering across the organisation. | | **Send Alerts To — Email** | The delivery channel. Currently the only one available. | | **Send Alerts To — Resource Creator** | Notifies whoever created the monitored audience or source. Enabled by default. | | **Send Alerts To — Additional Recipients** | Optional. Further email addresses, up to 20 recipients. | ## FAQs > [accordion] Why am I not getting emails for an alert that is enabled? > > Check the alert's filters first — a filter scoped to a folder or resource you are not using will stop it firing for anything else. Then check **Send Alerts To**: if **Resource Creator** is cleared and no additional recipients are listed, the alert has nobody to notify. > [accordion] Can I stop an alert without losing its configuration? > > Yes. Disable it with the toggle on the alert card. The thresholds, filters and recipients are all kept, so switching it back on restores the same behaviour. > [accordion] Can I point a default alert at a different event? > > No — the trigger event on a default alert is fixed, and both **Alert Name** and **Trigger Alert When** are read-only when you edit one. Create a custom alert, or duplicate the default alert and adjust the copy. > [accordion] Why would I use a lookback condition instead of alerting on every failure? > > To avoid a flood. A source that fails on every retry can generate a lot of individual emails; a lookback condition turns that into one notification when the count crosses your threshold in the window you set. > [accordion] Should I let Zeotap detect anomalies or set my own deviation condition? > > Start with automatic detection: it adapts to each audience's normal pattern without any tuning. Switch to a deviation condition when you need a specific, explainable rule — for example, "alert me if this audience drops more than 30%". > [accordion] Why doesn't the percentage in a size-change email match the last refresh? > > The alert measures each refresh against a baseline of several recent refreshes, not just the one before it. The email shows the baseline value alongside the current size so you can see what it was compared against. > [accordion] Why didn't I get a size-change alert when my audience dropped to zero? > > Very small and empty audiences are excluded from size-change alerts. A refresh that delivers nothing is already reported by the refresh alerts, so you won't be told about the same problem twice. > [accordion] Will I get an email on every refresh while an audience stays unusual? > > No. After a size-change alert fires for an audience-destination pair, repeat alerts for it are paused for 24 hours to avoid a flood. > [accordion] How many people can receive one alert? > > Up to 20 additional recipients, plus the resource creator if that option is left enabled. ## Related Topics > [card] [Audience Alerts](/articles/segment-customer/audience-alerts) > [card] [Source Alerts](/articles/integrate-customer/source-alerts) > [card] [Audit Logs](/articles/admin-customer/audit-logs) > [card] [User Roles and Access](/articles/admin-customer/user-roles-and-access) # Audit Logs Source: https://docs.zeotap.com/articles/admin-customer/audit-logs Audit Logs are records that provide details about user activities within your organization. They capture actions performed by users in the Zeotap CDP app and display these actions in a table. This enhances transparency, accountability, and user trust by providing a detailed record of user actions. > [!NOTE] > > **Note:** > > For a complete list of audit log event names and their logging conditions, click [here](/articles/admin-customer/events-tracked-in-zeotap-cdp). Note that only the users with 'Admin' permissions can view audit logs. ## Viewing the Audit Logs Perform the following steps to view Audit Logs for your Organisation on Zeotap CDP: **Step 1** Log into the Zeotap CDP App and go to **Admin**. **Step 2** Under the **Admin** module, click **Audit Logs**. ![](https://mintcdn.com/zeotap/vFAAmDAYNzRboQBn/articles/admin-customer/Storage/admin-customer/audit-logs/audit-logs-2024-07-01.png?fit=max\&auto=format\&n=vFAAmDAYNzRboQBn\&q=85\&s=fbc2a7a8bfda3964347e233ae566f57c) **Step 3** In the new screen that appears, you can view the list of log entries for your Organisation for the last 7 days. You can adjust the dates as per your preference. Note that you can choose the time period for which you wish to view the log entries using the drop-down menu as shown below. ![](https://mintcdn.com/zeotap/vFAAmDAYNzRboQBn/articles/admin-customer/Storage/admin-customer/audit-logs/audit-logs-2024-07-01-1.png?fit=max\&auto=format\&n=vFAAmDAYNzRboQBn\&q=85\&s=239ff7daa25a8d5d8749dbcd4bb3b77b) **Step 4** Use the **Filters** to select columns such as User Name, Module, Actions, Email and/or Timestamp to find specific entries. ![](https://mintcdn.com/zeotap/vFAAmDAYNzRboQBn/articles/admin-customer/Storage/admin-customer/audit-logs/audit-logs-2024-07-01-2.png?fit=max\&auto=format\&n=vFAAmDAYNzRboQBn\&q=85\&s=6e4dba723f9a397787264a034a3e3fe5) # My Organisation Source: https://docs.zeotap.com/articles/admin-customer/creating-an-organisation The process of onboarding a new client starts with creating an organisation. Perform the following steps to create an organisation: **Step 1** Log into **the Zeotap CDP App** and go to the **Admin** application. **Step 2** Under **My Organisations,** click **+** **Create Organisation.** ![](https://mintcdn.com/zeotap/vFAAmDAYNzRboQBn/articles/admin-customer/Storage/admin-customer/creating-an-organisation/creating-an-organisation-2024-08-16.png?fit=max\&auto=format\&n=vFAAmDAYNzRboQBn\&q=85\&s=09238c13bf8e8420c20da6092c8e4f68) **Step 3** Enter the **Organisation Name**. **Step 4** Select the **Parent Organisation**. Every organisation must have a parent organisation. With the parent-child relationship not defined, Zeotap is chosen as the parent organisation. ![](https://mintcdn.com/zeotap/vFAAmDAYNzRboQBn/articles/admin-customer/Storage/admin-customer/creating-an-organisation/create_org_2.png?fit=max\&auto=format\&n=vFAAmDAYNzRboQBn\&q=85\&s=a6d31082ce80434723d0cf6117c68a35) **Step 5** In the new screen that appears, select the packages that is appropriate for your organisation. **Step 6** If you choose the **CDP package**, then ensure to set the region where you want your data to be stored. ![](https://mintcdn.com/zeotap/vFAAmDAYNzRboQBn/articles/admin-customer/Storage/admin-customer/creating-an-organisation/create_org_3.png?fit=max\&auto=format\&n=vFAAmDAYNzRboQBn\&q=85\&s=cf017287f9a83d0a9c11148e01538d2d) **Step 7** Choose the **Add-Ons** that you wish to have and click **Save**. ![](https://mintcdn.com/zeotap/vFAAmDAYNzRboQBn/articles/admin-customer/Storage/admin-customer/creating-an-organisation/create_org_4.png?fit=max\&auto=format\&n=vFAAmDAYNzRboQBn\&q=85\&s=c7bd481cb83666776d0de0139beecc22) > [!NOTE] > > **Note** > > *To make changes to the selected packages, use the **Edit** button shown below. If an organization created within the Admin module is no longer needed or was created by mistake, you can remove it using the **Delete** button shown below.* > > ![](https://mintcdn.com/zeotap/vFAAmDAYNzRboQBn/articles/admin-customer/Storage/admin-customer/creating-an-organisation/creating-an-organisation-2024-08-16-1.png?fit=max\&auto=format\&n=vFAAmDAYNzRboQBn\&q=85\&s=4a034e926315a5508395bdc4f578da43) # Events Tracked in Zeotap CDP Source: https://docs.zeotap.com/articles/admin-customer/events-tracked-in-zeotap-cdp The following table lists the events tracked in Zeotap CDP for specific actions: | **Logged Event Name** | **Description** | | :- | :- | | ADMIN_APPROVE_ACCESS | Logged when you approve an access request in the Admin panel. | | ADMIN_AUDIT_LOG_CLICK | Logged when you access the audit log in the Admin section. | | ADMIN_CREATE_ORGANISATION_BUTTON | Logged when you click the button to initiate the creation of a new organization within the Admin interface. | | ADMIN_CREATE_ORGANISATION_SAVE | Logged when you save the newly created organization within the Admin interface. | | ADMIN_CREATE_USER_CANCEL | Logged when you cancel the process of creating or editing a user account within the Admin interface. | | ADMIN_CREATE_USER_SAVE | Logged when you save the details of a newly created user account within the Admin interface. | | ADMIN_EDIT_ORGANISATION | Logged when you access the editing interface for a specific organization within the Admin dashboard. | | ADMIN_EDIT_USER | Logged when you access the editing interface for a specific user account within the Admin dashboard. | | ADMIN_INVITE_USER_BUTTON | Logged when you initiate the process of inviting a new user by clicking the respective button. | | ADMIN_MY_ORGANISATIONS_CLICK | Logged when you navigate to the "My Organizations" section in the Admin interface by clicking the respective link. | | ADMIN_MY_USERS_CLICK | Logged when you navigate to the "My Users" section in the Admin interface to access user management functionalities. | | ADMIN_ORGANISATION_CANCEL | Logged when you cancel the process of creating or editing an organization within the Admin interface. | | ADMIN_RAISE_NEW_REQUEST_BUTTON | Logged when you initiate the process of raising a new access request by clicking the respective button. | | ADMIN_RAISE_NEW_REQUEST_CANCEL | Logged when you cancel a new access request in the Admin panel. | | ADMIN_REQUEST_ACCESS_BUTTON | Logged when you click the button to request access to specific resources or functionalities within the Admin interface. | | ADMIN_REQUEST_ACCESS_CLICK | Logged when you click the "request access" option within the Admin interface to initiate a request for accessing certain resources. | | ADMIN_UPDATE_ORGANISATION_BUTTON | Logged when you click the button to update or save changes made to an organization’s details. | | ADMIN_UPDATE_ORGANISATION_BUTTON | Logged when you update organization settings in the Admin panel. | | ADMIN_UPDATE_USER_BUTTON | Logged when you click the button to update or save changes made to a user’s account details. | | ADMIN_VIEW_MY_ORGANISATIONS_LIST | Logged when you view the list of organizations associated with the Admin account. | | ADMIN_VIEW_MY_USERS_LIST | Logged when you view the list of users managed by the Admin account. | | ADMIN_VIEW_REQUEST_ACCESS_LIST | Logged when you access and view the list of access requests made within the Admin interface. | | ADMIN_VIEW_REQUEST_BUTTON | Logged when you view the details of a specific access request within the Admin interface. | | AUDIENCE_AB_TESTING | Logged when you access the A/B testing section for an audience. | | AUDIENCE_ACTIVATE | Logged when you activate an audience. | | AUDIENCE_ACTIVATE_LATER_CLICK | Logged when you choose to activate an audience at a later time. | | AUDIENCE_ADA_GENERATE | Logged when you choose the “Generate Audience” button through AI. | | AUDIENCE_ADA_GENERATE_ERROR | Logged when you get an error on the audience creation through AI. | | AUDIENCE_ADA_GENERATE_SUCCESS | Logged when you get a successful query created through ADA. | | AUDIENCE_ADD_NEW_AB_COHORT | Logged when you add a new cohort for an A/B test within an audience. | | AUDIENCE_ADD_TAG | Logged when you add any tag to the audience. | | AUDIENCE_ADDNEW_AB_COHORT | Logged when you click the add cohort button. | | AUDIENCE_ARCHIVE | Logged when you choose to archive the audience progress. | | AUDIENCE_ATTACH_DESTINATION | Logged when you attach a destination to an audience. | | AUDIENCE_CANCEL_AB_TEST | Logged when you choose to cancel the test after confirmation. | | AUDIENCE_CANCEL_DESTINATION_SETTING | Logged when you cancel the settings for a destination in an audience. | | AUDIENCE_CANCEL_FOLDER_CREATION | Logged when you choose to cancel the new folder creation. | | AUDIENCE_CANCEL_LINK_DESTINATION | Logged when you choose to cancel linking the destination. | | AUDIENCE_CANCEL_LINKING_AB_DESTINATION | Logged when you cancel linking a destination in an A/B audience. | | AUDIENCE_CANCEL_LINKING_DESTINATION | Logged when you cancel linking a destination to an audience. | | AUDIENCE_CANCEL_SUBFOLDER_CREATION | Logged when you choose to cancel the new subfolder creation. | | AUDIENCE_CANCEL_TEST | Logged when you cancel a test setup for an audience. | | AUDIENCE_CHECK_ESTIMATE_CLICK | Logged when you check the estimated size of an audience. | | AUDIENCE_CREATE_BUTTON | Logged when you select to create a new audience. | | AUDIENCE_CREATE_CANCEL | Logged when you select to cancel the audience creation. | | AUDIENCE_CREATE_DESTINATION | Logged when you choose to create a destination on the fly for the channel. | | AUDIENCE_CREATE_FOLDER_AUD | Logged when you create a new folder while creating an audience. | | AUDIENCE_DEFINE_BASIC_DETAILS_BUTTON | Logged when you click to define the basic details of an audience. | | AUDIENCE_DEFINE_USER_BUTTON | Logged when you select to go to the next step to define a user. | | AUDIENCE_DELETE_AB_COHORT | Logged when you click to delete a cohort. | | AUDIENCE_DELETE_DESTINATION | Logged when you choose to delete the destination. | | AUDIENCE_DELETE_DRAFT | Logged when you choose to delete the saved audience draft. | | AUDIENCE_DELETE_FOLDER | Logged when you delete the folder. | | AUDIENCE_DESTINATION_CREATION | Logged when you create a new destination for an audience. | | AUDIENCE_DESTINATION_DROPPED | Logged when a destination is dropped from an audience. | | AUDIENCE_DETAIL_EDIT | Logged when you choose to edit audience info like name and folder on the defining user page. | | AUDIENCE_DISABLE_MEMBERSHIP | Logged when you disable membership for an audience. | | AUDIENCE_DISABLE_MEMBERSHIP_CLICK | Logged when you click to disable membership for an audience. | | AUDIENCE_DRAFT_CONTINUE_BUILD | Logged when you choose to continue building the audience from a draft. | | AUDIENCE_DUPLICATE | Logged when you choose to duplicate the audience. | | AUDIENCE_EDIT | Logged when you choose to edit audience info on the audience page. | | AUDIENCE_EDIT_AB_TEST | Logged when you click to edit the cohort. | | AUDIENCE_EDIT_AUDIENCE_CLICK | Logged when you click to edit an existing audience. | | AUDIENCE_EDIT_COHORT | Logged when you edit a cohort within an audience. | | AUDIENCE_EDIT_MEMBERSHIP_CLICK | Logged when you click to edit audience membership settings. | | AUDIENCE_ENABLE_MEMBERSHIP_CLICK | Logged when you click to enable membership for an audience. | | AUDIENCE_ESTIMATE_DETAIL_VIEW | Logged when you click the detailed view link to see the ID breakdown of the audience. | | AUDIENCE_FILTER | Logged when you apply a filter to an audience. | | AUDIENCE_FILTERING_BLOCK_ADD | Logged when you click to add a conditional block. | | AUDIENCE_FOLDER_CREATION | Logged when you successfully create a new folder. | | AUDIENCE_INSIGHTS | Logged when you view insights related to an audience. | | AUDIENCE_LINK_TO_DESTINATION | Logged when you choose to set a destination. | | AUDIENCE_PAUSE | Logged when you choose to pause the audience progress. | | AUDIENCE_REFRESH_ESTIMATE | Logged when you click the refresh button to get an estimate size of the audience. | | AUDIENCE_RENAME_FOLDER | Logged when you rename the folder. | | AUDIENCE_RESUME | Logged when you choose to resume the audience progress. | | AUDIENCE_SAVE | Logged when you complete building an audience and select the save button. | | AUDIENCE_SAVE_AB_COHORT | Logged when you click next to complete creating the A/B test. | | AUDIENCE_SAVE_AB_DESTINATION_SETTING | Logged when you save settings for an A/B test destination in an audience. | | AUDIENCE_SAVE_AB_TEST | Logged when you save an A/B test configuration for an audience. | | AUDIENCE_SAVE_AS_DRAFT | Logged when you choose to save the current creation as a draft. | | AUDIENCE_SAVE_DESTINATION_SETTING | Logged when you choose to save the settings of the destination. | | AUDIENCE_SAVE_DESTINATIONS | Logged when you save the destinations for an audience. | | AUDIENCE_SAVE_MEMBERSHIP_CLICK | Logged when you click to save the membership settings for an audience. | | AUDIENCE_SAVE_SETTINGS_DESTINATION | Logged when you save settings for a destination in the audience module. | | AUDIENCE_SELECT_CREATE_FOLDER | Logged when you select to create a new folder in the audience module. | | AUDIENCE_SELECT_DELETE_CUSTOMER | Logged when you select the option to delete a customer from an audience. | | AUDIENCE_SELECT_FOLDER | Logged when you select a folder for audience organization. | | AUDIENCE_SET_AB_TEST | Logged when you choose to create an A/B test. | | AUDIENCE_START_AB_TEST | Logged when you choose to save the A/B test confirmation. | | AUDIENCE_SUBFOLDER_CREATION | Logged when you successfully create a new subfolder. | | AUDIENCE_UNSELECT_DELETE_CUSTOMER | Logged when you unselect a customer for deletion in an audience. | | AUDIENCE_VIEW_AB_TEST | Logged when you choose to view the A/B test. | | AUDIENCE_VIEW_ACTIVATIONS | Logged when you view activations associated with an audience. | | AUDIENCE_VIEW_AUDIENCE | Logged when you view the details of an audience. | | AUDIENCE_VIEW_INSIGHT | Logged when you choose to see the Audience Insights. | | AUDIENCE_VIEW_INSIGHT_DESTINATION_DETAILS | Logged when you view destination details within audience insights. | | AUDIENCE_VIEW_INSIGHT_IDENTIFIER_DETAILS | Logged when you view identifier details within audience insights. | | AUDIENCE_VIEW_INSIGHT_METRICS | Logged when you choose to see the Audience Metrics. | | AUDIENCE_VIEW_INSIGHT_OVERLAP | Logged when you view audience overlap insights. | | AUDIENCE_VIEW_INSIGHT_TRENDS | Logged when you view trend insights for an audience. | | AUDIENCE_VIEW_LIFECYCLE | Logged when you choose to see the Audience Lifecycle. | | AUDIENCE_VIEW_OVERLAP | Logged when you choose to see the Audience Overlap. | | AUDIENCE_VIEW_OVERLAP_INSIGHT | Logged when you choose to see Audience Overlap in Insights. | | AUDIENCE_VIEW_OVERLAP_TREND | Logged when you choose to see Audience Overlap in Trends. | | AUDIENCE_VIEW_TREND | Logged when you choose to see the Audience Trend. | | BATCH_CALCULATED_ATTRIBUTES_CANCEL_CLICK | Logged when you cancel the process of creating or editing a batch-calculated attribute by clicking the respective cancel button. | | BATCH_CALCULATED_ATTRIBUTES_CREATE_ATTRIBUTE_CLICK | Logged when you initiate the creation of a new batch-calculated attribute by clicking the designated button. | | BATCH_CALCULATED_ATTRIBUTES_MODULE_CLICK | Logged when you click on the module related to calculated attributes to access its functionalities. | | BATCH_CALCULATED_ATTRIBUTES_SAVE_CLICK | Logged when you save the changes made to a batch-calculated attribute by clicking the respective save button. | | BATCH_CALCULATED_ATTRIBUTES_TAB_CLICK | Logged when you navigate to the tab dedicated to batch-calculated attributes by clicking the respective tab. | | CALCULATED_ATTRIBUTE_ADD_CONDITION_CLICK | Logged when you add a condition to a calculated attribute. | | CALCULATED_ATTRIBUTE_RUN_COMPUTATION_DROPDOWN_CLICK | Logged when you click the dropdown to run a computation for a calculated attribute. | | CALCULATED_ATTRIBUTE_SELECT_AGGREGATION_FIELD | Logged when you select a field for aggregation in a calculated attribute. | | CALCULATED_ATTRIBUTE_SELECT_AGGREGATION_TYPE | Logged when you select an aggregation type for a calculated attribute. | | CALCULATED_ATTRIBUTE_SELECT_EVENT_NAME | Logged when you select an event name for a calculated attribute. | | CALCULATED_ATTRIBUTE_VIEW_ATTRIBUTE | Logged when you view the details of a calculated attribute. | | CALCULATED_ATTRIBUTES_CANCEL_CLICK | Logged when you click to cancel changes in the calculated attributes section. | | CALCULATED_ATTRIBUTES_CREATE_ATTRIBUTE_CLICK | Logged when you click to create a new calculated attribute. | | CALCULATED_ATTRIBUTES_MODULE_CLICK | Logged when you access the calculated attributes module. | | CALCULATED_ATTRIBUTES_SAVE_CLICK | Logged when you click to save a calculated attribute. | | CALCULATED_ATTRIBUTES_TAB_CLICK | Logged when you click on the calculated attributes tab. | | CATALOGUE_ADD_CATALOGUE_FIELD_BUTTON | Logged when you click to add a new field to the Catalogue. | | CATALOGUE_DIY_ADD_NEW_CATALOGUE_FIELD | Logged when you add a new field in the DIY (do-it-yourself) section of the Catalogue. | | CATALOGUE_DIY_CREATE_SOURCE_FIELD | Logged when you create a new source field in the Catalogue. | | CATALOGUE_DIY_DELETE_AUTOMAPPING | Logged when you delete an automapping in the DIY section of the Catalogue. | | CATALOGUE_DIY_NEW_MAPPING | Logged when you create a new custom mapping in the Catalogue. | | CATALOGUE_DOWNLOAD_CATALOGUE | Logged when you download a copy of the catalogue. | | CATALOGUE_EDIT_CATALOGUE_FIELD_ACTION | Logged when you take an action to edit a field in the Catalogue. | | CATALOGUE_FILTERS | Logged when you apply filters in the Catalogue. | | CATALOGUE_HIDE_CATALOGUE_FIELD_ACTION | Logged when you hide a field within the Catalogue. | | CATALOGUE_MAPPING_ADD_CATALOGUE | Logged when you click the “Add Catalogue” button. | | CATALOGUE_MAPPING_DOWNLOAD_CATALOGUE | Logged when you click the “Download Catalogue” button. | | CATALOGUE_MAPPING_EDIT_CATALOGUE | Logged when you click the “Edit Catalogue” button. | | CATALOGUE_MAPPING_FILTERS | Logged when you click the filters button. | | CATALOGUE_MAPPING_HIDE_CATALOGUE | Logged when you click the “Hide Catalogue” button. | | CATALOGUE_MAPPING_SAVE_CATALOGUE | Logged when you click the “Save Catalogue” field button. | | CATALOGUE_SAVE_CATALOGUE_FIELD_BUTTON | Logged when you save changes to a catalogue field. | | CDP_LOGOUT | Logged when you click on the Logout button in the platform. | | COLLECT_ADD_ENRICHER | Logged when you add a data enricher in Collect. | | COLLECT_ADD_RULE_FOR_ACTIVATION | Logged when you add an activation rule in Collect. | | COLLECT_COPY_API_URL | Logged when you copy the API URL in Collect. | | COLLECT_COPY_GSUITE_ID | Logged when you copy the GSuite ID in Collect. | | COLLECT_COPY_PIXEL | Logged when you copy a pixel code in Collect. | | COLLECT_COPY_PROJECT_ID | Logged when you copy the project ID in the Collect module. | | COLLECT_COPY_SFTP_SERVER | Logged when you copy the SFTP server details in Collect. | | COLLECT_COPY_SNIPPET | Logged when you copy a code snippet in the Collect module. | | COLLECT_COPY_UPLOAD_PATH | Logged when you copy the upload path in Collect. | | COLLECT_COPY_USER_ID | Logged when you copy the User ID in Collect. | | COLLECT_COPY_WRITE_KEY | Logged when you copy the write key for a project in Collect. | | COLLECT_CREATE_PIXEL | Logged when you create a new pixel in the Collect module. | | COLLECT_EDIT_PIXEL | Logged when you edit an existing pixel in Collect. | | COLLECT_MAP_TO_ZEOTAP_ADVERTISING | Logged when you map data to Zeotap Advertising in Collect. | | COLLECT_PIXEL_GLOBAL_PROPERTIES | Logged when you access global properties for a pixel in Collect. | | COLLECT_PIXEL_GLOBAL_PROPERTIES_BUTTON | Logged when you access global properties for a pixel in Collect. | | COLLECT_PIXEL_PROPERTIES | Logged when you access properties of a pixel in Collect. | | COLLECT_SAVE_COLLECTION | Logged when you save a data collection in Collect. | | COLLECT_SAVE_ID_DIFFERENTIATION | Logged when you save the ID differentiation settings in Collect. | | COLLECT_SELECT_LINK_EVERYTHING_OPTION | Logged when you select the "Link Everything" option in Collect. | | COLLECT_TRY_BASE64_ENCODER | Logged when you try the Base64 encoder tool in Collect. | | COLLECT_VIEW_CONSENT_TAB | Logged when you view the consent tab in Collect. | | COLLECT_VIEW_IDENTITIES_TAB | Logged when you view the identities tab in Collect. | | CONSENT_ORCHESTRATION_ADD_RULE_FOR_ACTIVATION | Logged when you add a rule for activation in consent orchestration. | | CONSENT_ORCHESTRATION_AUDIENCE_RULE_EDIT | Logged when you edit an audience rule in consent orchestration. | | CONSENT_ORCHESTRATION_AUDIENCE_RULE_SAVE_RULE | Logged when you save an audience rule in consent orchestration. | | CONSENT_ORCHESTRATION_CHANNEL_RULE_EDIT_RULE_BUTTON | Logged when you click to edit a channel rule in consent orchestration. | | CONSENT_ORCHESTRATION_CHANNEL_RULE_SAVE_RULE | Logged when you save a channel rule in consent orchestration. | | CONSENT_ORCHESTRATION_VIEW_CONSENT_TAB | Logged when you view the consent tab in consent orchestration. | | CONSENT_RULES_EDIT_ACTIVATE | Logged when you click the Edit button for "Rule to activate consent for your audiences." | | CONSENT_RULES_EDIT_RULE | Logged when you click the “Edit” button of a rule. | | CONSENT_RULES_NEW_RULE | Logged when you click the “Add Rule” button for a rule. | | CONSENT_RULES_SAVE_RULE | Logged when you click the “Save” button after adding the rule in "Consent rules for channel activation." | | CONSENT_RULES_TRY_ARCHIVE | Logged when you try to archive an existing rule. | | CONSENT_RULES_TRY_EDIT | Logged when you try to edit an existing rule. | | CONSENT_RULES_TRY_PAUSE | Logged when you try to pause an existing rule. | | CONSENT_RULES_TRY_UNPAUSE | Logged when you try to unpause an existing rule. | | CONSENT_RULES_VIEW_INSIGHT | Logged when you try to view insights on an existing rule. | | CREATE_RULE_BUTTON | Logged when you click the create rule button. | | DATALIFECYCLE_NCE_ACTION_EDIT_RULE | Logged when you edit an existing rule in the data lifecycle module. | | DATALIFECYCLE_NCE_ACTION_PAUSE_RULE | Logged when you pause a rule in the data lifecycle module. | | DATALIFECYCLE_NCE_ACTION_UNPAUSE_RULE | Logged when you unpause a rule in the data lifecycle module. | | DATALIFECYCLE_NCE_ACTION_VIEW_INSIGHT | Logged when you view insights related to a rule in the data lifecycle module. | | DATALIFECYCLE_NCE_CREATE_DELETION_RULE_BUTTON | Logged when you click to create a new deletion rule in the data lifecycle module. | | DATALIFECYLCE_NCE_ACTION_ARCHIVE_RULE | Logged when you archive a rule in the data lifecycle module. | | DATALIFECYLCE_NCE_DATALIFECYCLE_TAB | Logged when you access the data lifecycle tab. | | DESTINATIONS_ADD_NEW_MAPPING | Logged when you add a new mapping for a destination. | | DESTINATIONS_CREATE_DESTINATION_BUTTON | Logged when you click to create a new destination. | | DESTINATIONS_DELETE_MAPPING | Logged when you delete a mapping in Destinations. | | DESTINATIONS_DESTINATION_DETAILS_NEXT_BUTTON | Logged when you click “Next” in the destination details view. | | DESTINATIONS_EDIT_DESTINATION_DETAILS | Logged when you edit details of a destination. | | DESTINATIONS_EDIT_MAPPING | Logged when you edit an existing mapping for a destination. | | DESTINATIONS_HOME_TAB | Logged when you navigate to the home tab in the Destinations module. | | DESTINATIONS_MAPPING_CREATE_DESTINATION_BUTTON | Logged when you click to create a new destination in the destination mapping section. | | DESTINATIONS_PRIVATE_DESTINATION_LIST | Logged when you view the list of private destinations. | | DESTINATIONS_PUBLIC_DESTINATION_LIST | Logged when you view the list of public destinations available. | | DESTINATIONS_SELECT_CHANNEL | Logged when you select a channel within Destinations. | | ID_STRATEGY_CUSTOM_STRATEGY | Logged when you select a custom strategy for ID handling. | | ID_STRATEGY_CUSTOM_STRATEGY_SAVE | Logged when you save a custom ID strategy. | | ID_STRATEGY_DEFAULT_STRATEGY | Logged when you set or view the default ID strategy. | | ID_STRATEGY_ID_DIFFERENTIATION_STEP1 | Logged when you complete Step 1 of the ID differentiation strategy. | | ID_STRATEGY_ID_DIFFERENTIATION_STEP2 | Logged when you proceed to Step 2 of the ID differentiation strategy. | | ID_STRATEGY_VIEW_IDENTITIES_TAB | Logged when you view the identities tab within the ID strategy section. | | JOURNEYS_ARCHIVE_MENU_ITEM | Logged when you archive specific content or data through the archive menu item in Journeys. | | JOURNEYS_CANCEL_BUTTON | Logged when you click the “Cancel” button to abort or terminate an ongoing operation in Journeys. | | JOURNEYS_CREATE_WORKFLOW_BUTTON | Logged when you click the button to create a new workflow in Journeys. | | JOURNEYS_EDIT_MENU_ITEM | Logged when you access and modify existing content or settings through the edit menu item in Journeys. | | JOURNEYS_PAUSE_MENU_ITEM | Logged when you pause a running process or task using the pause menu item in Journeys. | | JOURNEYS_PUBLISH_BUTTON | Logged when you publish the changes or content using the publish button in Journeys. | | JOURNEYS_REENTRY_BUTTON | Logged when you utilize the reentry button in Journeys for a specific action or process. | | JOURNEYS_RESUME_MENU_ITEM | Logged when you resume a paused task or process by selecting the resume menu item in Journeys. | | JOURNEYS_SAVE_DRAFT_BUTTON | Logged when you save the current state or progress of a task as a draft in Journeys. | | JOURNEYS_UNARCHIVE_MENU_ITEM | Logged when you unarchive previously archived content in Journeys using the unarchive menu item. | | JOURNEYS_UNARCHIVE_MENU_ITEM | Logged when you unarchive a menu item in Journeys. | | LOGIN_SUCCESS | Logged when a user successfully logs into the system. | | NCE_DATA_LIFECYCLE_TAB_CLICK | Logged when you click the “NCE Data Lifecycle” tab. | | REALTIME_CALCULATED_ATTRIBUTES_ADD_CONDITION_CLICK | Logged when you add a condition in the real-time calculated attributes section. | | REALTIME_CALCULATED_ATTRIBUTES_CANCEL_BUTTON_CLICK | Logged when you click to cancel in the real-time calculated attributes section. | | REALTIME_CALCULATED_ATTRIBUTES_CANCEL_CLICK | Logged when you cancel the process of creating or editing a real-time calculated attribute by clicking the respective cancel button. | | REALTIME_CALCULATED_ATTRIBUTES_CREATE_ATTRIBUTE_BUTTON | Logged when you click the button to create a new real-time calculated attribute. | | REALTIME_CALCULATED_ATTRIBUTES_CREATE_ATTRIBUTE_CLICK | Logged when you start the process of creating a new real-time calculated attribute by clicking the designated button. | | REALTIME_CALCULATED_ATTRIBUTES_RUN_COMPUTATION_DROPDOWN_CLICK | Logged when you click the dropdown to run a computation on a real-time calculated attribute. | | REALTIME_CALCULATED_ATTRIBUTES_SAVE_BUTTON_CLICK | Logged when you click the save button in real-time calculated attributes. | | REALTIME_CALCULATED_ATTRIBUTES_SAVE_CLICK | Logged when you save the changes made to a real-time calculated attribute by clicking the respective save button. | | REALTIME_CALCULATED_ATTRIBUTES_SELECT_AGGREGATION_FIELD | Logged when you select an aggregation field for a real-time calculated attribute. | | REALTIME_CALCULATED_ATTRIBUTES_SELECT_AGGREGATION_TYPE | Logged when you select an aggregation type for a real-time calculated attribute. | | REALTIME_CALCULATED_ATTRIBUTES_SELECT_EVENT_NAME | Logged when you select an event name for a real-time calculated attribute. | | REALTIME_CALCULATED_ATTRIBUTES_TAB_CLICK | Logged when you access the tab specifically for real-time calculated attributes by clicking the respective tab. | | REALTIME_CALCULATED_ATTRIBUTES_VIEW_ATTRIBUTE | Logged when you view a real-time calculated attribute. | | SAVE_RULE_CLICK | Logged when you click “Save Rule”. | | SOURCE_CATALOGUE_MAPPING_TAB | Logged when you click the top Catalogue Mapping tab. | | SOURCE_CLICK_BACK_TO_SOURCE_LIST | Logged when you click to return to the source list view. | | SOURCE_CREATE_SOURCE_BUTTON | Logged when you click the “Create Source” button. | | SOURCE_EDIT_MAPPING | Logged when you edit the mapping of a source. | | SOURCE_EDIT_MAPPING_BUTTON | Logged when you click to edit the mapping of a source. | | SOURCE_IMPLEMENTATION_TAB | Logged when you click the implementation tab. | | SOURCE_IMPLEMENTATION_TAB_ADD_FILES_BUTTON | Logged when you click the “Add files” button under the Implementation tab. | | SOURCE_IMPLEMENTATION_TAB_CYBERDUCK | Logged when you click “Cyberduck” under the implementation option in the flat file source. | | SOURCE_IMPLEMENTATION_TAB_GOOGLE_CLOUD_CONSOLE | Logged when you click “Google Cloud Console” under the implementation option in the flat file source. | | SOURCE_IMPLEMENTATION_TAB_GSUTILS_CLOUDSDK | Logged when you click “GSUtils” under the implementation option in the flat file source. | | SOURCE_IMPLEMENTATION_TAB_HELPGUIDE_BUTTON | Logged when you click the “Help Guide” button. | | SOURCE_MAP_TO_CATALOGUE_BUTTON | Logged when you click to map a source to the catalogue. | | SOURCE_MAPPING_ADD_ENRICHER | Logged when you click “Save” to add an enricher. | | SOURCE_MAPPING_BUTTON | Logged when you click the “Edit Mapping” button or “Map the Catalogue” button. | | SOURCE_MAPPING_PREVIEW_TAB | Logged when you click the “Preview tab”. | | SOURCE_MAPPING_PREVIEW_TAB_FILTER_OPTION | Logged when you click the “Preview tab” filter option. | | SOURCE_MAPPING_PREVIEW_TAB_REFRESH | Logged when you click the “Preview refresh”. | | SOURCE_MAPPING_REVIEW_BUTTON | Logged when you click the “Review” button. | | SOURCE_MAPPING_SAVE_DRAFT | Logged when you click “Save Draft”. | | SOURCE_MAPPING_SAVE_MAPPING | Logged when you click “Save Mapping”. | | SOURCE_MAPPING_VIEW_ERROR_LOG_BUTTON | Logged when you click the “View error log” button. | | SOURCE_PREVIEW_TAB | Logged when you open the preview tab for a source. | | SOURCE_PREVIEW_TAB_FILTER_BUTTON | Logged when you use the filter button in the preview tab of a source. | | SOURCE_PREVIEW_TAB_REFRESH_BUTTON | Logged when you refresh the preview tab in Source. | | SOURCE_PREVIEW_TAB_VIEW_ERROR_LOG_BUTTON | Logged when you view the error log in the preview tab of a source. | | SOURCE_REPORT_TAB | Logged when you go to the source report of a source. | | SOURCE_REPORT_TAB_COLUMN_NAME | Logged when you click “Column name”. | | SOURCE_REPORT_TAB_DOWNLOAD_REPORT | Logged when you click the “Download Report” option. | | SOURCE_REPORT_TAB_SHOW_DATA_BUTTON | Logged when you click “Show Data”. | | SOURCE_REPORT_TAB_STATUS_FILTER | Logged when you click “Status filter”. | | SOURCE_REPORT_TAB_VIEW_GRAPH | Logged when you click “View Graph”. | | SOURCE_REPORT_TAB_VIEW_SOURCE_NAME | Logged when you click any of the source names on the source listing screen. | | SOURCE_SAVE_SOURCE | Logged when you save changes to a source configuration. | | SOURCE_SELECT_CATEGORY | Logged when you select a category within a source. | | SOURCE_SELECT_SOURCE | Logged when you select a specific source from the source list. | | SOURCE_SOURCE_REPORT | Logged when you view a report in the Source module. | | SOURCE_SOURCE_REPORT_DOWNLOAD_REPORT | Logged when you download a report from the source report section. | | SOURCE_SOURCE_REPORT_SHOWDATA | Logged when you view data in the source report section. | | SOURCE_SOURCE_REPORT_STATUS_FILTER | Logged when you apply a status filter in the source report section. | | SOURCE_SOURCE_REPORT_VIEW_GRAPH | Logged when you view a graph in the source report section. | | SOURCE_UPDATE_SOURCE | Logged when you update an existing source. | | SOURCE_UPLOAD_FILES | Logged when you upload files to a source. | | SOURCE_VIEW_SOURCE_LIST | Logged when you view the full source list. | | STRATEGY_CUSTOM_ID_SAVE | Logged when you click “Save " on the Custom ID Strategy. | | STRATEGY_HIGH_FIDELITY_ID_SAVE | Logged when you click the “Differentiate customers with high-fidelity IDs" strategy. | | STRATEGY_IDENTITY_LINK_SAVE | Logged when you click “Save” for the "Identify and Link Using all IDs" strategy. | | USAGE_MODULE_VIEW | Logged when you view the usage module. | | VIEW_SOURCE_DASHBOARD | Logged when you access the dashboard of a specific source. | | WIDGET_DATA_DOWNLOADED | Logged when you download data from a widget. | | **ARCHIEVED EVENTS** | | | CONNECT_BACK_TO_SEGMENT_LISTING | Logged when you return to the segment listing page in Connect. | | CONNECT_CHOOSE_DESTINATION | Logged when you choose a destination in Connect. | | CONNECT_CREATE_DUPLICATE | Logged when you create a duplicate of a segment or configuration in Connect. | | CONNECT_CREATE_SEGMENT | Logged when you initiate the creation of a new segment in Connect. | | CONNECT_CREATE_SEGMENT_ADD_RULE | Logged when you add a rule during segment creation in Connect. | | CONNECT_CREATE_SEGMENT_ADD_RULE_SET | Logged when you add a rule set during segment creation in Connect. | | CONNECT_CREATE_SEGMENT_ADD_THIRD_PARTY_SEGMENT | Logged when you add a third-party segment while creating a new segment in Connect. | | CONNECT_CREATE_SEGMENT_DESCRIPTION | Logged when you add a description while creating a segment in Connect. | | CONNECT_CREATE_SEGMENT_FILTER_FPD | Logged when you add a filter for first-party data (FPD) in a new segment. | | CONNECT_CREATE_SEGMENT_INCLUDE_SEED_SET | Logged when you include a seed set while creating a segment in Connect. | | CONNECT_CREATE_SEGMENT_LOOKALIKE_EXTENSION | Logged when you create a lookalike extension for a segment in Connect. | | CONNECT_CREATE_SEGMENT_SAVE_BUTTON | Logged when you click to save a newly created segment in Connect. | | CONNECT_CREATE_SEGMENT_SELECTED_INPUT_IDENTIFIER | Logged when you select an input identifier while creating a segment in Connect. | | CONNECT_CREATE_SEGMENT_SELECTED_OUTPUT_IDENTIFIERS | Logged when you select output identifiers while creating a segment in Connect. | | CONNECT_CREATE_SEGMENT_SKIP_FILTER_FPD | Logged when you skip the first-party data (FPD) filter during segment creation. | | CONNECT_CREATE_SEGMENT_STATUS_ERROR | Logged when a segment creation in Connect encounters an error. | | CONNECT_CREATE_SEGMENT_THIRD_PARTY_ADDITION_TYPE_AND_OR_NOT | Logged when you specify addition type (AND/OR/NOT) for a third-party segment in Connect. | | CONNECT_CREATE_SEGMENT_ZEOTAP_EXTENSION | Logged when you create a segment extension for Zeotap in Connect. | | CONNECT_DESELECT_DESTINATION | Logged when you deselect a destination in Connect. | | CONNECT_DISTRIBUTE_CANCEL | Logged when you cancel the distribution of a segment in Connect. | | CONNECT_DISTRIBUTE_SAVE | Logged when you save distribution settings in Connect. | | CONNECT_DISTRIBUTE_SEGMENT | Logged when you distribute a segment to various channels or destinations in Connect. | | CONNECT_EDIT_LOOKALIKE_EXTENSION | Logged when you edit a lookalike extension in Connect. | | CONNECT_EDIT_SEGMENT | Logged when you edit an existing segment in Connect. | | CONNECT_EDIT_SEGMENT_CANCEL | Logged when you cancel the editing of a segment in Connect. | | CONNECT_EDIT_SEGMENT_FILTERS | Logged when you edit the filters on an existing segment in Connect. | | CONNECT_EDIT_SEGMENT_NAME | Logged when you edit the name of an existing segment in Connect. | | CONNECT_EDIT_SEGMENT_SAVE | Logged when you save changes to an existing segment in Connect. | | CONNECT_EDIT_SEGMENT_SELECTED_INPUT_IDENTIFIERS | Logged when you edit the selected input identifiers in an existing segment. | | CONNECT_EDIT_SELECTED_OUTPUT_IDENTIFIERS | Logged when you edit the selected output identifiers in Connect. | | CONNECT_SAVE_AND_PUSH_TO_DESTINATION | Logged when you save and push a segment or data to a destination in Connect. | | CONNECT_SELECT_DESTINATION | Logged when you select a destination in Connect. | | CONNECT_VIEW_DETAILS | Logged when you view details of a segment or connection in Connect. | | CONNECT_VIEW_INSIGHTS | Logged when you view insights related to a segment or connection in Connect. | # My Roles Source: https://docs.zeotap.com/articles/admin-customer/my-roles ## Overview My Roles module provides administrators with the ability to create and manage custom roles with granular permissions for different modules and folders within Zeotap platform. This feature also enables organisations to implement role-based access control (RBAC) by restricting user access to specific folders within the Journey and Audience modules, ensuring that team members only interact with content relevant to their responsibilities. Key Benefits: * Granular control over user permissions at both module and folder levels * Ability to segregate access based on business requirements and team structures * Centralised role management through a dedicated admin interface ## Accessing My Roles The My Roles screen is available under the Admin section of the Zeotap platform. This screen provides a centralized location to view, create, and manage all custom roles within your organization. To access My Roles: **Step 1** Navigate to the Admin section in the left sidebar **Step 2** Click 'My Roles' **Step 3** You will see a list of all existing custom roles in your organization ![](https://mintcdn.com/zeotap/vFAAmDAYNzRboQBn/articles/admin-customer/Storage/admin-customer/my-roles/image_\(2\).png?fit=max\&auto=format\&n=vFAAmDAYNzRboQBn\&q=85\&s=aa15bc7961ea9496b5febc62905d4b9a) My Roles screen displays following information for each role: * Name: The name of the custom role * Type: Indicates whether the role is a custom role * Created By: The user who created the role and creation timestamp * Last Updated By: The user who last modified the role and update timestamp * Actions: Edit button to modify role permissions ## Creating a Custom Role Custom roles allow you to define specific permissions and folder access for different users. Follow these steps to create a new custom role: **Step 1** Click 'Create Custom Role' button **Step 2** Enter a descriptive name for this role **Step 3** Define permissions across module **Step 4** Navigate to 'Orchestrate' module to configure folder level access for journeys **Step 5** Click save option to get the custom role created ![](https://mintcdn.com/zeotap/vFAAmDAYNzRboQBn/articles/admin-customer/Storage/admin-customer/my-roles/my-roles-2026-01-21.png?fit=max\&auto=format\&n=vFAAmDAYNzRboQBn\&q=85\&s=c219e5ff3d95f50e18706a0d8c2bf9ca) ## Managing Folder Access for Journey Module Folder access management allows you to control which folders users can see and interact with in the Journey module. This is particularly useful for organizations that need to segregate data based on teams, projects, or customer types. ### Option 1: All Folders (Default) By default, any custom role has access to All Folders. This means: * Users assigned to this role can access all current folders in the Journey module * They will automatically have access to any new folders created in the future * This option provides the most flexibility and is recommended for general-purpose roles ### Option 2: Specific Folders Select 'Specific Folders' when you need to restrict access to only certain folders. This option is ideal for teams that should only work with specific campaigns, projects, teams. When you select Specific Folders, an expanded panel appears with two toggle modes: * **Include** — Only the checked folders will be accessible to users with this role. All other folders are hidden. * **Exclude** — All folders are accessible *except* the checked folders. Use this when you want to hide a small number of folders. > [!NOTE] > > Only one mode (Include or Exclude) can be configured per role. The active mode is highlighted in blue. You can switch between the two modes at any time before saving. The folder selection panel provides the following capabilities: * A searchable, paginated list of all existing folders will be displayed * Access to 'Default' and 'Archived' folders is automatically granted and cannot be removed * When you select a parent folder, access to all its sub-folders is automatically granted * Users can also directly create a new folder from here and restrict it's permissions ![](https://mintcdn.com/zeotap/vFAAmDAYNzRboQBn/articles/admin-customer/Storage/admin-customer/my-roles/my-roles-2026-01-21-1.png?fit=max\&auto=format\&n=vFAAmDAYNzRboQBn\&q=85\&s=a996d8e6964e67f65c92a2a6e394f31a) > [!WARNING] > > When using **Specific Folders** with **Include** mode, newly created folders will **not** be automatically included. You must manually add new folders to the role configuration. Use the **All Folders** option or the **Exclude** mode if you want new folders to be automatically accessible. ## Managing Folder Access for Audience Module Folder access management for the Audience module allows you to control which audience folders users can see and interact with. This is configured within the **Segment** tab of the custom role modal. ### Option 1: All Folders (Default) By default, any custom role has access to All Folders. This means: * Users assigned to this role can access all current folders in the Audiences module * They will automatically have access to any new folders created in the future * This option provides the most flexibility and is recommended for general-purpose roles ### Option 2: Specific Folders Select 'Specific Folders' when you need to restrict access to only certain audience folders. At the bottom of the Segment permissions checklist, a **Folder Access** section appears with the two options. ![](https://mintcdn.com/zeotap/jexvlHp3stVptnlx/articles/admin-customer/Storage/admin-customer/my-roles/audience-folder-access-options.png?fit=max\&auto=format\&n=jexvlHp3stVptnlx\&q=85\&s=ca7ebc6a6dcbae4091ed7b027fc0a5f5) When you select Specific Folders, an expanded panel appears with two toggle modes: * **Include** — Only the checked folders will be accessible to users with this role. All other folders are hidden. * **Exclude** — All folders are accessible *except* the checked folders. Use this when you want to hide a small number of folders. > [!NOTE] > > The Include/Exclude toggle is displayed as a pair of pill-shaped buttons directly above the folder tree. The active mode is highlighted in blue. You can switch between the two modes at any time before saving. Only one mode (Include or Exclude) can be configured per role. The folder tree displays all available audience folders with checkboxes. You can: * Search for specific folders using the search field * Expand the tree to view and select sub-folders * Create a new folder directly from the selection panel using the **Create New Folder** button ![](https://mintcdn.com/zeotap/jexvlHp3stVptnlx/articles/admin-customer/Storage/admin-customer/my-roles/audience-folder-tree-selection.png?fit=max\&auto=format\&n=jexvlHp3stVptnlx\&q=85\&s=0e6ba55a585a0003b3191823efe63c81) > [!WARNING] > > When using **Specific Folders** with **Include** mode, newly created folders will **not** be automatically included. You must manually add new folders to the role configuration. Use the **All Folders** option or the **Exclude** mode if you want new folders to be automatically accessible. ### Folder Access in Action Once a user is assigned a role with specific folder access, navigating to **Segment > Audiences** will only display the folders permitted by their role. ![](https://mintcdn.com/zeotap/jexvlHp3stVptnlx/articles/admin-customer/Storage/admin-customer/my-roles/audience-folder-access-in-action.png?fit=max\&auto=format\&n=jexvlHp3stVptnlx\&q=85\&s=657368932563d199f4a78bd9ecdc1517) ## Saving Role Changes After configuring permissions and folder access, click **Save Changes**. A confirmation dialog will appear warning that the changes will be applied to all users assigned to this role. ![](https://mintcdn.com/zeotap/jexvlHp3stVptnlx/articles/admin-customer/Storage/admin-customer/my-roles/save-role-confirmation.png?fit=max\&auto=format\&n=jexvlHp3stVptnlx\&q=85\&s=aa279f226299352f38f1e0712b6cb054) > [!WARNING] > > Changes to a custom role are applied immediately to **all users** who have been assigned that role. Review your permission and folder access settings carefully before clicking **Apply Settings**. ## Assigning Roles to Users **Step 1** Navigate to Admin > My Users **Step 2** Select the user you want to assign a role to **Step 3** In the user configuration screen, select the appropriate custom role from the available options **Step 4** Save the changes The user will immediately inherit all permissions and folder access restrictions defined in the assigned role. ## Frequently Asked Questions > [accordion] Can I assign multiple roles to a single user? > > A user can be assigned single role per organization. Users can be assigned different roles across different organizations. > [accordion] If I delete a folder, what happens to roles that had access to it? > > When a folder is deleted, the corresponding folder permission is automatically removed from all custom roles that had access to it. > [accordion] Does folder access control apply to sub-folders? > > Yes, when you grant access to a parent folder, users automatically receive access to all current and future sub-folders within that parent folder. This inheritance applies recursively to all nested sub-folders. > [accordion] How do I know which folders a user has access to? > > You can navigate to 'My Roles' screen, select the relevant custom role and view the folders that role has access to. > [accordion] Can I use both Include and Exclude rules on the same role? > > No. Only one mode (Include or Exclude) can be configured per role for folder access. You must choose one approach for each custom role. > [accordion] What happens when a new folder is created? > > If the role uses **All Folders** or **Exclude** mode, the new folder is automatically accessible. If the role uses **Include** mode, the new folder must be manually added to the role configuration. > [accordion] Does folder access affect activation or downloads? > > Yes. Users can only view, activate, or download audiences within the folders they have access to. Audiences in restricted folders are completely hidden from the user. # Process to follow for Org/User creation or access Source: https://docs.zeotap.com/articles/admin-customer/process-to-follow-for-org-user-creation-or-access-1 This topic summarises the organisation/user creation process by teams. ## Process for Client Team (CSM/TAM) ### New Org Creation 1. Make a new org creation request in SF. 2. TAM creates the org. 3. TAM creates the users for the org and assigns a CS to the org Admin. When a new org is created, a TAM should atleast create one user who is an Admin across all (or atleast Access control and Collect) the products on the client side to enable the GCS/BQ approval process. ### Existing Org - New CS 1. CS creates a request in SF. 2. Assigns the ticket to the concerned TAM/ Team lead. 3. TAM/TL assigns the org to the CS account. ### Existing Org - CS/TAM - Temporary Access 1. CS creates a request in SF. 2. Assigns the ticket to the concerned TAM/ Team lead. 3. TAM/TL assigns the org to the temp CS. 4. TAM/TL revokes the org when the concerned CS is back and then closes the ticket. ### Backup Flow if the TAM/Super Admin is Not Available 1. When an access request is raised in SF, assign it to the concerned TAM or Super Admin. 2. If the concerned TAM/Super Admin is OOO, then assign the ticket to the Support Team. 3. The Support Team grants access and close the ticket based on the above scenario. ## Process for Tech Team 1. Some of the key team members are given the Super Admin access (Shubham Patil, Kannan, Sathish Kuppuswami). 2. For GCS and BigQuer, some of the Tech team members have direct access. 3. If any the Zeotap CDP App access is required, then the team member has to reach out to the concerned department’s Super Admin. # Request Access Source: https://docs.zeotap.com/articles/admin-customer/request-access Perform the following steps to raise a request: **Step 1** In the **Request Access** tab, click **RAISE NEW REQUEST.** ![](https://mintcdn.com/zeotap/vFAAmDAYNzRboQBn/articles/admin-customer/Storage/admin-customer/request-access/request-access-2023-09-13.png?fit=max\&auto=format\&n=vFAAmDAYNzRboQBn\&q=85\&s=8a21ce13c21073d7aca07e3ada0174bc) **Step 2** Currently, **GCS/BQ Access** appears as the **Request Type**. You can modify this selection. **Step 3** Choose the **Organization** for which you want to access the BigQuery or GCS bucket. Note that all the organisations for which you have access to the Collect application, appear in this drop-down menu. **Step 4** Select the appropriate **Client Admin**. **Step 5** Type the appropriate **Reason for request** in the text box provided. ![](https://mintcdn.com/zeotap/vFAAmDAYNzRboQBn/articles/admin-customer/Storage/admin-customer/request-access/request-access-2023-09-13-1.png?fit=max\&auto=format\&n=vFAAmDAYNzRboQBn\&q=85\&s=7c2dd1af7c59deb7b4a3943dd51d0cc6) **Step 6** Click **REQUEST ACCESS**. The request is sent to the Client Admin and a row appears on the **REQUEST ACCESS** page with the status as **Sent**. Note that the **STATUS** and **REVIEWED BY** columns are updated based on the changes made by the Client Admin. ## Reviewing the Request As a Client Admin, you receive the request in the form of an email. Open the email and click **REVIEW ACCESS REQUEST**. You are taken to the **REQUEST ACCESS** page in the Zeotap CDP App from where you can approve or reject the request. ## Accessing an Approved Request Once the Client Admin approves the request, an email is sent to the Zeotap Admin/Zeotap Client Admin who raised the request. The email also contains details about how long the Zeotap Admin/Zeotap Client Admin can access the Client’s BigQuery or GCS bucket. On navigating to the **REQUEST ACCESS** page, the status of the request appears as **Approved** along with the name of the Reviewer. The Zeotap Admin/Zeotap Client Admin can then access the Client’s BigQuery or GCS bucket and finish debugging. # Roles and their descriptions Source: https://docs.zeotap.com/articles/admin-customer/role-descriptions The table below provides information about the various roles available in the system with their descriptions. | **Role Name** | **Role Description** | | :- | :- | | CDP Admin | This role grants access to all Zeotap CDP features, including those required for customer data deletion. | | CDP Manager | This role grants access to all Zeotap CDP features, except advanced asset management and data deletion features. | | CDP Viewer | This role grants access to view CDP assets, such as Sources, Audiences, Journeys and more. Note that Individual customer data is not visible. | | Campaign Admin | This role grants basic access to ingestion and full access to segmentation and activation. | | Campaign Manager | This role grants access to all the features necessary for a marketer's daily work. | | Campaign Viewer | This role grants access to view ingestion, segmentation and activation assets. | | Integrations Admin | This role grants access to Source and Destination management, including user deletion access. | | Integrations Manager | This role grants access to Source and Destination management, excluding user deletion access. | | Integrations Viewer | This role grants access to view Sources and Destinations. | | Destination Admin | This role grants access to create and manage Destinations. | | Destination Viewer | This role grants access to view Destinations. | | Zeotap Viewer | This is an internal Zeotap role intended to provide viewer access to all features. | | Zeotap Manager | This is an internal Zeotap role designed for Customer Success Managers. | | Zeotap Engineer | This is an internal Zeotap role intended for Implementation Engineers and Solution Engineers. | | Zeotap Tester | This is an internal Zeotap role intended for testing. | # User Roles and Access Source: https://docs.zeotap.com/articles/admin-customer/user-roles-and-access This section explains the user roles and access granted for the various products. > [!NOTE] > > **Note** > > For information about the various roles available in the system with their descriptions, refer [here](/articles/admin-customer/role-descriptions). ## Integrate - User Roles and Access The following table summarises the roles and access levels available for various features on Integrations: | **Module** | **Access - Display Name** | **Campaign Admin** | **Campaign Manager** | **Campaign Viewer** | **CDP Admin** | **CDP Manager** | **CDP** **VIEWER** | **Destination Admin** | **Destination Viewer** | **Integrations Admin** | **Integrations Manager** | **Integrations Viewer** | **Zeotap Engineer** | **Zeotap Manager** | **ZEOTAP tester** | **ZEOTAP Viewer** | | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | | **Integrate > Sources** | View Sources | Y | Y | Y | Y | Y | Y | N | N | Y | Y | Y | Y | N | Y | Y | | **Integrate > Sources** | Create, Pause, Resume, and Archive Sources | N | N | N | Y | Y | N | N | N | Y | Y | N | Y | N | Y | N | | **Integrate > Sources** | Rename Sources | N | N | N | Y | Y | N | N | N | Y | Y | N | Y | N | Y | N | | **Integrate > Sources** | Read and write to GCS | N | N | N | Y | Y | N | N | N | Y | Y | N | N | N | Y | N | | **Integrate > Destinations** | View Destinations | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | | **Integrate > Destinations** | Create and Edit Destinations | Y | Y | N | Y | Y | N | Y | N | Y | Y | N | Y | Y | Y | N | ## Unify - User Roles and Access The following table summarises the roles and access levels available for various features on Unify: | **Module** | **Access - Display Name** | **Campaign** **Admin** | **Campaign** **Manager** | **Campaign** **Viewer** | **CDP** **Admin** | **CDP** **Manager** | **CDP** **VIEWER** | **Destination** **Admin** | **Destination** **Viewer** | **Integrations** **Admin** | **Integrations** **Manager** | **Integrations** **Viewer** | **Zeotap** **Engineer** | **Zeotap** **Manager** | **Zeotap** **tester** | **ZEOTAP** **VIEWER** | | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | | **Unify > Catalogue** | Create and Edit Catalogue | N | N | N | Y | Y | N | N | N | Y | Y | N | Y | Y | Y | N | | **Unify > Catalogue** | View Catalogue | Y | Y | Y | Y | Y | Y | N | N | Y | Y | Y | Y | Y | Y | Y | | **Unify > Calculated Attributes** | View Calculated Attributes | Y | Y | Y | Y | Y | Y | N | N | Y | Y | Y | Y | Y | Y | Y | | **Unify > Calculated Attributes** | Create and Edit Calculated Attributes | N | N | N | Y | Y | N | N | N | Y | Y | N | Y | Y | Y | N | | **Unify > ID Strategy** | View ID Strategy | Y | Y | Y | Y | Y | Y | N | N | Y | Y | Y | Y | Y | Y | Y | | **Unify > ID Strategy** | Edit ID Strategy | N | N | N | Y | Y | N | N | N | Y | Y | N | Y | N | Y | N | ## Segment - User Roles and Access The following table summarises the roles and access levels available for various features on Segment: | **Module** | **Access - Display Name** | **Campaign Admin** | **Campaign Manager** | **Campaign Viewer** | **CDP Admin** | **CDP Manager** | **CDP**  **VIEWER** | **Destination Admin** | **Destination Viewer** | **Integrations Admin** | **Integrations Manager** | **Integrations Viewer** | **Zeotap Engineer** | **Zeotap Manager** | **Zeotap** **Tester** | **ZEOTAP** **VIEWER** | | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | | **Segment > Audiences** | View Audience | Y | Y | Y | Y | Y | Y | N | N | N | N | N | Y | Y | Y | Y | | **Segment > Audiences** | Create, Edit, Pause, and Duplicate Audience | Y | Y | N | Y | Y | N | N | N | N | N | N | Y | Y | Y | N | | **Segment > Audiences** | Archive Audience | Y | N | N | Y | N | N | N | N | N | N | N | Y | Y | Y | N | | **Segment > Audiences** | Download Audience | Y | N | N | Y | N | N | N | N | N | N | N | Y | Y | Y | N | | **Segment > Audiences** | Create Folder | Y | Y | N | Y | Y | N | N | N | N | N | N | Y | Y | Y | N | | **Segment > Audiences** | Activate Audience | Y | Y | N | Y | Y | N | N | N | N | N | N | Y | Y | Y | N | ## Orchestrate - User Roles and Access The following table summarises the roles and access levels available for various features on Orchestrate: | **Module** | **Access - Display Name** | **Campaign Admin** | **Campaign Manager** | **Campaign Viewer** | **CDP Admin** | **CDP Manager** | **CDP** **VIEWER** | **Destination Admin** | **Destination Viewer** | **Integrations Admin** | **Integrations Manager** | **Integrations Viewer** | **Zeotap Engineer** | **Zeotap Manager** | **ZEOTAP** **TESTER** | **ZEOTAP** **VIEWER** | | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | | **Orchestrate > Journeys** | View Journeys | Y | Y | Y | Y | Y | Y | N | N | N | N | N | Y | Y | Y | Y | | **Orchestrate > Journeys** | Create, Edit, and Archive Journeys | Y | Y | N | Y | Y | N | N | N | N | N | N | Y | Y | Y | N | | **Orchestrate > Journeys** | Delete Journeys | Y | Y | N | Y | Y | N | N | N | N | N | N | Y | N | Y | N | | **Orchestrate > Journeys** | Pause Journeys | Y | Y | N | Y | Y | N | N | N | N | N | N | Y | N | Y | N | | **Orchestrate > Journeys** | Resume Journeys | Y | Y | N | Y | Y | N | N | N | N | N | N | Y | Y | Y | N | ## Protect - User Roles and Access The following table summarises the roles and access levels available for various features on Protect: | **Module** | **Access - Display Name** | **Campaign Admin** | **Campaign Manager** | **Campaign Viewer** | **CDP Admin** | **CDP Manager** | **CDP** **VIEWER** | **Destination Admin** | **Destination Viewer** | **Integrations Admin** | **Integrations Manager** | **Integrations Viewer** | **Zeotap Engineer** | **Zeotap Manager** | **ZEOTAP** **TESTER** | **ZEOTAP** **VIEWER** | | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | | **Protect > Consent** | View Consent | Y | Y | Y | Y | Y | Y | N | N | Y | Y | Y | Y | N | Y | Y | | **Protect > Consent** | Set up and Edit Consent | N | N | N | Y | Y | N | N | N | Y | Y | N | Y | N | Y | N | | **Protect > Customer 360** | Search and View Users | N | N | N | Y | N | N | N | N | Y | N | N | Y | Y | Y | N | | **Protect > Customer 360** | Delete and Export Users | N | N | N | Y | N | N | N | N | Y | N | N | N | N | Y | N | ## Admin - User Roles and Access The following table summarises the roles and access levels available for various features on Admin: | **Module** | **Access - Display Name** | **Super Admin** | **Zeotap Admin** | **Zeotap cft** | **partner** | **admin** | **moderator** | **Viewer** | | :- | :- | :- | :- | :- | :- | :- | :- | :- | | **Admin** | View Organisations | Y | Y | Y | Y | Y | Y | Y | | **Admin** | Create, Edit and Delete Organisations | Y | Y | N | N | Y | N | N | | **Admin** | View Users | Y | Y | Y | Y | Y | Y | Y | | **Admin** | Edit and Delete Users | Y | Y | N | Y | Y | N | N | | **Admin** | Create User | Y | Y | N | Y | Y | Y | N | | **Admin** | View Request Access Tab | Y | Y | Y | Y | Y | N | N | | **Admin** | View Request Access Form | Y | Y | Y | N | N | N | N | | **Admin** | View Request Access Requests | N | N | N | Y | Y | N | N | | **Admin** | Edit Own Profile | Y | N | N | Y | Y | N | N | ## Download Users The **Download Users** feature enables administrators to export a CSV file containing all users and their detailed permission assignments, scoped by organization. This is useful for auditing, compliance reviews, and access management reporting. ### Exporting User Permissions **Step 1** Navigate to **Admin > My Users**. **Step 2** Click the **Download Users** button in the top-right area of the page. ![](https://mintcdn.com/zeotap/jexvlHp3stVptnlx/articles/admin-customer/Storage/admin-customer/user-roles-and-access/download-users-button.png?fit=max\&auto=format\&n=jexvlHp3stVptnlx\&q=85\&s=8a51d4f1accaee5cee3b6acd21262354) **Step 3** In the modal that appears, choose the export scope: * **All Organizations** — Exports users from all organizations. Useful for global audits. * **Specific Organization** — Exports users from a selected organization only. A searchable dropdown lets you pick the organization. ![](https://mintcdn.com/zeotap/jexvlHp3stVptnlx/articles/admin-customer/Storage/admin-customer/user-roles-and-access/choose-organization.png?fit=max\&auto=format\&n=jexvlHp3stVptnlx\&q=85\&s=4661d3fe92ec92d8c79101f11d389648) **Step 4** Click **Download** to generate and download the CSV file. ### Exported File The exported file follows the naming convention `zeotap_users_export_YYYY-MM-DD (N).csv`. #### Data Structure Each row in the CSV represents a user. The columns cover identity fields and permission states: | Column Group | Fields | | - | - | | **User Identity** | User Name, Email ID, Admin Portal Access, Last Login Date, Organization | | **User Role** | Role Name | | **Audience Permissions** | View Audience, Create/Edit/Move/Duplicate, Archive Audience, Download Audience, Activate Audience, Allow User Deletion | | **Folder Permissions** | Create Folder, Create Sub Folder, Delete Folder | | **Catalogue & Attributes** | Catalogue Admin, Calculated Attributes, View Catalogue | Permission values are displayed as **TRUE** or **FALSE** for each user. > [!NOTE] > > Use conditional formatting in your spreadsheet tool to highlight **TRUE** values in green and **FALSE** values in red for a quick visual audit of permission coverage across users. ### Best Practices * **Schedule regular exports** — Download the user permissions CSV at a regular cadence (e.g., monthly) for compliance and audit purposes. * **Compare over time** — Keep historical exports to track how permissions change over time and identify any unintended permission escalations. * **Use Specific Organization scoping** — For multi-org deployments, export per organization to keep audit files focused and manageable. * **Automate reviews** — Use spreadsheet formulas or scripts to flag users with unusual permission combinations (e.g., users with Delete permissions but not Create permissions). # Logging In & Two-Factor Authentication Source: https://docs.zeotap.com/articles/admin-customer/your-first-login-to-the-zeotap-cdp-platform How to make your first login to the Zeotap CDP platform, and how to set up and use Two-Factor Authentication (2FA) to secure your account. ## Logging In for the First Time To make your first login to the Zeotap CDP account using the welcome link you received after subscription, perform the following steps: **Step 1** To begin with, ensure that you have received the welcome email with the **FINISH SIGNUP** link from Zeotap CDP. If you cannot find the email, check your spam folder or contact the Zeotap support team at [support@zeotap.com](mailto:support@zeotap.com). ![](https://mintcdn.com/zeotap/cTmgcQYl-5jOouxf/articles/admin-customer/Storage/admin-customer/your-first-login-to-the-zeotap-cdp-platform/your-first-login-to-the-zeotap-cdp-platform-2024-09-02.png?fit=max\&auto=format\&n=cTmgcQYl-5jOouxf\&q=85\&s=82f55a25fd4c675a088cb0e77b72b4c7) **Step 2** Click **FINISH SIGNUP** in the email. **Step 3** Set a new password for your Zeotap CDP account. Ensure your password meets safety standards as mentioned in the image below. ![](https://mintcdn.com/zeotap/cTmgcQYl-5jOouxf/articles/admin-customer/Storage/admin-customer/your-first-login-to-the-zeotap-cdp-platform/your-first-login-to-the-zeotap-cdp-platform-2024-09-02-1.png?fit=max\&auto=format\&n=cTmgcQYl-5jOouxf\&q=85\&s=59db90d621d1bf6e0ad07d5e41ae8fa7) **Step 4** Click **Create My Account** to complete the account setup. After successfully creating your account, you will be automatically redirected to [app.zeotap.com](https://app.zeotap.com). If redirection does not occur, manually navigate to [app.zeotap.com](https://app.zeotap.com). ![](https://mintcdn.com/zeotap/cTmgcQYl-5jOouxf/articles/admin-customer/Storage/admin-customer/your-first-login-to-the-zeotap-cdp-platform/your-first-login-to-the-zeotap-cdp-platform-2024-09-02-2.png?fit=max\&auto=format\&n=cTmgcQYl-5jOouxf\&q=85\&s=c1818325c18f6e248799ca407f5e2fcb) **Step 5** Upon successful login, you will be able to access the Zeotap CDP platform. Use the drop-down menu in the top right corner to switch between your preferred instance or Organization. ![](https://mintcdn.com/zeotap/cTmgcQYl-5jOouxf/articles/admin-customer/Storage/admin-customer/your-first-login-to-the-zeotap-cdp-platform/your-first-login-to-the-zeotap-cdp-platform-2024-09-02-3.png?fit=max\&auto=format\&n=cTmgcQYl-5jOouxf\&q=85\&s=561c422d69229be43784b44e9a75da01) ## Two-Factor Authentication (2FA) Two-Factor Authentication (2FA) adds a second verification step to your Zeotap login, on top of your email and password. Once 2FA is set up, logging in requires a time-based one-time code from an authenticator app on your phone, in addition to your usual credentials. If your organisation requires 2FA, it applies to every user logging in with a username and password. This can't be turned off at the individual user level — an organisation admin needs to raise a request with Zeotap support to remove the 2FA requirement, and this applies to the whole organisation, not select users. You'll be prompted to set it up automatically the first time you log in after it's enabled for your organisation. > [!NOTE] > > **Note** > > Zeotap currently supports one 2FA method: a third-party authenticator app (TOTP-based). This includes apps such as Google Authenticator, Microsoft Authenticator, and Authy. ### Why Two-Factor Authentication Matters Your password alone protects your account only as far as the password itself stays secret. 2FA means that even if your password is ever guessed, phished, or leaked, an intruder still cannot log in without the current code generated on your personal device. This significantly lowers the risk of unauthorised access to your account and to the customer data available within it. ### Setting Up 2FA You'll see the setup screen the first time you log in after your organisation enables 2FA. You'll need a phone with an authenticator app installed. **Step 1** **Log in as usual.** Enter your email and password on the Zeotap login screen. **Step 2** **Open the setup screen.** Since this is your first login with 2FA enabled, the **Two Factor Authentication Setup** screen appears automatically. **Step 3** **Open your authenticator app.** On your phone, open Google Authenticator, Microsoft Authenticator, Authy, or any other TOTP-compatible authenticator app. If you don't already have one installed, install one from your phone's app store first. **Step 4** **Scan the QR code.** Use your authenticator app to scan the QR code shown on screen. Can't scan it? Click **Can't scan the QR code?** and enter the setup key shown underneath into your authenticator app manually instead. **Step 5** **Enter the 6-digit code.** Your authenticator app will now display a 6-digit code for your Zeotap account, refreshing every 30 seconds. Enter the current code into the **Enter 6 digit Code** field. **Step 6** **Complete setup.** Click **Complete setup**. This button activates once a valid 6-digit code has been entered. ![Two Factor Authentication Setup screen](https://mintcdn.com/zeotap/OlF6TClnrz_EqCae/articles/admin-customer/Storage/admin-customer/your-first-login-to-the-zeotap-cdp-platform/two-factor-authentication-setup.png?fit=max\&auto=format\&n=OlF6TClnrz_EqCae\&q=85\&s=196224cb122c2658aa244daadeb6214c) > [!WARNING] > > Your setup key is unique to your account. Treat it like a password — don't share it, screenshot it, or send it to anyone, including colleagues or support. ### Logging In with 2FA Once setup is complete, you'll be asked for a code every time you log in. **Step 1** **Log in as usual.** Enter your email and password on the Zeotap login screen. **Step 2** **Open the verification screen.** The **Two Factor Authentication** screen appears, asking for your 6-digit code. **Step 3** **Get your current code.** Open your authenticator app and note the current 6-digit code for your Zeotap account. **Step 4** **Verify.** Enter the code into the **Enter 6 digit Code** field and click **Verify**. Click **Back** if you need to return to the login screen. ![Two Factor Authentication verification screen](https://mintcdn.com/zeotap/OlF6TClnrz_EqCae/articles/admin-customer/Storage/admin-customer/your-first-login-to-the-zeotap-cdp-platform/two-factor-authentication-verification.png?fit=max\&auto=format\&n=OlF6TClnrz_EqCae\&q=85\&s=ed9474109d207cc292543a70ae31110f) ### Lost Access to Your Authenticator Device? If you've lost, replaced, or reset the phone with your authenticator app on it, you won't be able to generate a valid code to log in. Since Zeotap doesn't currently support backup codes or a secondary 2FA method, you'll need help to regain access. **Step 1** **Raise a support ticket.** Raise a support ticket with the Support team, requesting an MFA reset. Include your registered email address and organisation name. **Step 2** **Verification.** The Zeotap team will verify your identity before resetting your 2FA. **Step 3** **Set up again.** Once your 2FA is reset, log in with your email and password. You'll see the setup screen again and can link a new device by scanning the QR code. ## Frequently Asked Questions > [accordion] Which authenticator apps can I use? > > Any TOTP-compatible authenticator app works, including Google Authenticator, Microsoft Authenticator, and Authy. > [accordion] Can I turn 2FA off? > > Not on your own — 2FA can't be disabled at the individual user level. If your organisation requires 2FA, an organisation admin can raise a request with Zeotap support to remove the requirement. This is an org-wide setting, so it applies to all users in the organisation, not select individuals. > [accordion] Do I need to enter a code every time I log in? > > Yes. A current 6-digit code from your authenticator app is required at every login, not just the first one. > [accordion] My code isn't working. What should I do? > > Codes refresh every 30 seconds, so make sure you're entering the current one. Also check that the time on your phone is set automatically — authenticator codes rely on your device's clock being accurate. > [accordion] Can I set up 2FA on more than one device? > > Scanning the QR code or entering the setup key on additional devices will also generate valid codes for your account. Keep in mind that anyone with the setup key can generate a code, so only add devices you control. > [accordion] I lost my phone or uninstalled the app. What now? > > Raise a support ticket with the Support team requesting an MFA reset (see **Lost Access to Your Authenticator Device?** above). ## Related Topics As your next step, you may need guidance on creating an organisation and adding users. Use the following links to navigate: > [card] [How to create an Organisation?](https://docs.zeotap.com/articles/admin-customer/creating-an-organisation) > [card] [How to add a User?](https://docs.zeotap.com/articles/admin-customer/add-an-user) > [card] [Feature/Functionalities available for different User Roles](https://docs.zeotap.com/articles/admin-customer/user-roles-and-access) > [card] [User roles and their descriptions](https://docs.zeotap.com/articles/admin-customer/role-descriptions) > [card] [How to raise an Access Request?](https://docs.zeotap.com/articles/admin-customer/request-access) > [card] [Organisation/User creation process for different teams](https://docs.zeotap.com/articles/admin-customer/process-to-follow-for-org-user-creation-or-access-1) # Collaborate Source: https://docs.zeotap.com/articles/collaborate-customer/collaborate Collaborate is Zeotap's privacy-safe data clean room. Two organisations can run joint audience analyses and activate insights without either party ever sharing raw customer data with the other. Collaborate is a privacy-safe data collaboration module that allows two organisations to run joint audience analyses and activate insights — **without either party ever sharing raw customer data with the other**. Built on Google BigQuery's Analytics Hub infrastructure, Collaborate lets organisations bring their own datasets together, measure how their audiences overlap, and act on those insights for advertising campaigns. Neither side can access the other's underlying records, view individual-level data, or export raw data outside the controlled environment. ## Use cases Collaborate supports three core use cases. A partnership can be used for one or all three, depending on what you and your partner agree to enable. ### Discover Understand how your audience overlaps with your partner's — and what those shared customers look like. Run an overlap analysis to see how many records match between the two datasets, broken down by shared demographic or behavioural attributes (such as gender, age group, or purchase category). This tells you the size and composition of your shared audience without either side exposing individual records. > [!NOTE] > > **Example:** A retailer (Contributor) and an FMCG brand (Subscriber) use overlap analysis to understand what share of the brand's customer base shops at the retailer, and which product categories those shared customers buy. ### Activate Save matched segments as audiences and push them to advertising channels for targeting. Once you have run an overlap analysis, the Subscriber can save the matched population — or specific breakdowns of it — as an audience in Zeotap CDP. That audience can then be activated to any channel the Contributor has permitted, such as a DSP or paid social platform. > [!NOTE] > > **Example:** A media owner (Contributor) allows an advertiser (Subscriber) to save the overlap between the advertiser's high-value customers and the media owner's addressable inventory, and activate it directly to a campaign on a permitted ad platform. ### Suppress Identify customers in your dataset who were *not* reached by your partner — for exclusion targeting or incrementality measurement. The suppression view shows the non-overlapping portion of the Subscriber's audience. This is useful for building exclusion lists (avoid showing ads to people already reached), measuring incremental reach (how much new audience did the partnership unlock?), and managing frequency across channels. > [!NOTE] > > **Example:** A brand (Subscriber) uses suppression to identify which of their CRM customers have not been exposed to a partner publisher's campaign, then activates that segment separately to close the coverage gap. ## What you can do in Collaborate | Capability | Description | | :- | :- | | Overlap analysis | Measure the size of the matched audience between two datasets. | | Insight dimensions | Break down the overlap by shared attributes (for example, gender, age group, loyalty tier). | | Audience saving | Save matched or suppressed results as audiences in Zeotap CDP. | | Channel activation | Push saved audiences to ad platforms and CRM systems. | | Suppression analysis | Identify the non-overlapping portion of your audience. | | Privacy controls | Set a minimum cohort size below which results are not shown to your partner, and control the channels where users can activate the segments. | ## How it works A Collaborate partnership always involves two roles. | Role | What they do | | :- | :- | | **Contributor** | Owns the data. Controls which attributes are shared, sets privacy thresholds, and defines what the Subscriber can activate. | | **Subscriber** | Brings their own audience. Maps identity keys, runs overlap analysis, and saves results as audiences for activation. | > [!NOTE] > > The Contributor is displayed as **Publisher** in some parts of the product. The partnership follows a structured setup before analysis can begin: 1. The Contributor creates the partnership — an invitation email is sent immediately to the CDP admins of the Subscriber organisation. 2. The Contributor configures which attributes to share and sets privacy controls. 3. The Subscriber accepts the invitation — the partnership status moves to **In Setup**. 4. The Subscriber maps their identity keys to the Contributor's, completing their configuration. 5. Once both sides have submitted, the partnership becomes **Active**. 6. The Subscriber runs analysis to view overlap/suppression results and activate relevant segments. ## Partnership status lifecycle | Status | Meaning | | :- | :- | | **Pending** | Partnership created. Invitation email sent to the Subscriber's CDP admins. Waiting for the Subscriber to accept. The Contributor can begin their configuration at this stage. | | **In Setup** | Subscriber has accepted the invitation. Both sides are completing their configuration. The Subscriber can map join keys only once the Contributor has submitted their side. | | **Active** | Both sides have submitted their configuration. All three use cases are available. | | **Archived** | Partnership closed. No further analysis is possible. Both organisations receive an email notification. | ## Which role are you? > [card] [I own the data I want to share → Contributor Guide](/articles/collaborate-customer/contributor-guide) > > Create the partnership, select attributes to share, set privacy and activation controls, and manage the partnership throughout its lifetime. > [card] [I want to analyse a partner's data → Subscriber Guide](/articles/collaborate-customer/subscriber-guide) > > Accept an invitation, map your identity keys, run overlap analysis, and save matched audiences for activation. ## Prerequisites Complete these before attempting to create or join a partnership. **Admin tasks — completed once per organisation** * Confirm your organisation is on the Zeotap **composable CDP plan** (a warehouse-native BigQuery setup is required for both sides). To be a Subscriber, your organisation must be composable. * Request the **Collaborate module** to be enabled for your org, and enable **collaboration consent** — contact your Zeotap account team. Only consenting organisations appear in the partner selection dropdown. **Contributor tasks — before creating a partnership** * Confirm at least one composable data source is onboarded in your org. * Confirm that source contains at least one ID-type attribute (for example, Email MD5 or Phone MD5) or a primary key column, to serve as the join key. **Subscriber tasks — before accepting a partnership** * Confirm you have onboarded a dataset as a **customer parent model** in your org. This is required for overlap analysis — the join key of the customer parent model lets the system resolve user profiles for matching. * Ensure your org's CDP admins are monitoring their inbox — they receive the invitation email when a Contributor creates a partnership with your org. ## Core concepts | Term | Definition | | :- | :- | | **Partnership** | A named collaboration between a Contributor and a Subscriber org. Contains configuration from both sides and all analysis results. Each partnership has a unique ID. | | **Join Key** | The identity attribute used to match records between the two organisations. Must be an ID-type attribute (for example, Email MD5). Both parties must hold the same identifier type for successful overlap analysis. | | **Insight Dimension** | An attribute the Contributor shares for segment analysis — for example, gender or purchase category. Subscribers see aggregated counts broken down by this attribute, not individual values. | | **Aggregate Threshold** | A minimum group size set by the Contributor. Any cohort smaller than this is not shown in results. Default is 1,000. | | **Activation** | The ability for the Subscriber to save overlap results as an audience and push it to a connected channel. Enabled and scoped to specific channels by the Contributor. | | **Suppression** | An analysis view showing users in the Subscriber's dataset that were not matched — useful for exclusion targeting and incrementality measurement. | | **Composable Source** | A warehouse-native data source where raw data stays in the client's own BigQuery environment. Zeotap queries it in place without copying it. | ## Related guides > [card] [Quick Start](/articles/collaborate-customer/quick-start) > [card] [Contributor Guide](/articles/collaborate-customer/contributor-guide) > [card] [Subscriber Guide](/articles/collaborate-customer/subscriber-guide) > [card] [Key Concepts](/articles/collaborate-customer/key-concepts) > [card] [FAQs](/articles/collaborate-customer/frequently-asked-questions) # Contributor Guide Source: https://docs.zeotap.com/articles/collaborate-customer/contributor-guide As the Contributor, you own the data in a Collaborate partnership. Create the partnership, decide which attributes your partner can see, set the privacy controls that govern analysis results, and manage the partnership throughout its lifetime. As the Contributor (displayed as **Publisher** in most parts of the product), you own the data in a Collaborate partnership. You create the partnership, decide which attributes your partner can see, set the privacy controls that govern what they can do with analysis results, and manage the partnership throughout its lifetime. ## Prerequisites Before creating a partnership, confirm that: * Your organisation is on the **Zeotap composable CDP plan** and has the Collaborate module enabled. * Your organisation has given **collaboration consent** (contact your account team if unsure). * You have at least one **data source** onboarded. * That data source contains at least one **ID-type attribute** (for example, Email MD5 or Phone MD5) to serve as the join key, or you have a primary key column on a composable dataset. * You know which Zeotap organisation your partner belongs to, and they have also consented to collaborate. ## Creating a partnership **Step 1** In Zeotap CDP, navigate to **Collaborate → Partnerships** in the left sidebar. **Step 2** Click **+ Create Partnership** in the top right. **Step 3** Fill in the following fields: | Field | What to enter | | :- | :- | | **Partnership Name** | Choose a name meaningful to both teams — for example, "BrandX × RetailerY — Summer 2024". | | **Description** (optional) | A short note on the purpose. Visible to both sides. | | **Your Role** | Select **Contributor (I own the Data)**. | | **Partner Organisation** | Select your partner from the dropdown. Only organisations with collaboration consent enabled appear here. | **Step 4** Click **Next**. ![](https://mintcdn.com/zeotap/4Uwt8DmgKlLZCWzT/articles/collaborate-customer/Storage/collaborate-customer/collaborate/create-partnership.png?fit=max\&auto=format\&n=4Uwt8DmgKlLZCWzT\&q=85\&s=29e2cb038e9a1f7ff96e7f3fdc033d18) The partnership is created with **Pending** status, and an invitation email is sent immediately to all CDP admins of your partner's organisation. You can continue with the data configuration to begin your side of the setup straight away, without waiting for the Subscriber to accept. ## Configuring data sharing The configuration wizard has two steps. Complete both before your Subscriber can begin their side. ### Step 1 — Data Collaboration This is where you choose which attributes your partner can use for identity matching and segment analysis. Your available composable data sources are listed on the left. Expand a source to see its attributes, then toggle on the attributes you want to share. ![](https://mintcdn.com/zeotap/4Uwt8DmgKlLZCWzT/articles/collaborate-customer/Storage/collaborate-customer/collaborate/configure-data-collaboration.png?fit=max\&auto=format\&n=4Uwt8DmgKlLZCWzT\&q=85\&s=5d4d71b476729148ba0a78f7b161b6a3) **Setting join keys** At least one attribute must be designated as a **Join Key** — the identity attribute used to match records between your organisation and your partner's. The **Enable Join Key** toggle is available on: * **ID-type attributes** — such as Email MD5 Lowercase, Phone MD5, and similar hashed identifiers. * **Primary key columns** of composable datasets. Your partner will map their equivalent attribute to each join key you set here. Only mapped join keys are used when analysis runs. > [!WARNING] > > Once submitted, you **cannot remove** a join key from the partnership. The only way to remove it is to archive the partnership. **Setting insight dimensions** Insight dimensions are attributes you share for segment analysis. Your partner sees aggregated counts broken down by these attributes — for example, a count of matched users by gender — but never individual-level values. Toggle **Insight Dimension** on for categorical attributes you want to expose: age group, purchase category, loyalty tier, interest segment, and similar. > [!WARNING] > > **Choosing the right attributes as insight dimensions:** Only use categorical attributes with a limited set of values (for example, gender, age band, region). Do **not** enable individual-level attributes (such as customer IDs, precise location, or any field that varies at an individual level) as insight dimensions. Even though results are protected by the aggregate threshold, attributes that differ at the individual level are not suitable for group-by analysis and will produce results of limited value. This applies whether you are using a composable or an ingested source. **Minimum requirement** At least one join key must be enabled. Clicking **Next** without a join key will show an inline error. Click **Next** to proceed. ### Step 2 — Privacy and Activation Control **Aggregate Threshold** The minimum number of matched users required for a cohort to appear in analysis results. Any segment bucket smaller than this number is not shown to your partner — it does not appear as a low number, it is suppressed entirely. The default is **1,000**. You can increase this for stronger privacy protection. > [!NOTE] > > **Example:** If the threshold is 2,000 and your partner runs a gender breakdown, a bucket showing "Female: 1,450" would be hidden. "Male: 3,200" would be visible. **Activation Settings** Controls whether your partner can save overlap results as audiences and activate them. * **Allow Activation** — toggle on to permit your partner to save audiences from analysis results. * **Activation Channels** — if activation is enabled, select which channels your partner may activate to (for example, TTD or Google DV360). ![](https://mintcdn.com/zeotap/4Uwt8DmgKlLZCWzT/articles/collaborate-customer/Storage/collaborate-customer/collaborate/privacy-activation-control.png?fit=max\&auto=format\&n=4Uwt8DmgKlLZCWzT\&q=85\&s=dbfa7332dea6abf896d2dce8b789bf3e) When activation is enabled, your partner can: * Save the full overlap as an audience. * Save individual insight dimension breakdowns as separate audiences (for example, save just the "Female" matched segment). * Activate those audiences to the channels you have permitted. Your partner **cannot** copy the saved audiences to other destinations beyond what you have permitted, and they have no access to the raw individual-level values that make up those audiences. Click **Submit** to complete configuration. ## After you submit Your partner's invitation remains open for them to accept. Once they accept, the partnership status moves to **In Setup**. The Subscriber can begin mapping their join keys once you have submitted your configuration. When both sides have submitted, the partnership becomes **Active**. You can track progress in the **Activity Log** tab. ## Activity log The **Activity Log** tab records all key events for the partnership, visible to both sides. As the Contributor, you will see events generated by both you and your Subscriber in the same log: * Invite Sent * Invite Accepted * Invite Declined * Configuration Saved (both sides) * Analysis Run * Audience Saved * Partnership Terminated For a full explanation of what each event means, when it fires, and what information it shows, see [Key Concepts](/articles/collaborate-customer/key-concepts#activity-log). ## Editing your configuration You can edit your configuration at any time, including while the partnership is **Active**. **Step 1** Open the partnership and go to the **Configure** tab. **Step 2** Click **Edit Configuration**. **Step 3** Make your changes — you can add more attributes, adjust the threshold, or change activation settings. **Step 4** Click **Submit**. > [!NOTE] > > * Updated settings do **not** apply to audiences that subscribers have already saved. > * You **cannot** remove join keys once they are added to the partnership. > * Editing your configuration may require the Subscriber to re-run analysis to see results based on the updated attribute set. ## Archiving a partnership When a partnership is no longer needed, you can archive it from the partnership detail view. Both organisations receive an email notification when the partnership is archived. > [!WARNING] > > Archived partnerships **cannot be reactivated** and no new analysis can be run in them. Audiences that have already been saved continue to run. ## Constraints and limitations * A combination of attributes across **composable data sources** and **ingested sources** cannot be shared in a single partnership. At any time, you can share either ingested attributes or attributes across composable sources — not both. * A partnership has exactly **one Contributor and one Subscriber**. * The Subscriber can only start their configuration after you have submitted yours. * Join keys must be ID-type attributes or primary key columns on composable datasets. * Your partner can only activate to channels you have **explicitly permitted**. ## Related guides > [card] [Quick Start](/articles/collaborate-customer/quick-start) > [card] [Subscriber Guide](/articles/collaborate-customer/subscriber-guide) > [card] [Key Concepts](/articles/collaborate-customer/key-concepts) > [card] [FAQs](/articles/collaborate-customer/frequently-asked-questions) # Frequently Asked Questions Source: https://docs.zeotap.com/articles/collaborate-customer/frequently-asked-questions Common questions from Contributors and Subscribers about Zeotap Collaborate — partnerships, privacy controls, analysis, activation, and data handling. ## For Contributors > [accordion] Who can I create a partnership with? > > You can create a partnership with any organisation that is onboarded on Zeotap CDP and has enabled collaboration consent. Only consenting organisations appear in the partner selection dropdown. If you cannot find your intended partner, ask them to contact their Zeotap account team. > [accordion] Can I create multiple partnerships with the same partner? > > Yes. You can create as many partnerships as you need, even with the same subscriber organisation. This is useful if you want to share different attribute sets, or apply different privacy settings, for different use cases. > [accordion] What is the minimum aggregate threshold I can set? > > 1,000. This is a fixed lower bound and cannot be reduced. Zeotap enforces this minimum to prevent small cohort sizes from being used to infer individual identities. > [accordion] Can I change my configuration after the partnership is Active? > > Yes. Open the partnership, go to the **Configure** tab, and click **Edit Configuration**. You can add more attributes, adjust the aggregate threshold, and change activation settings at any time. Note that your Subscriber may need to re-run analysis to see results based on the updated configuration. Updated settings will not apply to any audience that was saved before the edit. > [accordion] Can I see the results of the analysis? > > As the Contributor you set up and govern the partnership, but analysis is initiated and viewed by the Subscriber. You have visibility of the activity log (which shows when analysis runs and when configuration is saved) but you do not see the analysis results panel. > [accordion] My partner cannot find my organisation in their partner dropdown. What should I do? > > This means collaboration consent has not been enabled for your organisation. Contact your Zeotap account team and ask them to enable it. > [accordion] Can I control which specific channels my Subscriber can activate to? > > Yes. In Step 2 of the configuration wizard, if you enable activation you can select individual channels. Your Subscriber can only activate to the channels you have explicitly permitted, regardless of what channels are connected in their own Zeotap org. ## For Subscribers > [accordion] How do I know when a partnership is ready for me to configure? > > The partnership will appear in your **Collaborate → Partnerships** list with **Pending** status. You will also receive a notification from Zeotap. Click the partnership name and then **Accept Invitation** to proceed. Once the Contributor has submitted their configuration, you can map your join keys. > [accordion] What happens if I do not have one of the join key types my partner has set up? > > Leave it unmapped. The analysis will still run using the join keys you have successfully mapped. An unmapped join key does not cause an error — it is simply excluded from the identity matching step. Your overlap result may be smaller, but it will still be valid. > [accordion] Can I see my partner's raw data? > > No. The clean room architecture ensures you only ever see aggregated counts. You cannot query, download, or export individual-level records from your partner's dataset. > [accordion] Why are some rows hidden in my insight dimension results? > > Your Contributor partner has set an aggregate threshold — a minimum group size for results to be shown. Any cohort with fewer than that many matched users is suppressed. This is a privacy protection and is not a data quality issue. The note in the results panel will confirm when suppression has occurred. > [accordion] The Save as Audience button is greyed out. Why? > > There are two possible reasons: > > 1. The overlap for that cohort is below the Contributor's aggregate threshold (minimum 1,000). Audiences cannot be saved from groups smaller than this threshold. > 2. Your Contributor partner has not enabled activation for this partnership. Contact your partner if you believe activation should be permitted. > [accordion] Can I run analysis more than once? > > Yes. You can run analysis as many times as you need. Each run queries the current state of both organisations' data. Running analysis again after you or your partner updates your data will give you fresh results. > [accordion] How long does analysis take? > > Typically a few minutes, depending on data volume. The page refreshes automatically when results are ready. > [accordion] What is suppression analysis and when should I use it? > > Suppression shows the users in your dataset who were not matched by your partner. Use it when you want to target people your partner has not yet reached — for exclusion audiences, new customer acquisition campaigns, or understanding the non-overlapping portion of your audience. > [accordion] Can I activate audiences to any channel I want? > > Only to channels your Contributor partner has explicitly permitted in their activation settings. If a channel is not available in your activation workflow for a particular partnership, your partner has not enabled it. Reach out to them to discuss. > [accordion] I accepted the invitation but the partnership is still showing as In Setup. Why? > > Once you accept, the status correctly moves from Pending to **In Setup**. It stays In Setup until both sides have submitted their configuration. If you have submitted your join key mapping but the partnership is still In Setup, it means your Contributor partner has not yet completed their configuration on their end. Check with them. ## General > [accordion] Is my data ever shared with my partner? > > No. Collaborate is built on a clean room architecture where raw data from neither side is shared with the other. The Contributor's data is queried in place within a secure BigQuery environment. The Subscriber never receives individual-level records from the Contributor, and vice versa. Only aggregated counts that meet the minimum threshold are returned as results. > [accordion] What happens to my data if I archive a partnership? > > Archiving a partnership removes it from the active partnerships list and prevents any further analysis. Both organisations receive an email notification when the partnership is archived. It does not delete your underlying data — your data source and attributes remain intact in your Zeotap org. Any audiences already saved from previous analyses are also unaffected. > [accordion] Does Collaborate support more than two organisations in a single partnership? > > Not currently. Each partnership is a one-to-one relationship between a single Contributor and a single Subscriber. If you need to collaborate with multiple partners, create separate partnerships with each. > [accordion] Can the Subscriber become a Contributor in a different partnership? > > Yes. Roles are set per partnership. An organisation can be a Contributor in one partnership and a Subscriber in another simultaneously. > [accordion] Who can see the analysis results? > > Only the Subscriber sees the analysis results panel. The Contributor sets the parameters but does not view results directly. Both sides can see the activity log for the partnership. > [accordion] What are the main use cases for Collaborate? > > Collaborate supports three core use cases: > > * **Overlap** — Understand how your audience overlaps with a partner's. Run an overlap analysis to see the size and composition of your shared audience, broken down by attributes such as gender, age group, or purchase category. > * **Activate** — Save matched segments as audiences and push them to ad platforms or CRM systems. The Contributor controls which channels are permitted. > * **Suppress** — Identify customers in your dataset who were *not* reached by your partner. Use the non-overlapping population to build exclusion lists, measure incremental reach, or manage ad frequency across channels. > > These three use cases map to the Overlap, Insight Dimension, and Suppression sections in the Analysis tab. > [accordion] I am getting a 'No matching customers found' error after running analysis. What does this mean? > > This means no identity matches were found between your dataset and your partner's using the mapped join keys. Common causes are: the two organisations are using different identifier types or different hashing algorithms (for example, one side has Email MD5 and the other has Email SHA256), the subscriber has not mapped the correct attributes, or the underlying audiences genuinely do not overlap. Check your join key mapping and confirm the identifier type and hash format with your partner. ## Related guides > [card] [Quick Start](/articles/collaborate-customer/quick-start) > [card] [Contributor Guide](/articles/collaborate-customer/contributor-guide) > [card] [Subscriber Guide](/articles/collaborate-customer/subscriber-guide) > [card] [Key Concepts](/articles/collaborate-customer/key-concepts) # Key Concepts Source: https://docs.zeotap.com/articles/collaborate-customer/key-concepts The core ideas behind Collaborate — the data clean room, join keys, insight dimensions, aggregate thresholds, activation settings, the partnership lifecycle, composable vs ingested sources, suppression, and the activity log. This reference explains the core ideas behind Zeotap Collaborate. Understanding these concepts will help you configure partnerships correctly and interpret analysis results accurately. ## Data Clean Room Zeotap Collaborate is built on **Google BigQuery's Analytics Hub Data Clean Room** infrastructure. This is what makes privacy-safe collaboration possible. When a partnership is created, Zeotap provisions a secure, isolated environment inside BigQuery. Overlap analysis runs inside this environment — neither organisation's raw data leaves their own environment. The Contributor's data is queried in place; the Subscriber's data is brought in for matching; the result that comes out is an aggregated count, not a list of individuals. This architecture means: * The Subscriber never receives the Contributor's raw records. * The Contributor never sees what is in the Subscriber's dataset. * Both sides can trust that the analysis reflects true overlap without either party exposing their customer data. ## Join Keys A **Join Key** is the identity attribute used to match records between the Contributor's dataset and the Subscriber's dataset. It must be an ID-type attribute — a field that uniquely identifies a person, such as a hashed email address or hashed phone number. **How matching works** The clean room compares the join key values from both sides. A match occurs when the same identifier value appears in both datasets. For example, if both organisations hold Email MD5 values, a user with Email MD5 `a3f…` on the Contributor side is matched to the same `a3f…` value on the Subscriber side. > [!TIP] > > Use consistent, mutually agreed-upon hashed data (such as SHA-256 emails or user IDs) as a standard best practice for privacy-safe data collaboration. **Multiple join keys** A partnership can have more than one join key — for example, both Email MD5 and Phone MD5. Each join key is matched independently. This generally increases the size of the overlap, because users who are present in only one identifier type can still be matched. **Unmapped join keys** If the Subscriber has not mapped one of the Contributor's join keys (because they do not hold that identifier type), that join key is simply excluded from the analysis. The partnership still works; the overlap is calculated using only the keys that were successfully mapped. **Common join key types** Email MD5, Email SHA256, Phone MD5, Phone SHA256, Zeotap ID, and other platform-specific IDs are typical join key types. The key requirement is that both organisations hold the same type and have applied the same hashing algorithm. ## Insight Dimensions An **Insight Dimension** is an attribute the Contributor chooses to share for analysis purposes — not for matching. It allows the Subscriber to break down the overlap count by characteristics of the Contributor's audience. **What the Subscriber sees** When a Subscriber selects an insight dimension in analysis, they see the matched overlap count split by each value of that attribute. For example, if the Contributor shares "Gender" as an insight dimension, the Subscriber sees: | Gender | Overlap | | :- | :- | | Male | 11,678 | | Female | 11,800 | The Subscriber does not see which specific users fall into each group — only the aggregate count per segment. **What the Contributor should consider** Insight dimensions are a deliberate choice. By enabling an attribute as an insight dimension, you are giving your partner partial visibility into the demographic or behavioural composition of the matched audience. Consider whether this is appropriate for your data governance policies before enabling dimensions beyond the join key. This applies to both composable and ingested sources — in both cases, aggregated breakdown values are visible to your partner in results. **Choosing the right attributes** Insight dimensions are designed for categorical attributes with a finite set of values — gender, age band, purchase category, region, device type. Do **not** enable individual-level attributes (customer IDs, precise timestamps, free-text fields, or any attribute whose values differ at the per-person level) as insight dimensions. Even though results are guarded by the aggregate threshold, these attributes are not suitable for group-by analysis and will not produce meaningful results. **Common insight dimension examples** Age group, gender, purchase category, interest segment, loyalty tier, device type, and geography (country or region) are frequently used as insight dimensions. ## Aggregate Threshold The **Aggregate Threshold** is a minimum group size set by the Contributor. Any cohort in the analysis results that contains fewer users than this threshold is hidden entirely from the Subscriber — not shown as a small number, but suppressed completely. **Default** The default threshold is **1,000**. Groups smaller than 1,000 are not shown in results by default. **Why suppression exists** If a Subscriber could see very small cohort sizes — for example, "3 matched users are Female aged 25–34 in Munich" — it would be possible in some cases to infer the identity of individuals. Suppressing small cohorts prevents this. **Effect on Save as Audience** The threshold also governs whether a Subscriber can save a cohort as an audience. Any overlap bucket not shown due to the threshold cannot be saved as an audience. ## Activation Settings **Activation Settings** are configured by the Contributor and control what the Subscriber can do with analysis results beyond viewing them. **Allow Activation toggle** When this is off, the Subscriber can run analysis and view all result panels, but the **Save as Audience** button is disabled throughout. No audiences can be created from this partnership. When this is on, the Subscriber can save audiences from the Overlap, Insight Dimension, and Suppression sections. **Activation Channels** When activation is enabled, the Contributor selects which downstream channels the Subscriber may push audiences to. Only destinations from these channels appear in the Subscriber's activation workflow. If the Contributor has not permitted a particular channel, the Subscriber cannot activate it — even if that channel is connected in their own Zeotap org. > [!NOTE] > > A channel selected by the publisher also needs to be enabled for the subscriber org to facilitate activation. ## Partnership Lifecycle A Collaborate partnership moves through the following statuses: | Status | What it means | | :- | :- | | **Pending** | The partnership has been created. An invitation email has been sent to the Subscriber's CDP admins. Waiting for the Subscriber to accept. The Contributor can begin their configuration at this stage. | | **In Setup** | The Subscriber has accepted the invitation. Both sides are completing their configuration. The Subscriber can map join keys once the Contributor has submitted their configuration. | | **Active** | Both sides have submitted their configuration. Analysis can be run. | | **Archived** | The partnership has been closed. It is no longer available for analysis. Both organisations receive an email when a partnership is archived. This is a terminal status. | The **Activity Log** tab on each partnership shows a timestamped record of all user-facing events, visible to both sides. See [Activity Log](#activity-log) below for the full reference. ## Composable Sources vs Ingested Attributes These are the two ways data can be brought into Zeotap, and they behave differently in the context of Collaborate. **Composable Sources (warehouse-native)** A composable source connects to data that lives in the **client's own BigQuery environment**. Zeotap creates a view over the data and queries it in place — no raw data is copied into Zeotap's systems. Collaboration only works if the subscriber's org is a composable org. This is to enable audience creation and activation on the publisher's attributes without copying the publisher's data into the subscriber's project. **Ingested Attributes** Ingested attributes are data the client has uploaded into **Zeotap's managed environment** through standard data ingestion pipelines. The data is stored and processed within Zeotap's infrastructure. **Why they cannot be mixed** Each partnership must use one source type exclusively. The underlying infrastructure that powers the clean room analysis handles composable and ingested data through different query paths, and these paths cannot be combined within a single analysis context. ## Suppression Analysis Suppression is an analysis view that shows the portion of the Subscriber's dataset that was **not matched** by the Contributor. It is the inverse of the overlap. This is valuable for: * **Exclusion targeting** — identifying customers your partner has not yet reached, for campaigns aimed at filling that gap. * **Incrementality measurement** — understanding what share of your audience is unique versus shared with your partner. * **Frequency management** — suppressing already-reached audiences from campaigns to avoid over-exposure. The Subscriber can save the suppression result as an audience in the same way they can save the overlap result, subject to the same aggregate threshold and activation settings. ## Activity Log The Activity Log is a chronological, tamper-evident record of significant events on a partnership. It is visible to both the Contributor and the Subscriber — both sides see the same log, with no separate view per role. Each entry shows the event label, a human-readable description, the actor's organisation, and a timestamp. The following events are displayed in the UI. > [accordion] Invite Sent > > **When it fires:** Immediately when the Contributor creates the partnership. > > **What it shows:** "\[Contributor org] sent invite to \[Subscriber org]" > > **What it means:** The partnership has been created and an invitation email has been dispatched to the CDP admins of the Subscriber's organisation. The Contributor can begin their configuration at this point. > [accordion] Invite Accepted > > **When it fires:** When a Subscriber CDP admin accepts the invitation. > > **What it shows:** "\[Subscriber org] accepted the invite" > > **What it means:** The Subscriber has acknowledged the partnership. The status moves from **Pending** to **In Setup**. The Subscriber can now see the configuration screen and begin mapping their join keys, but only after the Contributor has completed their configuration. > [accordion] Invite Declined > > **When it fires:** When a Subscriber CDP admin declines the invitation. > > **What it shows:** "\[Subscriber org] declined the invite" > > **What it means:** The Subscriber has rejected the partnership. The partnership does not progress. The Contributor would need to create a new partnership to try again. > [accordion] Configuration Saved (Publisher) > > **When it fires:** When the Contributor submits their attribute selection and privacy settings (Steps 1 and 2 of the configuration wizard). > > **What it shows:** "\[Contributor org] submitted their configuration" > > **What it means:** The Contributor has defined which attributes are shared, which are join keys, which are insight dimensions, the aggregate threshold, and the activation settings. This unlocks the Subscriber's configuration step — the Subscriber can now map their join keys. > [accordion] Configuration Saved (Subscriber) > > **When it fires:** When the Subscriber submits their join key mapping. > > **What it shows:** "\[Subscriber org] mapped X join keys successfully" > > **What it means:** The Subscriber has mapped their identity attributes to the Contributor's join keys. The number of successfully mapped keys is shown in the description. If both sides have now submitted, the partnership status moves to **Active** and analysis can begin. > [accordion] Analysis Run > > **When it fires:** When an analysis pipeline run completes successfully. > > **What it shows:** "Overlap analysis completed with X matched records" > > **What it means:** The Subscriber triggered an overlap analysis and it has finished. The overlap count in the description is the total number of matched records across all mapped join keys. The Subscriber can view the full results in the Analysis tab. > [accordion] Audience Saved > > **When it fires:** When the Subscriber saves an audience from analysis results. > > **What it shows:** "Audience saved from \[overlap / insight dimension / suppression] segments" > > **What it means:** The Subscriber has created a new audience from their analysis results. The description indicates which part of the results it was saved from — the main overlap, an insight dimension breakdown, or the suppression view. The audience is now available in **Segment → Audiences** for activation. > [accordion] Partnership Terminated > > **When it fires:** When either the Contributor or the Subscriber terminates the partnership. > > **What it shows:** "\[Org name] terminated the partnership" > > **What it means:** The partnership has been archived. No further analysis can be run. Both organisations receive an email notification. Any audiences already saved from previous analyses are unaffected. ## Related guides > [card] [Quick Start](/articles/collaborate-customer/quick-start) > [card] [Contributor Guide](/articles/collaborate-customer/contributor-guide) > [card] [Subscriber Guide](/articles/collaborate-customer/subscriber-guide) > [card] [FAQs](/articles/collaborate-customer/frequently-asked-questions) # Quick Start: Your First Partnership Source: https://docs.zeotap.com/articles/collaborate-customer/quick-start Set up a Collaborate partnership from scratch and run your first Discover, Activate, and Suppress analyses. The whole process takes around 15 minutes once both parties are ready. This guide walks both the Contributor and the Subscriber through setting up a Collaborate partnership from scratch and running your first Discover, Activate, and Suppress analyses. The whole process takes around 15 minutes once both parties are ready. ## Admin setup — complete once before your first partnership These steps are done once per organisation. If your org has already done this, skip ahead to Step 1. * **Enable the Collaborate module** — Contact your Zeotap account team to have the Collaborate module activated on your org. It will not appear in the left navigation until this is done. * **Confirm composable CDP plan** — Subscriber orgs must be on the Zeotap composable CDP plan (warehouse-native BigQuery setup). Confirm this with your account team if unsure. * **Enable collaboration consent** — Your org must opt in to data collaboration on Zeotap before it can appear in another org's partner dropdown. Ask your account team to enable this. * **Notify CDP admins** — When a Contributor creates a partnership, the invitation email goes to all CDP admins of the Subscriber org. Make sure the right people have admin access so they receive it. Contact the support team if you need to change this setting. ## Before you begin Make sure both organisations have completed the admin setup above, and that: * You have **at least one ID-type attribute in common** — for example, both sides hold Email MD5 data. * The Contributor has a data source onboarded, and the Subscriber has a source tagged as a **customer parent model**. ## Step 1 — Contributor: Create the partnership **Step 1** In Zeotap CDP, navigate to **Collaborate → Partnerships** in the left sidebar. **Step 2** Click **+ Create Partnership** in the top right. **Step 3** Fill in: * **Partnership Name** — choose something descriptive that both teams will recognise. * **Description** (optional) — a brief note on the purpose. * **Your Role** — select **Contributor (I own the Data)**. * **Partner Organisation** — select your partner from the dropdown. Only organisations with collaboration consent enabled appear here. If you cannot find your partner, ask them to contact their Zeotap account team. **Step 4** Click **Next**. ![](https://mintcdn.com/zeotap/4Uwt8DmgKlLZCWzT/articles/collaborate-customer/Storage/collaborate-customer/collaborate/create-partnership.png?fit=max\&auto=format\&n=4Uwt8DmgKlLZCWzT\&q=85\&s=29e2cb038e9a1f7ff96e7f3fdc033d18) The partnership is created with **Pending** status. An **invitation email is sent automatically to the CDP admins of your partner's organisation** — they do not need to look for it; it comes to them. You are taken to the configuration screen, where you can start your side of the setup immediately. ## Step 2 — Contributor: Configure data sharing You will see a two-step configuration wizard. ### Step 1 of 2 — Data Collaboration **Step 1** Browse your available composable data sources on the left and expand a source to see its attributes. **Step 2** For each attribute you want to share: * **Enable Join Key** — turn this on for the identity attribute that will be used to match records with your partner. Join keys are available on ID-type attributes (such as Email MD5 or Phone MD5) and on the primary key column of composable datasets. At least one join key is required to proceed. * **Insight Dimension** — turn this on for any attribute you want your partner to use in segment analysis (for example, gender, age group, or loyalty tier). ![](https://mintcdn.com/zeotap/4Uwt8DmgKlLZCWzT/articles/collaborate-customer/Storage/collaborate-customer/collaborate/configure-data-collaboration.png?fit=max\&auto=format\&n=4Uwt8DmgKlLZCWzT\&q=85\&s=5d4d71b476729148ba0a78f7b161b6a3) **Step 3** Click **Next** when done. If you click **Next** without selecting at least one join key, you will see an inline error — select a join key to proceed. > [!WARNING] > > **Choosing the right attributes as insight dimensions:** Insight dimensions are used for group-level analysis — your partner sees a count of matched users per value (for example, "Female: 11,800 users"). Use them for categorical attributes with a limited set of values. Do **not** enable individual-level attributes (such as a customer ID, email, or any attribute that varies per person) as insight dimensions. Even though results are protected by the aggregate threshold, surfacing granular per-individual attributes is not suitable for analysis and will not produce meaningful results. > [!NOTE] > > Publishers can only share attributes either from composable sources **or** from ingested sources — not a combination of both. Sharing both types together may result in duplicate records. ### Step 2 of 2 — Privacy and Activation Control **Step 1** **Aggregate Threshold** — the minimum group size for a cohort to appear in analysis results. Cohorts smaller than this are not shown to your partner. The default is 1,000. This ensures that overlaps below a certain size are not exposed, to avoid user re-identification. **Step 2** **Activation Settings** — select **Allow Activation** if you want your partner to be able to save overlap results as audiences, then select which channels they can activate to. ![](https://mintcdn.com/zeotap/4Uwt8DmgKlLZCWzT/articles/collaborate-customer/Storage/collaborate-customer/collaborate/privacy-activation-control.png?fit=max\&auto=format\&n=4Uwt8DmgKlLZCWzT\&q=85\&s=dbfa7332dea6abf896d2dce8b789bf3e) **Step 3** Click **Submit**. ## Step 3 — Subscriber: Accept the invitation Your CDP admins received an invitation email when the Contributor created the partnership. To accept: **Step 1** Navigate to **Collaborate → Partnerships**. **Step 2** Find the partnership with **Pending** status and your role as **Subscriber**. **Step 3** Click the partnership name, then click **Accept Invitation**. Once accepted, the partnership status moves to **In Setup** and you can begin your configuration. ## Step 4 — Subscriber: Map your join keys The configuration screen shows the join keys the Contributor has set on their side. You map each to the equivalent attribute in your data. > [!NOTE] > > The Subscriber configuration step is only available once the Contributor has completed their configuration. If the Contributor has not yet submitted their side, you will not see the mapping screen. **Step 1** For each partner join key shown (for example, "Email MD5 Lowercase"), select the matching attribute from your own data. **Step 2** Map all available join keys if possible — each mapped key increases the chance of finding matches. ![](https://mintcdn.com/zeotap/4Uwt8DmgKlLZCWzT/articles/collaborate-customer/Storage/collaborate-customer/collaborate/map-join-key.png?fit=max\&auto=format\&n=4Uwt8DmgKlLZCWzT\&q=85\&s=5ec62a0afdc1f3ca9f5770eeb4a21d71) **Step 3** Click **Submit**. Once both sides have submitted, the partnership status becomes **Active**. ## Step 5 — Subscriber: Discover Discover is the overlap analysis step — understand how your audience aligns with your partner's and what those shared customers look like. **Step 1** Open the **Active** partnership and click the **Analysis** tab. **Step 2** Under **Matching on**, select the join key to use for this run. **Step 3** Click **Run Analysis**. ![](https://mintcdn.com/zeotap/4Uwt8DmgKlLZCWzT/articles/collaborate-customer/Storage/collaborate-customer/collaborate/analysis-results.png?fit=max\&auto=format\&n=4Uwt8DmgKlLZCWzT\&q=85\&s=02debaeb39076f5a12745ca089705da9) Analysis typically completes within a few minutes. When done, the page displays: | Metric | What it shows | | :- | :- | | Your Dataset | Total records in your data. | | Partner's Dataset | Total records in the Contributor's data. | | Overlap | Records matched between both datasets. | | Overlap % of Yours | Matched records as a percentage of your total. | | Overlap % of Partner's | Matched records as a percentage of the Contributor's total. | Use **Analyse by Insight Dimension** to select an insight dimension from the dropdown and see the overlap broken down by that attribute (for example, Gender: Male 11,678 / Female 11,800). Cohorts below the Contributor's aggregate threshold are not shown. ## Step 6 — Subscriber: Activate Activate — save matched segments as audiences and push them to ad channels. **Step 1** In the **Overlap** section, click **Save as Audience** to save the full matched population. ![](https://mintcdn.com/zeotap/4Uwt8DmgKlLZCWzT/articles/collaborate-customer/Storage/collaborate-customer/collaborate/save-as-audience.png?fit=max\&auto=format\&n=4Uwt8DmgKlLZCWzT\&q=85\&s=1a10ea95490b6e129bd3fb69cc2ffd4e) **Step 2** In the **Analyse by Insight Dimension** table, click **Save as Audience** next to a specific segment to save that breakdown as a separate audience (for example, save "Female" matched users only). **Step 3** Saved audiences appear in **Segment → Audiences** and can be activated to any channel the Contributor has permitted. > [!NOTE] > > Cohorts below the aggregate threshold (default 1,000 users) cannot be saved. The **Save as Audience** button is disabled for those rows. ## Step 7 — Subscriber: Suppress Suppress — identify customers not reached by your partner, for exclusion targeting or incrementality measurement. **Step 1** In the **Suppression** section of the Analysis tab, view the count of users in your dataset who were *not* matched by the Contributor. **Step 2** Click **Save as Audience** to save this non-overlapping population as a separate audience. **Step 3** Use this audience to exclude already-reached customers from campaigns, or to measure incremental reach. ## Tracking progress Both sides can monitor the partnership at any time via the **Activity Log** tab. As you work through the steps above, you will see these events appear in the log: * **Invite Sent** — when the Contributor created the partnership. * **Invite Accepted** — when the Subscriber accepted. * **Configuration Saved** — when either side submits their configuration. * **Analysis Run** — when an analysis run completed, with the overlap count. * **Audience Saved** — when the Subscriber saved an audience. ## What's next? > [card] [Contributor Guide](/articles/collaborate-customer/contributor-guide) > [card] [Subscriber Guide](/articles/collaborate-customer/subscriber-guide) > [card] [Key Concepts](/articles/collaborate-customer/key-concepts) > [card] [FAQs](/articles/collaborate-customer/frequently-asked-questions) # Subscriber Guide Source: https://docs.zeotap.com/articles/collaborate-customer/subscriber-guide As the Subscriber, you bring your own audience into a Collaborate partnership and run overlap analysis against your partner's data. You see only aggregated results that meet the privacy thresholds your partner has set — never raw data. As the Subscriber, you bring your own audience into a Collaborate partnership and run overlap analysis against your partner's data. You do not see raw data from your partner — only aggregated results that meet the privacy thresholds they have set. ## Prerequisites Before accepting a partnership invitation, confirm that: * Your organisation is onboarded on Zeotap CDP as a **composable organisation**. * Your organisation has enabled **collaboration consent** (contact your account team if you are unsure). * You have a **customer parent model** dataset onboarded as a source in your org. This is required to enable overlap analysis. * You hold at least one ID-type attribute that matches a join key your Contributor partner has configured (for example, if your partner shares Email MD5, you need Email MD5 data too). ## Accepting an invitation When a Contributor creates a partnership and selects your organisation, all CDP admins in your organisation receive an invitation email. The partnership also appears in your **Collaborate → Partnerships** list with **Pending** status. **Step 1** Navigate to **Collaborate → Partnerships** in the left sidebar. **Step 2** Find the pending partnership — you will see the Contributor's organisation name and the partnership name they chose. **Step 3** Click the partnership name to open it. **Step 4** Click **Accept Invitation**. Once you accept, the partnership status moves to **In Setup**. Both sides are now configuring their end. ## Configuring your join key mapping > [!NOTE] > > The join key mapping step is only available once the Contributor has submitted their configuration. If the Contributor has not yet completed their side, you will not see the mapping screen — check with your partner on their readiness. The configuration screen shows the join keys your Contributor partner has set up on their side. Your task is to map each one to the equivalent attribute in your own data. Each row shows: * **Partner's Join Key** — the attribute name and ID type your partner is using (for example, "Email MD5 Lowercase"). * **Your Mapped Attribute** — the dropdown where you select the equivalent attribute from your data. **Step 1** Click the dropdown in the **Your Mapped Attribute** column. **Step 2** Select the attribute in your data that corresponds to the partner's key. **Step 3** Repeat for all available join keys, then click **Submit**. ![](https://mintcdn.com/zeotap/4Uwt8DmgKlLZCWzT/articles/collaborate-customer/Storage/collaborate-customer/collaborate/map-join-key.png?fit=max\&auto=format\&n=4Uwt8DmgKlLZCWzT\&q=85\&s=5ec62a0afdc1f3ca9f5770eeb4a21d71) > [!TIP] > > Map as many join keys as you can. A higher number of mapped identity types generally produces a more complete overlap result. Only the join keys you have successfully mapped will be available for selection when you run analysis. > [!NOTE] > > Any join keys you leave unmapped will not contribute to the analysis — they are shown with a **Not mapped** status but will not cause the partnership to fail. Once you submit, the partnership status moves to **Active** automatically (assuming the Contributor has already submitted their side). ## Run overlap analysis Discover lets you understand how your audience overlaps with your partner's and what those shared customers look like. **Step 1** Open the **Active** partnership and click the **Analysis** tab. **Step 2** Under **Matching on**, select which join key(s) to use for this run. **Step 3** Click **Run Analysis**. Analysis runs asynchronously and typically completes within a few minutes. The page refreshes automatically when results are ready. You can run analysis as many times as you need — each run uses the current state of both organisations' data. ## Reading your Discover results ![](https://mintcdn.com/zeotap/4Uwt8DmgKlLZCWzT/articles/collaborate-customer/Storage/collaborate-customer/collaborate/analysis-results.png?fit=max\&auto=format\&n=4Uwt8DmgKlLZCWzT\&q=85\&s=02debaeb39076f5a12745ca089705da9) **Overlap** | Metric | What it means | | :- | :- | | Your Dataset | Total records in your data. | | Partner's Dataset | Total records in the Contributor's data. | | Overlap | Records matched between both datasets. | | Overlap % of Yours | Matched records as a percentage of your total dataset. | | Overlap % of Partner's | Matched records as a percentage of your partner's total dataset. | **Analyse by Insight Dimension** If your partner has enabled insight dimensions, select one from the **Analyse by** dropdown (for example, Gender or Age Group) to break the overlap down by that attribute. | Segment | Overlap | | :- | :- | | Male | 11,678 | | Female | 11,800 | | Unknown | 432 | > [!NOTE] > > **Privacy note:** Rows may be hidden if the count falls below your partner's aggregate threshold. This is expected behaviour — those cohorts are too small to be shown under the partner's privacy settings. ## Activate — save audiences for channel targeting Activate turns your Discover results into audiences you can push to ad platforms and other destinations. * **Save the full overlap** — in the **Overlap** section, click **Save as Audience** to save the entire matched population. * **Save a segment** — in the **Analyse by Insight Dimension** table, click **Save as Audience** next to any row to save that specific segment as its own audience (for example, "Female" matched users only). ![](https://mintcdn.com/zeotap/4Uwt8DmgKlLZCWzT/articles/collaborate-customer/Storage/collaborate-customer/collaborate/save-as-audience.png?fit=max\&auto=format\&n=4Uwt8DmgKlLZCWzT\&q=85\&s=1a10ea95490b6e129bd3fb69cc2ffd4e) Saved audiences appear in **Segment → Audiences** and can be pushed to any connected destination the Contributor has permitted. > [!NOTE] > > **Minimum size:** Cohorts below the aggregate threshold (default 1,000 users) cannot be saved. The **Save as Audience** button is disabled for those rows. > [!NOTE] > > **Activation channels:** The channels available to you are controlled by your Contributor partner's activation settings. If a channel is missing, your partner has not permitted it for this partnership. ## Suppress — exclusion targeting and incrementality Suppress shows the portion of your dataset that was *not* matched by your partner. Use this to: * **Build exclusion audiences** — avoid showing ads to customers your partner has already reached. * **Measure incremental reach** — understand how much new audience the partnership unlocks beyond your existing overlap. * **Manage frequency** — suppress already-exposed users to avoid over-targeting. In the **Suppression** section of the Analysis tab, view the unmatched count and click **Save as Audience** to save the non-overlapping population for use in campaigns. ## Tracking partnership activity The **Activity Log** tab shows a timestamped record of all key events for the partnership, visible to both you and the Contributor in the same log: Invite Sent, Invite Accepted, Invite Declined, Configuration Saved (both sides), Analysis Run, Audience Saved, and Partnership Terminated. ![](https://mintcdn.com/zeotap/4Uwt8DmgKlLZCWzT/articles/collaborate-customer/Storage/collaborate-customer/collaborate/activity-log.png?fit=max\&auto=format\&n=4Uwt8DmgKlLZCWzT\&q=85\&s=14fac6731e77f4841d6463cffb459d03) For a full explanation of what each event means, when it fires, and what information it shows, see the [Activity Log reference in Key Concepts](/articles/collaborate-customer/key-concepts#activity-log). ## Constraints and limitations * You can only run analysis if the partnership is **Active** — both sides must have submitted their configuration. If the partnership is still In Setup, wait for the Contributor to complete their side. * Only the join keys you have **mapped** are used in analysis; unmapped keys are excluded. * The **aggregate threshold** is set by your Contributor partner and cannot be overridden. * Audience saving requires a minimum of **1,000 matched users** per cohort. * You can only activate saved audiences to channels your partner has **explicitly permitted**. * You **cannot** change the Contributor's attribute selection or privacy settings — contact your partner directly if you need adjustments. * You need a data source marked as a **customer parent model** to enable successful overlap analysis. The join key of this source lets the system resolve user profiles for matching. ## Related guides > [card] [Quick Start](/articles/collaborate-customer/quick-start) > [card] [Contributor Guide](/articles/collaborate-customer/contributor-guide) > [card] [Key Concepts](/articles/collaborate-customer/key-concepts) > [card] [FAQs](/articles/collaborate-customer/frequently-asked-questions) # Comcast EntOS Source: https://docs.zeotap.com/articles/comcast-entos-publication/comcast-ent-os ## Overview Comcast's EntOS is a comprehensive entertainment platform designed to enhance home entertainment by offering users greater control, discovery, and enjoyment of content across various devices. It aggregates multiple services and subscriptions, providing intuitive navigation and personalised content recommendations to reduce search time and increase viewing satisfaction. By integrating with Zeotap's Customer Data Platform (CDP), you can create audience segments using your first-party data and associate them with device Ids. This integration enables you to push these audiences to Comcast EntOS, improving audience targeting, enhancing personalisation for set-top box users, and optimising advertising effectiveness. ## Supported Identifiers You can use this integration to send any identifiers like Device Id, Account Id and other attributes of your choice. ## Available Actions and Supported Features | Action Name | [ID EXTENSION](https://docs.zeotap.com/articles/segment-customer/extend-your-audience/a/h2_1167151146) | [DELETE](https://docs.zeotap.com/articles/integrate-customer/delta-upload-and-delete-functions) | [DELTA UPLOAD](https://docs.zeotap.com/articles/integrate-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send Identifiers and attributes to EntOS | - | - | - | ## Components of Comcast EntOS Ensure to obtain the following components of the Comcast EntOS integration from your Comcast POC before creating a destination in Zeotap CDP. These credentials are essential for generating a bearer token and establishing a secure connection with Comcast EntOS. * **Client ID –** Identifies the system, client, or application making API requests. * **Client Secret –** Serves as a confidential key for authenticating your application. * **Request ID –** Acts as a unique external transaction identifier, typically a UUID. * **Partner ID –** Represents your organisation's identity in the integration. * **Domain Name –** Defines the namespace for audience segmentation and targeting rules. ## Create a Destination for Comcast EntOS Perform the following steps to create a Destination for Comcast EntOS: **Step 1** Log into the Zeotap CDP App and go to the **DESTINATIONS** application. **Step 2** Click  + **Create Destination**. ![](https://mintcdn.com/zeotap/cTmgcQYl-5jOouxf/articles/comcast-entos-publication/Storage/comcast-entos-publication/project-integrate/adform/Destinations_all_1.png?fit=max\&auto=format\&n=cTmgcQYl-5jOouxf\&q=85\&s=f71cc3545ea27e7600739dc922f734fa) **Step 3** Under **All Destinations**, search for **Comcast EntOS**. **Step 4** Click **Comcast EntOS**. A screen appears displaying details about the particular destination towards the left. On the right-hand side of the screen find a list of fields that are required for the integration to be established. Enter the required details as mentioned in the following steps: 1. Enter a name for the Destination. 2. Enter the **Client ID, Client Secret, Request ID, Partner ID** (separated by commas) and the **Domain name** obtained from your Comcast POC. 3. Click **Next** to proceed to mapping. ![](https://mintcdn.com/zeotap/cTmgcQYl-5jOouxf/articles/comcast-entos-publication/Storage/comcast-entos-publication/project-integrate/ent-os/ent-os-2025-03-03.png?fit=max\&auto=format\&n=cTmgcQYl-5jOouxf\&q=85\&s=c52e85ea4b958557ede8a0cfc62bdd62) **Step 5** In the **Actions and Mapping** screen, choose **Send identifiers and attributes to EntOS** as your action. ![](https://mintcdn.com/zeotap/cTmgcQYl-5jOouxf/articles/comcast-entos-publication/Storage/comcast-entos-publication/project-integrate/ent-os/ent-os-2025-03-03-1.png?fit=max\&auto=format\&n=cTmgcQYl-5jOouxf\&q=85\&s=cd2c7bb661285ce3372f9e280c89c884) **Step 6** Under **Map the Fields**, map the required identifiers and attributes. Ensure to map the Catalogue fields to the corresponding Destination fields as per your requirement. **Step 7** After completing the mapping, click **Create Destination**. The created Destination gets listed in the **Audiences**application, which can be linked to an audience (segment). ## Link an Audience to the Comcast EntOS Destination For information about how to link an audience to the created Destination in the **Audiences** application, refer [here](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > **Note:** > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an Audience or a segment could be a specific group of customers who are over 18 years of age and who have performed an addToCart event within the last 30 days. # Overview Source: https://docs.zeotap.com/articles/dashboard-customer/overview Dashboard provides information about the key account metrics in the form of charts. The metrics include inbound events, number of unique users, number of segments in successful state and so on. To navigate to the Dashboard, log into the Zeotap CDP App and click **Dashboard** on the left navigation panel. The home screen of the Dashboard appears as shown below. ![](https://mintcdn.com/zeotap/cTmgcQYl-5jOouxf/articles/dashboard-customer/Storage/dashboard-customer/overview/button_cumulativive.png?fit=max\&auto=format\&n=cTmgcQYl-5jOouxf\&q=85\&s=7fcd8255723e1bf8970ae24951199ddc) > [!NOTE] > > For more information about different panels in the Dashboard, refer [here](/articles/dashboard-customer/panels-of-the-dashboard). ### When to use the “Show Cumulative Usage Data” option? Use the **Show Cumulative Usage Data** button to view the cumulative usage of all organisations within a parent organisation. For example, if your parent organisation is named "Client A" and it has two child organisations, "Client A-Child1" and "Client A-Child2," then enabling this option allows you to see the combined usage across all entities. By default, the **Show Cumulative Usage Data** button is disabled. In this state, the Dashboard panels display data solely for the selected organisation.  ![](https://mintcdn.com/zeotap/cTmgcQYl-5jOouxf/articles/dashboard-customer/Storage/dashboard-customer/overview/Dashboard_new_1.png?fit=max\&auto=format\&n=cTmgcQYl-5jOouxf\&q=85\&s=5d324f20b7dbcc7ed2f746a7d2702086) > [!NOTE] > > The **Show Cumulative Usage Data** option appears only when the selected organisation has child organisations. # Panels of the Dashboard Source: https://docs.zeotap.com/articles/dashboard-customer/panels-of-the-dashboard The Dashboard is broadly classified into the different panels as explained below. ## Panel 1: Summary Numbers ![](https://mintcdn.com/zeotap/cTmgcQYl-5jOouxf/articles/dashboard-customer/Storage/dashboard-customer/panels-of-the-dashboard/Screenshot_2024-02-28_at_11-59-44_AM.png?fit=max\&auto=format\&n=cTmgcQYl-5jOouxf\&q=85\&s=878b49f2784583bbc58fa16a34b5c171) * **Total Inbound Events** – The total number of inbound events (streaming events + batch events + Profile API calls ) received since the account was created. * **API Usage** – The total number of API calls made through the Profile API. This includes read, write and delete calls. * **Total Unique Users** – The total number of unique users that are ingested into the Zeotap system since the account creation. The users are included in the Total Unique Users count even if they are deleted after ingestion. * **Total the Zeotap CDP App Users** – The total number of the Zeotap CDP App users that are created under the account. * **Last 30 Days Logins** – The total number of the Zeotap CDP App users that are associated with the account and have logged-in within the last 30 days. ## Panel 2: Inbound Events ![](https://mintcdn.com/zeotap/cTmgcQYl-5jOouxf/articles/dashboard-customer/Storage/dashboard-customer/panels-of-the-dashboard/image_\(21\).png?fit=max\&auto=format\&n=cTmgcQYl-5jOouxf\&q=85\&s=ed467bde2a2f10f99259d861b6cb99c5) * **Total Inbound Events Breakdown**: This chart shows a breakdown of the total inbound events by ingestion type and through Profile API calls, comparing real-time ingestion with batch ingestion and Profile API calls. You can choose the duration for which you want to view the data. * **Cumulative Inbound Events over Time**: This chart shows a trend line of the ingested events and API calls over time. You can choose the duration for which you want to view the data and the grouping frequency at which you want to see it. > [!NOTE] > > When the chart is grouped at weekly frequency, the X-axis shows week of the year and the Y-axis shows the total volume of events ingested until that point. ## Panel 3: Top 5 Sources ![](https://mintcdn.com/zeotap/cTmgcQYl-5jOouxf/articles/dashboard-customer/Storage/dashboard-customer/panels-of-the-dashboard/panels-of-usage-module-2023-08-07-3.png?fit=max\&auto=format\&n=cTmgcQYl-5jOouxf\&q=85\&s=2cb6e886d547d89835b5d5aa19afd1d6) **Top 5 Sources**: This shows the top 5 data sources that brought in the highest volume of data. Note that this chart excludes archived data sources. ## Panel 4: Connect Segments ![](https://mintcdn.com/zeotap/cTmgcQYl-5jOouxf/articles/dashboard-customer/Storage/dashboard-customer/panels-of-the-dashboard/panels-of-usage-module-2023-08-07-4.png?fit=max\&auto=format\&n=cTmgcQYl-5jOouxf\&q=85\&s=1aea212eed76f0d61902d4035d4532ce) * **Successful Segments**: This chart displays the number of successful segments against the sum of successful and failed segments. This shows the success rate of segments. * **Segment Status**: This chart shows a detailed view of all the segment statuses for segments created under an account. * **Segments by Extension**: This chart shows a breakdown of segments by extension for all segments created under an account. ## Panel 5: Calculated Attributes ![](https://mintcdn.com/zeotap/cTmgcQYl-5jOouxf/articles/dashboard-customer/Storage/dashboard-customer/panels-of-the-dashboard/panels-of-usage-module-2023-08-07-5.png?fit=max\&auto=format\&n=cTmgcQYl-5jOouxf\&q=85\&s=6149e478285db786a0353a9da4c4e150) **Number of Calculated Attributes by Status**: This chart shows the total number of Calculated Attributes (including the ones that are system created). The Calculated Attributes are categorised based on their status, which can be Active, Published, Failed and Paused. ## Panel 6: Symphony Workflows ![](https://mintcdn.com/zeotap/cTmgcQYl-5jOouxf/articles/dashboard-customer/Storage/dashboard-customer/panels-of-the-dashboard/panels-of-usage-module-2023-08-07-6.png?fit=max\&auto=format\&n=cTmgcQYl-5jOouxf\&q=85\&s=a3c4178d135ea849a396eee3cb534b26) **Number of Workflows by Status**: This chart shows the total number of Symphony Workflows created in the account. These workflows are categorised based on their status, which can be Archived, Published, Draft, Paused and Failed.| > [!NOTE] > > * If there is no data available for the duration that you've chosen in the above mentioned charts, then the `No Data to Show` message is displayed. > > * If your account does not have access to a particular product, then a message to upgrade to the respective product appears on that chart. Reach out to your CSM to upgrade. # Activate Audience on Destinations Source: https://docs.zeotap.com/articles/get-started-guide/activate-audience-on-destinations Activation is the process of linking the cohort of customers to various advertising platforms, such as Facebook, Adform, Twitter and more. This allows you to implement focused marketing strategies that align with the criteria established for the target cohort. After defining the audience, you can activate it on a Destination either immediately or you can choose to activate it later. You can revisit this Audience later for further modifications. * To activate the Destination immediately, after defining the criteria for your Audience, on the last screen of the Audience creation, click **Activate Now.** ![](https://mintcdn.com/zeotap/cTmgcQYl-5jOouxf/articles/get-started-guide/Storage/get-started-guide/activate-the-audience/activate-the-audience-2024-02-03.png?fit=max\&auto=format\&n=cTmgcQYl-5jOouxf\&q=85\&s=851faf7e2cc47b2fc0be4caba9fd231b) * This takes you to a new screen, where you can either choose to enable [A/B testing](/articles/segment-customer/ab-testing) on the Audience or activate the created audience by linking it to a specific Destination as shown in the image below. * **Set A/B Test** – This functionality is exclusively available for users who have opted for it. Selecting this option takes you to a screen where you can split the audience into two or more variations. For more information about AB testing and its application, refer [here](/articles/segment-customer/ab-testing). * **Link to Destination** – This functionality helps you to activate the created Audience by linking to a Destination. For step-by-step instructions on how to activate an Audience, refer [here](/articles/segment-customer/link-the-destination). ![](https://mintcdn.com/zeotap/cTmgcQYl-5jOouxf/articles/get-started-guide/Storage/get-started-guide/activate-the-audience/activate-the-audience-2024-02-03-1.png?fit=max\&auto=format\&n=cTmgcQYl-5jOouxf\&q=85\&s=4ff6258bcdc40ab9d026f3f8bfd528cc) # Best Practices for Using Zeotap CDP Source: https://docs.zeotap.com/articles/get-started-guide/best-practices-for-using-zeotap-cdp This section offers helps you with the best practices and recommendations to accurately set up the Zeotap CDP account across different implementation stages. This section covers the following topics: > [card] [Validating Data before Onboarding](/articles/get-started-guide/validating-data-before-onboarding) > [card] [Setting Up Organisation and User](/articles/get-started-guide/setting-up-organisation-and-user) > [card] [Setting Up Sources](/articles/get-started-guide/setting-up-sources) > [card] [Setting Up Destinations](/articles/get-started-guide/setting-up-destinations) > [card] [Setting Up Predictive Audience](/articles/get-started-guide/setting-up-predictive-audience) > [card] [Setting Up Journeys](/articles/get-started-guide/setting-up-journeys) > [card] [Setting Up Consent Orchestration](/articles/get-started-guide/setting-up-consent-orchestration) > [card] [Setting Up Profile API](/articles/get-started-guide/setting-up-profile-api) # Create Calculated Attributes Source: https://docs.zeotap.com/articles/get-started-guide/create-calculated-attributes This step allows you to derive user-level insights by aggregating your users' isolated actions. You can then use this data to create more powerful customer cohorts. As a marketer, you can use calculated attributes to create new attributes for a user by aggregating their event data over a specific time period. For example, `90_day_revenue` of a user, `1_week_page_views` to check the engagement of a user, `units_purchased` by a user for a specific category like T-shirts. These calculated attributes are used as segmenting criteria and can then be forwarded to different integrations. For example, in a workflow, you can define High Spenders as users with `90_day_revenue` > €500 or Low Engagement Users by putting `1_week_page_views` \< 5 criteria. For more information about Calculated Attributes, refer [here](/articles/unify-customer/calculated-attributes). ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/get-started-guide/Storage/get-started-guide/previewing-data/CA.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=021fce9b25d399276c96b50ee3c04257) # Create a Source Source: https://docs.zeotap.com/articles/get-started-guide/create-source To get started with Zeotap CDP, begin by creating a new source to bring Data to Zeotap CDP. You must also select a source category that align with your specific needs and create the source accordingly. The following are the various source categories supported in Zeotap CDP: * **[Website Events](/articles/integrate-customer/website-events)**: To send data from your websites to Zeotap CDP, The following are the two commonly used methods/files to implement website event tracking: * **Web JS**, This is a client-side library that can be implemented on websites to track events, page visit information, user logins, user details and any other information relating to the product or services offered on the website. For more information about WebJS source, refer [here](/articles/integrate-customer/web-javascript). * **Pixel files**, also known as tracking pixels or web beacons, are small, invisible elements embedded within web pages to collect information about user behaviour and interactions. For more information about Pixel files, refer [here](/articles/integrate-customer/web-pixel-web-iframe-app-pixel). * **[App Events](/articles/integrate-customer/app-events)**: To collect customer data in mobile applications, we integrate our native Android and iOS SDKs (Software Development Kits). These SDKs track user interactions and capture events within the app. The following are the two native SDKs available in the system: * **Android SDK**, This is designed to support all Android devices and tablets, including Amazon Fire TV. The SDK simplifies the process of sending data to any tool without having to implement a new API every time. For more information about Android SDK, refer [here](/articles/integrate-customer/android-sdk). * **iOS SDK**, This supports all iOS devices and tablets. The SDK simplifies the process of sending the data from your iOS app to Zeotap. For more information about iOS SDK, refer [here](/articles/integrate-customer/ios-sdk). * **[Flat Files](/articles/integrate-customer/flat-files)**: To store data collected from external sources, often in formats like CSV or JSON, which can be directly uploaded from the Sources user interface or through other methods like the GCloud Console, GS Utils, or through third-party tools like Cyberduck. The following are the two ways for transferring batch data using Flat Files: * **Zeotap Google Cloud Storage**, Zeotap supports importing of data collected from other sources or stored outside Collect onto the platform. This data can be in the form of CSV or JSON files. For more information about Zeotap Google Cloud Storage, refer [here](/articles/integrate-customer/zeotap-google-cloud-storage). * **SFTP (Secure File Transfer Protocol)**, Sources supports importing of data collected from other sources or stored outside Sources onto the platform. As an organisation, you can use the SFTP source to onboard your data to Zeotap’s SFTP server using one of the different modes of connection that we recommend. For more information about Zeotap SFTP Sources, refer [here](/articles/integrate-customer/sftp-secure-file-transfer-protocol). * **[Server to Server](/articles/integrate-customer/server-to-server)**: Sources can be registered for server-to-server data transfer under the HTTP API source. The Source details contain the API endpoint and the write_key to be used for sending the data. * **[Tag Managers](/articles/integrate-customer/tag-managers)**: Provides a user-friendly interface that allows marketers and website administrators to add, update, and manage tracking codes without the need for direct involvement from developers or frequent code changes on the website.The following are the two popular tag managers that Zeotap offers: * **Adobe Experience Platform Tag Extension**, Zeotap provides the Zeotap Collect Tag Extension within the Adobe Experience Platform marketplace to capture events and user identities and enable cookie syncing on the Web. For more information about Adobe Experience Platform Tag Extension, refer [here](/articles/integrate-customer/adobe-experience-platform-tag-extension). * **Google Tag Manager**, The Zeotap Collect Tag is available as a custom template on Google Tag Manager for easy integration. This is a JavaScript tag that captures events and user information as the customers navigate your websites. For more information about Google Tag Manager, refer [here](/articles/integrate-customer/google-tag-manager). * **[CRM Data](/articles/integrate-customer/crm-data)**: refers to the comprehensive set of information about customers and their interactions with a business that is stored and managed within the CRM platform. The following are the CRM Data Source integrations that Zeotap offers: * **Salesforce CRM**,The Sources module supports importing data from the Salesforce CRM. Salesforce CRM stores data as standard objects that are like tables. For more information about Salesforce CRM, refer [here](/articles/integrate-customer/salesforce-crm). * **[Data Warehouse](/articles/integrate-customer/data-warehouse)**: A Data Warehouse is a centralised and integrated repository that stores large volumes of structured and unstructured data from various sources.The following are the Data Warehouses integration that Zeotap offers: * **Snowflake**, Zeotap brings simplicity to your data onboarding process by letting you connect directly to your source data residing in Snowflake through Sources. For more information about Snowflake, refer [here](/articles/integrate-customer/snowflake). * **BigQuery**, Zeotap simplifies your data onboarding process by letting you connect directly to your source data residing in BigQuery through Sources. For more information about BigQuery, refer [here](/articles/integrate-customer/bigquery). * **Amazon S3**, Zeotap brings simplicity to your data onboarding process by letting you connect directly to your source data residing in Amazon (AWS) S3 through the Sources module of Zeotap CDP. Note that you can configure auto-sync of data between your S3 account and the source created in Zeotap CDP by using the **Sync Frequency** feature. For more information about BigQuery, refer [here](/articles/integrate-customer/amazon-s3). * **[Customer Engagement Channels](/articles/integrate-customer/customer-engagement-channels)**: These are powerful tools that enable businesses to interact with customers across multiple touchpoints, deliver personalised experiences, and collect valuable data on customer preferences, behaviours, and responses. The following are the Customer Engagement Channels Source Integrations that Zeotap offers: > [card] [Braze Currents](/articles/get-started-guide/create-source#braze-currents) > [card] [Batch](/articles/get-started-guide/create-source#batch) > [card] [Dotdigital](/articles/get-started-guide/create-source#dotdigital) > [card] [HubSpot Source](/articles/get-started-guide/create-source#hubspot-source) > [card] [Airship Batch](/articles/get-started-guide/create-source#airship-batch) > [card] [Airship Real-Time Data Streaming](/articles/get-started-guide/create-source#airship-real-time-data-streaming) > [card] [Cleverpush (Batch) Source](/articles/get-started-guide/create-source#cleverpush-batch-source) > [card] [Cleverpush (Real-Time) Source](/articles/get-started-guide/create-source#cleverpush-real-time-source) **[Message Queue](/articles/integrate-customer/message-queue)**: A message queue is like a buffer that receives messages in a specific order and forwards them to the concerned sub-system or application in the same order. Message queues decouple the sender and recipient, allowing them to operate independently and at their own pace. Consumers retrieve messages from the queue when they are ready to process them. They can retrieve and process messages independently and at their own pace, allowing for asynchronous processing .The following are the message Queue integration that Zeotap offers: * **Pub/Sub Stream**, Pub/Sub (Publish/Subscribe) Stream is a messaging pattern that allows different applications and services to communicate with each other in real-time. In a Pub/Sub system, messages are published to a central exchange (or “topic”) and subscribed to by various recipients. The recipients receive notifications or data as soon as new messages are published, which makes it an efficient and scalable way to exchange information in real-time . For more information about Pub/Sub Stream, refer [here](/articles/integrate-customer/pub-sub-stream). * **Pub/Sub Batch**, Pub/Sub (Publish/Subscribe) Batch upload is a way to efficiently and reliably send multiple messages to Pub/Sub topics in a single request. This feature allows you to save network requests and improve the performance and scalability of your applications. In Pub/Sub Batch upload, you create a batch file containing all the messages you want to send. The batch file can be read as often as necessary, but once it is exhausted, only new messages are sent. Pub/Sub Batch upload is useful for processing large numbers of messages at once in real-time applications, as well as in back-end processes that process data over time . For more information about Pub/Sub Batch, refer [here](/articles/integrate-customer/pub-sub-batch). # Create Audience Source: https://docs.zeotap.com/articles/get-started-guide/create-your-audience The following are the steps involved in creation of Audiences in Zeotap CDP. The following are the steps involved in creation of Audiences in Zeotap CDP: * **Create Audience:** Upon successfully [creating a source and ingesting your data](/articles/integrate-customer/creating-a-source) into the Zeotap system, the next step involves [unifying this data](/articles/unify-customer/unify) by [mapping it to the corresponding fields on the Catalogue](/articles/unify-customer/map-the-catalogue). Subsequently, you can proceed to create a cohort of customers, commonly referred to as [Audience](/articles/segment-customer/audience) as per your use case. ![](https://mintcdn.com/zeotap/cTmgcQYl-5jOouxf/articles/get-started-guide/Storage/get-started-guide/create-and-activate-audience/create-and-activate-audience-2024-02-03.png?fit=max\&auto=format\&n=cTmgcQYl-5jOouxf\&q=85\&s=b6ce5927f40ed6cb5188f3a90b123fd1) * **Define Criteria for Your Audience:** Further, define the criteria for the created Audience to qualify customers (unified profiles). You can leverage the available attribute types to define your Audience and create the optimal marketing strategy for them. The attribute types include attributes such as [Events](/articles/segment-customer/apply-attributes-to-your-audience#events), [Profile attributes](/articles/segment-customer/apply-attributes-to-your-audience#profile-attributes), [Calculated attributes](/articles/segment-customer/apply-attributes-to-your-audience#calculated-attributes), [Consent](/articles/segment-customer/apply-attributes-to-your-audience#consent), [Marketing preferences](/articles/segment-customer/apply-attributes-to-your-audience#marketing-preferences) and more. To know more about attributes and how to apply them to your Audience, refer [here](/articles/segment-customer/apply-attributes-to-your-audience).. ![](https://mintcdn.com/zeotap/cTmgcQYl-5jOouxf/articles/get-started-guide/Storage/get-started-guide/create-and-activate-audience/create-and-activate-audience-2024-02-03-1.png?fit=max\&auto=format\&n=cTmgcQYl-5jOouxf\&q=85\&s=fb3a85b5598d58c3a82afe220bef155e) # Data or Catalogue Definition Source: https://docs.zeotap.com/articles/get-started-guide/data-or-catalogue-definition In this stage, you need to define the incoming fields and map it to the respective Zeotap Catalogue field, specify the sensitivity of the data, define consent and more. In this stage, you need to define the incoming fields and map it to the respective Zeotap Catalogue field, specify the sensitivity of the data, define consent and more. > [card] [Develop a schema document with transformation requirements](/articles/get-started-guide/data-or-catalogue-definition#develop-a-schema-document-with-transformation-requirements) > [card] [Define the data model](/articles/get-started-guide/data-or-catalogue-definition#define-the-data-model) > [card] [Define the sensitivity of the data](/articles/get-started-guide/data-or-catalogue-definition#define-the-sensitivity-of-the-data) > [card] [Establish Time-To-Live strategy](/articles/get-started-guide/data-or-catalogue-definition#establish-time-to-live-ttl-strategy) > [card] [Define the granular consent fields](/articles/get-started-guide/data-or-catalogue-definition#define-the-granular-consent-fields) > [card] [Provide sample files for testing](/articles/get-started-guide/data-or-catalogue-definition#provide-sample-files) > [card] [Finalise the Enrichers to use](/articles/get-started-guide/data-or-catalogue-definition#finalise-the-enrichers-to-use) ## Develop a schema document with transformation requirements Ensure that you develop a schema document (A schema document is a structured document that outlines the format, structure, and specifications of data within a dataset. In the context of your requirement, it serves as a comprehensive guide for handling data transformation needs.) for each source, along with the following details: A schema document is a structured document that outlines the format, structure, and specifications of data within a dataset. In the context of your requirement, it serves as a comprehensive guide for handling data transformation needs. * Confirm the presence of at least one ID, Consent and Country field. * Explicitly map incoming fields to the corresponding Zeotap Catalogue field in the schema document. * Specify consent details, considering the customer's desired consent type, applicable channels and the creation of custom consent fields if the source lacks an explicit consent field. * When no specific consent field exists, consider the entire dataset as consented for all purposes. ## Define the data model Define the consolidated data model obtained during the discovery stage, covering event, profile and other custom attributes. ## Define the sensitivity of the data Specify the sensitivity of data, including Personally Identifiable Information (PII) and other sensitive data. PII and sensitive data are masked within the product and Special Personally Identifiable Information (SPII) data must be classified as PII data. ## Establish Time-to-Live (TTL) strategy Establish the Time-to-Live (TTL) (Time-to-Live (TTL) is a strategy that defines the lifespan or expiration period of data within a system. It specifies the duration for which data, particularly identifiers (IDs), remains valid and accessible. The TTL strategy is crucial for managing data freshness, security, and compliance with privacy regulations.) strategy for bothpersistent (Persistent IDs typically have a longer TTL, often set to 'Forever.' These identifiers, like customer-specific IDs, are meant to persist indefinitely.) and non-persistent (Non-persistent IDs, on the other hand, have a defined TTL after which they expire. This duration is determined by the TTL strategy and ensures that outdated or irrelevant data is not retained unnecessarily.) IDs. Time-to-Live (TTL) is a strategy that defines the lifespan or expiration period of data within a system. It specifies the duration for which data, particularly identifiers (IDs), remains valid and accessible. The TTL strategy is crucial for managing data freshness, security, and compliance with privacy regulations.Persistent IDs typically have a longer TTL, often set to "Forever." These identifiers, like customer-specific IDs, are meant to persist indefinitely.Non-persistent IDs, on the other hand, have a defined TTL after which they expire. This duration is determined by the TTL strategy and ensures that outdated or irrelevant data is not retained unnecessarily. ## Define the granular consent fields Define the Granular Consent fields for each source along with the following details: * Identify the attributes denoting consent. * Determine the customer's desired consent type. * Define the applicable channels for consent. In cases where the source lacks an explicit consent field, establish a custom consent field and generate a hardcoded or derived enricher. If no specific consent field exists, the platform considers the complete data as consented for all purposes. ## Provide sample files Provide sample files to Zeotap for testing purposes, adhering to best practices and recommendations for various source types. ## Finalise the Enrichers to use Gather a list of required enrichers, such as Date-Time and Currency Transformations. For an exhaustive list of available enricher types within the system, refer [here](/articles/unify-customer/enrichers). # Discovery Source: https://docs.zeotap.com/articles/get-started-guide/discovery In the Discovery phase, you can start by defining your use cases and understanding your customers' requirements. Prioritise use cases and map out data sources, destinations, usage timelines and more. You need to get clarity from your customers on the following aspects of using a CDP for their use case. By adhering to the instructions below, ensures a fast, hassle-free and successful integration. > [card] [Get prioritised list of use cases for using Zeotap CDP](/articles/get-started-guide/discovery#get-prioritised-list-of-use-cases-for-using-zeotap-cdp) > [card] [Get prioritised list of Sources to integrate with Zeotap CDP](/articles/get-started-guide/discovery#get-prioritised-list-of-sources-to-integrate-with-zeotap-cdp) > [card] [Get prioritised list of Destinations to target your customers](/articles/get-started-guide/discovery#get-prioritised-list-of-destinations-to-target-your-customers) > [card] [Gather use cases for Profile API](/articles/get-started-guide/discovery#gather-use-cases-for-profile-api) > [card] [Gather use cases for Calculated Attributes](/articles/get-started-guide/discovery#gather-use-cases-for-calculated-attributes) > [card] [Gather use cases for Journeys](/articles/get-started-guide/discovery#gather-use-cases-for-journeys) > [card] [Other general requirements](/articles/get-started-guide/discovery#other-general-requirements) ### Get prioritised list of use cases for using Zeotap CDP Obtain a prioritised list of use cases that your customers intend to address using Zeotap CDP. This helps you to align the integration with their specific needs and objectives. For each use case, ensure to map out the [Source](/articles/integrate-customer/sources), [Destination](/articles/integrate-customer/destinations) and establish clear timelines for when they plan to employ them. This level of detail ensures that the integration is precisely tailored to their requirements. For information about some of the real-time use cases that we have solved through Zeotap CDP, refer [here](https://zeotap.com/resources/case-studies/). ## Get prioritised list of Sources to integrate with Zeotap CDP Obtain the prioritised list of Sources, which you wish to integrate with Zeotap CDP for transferring your customer data. In addition, ensure that you have the following details readily available regarding the Source Integration: * **Data model** - Ensure that you have clearly defined the fields that you wish to send to Zeotap through source integration. * **Onboarding Format** - Specify the preferred method for onboarding, such as Flat file, API, Data warehouse, SDK, or other applicable formats. * **Managing Deltas** - Verify that customers adhere to the practice of sending only delta updates, especially when utilizing Flat Files or establishing configurations within DB tables. This ensures the efficient and incremental transfer of data, minimising redundancy. ## Get prioritised list of Destinations to target your customers Obtain the prioritised list of Destinations to concentrate your marketing efforts on targeting specific customer cohorts. In addition, ensure that you have the following details readily available regarding the Destination Integration: * **Credentials of the Platforms** - Secure the necessary credentials for the identified Platforms. To understand the difference between Platforms and Destinations, refer [here](/articles/integrate-customer/destinations). * **Use Cases to be Activated**- Be clear about the use cases to be activated on the Destinations. For example, suppression, creating look-a-likes in the platforms and more. * **Preferred Output Data Fields** - Define the preferred output identifiers for each platform. For example, for Facebook - `emails`, `MAIDs`, or both; for Braze - `First name`, `Last name`, `email`, `Braze ID` and so on. ## Gather use cases for Profile API You can use our Profile API to read, write and delete the user profiles from the Zeotap system. Ensure that you have the following details readily available for for effective use of our Profile API: * **Identify Data for Profile API** - Specify the data intended for utilisation through the Profile API, such as segment membership or other profile attributes. Note that event data is not supported through Profile API. * **Delete API Caller** - Clearly define the caller of the Delete API and the responsible system or individual for the Delete API operation. > [!NOTE] > > For more information about Profile API, use cases for Profile API, workflow of the API, endpoint, best practices and more, refer [here](/articles/api-doc-customer/profile-api). ### Gather use cases for Calculated Attributes For [Calculate Attributes](/articles/unify-customer/calculated-attributes), identify the use case and possible conditions that you want to achieve. * For example, create a lead score for routing the leads to specific sales representatives. * For example, to show a welcome back banner to people who did not login in the last 7 days, pre-create a Calculated Attribute counting `last_7_days_login`. * To target a customer when they are viewing a product they have been most engaged with, pre-create a Calculated Attribute tracking `most_viewed_product` in the last 3 days. > [!NOTE] > > Calculated Attributes are computed daily and exclusively supported for events data. ## Gather use cases for Journeys For you to be able to use [Journeys](/articles/orchestrate-customer/orchestrate) and create workflows, ensure the following: * You have a real-time streaming source created in Sources. * You have mapped the streaming source in your Catalogue. > [!NOTE] > > A [workflow](/articles/orchestrate-customer/create-a-workflow) runs on the Event Name and other attributes that are mapped in the Catalogue. Hence, ensure that the above points are taken care of. ## Other general requirements Below are the general requirements that can be considered during Discovery: * Collect your precise Country/Region requirements. * Inform that default support for the EU is available; approval is required in the contract for other regions in terms of Data Residency. # Get Started with Zeotap CDP Source: https://docs.zeotap.com/articles/get-started-guide/getting-started Welcome to Zeotap CDP, your gateway to a user-friendly Customer Data Platform that streamlines data integration, enriches customer profiles, enables precise segmentation and facilitates personalised marketing across multiple platforms. This document is designed to provide you the crucial initial steps to get started with Zeotap CDP and gives you a comprehensive overview of Zeotap's capabilities. It also helps you to seamlessly integrate and utilise your data with Zeotap CDP. Whether you are new to data-driven platforms or an experienced user, this document will walk you through the prerequisites steps that are essential before setting up your Zeotap CDP account, the overall workflow of Zeotap CDP and the best practices to be followed while using Zeotap CDP. This section covers the following topics: > [card] [Introduction](/articles/get-started-guide/introduction) > [card] [Before your Begin (Prerequisites)](/articles/get-started-guide/prerequisites) > [card] [How Zeotap CDP works](/articles/get-started-guide/how-zeotap-cdp-works) > [card] [Best Practices for using Zeotap CDP](/articles/get-started-guide/best-practices-for-using-zeotap-cdp) # How Zeotap CDP Works Source: https://docs.zeotap.com/articles/get-started-guide/how-zeotap-cdp-works After gathering all necessary customer information as outlined in the prerequisites section, you can get started with Zeotap CDP in the following order: ```mermaid theme={null} flowchart LR A[Create a Source] --> B[Implement the Source] --> C[Preview Data] C --> D[Map the Catalogue] --> E[Calculated Attributes] E --> F[Create Audience] --> G[Activate on Destinations] ``` > [card] [Create a Source](/articles/get-started-guide/create-source) > [card] [Implement the Source](/articles/get-started-guide/implement-source) > [card] [Preview Data](/articles/get-started-guide/preview-data) > [card] [Map the Catalogue](/articles/get-started-guide/map-catalogue) > [card] [Create Calculated Attributes](/articles/get-started-guide/create-calculated-attributes) > [card] [Create Audience](/articles/get-started-guide/create-your-audience) > [card] [Activate Audience on Destinations](/articles/get-started-guide/activate-audience-on-destinations) # ID Strategy Setup Source: https://docs.zeotap.com/articles/get-started-guide/id-strategy-setup Ensure that you prepare the source-specific data dictionary (listing attributes from each source) and a data model (illustrating the relationships between each source and their respective identifiers) before proceeding with the configuration of the ID strategy. We recommend you to develop an ID Catalogue document to define relationships between identifiers for the [ID strategy configuration](/articles/unify-customer/id-strategies), including all relevant identifiers within your account's catalogue. Once the ID strategy configuration is finalised, document the corresponding data scenarios and replicate them in the Zeotap CDP interface. Following that, you can set up your ID configuration. For more information about how to configure the ID strategy for your account, refer [here](/articles/unify-customer/configure-the-id-strategy). > [!NOTE] > > By default, we enable the **Identify and link using all IDs**option, which takes into account all the ID attributes across sources for resolving or creating user profiles. Note that this is an irreversible process. Any changes done after source creation are only applicable to the new data that is ingested. > > Once the data mapping is complete, the customer profiles are created and unified as per the ID strategy active in the account. ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/get-started-guide/Storage/get-started-guide/id-strategy-setup/id-strategy-setup-2024-02-03-1.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=e00f6f3a9a9b323c4bc91fe3b749e741) # Implement the Source Source: https://docs.zeotap.com/articles/get-started-guide/implement-source Once the source is created, proceed with its implementation. Refer to the step-by-step instructions provided in the Implementation guide tailored to the chosen Source Type. You can download this document from the IMPLEMENTATION DETAILS tab of the source that you created. ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/get-started-guide/Storage/get-started-guide/implement-source/implement-source-2024-02-03.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=0cf4bf93178a2469d3bc6e5b284b2f4d) * To implement a **Web JS Source**, refer [here](/articles/sdks/web-js/intro). * To implement a **Pixel Source**, refer [here](/articles/integrate-customer/implementing-pixel-source-2665775396). * To implement **Pixels on a Site, Ad or Campaign**, refer [here](/articles/integrate-customer/implementing-pixels-on-a-site-2c-ad-or-campaign-2693727342). * To implement **Android SDK Source**, refer [here](/articles/sdks/android/intro). * To implement **iOS SDK Source**, refer [here](/articles/sdks/ios/intro). * To implement a **react native** package, refer [here](/articles/sdks/react-native/intro). * To implement **Zeotap Google Cloud Storage Source**, refer [here](/articles/integrate-customer/implement-a-zeotap-google-cloud-storage-source). * To implement **SFTP(Push) Source**, refer [here](/articles/integrate-customer/implementing-sftp-push-source). * To implement **SFTP(Pull) Source**, refer [here](/articles/integrate-customer/implement-the-sftp-pull-source). * To implement **Server to Server Source**, refer [here](/articles/integrate-customer/implementing-server-to-server-source-2665709918). * To implement **Adobe Experience Platform Tag Extension Source**, refer [here](/articles/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source). * To implement **Google Tag Manager Source**, refer [here](/articles/integrate-customer/implementing-google-tag-manager-source-2665775403). * To implement **BigQuery Source**, refer [here](/articles/integrate-customer/create-a-bigquery-source). * To implement **Snowflake Source**, refer [here](/articles/integrate-customer/create-a-snowflake-source.mdx). * To implement **Amazon S3 Source**, refer [here](/articles/integrate-customer/create-and-implement-an-amazon-s3-source). * To implement **Batch Source**, refer [here](/articles/integrate-customer/create-a-batch-source). * * To implement **Braze Currents Source**, refer [here](/articles/integrate-customer/implement-a-braze-currents-source). * To implement **Dotdigital Source**, refer [here](/articles/integrate-customer/create-a-dotdigital-source). * To implement **HubSpot Source**, refer [here](/articles/integrate-customer/create-a-hubspot-source). * To implement **Airship (Batch)** Source, refer [here](/articles/integrate-customer/create-an-airship-batch-source). * To implement **Airship (Real-time)** Source, refer [here](/articles/integrate-customer/implement-an-airship-real-time-data-streaming-source). * To implement **Cleverpush (Batch)** Source, refer [here](/articles/integrate-customer/create-a-cleverpush-batch-source). * To implement **Cleverpush (Real-time)** Source, refer [here](/articles/integrate-customer/implement-a-cleverpush-real-time-source). # Introduction Source: https://docs.zeotap.com/articles/get-started-guide/introduction In a nutshell, you first create a source within Zeotap CDP to gather your customer data (like events from your site or app) processed either in batches or real-time. Channel this plethora of data into the Zeotap system in a specific format by mapping your incoming fields to Zeotap Catalogue fields. This forms unified profiles of your customers in the Zeotap system based on the configured [ID Strategy](/articles/unify-customer/id-strategies). You can then make use of another tool of Zeotap CDP called [Segment](/articles/segment-customer/segment), to create cohorts of your customers, known as Audiences/segments. Finally, link these Audiences/segments to outbound platforms such as Facebook, Snapchat, Airship, Batch and so on, to achieve your use case using another Zeotap tool named [Destinations](/articles/integrate-customer/destinations). ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/get-started-guide/Storage/get-started-guide/introduction/introduction-2024-03-25.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=a35910c3be1fec9491da362aa57c44ec) ## Use cases The following are some of the use cases that can be solved using Zeotap CDP: * **Unified Customer Profiles:** CDP aggregates customer data from various sources to create unified profiles, ensuring a comprehensive understanding of individual customer behaviours and preferences. * **Personalised Marketing:** CDP enables businesses to deliver personalised marketing messages by analysing customer data, enhancing the effectiveness of campaigns and increasing customer engagement. * **Real-time Data Access:** CDP provides real-time access to customer data, empowering businesses to respond promptly to customer interactions and deliver timely and relevant communication. * **Cross-Channel Coordination:** CDP ensures consistent messaging across different channels, maintaining a cohesive brand image and improving the overall customer experience. * **Optimised Campaigns:** CDP-driven insights refine marketing campaigns, improving targeting accuracy and maximizing Return on Investment (ROI) by tailoring strategies based on customer behaviour. * **Customer Retention Strategies:** CDP identifies potential churn indicators, allowing businesses to implement proactive customer retention strategies and personalised engagement to retain valuable customers. * **Compliance with Data Protection Regulations:** CDP centralises customer data management, facilitating compliance with data protection regulations by ensuring secure and organised handling of customer information. * **Effective Suppression of Existing Customers:** CDP suppresses existing customers from marketing campaigns to prevent repeated targeting, reducing marketing fatigue, and avoiding unnecessary outreach to those already engaged. * **Optimising Loyalty Programs:** CDP supports loyalty programs by tailoring promotions based on individual customer profiles, increasing customer engagement, and fostering loyalty through targeted incentives. * **Preventing Customer Fatigue:** CDP analyses customer interaction patterns to detect signs of fatigue, enabling businesses to adjust marketing strategies and content to maintain customer interest and satisfaction. # Map the Catalogue Source: https://docs.zeotap.com/articles/get-started-guide/map-catalogue This is the stage in which you can standardise the incoming data to a single organisational-level catalogue by mapping and applying the required [data transformations](/articles/unify-customer/enrichers). Ensure that your ingested data such as identifiers, traits, consent, events and more are appropriately mapped against the fields available in the Zeotap Catalogue. This ensures the structuring the data flow efficiently. Map the ingested fields to the Catalogue fields by clicking **Map to Catalogue** under either the **CATALOGUE MAPPING** or **PREVIEW DATA** tab. ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/get-started-guide/Storage/get-started-guide/map-catalogue/map-catalogue-2024-02-03-2.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=80917aebe30e6996b38ff212f90e3126) The following are the important steps that you need to know while performing the Catalogue Mapping: 1. **Mapping Customer and Non-Customer Entity Data**: You can map both [Customer Data](/articles/unify-customer/customer-data) and [Non-Customer Entity Data](/articles/unify-customer/non-customer-entity-data) in the Catalogue. For more information about the how to map the Catalogue for Customer data and Non-Customer Entity Data, refer [here](/articles/unify-customer/map-the-catalogue). 2. **Knowing Zeotap Standard Fields** – Zeotap provides a set of standard fields in your catalogue. If you do not find these standard fields in your organisation’s catalogue, you can create custom fields. The process of creating the custom fields happens in an interactive interface wherein you can define your data points, bring them into Zeotap and manage them independently. Using this interface, you can easily edit the existing catalogue field or create a new field. For more information about the standard fields, refer to the relevant below links. > [card] [Zeotap Standard Fields](/articles/get-started-guide/map-catalogue#zeotap-standard-fields) > [card] [Reserved Catalogue Fields](/articles/get-started-guide/map-catalogue#reserved-catalogue-fields) 3. **Add a Catalogue field**– While adding a new Catalogue field, search for the desired field you wish to add. If the field is already present in the system, you are prompted to use the existing field and can access the details page. However, if the field does not exist in the system, you have to create a new field as explained in the [Add a Catalogue field](/articles/unify-customer/add-a-catalogue-field) topic. 4. **Configure Enrichers**– After adding the fields, you have to configure the required Enrichers. Enrichers are quick functions available for you to perform data transformations. Zeotap enrichers can be broadly classified as [Data Transformation Enrichers](/articles/unify-customer/enrichers-for-data-transformation-2816770049) and [Custom Enrichers](/articles/unify-customer/enrichers-for-custom-transformations). 5. **Map the Consent Purposes** - Once you have mapped all the Identifiers, on the same screen, click **+ ADD MAPPING**. If a source has consent data, then select the incoming consent field and map it to the relevant Zeotap consent field. For more information about mapping the consent purposes, refer [here](/articles/unify-customer/adding-a-consent-category). 6. **Map the Marketing Preferences** - Capture marketing preferences along with consent to add clarity and assurance to the marketing team while designing the campaign for the right audience. For more information about mapping the Marketing Preferences, refer [here](/articles/unify-customer/adding-a-marketing-preference-category). 7. **Review Mapping** – In the **REVIEW MAPPING**screen that appears, you can find warnings along with error logs that provide a description of the issue for incorrectly mapped fields. Once you have corrected these fields, the system automatically refreshes, allowing the warning to disappear. For more information about reviewing the mapping, refer [here](/articles/unify-customer/map-the-catalogue-for-customer-data). 8. **Save Mapping**– When you have reviewed all the fields, click **CONFIRM** AND **SAVE**. > [!NOTE] > > Once the mapping is successfully done, then the source transitions to *Mapped* state. # Before your Begin Source: https://docs.zeotap.com/articles/get-started-guide/prerequisites Before you start using Zeotap CDP, ensure that you address the following prerequisites and obtain the necessary information outlined in each requirement: 1. **[Discovery](/articles/get-started-guide/discovery)**: Begin by defining your use cases and understanding your customers' requirements. Prioritise use cases and map out data sources, destinations, usage timelines and more. 2. **[Data or Catalogue Definition](/articles/get-started-guide/data-or-catalogue-definition)**: Subsequently, gain an understanding of your customers' data models, fields, data onboarding formats, delta management and more. 3. **[ID Strategy](/articles/get-started-guide/id-strategy-setup)**: During this phase, it is crucial to formulate your strategy for identification management. Determine how you can effectively handle data identification and integration to achieve optimal outcomes with Zeotap CDP. > [!NOTE] > > Before starting with discovery, ensure that you get the following information as per the pre-sales cycle: > > * Handover checklist > * Usage expectation > > This information is crucial as it sets the base for the overall onboarding process. # Preview Data Source: https://docs.zeotap.com/articles/get-started-guide/preview-data After successfully implementing the source, you can examine the data that has been received into the system under the PREVIEW DATA tab. Note that once the data starts flowing into the system, the status of the source changes to *Integrated*. > [!NOTE] > > If no data is ingested, then a message stating “*We haven’t received any data yet. please check again later and ensure that thesource is implemented correctly. In case of any issues, contact [support@zeotap.com](mailto:support@zeotap.com)” message appears on the screen.* ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/get-started-guide/Storage/get-started-guide/how-zeotap-cdp-works/how-zeotap-cdp-works-2024-02-03-1.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=77c9de4971ac6a46b73c172f987f7eea) # Setting Up Consent Orchestration Source: https://docs.zeotap.com/articles/get-started-guide/setting-up-consent-orchestration All the consent and marketing preference attribute should be mapped to relevant consent and marketing preference attributes in the Zeotap catalogue to ensure visibility in Consent Orchestration rules. For more information on Consent Orchestration, refer[here](/articles/protect-customer/consent-orchestration-2830401643). # Setting Up Journeys Source: https://docs.zeotap.com/articles/get-started-guide/setting-up-journeys The following are the best practices and recommendations for setting up workflows within Journeys: * Ensure accurate mapping of all required data fields under the correct source for creating workflows. Only the mapped fields will be accessible for filtering during workflow creation. * At least one streaming source must be mapped, and it is mandatory for the event_name to be present on the source mapping. * Make sure to pre-create the Calculated Attributes needed for the workflows. * While setting up a Destination, verify that you've entered the correct connection details for the designated channel and are sending all the mandatory fields required for that channel. * Verify accurate data mapping between Zeotap CDP and the Channel. # Setting Up Organisation and User Source: https://docs.zeotap.com/articles/get-started-guide/setting-up-organisation-and-user The following are the best practices for setting up Organisations and Users within Zeotap CDP: * Data Residency: All data will reside in the European Union (EU) region unless the customer specifically asks for a different region, which needs to be notified before hand. * If all the data must be unified, then ensure to onboard them onto the same organisation. * In case of child organisations, data will not be unified across them. This is ideal when: * Data is kept separate across countries or brands. * Consent is specific to a particular brand or source. * User Access Management: Make sure to complete the tree mapping of admin and other roles in the client side. # Setting Up Predictive Audience Source: https://docs.zeotap.com/articles/get-started-guide/setting-up-predictive-audience The following are the best practices and recommendations for setting up Predictive Audience: * Ensure that data for the relevant events is added and accurately mapped. * To run the RFM and CLV models, ensure that the you have mapped Event Name and Event > Timestamp and Event > eCommerce > Price, Order Value or Cart Value in Zeotap Catalogue Field. * The customer should have access to over 10K events for the specific event on which they intend to initiate model creation. For more information about Predictive Audiences, refer [here](/articles/segment-customer/predictive-audiences). # Setting Up Profile API Source: https://docs.zeotap.com/articles/get-started-guide/setting-up-profile-api Below are the best-practices that you need to adhere while setting up Profile API. * As per the Profile API use cases defined in the Discovery Phase, each use case or system must have a separate API key to ensure traceability. * You should invoke the Profile API once per session, only. As the response is unlikely to change, even if the API is called multiple times, you can cache the response locally for subsequent use within the session. However, note that calling the API multiple times is still counted against your usage metrics. * To avoid unnecessary count against your usage metrics, you can add a check to prevent calling the Profile API when there is no ID to look up. * You can use a separate API token for each interface. This ensures that each interface is uniquely identified and managed separately. Using separate API tokens also enhances the security of your system by limiting access to individual interfaces when one token is compromised. * For user lookups, you can use one of the immutable IDs or primary IDs that you have selected for ID resolution. This ensures that the user is identified uniquely and the lookup is consistent across the different systems. * To ensure security, we do not recommend you implement Profile API on a web interface. Instead, you can implement the API remotely using a service layer. This approach minimises the risk of unauthorised access and other security vulnerabilities that may arise when implementing the API on a web interface. * To call a specific attribute of a user, you can use the Fetch node. This allows you to retrieve only the required attribute instead of calling all user attributes on the client side. # Setting Up Sources Source: https://docs.zeotap.com/articles/get-started-guide/setting-up-sources The following are the best practices and recommendations that must be considered when using Sources: * For information on best practices to be followed while setting up different sources, refer [here](/articles/integrate-customer/best-practices-for-flat-file-source-2709422090). * Verify the sample data provided by the customer for nested or complex structures. Presently, this data type is not supported. If ingestion is necessary, the customer must flatten the data on their end. * For Server to Server aka HTTP API sources, the data formats may need to be transformed. * Consider the Events vs Profiles vs other attribute types carefully when defining custom fields based on the customer's use-case and specified data type. For information on Catalogue fields, refer [here](/articles/unify-customer/add-a-catalogue-field). * For Deltas, you must only share the updated data to ensure optimal use of processing allowance. # Validating Data before Onboarding Source: https://docs.zeotap.com/articles/get-started-guide/validating-data-before-onboarding The following are the best practices for validating data before onboarding: * All sources need to share the sample files to validate the data coming in with the data discovery sheet. * All data should be first uploaded into the sandbox environment and tested, before onboarding onto the Production environment. All clients are given one Sandbox environment. # What's Next Source: https://docs.zeotap.com/articles/get-started-guide/what-next You are just getting started with Zeotap CDP, but there’s so much more to explore! ## Related Topics The following are some of the important topics that can help you understand the different tools/technical concepts of Zeotap CDP in detail: > [card] Integrate - Sources > > > [card] Integrate - Destinations > > > [card] Unify - Catalogue > > > [card] Unify - Calculated Attributes > > > [card] Unify - ID Resolution > > > [card] Segment - Audiences > > > [card] Segment - Predictive Audiences > > > [card] Orchestrate - Journeys > > # Advanced Integration Guide_V2 Source: https://docs.zeotap.com/articles/id-publication/advanced-integration-guide_v2 ## Introduction ### Zeotap Zeotap is a Customer Intelligence Platform (CIP) that helps companies better understand their customers and predict behaviours, to invest in more meaningful experiences. We enable brands to build on a nucleus of first-party data to win new customers and grow their loyal base. Our independent but integrated modules include customer data unification, identity resolution, enrichment, analytics/modeling (including in data clean rooms), and activation to 100+ partners in the marketing ecosystem. Recognized by Gartner as a "Cool Vendor" (2020) and by AdExchanger as the “Best Data-Enabling Technology” (2019), our platform meets the highest enterprise data privacy and security stan dards, including GDPR, ISO 27001 and CSA STAR. We serve the world's top brands, agencies and publishers across a dozen countries in Europe, North and Latin America, and APAC. ### ID+ Initiative Zeotap is also the founding member of ID+, a global universal ID solution. The ID+ solution is identifier-agnostic and empowers the marketing ecosystem ––brands, publishers, and vendors alike–– with a privacy-compliant mechanism to overcome identity resolution challenges arising from 3rd party cookie/identifier restrictions and increasingly stringent regulations across the world. ## Publisher Onboarding The Publisher Onboarding process comprises of the following steps: **Step 1** On signing up for ID+ advanced, the Zeotap Product Operations Manager (POM) onboards the publisher to the Zeotap Unity Platform, and provides access to the ID+ and Data Partner Product. This generates the partner ID to use ID+ services and Org ID to be a data partner. **Step 2** The Zeotap POM then shares the ID+ Partner ID and Orgid for the implementation process. Replace the \ and Orgid with respective received values. ## How does it work? In the ID+ Advanced model the ID+ partner shares the hashed identifiers as well as the attributes for socio-demographic or interest signals. The JavaScript (JS) tag must have the below format and must be placed within the \ and \ of the website. ```js theme={null} ``` Any attributes related to the user/page/event or identifier can be attached to this source URL as query parameters and values. For example, see the sample script below. ```js theme={null} ``` The following are some important points about the JS and the Zeotap smart pixel end point: * The script also makes a GET call to the Zeotap smart pixel endpoint with all the query parameters and values attached. * The Zeotap smart pixel endpoint identifies the user with the Zeotap third-party cookies and responds with the relevant cookie syncs * The script fires cookie syncs that are returned by the service as image pixels on the device based on the predefined configurations, with a daily frequency cap (that is, one cookie sync per channel per day). * The Zeotap smart pixel endpoint can perform the following actions: * Accept and record data explicitly attached to the call as query parameters and values * Accept and record data in the HTTP headers (IP-based country, telecom, user-agent-based browser type, device-info, pageURL based domain and path) ## How to pass the identifiers? The following steps explain the process of passing the identifiers: **Step 1** When a user logs in, set this action as a trigger for the data collection script in order to perform the ID+ actions. **Step 2** The following are the reserved keywords from Zeotap, that must be used to pass the email addresses and mobile phone numbers: * `zem` for raw email addresses * `zc_wo` for raw mobile phone number without the country code * `zc_w` for raw mobile phone number with the country code **Step 3** In case of raw email addresses, Zeotap’s library converts the email addresses to lowercase and hashes them to `sha256` before making the GET calls for data collection. **Step 4** In case of raw mobile phone numbers, Zeotap’s library hashes them to `sha256` before making the GET calls for data collection. **Step 5** The following reserved keywords must be used to pass the email addresses and mobile phone numbers that are already hashed: * `z_e_sha2_l` for `sha256` hash of email addresses in lowercase * `z_c_sha2_wo` for `sha256` hash of mobile phone number without country code * `z_c_sha2_w for sha256 hash of mobile phone number with country code` ## How does user consent work? The following are the different methods of consent passing that we support: Optin parameter In this method, the consent signal of the user is passed in the JS tag using the optin parameter with yes/no, true/false or 1/0 as the value. `optin=yes` is used for the following purposes: * Activate the ID+ module * Drop or read a Zeotap cookie * Store other data points ### TCF The following points explains this method: * If the `optin` parameter is not found, then the JS checks the page for the presence of `cmp.js`. * If the `cmp.js` is found, then it calls the CMP API to fetch the TCF consents. * The JS checks if consent is provided for vendorid: 301 for the registered purposes to activate the ID+ module, drop/read zeotap cookie, and store other data points. ### Actions when consent=no The following points explains the actions when consent is no as communicated by either methods above: * No ID+ calls are made * Existing ID+ cookie are deleted * If a user opts out from all the purposes relating to processing of data, the same is communicated to the smart pixel endpoint as revoking of consent. The corresponding user IDs are added to our opt-out pipeline in order to remove the older data collected. ## How to enable id+ cookie stamping? When the email and/or mobile phone numbers are passed during the user login, the following steps must be performed to use the same for ID+ cookie stamping: **Step 1** In the JS tag, set the flags for ID+ as `&idp=1` and the consent signals, and attach the ID+ partner ID as `&idp_partnerid={IDP_PartnerID}` and Page domain as `&partner_dom={domain of the page}`. This Partner ID will be shared by Zeotap Product Operations Manager. For more information on consent signals, see [Consent Setting](#how-does-user-consent-work). ```js theme={null} ``` **Step 2** When the ID+ flag is set to 1 and the ID+ partner ID added, the ID+ actions are enabled. **Step 3** The script checks for the below information in order to perform the ID+ services: * If the user consent is present * If the ID+ partner ID is present * If email address and/or mobile phone number exists in raw or hashed form **Step 4** When the above-mentioned conditions are satisfied, the JS makes a call to the ID+ stamping service API by passing on the hashed IDs, ID+ partner ID and user consent. **Step 5** The ID+ stamping service resolves the identity of the user and returns the corresponding ID+ value and expiry. **Step 6** The JS then takes the ID+ value returned and stamps this as a first-party cookie named IDP, with expiry as stated. Note that this cookie is a first-party cookie against the Top Level Domain, Secure and Strict. The ID+ value returned has a certain expiry that is stored as a cookie called idp_expiry. **Step 7** On subsequent initialisations of the script, the IDP cookie is reset based on the stored expiry. > [!NOTE] > > **Note**: > > * The email address or the mobile phone numbers are not stored in any format on the device. Therefore, ensure that a new call is made when a new session is started if the login state is true. > * If Zeotap is unable to resolve the identity of the user, no IDP cookie is created. #### A. ID+ value is not found When the ID+ value is not found for the user by the ID+ service for a corresponding email address or mobile phone number, the following events take place: 1. The ID+ API responds with 200 and no response body. 2. The JS then deletes any existing IDP cookie value that is present. #### B. No IDs are passed Until IDs are passed in the query parameters, no call is made to the ID+ API, even if the idp flag is set to 1. If there is an existing IDP cookie, then the same continues to exist until the cookie expires. #### C. Passing the email and mobile phone IDs The email and/or phone number must be passed in the query parameters along with \&idp=1 in the following scenarios: * When a user logs in. * At the start of a new session if the user is in the logged-in state. * If a user is in the logged-in state but no IDP cookie is found. ## Integrating with Prebid  Prebid is an open-source Header Bidder (HB) solution. Zeotap is integrated with Prebid to pick the stamped IDP cookie and send it to the SSP’s. After successfully implementing the JS on your website, the IDP cookie is stamped on the page. Next, it must be passed in the bid request. To let it flow to the downstream systems through Prebid, you have to include Zeotap ID+ in your Prebid Package. > [!NOTE] > > **Note** > > Ensure that your bidder adapter can listen to Zeotap ID+. To know more about integrating your Prebid package, refer to the user ID module of the Prebid document [here](https://docs.prebid.org/dev-docs/bidder-adaptor.html). ## Cookie syncing We have also embedded the soon to be legacy functionality of third-party cookie syncing in the JS which can be used until the third-party cookies exist. This means that you are future-ready and you do not have to make any code changes when you transition from a third-party cookie to ID+ in future. The Zeotap JS drops a cookie against the Zeotap domain (third-party cookie ) called zc. Any channels with whom we cookie sync, share their third-party cookies for the users. These third-party cookies are used for populating audience segments on the channels in terms of third-party cookies (as long as they exist). From Zeotapʼs list of integrated partners, you can select the partners with whom you want to cookie sync. Note that these cookies are preconfigured against your Write Key and are fired as image pixels on the site asynchronously, mapped to the ID+ cookie and any user identifiers sent by you. Contact your Zeotap POM (Product Operations Manager) to get the updated list of integrated platforms for the markets you are interested in. # Basic Integration Guide_V2 Source: https://docs.zeotap.com/articles/id-publication/basic-integration-guide_v2 ## Zeotap CDP Zeotap is a Customer Intelligence Platform (CIP) that helps companies better understand their customers and predict behaviors, to invest in more meaningful experiences. We enable brands to build on a nucleus of first-party data to win new customers and grow their loyal base. Our independent but integrated modules include customer data unification, identity resolution, enrichment, analytics/modelling (including in data clean rooms), and activation to 100+ partners in the marketing ecosystem. Recognized by Gartner as a "Cool Vendor" (2020) and by AdExchanger as the “Best Data-Enabling Technology” (2019), our platform meets the highest enterprise data privacy and security standards, including GDPR, ISO 27001and CSA STAR. We serve the world's top brands, agencies and publishers across a dozen countries in Europe, North and Latin America, and APAC. ## ID+ Initiative Zeotap is also the founding member of ID+, a global universal ID solution. The ID+ solution is identifier-agnostic and empowers the marketing ecosystem ––brands, publishers, and vendors alike–– with a privacy-compliant mechanism to overcome identity resolution challenges arising from third-party cookie/identifier restrictions and increasingly stringent regulations across the world. ## Publisher Onboarding The Publisher Onboarding process comprises of the following steps: **Step 1** On signing up for ID+, the Zeotap Product Operations Manager (POM) onboards the publisher to the Zeotap Unity Platform, and provides access to the ID+ product. This generates the partner ID to use the ID+ services. **Step 2** The Zeotap POM then shares the ID+ Partner ID for the implementation process. Replace the \ with the actual Partner ID received. ### Snippet The following is a ID+ JavaScript (JS) snippet that must be placed within the \ and \ of the website: ```js Code theme={null} ``` ## Initialisation The snippet mentioned above includes the initialisation call. In the call, the \ must be replaced with the actual partner ID shared for the individual publisher. Absence of the same or an incorrect value results in the failure to identify the correct publisher and no/incorrect IDP cookie. `zeotap.init(options)` This method is called to initialise the ID+ script. The options related to ID+ are listed in the table below. Table 1: Options related to ID+ | **Name** | **Type** | **Default** | **Required** | **Description** | | :- | :- | :- | :- | :- | | `[partnerId]` | string | null | Yes | The partner ID associated with the organisation for ID+. This is sent in the call made to the ID+ API for fetching the ID+ value of the user. | | `[allowIDP]` | string | true | Yes | If this option is set to false, then IDP related activities do not occur. | | `[partner_dom]` | string | null | Yes | This is the Domain of the page from where the Zeotap endpoint is being called. For example, if the URL is [https://www.nytimes.com](https://www.nytimes.com), then ‘nytimes.com’ should be passed. | ## Consent The user’s consent related to the creation of the ID+ universal ID must be communicated before any ID+ actions occur. The following options can be set as per the consent collection method on the website. Table 2: Options to be set as per consent collection method. | **Name** | **Type** | **Default** | **Required** | **Description** | | :- | :- | :- | :- | :- | | `[optOut]` | boolean | false | No | Signal whether the SDK is allowed to act. If this option is set to true, then the SDK related actions are ceased. This option is used as a fallback when user consent is not specified in the other options. Not a mandatory option to be set, if `useConsent` is true. | | `[useConsent]` | boolean | false | Yes | If this option is set to true, then the SDK waits to receive a consent signal from the consent resolution mechanism (GDPR or custom) and uses that consent to manage its actions. This consent resolution mechanism is determined by the `checkForCMP` option. | | `[checkForCMP]` | boolean | true | Yes | If this option is set to true, then it checks for GDPR consent resolution using the `_cmp` or `_tcfapi` variables in the global scope and the cmp.js script. If the variables are present then the CMP API or TCF v2 API is queried to check vendor consent for `vendorid:301`. If this option is set to false, then it checks for the consent signal to be set using the `setConsent` method. | Note: When the useConsent option is set to true and the checkForCMP option is set to false, you must use the setConsent method to send the user consent. This information is stored in cookieStorage and used as the user’s consent status for subsequent ID+ activities until a new status is sent or the consent expires. The cookie is named as: `zpstorage_{base64encodedpartnerid}consentmyhost.zeotap.com` `zeotap.setConsent(value, [expiry])` This method sets the custom consent value. The options related to the custom consent value are listed in the table below. Table 3: Parameters related to custom content value | **Parameter** | **Type** | **Default** | **Description** | | :- | :- | :- | :- | | value | boolean | | When set to true, the value is used to perform the ID+ activities. When set to false, the value is treated as No consent. | | \[expiry] | number | 365 | Number of days the consent is valid for. | ### Actions for ‘no consent’ When we receive an explicit No from any of the consent methods chosen, below are the corresponding actions from the SDK. * No call is made to the ID+ API even if the user logs in later * Any existing IDP cookie is deleted ### Actions when consent is ‘missing’ If the consent signal is not received but the user has logged in, for example a setConsent call is not made because the user has not made an explicit choice or the CMP API does not respond with the consent value, then the SDK operates in the Do-Not-Track mode. The following points simplify this process: * No call is made to the IDP API until consent is received, even if the user logs in * Any existing IDP cookie remains as it is ## Integrating the JavaScript through a Google Tag Manager Tag The ID+ JavaScript (JS) snippet can also be integrated through a Google Tag Manager (GTM) Tag. The Zeotap IDP Tag is available as a custom template on GTM for easy integration. This is a JavaScript (JS) tag that is used to identify the user’s IDP cookie value based on a given email address or phone number. To know more about how the Zeotap IDP Tag and how to integrate it, refer to the [ID+ Google Tag Manager Implementation](/articles/id-publication/google-tag-manager-implementation-guide) guide. ## Passing Identifiers for ID+ For the ID+ retrieval to happen successfully, the user has to log in to the website at least once. When this happens, you can use the methods available in the library to pass the email address and/or mobile phone number that was used to log in or belongs to the logged-in user (in case the login ID is specific to the website). `zeotap.setUserIdentities(properties, [isHashed])` This is the method to send `userIdentities` and drop an Identity Provider (IDP) cookie for the given Partner ID. Table 4: Parameters to send user identities and IDP cookie | **Parameter** | **Type** | **Default** | **Description** | | :- | :- | :- | :- | | `properties` | Identities | | The email address or mobile phone number can be passed here using the reserved keywords. For more information, see the [Identities Objects](/articles/id-publication/basic-integration-guide_v2#identities-object) table below. | | `[isHashed]` | boolean | false | If this parameter is set to true, then the IDs are considered as hashed in sha256. If this parameter is set to false, then the email address is converted to lowercase and hashed in sha256. Mobile phone numbers have all the symbols removed before hashing the number to sha256. | #### Identities Object The Identities Objects can be set to pass the user’s deterministic identities. Table 5: Identity Objects | **Name** | **Type** | **Description** | | :- | :- | :- | | `[email]` | string | Email address of the user in [x@y.com](mailto:x@y.com) format. | | `[cellno_cc]` | string | Mobile phone number with the country code. | You can also use the common method for passing identity information as shown below. `zeotap.callMethod(functionName, ...functionParams)` This is the common interface to call the methods of the Zeotap object. Table 6: Parameters for the common interface | **Parameter** | **Type** | **Description** | | :- | :- | :- | | functionName | string | Name of the method to be called. | | functionParams | \* | Parameters to be passed for the function mentioned in the first parameter. | **Example**: `zeotap.callMethod('setUserIdentities',{..ids},true)` **Making a setUserIdentities call** The `setUserIdentities` call should be made in the following scenarios: * When a user logs in. * At the start of a new session if the user is in the logged-in state. * If a user is in the logged-in state but no IDP cookie is found. ## Flow for ID+ ### ID+ cookie stamping The ID+ cookie stamping process comprises of the following steps: **Step 1** The JS is initialised and the partner ID, IDP flag and the consent related options are considered before deciding on the ID+ actions. **Step 2** If you have the permission to perform the ID+ activities, Zeotap waits for setUserIdentities to identify the user deterministically. **Step 3** After checking for consent and performing hashing where required, a call is made to the ID+ API, with the user identities. The API resolves the user’s identities and responds with the ID+ value of the user and expiry **Step 4** The JS then writes this value as a cookie named IDP. Note that this cookie is a first-party cookie against the Top Level Domain, Secure and Strict. The ID+ value returned has a certain expiry that is stored as a cookie called `idp_expiry`. **Step 5** On subsequent initialisations of the script, the IDP cookie is reset based on the stored expiry. #### A. ID+ value is not found When the ID+ value is not found for the user by the ID+ service for a corresponding email address or mobile phone number, the following events take place: 1. The ID+ API responds with 200 and no response body. 2. The JS then deletes any existing IDP cookie value that is present. #### B. The user logs out When the user logs out, the following events take place: 1. If the user logs out, then the IDP cookie remains the same until the cookie expires. 2. If there’s a new login from the device, the ID+ service needs to be refreshed based on the new information. The IDP cookie may change at this time depending on the login used. #### C. No IDs are passed Until IDs are passed using the setUserIdentities call, no call is made to the ID+ API. If there is an existing IDP cookie, then the same continues to exist until the cookie expires. ## Integrating with Prebid  Prebid is an open-source Header Bidder (HB) solution. Zeotap is integrated with Prebid to pick the stamped IDP cookie and send it to the SSP’s. After successfully implementing the JS on your website, the IDP cookie is stamped on the page. Next, it must be passed in the bid request. To let it flow to the downstream systems through Prebid, you have to include Zeotap ID+ in your Prebid Package. > [!NOTE] > > **Note** > > Ensure that your bidder adapter can listen to Zeotap ID+. To know more about integrating your Prebid package, refer to the user ID module of the Prebid document [here](https://docs.prebid.org/dev-docs/bidder-adaptor.html). # Google Tag Manager Implementation Guide Source: https://docs.zeotap.com/articles/id-publication/google-tag-manager-implementation-guide ## Introduction to Google Tag Manager Google Tag Manager (GTM) is a useful tool that allows you to manage and deploy marketing tags, snippets of code or tracking pixels on your website or mobile app without having to modify the code. With the GTM integrated, you have multiple tags stored in one place and therefore it becomes handy for the Marketeer to manage all the codes on their own. There are three main parts to GTM: * **Tags** – Snippets of JavaScript or tracking pixels * **Triggers** – This tells GTM when or how to fire a tag * **Variables** – Additional information GTM may need for the tag and trigger to work ## Prerequisites Ensure that you have created your GTM account and installed the GTM container to use the Zeotap IDP Tag Template. To know more about how to set up and install the GTM, refer to [Setting up and Installing Tag Manager](https://support.google.com/tagmanager/answer/6103696?hl=en). ## Overview of Zeotap IDP Tag Template The Zeotap IDP Tag is available as a custom template on GTM for easy integration. This is a JavaScript (JS) tag that is used to identify the user’s IDP cookie value based on a given email address or phone number. This is an asynchronous process and does not affect the loading of the site or the end-user experience. The Zeotap IDP tag requires a data layer to be set up on your websites. This data layer is used for capturing all the information required for IDP Cookie identification. Note that all these details about the IDP cookie are sent to Prebid. > [!NOTE] > > GTM’s custom templates allow you to write your own tag and variable definitions so that others within your organization can use them alongside the built-in tag and variable templates. These custom templates allow you to build a user interface around the custom code you might want to run on your website using GTM. This user interface comprises text input fields, settings, tables, labels, drop-down menus and so forth. ## Adding the Zeotap IDP Tag Template You can add the Zeotap IDP Tag Template using one of the following methods: ### Method 1 **Step 1** Log into your GTM account and click Templates from the left menu. **Step 2** Under Tag Templates, click Search Gallery on the top-right corner. ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/id-publication/Storage/id-publication/google-tag-manager-implementation-guide/ID_GTM_1.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=c784789de2876a9449aba0bd7e757aa3) **Step 3** Search and choose Zeotap ID+ Tag from the list. ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/id-publication/Storage/id-publication/google-tag-manager-implementation-guide/ID_GTM_2.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=756018c571e6ff7fa254ca8e9d0037a2) **Step 4** Click Add to your workspace to add the Tag Template for further usage. ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/id-publication/Storage/id-publication/google-tag-manager-implementation-guide/ID_GTM_3.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=82f015c43f9eb147689c97b6e4b2191f) ### Method 2 **Step 1** Check with your Zeotap Product Operations Manager to get the .tpl file. **Step 2** Log into your GTM account and click Templates from the left menu. **Step 3** Under Tag Templates, click New on the top-right corner. ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/id-publication/Storage/id-publication/google-tag-manager-implementation-guide/ID_GTM_4.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=fd09980646bc8c298e43d08c178a3d28) **Step 4** In the top-right corner, click the vertical ellipses and select Import. **Step 5** Select the .tpl file shared in step 1 above. **Step 6** Name the template as Zeotap ID+ Template and save it for further usage. ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/id-publication/Storage/id-publication/google-tag-manager-implementation-guide/ID_GTM_5.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=13392970fe41f4441c3633b3a06c2994) ## Adding the Tag Once you have added the Tag Template, the next step is to add the tag. Perform the following steps to add the Tag: **Step 1** Log into your GTM account and click Tag from the left menu. **Step 2** Click New and name the tag descriptively. For example, Zeotap IDP+ Tag. ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/id-publication/Storage/id-publication/google-tag-manager-implementation-guide/ID_GTM_6.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=c156ccf870e3fde97607bf662fb15b64) **Step 3** Click Tag Configuration and search for Zeotap IDP+ Tag. The Tag is listed under the Custom tab. ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/id-publication/Storage/id-publication/google-tag-manager-implementation-guide/ID_GTM_7.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=2bedf05205654a442468fb45bc5bbb56) **Step 4** Click Zeotap ID+ Tag. To configure the tag, follow the steps mentioned [below](/articles/id-publication/google-tag-manager-implementation-guide#configuring-the-tag). ## Configuring the Tag The process of configuring a Tag is divided into the following sections: * [Initialisation Options](/articles/id-publication/google-tag-manager-implementation-guide#configuring-the-initialisation-settings) * [Login and Identities Settings](/articles/id-publication/google-tag-manager-implementation-guide#configuring-the-login-and-identities-settings) * [Advanced Settings](/articles/id-publication/google-tag-manager-implementation-guide#configuring-the-advanced-settings) ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/id-publication/Storage/id-publication/google-tag-manager-implementation-guide/ID_GTM_8.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=bd6c337a3cbff225b7155a41b5f3c92d) ### Configuring the Initialisation Settings Under the Initialisation section, enter the following details to configure the initialisation options: * **Partner ID** – Zeotap provides this ID after enabling ID+ for your organisation. Ensure that you add the ID properly. * **Consent Method** – The Zeotap IDP SDK has the following two options that can be used to determine the consent actions: * **Default Opt-in** – This option sets the optOut option to false and is used to record events. Choose this option to fire the tag only for the consented users. * **Check TCF CMP** – This option sets the useConsent and checkForCMP options to true. The JS automatically checks for the presence of the cmp.js script and the **\_\_cmp** variable in the global scope. The JS also queries the TCF API to fetch the latest Publisher consent before recording the events on each JS load. ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/id-publication/Storage/id-publication/google-tag-manager-implementation-guide/ID_GTM_9.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=5bed932ec0847f46b3e4e892759b80eb) ### Configuring the Login and Identities Settings Under the Login and identities settings section, enter the following details to configure the login and identities settings: * **Event Key** – This is the key against which the login event names are stored in the dataLayer object. You can choose not to add this key if you are using the GTM's default key. * **Login Event** – Specify the dataLayer event fired on user login. For example, setUserIdentities. * **Capture email** – Use this checkbox to specify if email address must be used for ID+ calls. If selected, the corresponding variable must be added in the next input box. * **Email variable** – Specify the variable to pick up the email address from. The same email address is hashed to sha256 and is used to retrieve the IDP cookie against the email address. * **Capture cell phone number** – Use this checkbox if cell phone number must be used for ID+ calls. If selected, the corresponding variable must be added in the next input box. * **Cellphone number variable** – Specify the variable to pick up the phone number with the country code from. The same phone number is hashed to sha256 and is used to retrieve the IDP cookie against the cellphone. * **Are your identities hashed?** – For ID+ calls, the email address in lowercase and cell phone number with country code must be hashed to sha256. If this checkbox is selected, then we assume that the email address and/or phone number variables are already in the hashed format as per guidelines. If unselected, then we treat them as raw values and perform the hashing before the ID+ calls. ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/id-publication/Storage/id-publication/google-tag-manager-implementation-guide/ID_GTM_10.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=99fabecdff073cbd6cf0befa5826ed32) ### Configuring the Advanced Settings All the options available under the Advanced Settings section, function as usual. However, take a note of the following two options: * Tag firing options – Choose the Once per event option from the Tag firing drop-down menu. At this moment, we only support this option. * Additional Tag Metadata – This section is not applicable for ID+. Therefore, you need not make any selections here. ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/id-publication/Storage/id-publication/google-tag-manager-implementation-guide/ID_GTM_11.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=199e3768abe042bd00b2bc31297778a5) ## Setting Up the Trigger The IDP tag is recommended to have triggers during the login event so that you can attach triggers only for the login event key. You can either add a preconfigured trigger to a tag or create a trigger within the tag. The section below explains the two methods in detail. ### Method 1 If you want to fire the tag on the login event, then trigger ‘Custom event' by performing the following steps: **Step 1** Click Trigger Configuration from your left menu. **Step 2** Click New to add a trigger. **Step 3** Add a descriptive name to the trigger. **Step 4** Edit the Trigger Configuration section and search for Custom Event. **Step 5** Type your ‘Login event’ as the event name. For example, setUserIdentities. **Step 6** Select the All Custom Events radio button. The trigger is set for the login event only. ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/id-publication/Storage/id-publication/google-tag-manager-implementation-guide/ID_GTM_12.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=a4e0790acca7fbf03a524f7c024a10ba) ### Method 2 You can also set a trigger to a tag while configuring it. Perform the following steps to set a trigger to a tag from the Tag Configuration section. **Step 1** Navigate to the Tag Configuration section of the tag to which you want to attach a trigger. **Step 2** Click under the Triggering section. **Step 3** In the Choose a trigger window that appears click ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/id-publication/Storage/id-publication/google-tag-manager-implementation-guide/ID_GTM_13.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=1a89cdc812be3fed38f34a18af34215c) **Step 4** Add a descriptive name to the trigger. **Step 5** Edit the Trigger Configuration section and search for Custom Event. **Step 6** Type your ‘Login event’ as the event name. For example, setUserIdentities. **Step 7** Select the All Custom Events radio button. The trigger is set for the login event only. ## Validating the Configured IDP Tag  After you have added the Zeotap IDP Tag, configured the same and set the trigger to perform the following steps to evaluate how it works: **Step 1** Click Tag from the left menu. Of all the tags that are listed, ensure that your tag is in the active state and has not been paused. **Step 2** Click the Preview button that appears on the top right corner. You are taken to the Tag Assistant page. **Step 3** In the Google Tag Assistant window that appears, enter the website where you have integrated the GTM and then click Start. Refer to the image below from a sample website. ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/id-publication/Storage/id-publication/google-tag-manager-implementation-guide/ID_GTM_14.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=e8dad707477973cd5bc4050857d699cf) **Step 4** You are redirected to the website URL that you had entered. Log into the website. ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/id-publication/Storage/id-publication/google-tag-manager-implementation-guide/ID_GTM_15.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=6f8007d1acb6cd6e9fa8c337284ca10f) **Step 5** After successfully logging into the website, right-click on the web page and click Inspect. **Step 6** Go to the Console tab of the DevTools window that opens and under dataLayer look for the login event name that you have configured. The image below shows the event name setUserIdentities. ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/id-publication/Storage/id-publication/google-tag-manager-implementation-guide/ID_GTM_16.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=4ddea9c2e5c4e21f118f8e7bc45e47c4) **Step 7** Go back to the Tag Assistant window and click Continue. ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/id-publication/Storage/id-publication/google-tag-manager-implementation-guide/ID_GTM_17.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=2f793cd21df3fb6241d17485570ab86b) **Step 8** Under Tags Fired you can find the tag that was fired. Therefore, the tags were fired based on the trigger set for the login event named setUserIdentities. The tag contains the user’s IDP cookie detail for a given email address or phone number that is used for logging into the website. ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/id-publication/Storage/id-publication/google-tag-manager-implementation-guide/ID_GTM_18.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=bfaf6a0e814497d0e57086a2726e9408) # SSP Implementation Guide Source: https://docs.zeotap.com/articles/id-publication/new-topic-ssp-implementation-guide ## ZEOTAP Zeotap is a Customer Intelligence Platform (CIP) that helps companies better understand their customers and predict behaviours, to invest in more meaningful experiences. We enable brands to build on a nucleus of first-party data to win new customers and grow their loyal base. Our independent but integrated modules include customer data unification, identity resolution, enrichment, analytics/modelling (including in data clean rooms), and activation to 100+ partners in the marketing ecosystem. Recognized by fiartner as a "Cool Vendor" (2020) and by AdExchanger as the “Best Data-Enabling Technology” (2019), our platform meets the highest enterprise data privacy and security standards, including fiDPR, ISO 27001and CSA STAR. We serve the world's top brands, agencies and publishers across a dozen countries in Europe, North and Latin America, and APAC. ## ID+ INITIATIVE Zeotap is also the founding member of ID+, a global universal ID solution. The ID+ solution is identifier-agnostic and empowers the marketing ecosystem ––brands, publishers, and vendors alike–– with a privacy-compliant mechanism to overcome identity resolution challenges arising from third-party cookie/identifier restrictions and increasingly stringent regulations across the world. ## INTEGRATING WITH PREBID When a user visits a Publisher website, the already stamped IDP cookie must be passed in the Bid Request. A Publisher usually has a Header-Bidder (HB) solution integrated. Prebid is an open-source HB solution. Zeotap has integrated with Prebid to pick every such IDP stamped cookie and send it to the SSP. Prebid helps to create a proper Bid request consisting of all the required information in terms of the Bidding Process. > [!NOTE] > > **Note**: > > Ensure that your bidder adapter can listen to Zeotap ID+. To know more about the integration of bidder adapters and user ID modules refer to the Prebid document [here](https://docs.prebid.org/dev-docs/bidder-adaptor.html). ## ID+ RESOLVER FOR SUPPLY-SIDE PLATFORM (SSP) Zeotap’s ID+ solution for Supply-Side Platform (SSP) includes the ID+ Resolver Service that sits on the SSP server. The Resolver Service allows SSP to decode the ID+ received from the Publisher into a Demand-Side Platform (DSP) specific ID+ that is passed to the respective DSPs in the Real-Time Bidding (RTB) request. The DSP specific ID+ can then be used to target the underlying users with the help of Zeotap. An SSP may be connected to multiple DSPs. The SSP needs to inform Zeotap for which all DSP IDs it needs the tokenized ID+ value. For every requested DSP, Zeotap performs a set of operations and builds a tokenized ID+. ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/id-publication/Storage/id-publication/google-tag-manager-implementation-guide/SSP_1.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=638a39b04bf95c2e5316daab13cc4fd5) ## INTEGRATING RESOLVER SERVICE ON SSP SERVER This section explains the steps involved in the integration process at a high level. **Step 1** Zeotap provides a Docker image of the ID+ Resolver Service. This docker image is installed on the SSP server that receives the Ad requests. This step ensures low latency for ID+ resolution. To know more about how to run the Docker container, refer to the [Installing and running the Docker Container](/articles/id-publication/new-topic-ssp-implementation-guide#installing-and-running-docker-container) section. **Step 2** ID+ Resolver Service communicates with the client (SSP service) using an API request for easy integration. **Step 3** SSP sends details such as the IDP cookie that it received and a list of DSPs for which the corresponding ID+ token is required. To know more about this, refer to the [Input to Resolver Service](/articles/id-publication/new-topic-ssp-implementation-guide#input-to-resolver-service) section. **Step 4** ID+ Resolver Service responds with an array of objects having the DSP ID and the resolved ID+ token specific for that particular DSP. To know more about this, refer to the [Output of Resolver Service](/articles/id-publication/new-topic-ssp-implementation-guide#output-of-resolver-service) section. **Step 5** ID+ Resolver Service also makes fiRPC call (secured using Transport Layer Security (TLS)) client connection to the Zeotap Master Data server that performs the following functions: 1. Update the metadata specific to DSP specific resolution configuration 2. Send stats or diagnostic information to convey service health > [!NOTE] > > **Note**: > > When a user opts out from an SSP, then the SSP does not have to make a call to the Resolver Service. ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/id-publication/Storage/id-publication/google-tag-manager-implementation-guide/SSP_2.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=c18e796ba5eb777859d558fafe8baac4) ### INSTALLING AND RUNNING DOCKER CONTAINER The Resolver Service makes a call to the Zeotap Data Center using TLS certificates that are part of the Docker Container. The following are the commands to install and run the Docker Container: 1. `docker login` – This command asks for username and password. Reach out to your Zeotap Product Operations Manager (POM) for the username and password. 2. `docker run -d -e SSP.ID=${SSP_ID} -p [PORT]:80 --cap-add IPC_LOCK zeotapgmbh/resolver:` – Reach out to your Zeotap Product Operations Manager (POM) for the tag. The table below explains the variables used in this command. > [!NOTE] > > **Note:** > > An SSP must give IP addresses of servers or NAT IP where they are hosting the Docker application (for both testing and production environments). Only the whitelisted IPs can communicate with the Zeotap Data Center. > > Security patches are done immediately and informed on an ad hoc basis so that the patches can be pulled from Docker Hub. However, the regular feature updates are done once every month. Table 1: Docker Command Variable | **VARIABLE** | **DESCRIPTION** | | :- | :- | | SSP.ID | This is an environment variable that must be passed to the Docker Container for handshake communication between the Resolver Service and the Zeotap Data Center. | | PORT | This is the port at which the application runs outside the container. | | RESOLVER_PORT | RESOLVER_PORT is an optional variable. This is the port at which the application runs inside the container. If the RESOLVER_PORT is not given, then the application runs at the default port 80. Use the following command when you are running the Docker Container with the RESOLVER_PORT: | | | `docker run -d -e SSP.ID=${SSP_ID} -e RESOLVER_PORT=${RESOLVER_PORT} -p [PORT]:${RESOLVER_PORT} --cap-add IPC_LOCK zeotapgmbh/resolver:` | ### COMMUNICATING WITH ZEOTAP DATA CENTER The Resolver Service communicates with the Zeotap Data Center at regular intervals using the following two components: * **Metric Collector** - The metric information passed to the metric service is used to track the errors and performance of the Resolver Service at regular intervals. This is to ensure that the Resolver Service performs best to its capacity and we are able to take actions on the errors at the earliest. * **Data Manager** - The Data Manager is used to check in, obtain and renew keys to generate the tokenised DSP IDP Cookies. The Resolver Service connects to idplusdc.zeotap.com. To validate this request, we require the IPs or NAT IPs associated with the request originating network. ### STARTING RESOLVER SERVICE Note that the keys are highly sensitive and memory locked into the container. Any attempt to access or modify the key may lead to system wide disruption of the account. As a result, legal measures may be taken. Therefore, before starting the Resolver Service, ensure of the following points: * The coredump must be disabled. The ulimit core is set to 0 (Overridden) by default. * If the IPC_LOCK capability is not provided, the application cannot start. ### INPUT TO RESOLVER SERVICE The Resolver Service receives the input from SSP in the form of IDP Cookie and/or the DSP IDs. These are then converted to the corresponding DSP ID+ tokens. * **Cookie** – This is the Zeotap IDP cookie that is stamped on the Publisher page and passed to SSP through the Prebid module or any other Header Bidder solution. * **DSP IDs** – While onboarding a SSP into Zeotap, the SSP provides a list of DSPs that it works with along with their DSP IDs. When calling the Resolver Service, one or more of this DSP ID is passed as an input. * If the **DSP IDs** parameter is used, then only the provided DSP IDs and their associated ID+ is generated as the output. Zeotap recommends that you provide the DSP IDs in the input request. * If the **DSP IDs** parameter is not included, then the Resolver Service returns ID+ for all the available DSPs that are authorized for the SSP. ### OUTPUT OF RESOLVER SERVICE The Resolver Service generates a key value pair of DSP IDs mentioned along with their corresponding IDP cookie. For more information, refer to the [Resolver API](/articles/id-publication/new-topic-ssp-implementation-guide#resolver-api) section. ### API ENDPOINTS OF RESOLVER SERVICE This section explains the API endpoints of the Resolver Service in detail. #### Health Check API Use the Health Check API to check the health status of the Docker Container. | **Status Code** | **Response from API** | **Scenario** | | :- | :- | :- | | 200 | Ok | When the application is up and running | | 404 | Not Found | When the application is down or the server is not able to start due to some reason | #### Resolver API This is the primary endpoint of the Resolver Service that converts the IDP Cookie to its corresponding DSP IDP Cookies. > Metrics API URL: /metrics | **Status Code** | **Response from API** | **Use case** | | :- | :- | :- | | 200 | Ok | When the cookie value is correct and the correct list of DSP IDs/authorized DSP list is passed | | 204 | No Content | When the cookie value is correct but the wrong value of DSP IDs or unauthorised DSP list is passed | | 400 | Bad Request | When the cookie value is wrong but correct/incorrect/noList is passed | | 500 | Internal Server Error | When something has gone wrong | **Metrics API** The metrics API returns the metrics in the Prometheus metric format. This API returns the number of requests processed differentiated on the basis of code, method and URL. The latency is measured in seconds at various percentiles for the overall requests served by the application. ```json Code theme={null} Response # HELP resolver_request_duration_seconds The HTTP request latencies in seconds. # TYPE resolver_request_duration_seconds summary resolver_request_duration_seconds{quantile="0.5"} 9.7338e-05 resolver_request_duration_seconds{quantile="0.9"} 9.7338e-05 resolver_request_duration_seconds{quantile="0.99"} 9.7338e-05 resolver_request_duration_seconds_sum 9.7338e-05 resolver_request_duration_seconds_count 1 # HELP resolver_requests_total How many HTTP requests processed, partitioned by status code and HTTP method. # TYPE resolver_requests_total counter resolver_requests_total{code="200",method="GET",url="/v1/resolve"} 1 ``` Table 4: Response Codes | **Status Code** | **Response from API** | | :- | :- | | 200 | Ok | | 500 | Internal Server Error | ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/id-publication/Storage/id-publication/google-tag-manager-implementation-guide/SSP_3.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=e18617f02b86fb0e3eceb4bd770ef62b) ## USING ID+ IN ORTB BID REQUEST Once the SSP derives ID+ for their respective DSP partner from the ID+ Resolver Service, they can add it to the outgoing bid request. Ensure that the demand-side platform has support for reading it. **For example:** If SSP and DSP support ORTB 2.5 Format **For example:** If SSP and DSP support ORTB 3.0 Format ## BEST PRACTICES TO OPTIMISE PERFORMANCE ### IDEAL CONFIGURATION FOR BEST PERFORMANCE The following is the ideal configuration that we achieved after running our test on 8 cores and 7.2 fiB RAM: * 99 percentile response time of requests within 1 ms * Mean response time 0.5 milliseconds We prefer keeping 4x connection to numbers of cores for ideal throughput and latency combination. Also, note that the Resolver Service should be closer to the Exchange Application to ensure better results. ### RECOMMENDATION TO OPTIMIZE LATENCY To achieve latency within 1 ms, we recommend that you use 2 cores and 4 parallel keep-alive connections with 5K rps per core. ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/id-publication/Storage/id-publication/google-tag-manager-implementation-guide/SSP_4.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=fd2c364fa618ac558940964218020ab4) ### RECOMMENDATION TO OPTIMISE THROUGHPUT To achieve higher throughput, we recommend that you use 2 cores and 8 parallel keep-alive connections with 7K rps per core. This combination provides latency within 1 ms. ![](https://mintcdn.com/zeotap/rwzlL6tHGA5Q4kOq/articles/id-publication/Storage/id-publication/google-tag-manager-implementation-guide/SSP_5.png?fit=max\&auto=format\&n=rwzlL6tHGA5Q4kOq\&q=85\&s=fad7f8dbf4c17e7693665435be50d2b2) # Create a Web Pixel, IFrame or App Pixel source Source: https://docs.zeotap.com/articles/integrate-customer/2676392376 Create the Zeotap CDP source that receives the website or app event data your pixels collect. ## What this is A Web Pixel, IFrame or App Pixel source carries event data **into** Zeotap CDP. The pixel fires on your website, email, advertisement or app, and the pixel URL sends the event information to Zeotap, where it is recorded against the `write_key` provisioned for that source. Data moving the other way — out of Zeotap CDP to an external marketing or advertising platform — is handled by a [destination](/articles/integrate-customer/destinations), not by a source. Setting up this integration takes three stages, and this page covers the first: 1. **Create the source** (this page) — choose the category and data source, name the source, and select the region of upload. 2. [Add the global properties and create the pixels](/articles/integrate-customer/implementing-pixel-source-2665775396) on the source's **IMPLEMENTATION DETAILS** tab. 3. [Implement the pixels on your site, ad or campaign](/articles/integrate-customer/implementing-pixels-on-a-site-2c-ad-or-campaign-2693727342). For what pixel files are and how the three variants differ, see [Web Pixel/Web IFrame/App Pixel](/articles/integrate-customer/web-pixel-web-iframe-app-pixel). ## Supported identifiers | **Data source** | **How users are identified** | | :- | :- | | **Web Pixel API** | Relies primarily on the Zeotap third-party cookie. You may also send your own identifiers in the pixel. | | **App Pixel API** | Relies on the MAID sent in the pixel. MAID is mandatory, in addition to any other identifiers you send. | Cookie syncing differs by variant as well: a web image pixel performs only one cookie sync at a time, so five preferred partners mean the pixel has to be fired five times, whereas an IFrame tag responds with multiple image tags, each of which is a cookie sync with a platform of your choice. The [Web Pixel/Web IFrame/App Pixel](/articles/integrate-customer/web-pixel-web-iframe-app-pixel) page carries the full comparison. ## Prerequisites * Decide what the source represents before you create it. A source can be a whole website or app, a specific landing page, a single campaign, or a set of campaigns grouped together. Create one source per unique source of data — two websites are two sources. * Know whether you are tracking **Website Events** or **App Events**. That choice determines which data sources the wizard offers next. ## Create the Web Pixel, IFrame or App Pixel source **Step 1** Navigate to the **Sources** application under **Integrate**, in the Zeotap CDP App. **Step 2** Click **CREATE SOURCE**. **Step 3** Choose **Website Events** or **App Events** as the Category. ![Step 1 of the CREATE SOURCE dialog, SELECT CATEGORY, with Website Events and App Events highlighted above Flat Files, Server to Server, Tag Managers, CRM Data and Data Warehouse.](https://mintcdn.com/zeotap/1FGgO964H8EKim6t/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/create_webpixel_1.png?fit=max\&auto=format\&n=1FGgO964H8EKim6t\&q=85\&s=042dc39ca7abf5b5153cb23b6bf259b2) **Step 4** If you chose **Website Events**, choose **Web Pixel API** or **IFrame** as the Data Source. ![Step 1 of the CREATE SOURCE dialog, SELECT DATA SOURCE, listing Web JavaScript with Web Pixel API and IFrame highlighted below it.](https://mintcdn.com/zeotap/1FGgO964H8EKim6t/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/create_webpixel_2.png?fit=max\&auto=format\&n=1FGgO964H8EKim6t\&q=85\&s=f1d1c893b13c0c7b7e2eea25e52adab7) **Step 5** If you chose **App Events**, choose **App Pixel API** as the Data Source. ![SELECT DATA SOURCE step showing App Pixel API as the only option, described as tracking user actions using parameters in the pixel against MAID.](https://mintcdn.com/zeotap/xGzkHY-dcQy5tLit/articles/integrate-customer/Storage/integrate-customer/CD/attachments/2676392376/2693988379.png?fit=max\&auto=format\&n=xGzkHY-dcQy5tLit\&q=85\&s=2f909511d10ee4bcbb2261af2041950b) **Step 6** Enter a short and descriptive name for the source in **Source Name**. **Step 7** Under **Select your Region**, choose the region of upload — **Europe (EU)**, **United States (US)** or **India (IN)**. ![Step 2 of the CREATE SOURCE dialog, SOURCE DETAILS, with a Source Name field and Select your Region checkboxes for Europe (EU), United States (US) and India (IN).](https://mintcdn.com/zeotap/xGzkHY-dcQy5tLit/articles/integrate-customer/Storage/integrate-customer/CD/attachments/2676392376/2693398601.png?fit=max\&auto=format\&n=xGzkHY-dcQy5tLit\&q=85\&s=9a2f8f38e505b7936093d8979c44379a) **Step 8** Click **CREATE SOURCE**. The created source appears on the **SOURCES** listing page. Click a particular source to view the details regarding the snippet code and authorisation key. ## Verify the source 1. On the **SOURCES** listing page, find the source you created. Its status is **Created**, which means the source exists but has not received any data yet. 2. Complete the implementation stages linked under [Next steps](#next-steps) so that the pixels start firing. 3. Once data starts flowing in, the status changes to **Integrated** and you can inspect a sample of the incoming data on the source's **[PREVIEW DATA](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab)** tab. ## Troubleshoot * **The status stays at Created.** The source has not received any data yet. Re-check that the global properties and pixels exist on the **IMPLEMENTATION DETAILS** tab and that the pixels are firing on your site, ad or campaign. * **No preview is available.** The **PREVIEW DATA** tab displays an error message stating the reason. Fix the issue, confirm the source is implemented correctly, and try again after some time. Use **View Error Log** on that tab to review the errors found in the ingested data. * **An alert icon appears beside the source name.** An erroneous record was ingested in the last 90 days. The alert remains until the errors are fixed. ## Next steps * [Implement the Pixel Source](/articles/integrate-customer/implementing-pixel-source-2665775396) — add the global properties, then create a pixel per event. * [Implement the Pixels on a Site, Ad or Campaign](/articles/integrate-customer/implementing-pixels-on-a-site-2c-ad-or-campaign-2693727342) — deploy the pixels through a tag manager. * [Components of the Preview Data Tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) — read the sample of ingested data. * [Components of the Source Listing Page](/articles/integrate-customer/components-of-the-source-listing-page) — what each status and column on the listing page means. # Activate your real-time audiences Source: https://docs.zeotap.com/articles/integrate-customer/activate-your-real-time-audiences Attach a real-time destination to a Journeys workflow so qualified users are sent to your marketing platform as they qualify. ## What this is Real-time activation sends qualified users from a Journeys workflow to your marketing destination as they meet the workflow's filters and conditions. You attach a destination to the **Send to Destinations** node inside a workflow: the destination holds the connection credentials, and the node holds the workflow-specific action and field mapping. This page walks through creating a new destination from inside a workflow, attaching it to the **Send to Destinations** node, and publishing the workflow so activation begins. Each real-time integration (SFMC Personalization, Adobe Campaign, Airship, Batch, Cleverpush, Optimizely, Channable) has its own reference page for the exact credentials and actions it accepts; this page covers the flow that is common to all of them. ## Prerequisites > [!NOTE] > > Before you start: > > * A Journeys workflow with the user filters or conditions already applied. See [Create a Workflow](https://docs.zeotap.com/articles/orchestrate-customer/create-a-workflow). > * Destination-side credentials for the platform you are activating to (for example, an SFMC Personalization **Account Name**, **API Instance**, and **Dataset Name**). Each destination integration page lists the exact credentials it requires. > * Permission to create destinations and publish workflows in your Zeotap CDP workspace. ## Add a new destination from the workflow You can attach an existing destination or create a new one from the **Send to Destinations** node. ![Send to Destinations node in a Journeys workflow](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=8ed8abd70040c3e575c94c98ad4e6956) **Step 1** Open the workflow and click the **Send to Destinations** node. A panel opens listing the destinations already available in your workspace. ![Destination panel listing available destinations](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-25.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=9436e6620f33e4a53c427900a718e9a2) **Step 2** Click **+ Add New Destination** to create a new destination, or select an existing destination from the list to reuse it. ![Add New Destination button in the destination panel](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26-1.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=45aec566d6937bbb28613e4b880207c4) **Step 3** Search for your real-time integration in the search box, then click the integration and enter a name for the destination. **Step 4** Enter the components required for that integration. For SFMC Personalization, enter **Account Name**, **API Instance**, and **Dataset Name** obtained from your SFMC instance. Other integrations require different credentials — refer to the integration-specific page under [Next steps](#next-steps). ![Component fields for the SFMC Personalization destination](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-25-1.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=2de798faea0c16cca777f5ab13cfb92e) **Step 5** Click **Next** to proceed to field mapping. **Step 6** Under **Choose your Action**, select the action for real-time activation. For SFMC Personalization the action is **Send attributes to SFMC Personalization**. Under **Map the Fields**, map the identifiers and attributes required by the destination. Use **+ Add Mapping Field** to add custom identifier or attribute fields. ![Action selection and field mapping screen](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-12-12-1.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=32f340bd17ad5ea74dcae6d541c112f7) > [!WARNING] > > Mandatory fields must be mapped before you can proceed. The **Create Destination** button stays disabled until every mandatory identifier and attribute has a source field. **Step 7** Click **Create Destination**. The destination is created and returns you to the destination list, where it is now selectable for this workflow. ![Newly created destination in the destination list](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26-2.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=267a44fc9b1c80ab0d5809bfc6aea66e) ## Attach the destination to the Send to Destinations node Once the destination exists in your workspace, attach it to the node and complete the node-specific inputs. **Step 1** Click the destination you just created from the list of available destinations. **Step 2** On the **Destination Details** tab, credential fields (for example, **Account Name**, **API Instance**, **Dataset Name**, **API Username**, and **API Password** for SFMC Personalization) are pre-populated from the destination you created. Enter the node-specific inputs the destination requires — for SFMC Personalization these are **Action Name** (the name of the action associated with the event) and **Profile Object Name** (the object name associated with the event). **Step 3** On the **Destination Settings** tab, choose the action and field mapping for this node. **Step 4** Click **Save Destination**. The destination is attached to the node. ![Destination attached after saving](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26-3.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=a9a980e7e294460ac438a8df0d54fb41) **Step 5** Click **Add Destinations** to confirm attachment. To send the same audience to more than one destination from this node, add each additional destination here. ![Add Destinations confirmation with option to add more destinations](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26-4.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=fd6df4739a5d2a393fd1c77112c833ff) ## Publish the workflow **Step 1** The linked destinations now appear in the **Send to Destinations** node. Enter a workflow name in the text box at the top of the workflow canvas — a name is required to save the workflow. ![Linked destinations shown in the Send to Destinations node on the workflow canvas](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26-7.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=b115f3bbc04540d675d2e9145a7f91d6) **Step 2** Click **+** to add any further nodes (conditions, filters, additional destinations) your workflow requires. **Step 3** Choose one of the following: * **Save Draft** — saves the workflow so you can return and edit it before publishing. * **Next: Re-entry Condition** — defines whether a user can re-enter the same workflow after they have exited. **Step 4** After defining the re-entry criteria, click **Publish Workflow**. The workflow appears in the workflow listing with a **Published** status. ![Workflow listing showing the workflow with Published status](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26-8.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=634ab0c131fbe99396837bc9f7b8fc91) ## Verify activation is running To confirm the workflow is publishing to your real-time destination: 1. In the workflow listing screen, confirm the workflow shows **Published** status. 2. Open the **Send to Destinations** node and confirm each attached destination shows its credential fields populated and its action selected on the **Destination Details** and **Destination Settings** tabs. 3. In your destination platform (for example, SFMC Personalization, Airship, Optimizely), confirm that new records or events are arriving with the identifiers and attributes you mapped. Each destination platform surfaces incoming records in its own console — see the integration-specific pages under [Next steps](#next-steps) for where to look. ## Troubleshooting Common configuration errors surfaced while creating or attaching a destination: | Error condition | What it means | Where to look | | - | - | - | | **Create Destination** button disabled | One or more mandatory identifier or attribute fields on the mapping screen have no source field selected | Mapping screen → **Map the Fields** — check every field flagged mandatory | | Workflow cannot be saved | The workflow has no name in the top text box | Workflow canvas → workflow name field | | Attribute name rejected by destination | The destination platform restricts field names to a specific character set (Batch, for example, accepts only lowercase `a-z0-9_` for event attributes) | Destination-specific integration page — see [Next steps](#next-steps) | | Filename prefix rejected on file-based destinations | Adobe Campaign S3/Azure prefixes reject spaces and the symbols `_`, `#`, `@`, `$`, `%`, `&`, `*` | Adobe Campaign destination configuration → **Filename Prefix** field | For file-based real-time destinations (Adobe Campaign S3/Azure), the exported file follows this format: ``` {filenamePrefix}{fileNumber}_${channelId}_${timestamp}.csv ``` where `${timestamp}` is in epoch format. ## FAQ > [accordion] Can I send the same workflow to more than one destination at the same time? > > Yes. In the **Send to Destinations** node, click **Add Destinations** and select each additional destination. Every attached destination receives users as they qualify the workflow. > [accordion] Do I need to recreate the destination for every workflow? > > No. A destination is a workspace-level object. Once created, it appears in the destination list on the **Send to Destinations** node of any workflow in the same workspace. Credential fields are shared across nodes; the action and mapping on the **Destination Settings** tab are set per node. > [accordion] Where do I find the exact fields a given destination expects? > > Each real-time integration has its own reference page listing the required credentials, supported identifiers and attributes, and the available actions. See the integration pages linked under [Next steps](#next-steps). ## Next steps * [Explore the Adobe Campaign real-time integration →](/articles/integrate-customer/adobe-campaign-real-time-integration) * [Explore the Airship real-time integration →](/articles/integrate-customer/airship-real-time-destination-integration) * [Explore the Batch real-time integration →](/articles/integrate-customer/batch-real-time-destination-integration) * [Explore the Cleverpush real-time integration →](/articles/integrate-customer/cleverpush-real-time-integration) * [Explore the Optimizely real-time integration →](/articles/integrate-customer/optimizely) * [Explore the Channable real-time integration →](/articles/integrate-customer/channable-real-time-integration) # Active Agent - Virtual Minds Source: https://docs.zeotap.com/articles/integrate-customer/active-agent-virtual-minds Send audiences built in Zeotap CDP to your Active Agent instance as a batch destination, using your Adition Network ID and an Active Agent attribute ID and key. ## What this is This destination sends data **out of Zeotap CDP to Active Agent**: segment data created in Zeotap is pushed to your Active Agent instance, where it appears as a segment you can target. Active Agent is a *demand-side platform (DSP)*. It is a **batch destination** — you attach it to an **audience**, not to a journey. Yieldlab, a supply-side platform (SSP) that uses the same **Adition Network ID** and the same Active Agent attribute and subkey setup, is a separate destination. If you are activating segments on Yieldlab inventory rather than through the Active Agent DSP, see [Yieldlab SSP](/articles/integrate-customer/yieldlab-ssp). > [!NOTE] > > **Note:** > > *The terms Audiences and Segments are used interchangeably to refer to customer cohorts belonging to a specific category — for example, customers over 18 years of age who have performed an `addToCart` event within the last 30 days.* ## Supported identifiers and actions The integration supports the following identifier types: | ID Type | Description | | :- | :- | | 0 | UNKNOWN | | 3 | ADITION | | 4 | AAID — Android Advertising ID | | 5 | IDFA — iOS Identifier for Advertisers | | 12 | CTV | | 13 | NETID | | 15 | ID5 | | 17 | IDFV | | 40 | UTIQ | > [!NOTE] > > If you are unsure which ID type you will send, you can leave the ID Type blank. The destination offers one action, selected while you create it: **Send Identifiers via Sub-Key in Active Agent**. It adds a sub-key into an existing key, so the attribute key and attribute ID you capture in Active Agent are the values you fill in later, when you link an audience to the destination. ## Prerequisites Before pushing segments to Active Agent, ensure you have your **Adition Network ID** from your Active Agent POC. Once you have the Adition Network ID, contact **Zeotap Customer Support** and request that they create the required attribute on their side for your network ID. After the attribute is created, it becomes visible in your Active Agent instance, and Support will share the following credentials with you: * **Attribute ID** * **Attribute Key** These credentials are used when linking an audience to the Active Agent destination, so that segments are automatically pushed to your Active Agent instance. ### Note the attribute ID and key Once Support has created the shared attribute, it appears in **Active Agent** under **Audience**. Note down its **ID** and **Key** — the attribute list shows both in their own columns. ![The Active Agent Audience attribute list, with ID, Name, Key, Audience size, Type, Data owner, Period of validity and Description columns, and a New attribute button above the table.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/active-agent-virtual-minds/active-agent-virtual-minds-p3-1.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=79916db3ebeb5efcbcfdc00a44a17a59) ## Create the Active Agent destination Once you have the prerequisites above, create the destination: **Step 1** Log into the Zeotap CDP App and go to **Integrate** → **Destinations**. **Step 2** Click **+ Create Destination**. ![The Destinations list on the Private Destination tab, with the Create Destination button highlighted at the top right.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/active-agent-virtual-minds/active-agent-virtual-minds-p3-2.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=4cc643d565d1c13a844b0cb8fc41f7a7) **Step 3** Under **All Destinations**, search for **Active Agent**. ![The All Destinations catalogue with the Search for a Destination box highlighted above the tiles of available destinations.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/active-agent-virtual-minds/active-agent-virtual-minds-p3-3.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=e60ebe9262e9ab47c7ad2e3306bee519) **Step 4** Click **Active Agent**. A screen appears with destination details on the left and the configuration fields on the right. Enter the required details: a. In **Destination Name**, enter a name for the destination. b. In **Adition Network ID**, enter your Adition Network ID. ![The Active Agent destination details form, showing the Destination Name field and the Adition Network ID field.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/active-agent-virtual-minds/active-agent-virtual-minds-p4-4.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=378e0811df827b71a5bb0676e2fca234) c. Review the values and click **Next** to proceed to mapping. **Step 5** Under **Choose your Action**, select **Send Identifiers via Sub-Key in Active Agent**. Then, under **Map the Fields**, map the **Catalogue Field** entries to the **Destination Field** entries: a. **Active Agent ID** — map the identifier(s) you want to send. You can map **multiple identifiers** to this single field — select them as a **List** (for example, `Adid`, `Email Raw` and `Yieldlab_Cookie`) so that all of them are sent to Active Agent in one action. b. **ID Type** — choose the appropriate ID type from the [Supported identifiers and actions](#supported-identifiers-and-actions) list. Add it as custom data. When sending a list of identifiers, provide the **ID Type** as a single **String** value. If unsure, leave it blank. ![The action and mapping screen: Choose your Action with Send Identifiers via Sub-Key in Active Agent selected, and Map the Fields mapping three catalogue attributes to Active Agent ID as a List, and an ID type value to ID Type as a String.](https://mintcdn.com/zeotap/8dYUBB_jmsjP3lCu/articles/integrate-customer/Storage/integrate-customer/active-agent-virtual-minds/active-agent-virtual-minds-p5-5.png?fit=max\&auto=format\&n=8dYUBB_jmsjP3lCu\&q=85\&s=6ab379eff96808fc4e5c45f281e2e049) **Step 6** Once the mapping is complete, click **Create Destination**. The created destination is listed in the **Audiences** application (**Segment** → **Audiences**), where it can be linked to an audience. ## Enable Audience Boost Active Agent supports **Audience Boost**, which enriches your first-party (1P) audience data using Zeotap's identity graph to increase match rates and addressable reach — without collecting more data yourself. To enable it, open the destination's **Destination Settings**, go to the **Enable Audience Boost** section, and select the **Audience boost** checkbox. > [!NOTE] > > Audience Boost is enabled per Destination, and its availability depends on the data acceptance policy of the Destination. For any inquiries, contact your Zeotap POC. For how Audience Boost works, the audiences it creates in the destination, and how to measure incremental reach, see [Audience Boost](/articles/segment-customer/audience-boost). ## Link an audience to the destination The attribute ID and key you captured earlier are used when you link the audience. For the general linking flow in the **Audiences** application, see [Activate your batch audiences](/articles/integrate-customer/link-an-audience-to-the-destination). Fill in the **Action Inputs** fields in the destination settings. ### Action Inputs ![The audience's destination drawer on the Destination Settings tab, showing the refresh schedule options and the Action Inputs fields Attribute Key, Attribute ID and CPM, with Save Destination at the bottom right.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/active-agent-virtual-minds/active-agent-virtual-minds-p6-7.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=773d1d2ad485e985fdd87ee7ae6e258b) Use the credentials shared by Zeotap Customer Support (or the ones you noted in Active Agent) to fill in the following fields: | Field | Description | | :- | :- | | **Attribute Key** | Paste the **Attribute Key** shared by Support (or the one you noted). | | **Attribute ID** | Paste the **Attribute ID** shared by Support (or the one you noted). | | **CPM** | Optional. Leave blank if not needed. | When the fields are complete, click **Save Destination**. ## Verify the audience reached Active Agent After you save the destination, the audience starts pushing into your Active Agent instance and should appear as a segment in Active Agent. For the two-sided check — confirming the delivery in Zeotap and then confirming the record count in the destination platform — see [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). ## Next steps * [Activate your batch audiences](/articles/integrate-customer/link-an-audience-to-the-destination) — the full linking flow in the **Audiences** application. * [Destinations](/articles/integrate-customer/destinations) — how destinations are configured and mapped, including [Configure a destination](/articles/integrate-customer/destinations#configure-a-destination) and [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). * [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail) and [When to contact support](/articles/integrate-customer/destinations#when-to-contact-support) — the errors that surface on an audience–destination pair, and what to include in a support request. * [Audience Boost](/articles/segment-customer/audience-boost) — enrich the audience before it is sent. * [Yieldlab SSP](/articles/integrate-customer/yieldlab-ssp) — the other destination that uses your Adition Network ID. * [Integrations master list](/articles/integrations-master-list-publication/integrations-master-list) — every destination and the identifiers it accepts. # Acxiom Source: https://docs.zeotap.com/articles/integrate-customer/acxiom Send Zeotap CDP audience identifiers out to the Amazon S3 bucket provided by Acxiom as scheduled CSV deliveries. The Acxiom destination sends audience identifiers **out of Zeotap CDP** to the Amazon S3 bucket provided by Acxiom, as CSV files. Data moves in one direction only: nothing flows from Acxiom back into the CDP. Acxiom appears in the [integrations master list](/articles/integrations-master-list-publication/integrations-master-list) as a destination only, so there is no Acxiom source page to pair this one with. ## What this is Acxiom is a global data and marketing technology company that primarily focuses on providing data solutions and insights to help businesses understand and engage their customers more effectively. The company is best known for its capabilities in customer data analytics, data-driven marketing, and identity resolution. The Acxiom integration with Zeotap allows the customer to push the audiences from Zeotap to the S3 bucket provided by Acxiom. It is a batch integration for audiences: you configure the destination once against a bucket and folder, then reuse it for every audience you link to it. Each delivery writes CSV files into that folder. ## Supported identifiers and actions This integration supports MAIDs (Raw), Email addresses (SHA 256), Phone numbers, TTD, ID5 and External ID. Each identifier has its own action on the **Actions and Mapping** screen. Choose the action that matches the identifier you want to deliver: | Identifier | Action | | - | - | | Email addresses (SHA 256) | Send email to Acxiom Audiences | | External ID | Send external ID to Acxiom Audiences | | ID5 | Send ID5 to Acxiom Audiences | | MAIDs (Raw) | Send MAID to Acxiom Audiences | | Phone numbers | Send Phone Number to Acxiom Audiences | | TTD | Send TTD to Acxiom Audiences | ## Prerequisites > [!NOTE] > > Before you create an Acxiom Destination in Zeotap CDP, ensure that you obtain the following S3 bucket details from Acxiom: > > * **Bucket** > * **Folder** > * **Access Token** > * **Secret Access Token** > * **S3 Bucket Region** > * **Data Format** > > You also need an audience to activate, and the destination rights described in the [Destinations prerequisites](/articles/integrate-customer/destinations#prerequisites). ## Where each detail appears in Amazon S3 The screenshots below show where each of these values appears in the Amazon S3 console. ### Bucket This is the name of your S3 bucket. You can obtain this information on your Amazon S3 account by navigating to **Buckets**. The bucket name is shown in the breadcrumb and as the heading of the bucket's own page, as highlighted below. ![The Amazon S3 console with a bucket open, the bucket name highlighted in the breadcrumb and page heading, and the Objects tab selected](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/amazon-s3-destination/image-1.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=125e1f75dee2f9e06f48ebac1542d6c1) ### Folder In Amazon S3, a folder serves as a logical container for organising stored objects within a bucket. In reality, there are no actual folders in Amazon S3. Instead, the folder concept is emulated by employing object key names containing slashes ("/") to replicate a hierarchical arrangement. You can obtain this information from your Amazon S3 account by navigating to the **Objects** tab under the Amazon S3 bucket as shown in the image below. ![The Objects tab of an Amazon S3 bucket, with the folder name highlighted in the breadcrumb and page heading and a nested folder listed under Objects](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/amazon-s3-destination/image-2.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=839d21273b69988d09571cd005653f5c) Ensure that you follow the folder structure shown below. `folder_name/sub_folder_name/` ### Access Token and Secret Access Token These are the security tokens that provide secure access to your Amazon S3 resources. You can obtain the Access Token and Secret Access Token by navigating to the **AWS IAM Credentials** tab under **Security credentials** in your Amazon S3 account. ### S3 Bucket Region This is the geographical location where the Amazon S3 storage is available. You can obtain this information by navigating to the **Properties** tab under the Amazon S3 bucket as shown in the image below. ![The Properties tab of an Amazon S3 bucket, with the AWS Region field highlighted under Bucket overview](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/amazon-s3-destination/image-3.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=0eb197eabbe45efa4f3f2d8a4c676da2) ### Data format * **Phone number format** — full international format without "+". For example, 9876453123. * Enrichers needs to be applied based on the format in which the data is ingested. Please contact your Zeotap POC before using the Send Phone Number to Acxiom Audiences action. For what enrichers do on the mapping screen, see [Enrichers in Destination Mapping](/articles/segment-customer/enrichers-in-destination-mapping). * **File name** — delivered files follow this pattern: `/{{ org_id }}/{{ identifier used }}/{{segment_id}}_{{ segment_name }}_{{ timestamp_of_update }}_{{ part }}.csv` ## Create the Acxiom destination Perform the following steps to create a Destination for Acxiom: **Step 1** Log into the Zeotap CDP App and go to the **DESTINATIONS** application. **Step 2** Click **+ Create Destination**. ![The Zeotap CDP Destinations listing with the Create Destination button highlighted](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/amazon-s3-destination/image-4.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=4dcbd67902a087cb7e51b65a093cfcd3) **Step 3** Under the **All Destinations** section, search for **Acxiom**. ![The All Destinations catalogue in Zeotap CDP with the Search for a Destination box highlighted above the destination tiles](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/amazon-s3-destination/image-5.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=c2cc8d0a1797b8f629331cd00240199f) **Step 4** Click **Acxiom**. A screen appears displaying details about the particular destination towards the left. On the right-hand side of the screen find a list of fields that are required for the integration to be established. Provide the required details as mentioned in the following steps: a. Enter a name for the Destination. Choose a name that identifies the Acxiom bucket it delivers to, so the destination is easy to find when you link an audience. b. In the **Bucket** field, provide the name of the Amazon S3 Bucket. c. In the **Folder** field, provide the folder path in your storage location where Zeotap CDP can store your exported data. d. Enter **Access Token** and **Secret Access Token** that you obtained from your Amazon S3 account. e. In the **S3 Bucket Region** field, provide the geographical region where your Amazon S3 bucket is available. f. Review all the values entered above and then click **Next** to proceed. ![The Enter Destination Details step for the Acxiom destination in Zeotap CDP, showing the Destination Name, Bucket, Folder and Access Token fields](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/amazon-s3-destination/image-6.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=908d61334a9f4db599e4c15cd524c13d) **Step 5** In the **Actions and Mapping** screen that appears, choose the action for the identifier you want to deliver — see [Supported identifiers and actions](#supported-identifiers-and-actions) above. **Step 6** Based on the actions you choose, map the catalogue fields to the corresponding destinations fields. Ensure that you map the mandatory fields, otherwise destination will fail. For how mapping works across destinations, see [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). **Step 7** Click **Create Destination**. The created Destination gets listed in the **Audiences** application, which can be linked to an audience. For the two entry points into destination configuration and what each part of the configuration does, see [Configure a destination](/articles/integrate-customer/destinations#configure-a-destination). ## Link an audience to the destination For information about how to link an Audience or segment to the created Destination in Audiences application, refer to [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > **Note:** > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an Audience or a segment could be a specific group of customers who are over 18 years of age and who have performed an `addToCart` event within the last 30 days. ## Verify the audience reached Acxiom Confirm delivery from both sides: 1. **In Zeotap CDP** — open the linked audience–destination pair and check that the latest run completed with a non-zero qualified count. For what a successful run records and what a failed one shows, see [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). 2. **In the S3 bucket** — if you have read access to the bucket, open the folder path you configured on the destination and confirm the CSV files for the audience are present, named according to the file name pattern above. ## Troubleshoot the Acxiom destination | Symptom | What it means | What to do | | - | - | - | | The destination fails on its first run | One or more mandatory fields were not mapped on the **Actions and Mapping** screen | Reopen the destination's mapping for the action you chose and map every mandatory field, then re-run | | No files appear under the folder you expect | The folder path on the destination does not match the structure Acxiom expects | Re-enter the **Folder** value using the `folder_name/sub_folder_name/` structure shown above, and confirm the path against the folder Acxiom gave you | | Phone numbers are delivered in the wrong format | The numbers were ingested in a format other than full international format without "+" | Apply an enricher to the phone-number field on the mapping so the delivered value matches the required format — see [Enrichers in Destination Mapping](/articles/segment-customer/enrichers-in-destination-mapping) — and contact your Zeotap POC before using the **Send Phone Number to Acxiom Audiences** action | For delivery errors that are not specific to Acxiom — no customers qualified, a terminated refresh, a rejected payload — see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail) and [When to contact support](/articles/integrate-customer/destinations#when-to-contact-support). ## Next steps * [Explore how to link an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore how destinations work across platforms →](/articles/integrate-customer/destinations) * [Explore enrichers in destination mapping →](/articles/segment-customer/enrichers-in-destination-mapping) * [Explore how to choose the output identifiers →](/articles/segment-customer/choose-the-output-identifiers) # Adform Source: https://docs.zeotap.com/articles/integrate-customer/adform Push Zeotap CDP audiences out to Adform as segments for programmatic targeting, using MAIDs and Adform cookies. ## What this is Adform is an outbound batch destination: Zeotap CDP pushes your audiences **out** to Adform, where they arrive as segments you can target in programmatic campaigns. Nothing flows back from Adform into Zeotap CDP through this integration. Adform is a global digital media advertising technology company specialising in real-time programmatic marketing automation technologies. Integrated with Zeotap, it offers marketers a suite of tools to plan, execute and optimise digital advertising campaigns across multiple channels and devices. Segments delivered through this destination are created inside **Zeotap's own Adform account**, and who can see them depends on the **Org Type** you choose: * **Advertiser** and **Agency** — the segment is restricted to you. You specify the countries, agency and advertisers that get access. * **Zeotap** — the segment is universally visible and accessible to all Adform Advertisers and Agencies. > [!NOTE] > > Adform appears twice in the destinations catalogue. Use **Adform** (this page) to push segments through Zeotap's Adform account. Use [Adform DMP](/articles/integrate-customer/adform-dmp) to upload audiences directly into **your own** Adform DMP account, which needs your own Adform DMP Account ID and API credentials. ## Supported identifiers and actions This integration supports MAIDs and Adform cookies. | Action | [ID extension](/articles/segment-customer/extend-your-audience#id-extension) | [Delete](/articles/segment-customer/delta-upload-and-delete-functions) | [Delta upload](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send identifiers to Adform | ✅ | ✅ | — | ## Prerequisites Have the following details ready before you create the destination. > [!NOTE] > > An Adform customer can be an **Agency** or an **Advertiser** registered for a country. ### Categories Choose the **Category** that matches the type of segment you want to create through Zeotap — for example Demographics, Interest or Intent. ### Org type Pick the Org Type that describes your position in Adform, and collect the identifiers it requires from the Adform support team. * **Agency** — choose **Agency** if you are an advertising agency within the Adform platform. Agencies manage and oversee advertising campaigns on behalf of their clients, using Adform's tools to optimise and track campaign performance. This Org Type requires an **Agency Id** and **Countries**, obtained from the Adform support team. ![Org Type set to Agency, showing the Agency Id field and the Countries selector beneath it.](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/adform_1.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=9c3f4806aeb7f43a00bdea1c927817e1) * **Advertiser** — choose **Advertiser** if you are an advertiser within the Adform platform. Advertisers use Adform to create, launch and manage their own campaigns. This Org Type requires an **Advertiser Id**, an **Agency Id** and **Countries**, obtained from the Adform support team. ![Org Type set to Advertiser, showing the Advertiser Id and Agency Id fields and the Countries selector beneath them.](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/adform_2.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=7495084f045ca39758aea1d2d799f15d) * **Zeotap** — choose **Zeotap** if you intend to make segments created within Zeotap's Adform account accessible to all Adform Advertisers and Agencies. > [!NOTE] > > For every Org Type the segment is created through Zeotap's account. For **Agency** and **Advertiser**, you additionally have to whitelist the segments for that Org Type. ## Create the Adform destination **1. Open the Destinations module** Log into the Zeotap CDP App and go to the **Destinations** application. **2. Start a new destination** Click **+ Create Destination**. ![The Destinations list with the + Create Destination button highlighted in the top right.](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_1.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=92dfe8ecb29e59c9d7d57cb954e54618) **3. Find Adform in the catalogue** Under **All Destinations**, search for **Adform**. ![The All Destinations catalogue with the search box highlighted; separate Adform and Adform DMP tiles appear in the results grid.](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_2.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=6f5f0f5367788fb4e9e946f4b3cb5874) **4. Enter the destination details** Click **Adform**. Details about the destination appear on the left of the screen, and the fields required to establish the integration appear on the right. Fill them in: a. Enter a name for the destination. b. **Price Currency** is set to **EUR** by default. c. Choose the **Category** that best describes the audience you want to activate through this destination. d. Choose the **Org Type** from the drop-down list. To decide which one applies, see [Org type](/articles/integrate-customer/adform#org-type) above. e. Review the values you entered, then click **Next**. ![The Enter Destination Details step showing the Destination Name, Price Currency, Categories and Org Type fields.](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/adform-2023-11-08.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=a7e94137deb7a077156aadcf75d474f1) **5. Choose the action and define the mapping** a. Under **Choose your Action**, select the [action](/articles/integrate-customer/destinations#configure-a-destination), then choose the corresponding identifiers under **Map the Fields**. Zeotap pre-populates the [output identifiers](/articles/segment-customer/choose-the-output-identifiers) the platform accepts — MAIDs, cookies, email IDs and so on. You can edit, add or remove an identifier from that list; see [defining the mapping](/articles/integrate-customer/destinations#define-the-mapping). ![The mapping step with Send identifiers to Adform selected as the action, and the Output Identifiers Mapping rows pairing Catalogue fields with Adform destination fields.](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/adform-2023-11-07-2.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=0831f0b71d0790a0963ca610c6838680) > [!NOTE] > > This integration supports [ID extension](/articles/segment-customer/extend-your-audience#id-extension) for the action **Send identifiers to Adform**. b. Click **Create Destination**. The destination is then listed in the **Target** and **Audiences** applications, ready to be linked to an audience. ## Link an audience to the destination For how to link an audience (also called a segment) to the destination from the **Audiences** and **Target** applications, see [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination). A **CPM** textbox appears in the audience settings when you link a destination to an audience. Enter a value there if you want to specify a CPM for that destination. ## Verify the activation 1. **In Zeotap** — open the destination and review its activity for the linked audience. See [verifying the activation](/articles/integrate-customer/destinations#verify-the-activation-worked). 2. **In Adform** — check that the segment has appeared at the Adform seat. Allow up to **three business days** after linking; the segment is not expected to be visible immediately. 3. **For the Agency and Advertiser Org Types** — confirm the segment has been whitelisted for your Org Type. Without that step the segment is created in Zeotap's Adform account but is not accessible to you. ## Next steps * [Set up Adform DMP to upload into your own DMP account →](/articles/integrate-customer/adform-dmp) * [Link an audience to the destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Understand why deliveries fail and when to contact support →](/articles/integrate-customer/destinations#why-deliveries-fail) * [Understand delta upload and delete functions →](/articles/segment-customer/delta-upload-and-delete-functions) * [Extend your audience with ID extension →](/articles/segment-customer/extend-your-audience#id-extension) * [Browse all batch integrations →](/articles/integrate-customer/destination-batch-integrations) # Adform DMP Source: https://docs.zeotap.com/articles/integrate-customer/adform-dmp Send Zeotap CDP audience identifiers out to your Adform DMP account, where they become segments you can target in programmatic campaigns. This page covers the Adform DMP destination, which sends audience identifiers **out of Zeotap CDP** to your Adform DMP account, where they arrive as segments you can use for targeting in your programmatic campaigns. Data moves in one direction only: Zeotap CDP does not read data back from Adform. For the separate [Adform](/articles/integrate-customer/adform) destination — which is configured with an Adform org type (agency, advertiser or Zeotap) and a category instead of Adform DMP API credentials and a Data provider id — see that page. ## What this is Adform is a media buying platform that enables brands, agencies and publishers to create, buy and sell digital advertising globally. Adform DMP (Data Management Platform) is the data management solution within that platform: it lets businesses collect, organise, analyse and activate large volumes of data drawn from sources such as websites, mobile apps and advertising campaigns. Integrated with Zeotap CDP, the Adform DMP destination uploads audiences directly into your Adform DMP account so you can use them for targeting in your programmatic campaigns. The Adform DMP destination is a batch integration for audiences: you configure it once against an Adform DMP account and then reuse it for every audience you link to it. Neither Adform integration has a source counterpart — both are destinations, so nothing flows from Adform into the CDP. ## Supported identifiers This integration supports MAIDs, Adform Cookies and ID5. ## Available actions | Action | [ID Extension](/articles/segment-customer/extend-your-audience#id-extension) | [Delete](/articles/segment-customer/delta-upload-and-delete-functions) | [Delta Upload](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send identifiers to Adform DMP | ✅ | — | — | The destination exposes a single action, **Send identifiers to Adform DMP**. It supports [ID Extension](/articles/segment-customer/extend-your-audience#id-extension) for expanding an audience before delivery. Adform DMP is not among the integrations where [Delete and Delta Upload](/articles/segment-customer/delta-upload-and-delete-functions) are enabled. ## Prerequisites Ensure that the following are taken care of before you start this integration. ### Adform DMP account Ensure that you have an Adform DMP account set up. If you do not have an account, contact your Adform Account Manager to set one up. ### Adform DMP Account ID Have your Adform DMP Account ID handy to set up this integration — it is the value you enter as the **Data provider id** on the destination. If you do not know your Account ID, contact [dmp@adform.com](mailto:dmp@adform.com). ### External platform connection Ensure that Zeotap CDP is added as an external platform on your Adform DMP account, so that the two can connect. To do this, contact [dmp@adform.com](mailto:dmp@adform.com) with your account details and request that Zeotap CDP be connected as an external platform. ### Adform API credentials You need to register as an [OAuth](https://api.adform.com/help/guides/getting-started/authorization-guide) client with the Adform DMP by providing the following details of the client to the Adform support team at [dmp@adform.com](mailto:dmp@adform.com): * **Username** * **Description** — a description such as "To facilitate the segment creation process through APIs" * **Authorisation flow** — Client Credentials * **Scopes** — [https://api.adform.com/scope/dmp.segments](https://api.adform.com/scope/dmp.segments) and [https://api.adform.com/scope/dmp.categories](https://api.adform.com/scope/dmp.categories) > [!NOTE] > > On successful registration, Adform shares the credentials by email to the username you gave them. These are the **API Username** and **API Password** you enter on the destination. You also need an audience to activate, and the destination rights described in the [Destinations prerequisites](/articles/integrate-customer/destinations#prerequisites). ## Create the Adform DMP destination **Step 1** Log in to the Zeotap CDP app and go to **Integrate > Destinations**. **Step 2** Click **+ Create Destination**. ![The Destinations listing in Zeotap CDP with the Create Destination button highlighted](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform-dmp/adform-dmp-2024-03-27-6.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=3b6455b42207522451a0c6d95c6bea0d) **Step 3** Under **All Destinations**, search for **Adform DMP**. ![The All Destinations catalogue with the Search for a Destination box highlighted](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform-dmp/adform-dmp-2024-03-27-7.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=552829f98882996687794b1f3c539cea) **Step 4** Click **Adform DMP**. Details about the destination appear on the left of the screen; the fields the integration needs appear on the right. Enter: a. A name for the destination. Choose a name that identifies the Adform DMP account it connects to, so the destination is easy to find when you link an audience. b. The **API Username** and **API Password** you obtained from Adform. c. The **Data provider id** from your Adform DMP account — this is the Account ID you gathered in the prerequisites. ![The Enter Destination Details step for Adform DMP, showing the Destination Name, API Username, API Password and Data provider id fields](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform-dmp/adform-dmp-2024-03-27-8.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=f6b9d2d550ec6d4006f4441b5e386bda) **Step 5** On the mapping screen, choose the action and the identifiers to send: a. Under **Choose your Action**, select **Send identifiers to Adform DMP**, then choose the corresponding identifiers under **Map the Fields**. The [output identifiers](/articles/segment-customer/choose-the-output-identifiers) the platform accepts — MAIDs, Cookies and more — are shown by default. You can edit, add or remove an identifier from the list; see [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). b. Click **Create Destination**. The created destination is then listed in the **Audiences** application, ready to be linked to an audience or segment. ![The Mapping step with Send identifiers to Adform DMP chosen under Choose your Action and the Output Identifiers Mapping table under Map the Fields](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform-dmp/adform-dmp-2024-03-27-9.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=ef6c80369312f2ae24431738d193627c) > [!NOTE] > > This integration supports [ID Extension](/articles/segment-customer/extend-your-audience#id-extension) for the action **Send identifiers to Adform DMP**. For the two entry points into destination configuration and what each part of the configuration does, see [Configure a destination](/articles/integrate-customer/destinations#configure-a-destination). ## Link an audience to the destination Once the destination is created, link it to the audience you want to activate from the **Audiences** application — see [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination) for the end-to-end workflow. It can take up to three business days for a linked segment to be available at the Adform DMP seat. > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience or a segment can be a specific group of customers who are over 18 years of age and have performed an `addToCart` event within the last 30 days. ## Verify the audience reached Adform DMP Confirm delivery from both sides: 1. **In Zeotap CDP** — open the destination and review its activity. A successful delivery records a completed run with a non-zero qualified count; a failed run records an error message you can use to diagnose the cause. See [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). 2. **In the Adform console** — open **Audiences** for the account and find the audience delivered from the CDP. It is listed with its audience name, audience ID, audience category and a status, as shown below. Allow up to three business days before expecting it to appear. ![The Audiences list in the Adform console showing a delivered audience with an active status, its audience ID, data type and audience category](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform-dmp/adform-dmp-2024-03-27-5.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=0851b8d7fe10edaf84363d72d6460c96) The two counts will not match exactly — Adform applies its own match-rate filtering to the identifiers it receives — but both should be non-zero. ## Troubleshoot the Adform DMP destination | Symptom | What it means | What to do | | - | - | - | | The segment is not at the Adform DMP seat shortly after linking | Segments can take up to three business days to be available at the seat | Confirm the delivery completed in Zeotap CDP, then re-check the Adform console after three business days | | The destination cannot authenticate against Adform | The API Username and API Password are not the ones Adform issued, or the OAuth client was never registered with the two DMP scopes | Re-check the credentials Adform emailed you, and confirm the client was registered with the `dmp.segments` and `dmp.categories` scopes described in the [prerequisites](#adform-api-credentials) | | The delivery completes in Zeotap CDP but nothing arrives in Adform DMP | Zeotap CDP has not been added as an external platform on the Adform DMP account, so there is no connection to deliver over | Contact [dmp@adform.com](mailto:dmp@adform.com) with your account details and request that Zeotap CDP be connected as an external platform | | Segments arrive on an Adform DMP account you did not expect | The **Data provider id** on the destination points at a different Adform DMP account | Re-check the Account ID for the account you intend to deliver to and correct the **Data provider id** on the destination | | The delivery completes but Adform matches far fewer users than the audience holds | The identifiers mapped on the destination are not identifiers Adform holds for those users | Review the destination's mapping and confirm the mapped identifiers are actually present on the audience | For delivery errors that are not specific to Adform DMP — no customers qualified, a terminated refresh, a rejected payload — see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail) and [When to contact support](/articles/integrate-customer/destinations#when-to-contact-support). ## Next steps * [Explore the Adform destination for agency, advertiser and Zeotap org seats →](/articles/integrate-customer/adform) * [Explore how to link an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore how destinations work across platforms →](/articles/integrate-customer/destinations) * [Explore ID Extension for expanding an audience →](/articles/segment-customer/extend-your-audience#id-extension) # Adobe Analytics (New) Source: https://docs.zeotap.com/articles/integrate-customer/adobe-analytics Send audience identifiers out of Zeotap CDP to Adobe Analytics. ## What this is Adobe Analytics is a **destination**: data flows one way, out of Zeotap CDP and into Adobe Analytics. Nothing comes back into Zeotap CDP through this connector. You create the destination once in the **Destinations** module, then link an audience to it, and each refresh of that audience delivers the mapped identifiers to Adobe Analytics. Adobe Analytics is a web and mobile analytics provider that enables organisations to gather data and gain actionable insights from any digital customer interaction. With in-depth analysis, versatile reporting and predictive intelligence, organisations get the insightful foundation they need to build better experiences for their customers. For data flowing the other way — Adobe-side tags collecting web events and user identities **into** Zeotap CDP — see [Adobe Experience Platform Tag Extension](/articles/integrate-customer/adobe-experience-platform-tag-extension). Other Adobe destinations have their own pages: [Adobe Campaign](/articles/integrate-customer/adobe-campaign) and [Adobe Target](/articles/integrate-customer/adobe-target). ## Supported identifiers and actions This integration supports Analytics Cookies. On the mapping step you choose the action. Select **Send identifiers to Adobe Analytics**, which supports [ID extension](/articles/segment-customer/extend-your-audience#id-extension). By default, the mapping is pre-populated with the [output identifiers](/articles/segment-customer/choose-the-output-identifiers) that the platform accepts, such as MAIDs, cookies and email IDs. You can edit, add or remove an identifier from that list — see [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). ## Prerequisites * An audience defined in Zeotap CDP, built on a source that is connected and mapped to the Catalogue. For the full upstream checklist, see [Destinations](/articles/integrate-customer/destinations#prerequisites). * A role that grants destination edit rights on the organisation that owns the destination. * The three Adobe Analytics details described below: **Report Suite ID**, **Name Space** and **Marketing Cloud Org ID**. Gather these before you start, because the create-destination form asks for all three on its first screen. ## Gather the details from Adobe Analytics ### Report Suite ID A report suite is a silo of data that Adobe Analytics uses to pull reports. An organisation can have many report suites, each containing different data sets. To find a Report Suite ID in Adobe Analytics: **Step 1** Log into the Adobe Experience Platform and navigate to Adobe Analytics. Note that Adobe Experience Platform allows you to [ingest Adobe Analytics data through the Analytics source connector](https://experienceleague.adobe.com/docs/experience-platform/sources/connectors/adobe-applications/analytics.html?lang=en). **Step 2** In the Adobe Analytics screen, from the top bar, click **Admin** > **All admin**. **Step 3** Under **Data configuration & collection**, click **Report suites**. Here you can find a list of report suites, including their ID and title. For more information about how to identify your analytics tracking server and report suite ID, refer to [Adobe's documentation](https://experienceleague.adobe.com/docs/analytics-learn/tutorials/implementation/implementation-basics/how-to-identify-your-analytics-tracking-server-and-report-suites.html?lang=en). ### Name Space In Adobe Analytics, a namespace is a logical container that holds all the properties, segments, events and other components related to a specific website or application. For more information about namespaces in Adobe Analytics, refer to [Adobe's documentation](https://experienceleague.adobe.com/docs/analytics/admin/admin-tools/data-governance/data-labels/gdpr-namespaces.html?lang=en). ### Marketing Cloud Org ID The Marketing Cloud Org ID is the ID associated with your provisioned Experience Cloud company. This ID is a 24-character alphanumeric string, followed by (and must include) `@AdobeOrg`. You can view your organization ID, along with other account information, using the keyboard shortcut **Ctrl+i** from any page at `https://experience.adobe.com`. For more information about how to fetch the Marketing Cloud Org ID, refer to [Adobe's documentation](https://experienceleague.adobe.com/docs/core-services/interface/administration/organizations.html?lang=en#concept_EA8AEE5B02CF46ACBDAD6A8508646255). ## Create the Adobe Analytics destination **Step 1** Log in to the Zeotap CDP App and go to **Destinations** under **Integrate**. **Step 2** Click **+ Create Destination**. ![The Destinations list under Integrate, with the + Create Destination button highlighted above the table of existing destinations](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/ADOBE_DMP_3.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=50d0558618336ceb78709191fcdda472) **Step 3** Under **All Destinations**, search for **Adobe Analytics**. ![The All Destinations catalogue with the search box highlighted, showing destination cards including Adobe Analytics](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/ADOBE_DMP_4.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=a0de06ff7f37752957c9f44c072aaebd) **Step 4** Click **Adobe Analytics**. The **Enter Destination Details** screen appears, with details about the destination on the left and the fields required for the integration on the right. Enter the following: a. **Destination Name** — a name for the destination, for easy identification. b. **Report Suite Id**, **Name Space** and **Marketing Cloud OrgId** — the values you gathered from Adobe Analytics above. c. Review the values you entered, then click **Next** to proceed. ![The Enter Destination Details form for Adobe Analytics, with fields for Destination Name, Report Suite Id, Name Space and Marketing Cloud OrgId, and a Next button](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/google-ad-manager/Adobe_Analytics_1.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=f5422f2fbbf80fbb5dd667590f92f876) **Step 5** On the **Mapping** screen, choose the action and define the mapping: a. *(Optional)* Replace **Untitled Mapping** with a name for your mapping. b. Under **Choose your Action**, select **Send identifiers to Adobe Analytics**. c. Under **Map the Fields**, map the Catalogue fields to the destination fields under **Output Identifiers Mapping**. To change which identifiers are sent, refer to [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). d. Click **Create Destination**. The created destination gets listed in the **Audiences** application, where it can be linked to an audience or segment. ![The Mapping step with Choose your Action set to Send identifiers to Adobe Analytics and an Output Identifiers Mapping row under Map the Fields](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/google-ad-manager/Adobe_Analytics_2.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=65b666a0aaca4f1377d9bb3f67c6e0b7) ## Link an audience to the destination For information about how to link an audience or segment to the created destination in the **Audiences** application, see [Activate Your Batch Audiences](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > **Note:** > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience or a segment can be a specific group of customers who are over 18 years of age and have performed an `addToCart` event within the last 30 days. ## Verify the delivery After you link an audience to the destination, open the destination in Zeotap CDP and review its activity. A successful delivery records a run with a completed status and a non-zero qualified count; a run that fails records an error message you can use to diagnose the cause. Then confirm the data arrived on the Adobe Analytics side. The two counts will not match exactly — every platform applies its own match-rate filtering on the identifiers it receives — but both should be non-zero. For the full verification routine and the delivery errors that can surface on an audience–destination pair, see [Destinations](/articles/integrate-customer/destinations#verify-the-activation-worked). ## Next steps * [Link an audience to this destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Review why destination deliveries fail →](/articles/integrate-customer/destinations#why-deliveries-fail) * [Choose the output identifiers sent in the mapping →](/articles/segment-customer/choose-the-output-identifiers) * [Bring Adobe-side web events into Zeotap CDP →](/articles/integrate-customer/adobe-experience-platform-tag-extension) # Adobe Campaign (Audiences) Source: https://docs.zeotap.com/articles/integrate-customer/adobe-campaign Send an audience out of Zeotap CDP to the Amazon S3 bucket or Azure container that Adobe Campaign reads, then load the delivered CSV files into Adobe Campaign. ## What this is This is an outbound destination: data flows **out of Zeotap CDP** to Adobe Campaign, and nothing flows back from Adobe Campaign into the CDP. Zeotap CDP writes the audience you link to the destination into the Amazon S3 bucket or Azure container you nominate, as CSV files. Adobe Campaign then picks those files up through the external account you connected to that same storage, and a workflow in Adobe Campaign loads them into a Recipients folder. Adobe Campaign is a marketing automation platform that helps businesses manage and deliver targeted email, mobile and social media campaigns. Integrated with Zeotap CDP, you can use audiences built in Zeotap CDP to create, test and personalise campaigns across channels, and track their performance and impact. Adobe Campaign also has a real-time destination, which sends customers from a journey rather than from a linked audience. If you want a journey-triggered delivery instead of a scheduled audience delivery, see [Adobe Campaign real-time integration](/articles/integrate-customer/adobe-campaign-real-time-integration). Adobe Campaign appears in the [integrations master list](/articles/integrations-master-list-publication/integrations-master-list) as a destination only, so there is no Adobe Campaign source page to pair this one with. ## Supported identifiers and actions This integration supports raw email addresses and Custom IDs. It exposes a single action, which you choose when you define the mapping: | Action | What it sends | | - | - | | **Send multiple identifiers to Adobe Campaign** | Raw email addresses and Custom IDs. You can map fields while sending Custom IDs. | The **Choose your Action** list also offers **Send multiple identifiers to Adobe Campaign in Journeys**. That action belongs to the [Adobe Campaign real-time integration](/articles/integrate-customer/adobe-campaign-real-time-integration), not to this one. ## Prerequisites Before you create the destination, make sure you have: * An Adobe Campaign account, with an [external account created in Adobe Campaign](https://experienceleague.adobe.com/docs/campaign-classic/using/installing-campaign-classic/accessing-external-database/external-accounts.html?lang=en#creating-an-external-account) and that [external account connected to your cloud storage](https://experienceleague.adobe.com/docs/campaign-classic/using/installing-campaign-classic/accessing-external-database/configure-fda/connecting-to-database.html?lang=en). The integration supports the following upload/connection types: * **Amazon (AWS) S3** * **Azure** * The details of that storage to hand, so you can enter them when you create the destination: * For **S3** — the bucket name, the geographical region the bucket is in, the folder path, and the Access Key ID and Secret Access Key of the S3 account, which you enter as **Client Id** and **Client Secret**. * For **Azure** — the container, the folder path, and the RSA-formatted public key used to add PGP/GPG encryption to the exported files, written as a Base64 encoded string. * An audience defined with the criteria for the cohort you want to activate. See [Create an Audience](/articles/segment-customer/create-an-audience). * The upstream setup and destination rights described in the [Destinations prerequisites](/articles/integrate-customer/destinations#prerequisites). ## Create the Adobe Campaign destination **Step 1** Log into the Zeotap CDP App and go to the **Destinations** application. **Step 2** Click **+ Create Destination**. ![The Destinations listing with the Private Destination and Public Destination tabs, a destination search box, and the + Create Destination button highlighted above the list of existing destinations.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/ADOBE_DMP_3.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=50d0558618336ceb78709191fcdda472) **Step 3** Under **All Destinations**, search for **Adobe Campaign**. ![The All Destinations catalogue with the Search for a Destination box highlighted, above cards for Adform, Adform DMP, Adobe Analytics, Adobe Campaign, Adobe DMP, Adobe Marketo Static Lists, Adobe Marketplace and Adobe Target.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/ADOBE_DMP_4.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=a0de06ff7f37752957c9f44c072aaebd) **Step 4** Click **Adobe Campaign**. The **Enter Destination Details** screen describes the destination on the left and lists the fields the integration needs on the right. a. Enter a **Destination Name**. b. Provide the **Client Name**. c. Choose the **Upload Type** from the drop-down menu, then fill in the fields for the storage you chose. **If you choose S3**, provide the following details of your Amazon S3 storage: * In the **Bucket** field, provide the name of the Amazon S3 bucket. * In the **S3 Bucket Region** field, provide the geographical region where your Amazon S3 bucket is available. * In the **Folder** field, provide the folder path in your storage location where Zeotap CDP can store your exported data. * Enter the **Client Id** and **Client Secret** obtained from your Amazon S3 account — the Access Key ID and Secret Access Key respectively. * Under **Filename Prefix**, enter a plain text value. Each delivered file name is built from this prefix together with the `channelId` — the ID associated with your audience (segment) in Zeotap CDP, generated after the audience is linked to a destination — a part number, and a timestamp in epoch format. Read the exact file name off the file that lands in your storage: you need it when you set the **Server folder** value in [File transfer](#file-transfer). ![The Enter Destination Details step with Upload Type set to S3 and highlighted, showing the Destination Name, Client Name, Bucket, S3 Bucket region, Folder, Client Id and Client Secret fields filled with placeholder values.](https://mintcdn.com/zeotap/YNdtFkydSZ-00_Bc/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/adobe_campaign_1.png?fit=max\&auto=format\&n=YNdtFkydSZ-00_Bc\&q=85\&s=6462710944a7ecc105bef4d1f37d8a91) **If you choose Azure**, provide the following details of your Azure storage: * In the **Container** field, provide the container details that hold your folder path. * In the **Folder** field, provide the path in your storage location where Zeotap CDP can store your export data as CSV files. * In the **Key** field, provide the RSA-formatted public key to add encryption with PGP/GPG to your exported files. Ensure that your public key is written as a Base64 encoded string. * Under **Filename Prefix**, enter a plain text value. Each delivered file name is built from this prefix together with the `channelId`, a part number, and a timestamp in epoch format. Read the exact file name off the file that lands in your storage: you need it when you set the **Server folder** value in [File transfer](#file-transfer). ![The Enter Destination Details step with Upload Type set to AZURE and highlighted, showing the Destination Name, Client Name, Container, Folder and Key fields filled with placeholder values.](https://mintcdn.com/zeotap/YNdtFkydSZ-00_Bc/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/adobe_campaign_3.png?fit=max\&auto=format\&n=YNdtFkydSZ-00_Bc\&q=85\&s=7197ffc1a24e368e6e8acfd6f9d45457) d. Review all the values entered above, then click **Next**. **Step 5** On the **Mapping** screen, choose the [action](/articles/integrate-customer/destinations#configure-a-destination) and the mapping. Under **Choose your Action**, select **Send multiple identifiers to Adobe Campaign** as the action for activating your audience (segment) in **Audiences**. The action sends raw email addresses and Custom IDs to Adobe Campaign. You can map fields while sending Custom IDs. ![The Map the Fields step under Output Identifiers Mapping, with an Email Raw catalogue field mapped to Email and a second catalogue field mapped to custom ID, above the + Add Mapping Field link.](https://mintcdn.com/zeotap/YNdtFkydSZ-00_Bc/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/campaign_send_multi_id_2.png?fit=max\&auto=format\&n=YNdtFkydSZ-00_Bc\&q=85\&s=3f2dc816e37b265a6c57e74eb2a7953d) **Step 6** Click **Create Destination**. The created destination is listed in the **Audiences** application, ready to be linked to an audience or segment. > [!NOTE] > > The destination form notes that it can take up to two business days for segments to be available at the Adobe Campaign private channel seat, so a newly created destination may not produce a visible result immediately. For the general behaviour of actions and mappings across destinations, see [Configure a destination](/articles/integrate-customer/destinations#configure-a-destination) and [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). ## Link an audience to the destination For how to link an audience or segment to the created destination in the **Audiences** application, see [Activate Your Batch Audiences](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > Keep the following in mind when linking an audience (segment) to Adobe Campaign: > > * The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. > * Each file must contain a maximum of one million email IDs and custom IDs together. Zeotap CDP splits a larger audience across several files: a list of 3 million email IDs and custom IDs arrives as three files, each holding at most 1 million records. > * After an audience is linked to a destination, Zeotap CDP generates the segment as one or more CSV files in the folder you configured, each carrying the filename prefix you set and a part number. ## Download the files from cloud storage to Adobe Campaign Once you push the audiences or segments from Zeotap CDP, they are stored in the cloud storage (S3 or Azure) that you specified in the destination. You then download the data from that storage into Adobe Campaign in two stages: 1. [Add a folder for the audience](#add-a-folder-for-the-audience) 2. [Create a workflow in Adobe Campaign](#create-a-workflow-in-adobe-campaign) ### Add a folder for the audience **Step 1** Log into **Adobe Campaign Classic**. **Step 2** Under **Explorer**, navigate to **Profiles and Targets** > **Add new folder** > **Database** > **Recipients**. > [!NOTE] > > For easy identification, name the folder after the audience or segment. ![The Adobe Campaign Classic Explorer with Profiles and Targets right-clicked, the Add new folder submenu open, Database highlighted and Recipients selected in the final submenu.](https://mintcdn.com/zeotap/YNdtFkydSZ-00_Bc/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/adobe-campaign-2023-11-21-6.png?fit=max\&auto=format\&n=YNdtFkydSZ-00_Bc\&q=85\&s=a662a1c9dafa40150ca7c1ec261ef4b6) **Step 3** The new folder is created under **Profiles and Targets**, with an empty recipient list. ![The Adobe Campaign Classic Explorer with the newly created recipient folder selected under Profiles and Targets, showing an empty recipient list and a blank Recipient detail pane.](https://mintcdn.com/zeotap/YNdtFkydSZ-00_Bc/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/adobe-campaign-2023-11-21-7.png?fit=max\&auto=format\&n=YNdtFkydSZ-00_Bc\&q=85\&s=7ab57552f55b75d4785facf08136b2c1) ### Create a workflow in Adobe Campaign ![An Adobe Campaign Classic workflow diagram running from Start through File transfer and Data loading (file) to Update data, with the Targeting activity palette on the left.](https://mintcdn.com/zeotap/YNdtFkydSZ-00_Bc/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/adobe-campaign-2023-11-21-8.png?fit=max\&auto=format\&n=YNdtFkydSZ-00_Bc\&q=85\&s=0cbc7f99ccdb557a29c64bbd68172005) A workflow in Adobe Campaign is a series of steps or tasks designed to automate and optimise marketing processes. For more information about how to create a workflow and design the workflow diagram, see [Build a workflow](https://experienceleague.adobe.com/docs/campaign/automation/workflows/introduction/build-a-workflow.html?lang=en) in the Adobe documentation. The workflow needs three activities: 1. [File transfer](#file-transfer) 2. [Data loading (file)](#data-loading-file) 3. [Update data](#update-data) > [!NOTE] > > Configure each activity individually by clicking on it in the workflow diagram, as described below. #### File transfer Click **File transfer** on the workflow diagram and configure the **File transfer** tab: **Step 1** Choose **Action** as **File download** using the drop-down menu. **Step 2** Under **Remote server**, ensure that the **Use an external account** checkbox is selected. a. Choose the desired **External account** using the drop-down menu. b. Set the **Server folder** value as shown in the screenshot below, then click **Ok**. ![The File transfer activity's File transfer tab, with Action set to File download, the Use an external account checkbox selected, an external account chosen, and the Server folder field populated with a CSV file name.](https://mintcdn.com/zeotap/YNdtFkydSZ-00_Bc/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/adobe-campaign-2023-11-21-9.png?fit=max\&auto=format\&n=YNdtFkydSZ-00_Bc\&q=85\&s=d1599eb449ee3a1a9d6ccd6df40375a1) #### Data loading (file) Click **Data loading (file)** on the workflow diagram and configure the **Data** tab. The steps differ slightly depending on whether the delivered file carries email addresses only, or email addresses and custom IDs. **Loading a file that contains only email addresses** **Step 1** Under **Sample file**, provide the path of a sample CSV file containing sample email addresses from your local drive. **Step 2** Select the **Use a sample file on the local computer** and **Use a line number as identifier** checkboxes. **Step 3** Under **Name of the file to load**, select **Specified in the transition**. **Step 4** Under **Target database**, select **Default**. **Step 5** Click **Ok**. > [!NOTE] > > You can preview the data in the sample file under the **Preview** section. ![The Data loading (file) activity's Data tab, with a sample CSV file selected, both sample-file checkboxes ticked, a Preview pane listing an email column with two example addresses, Specified in the transition chosen under Name of the file to load, and Default chosen under Target database.](https://mintcdn.com/zeotap/kl8L6sBUYwhq5T7t/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/adobe-campaign-2023-11-21-10.png?fit=max\&auto=format\&n=kl8L6sBUYwhq5T7t\&q=85\&s=63328dbe6971a4f844e260f84d516cbe) **Loading a file that contains email addresses and custom IDs** **Step 1** Under **Sample file**, provide the path of a sample CSV file containing sample email addresses and custom IDs from your local drive. **Step 2** Select the **Use a sample file on the local computer** and **Use a line number as identifier** checkboxes. **Step 3** Click **Auto-Detect format** to preview the uploaded sample file. **Step 4** Under **Name of the file to load**, select **Specified in the transition**. **Step 5** Under **Target database**, select **Default**. **Step 6** Click **Ok**. > [!NOTE] > > You can preview the data in the sample file under the **Preview** section. ![The Data loading (file) activity's Data tab with a two-column sample file selected, the Preview pane showing an email column and a custom ID column with two example rows, and Specified in the transition and Default selected below.](https://mintcdn.com/zeotap/YNdtFkydSZ-00_Bc/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/data_load_1_\(1\).png?fit=max\&auto=format\&n=YNdtFkydSZ-00_Bc\&q=85\&s=7a7ea9a90a024fc365a7c2d6b9e7b8c0) #### Update data Click **Update data** on the workflow diagram and configure the **Update data** tab. Again, the mapping differs depending on what the delivered file carries. **Updating data that contains only email addresses** **Step 1** Choose the appropriate **Operation type** using the drop-down menu. **Step 2** Set **Batch size** to 1,000,000 (one million). **Step 3** Under **Fields to update**, add the email address and the folder, using the **Add** icon to the right of the grid. **Step 4** Once your configuration is complete, click **Ok**. ![The Update data activity with Operation type set to Insert, a batch size entered, Recipients as the updated dimension, and a Fields to update grid holding an @email row and a folder row, with the Add icon highlighted at the right of the grid.](https://mintcdn.com/zeotap/5uegGRTZnAzLL6tY/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/image_\(101\).png?fit=max\&auto=format\&n=5uegGRTZnAzLL6tY\&q=85\&s=17c1b15129b18b47ab6156446fb19bb2) **Updating data that contains email addresses and custom IDs** **Step 1** Choose the appropriate **Operation type** using the drop-down menu. **Step 2** Set **Batch size** to 1,000,000 (one million). **Step 3** Under **Fields to update**, click **Add** to add a new row. ![The Update data activity's Fields to update grid with an @email row and a folder row already present, an empty row selected beneath them, and the Add tooltip showing on the icon at the right of the grid.](https://mintcdn.com/zeotap/5uegGRTZnAzLL6tY/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/update_data_2_\(1\)_nw_\(1\).png?fit=max\&auto=format\&n=5uegGRTZnAzLL6tY\&q=85\&s=d26f36798d1885cc813882f3904fd2d7) **Step 4** **Map the email address.** In the new row: 1. Click **Edit expression** under **Destination** (the left-hand side of the row). ![The Update data activity with an empty row in Fields to update and the Edit expression tooltip showing on the icon inside the Destination cell.](https://mintcdn.com/zeotap/YNdtFkydSZ-00_Bc/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/email_campaign_0.png?fit=max\&auto=format\&n=YNdtFkydSZ-00_Bc\&q=85\&s=ea724a3a20703cfb3b641444dde14236) 2. In the **Select a field from document 'Recipients'** window, search **Available fields** for Email. Choose **Email (@email)** and click **Ok**. ![The Select a field from document Recipients window with email typed in the Find box and Email (@email) selected at the top of the available fields list, above Email domain, Email format and other recipient fields.](https://mintcdn.com/zeotap/YNdtFkydSZ-00_Bc/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/email_campaign_1.png?fit=max\&auto=format\&n=YNdtFkydSZ-00_Bc\&q=85\&s=f0afe5eed7d0df3d513ad59365b996f3) 3. Under **Source expression** (the right-hand side of the row), click **Edit expression**. ![The Update data activity with the @email row in place and the Edit expression tooltip showing on the icon inside its Source expression cell.](https://mintcdn.com/zeotap/YNdtFkydSZ-00_Bc/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/email_campaign_3.png?fit=max\&auto=format\&n=YNdtFkydSZ-00_Bc\&q=85\&s=b9d4c5b228920b932a6efbd755c79e66) 4. In the **Select an expression** window, search **Available fields** for email, double-click **email** and click **Finish**. ![The Select an expression window titled Edit the expression, with an empty expression box, email typed in the Find box, the email field selected in the available fields list, and the List of functions panel on the right.](https://mintcdn.com/zeotap/YNdtFkydSZ-00_Bc/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/email_campaign_4.png?fit=max\&auto=format\&n=YNdtFkydSZ-00_Bc\&q=85\&s=50dad0eea475a619087b395b1aafb0ac) 5. The completed mapping appears in the grid. Click **Ok**. ![The Update data activity's Fields to update grid with a single completed row mapping the @email destination to the email source expression, highlighted.](https://mintcdn.com/zeotap/5uegGRTZnAzLL6tY/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/email_campaign_5.png?fit=max\&auto=format\&n=5uegGRTZnAzLL6tY\&q=85\&s=4aff7776554e7621ea1d43e261e43c61) **Step 5** **Map the custom ID.** Add another row, then: 1. Click **Edit expression** under **Destination** (the left-hand side of the row). ![The Update data activity with @email and folder rows already mapped, a third empty row added, and the Edit expression tooltip showing on the icon inside its Destination cell.](https://mintcdn.com/zeotap/5uegGRTZnAzLL6tY/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/update_data_3.png?fit=max\&auto=format\&n=5uegGRTZnAzLL6tY\&q=85\&s=a9c0de64fa842432011670692ee7ee87) 2. In the **Select a field from document 'Recipients'** window, search **Available fields** for Text. You can choose any option from **Text 1** to **Text 5** to map the custom ID. After choosing the Text field, click **Ok**. ![The Select a field from document Recipients window with text typed in the Find box and the Text 1 to Text 5 entries outlined in the available fields list, Text 1 (@text1) selected and the Ok button highlighted.](https://mintcdn.com/zeotap/5uegGRTZnAzLL6tY/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/update_data_4.png?fit=max\&auto=format\&n=5uegGRTZnAzLL6tY\&q=85\&s=0fe4810ae27d1787c67b216791b18ba5) 3. Under **Source expression** (the right-hand side of the row), click **Edit expression**. ![The Update data activity with a third row whose destination is @text1, and the Edit expression tooltip showing on the icon inside its empty Source expression cell.](https://mintcdn.com/zeotap/YNdtFkydSZ-00_Bc/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/data_update_5.png?fit=max\&auto=format\&n=YNdtFkydSZ-00_Bc\&q=85\&s=3d69d418b37ac796196fb81b9f918f1e) 4. In the **Select an expression** window, search **Available fields** for the custom ID, double-click it and click **Finish**. This custom ID must be exactly the same as the custom ID provided while creating the destination in Zeotap CDP. ![The Update data activity's Fields to update grid with three rows: @email mapped to email, folder mapped to a recipient folder, and @text1 mapped to the custom ID source expression, highlighted.](https://mintcdn.com/zeotap/5uegGRTZnAzLL6tY/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/update_data_5.png?fit=max\&auto=format\&n=5uegGRTZnAzLL6tY\&q=85\&s=de863e2022572e249617e5baec2de0b2) 5. The completed mapping appears in the grid. Click **Ok**. ![The Update data activity's Fields to update grid with the completed @text1 to custom ID row outlined, below the @email and folder rows.](https://mintcdn.com/zeotap/5uegGRTZnAzLL6tY/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/update_data_6.png?fit=max\&auto=format\&n=5uegGRTZnAzLL6tY\&q=85\&s=9d0c888eaadef408ebcc9f00d4bd4d3b) **Step 6** **Map the folder.** Add another row, then: 1. Click **Edit expression** under **Destination** (the left-hand side of the row). ![The Update data activity with the @email row mapped, an empty row added beneath it, and the Edit expression tooltip showing on the icon inside its Destination cell.](https://mintcdn.com/zeotap/5uegGRTZnAzLL6tY/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/folder_campaign_1.png?fit=max\&auto=format\&n=5uegGRTZnAzLL6tY\&q=85\&s=d0e003bc71f5abd753a0978a08bc3182) 2. In the **Select a field from document 'Recipients'** window, search **Available fields** for folder. Choose **Folder (folder)** and click **Ok**. ![The Select a field from document Recipients window with folder typed in the Find box and Folder (folder) selected in the available fields list, among Location, Postal address, Country/Region and other linked fields.](https://mintcdn.com/zeotap/5uegGRTZnAzLL6tY/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/folder_campain_2.png?fit=max\&auto=format\&n=5uegGRTZnAzLL6tY\&q=85\&s=d4c9e1c0018c6f178be4f06b9d97c61b) 3. Under **Source expression** (the right-hand side of the row), click **Select link**. ![The Update data activity with a folder destination row and the Select link tooltip showing on the folder icon inside its Source expression cell.](https://mintcdn.com/zeotap/5uegGRTZnAzLL6tY/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/folder_campaign_4.png?fit=max\&auto=format\&n=5uegGRTZnAzLL6tY\&q=85\&s=7ebca20d716ac0de7499171d287b487d) 4. In the **Please select a folder** window, select the folder you created in [Add a folder for the audience](#add-a-folder-for-the-audience). This folder holds the segments pushed from Zeotap CDP. ![The Please select a folder window showing the Adobe Campaign tree expanded at Profiles and Targets, with one of the recipient folders selected and a New folder link at the foot of the window.](https://mintcdn.com/zeotap/5uegGRTZnAzLL6tY/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/folder_campaign_5.png?fit=max\&auto=format\&n=5uegGRTZnAzLL6tY\&q=85\&s=9fe46696a9697b830eea8acdd2d3480a) 5. The completed mapping appears in the grid. Click **Ok**. ![The Update data activity's Fields to update grid with the completed folder row outlined, showing the selected recipient folder as its source expression, below the @email row.](https://mintcdn.com/zeotap/5uegGRTZnAzLL6tY/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/folder_campaign_6.png?fit=max\&auto=format\&n=5uegGRTZnAzLL6tY\&q=85\&s=2cdef78ad4df3a1f091a6467b50d51ce) **Step 7** Once all the fields are mapped, click **Run** to run the workflow. ![The workflow diagram with Start, File transfer, Data loading (file) and Update data nodes connected, the Update data node selected and the Run button highlighted in the toolbar.](https://mintcdn.com/zeotap/5uegGRTZnAzLL6tY/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/run_campaign.png?fit=max\&auto=format\&n=5uegGRTZnAzLL6tY\&q=85\&s=f885596b33b061b5ec48b5a8ed0fb4f1) ## Verify the audience in Adobe Campaign Check the delivery from both sides: * **In Zeotap CDP** — open the destination and review its activity, as described in [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). * **In your cloud storage** — open the folder you configured on the destination and confirm that CSV files are arriving with the filename prefix you set. * **In Adobe Campaign** — once the workflow has run, the delivered records appear in the Recipients folder you created. To view the pushed audiences (segments) in Adobe Campaign: **Step 1** Log into **Adobe Campaign Classic**. **Step 2** Under **Explorer**, select the folder you created in [Add a folder for the audience](#add-a-folder-for-the-audience). **Step 3** In the recipient detail pane, click **Other**. ![The Adobe Campaign Classic Explorer with a recipient folder open, listing six recipients by first name, last name and email, and the Recipient detail pane below with the Other tab available alongside General, Contact information, Lists, Subscriptions, Deliveries, Tracking and Propositions.](https://mintcdn.com/zeotap/kl8L6sBUYwhq5T7t/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/other_1.png?fit=max\&auto=format\&n=kl8L6sBUYwhq5T7t\&q=85\&s=39cccc260cdd12ed70440cbe92548381) **Step 4** Right-click on the list. In the menu that appears, click **Configure list...**. ![The recipient list with a right-click context menu open and Configure list highlighted above Export, Select all and the filter options; the Other tab below shows Text 1 to Text 5 and three Boolean fields.](https://mintcdn.com/zeotap/kl8L6sBUYwhq5T7t/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/other_2.png?fit=max\&auto=format\&n=kl8L6sBUYwhq5T7t\&q=85\&s=eb59d0373e14b382ea8bff22065c8cad) **Step 5** In the **List configuration** window, choose the mapped Text field to display in the UI and click **Ok**. ![The List configuration window on its Columns tab, with a Text field selected in Available fields and First name, Last name, Email and Account # already listed under Output columns.](https://mintcdn.com/zeotap/kl8L6sBUYwhq5T7t/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/other_3.png?fit=max\&auto=format\&n=kl8L6sBUYwhq5T7t\&q=85\&s=5a3de5120723f8e9b02168bd0a6467f5) **Step 6** The custom IDs appear under the mapped Text column. Rename that column to Custom ID — this custom ID must be the same as the custom ID provided while creating the destination in Zeotap CDP. ![The recipient list with a new Text 2 column outlined at the right, showing a short custom ID value for each of the six recipients.](https://mintcdn.com/zeotap/kl8L6sBUYwhq5T7t/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/other_4.png?fit=max\&auto=format\&n=kl8L6sBUYwhq5T7t\&q=85\&s=6fd3625086d865cd0e4ee58ee4476017) To rename the column: 1. Right-click on the list and click **Configure list...**. ![The recipient list, now including the Text 2 column, with the right-click context menu open and Configure list highlighted.](https://mintcdn.com/zeotap/kl8L6sBUYwhq5T7t/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/other_5.png?fit=max\&auto=format\&n=kl8L6sBUYwhq5T7t\&q=85\&s=b616975af16fb74c5c88551baea77d60) 2. Click the mapped Text field under **Label** and edit it. ![The List configuration window with the Text 2 entry in the Output columns Label column open for editing, its expression shown as Text 2 (@text2) alongside.](https://mintcdn.com/zeotap/kl8L6sBUYwhq5T7t/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/other_6.png?fit=max\&auto=format\&n=kl8L6sBUYwhq5T7t\&q=85\&s=f6bf465cc1b1e21871361e1f9ef5b9c0) 3. Rename it to **Custom ID** and click **Ok**. ![The List configuration window with the label edited to Custom ID in the Output columns list and the Ok button highlighted.](https://mintcdn.com/zeotap/kl8L6sBUYwhq5T7t/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/other_7.png?fit=max\&auto=format\&n=kl8L6sBUYwhq5T7t\&q=85\&s=4eb853013751e36cae2d44328f857173) **Step 7** The audiences or segments are displayed with the renamed column. ![The recipient list with the renamed Custom ID column outlined at the right, showing a custom ID value for each of the six recipients.](https://mintcdn.com/zeotap/kl8L6sBUYwhq5T7t/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/other_8.png?fit=max\&auto=format\&n=kl8L6sBUYwhq5T7t\&q=85\&s=b6e0c918192675d21e4f148886f24427) ## Troubleshoot the integration > [accordion] No files are arriving in the S3 bucket or Azure container > > Confirm the storage details on the destination: the **Bucket** or **Container**, the **Folder** path, and for S3 the **S3 Bucket Region** and the **Client Id** and **Client Secret** taken from your Amazon S3 account. Then confirm the audience is linked to the destination — see [Activate Your Batch Audiences](/articles/integrate-customer/link-an-audience-to-the-destination) — and review the destination's activity as described in [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). > [accordion] Files arrive in storage but Adobe Campaign does not see them > > This is on the Adobe Campaign side of the handover. Confirm that the external account you created in Adobe Campaign is connected to the same cloud storage, bucket or container and folder that the destination writes to, and that the **File transfer** activity in your workflow has **Use an external account** selected with that account chosen. > [accordion] The Filename Prefix is rejected > > The **Filename Prefix** must be a plain text value. Enter a plain text value and save the destination again. > [accordion] The Azure Key is rejected > > The **Key** field takes the RSA-formatted public key used to add PGP/GPG encryption to the exported files, and it must be written as a Base64 encoded string. Re-encode the public key and enter it again. > [accordion] The delivery is larger than one million records > > Each file must contain a maximum of one million email IDs and custom IDs together. Zeotap CDP splits the delivery automatically: a list of 3 million records arrives as three files of at most 1 million records each, distinguished by the part number in the file name. > [accordion] Custom IDs do not appear against the recipients in Adobe Campaign > > Two things have to line up. First, the custom ID mapped in the **Update data** activity must be exactly the same as the custom ID provided while creating the destination in Zeotap CDP. Second, the **Text 1** to **Text 5** field you mapped the custom ID into is not shown by default — add it as a column through **Configure list...**, as described in [Verify the audience in Adobe Campaign](#verify-the-audience-in-adobe-campaign). > [accordion] The destination records an error you do not recognise > > [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail) lists the errors that surface on a destination and what each one means, and [When to contact support](/articles/integrate-customer/destinations#when-to-contact-support) sets out what to include in a support request. ## FAQ > [accordion] Which Adobe Campaign integration should I use? > > Both are outbound destinations and both support raw email addresses and Custom IDs. Use this one when you want to link an audience to the destination in the **Audiences** application. Use [Adobe Campaign real-time integration](/articles/integrate-customer/adobe-campaign-real-time-integration) when the delivery should be driven by a journey in Journeys — customers are sent as they reach the **Send to Destinations** node. > [accordion] Do I still need an Adobe Campaign external account? > > Yes. Zeotap CDP writes CSV files into your own S3 bucket or Azure container; it does not push them into Adobe Campaign directly. Adobe Campaign reads them through the external account you created and connected to that storage, which is why the external account is a prerequisite for both Adobe Campaign integrations. > [accordion] How many custom ID fields can I send? > > You can map fields while sending Custom IDs with the **Send multiple identifiers to Adobe Campaign** action. ## Next steps > [card] [Adobe Campaign real-time integration](/articles/integrate-customer/adobe-campaign-real-time-integration) > > Send customers to Adobe Campaign from a journey instead of a linked audience. > [card] [Activate Your Batch Audiences](/articles/integrate-customer/link-an-audience-to-the-destination) > > Link an audience to this destination in the Audiences application. > [card] [Destinations](/articles/integrate-customer/destinations) > > How actions, mappings and destinations work across Zeotap CDP. > [card] [Integrations master list](/articles/integrations-master-list-publication/integrations-master-list) > > Browse every supported source and destination. # Adobe Campaign real-time integration Source: https://docs.zeotap.com/articles/integrate-customer/adobe-campaign-real-time-integration Send email addresses and Custom IDs out of a Zeotap CDP journey to the cloud storage that Adobe Campaign reads, as CSV files. ## What this is This is an outbound destination: data flows **out of Zeotap CDP** to Adobe Campaign, and nothing flows back from Adobe Campaign into the CDP. From a workflow in Journeys, Zeotap CDP writes the customers who reach a **Send to Destinations** node into the Amazon S3 bucket or Azure container you nominate, as CSV files. Adobe Campaign then picks those files up through the external account you connected to that same storage. Adobe Campaign is a marketing automation platform that helps businesses manage and deliver targeted email, mobile and social media campaigns. Integrated with Zeotap CDP, it lets marketers engage with customers in real time and at scale. Adobe Campaign also has a batch destination, which sends an audience from the **Audiences** application on a schedule rather than from a journey. If you want a scheduled audience delivery instead of a journey-triggered one, see [Adobe Campaign (Audiences)](/articles/integrate-customer/adobe-campaign). That page also walks through the Adobe Campaign side — adding a Recipients folder and building the Adobe Campaign workflow that loads the delivered files — which this page does not repeat. Adobe Campaign appears in the [integrations master list](/articles/integrations-master-list-publication/integrations-master-list) as a destination only, so there is no Adobe Campaign source page to pair this one with. You can enable batching on this destination to aggregate data before it is sent to Adobe Campaign. Batching is triggered by two factors — data size and processing time — whichever is met first. For example, if you set the batch size to 5 MB and the batch processing time to 2 minutes, the file is generated and sent when either condition is met. The maximum batch size is 10 MB and the maximum processing time is 15 minutes. ## Supported identifiers and actions This integration supports raw email addresses and Custom IDs. The action to choose for the Journeys lane is **Send multiple identifiers to Adobe Campaign in Journeys**. In the mapping for that action, the email address field is populated for you, and **+ Add Mapping Field** lets you add the Custom IDs you want to send. ## Prerequisites Before you create the destination, make sure you have: * An Adobe Campaign account, with an [external account created in Adobe Campaign](https://experienceleague.adobe.com/docs/campaign-classic/using/installing-campaign-classic/accessing-external-database/external-accounts.html?lang=en#creating-an-external-account) and that [external account connected to your cloud storage](https://experienceleague.adobe.com/docs/campaign-classic/using/installing-campaign-classic/accessing-external-database/configure-fda/connecting-to-database.html?lang=en). The integration supports the following upload/connection types: * **Amazon (AWS) S3** * **Azure** * The details of that storage to hand, so you can enter them when you create the destination: * For **S3** — the bucket name, the geographical region the bucket is in, the folder path, and the Access Key ID and Secret Access Key of the S3 account, which you enter as **Client Id** and **Client Secret**. * For **Azure** — the container, the folder path, and the RSA-formatted public key used to add PGP/GPG encryption to the exported files, written as a Base64 encoded string. * The **Client Name** you want the destination to carry. * A workflow in Journeys with the filters or conditions that select the customers you want to send. See [Create a Workflow](/articles/orchestrate-customer/create-a-workflow). * The destination rights described in the [Destinations prerequisites](/articles/integrate-customer/destinations#prerequisites). ## Create the Adobe Campaign destination Once you have applied filters or added conditions for your users in Journeys, you activate them from the **Send to Destinations** node in the workflow. ![The Choose an action menu on a journey node, with Send to Destinations highlighted and its tooltip explaining that the action forwards customer data to channels.](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=8ed8abd70040c3e575c94c98ad4e6956) The node opens a panel where you can pick a destination that already exists in your workspace or create a new one with **+ Add New Destination**. ![The Send to Destinations panel, showing a search box above a grid of cards for destinations that already exist in the workspace, with the + Add New Destination link above them.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-25.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=9436e6620f33e4a53c427900a718e9a2) To create the destination: **Step 1** Click **+ Add New Destination**. ![The Send to Destinations panel with the + Add New Destination link highlighted above the search box and the existing destination cards.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26-1.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=45aec566d6937bbb28613e4b880207c4) **Step 2** Search for **Adobe Campaign**. **Step 3** Click **Adobe Campaign**, enter a name for the destination, and enter the **Client Name**. **Step 4** Choose the **Upload Type** from the drop-down menu, then fill in the fields for the storage you chose. **If you choose S3**, provide the following details of your Amazon S3 storage: a. In the **Bucket** field, provide the name of the Amazon S3 bucket. b. In the **S3 Bucket Region** field, provide the geographical region where your Amazon S3 bucket is available. c. In the **Folder** field, provide the folder path in your storage location where Zeotap CDP can store your exported data. d. Enter the **Client Id** and **Client Secret** obtained from your Amazon S3 account — the Access Key ID and Secret Access Key respectively. e. Under **Filename Prefix**, enter a text value without special characters, such as underscores (\_), spaces, or symbols (#, @, $, %, &, \*). The file name follows the format `{filenamePrefix}{fileNumber}_$\_\$.csv\`, where the timestamp is in epoch format. ![The Enter Destination Details step with Upload Type set to S3 and highlighted; the Destination Name, Client Name, Bucket and S3 Bucket region fields are visible, and the form continues below the Folder label.](https://mintcdn.com/zeotap/YNdtFkydSZ-00_Bc/articles/integrate-customer/Storage/integrate-customer/adobe-campaign-real-time-integration/adobe-campaign-real-time-integration-2024-10-18-2.png?fit=max\&auto=format\&n=YNdtFkydSZ-00_Bc\&q=85\&s=e30beb8db794c2e49ec7044c4b5ff50f) **If you choose Azure**, provide the following details of your Azure storage: a. In the **Container** field, provide the container details that hold your folder path. b. In the **Folder** field, provide the path in your storage location where Zeotap CDP can store your export data as CSV files. c. In the **Key** field, provide the RSA-formatted public key to add encryption with PGP/GPG to your exported files. Ensure that your public key is written as a Base64 encoded string. d. Under **Filename Prefix**, enter a text value without special characters. The file name follows the format `{filenamePrefix}{fileNumber}_${channelId}_${timestamp}.csv`, where the timestamp is in epoch format. ![The Enter Destination Details step with Upload Type set to AZURE and highlighted; the Destination Name, Client Name and Container fields are visible, and the form continues below the Folder and Key labels.](https://mintcdn.com/zeotap/YNdtFkydSZ-00_Bc/articles/integrate-customer/Storage/integrate-customer/adobe-campaign-real-time-integration/adobe-campaign-real-time-integration-2024-10-18-1.png?fit=max\&auto=format\&n=YNdtFkydSZ-00_Bc\&q=85\&s=474ed4c8ab97bd346362eae5dea667a6) **Step 5** Review all the values entered above and then click **Next** to proceed. **Step 6** On the mapping screen: a. Under **Choose your Action**, select **Send multiple identifiers to Adobe Campaign in Journeys** as the action for sending data from the workflow created in Journeys. b. Under **Map the Fields**, the email address is already populated. Use **+ Add Mapping Field** to add any Custom IDs you want to send to Adobe Campaign. c. Select the **Enable Batching** checkbox if you want to aggregate data before it is sent. Set **Batch Size** and **Batch Duration**; whichever threshold is met first triggers the file. The maximum batch size is currently 10 MB and the maximum processing time is 15 minutes. ![The Mapping step, with the action Send multiple identifiers to Adobe Campaign in Journeys selected, an Email Raw catalogue field mapped to the Email destination field, and the Enable Batching checkbox selected above the Batch Size and Batch Duration settings.](https://mintcdn.com/zeotap/YNdtFkydSZ-00_Bc/articles/integrate-customer/Storage/integrate-customer/adobe-campaign-real-time-integration/adobe-campaign-real-time-integration-2024-10-18-3.png?fit=max\&auto=format\&n=YNdtFkydSZ-00_Bc\&q=85\&s=3452c1507d4a50be5d8b573cc0d8e1dd) **Step 7** Once all the fields are entered, click **Create Destination**. The destination is created and made available for activation in Journeys. ![The Send to Destinations panel with the newly created Adobe Campaign destination card highlighted alongside the other available destination cards.](https://mintcdn.com/zeotap/YNdtFkydSZ-00_Bc/articles/integrate-customer/Storage/integrate-customer/adobe-campaign-real-time-integration/adobe-campaign-real-time-integration-2024-10-18-4.png?fit=max\&auto=format\&n=YNdtFkydSZ-00_Bc\&q=85\&s=c30453b9412a408e786601ef9ef23516) > [!NOTE] > > The destination form notes that it can take up to two business days for segments to be available at the Adobe Campaign private channel seat, so a newly created destination may not produce a visible result immediately. For the general behaviour of actions and mappings across destinations, see [Configure a destination](/articles/integrate-customer/destinations#configure-a-destination) and [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). ## Add the destination to your journey After creating the destination, link it in the **Send to Destinations** node within the workflow. **Step 1** Click the destination you created from the list of available destinations. ![The Send to Destinations panel with the Adobe Campaign destination card highlighted, ready to be selected.](https://mintcdn.com/zeotap/YNdtFkydSZ-00_Bc/articles/integrate-customer/Storage/integrate-customer/adobe-campaign-real-time-integration/adobe-campaign-real-time-integration-2024-10-18-4.png?fit=max\&auto=format\&n=YNdtFkydSZ-00_Bc\&q=85\&s=c30453b9412a408e786601ef9ef23516) **Step 2** On the **Destination Details** tab, the Client Name, Upload Type, the storage fields for that upload type, and the Filename Prefix are filled in automatically from the values you entered when you created the destination. Enter the **Audience Name** to save the destination. ![The Destination Details tab scrolled to the read-only Key and Filename Prefix fields, with the editable Audience Name field highlighted above the Save Destination button.](https://mintcdn.com/zeotap/YNdtFkydSZ-00_Bc/articles/integrate-customer/Storage/integrate-customer/adobe-campaign-real-time-integration/adobe-campaign-real-time-integration-2024-10-18-6.png?fit=max\&auto=format\&n=YNdtFkydSZ-00_Bc\&q=85\&s=0b46da8fd6e099d63fb6cb77a785052b) **Step 3** On the **Destination Settings** tab, choose the action and mapping you need. **Step 4** Click **Save Destination**. The destination is attached to the node. ![The Send to Destinations node with the Adobe Campaign destination attached, showing the attached mapping, labelled Untitled Mapping, for the action Send multiple identifiers to Adobe Campaign in Journeys, above the remaining available destinations.](https://mintcdn.com/zeotap/YNdtFkydSZ-00_Bc/articles/integrate-customer/Storage/integrate-customer/adobe-campaign-real-time-integration/adobe-campaign-real-time-integration-2024-10-18-7.png?fit=max\&auto=format\&n=YNdtFkydSZ-00_Bc\&q=85\&s=e2aae56d50d293267f91c403eb3af5e6) **Step 5** Click **Add Destinations**. You can also add multiple destinations at this step if needed. **Step 6** The linked destination appears in the **Send to Destinations** node within the workflow. You can then build and customise your workflow as needed by clicking **+**. You must enter a name for your workflow in the provided text box to save it. ![A named workflow on the journey canvas, running from Start Workflow through an attribute node and an event node to a Send to Destination node, with Cancel, Save Draft and Next: Define Re-entry Criteria at the foot of the screen.](https://mintcdn.com/zeotap/YNdtFkydSZ-00_Bc/articles/integrate-customer/Storage/integrate-customer/adobe-campaign-real-time-integration/adobe-campaign-real-time-integration-2024-10-18-8.png?fit=max\&auto=format\&n=YNdtFkydSZ-00_Bc\&q=85\&s=4fdb657f221169c5a2a17cb2520e3349) **Step 7** After adding conditions and filters for users, choose one of the following options: * **Save Draft** — lets you revisit and edit the workflow before publishing. * **Next: Define Re-entry Criteria** — determines whether a user can re-enter the same workflow. **Step 8** After defining the re-entry criteria, click **Publish Workflow**. The workflow appears in the workflow listing screen with a **Published** status. ![The journey re-entry conditions panel, asking whether a user may re-enter the journey, with Cancel, Save Draft and Publish Workflow buttons.](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26-8.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=634ab0c131fbe99396837bc9f7b8fc91) > [!NOTE] > > The terms Audiences and Segments are used interchangeably to refer to customer cohorts belonging to a specific category. ## Verify the delivery Check the delivery from both sides: * **In Zeotap CDP** — use [Journey traces](/articles/orchestrate-customer/journey-traces) to confirm that customers reached the **Send to Destinations** node, then open the destination itself and review its activity — see [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked) for what a successful run records. * **In your cloud storage** — open the folder you configured on the destination and confirm that CSV files are arriving with the filename prefix you set. * **In Adobe Campaign** — once the Adobe Campaign workflow has loaded the files, the delivered records appear in the Recipients folder you created. [Adobe Campaign (Audiences)](/articles/integrate-customer/adobe-campaign) shows how to view them. Two things to keep in mind while checking: * With batching enabled, a file is only written once the batch size or the batch duration you configured is reached, so an empty folder immediately after a journey run is not necessarily a failure. * The destination form states that segments can take up to two business days to be available at the Adobe Campaign private channel seat. ## Troubleshoot the integration > [accordion] The destination does not appear in the Send to Destinations node > > The destination has to exist before you can attach it. Create it first with **+ Add New Destination** in the node's panel, as described in [Create the Adobe Campaign destination](#create-the-adobe-campaign-destination), then look for it again in the list. > [accordion] No files are arriving in the S3 bucket or Azure container > > Work through the delivery in order. Use [Journey traces](/articles/orchestrate-customer/journey-traces) to confirm customers are reaching the **Send to Destinations** node at all. If they are, check that batching is not simply still accumulating — with **Enable Batching** selected, nothing is written until the batch size or the batch duration is reached. Then confirm the storage details on the destination: the bucket or container, the folder path, and for S3 the region and the **Client Id** and **Client Secret** taken from your Amazon S3 account. > [accordion] Files arrive in storage but Adobe Campaign does not see them > > This is on the Adobe Campaign side of the handover. Confirm that the external account you created in Adobe Campaign is connected to the same cloud storage, bucket or container and folder that the destination writes to, and that the Adobe Campaign workflow that transfers and loads the files is configured against that external account. [Adobe Campaign (Audiences)](/articles/integrate-customer/adobe-campaign) documents that workflow. > [accordion] What the Azure Key field expects > > The **Key** field takes the RSA-formatted public key used to add PGP/GPG encryption to the exported files, and it must be written as a Base64 encoded string. > [accordion] Customers are not reaching the node at all > > This is a journey problem rather than a destination one. See [Journey troubleshooting](/articles/orchestrate-customer/journey-troubleshooting) and [Journey error codes](/articles/orchestrate-customer/journey-error-codes). > [accordion] The destination records an error you do not recognise > > [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail) explains the errors a destination can record and what each one means; the rows describing an audience refresh do not apply to a journey-driven delivery. [When to contact support](/articles/integrate-customer/destinations#when-to-contact-support) sets out what to include in a support request; the audience and audience–destination pair identifiers it asks for do not exist for a journey-driven delivery. ## FAQ > [accordion] Which Adobe Campaign integration should I use? > > Both are outbound destinations and both support raw email addresses and Custom IDs. Use this one when the delivery should be driven by a journey in Journeys — customers are sent as they reach the **Send to Destinations** node. Use [Adobe Campaign (Audiences)](/articles/integrate-customer/adobe-campaign) when you want to link an audience to the destination in the **Audiences** application and have it delivered on a schedule. > [accordion] Does enabling batching turn this into a batch integration? > > No. Batching only aggregates the records that a journey produces before they are written, so that a run does not generate a file per customer. The file is written when either the batch size or the batch duration is reached, whichever comes first, up to a maximum of 10 MB and 15 minutes. The trigger is still the journey. > [accordion] Do I still need an Adobe Campaign external account for this lane? > > Yes. Zeotap CDP writes CSV files into your own S3 bucket or Azure container; it does not push them into Adobe Campaign directly. Adobe Campaign reads them through the external account you created and connected to that storage, which is why the external account is a prerequisite for both the journey lane and the audience lane. ## Next steps > [card] [Adobe Campaign (Audiences)](/articles/integrate-customer/adobe-campaign) > > Send an audience to Adobe Campaign from the Audiences application, and set up the Adobe Campaign workflow that loads the delivered files. > [card] [Destinations](/articles/integrate-customer/destinations) > > How actions, mappings and destinations work across Zeotap CDP. > [card] [Create a Workflow](/articles/orchestrate-customer/create-a-workflow) > > Build the journey whose Send to Destinations node feeds this integration. > [card] [Journey traces](/articles/orchestrate-customer/journey-traces) > > Trace individual customers through a journey to confirm a delivery happened. # Adobe Experience Platform Tag Extension Source: https://docs.zeotap.com/articles/integrate-customer/adobe-experience-platform-tag-extension Bring website events, user identities, and consent signals into Zeotap CDP using the Zeotap Collect Tag Extension for Adobe Experience Platform Tags. ## What this is The Adobe Experience Platform Tag Extension is a **source**: it brings website events and user identities from your site **into** Zeotap CDP. Adobe Experience Platform provides a way to deploy and manage the analytics, marketing, and advertising tags that power customer experiences, and those tags are offered to Adobe Experience Cloud customers as an included, value-add feature. Zeotap publishes the **Zeotap Collect Tag Extension** in the Adobe Experience Platform marketplace to capture events and user identities and to enable cookie syncing on the web. If you already manage your website tags in Adobe Experience Platform Tags (Adobe Launch), this source adds Zeotap as one more extension inside that property. You create the source in Zeotap CDP to obtain a write key, then install and configure the extension in your Adobe Launch property and build rules that send events and identities to Zeotap. This page covers what the source is and when to choose it. The [create](/articles/integrate-customer/create-an-adobe-experience-platform-tag-extension-source) and [implement](/articles/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source) pages cover the configuration in full. ## Prerequisites > [!NOTE] > > Before you begin, confirm the following: > > * You have access to the **Sources** application in the Zeotap CDP App with permission to create a source. > * You have access to Adobe Experience Platform Tags (Adobe Launch) with edit permissions, and a published Adobe Launch property for your website. > * You are familiar with the Adobe Launch building blocks this integration uses — tags, extensions, rules, and data elements. See the [Adobe Launch integration guide](/articles/sdks/adobe-launch/intro). > * You know which region of upload your data must be stored in. See [Region of storage](/articles/integrate-customer/region-of-storage). This source is created with **Customer Data** as the Data Entity. ## When to use this source Choose the Adobe Experience Platform Tag Extension when Adobe Launch is the tag manager that already governs your website, and you want Zeotap to receive the same events and identities through that existing deployment rather than through a separate tag rollout. Choose a different source when: * **Google Tag Manager is your tag manager** — use the [Google Tag Manager](/articles/integrate-customer/google-tag-manager) source instead. Both are listed under [Tag Managers (CE)](/articles/integrate-customer/tag-managers). * **You want to send events from your own backend rather than the browser** — see the other categories on the [Sources](/articles/integrate-customer/sources) overview. **A worked example.** A financial services company that manages its site tags in Adobe Launch installs the Zeotap Collect Tag Extension in the same property. Rules in Adobe Launch capture page views, custom events such as an add-to-cart action, and the logged-in user's identifiers across the company's digital touchpoints, and those records flow into Zeotap CDP against a unified profile. The company then uses that profile data to analyse user behaviour, build audiences, and personalise its campaigns. Cookie syncing keeps the company's web identifiers aligned with Zeotap's integrated partners for downstream targeting. ## What the extension captures Once the extension is configured and your rules are live, the source can send the following to Zeotap CDP: * **Events** — page views, user attributes, and custom events, each carrying key-value pairs that you define in the rule's action configuration. * **User identities** — raw or hashed personally identifiable information such as email address, cell phone number, login ID, and first-party ID, plus custom identities such as `crmID`, `ECID`, and `visitorID`. * **Consent signals** — the extension can take consent from a default opt-in setting, from your own custom consent flow, or from a TCF 2.0 Consent Management Platform on your site. * **Cookie syncs** — cookie syncing with Zeotap's integrated partners is enabled by default for the Zeotap Collect Extension. To restrict or disable it, contact your Zeotap representative or Zeotap Support. The [implement](/articles/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source) page lists the supported identifier fields and hashing formats in full. ## Set up the source 1. **[Create the source](/articles/integrate-customer/create-an-adobe-experience-platform-tag-extension-source)** in the Sources application. Choose **Tag Managers** as the category and **Adobe Experience Platform Tag Extension** as the data source. Zeotap auto-generates a **write key** for the source — you need it in the next step. 2. **[Implement the source](/articles/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source)** in Adobe Launch: install the Zeotap Collect Extension, enter the write key, choose a consent method and identity handling, and create the rules that load the SDK, track events, and sync identities. The step-by-step Adobe Launch walkthrough lives in the [Adobe Launch integration guide](/articles/sdks/adobe-launch/intro) — [installation](/articles/sdks/adobe-launch/installation), [configuration](/articles/sdks/adobe-launch/configure), and [actions](/articles/sdks/adobe-launch/actions/overview). 3. **Confirm data is arriving.** Once the source is live, open its **PREVIEW DATA** tab to see incoming records. See [Knowing the fields on the Preview Data tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab). ## Next steps > [card] [Create the source](/articles/integrate-customer/create-an-adobe-experience-platform-tag-extension-source) > [card] [Implement the source](/articles/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source) > [card] [Adobe Launch integration guide](/articles/sdks/adobe-launch/intro) > [card] [All tag manager sources](/articles/integrate-customer/tag-managers) # Adobe Target Source: https://docs.zeotap.com/articles/integrate-customer/adobe-target Adobe Target is a Zeotap CDP destination. Compare the three Adobe Target integrations, Bulk Profile Update, Delivery API and Single Profile Update, and pick the one that matches your use case. ## What this is Adobe Target is a destination: profile parameters flow out of Zeotap CDP into Adobe Target, where they personalise what a visitor sees on your website. Adobe Target itself is a web personalisation tool through which you can build personalised experiences for your customers, and the parameters you pass can include demographic and behavioural information about a web page visitor, such as age, gender, products purchased, last time of visit and more. All three Adobe Target integrations run in that one direction, out of Zeotap CDP to Adobe Target. For data travelling the other way, into Zeotap CDP from an Adobe property, see [Adobe Experience Platform Tag Extension](/articles/integrate-customer/adobe-experience-platform-tag-extension), a source that captures events and user identities on the web. This page is the starting point for the Adobe Target integrations. The credentials, actions, identifiers and setup steps differ by integration and are documented on each integration's own page. ## Choose an integration There are three ways to integrate with Adobe Target, based on your use case. The choice comes down to whether you are activating an audience or reacting to what a customer is doing in the moment. ### Bulk Profile Update [Bulk Profile Update](/articles/integrate-customer/adobe-target-bulk-update) is an Audience integration, which allows you to create powerful audiences through Zeotap to personalise experiences as and when the customer lands on the website. It updates the profiles of multiple visitors at once rather than one at a time, and you put it to work by linking a Zeotap audience to the destination in the **Audiences** application. Choose it when your personalisation is driven by audience membership. ### Delivery API [Delivery API](/articles/integrate-customer/adobe-target-delivery-api) is a real-time integration, which allows you to create personalised experiences based on the activity performed by your customers on the website. It delivers personalised content and offers automatically, based on customer data and behaviour, across channels including web, mobile and email. You send data to it from a workflow built in Journeys. Choose it when the experience has to respond to what the customer is doing now. ### Single Profile Update [Single Profile Update](/articles/integrate-customer/adobe-target-single-update) is a real-time integration, which allows you to create personalised experiences based on golden record profile attributes sent to Adobe Target. It sends a profile update for a single user, and is generally used when an update must occur in relation to a transaction occurring in a channel that has not implemented Target. As with the Delivery API integration, you send data to it from a Journeys workflow. > [!NOTE] > > For Adobe's own reference on single and bulk profile updates, see the [Adobe Target API documentation](https://developers.adobetarget.com/api/#updating-profiles). ## Next steps * [Destinations](/articles/integrate-customer/destinations) covers the prerequisites, the mapping screen and what to check when a delivery fails. It applies to every Zeotap CDP destination, Adobe Target included. * [Create a destination](/articles/integrate-customer/create-a-destination) walks through the generic creation flow that each Adobe Target page then builds on with its own credentials and actions. * [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination) explains how an audience reaches a destination once the destination exists. # Adobe Target (Bulk Update) Source: https://docs.zeotap.com/articles/integrate-customer/adobe-target-bulk-update Send Zeotap CDP audiences and profile attributes out to Adobe Target in bulk, using Adobe's Bulk Profile Update API. ## What this is Adobe Target (Bulk Update) is a **destination**: data flows out of Zeotap CDP to your Adobe Target account. Zeotap uses Adobe's Bulk Profile Update API, which updates the profiles of many website visitors at once from a batch file, rather than one profile per call. What you send are profile attributes. Those attributes are what Adobe Target then uses to add a profile to, or remove it from, an Activity (campaign) — so building the cohort in Zeotap CDP and delivering it here saves updating each profile individually. For Adobe's own description of single versus bulk profile updates, see [Updating profiles](https://developers.adobetarget.com/api/#updating-profiles). Adobe Target integrates with Zeotap CDP in one direction only — the [three Adobe Target integrations](/articles/integrate-customer/adobe-target) all send data out of Zeotap CDP: * **Bulk Profile Update** (this page) — audience-based, delivered in batches. * [Adobe Target (Delivery API)](/articles/integrate-customer/adobe-target-delivery-api) — real time, driven by activity on your website. * [Adobe Target (Single Profile)](/articles/integrate-customer/adobe-target-single-update) — real time, one profile at a time. To bring data into Zeotap CDP from an Adobe deployment instead, use the [Adobe Experience Platform Tag Extension source](/articles/integrate-customer/adobe-experience-platform-tag-extension). ## Supported identifiers and actions This integration sends **Mbox 3rd Party IDs**, **PCID** and any custom attributes to Adobe Target. * **Mbox 3rd Party ID** — a client-specified identifier passed to Adobe Target through an mbox call as `mbox3rdPartyId`. * **PCID** — an auto-generated identifier stored in a visitor's cookies that uniquely identifies each visitor. Two actions are available, with the following feature support: | Action | [ID extension](/articles/segment-customer/extend-your-audience#id-extension) | [Delete](/articles/segment-customer/delta-upload-and-delete-functions) | [Delta upload](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send Mbox 3rd Party ID | ✅ | ✅ | — | | Send PCID and attributes | — | — | — | ## Prerequisites Have the following Adobe Target details to hand before you create the destination: * Client ID * Client Secret * Client Code * Tenant ID For the upstream Zeotap CDP setup — a connected source, Catalogue mapping, a defined audience and the role that lets you edit destinations — see [Destinations](/articles/integrate-customer/destinations#prerequisites). ### Client ID and Client Secret The Client ID uniquely identifies the application or service making the request; the Client Secret is a confidential password that verifies the request is genuine. Together they let Zeotap access and change data in Adobe Target. To obtain the Client ID and Client Secret, log in to the Adobe Developer Console and perform the following steps: **Step 1** Go to **Projects** and click **Create new project**. ![Adobe Developer Console Projects view with the Create new project button.](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/single_1.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=56f40e18e1d76bbd0dd66fe79b1fe28a) **Step 2** Under **Get started with your new project**, click **Add API**. ![Get started with your new project panel, offering Add API and Add Event.](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/single_2.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=13b50c8a665b6e1074d53947c361b4c8) **Step 3** The new screen lists all the APIs supported by Adobe. Click **Adobe Target**, then click **Next**. ![Add an API screen showing the grid of available Adobe product APIs, including Adobe Target.](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/single_3.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=04d87a25942a4ebc93156a1dc51267e9) **Step 4** Under **Choose the type of authentication you need**, click **OAuth Server-to-Server**, then click **Next**. ![Authentication type selection with the OAuth Server-to-Server option.](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/single_4.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=dfe746d20b3f9b07cd9e3dde785f5d4e) **Step 5** In the next screen, choose **Default work space** and click **Next**. **Step 6** To view the details of the project you have created, click **OAuth Server-to-Server**. ![Adobe Developer Console project overview, with the Credentials card highlighted and the OAuth Server-to-Server credential listed under it.](https://mintcdn.com/zeotap/V-MPu7vdxSd0lhbu/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/adobe-target-bulk-update-2023-10-25-1.png?fit=max\&auto=format\&n=V-MPu7vdxSd0lhbu\&q=85\&s=380bd3b06926e2cce365fd72c1919011) **Step 7** The next screen shows the **Client ID**. To see the **Client Secret**, click **Retrieve Client Secret**. **Step 8** Copy both the **Client ID** and the **Client Secret** for your project. ### Client Code A Client Code is a unique identifier assigned to a specific client or user, used to track and personalise their experiences across channels and devices. You can obtain the Client Code from the Adobe Experience Platform by navigating to **Administration** > **Implementation** > **Account details**. ![Adobe Target Administration, Implementation page with the Client Code row highlighted under Account details.](https://mintcdn.com/zeotap/V-MPu7vdxSd0lhbu/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/adobe-target-bulk-update-2023-10-25.png?fit=max\&auto=format\&n=V-MPu7vdxSd0lhbu\&q=85\&s=ada61358dfe35ba31b7e44524cd357d7) ### Tenant ID A Tenant ID is a unique identifier assigned to an organisation or individual to identify it within the Adobe Experience Platform (AEP) ecosystem. It is used to authorise user access to specific AEP capabilities. To obtain your Tenant ID, log in to the Adobe Experience Cloud, open Adobe Target and click the Target card. Your Tenant ID is the subdomain in the URL. For example, if the URL when you are logged in to Adobe Target is `https://mycompany.experiencecloud.adobe.com/...`, your Tenant ID is `mycompany`. > [!NOTE] > > **Note:** > > The Tenant ID is not the same as your Client Code. The Tenant ID appears in the URL when you are logged in to Adobe Target. ## Create the Adobe Target (Bulk Update) destination **Step 1** Log in to the Zeotap CDP App and go to **Destinations** under **Integrate**. **Step 2** Click **+ Create Destination**. ![Zeotap CDP Destinations module with the + Create Destination button.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/ADOBE_DMP_3.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=50d0558618336ceb78709191fcdda472) **Step 3** Under **All Destinations**, search for **Adobe Target - Bulk Profile Update**. ![All Destinations catalogue with the search box highlighted above tiles for Adform, Adobe Analytics, Adobe Campaign, Adobe DMP, Adobe Marketo Static Lists, Adobe Marketplace and Adobe Target.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/ADOBE_DMP_4.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=a0de06ff7f37752957c9f44c072aaebd) **Step 4** Click **Adobe Target - Bulk Profile Update**. Details about the destination appear on the left; the fields the integration needs appear on the right. Enter them as follows: a. Enter a name for the destination. b. Enter the **Client ID**, **Client Secret**, **Client Code** and **Tenant ID** you obtained in the [prerequisites](#prerequisites). c. To have Zeotap create the Audience in Adobe Target for you, select the **Allow Zeotap to create Audience in Target** checkbox. Otherwise, create the Audience in Adobe Target manually. Note that the segment Id value is equal to true for all Audiences that are created automatically. d. Review the values you entered, then click **Next**. ![Enter Destination Details step for Adobe Target - Bulk Profile Update, with fields for Destination Name, Client Id, Client Secret, Client Code and Tenant Id, and the Allow Zeotap to create Audience in Target checkbox below them.](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-ad-manager/adobe_target_bulk_profile_1.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=b03bbf544a227aa462b3b90f504c6f55) **Step 5** In the **Action and Mapping** screen, choose either **Send Mbox 3rd Party ID** or **Send PCID and attributes**, depending on the identifier and attributes you want to send. Then map the Catalogue fields to the destination fields. a. Use **Send Mbox 3rd Party ID** to send only the Mbox 3rd Party ID, the client-specified identifier passed to Adobe Target through an mbox call. [Learn more](https://developers.adobetarget.com/api/#updating-profiles) ![Action and Mapping screen with Send Mbox 3rd Party ID chosen and the Mbox 3rd Party Id Catalogue field mapped to the matching destination field.](https://mintcdn.com/zeotap/V-MPu7vdxSd0lhbu/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/adobe-target-bulk-update-2024-12-19-1.png?fit=max\&auto=format\&n=V-MPu7vdxSd0lhbu\&q=85\&s=9c10d7272e27474ce08d7f78975cc1fe) > [!NOTE] > > **Note:** > > This action supports [ID extension](/articles/segment-customer/extend-your-audience#id-extension). b. Use **Send PCID and attributes** to send the PCID, the identifier stored in a visitor's cookies that uniquely identifies each visitor. Alongside the PCID you can send any custom attribute you choose, by clicking **+ Add Mapping Field**. [Learn more](https://developers.adobetarget.com/api/#updating-profiles) ![Action and Mapping screen with Send PCID and attributes chosen, the PCID field mapped, and the + Add Mapping Field button highlighted below it.](https://mintcdn.com/zeotap/V-MPu7vdxSd0lhbu/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/adobe-target-bulk-update-2024-12-19-2.png?fit=max\&auto=format\&n=V-MPu7vdxSd0lhbu\&q=85\&s=bdf721e9f0fba37fa51f17f5496895ed) **Step 6** When the mapping is complete, click **Create Destination**. The destination is then listed in the **Audiences** module, ready to be linked to an audience or segment. ## Link an audience to the destination For how to link an audience or segment to the destination you created, see [Link an Audience to the Destination](/articles/integrate-customer/link-an-audience-to-the-destination). Note that it can take up to three business days for the segment to be available at the Adobe Target (Bulk Update) seat. > [!NOTE] > > **Note:** > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an Audience or a segment can be a specific group of customers who are over 18 years of age and have performed an `addToCart` event within the last 30 days. ## Activate the audience on Adobe Target Perform the following steps to activate the audience on the Adobe Experience Platform: **Step 1** Log in to Adobe Target and open the **Activities** tab. **Step 2** The Activities in **live** status are listed here. To create a new Activity, click **+ Create Activity** and choose the kind of Activity you want. The example below creates an **Experience Targeting** Activity. **Step 3** Enter the details the Activity needs, then click **Next**. ![Adobe Target Activities list with the Create Experience Targeting Activity dialog open, offering Web (Default), Mobile App, Email and Other/API, plus Choose Workspace and Choose Property menus.](https://mintcdn.com/zeotap/V-MPu7vdxSd0lhbu/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/bulk_10.png?fit=max\&auto=format\&n=V-MPu7vdxSd0lhbu\&q=85\&s=5f34db01d666ff29005da688b26c0daa) **Step 4** Once the Activity exists, link the appropriate Audience to it for targeting. ![Adobe Target Activity overview in Live status, with the Audiences panel highlighted showing the linked audience and the matching Experience on the right.](https://mintcdn.com/zeotap/V-MPu7vdxSd0lhbu/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/bulk_11.png?fit=max\&auto=format\&n=V-MPu7vdxSd0lhbu\&q=85\&s=b0b9727680726f9063cdb73b7489f18e) ## Verify the audience reached Adobe Target Check both sides of the delivery: 1. **In Zeotap CDP** — open the audience–destination pair and confirm the refresh completed with a non-zero qualified count. A failed run records an error you can act on; see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail) for what the common errors mean. 2. **In Adobe Target** — open the Activity you want to target and confirm the audience delivered from Zeotap is selectable in the **Audiences** panel, as shown in the previous step. Allow up to three business days after linking before treating a missing audience as a failure. ## Next steps * [Link an Audience to the Destination](/articles/integrate-customer/link-an-audience-to-the-destination) — link the destination you created to an audience and set its refresh frequency. * [Delta Upload and Delete Functions](/articles/segment-customer/delta-upload-and-delete-functions) — how subsequent refreshes send only what changed. * [Extend your audience](/articles/segment-customer/extend-your-audience#id-extension) — apply ID extension to the Mbox 3rd Party ID action. * [Adobe Target](/articles/integrate-customer/adobe-target) — compare this batch integration with the two real-time Adobe Target integrations. * [Destinations](/articles/integrate-customer/destinations) — how destinations, actions and mappings fit together across Zeotap CDP. # Adobe Target (Delivery API) Source: https://docs.zeotap.com/articles/integrate-customer/adobe-target-delivery-api Stream profile parameters out of Zeotap CDP into Adobe Target in real time from a Journeys workflow, so that the experience a visitor sees reacts to what they have just done on your website. ## What this is The Adobe Target (Delivery API) destination sends data **out of** Zeotap CDP and into Adobe Target: profile parameters are streamed from a Journeys workflow to Adobe Target in real time. Nothing travels back into Zeotap CDP through this integration. Adobe Target has no source integration — to bring web events and identities from the Adobe stack into Zeotap CDP, use the [Adobe Experience Platform Tag Extension source](/articles/integrate-customer/adobe-experience-platform-tag-extension) instead. Adobe Target's Delivery API enables real-time personalisation and targeting of customer experiences across various channels, including web, mobile and email. It allows for the automated delivery of personalised content and offers based on customer data and behaviour, improving engagement and conversion rates. ### Which Adobe Target integration to use Zeotap CDP offers three ways to integrate with Adobe Target, described together on the [Adobe Target](/articles/integrate-customer/adobe-target) page: * **Delivery API** — this page. A real-time integration that lets you create personalised experiences based on the activity performed by your customers on the website. * [**Single Profile**](/articles/integrate-customer/adobe-target-single-update) — a real-time integration that sends a profile update for a single user, generally used when an update must occur in relation to a transaction in a channel that has not implemented Target. * [**Bulk Profile Update**](/articles/integrate-customer/adobe-target-bulk-update) — updates the profiles of multiple website visitors at once from a batch file. ## Supported identifiers and actions This integration supports ECID, Adobe Target Session Id and Mbox Edge Number. All three are mandatory in the destination mapping. | Action name | [ID EXTENSION](/articles/segment-customer/extend-your-audience#id-extension) | [DELETE](/articles/segment-customer/delta-upload-and-delete-functions) | [DELTA UPLOAD](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send identifiers to Adobe Target - Delivery API | ✅ | - | - | | Send attributes to Adobe Target - Delivery API | - | - | - | ## Prerequisites Gather the following details from Adobe before you create the destination in Zeotap CDP. ### Property token A Property Token is a unique identifier assigned to a specific property within Adobe Target. It is used to retrieve or update the property value for a specific instance. You can obtain the Property Token from the Adobe Experience Platform by navigating to **Administration** → **Properties**, then opening an existing property or creating a new one with **+ Create Property**. The set of characters inside the implementation code shown in the dialog is your Property Token. ![The Create Property dialog on Adobe Target's Properties admin screen, with Property Name, Description and Channel fields above an Implementation Code snippet containing an at_property entry.](https://mintcdn.com/zeotap/V-MPu7vdxSd0lhbu/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/del_1.png?fit=max\&auto=format\&n=V-MPu7vdxSd0lhbu\&q=85\&s=3736262c721229c7cb686f192eba8d1f) ### Client code A Client Code is a unique identifier assigned to a specific client or user to track and personalise their experiences across different channels and devices. You can obtain the Client Code from the Adobe Experience Platform by navigating to **Administration** → **Implementation** → **Account details**. ![The Implementation screen in Adobe Target's Administration section, with the Account details panel listing Client Code, IMS Organization Id and the on-device decisioning toggles above the implementation methods.](https://mintcdn.com/zeotap/V-MPu7vdxSd0lhbu/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/adobe-target-bulk-update-2023-10-25.png?fit=max\&auto=format\&n=V-MPu7vdxSd0lhbu\&q=85\&s=ada61358dfe35ba31b7e44524cd357d7) ### Mbox name The Mbox Name identifies the mbox account to which you share the profile parameters. You can obtain the Mbox Name from the Adobe Experience Platform by navigating to **Activities** → **Location**. The drop-down list shows all the mbox accounts available. ![An activity in Adobe Target with the Location 1 selector open, listing the mbox names available in the account.](https://mintcdn.com/zeotap/V-MPu7vdxSd0lhbu/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/del_3.png?fit=max\&auto=format\&n=V-MPu7vdxSd0lhbu\&q=85\&s=e6f44420ff40ab76a5bea381de36a674) ## Create the Adobe Target (Delivery API) destination After you have applied filters or added conditions for your users in Journeys, you activate them under **Send to Destinations**. A new window opens, where you can set up your destination. You can use an already existing destination from the list of **Available Destinations** or create a new one. ![The Send to Destinations panel of a Journeys workflow in Zeotap CDP, showing the Add New Destination tile above a searchable list of the destinations already available.](https://mintcdn.com/zeotap/V-MPu7vdxSd0lhbu/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/del_4.png?fit=max\&auto=format\&n=V-MPu7vdxSd0lhbu\&q=85\&s=50b61ac210a2eea20cc742d502150766) Perform the following steps to add a new destination: **Step 1** Log into the Zeotap CDP App and go to **Integrate** → **Destinations**. **Step 2** Click **+ Create Destination**. **Step 3** Under **All Destinations**, search for **Adobe Target - Delivery API**. **Step 4** Click **Adobe Target - Delivery API**. a. Enter a name for the destination. b. Enter the **Property Token**, **Client Code** and **Mbox Name** that you obtained in the [prerequisites](#prerequisites). **Step 5** Review the fields entered above and click **Next**. **Step 6** In the mapping screen that appears, under **Choose your Action**, select **Stream attributes to Adobe Target - Delivery API** as the action for sending data from the workflow created in Journeys. Under **Map the Fields**, note that you must mandatorily map **ECID**, **Adobe Target Session Id** and **Mbox Edge Number**. Use **+ Add Mapping Field** to add custom identifiers and attributes you wish to send to Adobe Target (Delivery API). **Step 7** Once the mapping is complete, click **Create Destination**. For the shared version of this flow, common to every real-time integration, see [Activate your real-time audiences](/articles/integrate-customer/activate-your-real-time-audiences). ## Link the destination to the workflow After creating a destination, link it to the Journeys workflow and map the relevant source fields to the destination fields in the **Data To Send** tab. ![The Send to Destinations panel with an Adobe Target - Delivery API destination selected from the list of available destinations.](https://mintcdn.com/zeotap/V-MPu7vdxSd0lhbu/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/del_6.png?fit=max\&auto=format\&n=V-MPu7vdxSd0lhbu\&q=85\&s=62db38db90fb7c29a80e2fe04b1f362b) By default, ECID, Adobe Target Session Id and Mbox Edge Number are mapped in the **Data to Send** tab, as they are the mandatory fields. Alongside them you can map more profile attributes that you wish to share through this integration. Once you have completed the mapping, click **Save Destination**. ![The Data to Send tab, showing ECID, Adobe Target Session Id and Mbox Edge Number mapped to matching destination fields and marked required, with the User Trait, Calculated Attribute and ID Metadata groups unmapped below and Save Destination at the foot.](https://mintcdn.com/zeotap/V-MPu7vdxSd0lhbu/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/del_7.png?fit=max\&auto=format\&n=V-MPu7vdxSd0lhbu\&q=85\&s=d23f492adbb9027b310c13269916399c) To build the workflow itself, see [Create a workflow](/articles/orchestrate-customer/create-a-workflow). ## Verify the profile updates in Adobe Target You can view the profile parameters sent to Adobe Target (Delivery API). To do so, log into the Adobe Experience Platform and perform the following steps: **Step 1** Go to the **Audiences** tab and click **Create Audience**. **Step 2** Under **Attributes**, drag and drop **Visitor Profile** to the middle of the screen. **Step 3** Use the drop-down option on the Visitor Profile to verify the presence of the profile parameters that you have shared through Zeotap. ![The Create Audience dialog in Adobe Target with a Visitor Profile attribute rule added and its attribute drop-down open, listing the profile parameters held on the visitor profile.](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/del_8.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=e63909589b3d13182f64b9d557f8c29d) To check what a mapping will send before it goes live, generate a sample payload from the mapping screen — see [Payload preview for destination mappings](/articles/integrate-customer/payload-preview-for-destination-mappings). ## Next steps * [Adobe Target](/articles/integrate-customer/adobe-target) — the three Adobe Target integration modes and when to use each. * [Adobe Target (Single Update)](/articles/integrate-customer/adobe-target-single-update) — the other real-time Adobe Target destination. * [Adobe Target (Bulk Update)](/articles/integrate-customer/adobe-target-bulk-update) — the batch route, for updating many visitor profiles at once. * [Activate your real-time audiences](/articles/integrate-customer/activate-your-real-time-audiences) — activating a workflow on any real-time integration. * [Destinations](/articles/integrate-customer/destinations) — how deliveries are verified, why they fail and when to raise a support ticket. * [Delta upload and delete functions](/articles/segment-customer/delta-upload-and-delete-functions) — how refreshes send only what has changed. * [Updating profiles](https://developers.adobetarget.com/api/#updating-profiles) — Adobe's own reference for single and bulk profile updates. # Adobe Target (Single Update) Source: https://docs.zeotap.com/articles/integrate-customer/adobe-target-single-update Send profile attributes out of Zeotap CDP to Adobe Target one user at a time from a Journeys workflow, using Adobe Target's Single Profile Update API. ## What this is The Adobe Target (Single Update) integration sends profile attributes **out of Zeotap CDP to Adobe Target**, one user at a time, as users move through a workflow in Journeys. Adobe Target's Single Profile Update API sends a profile update for a single user. It is generally used when an update must occur in relation to a transaction occurring in a channel that has not implemented Target. Integrated with Zeotap, Adobe Target manages those profile updates so that audience segmentation is accurately reflected in the data, supporting personalisation and optimisation. To know more about updating the user profile using single or bulk updates, refer [here](https://developers.adobetarget.com/api/#updating-profiles). Adobe Target has three integrations in Zeotap CDP, and they are not interchangeable — all three send data **out of** Zeotap CDP: * [Adobe Target (Single Update)](/articles/integrate-customer/adobe-target-single-update) — this page. A real-time integration attached to a **Send to Destinations** node in Journeys, sending one profile update at a time. * [Adobe Target (Delivery API)](/articles/integrate-customer/adobe-target-delivery-api) — the other real-time integration, which delivers personalised content and offers based on customer data and behaviour. * [Adobe Target (Bulk Update)](/articles/integrate-customer/adobe-target-bulk-update) — the batch integration, which updates user profiles for multiple visitors at once using a batch file and is linked to an audience rather than to a Journeys node. For an overview of all three, see [Adobe Target](/articles/integrate-customer/adobe-target). To bring Adobe-side web events and user identities **into** Zeotap CDP, see the [Adobe Experience Platform Tag Extension](/articles/integrate-customer/adobe-experience-platform-tag-extension) source. ## Supported identifiers and actions This integration supports Mbox 3rd party Ids. The Mbox 3rd Party ID is a client-specified identifier passed to Adobe Target through an mbox call as `mbox3rdPartyId`. The following table lists the available actions for the integration and the features each one supports: | Action name | [ID EXTENSION](/articles/segment-customer/extend-your-audience#id-extension) | [DELETE](/articles/segment-customer/delta-upload-and-delete-functions) | [DELTA UPLOAD](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send identifiers to Adobe Target - Single Profile Update | ✅ | - | - | | Stream Profile Properties to Adobe Target - Single Profile Update | - | - | - | ## Prerequisites Have the following ready before you create the destination: * **An Adobe Target account**, and access to the Adobe Developer Console for the same organisation. * **The Client ID and Client Secret** of an OAuth Server-to-Server credential for the Adobe Target API. See [Client ID and Client Secret](#client-id-and-client-secret). * **The Client Code** of your Adobe Target account. See [Client Code](#client-code). * **The Tenant ID** of your organisation in the Adobe Experience Platform (AEP) ecosystem. See [Tenant ID](#tenant-id). * **A workflow in Journeys** with the filters or conditions that select the users you want to send. See [Create a Workflow](/articles/orchestrate-customer/create-a-workflow). ## Obtain the Adobe Target credentials ### Client ID and Client Secret The Client ID is a unique identifier for the application or service making the request, while the Client Secret is a confidential password that verifies the authenticity of the request. These credentials are used to access and manipulate data in the Adobe Target platform. To obtain the Client ID and Client Secret, log into the Adobe Developer Console and perform the following steps: **Step 1** Go to **Projects** and click **Create new project**. ![Adobe Developer Console on the Projects tab, with the Create new project button at the top right of the projects list](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/single_1.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=56f40e18e1d76bbd0dd66fe79b1fe28a) **Step 2** Under **Get started with your new project**, click **Add API**. ![Adobe Developer Console project overview with the Get started with your new project panel and the Add API, Add Event and Add Plugin options](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/single_2.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=13b50c8a665b6e1074d53947c361b4c8) **Step 3** In the new screen that appears, all the APIs supported by Adobe are listed. Here, click **Adobe Target** and click **Next**. ![Add an API dialog listing the available Adobe APIs as cards, with the Adobe Target card selected and the Next button at the bottom right](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/single_3.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=04d87a25942a4ebc93156a1dc51267e9) **Step 4** Under **Choose type of authentication you need**, click **OAuth Server-to-Server** and click **Next**. ![Configure API step showing the OAuth Server-to-Server option selected beside the deprecated Service Account (JWT) option, with a Credential name field below](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/single_4.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=dfe746d20b3f9b07cd9e3dde785f5d4e) **Step 5** In the next screen, choose **Default work space** and click **Next**. **Step 6** To view the details of the project that you have created, click **OAuth Server-to-Server** as shown below. ![Adobe Developer Console project overview with the Adobe Target API listed under Products and services, and the OAuth Server-to-Server entry in the Credentials panel beside a Generate access token button](https://mintcdn.com/zeotap/V-MPu7vdxSd0lhbu/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/adobe-target-bulk-update-2023-10-25-1.png?fit=max\&auto=format\&n=V-MPu7vdxSd0lhbu\&q=85\&s=380bd3b06926e2cce365fd72c1919011) **Step 7** In the next screen, you can find the **Client ID**. However, to view the **Client Secret**, click **Retrieve client secret**. **Step 8** In the next screen that appears, you can copy both the **Client ID** and **Client Secret** for your project. > [!WARNING] > > Treat the Client Secret as a secret. Do not paste it into tickets, screenshots or shared documents. ### Client Code A Client Code is a unique identifier assigned to a specific client or user to track and personalise their experiences across different channels and devices. You can obtain the Client Code in Adobe Target by navigating to **Administration** > **Implementation** > **Account details**. ![Adobe Target Administration section on the Implementation screen, with the Account details panel showing the Client Code row above the Implementation methods settings](https://mintcdn.com/zeotap/V-MPu7vdxSd0lhbu/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/adobe-target-bulk-update-2023-10-25.png?fit=max\&auto=format\&n=V-MPu7vdxSd0lhbu\&q=85\&s=ada61358dfe35ba31b7e44524cd357d7) ### Tenant ID A Tenant ID is a unique identifier assigned to an organisation or individual to uniquely identify them within the Adobe Experience Platform (AEP) ecosystem. This identifier is used to authorise user access to specific capabilities within AEP. To obtain your Tenant ID, log in to the Adobe Experience Cloud, open Adobe Target and click the Target card. Use the Tenant ID value as noted in the URL subdomain. For example, if your URL when logged in to Adobe Target is `https://mycompany.experiencecloud.adobe.com/...`, then your Tenant ID is `mycompany`. > [!NOTE] > > The Tenant ID is different from your Client Code. The Tenant ID exists in the URL when you are logged in to Adobe Target. ## Create the Adobe Target (Single Update) destination After you have applied filters or added conditions for your users in Journeys, you can activate them in Adobe Target under **Send to Destinations**. A new window opens, where you can set up your destination. You can use an already existing destination from the list of **Available Destinations** or create a new one. ![Send to Destinations panel in Journeys with the Add New Destination tile above a searchable grid of available destination cards](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/single_9.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=d8ae8464bb5a0038b044e64989624bf1) Perform the following steps to add a new destination: **Step 1** Log into the Zeotap CDP App and go to the **Destinations** application. **Step 2** Click **+ Create Destination**. **Step 3** Under **All Destinations**, search for **Adobe Target - Single Update**. **Step 4** Click **Adobe Target - Single Update**. a. Enter a name for the Destination. b. Enter the **Client ID**, **Client Secret**, **Client Code** and **Tenant ID** that you have obtained in the [above steps](#obtain-the-adobe-target-credentials) and save the Destination. **Step 5** Review the fields entered above and click **Next**. **Step 6** In the mapping screen that appears, under **Choose your Action**, select **Stream Profile Properties to Adobe Target - Single Profile Update** as the action for sending data from the workflow created in Journeys. Under **Map the Fields**, note that you must mandatorily map **Mbox 3rd Party Id**. Use **+ Add Mapping Field** to add custom identifiers and attributes you wish to send to Adobe Target (Single Update). **Step 7** Once the mapping is complete, click **Create Destination**. ## Activate the destination in a Journeys workflow After creating a Destination, link the Destination that you created to the Journeys workflow and map the relevant source fields to the Destination fields in the **Destination Settings** tab. ![Send to Destinations panel with an Adobe Target - Single Update destination card selected from the grid of available destinations](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/single_11.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=7c61b8a9481c259758de62cdb4511be0) Note that, by default, the Mbox 3rd Party Id is mapped in the **Destination Settings** tab as this is a mandatory field. Along with that, you can map more profile attributes that you wish to share using this integration. ![Data to Send tab with the Mbox 3rd Party Id catalogue field mapped to the Mbox 3rd Party Id destination field and marked REQUIRED, above collapsed Event, User Trait, Calculated Attribute and ID Metadata groups and the Save Destination button](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/single_12.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=0d451bc63846469af6af307c7191a332) Once you have completed the mapping, click **Save Destination**. ## Verify the profile updates reached Adobe Target You can view the profile parameters sent to Adobe Target (Single Update). To do so, log in to Adobe Target and perform the following steps: **Step 1** Go to the **Audiences** tab and click **Create Audience**. **Step 2** Under **Attributes**, drag and drop the **Visitor Profile** to the middle of the screen. **Step 3** Use the drop-down option on the Visitor Profile to verify the presence of the profile parameters that you have shared through Zeotap. ![Create Audience dialog in Adobe Target with Visitor Profile added under Attributes and the Select attribute drop-down open, listing the profile attributes available on the visitor profile](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/single_13.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=ec109a44b41f6b543c38a6c8f08a11a0) ## Troubleshoot the Adobe Target (Single Update) destination | Symptom | Most likely cause | What to do | | :- | :- | :- | | No profile attributes appear under **Visitor Profile** in Adobe Target | Nothing has been delivered yet for the users you checked, or the attributes you expected were not part of the mapping | Open the destination's **Data to Send** tab and confirm the attributes you expect are mapped alongside the Mbox 3rd Party Id, then re-check the Visitor Profile drop-down in Adobe Target | | Identifiers arrive but the profile attributes do not | The node is using an action that sends identifiers only — the two actions this integration exposes send different things, as listed in [Supported identifiers and actions](#supported-identifiers-and-actions) | Open the destination's mapping and switch to the action that sends profile properties, then map the attributes you need | | A custom attribute added with **+ Add Mapping Field** is not sent | The field was added to the mapping but the destination was not saved, or the mapping on the workflow node is a different one | Re-open the **Destination Settings** tab on the node, confirm the field is listed, and click **Save Destination** | | The destination fails on entry with an authentication error | One of the four credential values on the destination is wrong, or the Client Secret has been rotated in the Adobe Developer Console since the destination was created | Re-obtain the values (see [Obtain the Adobe Target credentials](#obtain-the-adobe-target-credentials)) and update them on the destination. Check in particular that the **Tenant ID** is the URL subdomain and not the **Client Code** — they are different values | | The destination node reports failures in the Journey Canvas | A configuration or payload problem at the node | Open the **Execution Details** panel for the failure status code and the Request ID, then look the code up in [Journey Error Codes](/articles/orchestrate-customer/journey-error-codes). See also [Journey Troubleshooting](/articles/orchestrate-customer/journey-troubleshooting) | | You cannot tell whether a particular user was sent | The workflow ran, but you need per-user evidence | Use [Journey Traces](/articles/orchestrate-customer/journey-traces) to search for a user who qualified and inspect the output event for the Adobe Target destination node | ### When to escalate Contact your Zeotap CSM or TAM if the destination node still fails after the checks above. Include the workflow name, the destination name, the failure status code and the **Request ID** from the **Execution Details** panel, and the timestamp of a failed execution. ## Next steps * [Set up the Adobe Target (Delivery API) real-time destination →](/articles/integrate-customer/adobe-target-delivery-api) * [Set up the Adobe Target (Bulk Update) batch destination →](/articles/integrate-customer/adobe-target-bulk-update) * [Create a workflow in Journeys →](/articles/orchestrate-customer/create-a-workflow) * [Debug a single user's path with Journey Traces →](/articles/orchestrate-customer/journey-traces) * [Bring Adobe web events and identities into Zeotap CDP →](/articles/integrate-customer/adobe-experience-platform-tag-extension) * [Explore how real-time destinations work →](/articles/integrate-customer/real-time-integrations) # Airship Static Lists Source: https://docs.zeotap.com/articles/integrate-customer/airship Send Zeotap CDP audiences out to Airship as static lists, using an Airship access token and the Send Named User to Airship action. ## What this is The Airship Static Lists destination sends audiences **out of Zeotap CDP to Airship**. Each audience you link is delivered as a list that appears under **Audience > Lists** in the Airship console, ready to target from Airship campaigns. Airship is a customer engagement platform that helps marketers deliver personalised and relevant experiences to their customers across multiple channels and touchpoints. Integrated with Zeotap CDP, it enables marketers to engage with their customers in real time and at scale. Airship appears four times in Zeotap CDP, in both directions. Use this table to confirm you are on the right page: | Integration | Direction | Runs from | | :- | :- | :- | | **Airship Static Lists** (this page) | Zeotap CDP to Airship, batch | Audiences | | [Airship Real Time Integration](/articles/integrate-customer/airship-real-time-destination-integration) | Zeotap CDP to Airship, real time | Journeys | | [Airship (Batch) Source](/articles/integrate-customer/airship-batch-source) | Airship to Zeotap CDP, batch | Sources | | [Airship Real-Time Data Streaming Source](/articles/integrate-customer/airship-real-time-data-streaming-source) | Airship to Zeotap CDP, real time | Sources | ## Supported identifiers and actions This destination supports Named Users (A Named User is a proprietary identifier that maps customer-chosen IDs. In other words, Named User is an individual consumer who can have more than one mobile device registered with your app. For example, Named User john_doe_123 can have a personal Android phone and an iPad, on both of which he has opted in for push notifications. If you want to reach John on both devices, associate the Channel (device) identifiers for each device to the Named User john_doe_123, and push to the Named User. This sends out notifications to both associated devices.) only. The destination exposes a single action, **Send Named User to Airship**: | Action | [ID Extension](/articles/segment-customer/extend-your-audience#id-extension) | [Delete](/articles/segment-customer/delta-upload-and-delete-functions) | [Delta Upload](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :-: | :-: | :-: | | Send Named User to Airship | — | — | — | None of the three delivery features are available for this action: it does not support ID Extension, Delete or Delta Upload. ## Prerequisites Have the following ready before you create the destination: * **Access Token** — created in Airship. See [Create an Airship access token](#create-an-airship-access-token) below. * **X-UA-Appkey** — the app key for the Airship project this destination writes to. Obtain it from your Airship account. * **Region** — the region for which your Airship account subscription is registered. Confirm it with your Airship account manager. * An audience in Zeotap CDP to link to the destination, and a role that grants destination edit rights on the organisation that owns the destination. See [Destinations: prerequisites](/articles/integrate-customer/destinations#prerequisites). ## Create an Airship access token Perform the following steps in Airship to create the access token: **Step 1** Log in to the Airship console and navigate to **Settings**. **Step 2** Under **Settings**, select **Project Configuration** and click **Manage** for **Tokens**. **Step 3** Click **Create Token**. ![Airship console, Settings then Tokens, with the Create Token button highlighted above the list of existing tokens and their roles](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/Imported/airship-static-lists-in-review-img0001.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=b77846dcd834323648b5619ec3c4ded0) **Step 4** Enter a token name. This is just a friendly name to help you recognise your tokens in Airship. **Step 5** Select the **Role** you want to grant for this token. For additional information, see [Airship API Security](https://docs.airship.com/guides/messaging/user-guide/admin/security/api-security/). * **Audience Modification**: Grants read and write permission to audience APIs, including channels, named users, segments, lists and so on. Use this permission for users sending custom events into Airship. * **All Access**: Grants full access to your Airship project, except Acoustic integrations. You must use this permission when creating a token for an inbound message handling web-hook. **Step 6** Click **Create Token**. ![Airship Create Token dialog, with a Name field for the token, a Role drop-down and the Create token button](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/Imported/airship-static-lists-in-review-img0002.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=753f290eb049a7e8117e3712783f8341) **Step 7** Copy the values, then click **Got it** to close the window. ![Airship Token Created confirmation dialog, with a reminder to save and protect the new credentials as confidential data and a Got it button to close it](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/Imported/airship-static-lists-in-review-img0003.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=17ee3d7ea0dd34809d1aad42149a9606) > [!WARNING] > > Copy the access token before you close the dialog, and store it as confidential data — Airship's own warning on this screen is to save and protect it against unauthorised access and use. If you no longer hold the value later, create a new token rather than sharing an existing one. ## Create the Airship Static Lists destination Perform the following steps to create the destination in Zeotap CDP: **Step 1** Log in to the Zeotap CDP App and go to the **DESTINATIONS** application. **Step 2** Click **+ Create Destination**. ![Destinations listing in the Zeotap CDP App, with the + Create Destination button highlighted above the table of existing destinations](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/ADOBE_DMP_3.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=50d0558618336ceb78709191fcdda472) **Step 3** Under the **All Destinations** section, search for **Airship Static Lists**. ![All Destinations catalogue in the Zeotap CDP App, with the destination search box highlighted above the destination cards](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/ADOBE_DMP_4.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=a0de06ff7f37752957c9f44c072aaebd) **Step 4** Click **Airship Static Lists**. A screen appears with details about the destination on the left, and on the right the fields required to establish the integration. Enter the required details: a. Enter a name for the destination. b. Enter the **Access Token**. c. Enter the **X-UA-Appkey**. d. Select the appropriate **Region** from the drop-down menu. e. Review all the values entered above, then click **Next** to proceed. ![Enter Destination Details screen for Airship Static Lists in the Zeotap CDP App, showing the Destination Name, Access Token and Region fields](https://mintcdn.com/zeotap/5uegGRTZnAzLL6tY/articles/integrate-customer/Storage/integrate-customer/adobe-dmp/airship_1.png?fit=max\&auto=format\&n=5uegGRTZnAzLL6tY\&q=85\&s=71b6edef7b76a53bc64fedf8fd9c7fa4) > [!NOTE] > > To access the help documentation for this integration, click **Integration Guide** under **Related Links**. **Step 5** In the new screen that appears, choose the action and mapping as explained below. a. Choose **Send Named User to Airship** under **Choose your Action** and map the corresponding identifiers under **Map the Fields**. For how mappings work, see [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). b. Click **Create Destination**. The created destination gets listed in the **Audiences** application, where it can be linked to an audience. ![Mapping screen in the Zeotap CDP App, with Send Named User to Airship selected under Choose your Action and the Named User destination field listed under Map the Fields](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/airship/airship-2024-01-23-1.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=5ad273ddee7fb98d6b8f7bc1ce976c55) ## Link an audience to the destination For information about how to link an audience (segment) to the created destination in the **Audiences** application, see [Link an Audience to the Destination](/articles/integrate-customer/link-an-audience-to-the-destination). Two things to keep in mind: * It can take up to **three business days** for the segment to be available at the Airship Static Lists seat. * Link **only one destination at a time** to avoid activation issues. > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an Audience or a segment can be a specific group of customers who are over 18 years of age and have performed an `addToCart` event within the last 30 days. ## Verify the audience reached Airship Check both sides of the delivery. **In Zeotap CDP** — open the destination and confirm the linked audience recorded a run with a completed status and a non-zero qualified count. See [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). **In Airship** — perform the following steps to view the segments that arrived: **Step 1** Log in to the Airship console, navigate to **Audience** and select the **Lists** option. **Step 2** Search and filter the lists as required to find the list for your audience. ![Airship console, Audience then Lists, Uploaded tab, showing uploaded lists with their status, device counts and created and last-modified dates](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/Imported/airship-static-lists-in-review-img0006.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=818ba3d5d2c73c22e267fe3c4b3d8fd1) The two counts will not match exactly, but both should be non-zero and in the same order of magnitude. ## Troubleshoot the Airship Static Lists destination | Symptom | What it means | What to do | | :- | :- | :- | | The list has not appeared under **Audience > Lists** in Airship | Either no refresh has completed on the Zeotap CDP side yet, or the segment has not yet become available at the Airship seat | Confirm the audience–destination pair recorded a completed refresh — see [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). If it has, allow up to three business days. On the Airship **Lists** screen, clear any active search or filter before concluding the list is missing. | | Activation issues on an audience linked to several destinations at once | More than one destination was linked to the audience at the same time | Link only one destination at a time, and wait for the first to finish activating before linking the next. | | You are not sure the access token or region on the destination is right for the account | The destination is configured with a token or region that does not match your Airship account | In Airship, re-check the role granted on the token under **Settings > Project Configuration > Tokens**, and confirm the **Region** with your Airship account manager. If you no longer hold the token value, create a new token using the steps above and re-enter it on the destination. | If the destination is configured correctly and the problem persists, read the error recorded on the audience–destination pair: [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail) lists the error strings that surface there, and [When to contact support](/articles/integrate-customer/destinations#when-to-contact-support) covers when to raise a ticket and what to include in it. ## Next steps * [Link an audience to the destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore audience scheduling →](/articles/segment-customer/audience-scheduling) * [Send real-time events to Airship from Journeys →](/articles/integrate-customer/airship-real-time-destination-integration) * [Bring Airship data into Zeotap CDP with the Airship (Batch) Source →](/articles/integrate-customer/airship-batch-source) * [Explore the integrations master list →](/articles/integrations-master-list-publication/integrations-master-list) # Airship (Batch) source Source: https://docs.zeotap.com/articles/integrate-customer/airship-batch-source Bring Named Users and Airship Channel IDs from Airship into Zeotap CDP in batch, so the devices you can reach with push notifications form part of the unified customer profile. ## What this is An Airship (Batch) source moves data **from Airship into Zeotap CDP**: Zeotap retrieves user IDs and attributes from your Airship project and consolidates them with everything else you have connected, so the result is one unified customer profile rather than an isolated Airship list. The identifiers it brings across are the ones Airship uses to reach a device — Android and iOS channels among them — which is what lets an audience built in Zeotap CDP be targeted with push notification campaigns. To send data the other way, from Zeotap CDP out to Airship, see [Airship Static Lists](/articles/integrate-customer/airship) or [Airship Real Time Integration](/articles/integrate-customer/airship-real-time-destination-integration). ## Supported identifiers | Identifier | What it is | | :- | :- | | **Named User** | A proprietary Airship identifier that maps customer-chosen IDs. A Named User is an individual consumer who can have more than one mobile device registered with your app — for example, a personal Android phone and an iPad that have both opted in for push notifications. Associating the channel (device) identifier for each device with a single Named User means a push sent to that Named User reaches every associated device. | | **Airship Channel ID** | The identifier Airship assigns to an individual registered device. | [Create an Airship (Batch) source](/articles/integrate-customer/create-an-airship-batch-source) also shows how, in addition to the Named Users, you can match the Airship Channel ID to a Zeotap attribute to enrich customer profiles further; [Tracking user identities](/articles/sdks/web-js/api-reference/set-user-identities#custom-identities) covers custom identities in the Zeotap SDKs generally. The [source integrations catalogue](/articles/integrate-customer/creating-a-source) lists Airship (Batch) as not supporting delta fetch — each run retrieves the full set rather than only what has changed since the last one. ## Which Airship integration do I need? Airship appears four times in Zeotap CDP — twice as a source and twice as a destination — and the names are close enough to be easy to mix up. Check the direction before you start: | Integration | Direction | Use it for | | :- | :- | :- | | **Airship (Batch)** — this page | Airship → Zeotap CDP | Retrieving Named Users and Airship Channel IDs, with their attributes, into customer profiles. | | [Airship Real-Time Data Streaming](/articles/integrate-customer/airship-real-time-data-streaming-source) | Airship → Zeotap CDP | Streaming the Airship event types you select into Zeotap CDP over a webhook connection. | | [Airship Static Lists](/articles/integrate-customer/airship) | Zeotap CDP → Airship | Delivering a linked audience to Airship as a static list. | | [Airship Real Time Integration](/articles/integrate-customer/airship-real-time-destination-integration) | Zeotap CDP → Airship | Activating users in Airship from a Journeys workflow. | > [!NOTE] > > In the **Sources** catalogue the tile for this integration is labelled **Airship**, under the **Customer Engagement Channels** category. In the **Destinations** catalogue the batch destination is listed as **Airship Static Lists**. The real-time destination is not in that catalogue — you add it from a Journeys workflow under **Send to Destinations → + Add New Destination**. ## Prerequisites Have the following ready before you create the source. [Create an Airship (Batch) source](/articles/integrate-customer/create-an-airship-batch-source) walks through each one with screenshots and covers the source form itself. * **An Airship bearer token (access token).** Create it in the Airship console under **Settings → Project Configuration → Tokens**. When you create the token you choose the role it is granted; Airship documents what **Audience Modification** and **All Access** each allow in [Airship API Security](https://docs.airship.com/guides/messaging/user-guide/admin/security/api-security/). Copy the **Access Token** value when Airship shows it — you enter it as the **Bearer Token** on the Zeotap CDP source form. * **Named Users in your Airship project.** Because the Named User is what ties one person's registered devices together, associate the channel (device) identifier for each device with the Named User you want to reach. * **Optionally, the Airship Channel ID captured on your own properties**, if you want to match it to a Zeotap attribute as well as ingesting the Named User. * **A decision on the Data Entity and the region of upload**, both of which the source form asks for. [Supported data entities](/articles/unify-customer/supported-data-entities) explains the Customer Data and Non-Customer Data options. ## Next steps * [Create an Airship (Batch) source](/articles/integrate-customer/create-an-airship-batch-source) — the step-by-step setup, including generating the bearer token in Airship and checking the **PREVIEW DATA** tab once data starts flowing. * [Components of the Preview Data tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) — what each field on that tab means. * [Airship Real-Time Data Streaming source](/articles/integrate-customer/airship-real-time-data-streaming-source) — add event streaming alongside this batch source. * [Airship Static Lists](/articles/integrate-customer/airship) and [Airship Real Time Integration](/articles/integrate-customer/airship-real-time-destination-integration) — send audiences and journey activations back out to Airship. * [Source Integrations (Batch+Real-Time)](/articles/integrate-customer/creating-a-source) — every source Zeotap CDP supports, with the identifiers each one accepts. # Airship Real-Time Data Streaming Source Source: https://docs.zeotap.com/articles/integrate-customer/airship-real-time-data-streaming-source Stream the Airship event types you select into Zeotap CDP in real time, through a webhook integration you configure in your Airship project. The Airship Real-Time Data Streaming source brings data **into Zeotap CDP**: Airship pushes the event types you select to Zeotap as they occur, over a webhook integration that you configure in your Airship project. To send data in the opposite direction — out of Zeotap CDP to Airship — use the [Airship Static Lists](/articles/integrate-customer/airship) destination for audiences, or the [Airship Real Time Integration](/articles/integrate-customer/airship-real-time-destination-integration) destination for Journeys workflows. ## What this is Airship is a customer engagement platform that helps marketers deliver personalised and relevant experiences to their customers across multiple channels and touch points. Integrated with Zeotap, it enables marketers to engage with their customers in real time and at scale. This source uses Airship's Real-Time Data Streaming feature. You create the source in Zeotap CDP, which generates an API URL and a Bearer Token; you then register those in a webhook integration in Airship and choose the event types to stream. With the streaming connection established between Airship and Zeotap, Airship starts sending those events to Zeotap. Airship has two source integrations and two destination integrations, and their names are easy to confuse. Use this table to confirm you are on the right page: | Page | Direction | What it does | | :- | :- | :- | | Airship Real-Time Data Streaming source (this page) | Airship → Zeotap CDP | Streams the Airship event types you select to Zeotap as they occur | | [Airship (Batch) source](/articles/integrate-customer/airship-batch-source) | Airship → Zeotap CDP | Retrieves user IDs and attributes from Airship into Zeotap in batches | | [Airship Static Lists](/articles/integrate-customer/airship) | Zeotap CDP → Airship | Sends an audience to Airship as a static list | | [Airship Real Time Integration](/articles/integrate-customer/airship-real-time-destination-integration) | Zeotap CDP → Airship | Sends data from a Journeys workflow to Airship | ## Supported identifiers * **Named User** — a proprietary Airship identifier that maps customer-chosen IDs. A Named User is an individual consumer who can have more than one mobile device registered with your app. For example, Named User `john_doe_123` can have a personal Android phone and an iPad, on both of which he has opted in for push notifications. Associating each device's channel identifier with the Named User means a push to the Named User reaches both devices. * **Airship channel ID** — in addition to Named Users, you can match the Airship channel ID to a Zeotap attribute to enrich customer profiles in Zeotap. [Create an Airship Real-Time Data Streaming Source](/articles/integrate-customer/create-an-airship-real-time-data-streaming-source) shows the SDK call that retrieves the channel ID from the Airship SDK. ## Prerequisites * Access to the **Sources** application under **Integrate** in the Zeotap CDP App. * An Airship project that you can open from the Airship projects list and whose **Settings → Project configuration → Real-Time Data Streaming** you can manage. * To match the Airship channel ID to a Zeotap attribute, Zeotap's SDK deployed on your property. See [Custom Identities](/articles/sdks/web-js/api-reference/set-user-identities#custom-identities) in the Web (JS) SDK reference. The credential that authenticates the connection is the **Bearer Token** Zeotap CDP generates when you create the source: you read it from **Access Details** on the source's **IMPLEMENTATION DETAILS** tab and enter it in the Airship webhook's **Custom Headers**. Treat it as a secret, in the same way as any other credential you hold. ## Create the Airship Real-Time Data Streaming source Setting up this source takes two stages, one on each side of the integration. Each stage has its own page: **1. Create the source in Zeotap CDP** Create the source under **Sources**, choosing **Customer Engagement Channels** as the category and **Airship Real Time Data Streaming** as the data source. On successful creation, a **Bearer Token** is generated and appears under **Access Details** on the source's **IMPLEMENTATION DETAILS** tab. You need it, together with the API URL for the source, for the next stage. See [Create an Airship Real-Time Data Streaming Source](/articles/integrate-customer/create-an-airship-real-time-data-streaming-source). **2. Configure data streaming in Airship** In your Airship project, add a webhook under **Real-Time Data Streaming**. Enter the API URL as the webhook endpoint URL, supply the Bearer Token in an **Authorization** custom header, select the event types you want to send to Zeotap, and activate the integration. See [Implement an Airship Real-Time Data Streaming Source](/articles/integrate-customer/implement-an-airship-real-time-data-streaming-source). ## Verify the source is receiving data After you implement the source, open it from the **SOURCES** listing page and check the **PREVIEW DATA** tab, which shows a sample of the data that has reached Zeotap. Once data starts flowing in, the status of the source changes to *Integrated*. If no preview is available, an error message states the reason. Check that the source is implemented correctly — that the webhook integration in Airship is activated and uses the API URL from the **IMPLEMENTATION DETAILS** tab — and try again after some time. For what each option on the tab does, see [Components of the Preview Data Tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab). ## Next steps > [card] [Create an Airship Real-Time Data Streaming Source](/articles/integrate-customer/create-an-airship-real-time-data-streaming-source) > > Create the source in Zeotap CDP and collect the API URL and Bearer Token. > [card] [Implement an Airship Real-Time Data Streaming Source](/articles/integrate-customer/implement-an-airship-real-time-data-streaming-source) > > Configure the webhook in Airship and choose the event types to stream. > [card] [Airship (Batch) source](/articles/integrate-customer/airship-batch-source) > > The other way to bring Airship user IDs and attributes into Zeotap CDP. > [card] [Airship Static Lists](/articles/integrate-customer/airship) > > Send an audience from Zeotap CDP out to Airship as a static list. # Airship real-time destination Source: https://docs.zeotap.com/articles/integrate-customer/airship-real-time-destination-integration Send users out of Zeotap CDP to Airship in real time from a Journeys workflow, as each user qualifies. ## What this is The Airship real-time destination sends users **out of Zeotap CDP to Airship** as they qualify a Journeys workflow, so you can engage them on the channels Airship manages. Airship is a customer engagement platform that helps marketers deliver personalised and relevant experiences across multiple channels and touchpoints; integrated with Zeotap CDP, it lets you act on those audiences in real time and at scale. You attach the destination to the **Send to Destinations** node inside a workflow. The destination holds the Airship connection credentials; the node holds the action and the field mapping used for that workflow. Airship appears elsewhere in Zeotap CDP, in both directions: * [Airship Static Lists](/articles/integrate-customer/airship) — the same outbound direction, but created from the **DESTINATIONS** application and activated by linking an audience to it rather than from a Journeys workflow. * [Airship Real-Time Data Streaming Source](/articles/integrate-customer/airship-real-time-data-streaming-source) and [Airship (Batch) Source](/articles/integrate-customer/airship-batch-source) — the opposite direction: these bring Airship data **into** Zeotap CDP. ## Supported identifiers and actions This integration exposes one action, **Send Named User to Airship**, which sends data from the workflow you built in Journeys. You must map at least one ID for data to transfer from Zeotap CDP to the Airship destination. The IDs are Named User, iOS channel, Android channel and Web channel. If you map more than one ID, Zeotap CDP chooses the ID highest in the priority order below. **Event Name** and **Event Timestamp** are mandatory and are mapped to the destination fields by default. | DB name | Display name | Mandatory | Priority | | :- | :- | :- | :- | | named_user | Named User | No | 1 | | ios_channel | iOS channel | No | 2 | | android_channel | Android channel | No | 3 | | web_channel | Web channel | No | 4 | | occurred | Event Timestamp | Yes | | | name | Event Name | Yes | | | transaction | Transaction | No | | | value | Value | No | | ## Prerequisites Obtain the following from Airship, and confirm your Zeotap CDP access, before you create the destination: * **Access Token** — an authentication mechanism that allows authorised users to access resources within an Airship integration. It confirms that the user is authorised for the resources they request and helps secure the Airship integration against unauthorised access. See [Create an Airship access token](#create-an-airship-access-token). * **X-UA-Appkey** — in Airship, a header that identifies the unique app key associated with each mobile device. The app key is a unique identifier assigned to each mobile device by Airship and is used to manage device information, send notifications and track app usage. * **Region** — the region your Airship account subscription is registered for. Confirm it with your Airship account manager. * A Journeys workflow with the user filters or conditions already applied. See [Create a workflow](/articles/orchestrate-customer/create-a-workflow). * A role that grants **Create and Edit Destinations** and **Create, Edit, and Archive Journeys** on the organisation that owns the destination. For the role-to-permission matrix, see [User Roles and Access](/articles/admin-customer/user-roles-and-access). ## Create an Airship access token Perform the following steps in Airship: **Step 1** Log into the Airship Static Lists console and navigate to Settings. **Step 2** Under Settings, select Project Configuration and click Manage for Tokens. **Step 3** Click Create Token. ![Airship token management screen with the Create Token button](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/Imported/airship-static-lists-in-review-img0001.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=b77846dcd834323648b5619ec3c4ded0) **Step 4** Enter a token name. This is a friendly name that helps you recognise your tokens in Airship. **Step 5** Select the Role you want to grant for this token. For more information, see [Airship API Security](https://docs.airship.com/guides/messaging/user-guide/admin/security/api-security/). * **Audience Modification** — grants read and write permission to audience APIs, including channels, named users, segments, lists and so on. Use this permission for users sending custom events into Airship. * **All Access** — grants full access to your Airship project, except Acoustic integrations. You must use this permission when creating a token for an inbound message handling web-hook. **Step 6** Click Create Token. ![Airship token creation form with the token name and role fields completed](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/Imported/airship-static-lists-in-review-img0002.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=753f290eb049a7e8117e3712783f8341) **Step 7** Copy the values, then click Got it to close the window. ![Airship confirmation window shown after a token is created](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/Imported/airship-static-lists-in-review-img0003.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=17ee3d7ea0dd34809d1aad42149a9606) ## Create the Airship destination After you have applied filters or added conditions for your users in Journeys, open the **Send to Destinations** node. A window appears where you can set up the destination: reuse an existing destination from the list, or create a new one with **+ Add New Destination**. ![Send to Destinations panel listing the destinations already available in the workspace, with the + Add New Destination link above the search box](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/airship-real-time-destination-integration/airship-real-time-destination-integration-2024-08-07.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=442f9ac57e67af27dae171b5fd733d9f) **Step 1** Click **+ Add New Destination**. **Step 2** Search for **Airship**. **Step 3** Click the **Airship Static Lists** tile and enter a name for the destination. **Step 4** Enter the **Access Token** and **X-UA-Appkey** you obtained from Airship. **Step 5** Choose the appropriate **Region** from the drop-down menu and click **Next**. **Step 6** On the mapping screen, under **Choose your Action**, select **Send Named User to Airship**. Under **Map the Fields**, map the relevant output identifiers and attributes — see [Supported identifiers and actions](#supported-identifiers-and-actions) for the full list and the priority order. The mandatory Event Name and Event Timestamp fields are mapped to the destination fields by default. ![Mapping screen with Send Named User to Airship selected under Choose your Action and catalogue fields mapped to the Event Name and Event Timestamp destination fields](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/airship-real-time-destination-integration/airship-real-time-destination-integration-2024-08-07-1.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=04810f0540f72591edb7f37afb62ebc9) **Step 7** Click **Create Destination**. The destination is created and becomes available for activation in Journeys. ## Activate the destination in a Journeys workflow Once the destination exists, link it in the **Send to Destinations** node of the workflow. **Step 1** In the workflow, click **+** and choose **Send to Destinations**. ![Node menu on the workflow canvas with Send to Destinations highlighted among the available node types](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/airship-real-time-destination-integration/airship-real-time-destination-integration-2024-08-07-2.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=fd4341e29c146c87a410b4c52c5a914e) **Step 2** Choose the destination from the list of available destinations, using the search box to find it. ![Send to Destinations panel with the search box highlighted above the list of available destinations](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/airship-real-time-destination-integration/airship-real-time-destination-integration-2024-08-07-3.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=f2930e066e937c1afd076171ae685b91) **Step 3** On the **Destination Details** tab, the **Access Token**, **X-UA-Appkey** and **Region** fields are populated automatically from the values you entered when you created the destination. **Step 4** On the **Destination Settings** tab, choose the action and mapping for this node. ![Destination Settings tab showing Send Named User to Airship as the chosen action and the Event Name and Event Timestamp fields listed under Mapping](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/airship-real-time-destination-integration/airship-real-time-destination-integration-2024-08-07-4.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=87cd4ac94b7c8134a5ca3d826db66722) **Step 5** Click **Save Destination**. The destination is attached to the node. ![Attached destination card on the Send to Destinations node showing the destination name, its ID, the mapping name and the Send Named User to Airship action](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/airship-real-time-destination-integration/airship-real-time-destination-integration-2024-08-07-5.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=43b61a20f28d3141fd924071f8436cd6) For the rest of the workflow — adding further nodes, setting re-entry criteria and publishing — see [Activate your real-time audiences](/articles/integrate-customer/activate-your-real-time-audiences). ## Verify the activation worked The destination is set up correctly when all of the following hold: 1. After you click **Create Destination**, the new destination appears in the list of available destinations on the **Send to Destinations** node. 2. After you click **Save Destination**, the destination card is attached to the node and shows the destination name, the mapping name and the **Send Named User to Airship** action. 3. The workflow shows **Published** status in the workflow listing screen. See [Activate your real-time audiences](/articles/integrate-customer/activate-your-real-time-audiences). 4. In Airship, new records or events arrive carrying the identifiers and attributes you mapped. 5. For a single user, [Journey Traces](/articles/orchestrate-customer/journey-traces) shows the output event that was sent to the Airship node, so you can confirm the mapped fields left Zeotap CDP with the values you expect. ## Troubleshoot the Airship destination | Symptom | What it means | Where to look | | - | - | - | | You cannot proceed past the mapping screen | A mandatory destination field has no Catalogue field selected — Event Name and Event Timestamp must both be mapped | Mapping screen → **Map the Fields** | | The workflow is published but no data reaches Airship | No ID is mapped. At least one of Named User, iOS channel, Android channel or Web channel must be mapped for data to transfer | Mapping screen → **Map the Fields**; [Supported identifiers and actions](#supported-identifiers-and-actions) | | Airship receives a different ID from the one you expected | More than one ID is mapped, so Zeotap CDP sent the one highest in the priority order | [Supported identifiers and actions](#supported-identifiers-and-actions) | | 100% of users fail at the Airship node | Typically an authentication or mapping error — for example an Access Token that has been rotated in Airship but not updated on the destination | **Execution Details** panel on the node; [Identify Journey Errors](/articles/orchestrate-customer/identify-journey-errors) | | A small percentage of users fail at the Airship node | Typically a consent or data-quality issue rather than a configuration error | [Troubleshooting Workflows](/articles/orchestrate-customer/journey-troubleshooting) | For the failure status code on a node and its resolution path, see [Journey Error Codes](/articles/orchestrate-customer/journey-error-codes). When you escalate, include the journey execution ID, the error code and timestamp, the destination name and type, the Request ID from the **Execution Details** panel, and the steps you have already taken — see [Troubleshooting Workflows](/articles/orchestrate-customer/journey-troubleshooting). ## FAQ > [accordion] Do I need to create the Airship destination again for every workflow? > > No. A destination is a workspace-level object. Once created, it appears in the destination list on the **Send to Destinations** node of any workflow in the same workspace. The credential fields are shared; the action and mapping on the **Destination Settings** tab are set per node. > [accordion] Can I send the same workflow to Airship and to another destination at the same time? > > Yes. In the **Send to Destinations** node, add each additional destination. Every attached destination receives users as they qualify the workflow. ## Next steps * [Explore activating your real-time audiences →](/articles/integrate-customer/activate-your-real-time-audiences) * [Explore the Airship Static Lists destination →](/articles/integrate-customer/airship) * [Explore the Airship Real-Time Data Streaming Source →](/articles/integrate-customer/airship-real-time-data-streaming-source) * [Explore the Airship (Batch) Source →](/articles/integrate-customer/airship-batch-source) * [Explore Journey error codes →](/articles/orchestrate-customer/journey-error-codes) * [Explore destinations →](/articles/integrate-customer/destinations) # Amazon Conversions API Source: https://docs.zeotap.com/articles/integrate-customer/amazon-conversions-api Send conversion events from Zeotap CDP to Amazon DSP in real time over a server-to-server connection, and verify them in Amazon Ads Events manager. ## What this is Amazon Conversions API is a **real-time destination**: it sends conversion events out of Zeotap CDP to your Amazon DSP (Amazon Ads) account over a direct, server-to-server connection, so you can reach your ideal audiences and optimise your campaigns in real-time. Amazon DSP is a programmatic advertising platform that allows marketers to buy display and video ads across Amazon-owned and third-party websites and mobile apps. Because it is a real-time destination, it is driven from a journey rather than from an audience refresh — you attach it to the **Send to Destinations** node of a workflow in Journeys. To send *audiences* to Amazon DSP rather than conversion events, use the batch destinations [Amazon DSP - DP Audience](/articles/integrate-customer/amazon-dsp-dp-audience) or [Amazon DSP](/articles/integrate-customer/amazon-dsp) instead. ## Supported identifiers and actions This integration sends the following identity fields as **Match Keys**: Email, Phone Number, MAID, First Name and LastName. You can also send additional attributes using **Custom Data Fields**, and an **Event Timestamp** is required for every event. > [!NOTE] > > **Note:** > > Ensure that the **Email**, **MAID**, **First Name**, and **LastName** values you map are SHA-256 hashed before they are sent to Amazon Conversions API. The destination exposes one action, **Send Events to Amazon**, which runs in Journeys. ## Prerequisites Before you create an Amazon Conversions API destination in Zeotap CDP, ensure that you have the following: * An Amazon DSP (Amazon Ads) account. * Your **Advertiser ID** (Amazon DSP Ad Account ID) and account **Currency** available. * Permission to authorise Zeotap to access your Amazon Ads account through the Amazon sign-in (OAuth) flow. ## Gather your Amazon DSP details Ensure that you have the details about the below components before creating a destination. ### Advertiser ID This is your Amazon DSP Ad Account ID. You can obtain it from your Amazon DSP account. ### Account Region This is the geographical region in which your Amazon DSP account operates — either **North America** or **Europe**. ## Create the Amazon Conversions API destination **Step 1** In Zeotap CDP, open **Integrate** > **Destinations**. **Step 2** Click **+ Create Destination**. **Step 3** Under the **All Destinations** section, search for Amazon Conversions API and click **Amazon Conversions API**. **Step 4** A screen appears displaying details about the destination towards the left. On the right-hand side, under **Enter Destination Details**, provide the required details: a. In the **Destination Name** field, enter a name for the destination. b. In the **Advertiser ID** field, enter your Amazon DSP Ad Account ID. c. Under **Account Region**, select the region where your Amazon DSP account operates (North America or Europe). ![The Enter Destination Details step of the Amazon Conversions API destination, with the Destination Name, Advertiser ID and Account Region fields and the Connect Amazon Conversions API button beneath them.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/amazon-conversions-api/amazon-conversions-api-2026-06-11-1.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=6ec5c3b066b7a5374c5a70d1daea0343) **Step 5** Click **Connect Amazon Conversions API**. In the Amazon sign-in window that opens, click **Allow** to authorise Zeotap to access your Amazon Ads account. **Step 6** Once authorisation is complete, a panel appears beneath **Account Region** recording when the connection was last updated, together with a note giving the date on which the refresh token expires. Note that date — the authorisation does not last indefinitely. Click **Next** to proceed to the **Mapping** screen. ![The same destination details step after authorisation, with a panel below Account Region showing the last-updated timestamp and a note stating when the refresh token expires, and the Next button now enabled.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/amazon-conversions-api/amazon-conversions-api-2026-06-11-2.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=74f5635e782f9ff07c34085d2a625f2a) **Step 7** On the **Mapping** screen, provide a name for your mapping and configure the action and field mapping: a. Under **Choose your Action**, select **Send Events to Amazon**. This action is tagged **Journeys** and sends your conversion events to Amazon DSP through Journeys. ![The Mapping screen with the Choose your Action dropdown open, listing Send Events to Amazon as the only action, tagged Journeys.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/amazon-conversions-api/amazon-conversions-api-2026-06-11-3.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=cf009cf935c232f64e24a69cad5a793f) b. Under **Map the Fields**, map the Catalogue fields to the destination fields: i. **Event Attribute** — map the required **Event Timestamp** field. ii. **Match Keys** — map the identity fields you want to send: Email, Phone Number, MAID, First Name and LastName. iii. **Custom Data Fields** — use **+ Add Mapping Field** to send any additional attributes. ![The Map the Fields table, with Event Timestamp mapped under Event Attribute and the Match Keys rows for Email, Phone Number, MAID, First Name and LastName, with an Add Mapping Field link beneath the group and a Custom Data Fields section below.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/amazon-conversions-api/amazon-conversions-api-2026-06-11-4.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=155e44c5b7c7605125dfb37e7afd0e4e) > [!NOTE] > > Zeotap CDP transmits the Amazon Consent Signal (`amazonAdStorage: GRANTED` and `amazonUserData: GRANTED`) to ensure compliance. Ensure that only consented users meet your audience criteria. c. Under **Additional Settings**, configure the event details: i. **Event Type** — select the type of conversion event (for example, **Add to Shopping Cart**). ii. **Event Source** — select where the event originates (for example, **Website**). iii. **Event Name** — enter the name of the imported event. iv. **Country Code** — enter the ISO 3166-1 alpha-2 country code (for example, `US` or `DE`). > [!NOTE] > > **Note:** > > Keep the **Event Name** consistent for a given **Event Type**. Once an event type (for example, *Add to Shopping Cart*) is configured with a specific Event Name, use the same Event Name for all future occurrences of that event type to ensure accurate tracking and attribution. ![The Additional Settings section of the Mapping screen, with Event Type set to Add to Shopping Cart, Event Source set to Website, and empty Event Name and Country Code fields; the consent-signal information message sits above it.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/amazon-conversions-api/amazon-conversions-api-2026-06-11-5.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=3b142229479c366e60a131bec5edf6ec) **Step 8** Click **Create Destination**. The created destination is listed in the **Audiences** application and can be activated through Journeys. ## Add the destination to a journey The **Send Events to Amazon** action runs in Journeys. After creating the destination, attach it using the **Send to Destinations** node within your workflow. For details on activating real-time destinations, see [Activate Your Real Time Audiences](/articles/integrate-customer/activate-your-real-time-audiences). > [!NOTE] > > **Note:** > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an Audience or a segment could be a specific group of customers who are over 18 years of age and who have performed an `addToCart` event within the last 30 days. ## Verify events in Amazon Ads Once the destination is activated and events begin flowing, you can verify them in the Amazon Ads console: **Step 1** In the Amazon Ads console, open the advertiser linked to this destination. **Step 2** From the left navigation, open **Events manager**. **Step 3** Open the **Conversions** tab to see the conversion events received through the Conversions API. Each row shows the **Data source** (Conversions API), the **Source account**, the **Conversion name** and **Conversion type**, the **Count method**, the **Event count** and the **Excluded events** percentage. ![The Conversions tab of Events manager in the Amazon Ads console, listing conversions whose Data source reads Conversions API, with columns for Source account, Conversion name, Conversion type, Count method, Event count and Excluded events.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/amazon-conversions-api/amazon-conversions-api-2026-06-11-6.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=da26b16f819ddac8778d3a0d7bee4743) ## Troubleshoot event delivery | What you see | What to check | | - | - | | The **Conversions** tab shows no rows shortly after activation. | Allow time for the first events to be processed before treating an empty view as an error. | | The **Amazon ad tag events** tab shows "No activity yet". | That tab lists tag-based events, not events received through the Conversions API. Check the **Conversions** tab instead. | | Event counts for the same kind of conversion are split across several rows. | Events manager lists one conversion per **Conversion name**. Keep the Event Name consistent for a given Event Type so counts attribute accurately. | | You cannot move past the **Mapping** screen. | **Event Timestamp** is mandatory. You cannot proceed until every mandatory field in **Map the Fields** is mapped. | | Amazon reports a compliance problem with your uploads. | Amazon Ads requires a country code for all data uploads globally, so confirm **Country Code** is set under **Additional Settings**. If you transmit data from UK or EEA users, a consent signal is also required — see Amazon's [consent signal requirements](https://advertising.amazon.com/resources/ad-policy/consent-signal-requirements). | For destination-level delivery errors and when to raise a support ticket, see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail). ## Next steps * [Activate your real-time audiences in Journeys →](/articles/integrate-customer/activate-your-real-time-audiences) * [Configure a destination →](/articles/integrate-customer/destinations#configure-a-destination) * [Define the mapping →](/articles/integrate-customer/destinations#define-the-mapping) * [Create a Destination →](/articles/integrate-customer/create-a-destination) * [Explore Destination Access Rules →](/articles/integrate-customer/destination-access-rules) * [Send audiences to Amazon DSP instead →](/articles/integrate-customer/amazon-dsp-dp-audience) # Amazon DSP Source: https://docs.zeotap.com/articles/integrate-customer/amazon-dsp Configure an Amazon DSP destination in Zeotap CDP to send audience identifiers to your Amazon DSP advertiser account for programmatic display and video targeting. ## What this is Amazon DSP is a programmatic advertising platform for buying display and video ads across Amazon-owned properties and third-party websites and apps. The Zeotap CDP integration sends audience identifiers — Zeotap Cookies for Amazon and Mobile Advertising IDs (MAIDs) — to an Amazon DSP advertiser account, where they surface as custom segments you can target inside Amazon Campaign Manager. This page walks through the one-time destination setup, how to link an audience to it, how to handle consent for EEA and UK users, and how to confirm the segment arrived on the Amazon DSP seat. ## Prerequisites > [!NOTE] > > Before you configure this destination, gather: > > * Your **Advertiser Id** — the Amazon DSP Ad Account ID that will receive the audience. > * The **Currency** of the Amazon DSP account. > * The **Advertiser Account Region** of the Amazon DSP account. > * Access to the **Destinations** application in your Zeotap CDP workspace. > * If your audience includes users in the European Economic Area (EEA) or the United Kingdom (UK): a consent strategy that limits audience membership to users who have granted the Amazon Consent Signal. See [Consent handling for EEA and UK users](#consent-handling-for-eea-and-uk-users) below. ## Supported identifiers and actions This integration supports **Zeotap Cookies for Amazon** and **MAIDs** as identifiers. | Action | [ID Extension](/articles/segment-customer/extend-your-audience#id-extension) | Delete | Delta Upload | | :- | :-: | :-: | :-: | | Send identifiers to Amazon DSP | ✅ | ✅ | — | For the definition of each action, see the [destination actions reference](/articles/integrate-customer/destinations#key-concepts). ## Consent handling for EEA and UK users Effective 7 February 2025, Amazon requires a consent string or Amazon Consent Signal (`amazonAdStorage`, `amazonUserData`) for users in the EEA and the UK. Refer to the [Amazon consent signal requirements](https://advertising.amazon.com/resources/ad-policy/consent-signal-requirements) for full details. Audience uploads without consent information are rejected. Zeotap CDP transmits the **GRANTED** Amazon Consent Signal for every user who qualifies in an audience. The consent payload Zeotap sends per qualified user has the shape: ```json theme={null} { "amazonAdStorage": "GRANTED", "amazonUserData": "GRANTED" } ``` To keep non-consented users out of the audience in the first place, use one of the following: * Apply consent filters in [Zeotap's Consent Orchestration Tool](https://docs.zeotap.com/smart/project-protect/consent-orchestration-2830401643) within Protect. * Apply consent filters while [creating an audience](https://docs.zeotap.com/articles/segment-customer/apply-attributes-to-your-audience/a/h2__379464276). > [!WARNING] > > Audience uploads that include EEA or UK users without a granted Amazon Consent Signal are rejected by Amazon DSP. Apply a consent filter before you activate an audience that targets those regions. ## Configure the Amazon DSP destination **1. Open the Destinations application** Log into the Zeotap CDP App and go to the **DESTINATIONS** application. **2. Start a new destination** Click **+ Create Destination**. ![Destinations application listing with the Create Destination button](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_1.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=92dfe8ecb29e59c9d7d57cb954e54618) **3. Locate Amazon DSP in the catalogue** Under **All Destinations**, search for **AmazonDSP** and click the tile. ![Searching the All Destinations catalogue](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_2.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=6f5f0f5367788fb4e9e946f4b3cb5874) **4. Enter the account details** On the destination configuration screen, fill in the right-hand form: a. Enter a **name** for the Destination. b. Enter the **Advertiser Id** — the Amazon DSP Ad Account ID on which the audience will be created. c. Choose the **Currency** from the drop-down menu. d. Select the **Advertiser Account Region** from the drop-down menu. e. Click **Next** to proceed to mapping. ![AmazonDSP destination configuration form with the Destination Name, Advertiser ID, Currency and Advertiser Account Region fields](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/amazon-dsp/amazon-dsp-2023-11-07.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=e8fadb658e5c664bec7d7e6c501be61e) **5. Map identifiers to the destination** On the **Actions and Mapping** screen: a. Under **Choose your Action**, select **Send identifiers to Amazon DSP**. b. Under **Map the Fields**, map the Zeotap catalogue identifiers you want to send (Zeotap Cookies for Amazon and MAIDs) to the corresponding Amazon DSP fields. c. Click **Create Destination**. The created Destination appears in the **Audiences** application, ready to be linked to an audience. ## Link an audience and set the Data Source Country After the destination exists, link it to an audience from the Audiences application. For the full linking flow, see [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination). > [!WARNING] > > After linking, set the **Data Source Country** value under **Audience Settings** on the Activation screen. Without this value, Amazon DSP cannot classify the audience for regional targeting. ![Data Source Country field under Audience Settings on the Activation screen](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/amazon-dsp/amazon-dsp-2025-02-06-2.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=88102f0c6215d4ee3c34985bb117d3cb) ## Verify the audience arrived in Amazon Campaign Manager Audience data takes up to two to three days to populate at the Amazon DSP seat after linking. Once that window has elapsed, confirm delivery from the Amazon side. > [!NOTE] > > The following steps happen in Amazon Campaign Manager, outside Zeotap CDP. **1. Open Amazon Campaign Manager** Log in to **Amazon Campaign Manager** and open the **Audiences** tab. **2. Filter by source** Under **OTHER SOURCES**, select the checkboxes that match the type of segment you are looking for: * **Standard segments** — select **Third-party** and **Zeotap**. These segments are pre-created by Zeotap and become available once third-party data access is enabled for your organisation. A standard segment contains a single attribute. * **Custom segments** — select **Advertiser audiences** and **DMP**. These are the audiences you built in Zeotap CDP and linked to this destination; they can contain more than one attribute. ![Amazon Campaign Manager Audiences tab filtered by OTHER SOURCES checkboxes](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/amazon-dsp/amazon-dsp-2024-05-01-2.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=7b91013377b55c2adc0ef3ce729becf5) ## How you know it worked The audience you linked in Zeotap CDP appears in Amazon Campaign Manager's **Audiences** tab under **Advertiser audiences** / **DMP** within two to three days of linking. From there, attach it to a line item or campaign to start targeting. ## User disqualification from audiences When a user stops meeting the audience criteria — because attributes changed, consent was withdrawn, or another condition is no longer satisfied — Zeotap CDP issues a user-deletion request on the next refresh cycle to every destination linked to that audience. Disqualified users are removed from the Amazon DSP segment on the refresh frequency configured for the audience. The process is automatic; no manual trigger is required. ## Troubleshooting Common failure modes when sending audiences to Amazon DSP, and where to fix each one: | Symptom | What it means | Where to fix | | - | - | - | | Segment not visible in Amazon Campaign Manager after linking | Propagation to the Amazon DSP seat takes up to two to three days after the first activation — wait for that window to elapse before treating it as an error | Amazon Campaign Manager → **Audiences** → **OTHER SOURCES** → check **Advertiser audiences** and **DMP** | | Segment appears but is empty | The linked audience has no qualifying members with a supported identifier (Zeotap Cookies for Amazon or MAID), or the **Data Source Country** was not set | Zeotap CDP → Activation screen → **Audience Settings**; confirm the audience contains supported identifiers | | Destination cannot be created — Advertiser Id rejected | The **Advertiser Id** entered does not match a valid Amazon DSP Ad Account | Confirm the Ad Account ID in your Amazon DSP account and re-enter it in the destination configuration | If the symptom you see is not in this table, or the fix above does not resolve it, contact your Zeotap customer success representative. Include in your request: * The destination name and ID * The audience ID * The timestamp of the activation * A description of what you see (or do not see) in Amazon Campaign Manager ## FAQ > [accordion] How long does audience data take to appear on the Amazon DSP seat? > > Up to two to three days after you link the audience to the destination. Wait for that window to elapse before treating an empty segment in Amazon Campaign Manager as an error. > [accordion] Which identifiers can I send to Amazon DSP? > > Zeotap Cookies for Amazon and Mobile Advertising IDs (MAIDs). Map these under **Map the Fields** during destination setup. > [accordion] Do I need to remove disqualified users from the audience manually? > > No. When a user stops meeting the audience criteria, Zeotap CDP issues a deletion request to Amazon DSP on the next refresh cycle for that audience. The process runs automatically on the audience's configured refresh frequency. > [accordion] What happens if I skip the Data Source Country setting? > > The audience will not be classified for regional targeting on Amazon DSP. Set the **Data Source Country** under **Audience Settings** on the Activation screen after linking the audience. ## Next steps * [Explore Amazon DSP — DP Audience →](/articles/integrate-customer/amazon-dsp-dp-audience) for the DP Audience variant of this destination, which collects an Advertiser ID and an Account Region but no Currency. * [Explore Amazon Conversions API →](/articles/integrate-customer/amazon-conversions-api) to send server-to-server conversion events to Amazon DSP through Journeys. * [Explore Amazon Marketing Cloud →](/articles/integrate-customer/amazon-marketing-cloud) for privacy-safe clean-room analysis of your CDP segments alongside Amazon Ads signals. * [Explore linking an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) for the full audience activation walkthrough. # Amazon DSP - DP Audience Source: https://docs.zeotap.com/articles/integrate-customer/amazon-dsp-dp-audience Send Zeotap CDP audiences to Amazon DSP as first-party (Advertiser) audiences for targeting across Amazon-owned and third-party inventory. ## What this is Amazon DSP - DP Audience is a Zeotap destination that pushes an audience (segment) from Zeotap CDP into Amazon DSP as an Advertiser (first-party) audience. Amazon DSP is a programmatic advertising platform for buying display and video ads across Amazon-owned properties and third-party sites and apps. Use this destination when you want your CDP-built audience to appear alongside your other advertiser-owned audiences inside Amazon DSP's Campaign Manager under the `Advertiser Audiences` source — separate from Amazon's native third-party segments. This page walks through creating the destination, linking an audience to it, and confirming delivery inside Amazon DSP. ## Prerequisites > [!NOTE] > > Before you create the destination, gather the following: > > * Your **Advertiser ID** — the Amazon DSP Ad Account ID for the account that will receive the audience. > * Your Amazon DSP **Account Region** — North America or Europe. > * The **Data Source Country** value (the country where the customer data was collected) that will be applied at the audience level. > * Sign-in credentials for the Amazon DSP account with permission to authorize Zeotap during the connection flow. This destination supports the following identifiers: ```text theme={null} Supported identifiers: - Zeotap Cookies for Amazon - MAIDs (Mobile Advertising IDs) ``` ## Create the destination Perform the following steps in the Zeotap CDP app to create an Amazon DSP - DP Audience destination. **Step 1** Log into the Zeotap CDP app and open the **DESTINATIONS** application. **Step 2** Click **+ Create Destination**. ![Destinations application with the + Create Destination button](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_1.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=92dfe8ecb29e59c9d7d57cb954e54618) **Step 3** Under **All Destinations**, search for **Amazon DSP - DP Audience**. ![Searching for a destination under All Destinations](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_2.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=6f5f0f5367788fb4e9e946f4b3cb5874) **Step 4** Click **Amazon DSP - DP Audience**. A configuration screen opens with the destination description on the left and the connection fields on the right. a. Enter a **name** for the destination. b. Enter the **Advertiser ID** for the Amazon DSP account that will receive the audience. c. Select the **Account Region** from the drop-down — **North America** or **Europe**. d. Click **Connect Amazon DSP - DP Audience** and complete the Amazon sign-in flow in the window that opens. **Next** stays disabled until the connection succeeds. e. After a successful login, click **Next** to proceed to the mapping section. ![Amazon DSP - DP Audience configuration screen with the Destination Name, Advertiser ID and Account Region fields and the Connect Amazon DSP - DP Audience button](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/amazon-dsp-dp-audience/amazon-dsp-dp-audience-2025-11-20.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=3bb0977699fccc888b7f142c7939afd3) **Step 5** On the **Actions and Mapping** screen, configure the action and identifier mapping. a. Under **Choose your Action**, select the desired [action](/articles/integrate-customer/destinations#actionsanchor) for this integration. b. Under **Map the Fields**, map each Zeotap catalogue identifier (Zeotap Cookies for Amazon, MAIDs) to the corresponding Amazon DSP field. c. In the **Additional Settings** section, select the appropriate **Data Source Country**. d. Click **Create Destination**. The destination is added to the list in the **Audiences** application and is ready to be linked to a segment. ## Link an audience to the destination After the destination exists, link a Zeotap audience to it from the **Audiences** application. Refer to [Link an audience to a destination](/articles/integrate-customer/link-an-audience-to-the-destination) for the linking workflow. > [!NOTE] > > When you link the audience, set the **Data Source Country** value under **Audience Settings** on the Activation screen. This value applies to every customer who qualifies for the audience. ![Data Source Country setting under Audience Settings on the Activation screen](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/amazon-dsp/amazon-dsp-2025-02-06-2.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=88102f0c6215d4ee3c34985bb117d3cb) Audience data can take up to two to three days to populate at the Amazon DSP seat after the audience is linked and activated. ## Verify audiences in Amazon DSP Confirm that Zeotap-delivered audiences reached your Amazon DSP account. **Step 1** Log into the Amazon DSP console. **Step 2** Open **Campaign Manager** from the administration toolbar. **Step 3** In the left navigation, click **Audiences**. ![Audiences option in the Amazon DSP Campaign Manager left navigation](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/amazon-dsp-dp-audience/amazon-dsp-dp-audience-2025-11-19.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=d2b1651e91d736d191aafcb4dce0910b) **Step 4** In the **Source** filter on the left, check the box for **Advertiser Audiences**. This hides Amazon's native segments and shows only the first-party data you ingested — including the audience you activated from Zeotap CDP. ![Source filter with the Advertiser Audiences box checked in Amazon DSP](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/amazon-dsp-dp-audience/amazon-dsp-dp-audience-2025-11-19-1.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=214347a6324f6776831d7c29517eced1) The audience appears under **Advertiser Audiences** with the name you gave it when creating the segment in Zeotap CDP. If it does not appear within three days of activation, use the troubleshooting table below. ## Why an activated audience does not appear Use the table below to interpret what you see (or do not see) in Amazon DSP and where to check next. | Signal | What it means | Where to look | | - | - | - | | Audience is not visible in Amazon DSP within three days of activation | Delivery is still in progress or the destination is not correctly linked to the audience | Zeotap CDP → **Audiences** — confirm the audience is linked to the Amazon DSP - DP Audience destination and has been activated | | Amazon DSP Audiences view shows only Amazon's native segments | The **Source** filter is not restricted to **Advertiser Audiences** | Amazon DSP → Campaign Manager → Audiences → **Source** filter → check **Advertiser Audiences** | | Audience uploads rejected for EEA and UK users | Amazon requires consent information (`amazonAdStorage`, `amazonUserData`) for European Economic Area and United Kingdom users. Uploads without this are rejected per [Amazon's consent signal requirements](https://advertising.amazon.com/resources/ad-policy/consent-signal-requirements) | Apply consent filters in Zeotap's Consent Orchestration Tool or while creating the audience — see the [Amazon DSP](/articles/integrate-customer/amazon-dsp) page for the consent workflow | | Amazon sign-in did not complete during connection setup | The OAuth authorization to Amazon Ads did not finish; the destination has no valid token | Zeotap CDP → **Destinations** → open the destination → click **Connect Amazon DSP - DP Audience** again | | Wrong or missing country on the activated records | The **Data Source Country** at the Audience Settings level is missing or set incorrectly | Zeotap CDP → **Audiences** → linked destination → Activation screen → **Audience Settings** → **Data Source Country** | ## FAQ > [accordion] How is 'Amazon DSP - DP Audience' different from the 'Amazon DSP' destination? > > Both destinations push audiences to Amazon DSP, but they collect different configuration. The **Amazon DSP - DP Audience** destination requires an **Advertiser ID** and an **Account Region** (North America or Europe), and uses the **Connect Amazon DSP - DP Audience** OAuth flow to authorize Zeotap. The base [Amazon DSP](/articles/integrate-customer/amazon-dsp) destination requires an **Advertiser ID**, a **Currency** and an **Advertiser Account Region**. Check with your Amazon Ads representative on which is enabled for your seat. > [accordion] How long does an activated audience take to appear in Amazon DSP? > > Audience data can take up to two to three days to populate at the Amazon DSP seat after you link and activate the audience. > [accordion] Why do I only see Amazon's native segments in the Audiences view? > > The Amazon DSP Campaign Manager **Audiences** view shows all sources by default. To see the first-party audiences you delivered from Zeotap CDP, set the **Source** filter to **Advertiser Audiences**. This hides Amazon's native segments. > [accordion] Which identifiers does this destination accept? > > Zeotap Cookies for Amazon and MAIDs (Mobile Advertising IDs). ## Next steps * [Explore the base Amazon DSP destination →](/articles/integrate-customer/amazon-dsp) * [Explore Amazon Conversions API for server-to-server conversion events →](/articles/integrate-customer/amazon-conversions-api) * [Explore Amazon Marketing Cloud (AMC) for clean-room audiences →](/articles/integrate-customer/amazon-marketing-cloud) * [Explore how to link an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) # Amazon Marketing Cloud (AMC) Source: https://docs.zeotap.com/articles/integrate-customer/amazon-marketing-cloud Send audience segments from Zeotap CDP into Amazon Marketing Cloud as pseudonymised, SHA-256 hashed identifiers for clean-room analysis and DSP activation. ## What this is Amazon Marketing Cloud (AMC) is a privacy-safe, cloud-based clean-room environment operated by Amazon Ads that stores pseudonymised, event-level Amazon Ads signals — impressions, clicks, and purchases — and lets you build audiences from custom queries. This integration sends audiences from Zeotap CDP into AMC as SHA-256 hashed identifiers plus optional PII attributes, so you can combine your first-party segments with Amazon Ads signals for overlap analysis, journey measurement, and Amazon DSP activation. It differs from the [Amazon Conversions API](/articles/integrate-customer/amazon-conversions-api) integration, which forwards conversion events into Amazon DSP rather than audiences into AMC. ## Prerequisites > [!NOTE] > > Before you create the AMC Destination, make sure the following are in place: > > * An Amazon Marketing Cloud account. AMC accounts come in two forms: **fully managed by Amazon** (your Amazon point of contact creates the Connection ID for you) and **self-serve** (you create the Connection ID yourself via the Amazon Ads API). > * A **Connection ID** issued by Amazon Ads that references the AMC instance and Amazon DSP advertiser you want to activate against. See [Obtain a Connection ID](#obtain-a-connection-id) below. > * Amazon Ads sign-in credentials with authorisation to grant Zeotap CDP access to the referenced AMC instance. > * The **country** in which the customer data is collected and the **region** (North America or Europe) to which your AMC instance is subscribed. ## What this integration supports The integration sends the following identifiers and attributes to AMC: * External User ID * Hashed Email Addresses (SHA-256) * Hashed Cellphone Numbers (SHA-256) * First Name * Last Name * Address * City * State * Postal * Country Code The single action available is **Send Identifiers and Attributes to AMC Audiences**. This integration does not support [ID Extension](/articles/segment-customer/extend-your-audience#id-extension), Delete, or Delta Upload. ## Obtain a Connection ID A Connection in Amazon Ads is an object that stores the mapping of an AMC instance to an Amazon DSP advertiser; Amazon Ads uses it as the target for audience creation, targeting, and activation. * **Fully managed AMC accounts** — your Amazon point of contact provisions the Connection ID. Request it from them and paste it into the Destination configuration in Zeotap CDP. * **Self-serve AMC accounts** — call the Amazon Ads `AmcpLinkAddConnectionV2` API with the required parameters and schema. The response returns the Connection ID. See the [Amazon Ads API reference](https://advertising.amazon.com/API/docs/en-us/amc-advertiser-audience#tag/Connections/operation/AmcpLinkAddConnectionV2) for the full request contract. The Amazon Ads Connections API expects the following media type in the request headers: ```http theme={null} Accept: application/vnd.amcaudiencesconnections.v1+json Content-Type: application/vnd.amcaudiencesconnections.v1+json ``` Store the returned Connection ID for the Destination configuration step below. ## Choose the country and region **Country** — the country in which the customer data is collected. You select this from a dropdown in the Destination configuration; Zeotap CDP converts your selection into the 2-character ISO 3166 format required by AMC. Country can be set at two levels: * **Audience-metadata level** — the Country you choose while creating the Destination. It applies to every customer who qualifies for any audience linked to that Destination. * **Record level** — the field you map for `Country Code` on the **Actions and Mapping** screen. Zeotap CDP offers a catalogue field named **User Source Country** that stays up to date with the latest country of the customer entering the system; map **User Source Country** → `Country Code` to send the freshest per-record country to AMC. ![Country selection at the audience-metadata and record levels in the AMC Destination configuration](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/amazon-marketing-cloud/amazon-marketing-cloud-2024-07-31.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=600d09e24f1602d66f4924969ab0ec69) > [!WARNING] > > When both are present and disagree, the **record-level** Country Code supersedes the audience-level Country. Confirm which behaviour you want before mapping `Country Code`. **Region** — the region to which your AMC instance is subscribed. Select **North America** or **Europe** based on your Amazon DSP Advertiser Account region. Audiences reach connected AMC instances regardless of the endpoint region you select here. ## Create the AMC Destination Work through the Destination creation flow in the **DESTINATIONS** application of the Zeotap CDP App. 1. In the **DESTINATIONS** application, click **+ Create Destination**. ![Create Destination button in the DESTINATIONS application](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/amazon-marketing-cloud/amazon-marketing-cloud-2024-07-31-1.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=2503f41488072d0c2d9a851fd0414978) 2. Under **All Destinations**, search for and select **Amazon Marketing Cloud**. ![Searching for Amazon Marketing Cloud under All Destinations](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/amazon-marketing-cloud/amazon-marketing-cloud-2024-07-31-2.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=33305b8e4c368dc5f41d8d4c71e9dc1d) 3. On the Destination configuration screen, enter: * A name for the Destination in **Destination Name**. * The Connection ID for your advertiser account on AMC in **Connector Id** (see [Obtain a Connection ID](#obtain-a-connection-id)). * The country where the customer data is collected in **Audience Country**. * The region to which your AMC instance is subscribed in **Account Region**. ![AMC Destination configuration screen with the Destination Name, Connector Id, Audience Country and Account Region fields](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/amazon-marketing-cloud/amazon-marketing-cloud-2024-07-31-3.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=c93bcba17f8a36eeb0c6ce5427cda67e) 4. Click **Connect Amazon Marketing Cloud**. Sign in to your AMC account in the Amazon window that opens. Signing in grants Zeotap CDP permission to manage the referenced AMC instance. ![Amazon sign-in window for connecting Zeotap CDP to AMC](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/amazon-marketing-cloud/amazon-marketing-cloud-2024-07-31-4.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=b54950e47d75909207a7aab994d5753c) 5. Back in Zeotap CDP, confirm that the **Access Token** and **Refresh Token** fields have auto-populated, along with the Access Token expiry period. Click **Next**. ![Access Token and Refresh Token auto-populated after connecting to AMC](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/amazon-marketing-cloud/amazon-marketing-cloud-2024-07-31-5.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=54f70876de696d9f92d043a263589eb6) 6. On the **Actions and Mapping** screen, under **Choose your Action**, select **Send Identifiers and Attributes to AMC Audiences**. Under **Map the Fields**, map each Catalogue field to the corresponding AMC Destination field. Apply SHA-256 hashing to Email and Cellphone Number in your Catalogue mapping before sending. ![Actions and Mapping screen with the Send Identifiers and Attributes to AMC Audiences action selected](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/amazon-marketing-cloud/amazon-marketing-cloud-2024-07-31-7.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=ee1481adca6b8e62efb76ca762b88dcd) 7. Review the mapping and click **Create Destination**. The Destination is now listed in the **Audiences** application and can be linked to any audience. ## Verify the Destination is ready Before linking an audience, confirm the three signals that show the Destination is configured correctly: * On the Destination configuration screen, the **Access Token**, **Refresh Token**, and Access Token expiry values are populated (not blank). * The Destination appears in the list in the **Audiences** application under the name you provided. * The Country and Region values match the AMC instance you intend to activate against. ## Link an audience to the Destination For the full linking flow, see [Link an Audience to the Destination](/articles/integrate-customer/link-an-audience-to-the-destination#h3_64671714). > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category — for example, a group of customers who are over 18 and who performed an `addToCart` event within the last 30 days. ## Troubleshooting Use this table to diagnose customer-observable conditions during Destination setup and activation. | Condition | What this means | Where to look | | - | - | - | | Records reach AMC with a country different from the audience-level Country you selected | A record-level `Country Code` mapping is in place and its value overrides the audience-level Country when the two disagree | **Actions and Mapping** → the field mapped to `Country Code` on the Destination | | **Access Token** and **Refresh Token** fields are empty after returning from the Amazon sign-in window | The OAuth authorisation to Zeotap did not complete against AMC | Destination configuration screen; re-run **Connect to Amazon Marketing Cloud** | | **Connect to Amazon Marketing Cloud** does not produce a working Destination | The Connection ID entered does not reference an AMC instance or DSP advertiser your signed-in Amazon Ads user has permission to use | Amazon Ads Connections (retrieved via `AmcpLinkAddConnectionV2`); verify the Connection ID with your Amazon point of contact or the API response | | Access Token expiry has elapsed and activation has stopped delivering | The stored Access Token expired and was not renewed via the Refresh Token | Access Token expiry timestamp on the Destination configuration screen | **Resolution steps** 1. If **Access Token** and **Refresh Token** did not populate, click **Connect to Amazon Marketing Cloud** again and complete the Amazon sign-in flow to the end, granting Zeotap CDP the requested permissions. 2. If the Connection ID is not recognised, retrieve it again — for fully managed accounts, from your Amazon point of contact; for self-serve accounts, by re-calling `AmcpLinkAddConnectionV2` and copying the ID from the response. Update the Destination with the corrected ID. 3. If a record-level country is overriding the audience-level Country unintentionally, remove the mapping to `Country Code` on the **Actions and Mapping** screen, or remap it to **User Source Country** for the freshest per-record value. 4. If none of the above resolves the condition, contact your Zeotap customer success representative. Include: the Destination name, the Connection ID, the audience ID, the Country and Region you configured, and the timestamp of the last successful activation. ## FAQ > [accordion] Do I need to hash Email and Cellphone Number before sending to AMC? > > Yes. The integration accepts Email and Cellphone Number only as **SHA-256 hashed** values. Apply the hash in your Catalogue mapping before the Destination sends the record to AMC. > [accordion] Which Region should I choose if my AMC instance and DSP advertiser are in different regions? > > Select the region that matches your **Amazon DSP Advertiser Account region** (North America or Europe). Audiences reach connected AMC instances regardless of the endpoint region you select. > [accordion] What happens when the audience-level Country and the record-level `Country Code` disagree? > > The **record-level** value wins. Map `Country Code` only when you want the per-record country to override the audience-metadata Country you selected during Destination creation. > [accordion] How is this integration different from Amazon Conversions API? > > This integration sends **audiences** into AMC's clean-room environment for analysis and DSP activation. The [Amazon Conversions API](/articles/integrate-customer/amazon-conversions-api) integration is a separate, server-to-server pipeline that forwards **conversion events** into Amazon DSP. ## Next steps * [Explore Amazon Conversions API →](/articles/integrate-customer/amazon-conversions-api) * [Explore linking an audience to a Destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore Audience ID extension →](/articles/segment-customer/extend-your-audience#id-extension) * [Explore Amazon S3 as a source →](/articles/integrate-customer/amazon-s3) # Amazon S3 source overview Source: https://docs.zeotap.com/articles/integrate-customer/amazon-s3 Bring data from your Amazon S3 bucket into Zeotap CDP as a Data Warehouse source, and keep it refreshed on a sync schedule you choose. ## What this is The Amazon S3 source brings data **into** Zeotap CDP: it connects directly to the data residing in your own Amazon (AWS) S3 bucket through the Sources module, so you do not have to stage those files anywhere else first. Amazon S3 is the object storage service provided by Amazon Web Services, and in the Zeotap CDP source form it sits under the **Data Warehouse** category. Once the source exists, Zeotap CDP re-reads the bucket on the **Sync Frequency** you set, so the data you have onboarded stays in step with what you hold in S3. > [!NOTE] > > **Amazon S3 works in both directions.** This page covers the **source** side — reading data from your S3 bucket into Zeotap CDP. To send audiences from Zeotap CDP out to an S3 bucket instead, see [Amazon S3 destination](/articles/integrate-customer/amazon-s3-destination). ## Prerequisites > [!NOTE] > > Before you create an Amazon S3 source in Zeotap CDP, confirm: > > * You have an Amazon S3 account, and the data you intend to import already resides in it. > * You can supply the **Bucket Name**, the **S3 Bucket Region**, and the **Folder** path that holds the data. > * You can supply an **S3 Access Token** and an **S3 Secret Access Token** for that account. > > [Create and Implement an Amazon S3 Source](/articles/integrate-customer/create-and-implement-an-amazon-s3-source) shows where each of these values is found in your Amazon S3 account. ## What you configure in the source form Alongside the S3 connection details, the source form decides how Zeotap CDP reads the bucket: * **Select your Region** — the region of upload for the source. This is chosen separately from the **S3 Bucket Region** you enter for the bucket itself. * **Sync Frequency** — how often Zeotap CDP re-reads the bucket. The Amazon S3 source supports Daily, Weekly and Monthly. The first sync starts once you create the source; every later sync follows this setting. * **Delta Queries Selection** — set it to **true** and and Zeotap CDP fetches the data that has been updated in your S3 bucket since the last sync, rather than re-reading everything. * **What is your file type?** — CSV or JSON. * **Data Entity** — whether the records are **Customer Data** or **Non Customer Data**. See [Supported Data Entities](/articles/unify-customer/supported-data-entities). After the source is created, the **IMPLEMENTATION DETAILS** tab shows the information about the source you created. ## Next steps * [Explore the full Amazon S3 source setup, field by field →](/articles/integrate-customer/create-and-implement-an-amazon-s3-source) * [Explore the Amazon S3 destination, for sending audiences out to a bucket →](/articles/integrate-customer/amazon-s3-destination) * [Explore the other Data Warehouse sources Zeotap CDP supports →](/articles/integrate-customer/data-warehouse) * [Explore how sources work across Zeotap CDP →](/articles/integrate-customer/sources) # Amazon S3 Source: https://docs.zeotap.com/articles/integrate-customer/amazon-s3-destination Send Zeotap CDP audiences out to an Amazon S3 bucket as CSV files, using the Amazon S3 destination. ## What this destination does Amazon S3 (Simple Storage Service) is a widely used object storage service provided by Amazon Web Services (AWS). This page documents Amazon S3 as a **destination** — data flows *out* of Zeotap CDP. Once the destination is created and an audience (segment) is linked to it, Zeotap CDP writes that audience to a bucket you own as CSV files, which you can then use for delivering more personalised targeting across your touch points. To move data the other way — reading data *into* Zeotap CDP from a bucket you own — see the [Amazon S3 source](/articles/integrate-customer/amazon-s3) and [Create and Implement an Amazon S3 Source](/articles/integrate-customer/create-and-implement-an-amazon-s3-source). ## Prerequisites > [!NOTE] > > Before you create an Amazon S3 destination in Zeotap CDP, have the following ready: > > * An **Amazon S3 account** containing the bucket you want Zeotap CDP to export into. > * The bucket details covered in [Gather your Amazon S3 details](#gather-your-amazon-s3-details): the **Bucket** name, the **S3 Bucket Region**, the **Folder** path, and the **Access Token** and **Secret Access Token**. > * An audience (segment) defined in Zeotap CDP, if you want to link one as soon as the destination exists. ## Supported identifiers and actions This integration supports MAIDs, hashed email addresses, hashed mobile numbers and CRM IDs. You can send any number of identifiers and attributes to Amazon S3 using this integration. | Action | [ID EXTENSION](/articles/segment-customer/extend-your-audience#id-extension) | [DELETE](/articles/segment-customer/delta-upload-and-delete-functions) | [DELTA UPLOAD](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :-: | :-: | :-: | | Send identifiers to Amazon S3 | ✅ | — | — | | Send attributes and identifiers to Amazon S3 | — | — | — | ## Gather your Amazon S3 details Collect the following from your Amazon S3 account before you create the destination. ### Bucket This is the name of your S3 bucket. You can obtain this information on your Amazon S3 account by navigating to **Buckets**. In the example shown below, **test-adobe-s3-bucket** is the bucket name. ![The bucket detail page in the Amazon S3 console with the bucket name test-adobe-s3-bucket highlighted](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-an-amazon-s3-source/amazon_s3_pre_1_\(1\).png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=285e645295f67b8e7ed9880ed63f79fe) ### S3 Bucket Region This is the geographical location where the Amazon S3 storage is available. You can obtain this information by navigating to the **Properties** tab under the Amazon S3 bucket as shown in the image below. ![The Properties tab of an Amazon S3 bucket, with the AWS Region shown under Bucket overview](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-an-amazon-s3-source/amazon_s3_pre_2_\(1\).png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=d4920504cf29017e61b52e67b48d80d6) ### Folder In Amazon S3, a folder serves as a logical container for organising stored objects within a bucket. In reality, there are no actual folders in Amazon S3. Instead, the folder concept is emulated by employing object key names containing slashes ("/") to replicate a hierarchical arrangement. You can obtain this information from your Amazon S3 account by navigating to the **Objects** tab under the Amazon S3 bucket. Ensure that you follow the folder structure shown below. ```text theme={null} folder_name/sub_folder_name/ ``` ### Access Token and Secret Access Token These are the security tokens that provide secure access to your Amazon S3 resources. You can obtain the Access Token and Secret Access Token by navigating to the **AWS IAM Credentials** tab under **Security credentials** in your Amazon S3 account. ## Create the Amazon S3 destination in Zeotap CDP **1. Open the Destinations application** Log into the Zeotap CDP App and go to the **DESTINATIONS** application, then click **+ Create Destination**. ![The + Create Destination button highlighted in the Destinations application](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/ADOBE_DMP_3.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=50d0558618336ceb78709191fcdda472) **2. Select Amazon S3 from the destination catalogue** Under the **All Destinations** section, search for **Amazon S3** and click it. ![The All Destinations search box in the Destinations module, with the destination catalogue listed below it](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/ADOBE_DMP_4.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=a0de06ff7f37752957c9f44c072aaebd) **3. Enter the destination details** A screen appears displaying details about the particular destination towards the left. On the right-hand side of the screen you find the list of fields required for the integration to be established. Provide the following: * **Destination Name** — a name for the destination, for easy identification. * **Destination Instance Name** — a value of your choice for this field. * **Bucket** — the name of the Amazon S3 bucket. * **Folder** — the folder path in your storage location where Zeotap CDP can store your exported data. * **Filename Prefix** — a text value without special characters, such as underscores (\_), spaces, or symbols (`#, @, $, %, &, /*`). The prefix is combined with the generated file name described below. * **Access Token** and **Secret Access Token** — the tokens you obtained from your Amazon S3 account. * **S3 Bucket Region** — the geographical region where your Amazon S3 bucket is available. * **Encryption Choice** — how the file is encrypted before it is written. The field has no default: open **Select your choices** and pick an option. The exported file name follows the format `${filenamePrefix}part-${sequence}_${destinationAudienceId}_${timestamp}.csv`, where the timestamp is the file generation time in epoch milliseconds (UTC) and `destinationAudienceId` is the ID associated with your audience (segment) in Zeotap CDP, generated after the audience (segment) is linked to a destination. | Variable | Description | | :- | :- | | `filenamePrefix` | The prefix for the file name, typically indicating the context or purpose of the file (for example, the segment or export type). | | `part-${sequence}` | A sequential number or identifier indicating the part or chunk number if the data is split across multiple files. | | `${destinationAudienceId}` | The unique ID assigned by Zeotap CDP to the audience (segment) after it is linked to a destination. | | `${timestamp}` | The time the file was generated, in epoch milliseconds (UTC) — for example, `1722931200000`. | | `.csv` | The file extension, indicating that the file is in CSV (Comma-Separated Values) format. | **Example file name:** `exportpart-0_894548842_1722931200000.csv` ![The ID that appears in the exported file name, highlighted in the Zeotap CDP audience view](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/integrate-customer/amazon-s3-destination/amazon-s3-destination-2025-08-06-1.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=9815ce4ace2add60e912e2a98028d8d4) Review all the values you entered and then click **Next** to proceed. ![The Enter Destination Details form for an Amazon S3 destination, filled in with example values](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/integrate-customer/amazon-s3-destination/amazon-s3-destination-2025-04-03.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=e808daf7f18fac25b22ca3068c435299) **4. Choose an action and map the fields** In the new screen that appears, choose the appropriate [action](/articles/integrate-customer/destinations#key-concepts) and mapping. Under **Choose your Action**, select either **Send identifiers to Amazon S3** or **Send attributes and identifiers to Amazon S3** as the action for activating your audience (segment) in Audiences. If you choose **Send identifiers to Amazon S3**, you can send MAIDs, IDP Base, raw mobile numbers and raw email addresses to Amazon S3. ![The Send identifiers to Amazon S3 action with the Output Identifiers Mapping table](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/integrate-customer/amazon-s3-destination/amazon_3_dd_2_nw.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=a9725a22f51132a2cb3886bf812b5a9b) If you choose **Send attributes and identifiers to Amazon S3**, you can send any attributes and identifiers to Amazon S3. Use the **+ Add Mapping Field** option to add the attributes and identifiers. ![The Send attributes and identifiers to Amazon S3 action with an attribute mapped using Add Mapping Field](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/integrate-customer/amazon-s3-destination/amazon_s3_dd_4.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=7f3a8d4cdfe855a20782f53a7d7f50b1) For more about how actions and mappings work across destinations, see [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). **5. Create the destination** Click **Create Destination**. The created destination gets listed in the **Audiences** application, where it can be linked to an audience. ## Link an audience to the destination For information about how to link an audience or segment to the created destination in the Audiences application, see [Link an Audience to the Destination](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience or a segment could be a specific group of customers who are over 18 years of age and who have performed an `addToCart` event within the last 30 days. ## Verify the export reached your bucket After you link an audience and an activation run completes, confirm delivery from both sides: 1. **In Zeotap CDP** — open the audience–destination pair and review its activity. A successful delivery records a completed run; a failed run records an error message you can use to diagnose the cause. 2. **In Amazon S3** — open the bucket you configured, go to the **Objects** tab, and navigate to the folder path you entered in the **Folder** field. Confirm that a `.csv` file is present and that its name matches the pattern described above, including your **Filename Prefix** and the generation timestamp in epoch milliseconds. ## Troubleshooting Delivery errors surface on the audience–destination pair in Zeotap CDP. For the shared error reference that applies to every destination, see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail). | Symptom | What to check | | :- | :- | | No file appears in the bucket after an activation run | The status and activity of the audience–destination pair in Zeotap CDP — a failed run records the error against the pair. | | Files arrive in the bucket, but not in the folder you expected | Check the **Folder** value on the destination against the folder structure described above. The `folder_name/sub_folder_name/` structure. | ## Next steps * [Explore the Amazon S3 source →](/articles/integrate-customer/amazon-s3) — bring data from a bucket into Zeotap CDP * [Explore linking an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) — activate an audience against the destination you just created * [Explore destination actions and mappings →](/articles/integrate-customer/destinations#key-concepts) * [Explore ID extension for audiences →](/articles/segment-customer/extend-your-audience#id-extension) — extend your audience across identifier types before exporting # Android SDK source Source: https://docs.zeotap.com/articles/integrate-customer/android-sdk Set up the Zeotap Android SDK source to collect events, identities, and consent from your Android and Android TV apps. ## What this is The Android SDK source is the Zeotap CDP entry point for first-party data collected from your Android and Android TV apps (including Amazon Fire TV). It pairs two components: a **Source** you create in the Zeotap CDP to receive events, and the **`ZeotapCollect` Android library** you embed in your app. The library tracks events, page views, user identities, user properties, and consent signals, and posts them to the Source using a `write_key` issued at Source creation. Once data lands in the CDP, you use it to build segments, view insights, and activate audiences to downstream destinations. ## Prerequisites > [!NOTE] > > Before you begin, confirm the following: > > * Access to the Zeotap CDP with permission to create Sources under **Integrate → Sources**. > * An Android project targeting **API level 19 (Android 4.4) or higher**. > * **Gradle 4.0 or higher** and **Java 8** source/target compatibility. > * For apps targeting Android 13 or above, the `com.google.android.gms:play-services-ads` dependency, so the SDK can retrieve the advertising ID. ## Create the Source in Zeotap CDP The Source issues the `write_key` your app authenticates with, so create it first. In the Zeotap CDP, open the **Sources** application under **Integrate**, start a new source, choose **App Events** as the category, and pick **Android Native SDK** as the data source. Enter a short descriptive name, select the upload region, and complete creation. The **IMPLEMENTATION DETAILS** tab then exposes the `write_key` and the SDK download link — keep both handy for the next step. For the full clickpath and screenshots, see [Create an Android SDK Source](/articles/integrate-customer/creating-android-sdk-source). ## Install and initialize the SDK Integrate `ZeotapCollect` through the Gradle dependency manager (recommended) or as a manual AAR. Once integrated, initialize the SDK in `MainApplication.java` with the `write_key` from the Source you created: ```java theme={null} import com.zeotap.collect.CollectOptions; import com.zeotap.collect.Collect; public class MainApplication extends Application { @Override public void onCreate() { super.onCreate(); CollectOptions options = CollectOptions.builder(this) .credential("") .enableLogging(true) .uploadBatchSize(5) .maxCacheSize(500) .useConsent(true) .checkForCMP(false) .build(); Collect.init(options); } } ``` Declare `MainApplication` in `AndroidManifest.xml`, and for apps targeting API 12 or higher add the `AD_ID` permission: ```xml theme={null} ``` Full installation options, `CollectOptions` builder methods, and the API reference live in [Implement the Android SDK Source](/articles/integrate-customer/implementing-android-sdk-source) and [Introduction to Zeotap Collect Android SDK](/articles/sdks/android/intro). ## Verify the integration After the SDK is initialized, fire a few test events from your app. In the Zeotap CDP, open the Source you created and check its **PREVIEW** tab — successful events appear there once they reach the platform. If events do not appear after your test batch is sent, work through the troubleshooting table below. ## Troubleshoot common integration issues Common setup problems and where to fix them: | Error string | What it means | Where to look | | - | - | - | | `flatDir is not supported` (Android Studio Bumblebee or higher) | The manual-AAR install path uses a `flatDir` repository that newer Gradle configurations reject. | Switch to the `sourceSets { main { jniLibs.srcDirs = ['libs'] } }` block in the app-level `build.gradle`, as documented in the manual install guide. | | Build fails on missing `com.google.android.gms.ads` class | The `AdID` retrieval path is enabled but the Play Services Ads dependency is not declared. | Add `implementation "com.google.android.gms:play-services-ads:20.4.0"` to the app-level `dependencies` block. | | Build fails on missing `com.google.gson` class | The SDK's JSON serialization requires Gson, which is not declared in the host project. | Add `implementation "com.google.code.gson:gson:2.10.1"` to the app-level `dependencies` block. | | Obfuscation conflicts when the SDK is used from a Kotlin project | Earlier SDK builds had a Kotlin obfuscation issue that produced runtime conflicts with third-party libraries. | Upgrade to SDK version 2.2.11 or higher — see the [release notes](/articles/integrate-customer/release-notes-android-sdk). | | Events fire in the app but do not appear in the Source's **PREVIEW** tab | Either the `write_key` passed to `CollectOptions.credential()` does not match the Source, or `useConsent(true)` is set and no consent has been supplied. | Recheck the `write_key` from the Source's **IMPLEMENTATION DETAILS** tab; if consent is enabled, confirm consent is set through `setConsent` or a CMP. | If none of the above resolves the symptom, contact your Zeotap customer success representative with the Source ID, the SDK version, the Android API level of the affected app, and a sample event payload from the app's local logs (`enableLogging(true)`). ## FAQ > [accordion] How is this page different from the Android SDK developer documentation? > > This page covers the Zeotap CDP side of the integration — creating the Android SDK Source and understanding how it fits into the CDP. The [Android SDK developer documentation](/articles/sdks/android/intro) covers the library itself: installation, `CollectOptions` configuration, the full API reference, consent handling, and release notes. > [accordion] Which Android versions does the SDK support? > > The SDK targets API level 19 (Android 4.4) and above, including Android TV and Amazon Fire TV. For apps built against Android 13 or higher, add the `com.google.android.gms:play-services-ads` dependency so the SDK can retrieve the advertising ID; on lower Android versions the SDK retrieves the ID on its own. > [accordion] Do I need to create the Source before installing the SDK? > > Yes. The SDK is initialized with the `write_key` that the Zeotap CDP issues when you create the Source. Without a Source, the SDK has no destination to post events to. > [accordion] Where do I see new versions of the SDK? > > All version changes are listed in the [Android SDK release notes](/articles/integrate-customer/release-notes-android-sdk), grouped by features, changes, and fixes for each release. ## Next steps * [Explore how to create an Android SDK Source →](/articles/integrate-customer/creating-android-sdk-source) * [Explore the full Android SDK implementation guide →](/articles/integrate-customer/implementing-android-sdk-source) * [Explore the Android SDK developer reference →](/articles/sdks/android/intro) * [Explore the Android SDK release notes →](/articles/integrate-customer/release-notes-android-sdk) * [Explore all Zeotap SDKs →](/articles/sdks/overview) # Apache Kafka Source: https://docs.zeotap.com/articles/integrate-customer/apache-kafka-destination Send identifiers and attributes out of Zeotap CDP to an Apache Kafka topic in real time from a Journeys workflow. ## What this destination does The Apache Kafka destination sends data **out of** Zeotap CDP into a Kafka topic you own. It is a real-time destination: you attach it to a **Send to Destinations** node in a [Journeys](/articles/orchestrate-customer/create-a-workflow) workflow, and the identifiers and attributes you map are published to your Kafka topic as users flow through the journey. Apache Kafka is an open-source distributed event streaming platform used for high-performance data pipelines, streaming analytics, data integration, and mission-critical applications. > [!NOTE] > > Zeotap CDP also has a Kafka **source**, which does the opposite — it ingests data *from* a Kafka topic *into* Zeotap CDP. If you want Kafka to feed Zeotap rather than receive from it, see [Kafka (source)](/articles/integrate-customer/kafka_message_queue) under [Message Queue](/articles/integrate-customer/message-queue). > > In the Zeotap CDP app, this destination is listed in the destination catalogue as **Kafka**, not "Apache Kafka". ## Prerequisites > [!NOTE] > > Before you create the destination, collect the following from your Kafka administrator or your cloud provider's Kafka management interface, and configure the topic on the Kafka side: > > * **Kafka Broker host** — the hostname and port of the Kafka broker. This is typically specified in the `server.properties` file under the `listeners` property in the Kafka installation directory, or provided by the administrator managing the Kafka cluster. For example, `broker1.example.com:9092`. > * **Broker API key** — the API key used to authenticate with the Kafka broker. Usually obtained from the administrator or through the Kafka management interface of the cloud provider, such as *Confluent Cloud* or *AWS MSK*. > * **Broker API Secret** — the API secret paired with the Broker API key for authentication. Also provided by the administrator or available in the Kafka management interface of the cloud provider. > * **Data Format** — the format in which data is sent from Zeotap CDP to Kafka. **AVRO** and **JSON** are supported. If you choose **AVRO**, you also need the three Schema Registry values below. > * **Schema Registry URL** — the endpoint URL of the Schema Registry service, available during setup or in the Kafka deployment's configuration settings. For Confluent Cloud, this is listed in the "Schema Registry" section of the dashboard. > * **Schema Registry API key** — the API key required to access the Schema Registry. Obtain it from the administrator, or generate it in the "API Keys" section of the Schema Registry management interface in Confluent Cloud. > * **Schema Registry API Secret** — the secret corresponding to the Schema Registry API key, available in the same section as the API Key or provided by the administrator. > * **Topic Name** — the label used for organising and identifying the grouped data in Kafka. Configure the topic in Kafka, along with its attributes, **before** you use it in Zeotap CDP. > > For example, if the Topic Name is "Topic 1", the information grouped under it might include attributes such as First Name, Last Name and Email. > > You also need access to the **Journeys** application in the Zeotap CDP app, and a workflow to attach the destination to. See [Create a Workflow](/articles/orchestrate-customer/create-a-workflow). ## Supported identifiers and actions This integration lets you send any identifiers and attributes of your choice from the Catalogue. The topic and its attributes must already exist in your Kafka account before you map to them in Zeotap CDP. | What | Supported | | - | - | | Action | **Stream data to Kafka** — publishes the mapped record to the Kafka topic configured on the destination. | | Identifiers and attributes | Any Catalogue identifier or attribute. Use **+ Add Mapping Field** to add any number of them. | | Data types available in mapping | String, Integer, Double, Boolean, Object, List of Object. | | Data formats | AVRO or JSON. | For how objects and lists of objects behave in a destination upload, see [Object, List of Objects and NCE Support in Destination Upload](/articles/segment-customer/object-list-of-objects-and-nce-support-in-destination-upload). For what each data type means in the Catalogue, see [Data Types in Catalogue](/articles/unify-customer/data-types-in-catalogue). ## Create the Kafka destination This flow creates the destination from inside a Journeys workflow. In the workflow, click **+** and choose **Send to Destinations**. ![The Choose an action menu in a Journeys workflow with Send to Destinations highlighted](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=8ed8abd70040c3e575c94c98ad4e6956) A new window appears where you can set up your destination. Use an existing destination from the list, or create a new one with **+ Add New Destination**. ![The Send to Destinations picker showing existing destinations and the + Add New Destination link. The destination cards shown belong to other integrations.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-25.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=9436e6620f33e4a53c427900a718e9a2) > [!NOTE] > > If a Kafka destination already exists in your workspace, skip this section and go straight to [Link the destination to a Journeys workflow](#link-the-destination-to-a-journeys-workflow). **1. Start a new destination** Click **+ Add New Destination**. ![The + Add New Destination link highlighted in the Send to Destinations picker. The destination cards shown belong to other integrations.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26-1.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=45aec566d6937bbb28613e4b880207c4) **2. Select Kafka from the catalogue** Search for **Kafka**, click **Kafka**, and enter a name for the destination. **3. Enter the connection details** Provide a **Connection Name** for the Kafka connection in Zeotap CDP, then enter the **Kafka Broker host**, **Broker API key** and **Broker API Secret** obtained from your Kafka account, as listed in [Prerequisites](#prerequisites). ![The Enter Destination Details screen with Destination Name, Connection Name, Kafka Broker host and Broker API key fields](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/apache-kafka-destination/apache-kafka-destination-2025-02-10.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=a36608e33fd217049f74195d84915b2e) **4. Choose the data format** Under **Data Format**, choose either **AVRO** or **JSON** as the format in which data is sent to Kafka. * If you choose **AVRO**, enter the **Schema Registry URL**, **Schema Registry API key** and **Schema Registry API Secret** obtained from your Kafka account, as listed in [Prerequisites](#prerequisites). * If you choose **JSON**, no additional fields are required — proceed to the action and mapping. ![The Data Format field set to AVRO, with the Schema Registry URL, API key and API Secret fields below it](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/apache-kafka-destination/apache-kafka-destination-2025-02-10-1.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=928b768c886baf9c0f9085c373da2a6c) **5. Review and continue** Review the fields you entered and click **Next** to move from **Destination Details** to **Mapping**. **6. Choose the action** On the mapping screen, under **Choose your Action**, select **Stream data to Kafka** as the action for sending data from the workflow you created in Journeys. ![The Mapping step showing Choose your Action set to Stream data to Kafka, above the Map the Fields table](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/apache-kafka-destination/apache-kafka-destination-2024-12-20-2.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=9582d06961b4675f4b1ed01dd2d9d2e0) **7. Map the fields** Under **Map the Fields**, use **+ Add Mapping Field** to add the identifiers and attributes you want to send to Kafka. Configure the topic and its attributes in Kafka before you map them here. Use the drop-down against each field to choose the data type for the attribute or identifier, and map the corresponding Catalogue fields to the Destination fields. If you choose **Object** or **List of Object**, you must also map the object's properties beneath the object, as shown below. > [!WARNING] > > Ensure that the fields defined as mandatory in your schema registry are mapped to valid columns that contain data, under Destination Mapping in Zeotap CDP. Otherwise it might result in destination failure. ![The data type drop-down open on a mapping row, offering Integer, Double, Boolean, Object and List of Object](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/apache-kafka-destination/apache-kafka-destination-2024-12-20-3.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=6bc02fb1c0824639eca551c274268f20) **Example.** The image below shows a sample JSON payload with a `metadata` object and a `payload` object, and how each of their properties becomes a row in the mapping table. ![A sample JSON payload with metadata and payload objects, and the corresponding rows in the Data Mapping table](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/apache-kafka-destination/apache-kafka-destination-2024-12-20-9.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=5fc5ca4e1b783eae890f9e905dc2c457) **8. Create the destination** Once the mapping is complete, click **Create Destination**. The destination is created and made available for activation in Journeys. ## Link the destination to a Journeys workflow After the destination exists, link it in the **Send to Destinations** node of your workflow. **1. Add the Send to Destinations node** In the workflow, click **+** and choose **Send to Destinations**. ![The Choose an action menu in a Journeys workflow with Send to Destinations highlighted](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/apache-kafka-destination/apache-kafka-destination-2024-12-20-5.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=f9a812f706e81f9c0587455db728c192) **2. Choose the Kafka destination** Choose the destination from the list of available destinations, using the search field if needed. ![The destination picker with a Kafka destination card selected](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/apache-kafka-destination/apache-kafka-destination-2024-12-20-4.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=463e97a6c75ffa7c1de97c864a68603d) **3. Set the topic and partition key** Under the **Destination Details** tab, the **Connection Name**, **Kafka Broker host**, **Broker API key**, **Broker API Secret**, **Schema Registry URL**, **Schema Registry API key** and **Schema Registry API Secret** fields are populated automatically from the values you entered while creating the destination. Enter the **Topic name**, then use the **Partition key Required?** drop-down to choose whether a **Partition key** (A Partition key is a unique key used to split the data in Kafka, whenever large amount of data is received.) is required. * If you select **Yes**, enter the name of the attribute to use as the partition key in the **Mapping path to the key** text box. Select an attribute that determines how data partitions occur when the incoming data exceeds the data size limit. * If you select **No**, proceed to the **Destination Settings** tab. ![The Topic name field, the Partition key Required? drop-down set to Yes, and the Mapping path to the key field](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/apache-kafka-destination/apache-kafka-destination-2024-12-20-6.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=dce82c31b8a7dc264c1390c35fb45ddf) > [!NOTE] > > To use a property of an [Object](/articles/unify-customer/data-types-in-catalogue#object) as the partition key, enter the attribute name given in the Destination field (right-hand side) in the format `objectname.attributename`. For example, if an object named **payload** includes properties such as **Contract ID**, **Contract Start Date** and **Contract End Date**, and you want to use **Contract ID** as the partition key, enter `payload.ContractID` in the **Mapping path to the key** text box. The value for the partition key is case sensitive. **4. Choose the action and mapping** Under the **Destination Settings** tab, choose the action and mapping as per your requirement. **5. Save the destination on the node** Click **Save Destination**. The destination is attached as shown below. ![The attached Kafka destination card in the Send to Destinations node, showing the mapping name and the Stream data to Kafka action](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/apache-kafka-destination/apache-kafka-destination-2024-12-20-7.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=4e8af7feee9fd364b8bb1420e1fa1405) **6. Add the destinations to the node** Click **Add Destinations**. You can add multiple destinations at this step if needed. **7. Continue building the workflow** The linked destinations appear in the **Send to Destinations** node within the workflow. You can then build and customise the workflow by clicking **+**. Enter a name for the workflow in the text box provided so that it can be saved. ![A Journeys workflow with a Send to Destination node carrying the Kafka destination](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/apache-kafka-destination/apache-kafka-destination-2024-12-20-8.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=a38d60fa13cf5f1d33d1394acf232c63) **8. Choose how to proceed** After adding conditions and filters for users, choose one of the following: * **Save Draft** — revisit and edit the workflow before publishing. * **Next: Re-entry Condition** — determine whether a user can re-enter the same workflow. **9. Publish the workflow** After defining the re-entry criteria, click **Publish Workflow**. The workflow appears on the Workflow listing screen with a **Published** status. ![The journey re-entry conditions panel with the Publish Workflow button](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26-8.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=634ab0c131fbe99396837bc9f7b8fc91) ## Verify the destination is live Check the following in order: 1. **The destination was created.** After you click **Create Destination**, it appears in the list of available destinations in the **Send to Destinations** picker. 2. **The destination is attached to the node.** After you click **Save Destination**, the destination card appears inside the **Send to Destinations** node, showing the mapping name and the action. 3. **The workflow is published.** The workflow shows a **Published** status on the Workflow listing screen. 4. **Records arrive on the topic.** Consume from the topic you configured in Kafka and confirm the mapped fields appear with the data format (AVRO or JSON) you selected. ## Troubleshooting | Symptom | What it means | Fix | | - | - | - | | The destination fails when AVRO is selected | A field defined as mandatory in your schema registry is not mapped, or is mapped to a column that contains no data | Open the destination's **Destination Mapping** in Zeotap CDP and map every mandatory schema-registry field to a Catalogue field that carries data | | Data is not partitioned as expected | The **Mapping path to the key** value does not match the Destination field name — the partition key value is case sensitive | Re-enter the key as `objectname.attributename`, matching the case of the Destination field | | The Schema Registry fields are not shown | **Data Format** is set to JSON | Set **Data Format** to **AVRO** if your topic is backed by a schema registry; the three Schema Registry fields then appear | ## FAQ > [accordion] Is this the same as the Kafka source? > > No. This page covers the Kafka **destination**, which sends data out of Zeotap CDP to your Kafka topic through a Journeys workflow. The [Kafka source](/articles/integrate-customer/kafka_message_queue) does the opposite — it ingests data from a Kafka topic into Zeotap CDP. The two are configured separately — the source in the **Sources** application under **Integrate**, this destination from a Journeys workflow. > [accordion] Does Zeotap create the Kafka topic for me? > > No. Configure the topic, and the attributes grouped under it, in your Kafka account before you reference the topic in Zeotap CDP. > [accordion] Should I choose AVRO or JSON? > > Choose the format your Kafka topic consumers expect. AVRO additionally requires a Schema Registry URL, API key and API secret, and every field your schema marks mandatory must be mapped to a Catalogue field that contains data. JSON needs no extra configuration. > [accordion] What is a partition key, and do I need one? > > A partition key is a unique key used to split the data in Kafka when a large amount of data is received. It is optional — set **Partition key Required?** to **No** if you do not need one. If you set it to **Yes**, name the attribute that should determine how data partitions occur when the incoming data exceeds the data size limit. > [accordion] Can I send nested data? > > Yes. In **Map the Fields**, set a Destination field's data type to **Object** or **List of Object** and map its properties beneath it. See [Object, List of Objects and NCE Support in Destination Upload](/articles/segment-customer/object-list-of-objects-and-nce-support-in-destination-upload). ## Next steps * Explore [Real-Time Integrations →](/articles/integrate-customer/real-time-integrations) for the other real-time integrations Zeotap CDP supports. * Explore [Create a Workflow →](/articles/orchestrate-customer/create-a-workflow) to build the journey this destination attaches to. * Explore [Kafka (source) →](/articles/integrate-customer/kafka_message_queue) to bring data from a Kafka topic into Zeotap CDP. * Explore [Destinations →](/articles/integrate-customer/destinations) for how actions and mappings work across all destinations. * Explore [Data Types in Catalogue →](/articles/unify-customer/data-types-in-catalogue) for what each mapping data type means. # App Events (CE) Source: https://docs.zeotap.com/articles/integrate-customer/app-events App Events is a Zeotap CDP source category that brings mobile app activity into Zeotap through the Android, iOS and React Native SDKs or an App Pixel. ## What this is App Events is a **source** category: it brings data *into* Zeotap CDP from your mobile applications. You embed a Zeotap SDK in the app — or fire an App Pixel from it — and what users do inside the app arrives in Zeotap CDP as events and identifiers, where they feed unified customer profiles, segments and activation. App Events sources carry Customer Data (CE) only. For the website equivalent, see [Website Events](/articles/integrate-customer/website-events). App events are the specific actions and interactions that occur within a mobile application — app launches, screen views, button clicks, form submissions, in-app purchases, video plays and more. Tracking them shows how users engage with the app, what actions they take and how they navigate through different screens and features. Because acquisition events such as app installs and in-app purchases are captured too, you can assess the return on your marketing spend and make data-driven decisions to optimise your advertising strategy. ## Choose your app SDK Zeotap provides two native app SDKs — Android and iOS — plus a React Native package that wraps both for cross-platform apps. > [card] [Android SDK](/articles/integrate-customer/android-sdk) > > All Android devices and tablets, including Android TV and Amazon Fire TV. > [card] [iOS SDK](/articles/integrate-customer/ios-sdk) > > All iOS devices and tablets. > [card] [React Native SDK](/articles/sdks/react-native/intro) > > One JavaScript codebase deployed to both iOS and Android, wrapping the two native SDKs. ## Create an app source Each app you instrument needs its own source in Zeotap CDP — one per platform the app ships on, so a cross-platform app needs two. The source issues the write key that the SDK is initialised with, so create the source before you implement the SDK. | Platform | Create the source in Zeotap CDP | Developer reference | | - | - | - | | Android | [Create an Android SDK source](/articles/integrate-customer/creating-android-sdk-source) | [Android SDK documentation](/articles/sdks/android/intro) | | iOS | [Create an iOS SDK source](/articles/integrate-customer/create-an-ios-sdk-source) | [iOS SDK documentation](/articles/sdks/ios/intro) | | React Native | Create both an Android and an iOS source, then follow the [React Native quick start](/articles/sdks/react-native/quick-start) | [React Native SDK documentation](/articles/sdks/react-native/intro) | | App Pixel (no SDK) | [Create an App Pixel source](/articles/integrate-customer/2676392376) — choose **App Events** as the Category and **App Pixel API** as the Data Source | [Web Pixel/Web IFrame/App Pixel](/articles/integrate-customer/web-pixel-web-iframe-app-pixel) | ## Next steps * [SDK Reference](/articles/integrate-customer/sdk-reference) — the status and message values returned by the SDK callback. * [Zeotap SDKs](/articles/sdks/overview) — installation, configuration, API reference, consent and release notes for every SDK. * [Source Integrations (Batch+Real-Time)](/articles/integrate-customer/creating-a-source) — every source category Zeotap CDP supports. # Appademic S3 Source: https://docs.zeotap.com/articles/integrate-customer/appademic-s3 Export audiences out of Zeotap CDP as CSV files to the Amazon S3 bucket Appademic reads for downstream audience activation and analytics. ## What this is Appademic S3 is a batch destination: data flows **out of Zeotap CDP** to an Amazon S3 bucket that Appademic reads. You link an audience to the destination, and each delivery writes the audience out as a CSV file into the bucket and folder path you configure, where Appademic picks it up for downstream audience activation and analytics. Appademic is a mobile marketing and analytics platform that helps businesses understand and engage their users more effectively. This connector is outbound only — there is no Appademic source, so nothing flows from Appademic back into Zeotap CDP through it. To bring data from your own Amazon S3 storage **into** Zeotap CDP, use the [Amazon S3 source](/articles/integrate-customer/amazon-s3) instead. For a general-purpose export to an S3 bucket of your own, see the [Amazon S3 destination](/articles/integrate-customer/amazon-s3-destination). ## Supported identifiers and actions You can send any identifiers and attributes available in your catalogue to Appademic S3. The fields that are exported are exactly the ones you select in the **Map the Fields** step while creating the destination — nothing is sent by default. The destination exposes a single action, **Send CSV to Appademic**, which sends your audience data to the Appademic S3 bucket as a CSV file. ## Prerequisites Before you create an Appademic S3 destination in Zeotap CDP, make sure you have the following Amazon S3 details to hand: * S3 bucket name * S3 folder path (optional) * AWS Access Key ID * AWS Secret Access Key * S3 bucket region ## Gather your Amazon S3 details Collect each value from your Amazon S3 account before you start the destination form. ### S3 bucket name The name of the Amazon S3 bucket where the exported files are stored. Find it in your Amazon S3 account under **Buckets**. ### S3 bucket region The geographical location where the Amazon S3 storage is available. Find it on the **Properties** tab of the bucket. ### S3 folder path The optional folder path within the bucket where Zeotap CDP stores your exported data. In Amazon S3, a folder serves as a logical container for organising stored objects within a bucket — in practice it is a prefix on the object name rather than a real directory. Find the existing structure on the **Objects** tab of the bucket, and enter the path in this form: `folder_name/sub_folder_name/` ### AWS Access Key ID and AWS Secret Access Key The security credentials that provide secure access to your Amazon S3 resources. Obtain both from the **AWS IAM Credentials** tab under **Security credentials** in your Amazon S3 account. ## Create the Appademic S3 destination **Step 1** Log in to the Zeotap CDP app and open **Destinations** under **Integrate**. **Step 2** Click **+ Create Destination**. **Step 3** Under the **All Destinations** section, search for Appademic S3 and click **Appademic S3**. **Step 4** The **Destination Details** step appears, with details about the destination on the left and the fields required to establish the integration on the right. Provide the following: a. In the **Destination Name** field, enter a name for the destination. b. In the **AWS Access Key ID** field, enter the AWS Access Key ID for accessing the S3 bucket. c. In the **S3 Bucket Name** field, enter the name of the S3 bucket where files are stored or retrieved from. d. In the **S3 Folder Path** field, optionally enter the folder path within the S3 bucket. e. In the **AWS Secret Access Key** field, enter the AWS Secret Access Key for accessing the S3 bucket. f. In the **S3 Bucket region** field, select the geographical location where the Amazon S3 storage is available. ![The Destination Details step of the Appademic S3 destination, with empty Destination Name, AWS Access Key ID, S3 Bucket Name, S3 Folder Path, AWS Secret Access Key and S3 Bucket region fields.](https://mintcdn.com/zeotap/wIX_MZLBG9xnFfjc/articles/integrate-customer/Storage/integrate-customer/appademic-s3/appademic-s3-2026-06-11-1.png?fit=max\&auto=format\&n=wIX_MZLBG9xnFfjc\&q=85\&s=1e20b76d1f2d05e1f73833479d73d47f) g. Review all the values you entered, then click **Next** to proceed. ![The same Destination Details step with the destination name, bucket name, folder path, region and credential fields filled in, ready to continue to the Mapping step.](https://mintcdn.com/zeotap/wIX_MZLBG9xnFfjc/articles/integrate-customer/Storage/integrate-customer/appademic-s3/appademic-s3-2026-06-11-2.png?fit=max\&auto=format\&n=wIX_MZLBG9xnFfjc\&q=85\&s=210c32d65e8e9ea5fff383d9f5baed8a) **Step 5** On the **Mapping** step, provide a name for your mapping, then configure the action and the field mapping: a. Under **Choose your Action**, select **Send CSV to Appademic**. This action sends your audience data to the Appademic S3 bucket. ![The Mapping step with Send CSV to Appademic selected under Choose your Action, above an empty Map the Fields table with Catalogue Field and Destination Field columns.](https://mintcdn.com/zeotap/wIX_MZLBG9xnFfjc/articles/integrate-customer/Storage/integrate-customer/appademic-s3/appademic-s3-2026-06-11-3.png?fit=max\&auto=format\&n=wIX_MZLBG9xnFfjc\&q=85\&s=56bf1cc5a2a15d27aae17ba5d00626aa) b. Under **Map the Fields**, map the catalogue fields to the destination fields you want to send to Appademic. Click **+ Add Mapping Field** to add an attribute, use **Choose Catalogue Attribute** to select the attribute, enter the destination key in **Enter Key Name**, and select its data type from the dropdown. ![The Map the Fields table with one mapping row added, showing the Choose Catalogue Attribute selector, the Enter Key Name field and the data type selector.](https://mintcdn.com/zeotap/wIX_MZLBG9xnFfjc/articles/integrate-customer/Storage/integrate-customer/appademic-s3/appademic-s3-2026-06-11-4.png?fit=max\&auto=format\&n=wIX_MZLBG9xnFfjc\&q=85\&s=75af20745f47e192f4a71a452f21f7f0) **Step 6** Click **Create Destination**. The destination is then listed in **Audiences**, where it can be linked to an audience. ## Link an audience to the destination The destination only delivers once an audience is linked to it. For how to link an audience or segment to the destination you created, see [Activate your batch audiences](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > **Note:** > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an Audience or a segment could be a specific group of customers who are over 18 years of age and who have performed an `addToCart` event within the last 30 days. ## How lists of objects and NCEs are exported When you export a List of Objects or a Non-Customer Entity (NCE) to Appademic, each object is flattened into a separate row in the CSV file. * If an NCE contains 3 objects, the export generates 3 rows in the CSV. * If multiple NCEs are attached, the export performs a cross-product across them. For example, if one NCE contains 3 objects and another contains 2 objects, the export generates 6 rows (3 × 2). For more about how objects, lists of objects and NCEs are supported in destination uploads, see [Object, List of Objects and NCE Support in Destination Upload](/articles/segment-customer/object-list-of-objects-and-nce-support-in-destination-upload). ## Verify the export Confirm the delivery from both sides: 1. **In Zeotap CDP** — open the destination and review its activity for the linked audience. A successful delivery records a completed run with a non-zero count; a failed run records an error you can use to diagnose the cause. See [verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). 2. **In Amazon S3** — open the bucket on the **Objects** tab, navigate to the folder path you configured, and confirm a CSV file is present for that run. Open the file and check that its columns match the key names you entered under **Enter Key Name** in the mapping. ## Troubleshoot the export Work through the destination's own configuration first — most failures on this connector are in the five Amazon S3 values you entered. | Symptom | What to check | | - | - | | The bucket is not found, or the bucket name is rejected | Amazon S3 bucket names are lowercase only, 3–63 characters, and may contain letters, numbers, hyphens and dots. They cannot contain spaces or adjacent dots, and must start and end with a letter or a number. Copy the name exactly as it appears under **Buckets** in your Amazon S3 account. | | The region is rejected, or the destination cannot reach the bucket | **S3 Bucket region** must be the region the bucket actually lives in. A region that does not match the bucket is one of the most common misconfigurations on S3-based destinations. Confirm the region on the bucket's **Properties** tab and reselect it. | | Files are delivered but do not appear where you expect | The folder path is a prefix on the object name, not a real directory. Enter it as `folder_name/sub_folder_name/` with a trailing slash and no leading slash, then look for the files under that exact prefix on the **Objects** tab. | | The credentials are rejected, or no file is written at all | The **AWS Access Key ID** and **AWS Secret Access Key** must belong to an identity that can write files into that bucket *and* into that folder path, not only read or list the bucket. Re-copy both values from the **AWS IAM Credentials** tab under **Security credentials**, and check the identity can write to the folder path. | | The file arrives but has more rows than the audience size | Lists of objects and NCEs are flattened one row per object, and multiple NCEs produce a cross-product. See [How lists of objects and NCEs are exported](#how-lists-of-objects-and-nces-are-exported). | | The file arrives but columns are missing | Only the fields you added under **Map the Fields** are exported. Reopen the mapping and confirm every attribute you need has a row with a key name and a data type. | If the run fails on the Zeotap CDP side rather than the Amazon S3 side — for example, the audience returns no qualifying customers, or the run is terminated — see [why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail). ## Next steps * [Activate your batch audiences →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Create a Destination →](/articles/integrate-customer/create-a-destination) * [Explore Destination Access Rules →](/articles/integrate-customer/destination-access-rules) * [Use Enrichers in destination mapping →](/articles/segment-customer/enrichers-in-destination-mapping) * [Send objects, lists of objects and NCEs to a destination →](/articles/segment-customer/object-list-of-objects-and-nce-support-in-destination-upload) * [Bring Amazon S3 data into Zeotap CDP →](/articles/integrate-customer/amazon-s3) # Appendix for Cleverpush Source: https://docs.zeotap.com/articles/integrate-customer/appendix-cleverpush-destination Cleverpush-side setup for the Cleverpush destination that sends audiences out of Zeotap CDP: create a channel and set up the Web Push, App Push and Email Push platforms those audiences are delivered on. ## What this is The [Cleverpush destination](/articles/integrate-customer/cleverpush-destination) sends audiences **out of Zeotap CDP to Cleverpush**, and this appendix covers the Cleverpush-side setup you complete before that destination will work. Everything here happens in the Cleverpush console, not in the Zeotap CDP App. You create a push notification channel, then set up the platforms you want that channel to send on. Cleverpush offers a long list of platforms on a channel; Zeotap CDP supports three of them: * **Web Push** — reach desktop and Android users via browser messages * **App Push** — reach iOS and Android users through your native app * **Email Push** — create registration forms, double opt-in routines and design newsletters The channel you create here also supplies the **Channel ID** that the Cleverpush destination asks for. The destination page documents where to read the Channel ID and the Private API Key once the channel and its platforms exist. ### Which Cleverpush appendix applies to you Three near-identical Cleverpush appendices exist in these docs, one per integration. Use the one that matches the integration you are configuring: | You are configuring | Use this appendix | | :- | :- | | [Cleverpush destination](/articles/integrate-customer/cleverpush-destination) (batch) | This page | | [Cleverpush Real Time Integration](/articles/integrate-customer/cleverpush-real-time-integration) (real-time destination) | [Appendix for the real-time integration](/articles/integrate-customer/appendix-cleverpush-real-time-integration) | | [Cleverpush (Batch) Source](/articles/integrate-customer/cleverpush-batch-source) or [Cleverpush Real Time Source](/articles/integrate-customer/cleverpush-real-time-source) | [Appendix for the Cleverpush sources](/articles/integrate-customer/cleverpush_appendix) | Data flows the other way — **into** Zeotap CDP from Cleverpush — through the [Cleverpush (Batch) Source](/articles/integrate-customer/cleverpush-batch-source) and the [Cleverpush Real Time Source](/articles/integrate-customer/cleverpush-real-time-source), which fetch subscriber information such as the subscription ID, channel ID, country, custom attributes and segments. ## Prerequisites Before you start, confirm the following: * You can log into the Cleverpush console. * You know which platforms you intend to use — Web Push, App Push, Email Push, or a combination. * **For Web Push:** you know the domain your site is served from, and whether you will send from your own domain (HTTPS only) or from a Cleverpush-hosted subdomain. * **For App Push:** you know which mobile SDK your app is built on, so you can pick the matching Cleverpush SDK documentation. ## Create a new channel in Cleverpush **Step 1** Log into the Cleverpush console and open **Channels** on the top navigation bar. **Step 2** Under **Channels**, click **Add Channel**. ![Cleverpush dashboard with the Channels menu open, showing the recent channels list and the Add Channel option highlighted at the bottom of the menu.](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/appendix_1.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=1d9704a20a7aab593d2df1c5b3672698) **Step 3** Under **Basic settings**, provide the following details: a. Enter a descriptive name for the channel. b. Click **Select file** to upload an icon for the channel. c. Choose the desired **Industry** from the drop-down menu. d. Click **Save Channel**. ![Cleverpush Basic settings form for a new channel, showing the Name field, the Industry drop-down, the Icon file picker and the Save Channel button, with the Platforms list beneath it.](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/appendix_2.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=ac914d5e7186661618decfb2051eb8f5) Once the channel is saved, set up each platform you want to send on. ## Set up Web Push in Cleverpush **Step 1** In the Cleverpush console, open **Channels**, select the channel you created, and go to **Platforms**. **Step 2** Click **Setup now** next to **Web Push**. ![Platforms list for a Cleverpush channel with the Web Push row highlighted and its Setup now button on the right.](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/web_push_1.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=3aad1d04cc6a9f765bb95cc9e34669b8) **Step 3** On **Step 1: Enter domain**, select the protocol and enter the domain of your site without a leading `http://` or `https://` and without a trailing path. Then choose one of the two delivery options and click **Continue**: * **Own domain** — HTTPS only. Notifications are sent directly via your domain. * **CleverPush Subdomain** — notifications are sent via a Cleverpush-hosted subdomain. Cleverpush notes that the domain can be changed later. ![Web Push wizard on Step 1, Enter domain, showing the protocol drop-down, the domain field and the Own domain and CleverPush Subdomain options above the Continue button.](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/Web_Push_2.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=0cabf8d5d5c9653b018168c61c11e241) **Step 4** On **Step 2: Choose subdomain**, enter the subdomain your users will opt in on and click **Continue**. > [!WARNING] > > Unlike the domain, the subdomain cannot be changed later. Confirm the name before you continue. ![Web Push wizard on Step 2, Choose subdomain, showing the subdomain field followed by the fixed Cleverpush domain suffix and the Continue button.](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/web_push_3.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=6b46136f186f1380e47a47c616959439) **Step 5** On the final step, **Goal**, click **Setup now** to finish. ![Web Push wizard with all three wizard steps marked complete and the Setup now button ready to finish the configuration.](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/web_push_4.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=2e3868a9bc0600c6b396f8c8ad40b6bc) ## Set up App Push in Cleverpush **Step 1** In the Cleverpush console, open **Channels**, select the channel you created, and go to **Platforms**. **Step 2** Click **Setup now** next to **App Push**. ![Platforms list for a Cleverpush channel with the App Push row highlighted and its Setup now button on the right.](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/App_push_1.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=bfdcb69c2b9d43ab369664bd5751897a) **Step 3** Click **Setup now** in the App Push panel. ![App Push panel opened over the Platforms list, with the Setup now button that starts the configuration.](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/app_push_2.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=3e2af0317db26fe3a2c77b81c7436a6b) **Step 4** Open **Implementation** for the channel and choose the SDK documentation that matches your app. ![App Push Implementation page listing the available app SDKs — Android, iOS, Cordova, React Native, Xamarin and Flutter — each with a button linking to its SDK documentation.](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/app_push_3.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=1ba6cd3e59854d3b939dece637b4ad38) The **Info** panel at the top of this page also carries the channel's **Channel ID**, which the Cleverpush destination asks for during setup. The [Cleverpush destination](/articles/integrate-customer/cleverpush-destination) page documents its own route to the same value. ## Set up Email Push in Cleverpush > [!NOTE] > > In the Cleverpush **Platforms** list this platform is labelled **Email**. Zeotap documentation refers to the same platform as **Email Push**. **Step 1** In the Cleverpush console, open **Channels**, select the channel you created, and go to **Platforms**. **Step 2** Scroll down the **Platforms** list to **Email** and click **Setup now**. ![Platforms list for a Cleverpush channel scrolled to the Email row, which is highlighted, with its Setup now button on the right.](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/email_push_1.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=4a90e7f64de4e577525e9948dd212c97) **Step 3** Click **Setup now** in the Email panel. ![Email panel opened over the Platforms list, with the Setup now button that starts the configuration and the channel's already-configured platforms listed in the left panel.](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/email_push_2.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=7d795d081673f35f8b732a8312dbff0b) ## Verify the platforms are set up Open the channel in the Cleverpush console and check the **PLATFORMS** list in the left panel. Each platform you have finished setting up is listed there; a platform that is still only a row in the **Platforms** setup list has not been completed. ## Next steps * [Create the Cleverpush destination →](/articles/integrate-customer/cleverpush-destination) * [Link an audience to the destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Bring Cleverpush subscriber data into Zeotap CDP with the Cleverpush (Batch) Source →](/articles/integrate-customer/cleverpush-batch-source) * [Bring Cleverpush subscriber data into Zeotap CDP with the Cleverpush Real Time Source →](/articles/integrate-customer/cleverpush-real-time-source) # Appendix: Cleverpush channel and platform setup Source: https://docs.zeotap.com/articles/integrate-customer/appendix-cleverpush-real-time-integration Create a channel in Cleverpush and set up its Web Push, App Push and Email Push platforms, so the Cleverpush real-time destination in Zeotap CDP has a channel to send to. ## What this is The Cleverpush real-time integration sends identifiers and attributes **out of Zeotap CDP to Cleverpush** as users move through a Journeys workflow, and this page covers the Cleverpush-side groundwork that has to exist before that destination can be created: a **channel**, and the **platforms** that channel sends notifications through. Cleverpush is a web-based platform that lets website owners and developers send push notifications to users who have subscribed to receive them. A channel is the container those notifications are sent from, and it is the channel that carries the **Channel ID** the destination asks for. Zeotap CDP supports three Cleverpush platforms — **Web Push**, **App Push** and **Email Push** — and you set up the ones you intend to send through. Every step on this page happens in the Cleverpush console. The Zeotap CDP side of the integration — creating the destination, entering the Private API Key and Channel ID, choosing the action and mapping the fields — is covered on [Cleverpush Real Time Integration](/articles/integrate-customer/cleverpush-real-time-integration). Data also flows the other way. To bring Cleverpush subscriber data **into Zeotap CDP**, see [Cleverpush Real Time Source](/articles/integrate-customer/cleverpush-real-time-source) or [Cleverpush (Batch) Source](/articles/integrate-customer/cleverpush-batch-source). > [!NOTE] > > These channel and platform steps are the same for every Cleverpush integration, and each integration keeps its own copy of them. **This page is the copy for the Cleverpush real-time destination.** If you are setting up a different Cleverpush integration, use its own appendix: > > * [Appendix for Cleverpush](/articles/integrate-customer/appendix-cleverpush-destination) — for the [Cleverpush](/articles/integrate-customer/cleverpush-destination) destination. > * [Appendix](/articles/integrate-customer/cleverpush_appendix) — for the Cleverpush (Batch) and Cleverpush Real-Time sources. ## Prerequisites > [!NOTE] > > Before you start, confirm the following. > > * **Access to your Cleverpush console.** Every step on this page is performed there. > * **For Web Push — the domain of the site** you want to send browser notifications from. The setup wizard asks for the protocol and the domain, without a leading `http://` or `https://` and without a trailing path. > * **For App Push — your own iOS or Android app**, and the ability to add the Cleverpush SDK to it. The setup screen links Cleverpush's SDK documentation for Android, iOS, Cordova, React Native, Xamarin and Flutter. ## Create a channel in Cleverpush **1. Open the Channels menu** Log into the Cleverpush console and click **Channels** in the top navigation bar. **2. Add a channel** In the **Channels** menu, click **Add Channel**. ![Cleverpush dashboard with the Channels menu open, listing the latest channels and the All channels link, and the Add Channel button highlighted at the bottom of the menu](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/appendix_1.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=1d9704a20a7aab593d2df1c5b3672698) **3. Fill in the basic settings and save** Under **Basic settings**: 1. In **Name**, enter a descriptive name for the channel. 2. Beside **Icon**, click **Select file...** to upload an icon for the channel. 3. Choose the relevant **Industry** from the drop-down menu. 4. Click **Save Channel**. ![Cleverpush Basic settings panel with the empty Name field, the Industry drop-down set to None, the Select file button for the channel icon and the Save Channel button, with the Platforms list below it](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/appendix_2.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=ac914d5e7186661618decfb2051eb8f5) The **Platforms** list sits below **Basic settings**. Once the channel is created, set up each platform you intend to send through, as described in the sections that follow. ## Set up Web Push in Cleverpush Web Push reaches desktop and Android users through browser messages. **1. Open the channel's platform list** Log into the Cleverpush console, click **Channels** in the top navigation bar, select the channel you created and go to **Platforms**. **2. Start the Web Push setup** Click **Setup now** next to **Web Push**. ![Cleverpush Platforms list for a channel, with the Web Push row highlighted and its Setup now button on the right, above App Push, Facebook Messenger and WhatsApp](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/web_push_1.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=3aad1d04cc6a9f765bb95cc9e34669b8) **3. Enter the domain** On **Step 1: Enter domain**, select the protocol and enter the domain of your site, then choose how notifications are sent and click **Continue**: * **Own domain (Only HTTPS)** — notifications are sent directly via your own domain. * **CleverPush Subdomain** — notifications are sent via a Cleverpush subdomain. ![Cleverpush Web Push wizard on step 1, Enter domain, showing the protocol drop-down, the domain field, the Own domain and CleverPush Subdomain options and the Continue button](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/Web_Push_2.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=0cabf8d5d5c9653b018168c61c11e241) **4. Choose the subdomain** On **Step 2: Choose subdomain**, enter a **Subdomain** name and click **Continue**. Cleverpush appends its own domain to the name you enter, and this is the subdomain your users opt in for notifications on. > [!WARNING] > > Cleverpush states on this screen that the subdomain cannot be changed later, so choose it carefully. ![Cleverpush Web Push wizard on step 2, Choose subdomain, with the subdomain name field, the note that it cannot be changed later and the Continue button](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/web_push_3.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=6b46136f186f1380e47a47c616959439) **5. Finish the setup** On the final step, **Goal**, click **Setup now** to complete the Web Push setup. ![Cleverpush Web Push wizard with all three steps complete and the Setup now button on the Goal step](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/web_push_4.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=2e3868a9bc0600c6b396f8c8ad40b6bc) ## Set up App Push in Cleverpush App Push reaches iOS and Android users through your own native app. **1. Open the channel's platform list** Log into the Cleverpush console, click **Channels** in the top navigation bar, select the channel you created and go to **Platforms**. **2. Start the App Push setup** Click **Setup now** next to **App Push**. ![Cleverpush Platforms list with the App Push row highlighted and its Setup now button, between Web Push and Facebook Messenger](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/App_push_1.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=bfdcb69c2b9d43ab369664bd5751897a) **3. Confirm the platform** In the **App Push** panel that opens, click **Setup now**. ![Cleverpush App Push panel with its description and a single Setup now button, with the platform list dimmed behind it](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/app_push_2.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=3e2af0317db26fe3a2c77b81c7436a6b) **4. Add the SDK to your app** Choose the SDK that matches your app and follow Cleverpush's SDK documentation to implement it. The **App SDKs** section links documentation for Android, iOS, Cordova, React Native, Xamarin and Flutter. ![Cleverpush App Push Implementation screen with the App SDKs section listing documentation links for Android, iOS, Cordova, React Native, Xamarin and Flutter](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/app_push_3.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=1ba6cd3e59854d3b939dece637b4ad38) ## Set up Email Push in Cleverpush **1. Open the channel's platform list** Log into the Cleverpush console, click **Channels** in the top navigation bar, select the channel you created and go to **Platforms**. **2. Start the Email Push setup** Scroll down the platform list and click **Setup now** next to **Email Push**. In the platform list the row is labelled **Email**, below Telegram and above SMS. ![Lower part of the Cleverpush Platforms list, with the Email row highlighted and its Setup now button, among Telegram, SMS, Web Stories, Surveys and Wallet Push](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/email_push_1.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=4a90e7f64de4e577525e9948dd212c97) **3. Confirm the platform** In the **Email** panel that opens, click **Setup now**. ![Cleverpush Email panel with its description and a single Setup now button, with the platform list dimmed behind it](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/email_push_2.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=7d795d081673f35f8b732a8312dbff0b) ## Verify the platforms are set up Open the channel in the Cleverpush console. The platforms you have set up are listed under **PLATFORMS** in the left panel — a platform that does not appear there has not been set up on this channel yet. ## Next steps * [Create the Cleverpush real-time destination and map the fields →](/articles/integrate-customer/cleverpush-real-time-integration) * [Set up the Cleverpush destination for audience delivery →](/articles/integrate-customer/cleverpush-destination) * [Bring Cleverpush subscriber data into Zeotap CDP in real time →](/articles/integrate-customer/cleverpush-real-time-source) * [Bring Cleverpush subscriber data into Zeotap CDP in batches →](/articles/integrate-customer/cleverpush-batch-source) # Appendix for Sendinblue Source: https://docs.zeotap.com/articles/integrate-customer/appendix-for-sendinblue Create custom contact attributes in Sendinblue (Brevo) and show them as columns, so Zeotap CDP can map them when it sends an audience to the destination. ## What this is Sendinblue (Brevo) is a **destination**: data flows out of Zeotap CDP into Sendinblue (Brevo), where an audience arrives as a List stored in a Folder. This appendix covers the two pieces of Sendinblue (Brevo)-side setup the destination depends on — creating a custom contact attribute, and displaying that attribute as a column in the Contacts table. You need this page when you configure the Sendinblue (Brevo) destination with the **Send attributes to Sendinblue** action. The custom attribute has to exist on the Sendinblue (Brevo) platform before it appears under **Map the Fields** in Zeotap CDP, so complete the steps here first, then return to [Sendinblue (Brevo)](/articles/integrate-customer/brevo-sendinblue) to create or edit the destination. Zeotap CDP also ships a real-time Sendinblue (Brevo) destination — see [Brevo](/articles/integrate-customer/brevo) — which sends user data out to a Brevo contact list as events occur, rather than as a batch audience push. ## Prerequisites * An active account on Sendinblue (Brevo). * The Zeotap Catalogue attributes you intend to send, so you can give the Sendinblue (Brevo) attribute a type that suits the Catalogue value you map onto it. ## Add custom attributes Perform the following steps to add custom attributes on the Sendinblue (Brevo) platform: **Step 1** Log into the Sendinblue (Brevo) console and navigate to **Contacts** → **Settings**. **Step 2** In the **Contacts settings** screen that appears, click **Contact attributes**. ![Brevo Contacts settings screen with Contacts and Settings selected in the left navigation and the Contact attributes card highlighted.](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/appendix-for-sendinblue/appendix-for-sendinblue-2024-05-06.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=f2213b5f0ce2f71194076c7bdad77885) **Step 3** In the following screen that appears, click **+ Add a new attribute**. ![Brevo Contact Attributes screen on the Normal Attributes tab, with the Add a new attribute button highlighted above the list of existing attribute names and types.](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/appendix-for-sendinblue/appendix-for-sendinblue-2024-05-06-1.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=eddfb57614f442846bbe05a05f334d35) **Step 4** In the **Attribute Settings** window that appears, provide an **Attribute Name** in capital letters, choose the desired **Attribute Type** from the drop-down list and click **OK**. Note that the attribute type can be **Text**, **Number**, **Category** and **Boolean**. ![Brevo Attribute Settings dialog with an attribute name entered in capital letters, an Attribute Type drop-down list, and the OK and Cancel buttons.](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/appendix-for-sendinblue/appendix-for-sendinblue-2024-05-06-2.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=bebb8e4bec1353ed59df4384c12f69c1) **Step 5** The custom attribute gets listed in the **Contact Attributes** screen. This custom attribute gets listed under the **Map the Fields** section while creating a Destination in Zeotap CDP. ![Brevo Contact Attributes screen showing a confirmation banner and the newly added attribute highlighted at the foot of the Normal Attributes table.](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/appendix-for-sendinblue/appendix-for-sendinblue-2024-05-06-3.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=4f4205bd2d1d71bcdef23842de6b1799) ## Add new columns for custom attributes Adding an attribute under **Contacts settings** does not display it in the contact table. Perform the following steps to add new columns for the custom attributes on the Sendinblue (Brevo) platform: **Step 1** Log into the Sendinblue (Brevo) platform, go to **Contacts** and click **Edit column attributes**. ![Brevo Contacts screen listing contacts in a table, with the Edit column attributes link highlighted above the table.](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/appendix-for-sendinblue/appendix-for-sendinblue-2024-05-06-4.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=bc05f35a8fb179415bdde62961affe9a) **Step 2** In the **Edit displayed columns** panel that appears, click **Add columns**. ![Brevo Edit displayed columns panel listing the currently displayed columns, with the Add columns button highlighted.](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/appendix-for-sendinblue/appendix-for-sendinblue-2024-05-06-5.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=7bd51874102d212369b14f4a3a7fd690) **Step 3** Search and add the desired custom attributes that you wish to view on Sendinblue (Brevo) using the drop-down menu and click **Save**. ![Brevo Add columns search list showing the attributes available to display, with the Save button highlighted at the foot of the panel.](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/appendix-for-sendinblue/appendix-for-sendinblue-2024-05-06-6.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=327ad26b5f79e30a160eeb1c94982587) **Step 4** The newly added custom attribute column is then displayed as shown in the image below. ![Brevo contact table with the newly added attribute shown as an additional column header to the right of Date added.](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/appendix-for-sendinblue/appendix-for-sendinblue-2024-05-06-7.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=1888b936e83a22a3c7161e1f822fdb0a) ## Verify the attribute reaches Zeotap CDP Open the Sendinblue (Brevo) destination in Zeotap CDP, choose **Send attributes to Sendinblue** as the action, and confirm the new attribute is listed under **Map the Fields**. If it is, you can map a Zeotap Catalogue attribute onto it. For the full destination walkthrough, see [Sendinblue (Brevo)](/articles/integrate-customer/brevo-sendinblue). ## Troubleshoot custom attributes * **The attribute is not listed under Map the Fields in Zeotap CDP.** The attribute has to be added on the Sendinblue (Brevo) platform before you push an audience that carries custom attributes. Add it as described above, then reopen the destination's **Actions and Mapping** screen. * **The attribute exists but does not show in the contact table.** Creating an attribute under **Contacts settings** does not add it as a column. Add it using [Add new columns for custom attributes](#add-new-columns-for-custom-attributes). * **The mapping is rejected, or the value does not arrive as expected.** The Sendinblue (Brevo) attribute type has to suit the Catalogue field mapped onto it — map a Text-type attribute against text, a Number-type attribute against a number, and replicate the values of a Category-type attribute exactly as they are configured in Sendinblue (Brevo). A Zeotap Catalogue attribute can be mapped only once. For the full set of mapping rules, see the note on [Sendinblue (Brevo)](/articles/integrate-customer/brevo-sendinblue). ## Next steps * [Sendinblue (Brevo)](/articles/integrate-customer/brevo-sendinblue) — create the destination, choose the action and map the fields. * [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination) — activate an audience on the destination you created. * [Brevo](/articles/integrate-customer/brevo) — the real-time Sendinblue (Brevo) destination, for sending user data as events occur. * [Destinations](/articles/integrate-customer/destinations#define-the-mapping) — how mapping works across every destination. # Appendix for SFMC Journey Builder Source: https://docs.zeotap.com/articles/integrate-customer/appendix-for-sfmc-journey-builder Create the Salesforce Marketing Cloud installed package and data extension table that the SFMC Journey Builder destination needs before Zeotap CDP can send data to it. ## What this is Data flows one way in this integration — out of Zeotap CDP and into Salesforce Marketing Cloud (SFMC) Journey Builder. This page is the partner-side setup for the [SFMC Journey Builder](/articles/integrate-customer/sfmc-journey-builder) destination. It covers the two things you create **in the Salesforce console first**, before you create the destination in Zeotap CDP: * **An installed package.** Its API Integration component is where the SFMC Journey Builder page tells you to read the Client Id, Client Secret and Sub Domain. * **A data extension table.** This is the table you use as an entry source in Journey Builder. Everything on the Zeotap CDP side — creating the destination, mapping the fields and activating it on a journey — stays on the [SFMC Journey Builder](/articles/integrate-customer/sfmc-journey-builder) page. Work through this page first, then return there. > [!NOTE] > > Salesforce data can also flow the other way, into Zeotap CDP. For that direction, see the [Salesforce CRM](/articles/integrate-customer/salesforce-crm) source. ## Prerequisites * An Admin account, so that you can reach all the features of Salesforce Marketing Cloud Journey Builder. * Access to log into the Salesforce console. ## Create a package Perform the following steps to create the new package: **Step 1** Navigate to **Settings > Setup > Apps > Installed Packages**. The existing list of packages is displayed. **Step 2** Click **New**. ![The Installed Packages list in Salesforce Marketing Cloud Setup, with Apps then Installed Packages selected in the left navigation and the New button highlighted at the top right.](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/Image_2.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=476b65e0de049e5bc7401222f7c293f0) **Step 3** Enter a name for the package and save the changes. We recommend including the word **Zeotap** in the package name for easy identification. **Step 4** Click the package you created, and navigate to **Add Component**. ![The summary screen for a newly created package, with an empty Components area and the Add Component button highlighted.](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/Image_4.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=0f61d34f1394d11acd7d7d9d96516cb6) **Step 5** Choose **API Integration** as the Component Type, then click **Next**. ![The Add Component dialog on the Choose Your Component Type step, with API Integration selected from a list that also offers Marketing Cloud App, Journey Builder Activity, Journey Builder Entry Source, Custom Content Block and Solution Package.](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/Image_5.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=212f5bb3cca924a5ff6b58814d146781) **Step 6** Choose **Server-to-Server** as the Integration Type, then click **Next**. ![The Add Component dialog on the Choose Your Integration Type step, with Server-to-Server selected; the table shows it uses the Client Credentials OAuth grant type, while Web App and Public App use Authorization Code.](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/Image_6.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=5fa52ee34befa91f45ef8fabc8bf3cee) **Step 7** In the new window that appears, select the following permissions: * **READ** under **Contacts > List and Subscribers** — required for SFMC Journey Builder * **READ** under **Automations > Journey Builder** — required for SFMC Journey Builder * **Read** and **Write** under **Data Extensions** — required for Salesforce Marketing Cloud - Data Extension > [!NOTE] > > Failing to add these permissions may lead SFMC to send an `Insufficient Privileges error`. **Step 8** Click **Save**. The API Integration details are now visible under the package summary. This is the screen you return to when the SFMC Journey Builder page asks for the Client Id, Client Secret and Sub Domain. ## Create a data extension table To send data to the data extension table of Salesforce Marketing Cloud, start by creating the table. Perform the following steps: **Step 1** Navigate to **Audience Builder > Contact Builder > Data Extensions** in the Salesforce Marketing Cloud console. **Step 2** Click **Create**. **Step 3** Under the **Properties** section, enter the following details: * Use the drop-down menu to choose **Create from New** for **Creation Method**. * Provide a suitable **Name** for the table and a relevant **Description** in the respective fields. * For **External Key**, use the system-generated key if an external key is not provided. * Currently, only **Standard** is supported as the **Type** (Data Extension). * Select the **Is Sendable?** checkbox to enable sending messages to this data extension. ![The Create New Data Extension dialog on the Properties step, showing the Creation Method, Name, External Key, Description, Type and Location fields and the Is Sendable? checkbox.](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/salesforce-marketing-cloud-data-extension/salesforce.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=2010c1b724b5fefeaa3556d49a6166df) **Step 4** Under **Data Retention Policy**, enter the required **Data Extension** details. **Step 5** Under **Attributes**, add the columns for the data you send: * Add a column for every identifier and attribute you intend to map. Zeotap CDP syncs to any number of columns, so add at least one. * Configure the attribute in the first column as the **Primary Key** using the checkbox provided. At least one attribute must be chosen as a primary key. * Enter the **Length** details based on the size of the values you send. To send hashed emails from Zeotap CDP, set the column length to 200. ![The Create New Data Extension dialog on the Attributes step, showing an example two-column configuration: an email column ticked as the primary key and marked required, a segment_name column beneath it, and a length set on each.](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/salesforce-marketing-cloud-data-extension/salesforce_2.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=42aafc08fb4778cf3dfdf7d4a19fd2f3) **Step 6** Review all the fields and click **Complete**. > [!NOTE] > > The **Name** of every attribute you create in the data extension table must match the Destination field name under **Map the fields** exactly when you create the destination. For example, if you create `email` as a column in the data extension, add `email` as the Destination field for the email data you want to send from Zeotap CDP. > [!NOTE] > > Setting up the [Salesforce Marketing Cloud - Data Extension](/articles/integrate-customer/salesforce-marketing-cloud-data-extension) destination instead? That page carries its own package and data extension instructions, and they differ from the ones above — follow the page for the destination you are creating. ## Troubleshoot the SFMC setup | Symptom | Likely cause | What to do | | - | - | - | | SFMC returns an `Insufficient Privileges error`. | The installed package is missing one or more of the required permissions. | Reopen the package's API Integration component and confirm **READ** under **Contacts > List and Subscribers** and **Automations > Journey Builder**, and — for the Data Extension destination — **Read** and **Write** under **Data Extensions**. | ## Next steps * [SFMC Journey Builder](/articles/integrate-customer/sfmc-journey-builder) — create the destination and activate it on a journey. * [Salesforce CRM](/articles/integrate-customer/salesforce-crm) — the opposite direction, bringing Salesforce data into Zeotap CDP. # Taboola appendix: taxonomy file and Channel ID Source: https://docs.zeotap.com/articles/integrate-customer/appendix-taboola-destination Find the Channel ID Zeotap CDP generates for a linked audience, and send Taboola the taxonomy file that maps your audiences to its client account. ## What this is Taboola is a destination: Zeotap CDP sends audience identifiers **out** to Taboola, and no Taboola data flows back into the CDP. This page covers the two handover items you complete **after** an audience is linked to a Taboola destination — the **Channel ID** that Zeotap CDP generates for that audience, and the **taxonomy file** you email to Taboola so it can match your audiences to the right client account. Everything about the destination itself — the supported identifiers, the Taboola Seat ID, creating the destination, and linking an audience to it — lives on the main [Taboola](/articles/integrate-customer/taboola) page. ## Prerequisites * A Taboola destination is created in Zeotap CDP. See [Create a Destination for Taboola](/articles/integrate-customer/taboola#create-the-taboola-destination). * The audience is already linked to that destination. Both handover items below depend on the link existing — the Channel ID is read from the linked Destination, and the taxonomy file is only shared once the audience is linked. See [Link an Audience to the Taboola Destination](/articles/integrate-customer/taboola#link-an-audience-to-the-destination). * You have the email address of the Taboola account manager (AM) who looks after your account. ## Channel ID The **Channel ID** is generated by Zeotap CDP, not by Taboola. It is the value that goes in the **Segment ID** column of the taxonomy file, so read it before you compile the file. Perform the following steps to obtain the Channel ID from Zeotap CDP: **Step 1** Log into Zeotap CDP and navigate to **Segment > Audiences**. **Step 2** In the Audience listing page, search for the Audience whose **Channel ID** you need. **Step 3** Click the **Insights** icon on that Audience, as shown in the image below. ![The Audience listing page in the Segment application, filtered by a search term, with the Insights icon highlighted on the matching Audience row.](https://mintcdn.com/zeotap/IaZjYE7XwRssOe8Q/articles/integrate-customer/Storage/integrate-customer/taboola/taboola_2.png?fit=max\&auto=format\&n=IaZjYE7XwRssOe8Q\&q=85\&s=cde920b4d6d438384beca9df8d4f8500) **Step 4** On the Audience insights page that appears, under **Destination Linked**, click the Taboola Destination to view the information for that Destination. ![The Audience insights page showing the Audience Metrics tab, the unique customer count, and a Destination Linked card for the Taboola Destination.](https://mintcdn.com/zeotap/IaZjYE7XwRssOe8Q/articles/integrate-customer/Storage/integrate-customer/taboola/tabboola_3.png?fit=max\&auto=format\&n=IaZjYE7XwRssOe8Q\&q=85\&s=c6c25be1c3298fceedb86588beeef3cd) **Step 5** A panel opens showing the Destination's action, mapping and last upload. Copy the value under **Channel ID** — take care not to copy the adjacent **ID** field, which is a different value — and share it with the Taboola team alongside the taxonomy file. ![The Destination detail panel on the Audience insights page, showing the action, the mapping, the last upload time, the ID field and the Channel ID field side by side.](https://mintcdn.com/zeotap/IaZjYE7XwRssOe8Q/articles/integrate-customer/Storage/integrate-customer/taboola/taboola_4.png?fit=max\&auto=format\&n=IaZjYE7XwRssOe8Q\&q=85\&s=752f25671da3f7bb167f4e50566d06bd) ## Taxonomy file Share the taxonomy file as a CSV with the relevant Taboola Account Manager (AM) over email, in the following format. The Taboola team maps this information to the relevant client account. Ensure that you share the taxonomy file once the audiences (segments) are linked to the Destination. ```text theme={null} Segment Name | Segment ID | Client Name | Client Seat ID | Price ``` Note that the **Segment ID** to be shared is the [Channel ID](#channel-id) that is auto-generated by Zeotap CDP. > [!NOTE] > > For anything else about the taxonomy file — how to send it, or what Taboola expects in each column — contact your Taboola account manager. ## Next steps * [Taboola](/articles/integrate-customer/taboola) — supported identifiers, the Taboola Seat ID, and creating and linking the Destination. * [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination) — linking an Audience or segment to a created Destination. * [Destinations](/articles/integrate-customer/destinations#verify-the-activation-worked) — how to confirm a delivery actually reached the destination platform. # AppNexus Source: https://docs.zeotap.com/articles/integrate-customer/appnexus Send Zeotap CDP audiences out to your AppNexus seat as segments, and make them visible in your seat through the AppNexus Data Marketplace. ## What this is AppNexus is a batch **destination**: data flows out of Zeotap CDP to AppNexus, where each activated audience arrives as a segment on your seat. Nothing flows back — there is no AppNexus source that brings data into Zeotap CDP, so this page covers the outbound direction only. AppNexus is listed in Zeotap's integrations as AppNexus (Xandr), and parts of the AppNexus console carry Xandr branding. AppNexus is a programmatic advertising platform that enables marketers to buy and sell digital advertising across a range of channels, including display, video, mobile and native. It provides a range of features and capabilities that enable marketers to reach their target audiences, optimise their campaigns and measure their results. > [!NOTE] > > Data delivered through this integration is considered third-party data by clients, as opposed to the [Google DMP](/articles/integrate-customer/google-dmp) integration, where Zeotap data would look like first-party data. ## Supported identifiers and actions This channel supports AppNexus Cookie and MAIDs. The following table lists the available action for the integration and the supported features: | Action name | [ID extension](/articles/segment-customer/extend-your-audience#id-extension) | [Delete](/articles/segment-customer/delta-upload-and-delete-functions) | [Delta upload](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send identifiers to AppNexus | ✅ | ✅ | - | ## Prerequisites Before you create the destination, have the following ready: * **Seat ID** — the ID for your Advertiser account. You can find it next to your account name. In the case of a Publisher account, this is the Audience Link ID. * An audience in Zeotap CDP that you want to activate, or the criteria to build one. ## Add Zeotap as a data provider in the AppNexus Data Marketplace Zeotap's segments reach your seat through the AppNexus Data Marketplace, so add Zeotap as a data provider on the AppNexus side: **Step 1** Log into the AppNexus Data Marketplace console. **Step 2** Click the **Audiences** tab and then click **Segments** from the drop-down menu. ![The AppNexus console's Audiences menu open, with Segments highlighted in the drop-down](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-20221012-060331.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=1b71cb81437f594dfecf28c1909b6ef9) > [!NOTE] > > Ensure that you do not share segments with non-activated buyers, as it can result in untracked usage. **Step 3** In the window that appears, click **Manage Data Providers**. ![The Segments page in the AppNexus console, with the Manage Data Providers button highlighted at the top right](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-20221011-123419.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=ef87b333f3167b2a9d87c9e986fe505e) **Step 4** Select the data providers that you want to access segments from, including Zeotap, and click **Save**. ![The Manage Data Providers screen, listing the available Data Marketplace providers with selection checkboxes and a Save button](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-20221011-123745.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=3ccbdf593140d405139519095b75538f) **Step 5** Refresh the page to view the data provider's segments on your account. After adding Zeotap as a data provider, you can find the segments under the **Shared Segments** section. ## Create the AppNexus destination **Step 1** Log into the Zeotap CDP App and go to the **Destinations** module. **Step 2** Click **+ Create Destination**. ![The Destinations list with the + Create Destination button highlighted above the table of existing destinations](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_1.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=92dfe8ecb29e59c9d7d57cb954e54618) **Step 3** Under **All Destinations**, search for **AppNexus**. ![The All Destinations catalogue with the search box highlighted, showing the AppNexus tile among the available destinations](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_2.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=6f5f0f5367788fb4e9e946f4b3cb5874) **Step 4** Click **AppNexus**. A screen appears with details about the destination on the left and, on the right, the fields required to establish the integration. Enter the required details: a. Enter a name for the destination. b. Enter the **Seat ID** on which the client has requested the audience or segment. c. Review the values you entered and click **Next** to proceed. ![The Enter Destination Details step of the AppNexus destination wizard, showing the Destination Name and Seat ID fields](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/appnexus/appnexus-2023-11-07-1.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=665e5b830308e5c90255d0ce901e1907) **Step 5** In the new screen that appears, choose the action and the mapping: a. Choose the desired [action](/articles/integrate-customer/destinations#configure-a-destination) under **Choose your Action**, then choose the corresponding identifiers under **Map the Fields**. By default, the [output identifiers](/articles/segment-customer/choose-the-output-identifiers) that are accepted by the platform — such as MAIDs, cookies, email IDs and more — are displayed. You can edit, add or remove an identifier from the list; to do so, refer to [defining the mapping](/articles/integrate-customer/destinations#define-the-mapping). b. Click **Create Destination**. The created destination gets listed in the **Target** and **Audiences** applications, where it can be linked to an audience or segment. ![The Mapping step with the action Send identifiers to AppNexus selected, and Catalogue fields mapped to MAID and Appnexus Cookie](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/appnexus/appnexus-2023-11-07-2.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=f9b508a925be8e1f39287cc900dacc0e) ## Link an audience to the destination For information about how to link an audience or segment to the created destination in the **Audiences** and **Target** applications, refer to [activating your batch audiences](/articles/integrate-customer/link-an-audience-to-the-destination). It can take one business day for the audience or segment to be available at the AppNexus seat. > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience or a segment can be a specific group of customers who are over 18 years of age and have performed an `addToCart` event within the last 30 days. ## Verify the delivery Confirm the delivery from both sides: 1. **In Zeotap CDP** — the destination appears in the **Target** and **Audiences** applications once it is created, and the audience–destination pair records the outcome of each refresh. For what a failed run looks like and how to read it, see [why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail). 2. **In AppNexus** — open **Audiences** > **Segments** and look under **Shared Segments** for the Zeotap segments. Allow one business day after activation before expecting the segment to appear on the seat. ## Next steps * [Activate your batch audiences →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Understand delta upload and delete functions →](/articles/segment-customer/delta-upload-and-delete-functions) * [Extend an audience with ID extension →](/articles/segment-customer/extend-your-audience#id-extension) * [Browse the other batch integrations →](/articles/integrate-customer/destination-batch-integrations) # AppsFlyer Real Time Integration Source: https://docs.zeotap.com/articles/integrate-customer/appsflyer-real-time-integration Send mobile app and web events from Zeotap CDP to AppsFlyer in real time, from a journey's Send to Destinations node. ## What this is AppsFlyer is a **destination**: data flows out of Zeotap CDP to AppsFlyer. It is a **real-time** destination, which means it is driven from a journey and attaches to a **Send to Destinations** node — it is not linked to an audience. AppsFlyer is a mobile marketing analytics and attribution platform. It measures user acquisition campaigns across the whole customer journey, from the first ad interaction through to in-app activity, with multi-touch attribution, fraud protection and deep linking. This integration sends your event data from Zeotap CDP to AppsFlyer so those events can be attributed alongside the ones AppsFlyer already collects through its own SDK. AppsFlyer is available as a destination only. To bring app and website event data **into** Zeotap CDP, set up a [source](/articles/integrate-customer/sources) instead. ## Supported identifiers and actions The mapping screen is where you choose what this destination sends and which fields carry it. * **Actions.** The destination covers two event paths, each authenticated with its own key: **Send Mobile Events to AppsFlyer**, which uses AppsFlyer's Mobile S2S API, and **Send Web events to AppsFlyer**, which uses AppsFlyer's Web S2S API. Pick the one that matches the events you are sending under **Choose your Action**. * **Identifiers.** By default, the mapping shows the output identifiers the platform accepts — `customer_user_id` and `appsflyer_id`. You can edit, add, or remove an identifier from that list. * **Mandatory fields.** Every mapping must populate `eventName`, `eventValue`, `customer_user_id` and `appsflyer_id`. ## Prerequisites 1. An **active AppsFlyer account**. 2. **Your mobile apps configured in AppsFlyer.** Each Android and iOS application you want to send events for must already be added and configured in your AppsFlyer account — this is what lets AppsFlyer recognise the app. 3. **The AppsFlyer SDK integrated into those apps.** The SDK generates and collects the `appsflyer_id` for each user installation, and that identifier is mandatory for sending mobile app events through this integration. 4. **For web events:** your web property added in AppsFlyer as a *web app*, typically associated with a *brand bundle*. This is what produces the Web Dev Key. 5. **The AppsFlyer credentials** listed in the next section. ## Get your AppsFlyer credentials Collect these from AppsFlyer before you start, because the destination form asks for them in one pass. | Credential | What it is | Where AppsFlyer keeps it | | - | - | - | | **App ID** | The unique identifier of your mobile app — for example `com.example.app` for Android, `id123456789` for iOS. | The app's own entry in your AppsFlyer account. | | **Dev Key** | The primary authentication key for your AppsFlyer account, used for mobile (S2S) events. | **App Settings**, or **Security Center > API Tokens**. | | **Web Dev Key** | The authentication key for your web property, used for web (S2S) events. | **My Apps > View brand bundles**. | > [!NOTE] > > For an iOS app, enter the App ID exactly as AppsFlyer shows it, including the leading `id`. Without that prefix AppsFlyer still accepts the call, but the event is not recorded. ## Create the AppsFlyer destination **Step 1** Log in to the Zeotap CDP App and go to **Destinations** under **Integrate**. **Step 2** Click **+ Create Destination**. **Step 3** Under **All Destinations**, search for **Appsflyer**. **Step 4** Click **Appsflyer**. Details about the destination appear on the left of the screen; the fields the integration needs are on the right. Enter: a. A name for the destination. b. The **Dev Key**. c. The **Destination Instance Name**. d. The **App ID**. e. The **Web Dev Key**. f. The **Bundle ID**. g. Click **Next** to proceed to the mapping screen. ![The AppsFlyer destination details screen in Zeotap CDP, with the destination name and the AppsFlyer credential fields on the right of the screen.](https://lh7-qw.googleusercontent.com/docsz/AD_4nXdj2Qnz7nt0yGlYhcf5IV-rLvfFRSZGoPxMAMC1s7DGjlQL8ld7rcrgE4UQGE2ZEIomM2gKNMGZbP0rCt-tjOW4Q_2HTGFpmlUb1VV6rOthvLw6Mz3jZzKM2yfeUftK1Wc15LWX_A?key=mboj1TlFErc2rVAVCRFVXw) **Step 5** On the screen that follows, choose the action and build the mapping. a. Under **Choose your Action**, select **Send Mobile Events to AppsFlyer** or **Send Web events to AppsFlyer**, then choose the corresponding identifiers under **Map the Fields**. By default, the output identifiers accepted by the platform — `customer_user_id` and `appsflyer_id` — are displayed. You can edit, add, or remove an identifier from the list. b. Populate the mandatory fields: `eventName`, `eventValue`, `customer_user_id` and `appsflyer_id`. c. *(Optional)* Click **Generate Preview** to see the exact payload Zeotap will send before you save. See [Payload Preview for Destination Mappings](/articles/integrate-customer/payload-preview-for-destination-mappings). d. Click **Create Destination**. ![The destination mapping screen, showing the Choose your Action step above the Map the Fields table.](https://lh7-qw.googleusercontent.com/docsz/AD_4nXfp_ljF0yzKjuxTOyKxURGexc5lU2GoCKSSlM1KUPNROT_4Z2A04-GpUVzrwUj2J7curtsjMQ0TpzhVF1MF2WFY71R_bSXmogMX3CqrNAWyCCuh8xwKCTDQk30hhY9_-QmWv6wY7g?key=mboj1TlFErc2rVAVCRFVXw) For the generic version of these steps and the mapping options shared by every destination, see [Destinations](/articles/integrate-customer/destinations#configure-a-destination) and [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). ## Add the destination to a journey A real-time destination delivers nothing on its own. It starts sending once it is attached to a **Send to Destinations** node inside a published journey. **Step 1** In the workflow, click **+** and choose **Send to Destinations**. ![A journey workflow canvas with the node menu open and Send to Destinations being selected.](https://lh7-qw.googleusercontent.com/docsz/AD_4nXcU5ySYaywSTMYC3ZIQtaavmZirF7nsakP3sIMvrjnITlbV8xM49OgXNMv8Hw6bZfZl4FlaJyogM0WAyR7H8AOUOseP2sZ_WRiQU5MSnuozWTu0BOP3lkL0ZSpXVpnA1AQlei6OsA?key=mboj1TlFErc2rVAVCRFVXw) **Step 2** Choose the destination from the list of available destinations, using the search to find it. ![The Send to Destinations panel, with the search field above a list of available destinations.](https://lh7-qw.googleusercontent.com/docsz/AD_4nXdXALWyVT0vwdFa6MWcABCqpp7ZLhlZ912UJYBgh_J3QhVKCQutSjDLawGn9QUZqwheV057b2zfpox6BGXIfAxtphrHZmjjsiV2fEb5EAWX54QUPQo_K5hA1AJQqvQ5F-6NCNhPGA?key=mboj1TlFErc2rVAVCRFVXw) **Step 3** Under the **Destination Details** tab, the connection details you entered while creating the destination are automatically populated. **Step 4** Under the **Destination Settings** tab, choose the action and mapping you need for this node. **Step 5** Click **Save Destination**. The destination is attached to the node, as shown below. ![A journey workflow canvas showing the destination attached to the Send to Destinations node.](https://lh7-qw.googleusercontent.com/docsz/AD_4nXe9K4k-X4ZulhM_e2ZDixBSitrz5Dn7AM_NmrkJsAttCHF4-nOCX9amJvp6Nkcbd6yG96-nydcxFPkMpIcBX0ITxUiNwo0Xx9FJOLjIEvNXZzM_AYL0WrnV4gaNxWOpL11HsTq8?key=mboj1TlFErc2rVAVCRFVXw) Finish the workflow — entry conditions, re-entry criteria and publishing — as described in [Activate Your Real-Time Audiences](/articles/integrate-customer/activate-your-real-time-audiences) and [Create a Workflow](/articles/orchestrate-customer/create-a-workflow). Events only start flowing once the workflow is published. ## Verify the integration Check the integration from both sides: 1. **Before you save the mapping** — click **Generate Preview** on the mapping screen and confirm the sample payload carries the identifiers and event fields you expect. See [Payload Preview for Destination Mappings](/articles/integrate-customer/payload-preview-for-destination-mappings). 2. **After the journey is published, in Zeotap CDP** — open the journey canvas and check the execution counts on the **Send to Destinations** node. A healthy node shows events entering and succeeding; failures are counted separately and carry a failure status code. See [Identify Journey Errors](/articles/orchestrate-customer/identify-journey-errors), and use [Journey Traces](/articles/orchestrate-customer/journey-traces) to follow a single user end to end. 3. **In AppsFlyer** — confirm the events arrive for the app or web property you configured, under the event names you mapped. ## Troubleshoot the AppsFlyer destination | Symptom | What to check | | - | - | | The node records an **authentication** failure. | The key on the destination for the path you are sending on: the **Dev Key** for mobile app events, the **Web Dev Key** for web events. Confirm each is the key AppsFlyer currently shows, and that the Web Dev Key is the one from the brand bundle rather than the account Dev Key. | | The node records a **bad request** or a rejected payload. | The mapping. All four mandatory fields — `eventName`, `eventValue`, `customer_user_id` and `appsflyer_id` — must be populated, and **Generate Preview** shows what is actually being sent. | | Mobile events are accepted but no event appears in AppsFlyer for an **iOS app**. | The **App ID**. An iOS App ID must keep its leading `id` prefix; without it the call still succeeds but the event is not recorded. | | Events for a user never reach the node at all. | The journey itself rather than the destination — the user may not be qualifying for that branch. Trace the individual user with [Journey Traces](/articles/orchestrate-customer/journey-traces). | For the full list of failure status codes and what each one means, see [Journey Error Codes](/articles/orchestrate-customer/journey-error-codes). If the failure persists after those checks, raise a support request with the journey, the node, the failure status code, the timestamp of the failure and the Request ID shown in the **Execution Details** panel. ## Next steps * [Create a workflow to drive the destination →](/articles/orchestrate-customer/create-a-workflow) * [Activate the destination on journeys →](/articles/integrate-customer/activate-your-real-time-audiences) * [Preview the payload before a mapping goes live →](/articles/integrate-customer/payload-preview-for-destination-mappings) * [Look up a journey failure status code →](/articles/orchestrate-customer/journey-error-codes) * [Control which folders can use this destination →](/articles/integrate-customer/destination-access-rules) # Archived Source Source: https://docs.zeotap.com/articles/integrate-customer/archived-source Archive a source to pause all future ingestion without deleting the data Zeotap has already ingested, and unarchive it when you want ingestion to resume. ## What this is Archiving is how you retire a source you no longer want to receive data from, without losing the records it has already contributed. When you archive a source, Zeotap keeps every record already ingested from that source and pauses all future ingestion for it. The action is reversible — you can unarchive the source at any time and ingestion resumes from that point. Both actions are taken from the Sources listing page under **Integrate** > **Sources**. ## Prerequisites > [!NOTE] > > Before you archive or unarchive a source, confirm: > > * Your role carries the **Create, Pause, Resume, and Archive Sources** access for **Integrate > Sources**. To check, open **Admin > My Roles** and look under **Define Permissions > Integrate > Sources**. See [My Roles](/articles/admin-customer/my-roles) and [User Roles and Access](/articles/admin-customer/user-roles-and-access). > * You can open **Sources** under **Integrate** and find the source in the listing. > * For a streaming source, you are able to remove the Zeotap pixel or SDK from your pages. Archiving pauses ingestion on the Zeotap side; it does not stop your pages from sending. ## Key concepts * **Data already ingested is retained.** Archiving a source does not delete the data Zeotap has already ingested from it. * **Future ingestion is paused.** While a source is archived, no further records are ingested for it. * **The listing splits into two tabs.** The Sources listing page is divided into an **Available** and an **ARCHIVED** tab. An archived source appears under **ARCHIVED**, with the status **Archived**. * **Streaming sources need a change on your side as well.** For streaming sources, remove the Zeotap pixel or SDK from your pages so the origin stops sending. * **Archiving is reversible.** You can unarchive at any time. File ingestion resumes if there are files to ingest, and if the Zeotap tag was pushing streaming data, that resumes from the moment the source is unarchived. * **Archiving is not the same as pausing.** Pausing is a temporary hold, recorded on the listing as its own set of statuses — **Paused**, **Paused (Collection)** and **Paused (Ingestion)**. See [Components of the Source Listing Page](/articles/integrate-customer/components-of-the-source-listing-page) for every status and the actions each one allows. ## Archive a source **1. Open the Sources listing** Under **Integrate**, open **Sources**. The **Available** tab lists the sources that are not archived. **2. Open the actions menu for the source** Find the source you want to archive and click the three dots in the **ACTIONS** column at the end of its row. **3. Choose Archive** Select **Archive** from the drop-down menu. ![Sources listing with a row actions menu open, showing Rename, Pause and Archive.](https://mintcdn.com/zeotap/xGzkHY-dcQy5tLit/articles/integrate-customer/Storage/integrate-customer/3166076931/3166076931-2023-11-06-2.png?fit=max\&auto=format\&n=xGzkHY-dcQy5tLit\&q=85\&s=2725655480f9b2d3e0ce8ca092046424) Figure 1 — The actions menu on the Sources listing, with Archive selected. **4. Remove the Zeotap pixel or SDK (streaming sources)** If the source is a streaming source, remove the Zeotap pixel or SDK from your pages. Archiving pauses ingestion at Zeotap; removing the pixel or SDK is what stops your pages from sending. ## Unarchive a source **1. Open the ARCHIVED tab** On the Sources listing page, select the **ARCHIVED** tab and find the source you want to bring back. **2. Open the actions menu for the source** Click the three dots in the **ACTIONS** column at the end of the source's row. **3. Choose Unarchive** Select **Unarchive** from the drop-down menu. ![Sources listing on the ARCHIVED tab with rows in the Archived status and an actions menu showing Unarchive.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-23.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=929f72b61f5fdfe7fea2b2f4fc9351fe) Figure 2 — The ARCHIVED tab of the Sources listing, showing Unarchive in the actions menu of an archived source. **4. Put the Zeotap pixel or SDK back (streaming sources)** If you removed the Zeotap pixel or SDK when you archived a streaming source, put it back on your pages. Streaming data resumes from the moment the source is unarchived, so nothing arrives until the origin starts sending again. ## Verify the change took effect * **After archiving** — the source moves to the **ARCHIVED** tab and its status reads **Archived**. * **After archiving a source that was receiving data** — the **LAST INGESTED** timestamp on the source's row stops advancing, because no further records are ingested while the source is archived. * **After unarchiving** — the source is listed under **Available** again. For a batch source, ingestion picks up when there are files to ingest; for a streaming source, data resumes from the moment you unarchived it. ## Troubleshooting * **The source is archived, but your site or app is still sending data.** Archiving pauses ingestion at Zeotap only. Remove the Zeotap pixel or SDK from your pages to stop the origin sending. * **Archive does not appear in the actions menu.** The actions offered in the menu depend on the source's current status, and archiving depends on your access. Check the status shown on the listing, and confirm your role carries the **Create, Pause, Resume, and Archive Sources** access. * **You unarchived a source and no new records arrived.** For a batch source, ingestion resumes only when there are files to ingest — confirm a new file has landed at the location the source reads. For a streaming source, sending resumes from the moment of unarchiving, so the Zeotap pixel or SDK has to be back on your pages. ## FAQ > [accordion] What happens to data when I archive a source? > > Zeotap retains all data ingested before archival and pauses all future ingestion for that source. The source moves to the **ARCHIVED** tab of the Sources listing with the status **Archived**. For a streaming source, remove the Zeotap pixel or SDK from your pages so the origin stops sending. > [accordion] Can I unarchive a source later? > > Yes. You can at any time choose to unarchive an already archived source. Once it is unarchived, file ingestion resumes if there are files to ingest, and if the Zeotap tag was pushing streaming data, that resumes from the moment the source is unarchived. > [accordion] Do I have to remove the Zeotap pixel or SDK when I archive a streaming source? > > Yes. Archiving pauses ingestion on the Zeotap side, but it does not change what your pages send. Remove the Zeotap pixel or SDK from your pages when you archive a streaming source, and put it back when you unarchive. > [accordion] Is archiving the same as pausing a source? > > No. They are separate states on the Sources listing: an archived source sits on the **ARCHIVED** tab with the status **Archived**, while a paused source stays on the listing with the status **Paused**, **Paused (Collection)** or **Paused (Ingestion)**. See [Components of the Source Listing Page](/articles/integrate-customer/components-of-the-source-listing-page) for what each status means. ## Next steps * [Explore how sources bring data into Zeotap CDP →](/articles/integrate-customer/sources) * [Explore the Source listing page controls →](/articles/integrate-customer/components-of-the-source-listing-page) * [Explore the Source Report →](/articles/integrate-customer/source-report) * [Explore source alerts →](/articles/integrate-customer/source-alerts) # ELAINE Source: https://docs.zeotap.com/articles/integrate-customer/artegic-elaine Send audiences out of Zeotap CDP to ELAINE recipient groups over SFTP, using the identifier-only, delta and full-replace actions. ## What this is The ELAINE destination sends audiences **out of Zeotap CDP to ELAINE**, as recipient groups delivered to an SFTP bucket hosted within ELAINE. Nothing flows back from ELAINE into Zeotap CDP. ELAINE is an AI-powered marketing platform that helps businesses to connect with their customers. By leveraging customer data and AI technology, ELAINE enables marketers to create highly personalised and targeted email campaigns for maximum engagement and conversions. Integrated with Zeotap CDP, it allows marketers to create recipient groups and add more personalisation for the targeted audience. Zeotap CDP offers two separate ELAINE destinations, and both send data outbound from Zeotap CDP: * **ELAINE** — this page. A batch destination that delivers audiences into ELAINE recipient groups over SFTP. * **[Elaine Trigger Events](/articles/integrate-customer/elaine-real-time-integration)** — a real-time destination that sends event data from a Journeys workflow. The two use different credentials and are configured independently. Read the page for the one you are setting up. ## Supported identifiers and actions This integration supports First Name, Last Name, Email Addresses (raw), Gender and custom fields (any identifier or attribute). | Action | [ID extension](/articles/segment-customer/extend-your-audience#id-extension) | [Delete](/articles/segment-customer/delta-upload-and-delete-functions) | [Delta upload](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send identifiers to Artegic Elaine | ✅ | ✅ | ✅ | | Send Recipients to be Added in Recipient Group | - | ✅ | ✅ | | Send Recipients to be Replaced in Recipient Group | - | - | - | Delta and Delete are enabled per destination rather than being on by default — see [Delta Upload and Delete Functions](/articles/segment-customer/delta-upload-and-delete-functions#feature-activation-process). ## Prerequisites Complete the upstream setup common to every destination first — a connected source, fields mapped to the Catalogue, a defined audience, and destination edit rights on the organisation that owns the destination. See [Destinations](/articles/integrate-customer/destinations#prerequisites). Then gather the ELAINE details below. The destination screen lists the same set on the left when you create it. ### SFTP host, SFTP username, SFTP port and public key These are the details of the SFTP (Secure File Transfer Protocol) bucket hosted within ELAINE that you must provide to enable a secure connection. This ensures a smooth transfer of data between ELAINE and the SFTP bucket. * **SFTP Host** — the hostname or IP address of the server hosting the SFTP service. It represents the network location where the SFTP server is running and where the files are stored or transferred, and it is what Zeotap CDP connects to when it establishes the SFTP session. * **SFTP Username** — the unique identifier used to authenticate and authorise a user for SFTP access. It is a combination of characters, or a designated account name, that identifies the individual or entity accessing the SFTP server. * **SFTP Port** — the number that specifies the communication endpoint for SFTP connections. It represents the specific port on the server where the SFTP service is running and listening for incoming connections. * **Public Key** — Zeotap uses SFTP public key authentication to keep the transfer secure. It involves two keys, a public key and a private key, that go together as a pair. These keys are unique and cannot be used interchangeably with any other keys. Zeotap provides the public key, and you must register it within your SFTP server. ### API host, API username and API password The API host is the ELAINE endpoint that receives the API requests. The API username and password are the credentials ELAINE uses to create recipient groups. Together they provide authorised access to the API, enabling the creation and management of recipient groups for targeted marketing campaigns in ELAINE. Contact your ELAINE representative to obtain these three details. ### Folder Id The Folder Id is the unique identifier assigned to a specific folder within ELAINE. By specifying it, Zeotap CDP creates recipient groups in the folder you designate for the email upload that follows. ## Create the custom fields in ELAINE If you intend to send custom fields, create them in ELAINE before you configure the mapping. You enter the field's **variable** name — not its label — in the **Destination Field** column in Zeotap CDP, so note the variable name of each field you plan to map. **Step 1** Log into ELAINE and navigate to the global folder, or to the folder where the custom field is located. **Step 2** Select **Data Fields** and review the list of available fields in the folder. **Step 3** Click the field you want to map in Zeotap CDP. **Step 4** In the **Characteristics** section, locate the **Variable** field. Variable names usually start with `c_` or `e_` — for example, a custom text field added in ELAINE may have the variable name `c_test_zeotap_text`. Copy this value for use in the mapping step. ## Create the ELAINE destination **Step 1** Log into Zeotap CDP and go to **Integrate > Destinations**. **Step 2** Click **+ Create Destination**. ![The Destinations list in Zeotap CDP, with the + Create Destination button highlighted above the table of existing destinations.](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_1.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=92dfe8ecb29e59c9d7d57cb954e54618) **Step 3** Under **All Destinations**, search for **ELAINE**. ![The All Destinations catalogue, with the Search for a Destination box highlighted above the grid of destination tiles.](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_2.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=6f5f0f5367788fb4e9e946f4b3cb5874) **Step 4** Click **ELAINE**. The **Enter Destination Details** screen appears, with a description of the destination and the components it needs on the left, and the fields required to establish the integration on the right. Enter the following: a. **Destination Name** — a name for the destination, for easy identification. b. The **SFTP Port**, **SFTP Username** and **SFTP Host**. c. The **API Host**, **API Username** and **API Password**. d. The **Folder Id**. e. Confirm that the Zeotap public key is registered within your SFTP server. f. Review all the values you entered, then click **Next**. ![The Enter Destination Details step of the ELAINE destination, with the Destination Name, SFTP Port, SFTP Username and SFTP Host fields on the right and the ELAINE description and its list of required components on the left.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/artegic-elaine/artegic-elaine-2024-12-06-2.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=40404ce005bc53f5680279e71f26975a) **Step 5** On the mapping screen, under **Choose your Action**, select one of the three actions listed in [Supported identifiers and actions](#supported-identifiers-and-actions), then map the relevant Catalogue fields to the Destination fields. a. **Send identifiers to Artegic Elaine** sends Email Addresses (raw) only. ![The mapping screen with Send identifiers to Artegic Elaine selected under Choose your Action, and an Output Identifiers Mapping row pointing the Email catalogue field at the Email Raw destination field.](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/artegic-elaine/artegic-elaine-2024-12-19.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=b56a08602922e1215f5ceacf1e99cc62) b. **Send Recipients to be Added in Recipient Group** and **Send Recipients to be Replaced in Recipient Group** send details such as first name, last name, gender and email address (raw). You can include any custom field — identifier or attribute — by using **+ Add Mapping Field**, entering the ELAINE variable name you noted in [Create the custom fields in ELAINE](#create-the-custom-fields-in-elaine) as the **Destination Field**. The key difference between the two actions is how much data each sync carries: * **Send Recipients to be Added in Recipient Group** supports a delta update. A delta update retrieves the complete dataset during the initial fetch, but subsequent synchronisations include only the incremental changes (deltas) made since the last sync. This reduces data transfer by updating only the modified records, improving efficiency. For more information about how the data update occurs, refer to the [ELAINE help documentation](https://help.elaine.io/docs/add-import-recipients-to-be-added-in-recipient-group). * **Send Recipients to be Replaced in Recipient Group** supports a full update. A full update retrieves the complete dataset during the initial fetch and transfers the entire dataset during each subsequent synchronisation, regardless of any changes made. This ensures the full dataset is updated at each sync frequency. For more information about how the data update occurs, refer to the [ELAINE help documentation](https://help.elaine.io/docs/replace-import-recipients-to-be-replaced-in-recipient-group). ![The Map the Fields table for an ELAINE destination, with Attributes rows mapping the catalogue Email, First Name, Last Name and gender fields to the matching ELAINE destination fields, a highlighted row mapping a catalogue attribute to a custom ELAINE variable field, and the + Add Mapping Field link below.](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/artegic-elaine/artegic-elaine-2024-09-13.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=77a12bf91b5c20ff34734020912d1415) **Step 6** Under **Additional Settings**, set the [Skip Deleted](https://help.elaine.io/docs/add-import-recipients-to-be-added-in-recipient-group) parameter. When `skip-deleted` is set to `True`, only records which are not in the ELAINE recycle bin are updated. When it is set to `False`, records in the ELAINE recycle bin are updated as well. The same panel carries **Enable Delta uploads** — when enabled, only changes since the last sync are sent. ![The Additional Settings panel of the ELAINE destination, showing the Skip Deleted selector and the Enable Delta uploads checkbox with its description.](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/artegic-elaine/artegic-elaine-2025-10-08.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=4f21327803a5df11e18881248cf99c74) **Step 7** Once the mapping is done, click **Create Destination**. The created destination is listed in the **Audiences** application, where it can be linked to an audience (segment). ## Link an audience to the destination For how to link an audience or segment to the created destination in the **Audiences** application, see [Activate Your Batch Audiences](/articles/integrate-customer/link-an-audience-to-the-destination). Once the audiences are pushed, emails begin to populate within one hour at the ELAINE seat. > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience or a segment can be a specific group of customers who are over 18 years of age and have performed an `addToCart` event within the last 30 days. ### User disqualification from audiences This integration supports user disqualification from audiences. A user can be disqualified from an audience (segment) for various reasons, such as not meeting the audience criteria, consent requirements or other conditions set for a particular audience. * When a user disqualifies from an audience, Zeotap CDP initiates a user deletion request in the next refresh cycle. These requests are sent to the audiences linked to the specific destination. * The disqualified users are excluded from the audiences based on the configured refresh frequency for a particular audience. * User disqualification is a programmatic process that works automatically. You do not need to specify anything to trigger the disqualification and exclusion of users from audiences. For more information about this functionality, see [Delta Upload and Delete Functions](/articles/segment-customer/delta-upload-and-delete-functions). ## Verify the delivery Confirm the delivery from both sides. **In Zeotap CDP** — open the destination and review its activity. A successful delivery records a run with a non-zero qualified count and a completed status; a run that fails records an error message you can use to diagnose the cause. See [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). **In ELAINE** — in the ELAINE console you can view the audience (recipient groups) organised within specific folders, by using the associated Folder Id. Allow up to an hour after the audience is pushed. ![The ELAINE console dashboard, with the Audiences tree expanded in the left navigation and a recipient-count tile and group-membership charts on the right.](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/artegic-elaine/artegic-elaine-2024-12-06-4.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=e212d97c4b0c5867743a2aab2a2199a0) ## Troubleshoot this integration * **A custom field is not populated in ELAINE.** The field must already exist in ELAINE, and the **Destination Field** in the mapping must be its variable name (usually starting with `c_` or `e_`), not its label. See [Create the custom fields in ELAINE](#create-the-custom-fields-in-elaine). * **Recipients in the ELAINE recycle bin are not updated.** When **Skip Deleted** is set to `True`, only records which are not in the ELAINE recycle bin are updated. Check the value set on the destination. * **Only part of the audience arrives after the first sync.** The delta action sends only the records that changed since the last sync. Use the full-replace action if every sync must carry the complete dataset. * **The delivery itself failed.** For the errors that surface on the audience–destination pair and what each one means, see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail), and [When to contact support](/articles/integrate-customer/destinations#when-to-contact-support) for what to include in a ticket. ## Next steps * [Set up the real-time ELAINE destination →](/articles/integrate-customer/elaine-real-time-integration) * [Activate your batch audiences →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Understand delta uploads and delete functions →](/articles/segment-customer/delta-upload-and-delete-functions) * [Extend an audience with ID extension →](/articles/segment-customer/extend-your-audience#id-extension) * [Review the Destinations overview →](/articles/integrate-customer/destinations#configure-a-destination) # Azure Blob Storage Source: https://docs.zeotap.com/articles/integrate-customer/azure-blob-storage Send Zeotap CDP audiences out to a container in your Azure Blob Storage account as CSV files, authenticated with the storage account connection string. This page covers the **Azure Blob Storage destination** — sending audiences **out of** Zeotap CDP into a container in your Azure Storage account. It is a batch, file-based destination: each activation writes one or more CSV files into the container and folder you nominate. To bring data **into** Zeotap CDP instead, start from [Sources](/articles/integrate-customer/sources); for the object-storage destinations that work the same way as this one, see [Amazon S3](/articles/integrate-customer/amazon-s3-destination) and [Google Cloud Storage](/articles/integrate-customer/google-cloud-storage). ## What this is Azure Blob Storage is Microsoft Azure's object storage service, organised into storage accounts that hold containers, and containers that hold blobs. The Azure Blob Storage destination in Zeotap CDP activates an audience (segment) by writing it as a complete CSV file into a container in your storage account, optionally under a virtual folder path. Zeotap CDP authenticates to the storage account with the account's **Connection String**, which carries everything needed to establish the connection. This page walks the setup end to end: retrieving the connection string in the Azure Portal, identifying the container and folder to write into, and creating the destination in Zeotap CDP. ## Prerequisites > [!NOTE] > > Gather the following before you begin. You do the Azure-side work once; the destination in Zeotap CDP then reuses it for every audience you activate. > > * An active **Microsoft Azure** account. > * An existing **Azure Storage Account** created within that account. > * The necessary permissions within your Azure account to access the storage account's security credentials. > * The storage account's **Connection String** — see [Find your connection string in Azure](#find-your-connection-string-in-azure). > * The **Container**, and optionally the **Folder** path inside it, that Zeotap CDP should write to — see [Choose the container and folder in Azure](#choose-the-container-and-folder-in-azure). ## Supported actions The destination exposes a single action, **Send Complex CSV file to Blob Storage**. On the mapping screen you can map: * Identifiers * Any other custom field, using the **+ Add Mapping Field** button For how actions and mappings work across all destinations, see [Key concepts](/articles/integrate-customer/destinations#key-concepts) and [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). ## Authentication: using the connection string To connect to your Azure Storage Account, Zeotap CDP uses a Connection String. This string acts as a secure password, containing all the information needed to authenticate access. It is the only credential needed to establish the connection. ### What you need You need four values to authenticate the connection and name the exported files: 1. **Storage Account Name** — the unique name you assigned to your Azure Storage account. 2. **Connection String** — the access string obtained from the procedure below. 3. **Account Key** — a secret access key that provides administrative rights to the storage account. 4. **Filename Prefix** — the way you would identify your file. The naming convention is described under [Create the Azure Blob Storage destination in Zeotap CDP](#create-the-azure-blob-storage-destination-in-zeotap-cdp). ### Find your connection string in Azure Follow these steps to locate the credentials in your Azure Portal. **Step 1** **Log in to the Azure Portal.** Open your web browser and navigate to [https://portal.azure.com](https://portal.azure.com). ![Azure Portal sign-in page](https://lh7-qw.googleusercontent.com/docsz/AD_4nXfvheIkg92qb8BbAgy43Zja8XUBlhYh3Jv2ovHNSxMbjiollxR5DoMfMhgcg3RGHLawO0O2eI1tZzrsGGOoe3yu4ykvvVsfGH_PLFI0IMNt1wBX2LSGu28EtPuMzVeNWkGaOXfFSg?key=XI6r65vGrPcWQvwwmQ7GLA) **Step 2** **Navigate to the storage account.** Use the main search bar at the top of the portal to search for and select your storage account. ![Searching for a storage account from the Azure Portal search bar](https://lh7-qw.googleusercontent.com/docsz/AD_4nXewBHJR0Kvrz8crSVolzdqjb66Fu9QxKCQyrf-hkD04eYt1DHAI29zs5V0Qe-a1WAcdDz-WrYDFcZLWW0fgfJTA0pAL7NMISYbTvdGcL9Gi0fM4_8viZzNAp_nOnxhQQ7mbWxhhxA?key=XI6r65vGrPcWQvwwmQ7GLA) **Step 3** **Open the access keys.** In the left-hand menu for your storage account, find the section labelled **Security + networking** and click **Access keys**. **Step 4** **Retrieve the credentials.** * The **Storage account name** is displayed at the top of this page. * You will see two keys, **key1** and **key2**. Click **Show** next to either key. * Azure also provides the complete **Connection string**. Click the copy icon next to the connection string to copy it to your clipboard. The copied connection string looks similar to this example: ```text theme={null} DefaultEndpointsProtocol=https;AccountName=yourstorageaccountname;AccountKey=yourverylongaccountkey;EndpointSuffix=core.windows.net ``` This single string is what you provide to Zeotap CDP for authentication. ## Choose the container and folder in Azure Once authentication is established with the connection string, specify the exact location within the storage account where the audience files land. These path inputs are provided separately from the connection string. * **Container Name** — the name of the specific container that Zeotap CDP writes into. * **Folder Name** (optional) — the virtual folder path within the container. If no folder is specified, data is placed in the root of the container. ### Find your path inputs in Azure **Step 1** **Navigate to the storage account.** In the Azure Portal, go to your storage account's main page. **Step 2** **Go to Containers.** From the left menu, under the **Data storage** section, click **Containers**. ![Containers option under Data storage in the Azure storage account menu](https://lh7-qw.googleusercontent.com/docsz/AD_4nXeLapwW5wqi3K-oLVNOysBkn8Dxm_aiyAmxywMUrxgmW2ySiYwljDkfbBb3dY6P6Awbg0pJqIBwJA51NuDShKW5rlPZIBo82-L8o1KQ9lkMOm6Fw6GlxKWFrHj7Uy5Oblqp9sTjEA?key=XI6r65vGrPcWQvwwmQ7GLA) **Step 3** **Identify the container name.** You will see a list of all containers within this storage account. Copy the exact name of the container you wish to use. ![List of containers in an Azure storage account](https://lh7-qw.googleusercontent.com/docsz/AD_4nXfgbqduQCIpJWsSVPVFjjvjz8FSDcH3JjjNhpvlJevfYeY84U85HKsppbTtzc3_CLCTPFzXZm4MtFzwzgYqh-UZT1F5hT0NshSXmC06BCsh5YHJ1rbm6FLFtsedxShaCJNupCmzLA?key=XI6r65vGrPcWQvwwmQ7GLA) **Step 4** **Identify the folder name.** * Click on the desired container name to view its contents. * Azure Blob Storage uses a virtual folder structure. These folders are created by including slashes in the blob names — a file named `processed/invoices/inv_123.pdf` creates the virtual folders `processed` and `invoices`. * Determine the folder path you intend to use, for example `input-files` or `processed/invoices`. ## Create the Azure Blob Storage destination in Zeotap CDP **Step 1** Log into the Zeotap CDP App and go to the **Destinations** application. **Step 2** Click **+ Create Destination**. ![Create Destination button in the Destinations application](https://lh7-qw.googleusercontent.com/docsz/AD_4nXcCd4KIOxabOFLccTGGM2znMaEgKMO4JFfxzqTaMpJBjDU1E_XJe_2ptj9jIhKYXVrhhfT-ImEUQeSLuvZ0BiqH3ny3zBXpxcfb-vpiVn_3YsZ1LEfiCv0g6tz0LaJqQ1HeUq8JvA?key=XI6r65vGrPcWQvwwmQ7GLA) **Step 3** Under the **All Destinations** section, search for **Azure Blob Storage**. ![Searching for Azure Blob Storage under All Destinations](https://lh7-qw.googleusercontent.com/docsz/AD_4nXfn_K9G1tz095O3-AKGhZBvRxa8HQRVd5YY9DV6pKQlFu8O496Yl_DqU75lvJWPRTRh-L9uupuebMvGN4VR2WasYq9Qceu4XP2wFsE-N2xMx_O7b9a3bXrnkxHRRNIO44UX7mdEMA?key=XI6r65vGrPcWQvwwmQ7GLA) **Step 4** Click **Azure Blob Storage**. A screen appears displaying details about the destination on the left. On the right-hand side you find the list of fields required to establish the integration. Enter the details as described below. a. Enter a name for the destination. b. Enter the **Access token** that you obtained from your Azure instance — the steps to retrieve it are under [Find your connection string in Azure](#find-your-connection-string-in-azure). ![Azure Blob Storage destination configuration fields in Zeotap CDP](https://lh7-qw.googleusercontent.com/docsz/AD_4nXeGE_N7c7FhlNHeDXYfsYd-mLlVvXnSkSAUnS2_LnWNq_H0fpOTGekoHIy6DTc3JmnzDZ8Ypb8sBKaXrDShxVzjueINB7QaxLyCdtay1yLqbeTFOj4PhpGqxK1rq4PlxxBzz7MJ9g?key=XI6r65vGrPcWQvwwmQ7GLA) c. Enter the **Container**, **Connection String**, **Prefix name** and **Folder** of your Azure instance — the steps to find the container and folder are under [Choose the container and folder in Azure](#choose-the-container-and-folder-in-azure). d. Under **Filename Prefix**, enter a text value without special characters, such as underscores (`_`), spaces, or symbols (`#, @, $, %, &, *`). Note that the file name follows the format: `${filenamePrefix}part-${sequence}_${destinationAudienceId}_${timestamp}.csv`, where the timestamp is the file generation time in epoch milliseconds (UTC) and `destinationAudienceId` is the ID associated with your audience (segment) in Zeotap CDP, which is generated by Zeotap CDP after the audience (segment) is linked to a destination. ![Filename Prefix field on a batch file destination configuration form — capture taken from the Amazon S3 destination, which uses the same field and naming convention](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/integrate-customer/amazon-s3-destination/amazon-s3-destination-2025-08-06-1.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=9815ce4ace2add60e912e2a98028d8d4) | Variable | Description | | :- | :- | | `filenamePrefix` | The prefix for the file name, typically indicating the context or purpose of the file (e.g., the segment or export type). | | `part-${sequence}` | A sequential number or identifier indicating the part or chunk number if the data is split across multiple files. | | `${destinationAudienceId}` | The unique ID assigned by Zeotap CDP to the audience (segment) after it is linked to a Destination. | | `${timestamp}` | The time the file was generated, in epoch milliseconds (UTC) — for example, `1722931200000`. | | `.csv` | The file extension, indicating that the file is in CSV (Comma-Separated Values) format. | **Example File Name:** `exportpart-0_894548842_1722931200000.csv` e. Review all the values entered above and then click **Next** to proceed. ![Completed Azure Blob Storage destination configuration before clicking Next](https://lh7-qw.googleusercontent.com/docsz/AD_4nXfL9uAdb2FTQOLuxBMsZoctS7j1vd7mnoVRU-AV35vPz3jbGcxBB0o7qKNeTkW1-MexFcfWH3jG1MjqIEuMki1EQTJOy68gHcrFvTsa7iKPXwoBrLqtXrUZ4mf9FopAHkKLVxp_7g?key=XI6r65vGrPcWQvwwmQ7GLA) **Step 5** In the new screen that appears, choose the appropriate [action](/articles/integrate-customer/destinations#key-concepts) and mapping. Under **Choose your Action**, choose **Send Complex CSV file to Blob Storage**. You can map the following fields: i. Identifiers ii. Any other custom field, using the **+ Add Mapping Field** button **Step 6** Click **Create Destination**. The created destination gets listed in the **Audiences** application, where it can be linked to an audience. ## Link an audience to the destination Attach the newly created destination to a Zeotap audience from the **Audiences** application. For the full walkthrough, see [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience or a segment could be a specific group of customers who are over 18 years of age and who have performed an `addToCart` event within the last 30 days. ## Verify the destination worked After linking an audience and triggering an activation, confirm delivery in the Azure Portal. 1. Open the storage account, go to **Containers**, and open the container you configured. If you set a **Folder**, browse to that virtual folder path; if you left it empty, look in the root of the container. 2. Confirm a CSV file is present and that its name follows the `${filenamePrefix}part-${sequence}_${destinationAudienceId}_${timestamp}.csv` pattern, with the prefix you entered on the destination. 3. Open the file and confirm the columns match the identifiers and fields you mapped on the destination's action. ## Troubleshooting | Symptom | What it means | Where to look | | - | - | - | | No file appears in the container after an activation | The connection string does not belong to the storage account you expect, or the **Container** value does not match a container in that account | Azure Portal → storage account → **Security + networking** → **Access keys** to re-copy the **Connection string**; **Data storage** → **Containers** to re-check the container name | | Files land in the container root instead of the folder you expected | No **Folder** value was set on the destination, or the folder path does not match the virtual folder path in the container | Zeotap CDP → the destination's configuration → **Folder**; Azure Portal → the container's contents | | The file name is not what you expected | The **Filename Prefix** contains special characters, or the prefix on the destination differs from the one you intended | Zeotap CDP → the destination's configuration → **Filename Prefix**. The prefix must be plain text without underscores, spaces, or symbols | ## FAQ > [accordion] Does this integration bring Azure Blob Storage data into Zeotap CDP? > > No — it is a destination. It sends audiences from Zeotap CDP out to your Azure Storage account as CSV files. To bring data into Zeotap CDP, start from [Sources](/articles/integrate-customer/sources). > [accordion] Where does Zeotap CDP write the file if I leave Folder empty? > > In the root of the container you configured. The **Folder** value is optional; set it only when you want the files placed under a virtual folder path. > [accordion] How do folders work in Azure Blob Storage? > > Azure Blob Storage uses a virtual folder structure — there are no real folders. Folders are created by including slashes in the blob names, so a file named `processed/invoices/inv_123.pdf` creates the virtual folders `processed` and `invoices`. Enter the path you intend to use, for example `input-files` or `processed/invoices`. > [accordion] What format are the delivered files in? > > CSV. The action is **Send Complex CSV file to Blob Storage**, and the delivered file name ends in `.csv`. ## Next steps * [Explore linking an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) — activate an audience against the destination you just created * [Explore the Destinations overview →](/articles/integrate-customer/destinations) — how actions and mappings work across every destination * [Explore the Amazon S3 destination →](/articles/integrate-customer/amazon-s3-destination) — the equivalent object-storage destination on AWS * [Explore Sources →](/articles/integrate-customer/sources) — bringing data into Zeotap CDP # Batch Source: https://docs.zeotap.com/articles/integrate-customer/batch Send custom audiences of advertising IDs, custom IDs or install IDs from Zeotap CDP to Batch, using your Batch Live API Key and REST API Key. ## What this is Batch is a mobile marketing automation platform that enables marketers to engage with their mobile app users through push notifications, in-app messaging and email. Integrated with Zeotap it provides a range of features and capabilities that enable marketers to create personalised and relevant experiences for their users and drive engagement, retention and revenue. Use this integration to send custom audiences to Batch. A custom audience can contain a list of custom user IDs, advertising IDs (GAID or IDFA) or install IDs. > [!NOTE] > > **Batch or Batch CEP?** > > Two Batch destinations appear in the Zeotap catalogue: > > * **Batch** — the connector described on this page. It sends custom audiences to Batch and is configured with a **Live API Key** and a **REST API Key**. > * **[Batch CEP](/articles/integrate-customer/batch-audience-management)** — a newer connector that reflects recent improvements to the Batch APIs and is recommended for new audience and profile integrations. It is configured with an **API Bearer Token** and a **Project Key**, and it can also update attributes on existing Batch profiles without creating an audience. > > Confirm with your team which connector to use before you start. ## Prerequisites > [!NOTE] > > Before you create the destination, make sure you have: > > * A **Batch account**. After logging in to Batch you are taken to the Batch dashboard. > * Your **mobile applications integrated with Batch**. Applications that are already integrated appear on the Batch dashboard. > * Your Batch **Live API Key** and **REST API Key** — see [Get your Batch API keys](#get-your-batch-api-keys). > * In Zeotap CDP, a role that grants destination edit rights, and an audience ready to activate. For the upstream set-up every destination depends on, see [Destinations](/articles/integrate-customer/destinations). ## Key concepts > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an Audience or a segment can be a specific group of customers who are over 18 years of age and have performed an `addToCart` event within the last 30 days. ### Supported identifiers This integration supports MAIDs, Custom IDs and Install IDs. ### Available actions and supported features The action you choose on the mapping screen decides which identifiers Zeotap sends and which delivery features apply to the destination. A tick means the feature is supported for that action. | Action | [ID Extension](/articles/segment-customer/extend-your-audience#id-extension) | [Delete](/articles/segment-customer/delta-upload-and-delete-functions) | [Delta Upload](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send Advertising IDs to Batch | ✅ | - | ✅ | | Send Install Ids to Batch | - | - | - | | Send Custom Ids to Batch | - | - | - | | Send Attributes to Batch | - | - | ✅ | ### User disqualification from audiences This integration supports user disqualification from audiences. That is, a user can be disqualified from an audience (segment) for various reasons, such as not meeting audience criteria, consent requirements or other conditions set for a particular audience. * When a user is disqualified from an audience, Zeotap CDP initiates a user deletion request in the next refresh cycle. These requests are sent to the audiences linked to the specific destination. * The disqualified users are excluded from the audiences based on the configured refresh frequency for a particular audience. * User disqualification is a programmatic process that works automatically. You do not need to specify anything to trigger the disqualification and exclusion of users from audiences. ## Get your Batch API keys Collect both keys from the Batch dashboard before you create the destination in Zeotap CDP. **1. Open Settings on the Batch dashboard** Navigate to the Batch dashboard and click **Settings** in the top panel. ![Batch dashboard with Settings highlighted in the top navigation and the General tab showing App information for the selected application.](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/create-a-batch-source/create-a-batch-source-2024-07-06-1.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=1665349650b7854f0fffed2733af73e0) The Batch dashboard with Settings selected in the top panel and the General tab open. **2. Copy the Live API Key and the REST API Key** The **General** tab of the **Settings** page displays the API keys. Copy the **Live API Key** and the **REST API Key** and use them while creating the destination. ![Batch API Keys card showing the Dev API Key, Live API Key and REST API Key fields, each with a copy button.](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/Imported/batch-img0002.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=447a1216270d5d9b831c6200a2aa4928) The API Keys card on the General tab, listing the Dev API Key, Live API Key and REST API Key. > [!WARNING] > > The REST API Key authenticates every request made to Batch. Treat both keys like passwords: store them securely and never share them in client-side code, screenshots or chat messages. ## Create a destination for Batch **1. Open Destinations** Log in to **Zeotap CDP** and go to **Integrate → Destinations**. **2. Start a new destination** Click **+ Create Destination**. ![Zeotap Destinations screen showing the Private Destination tab, a destination search box and the + Create Destination button highlighted.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/ADOBE_DMP_3.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=50d0558618336ceb78709191fcdda472) The Destinations list, with + Create Destination at the top right. **3. Find the Batch connector** Under **All Destinations**, search for **Batch**. ![Zeotap All Destinations catalogue with the search box highlighted above a grid of destination cards.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/ADOBE_DMP_4.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=a0de06ff7f37752957c9f44c072aaebd) The All Destinations catalogue, where the search box filters the available connectors. **4. Enter the destination details** Click **Batch**. A screen appears with details about the destination on the left, and on the right the fields that are required for the integration to be established. Enter the required details: * A name for the Destination. * The **Live API Key** and the **REST API Key** you copied from Batch. Review all the values entered above and then click **Next** to proceed to mapping. ![Enter Destination Details step for the Batch destination showing the Destination Name, Live API Key and REST API Key fields with the Next button at the bottom right.](https://mintcdn.com/zeotap/YNdtFkydSZ-00_Bc/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/batch_1.png?fit=max\&auto=format\&n=YNdtFkydSZ-00_Bc\&q=85\&s=a3e8fea8a0a5169776fb4b110017b267) The Enter Destination Details step for Batch, with the Destination Name, Live API Key and REST API Key fields. **5. Choose your action and map the fields** In the new screen that appears, choose the desired [action](/articles/integrate-customer/destinations#key-concepts) under **Choose your Action** and then choose the corresponding identifiers under **Map the Fields**. Based on the action you choose, the [output identifiers](/articles/segment-customer/choose-the-output-identifiers) that are accepted by the platform — such as MAIDs, Custom ID and Install ID — are displayed. Here, you can map the respective Catalogue fields to the Destination fields. Choose one of the following actions as per your requirement: * **Send Advertising IDs to Batch** — sends advertising identifiers, such as MAIDs, to the Batch platform. * **Send Install Ids to Batch** — sends Install IDs generated by Batch when a new user is created in the Batch application. * **Send Custom Ids to Batch** — sends custom identifiers of your choice to Batch. * **Send Attributes to Batch** — sends attributes such as First Name, Last Name, Email Address, Gender and Age, among others, to Batch. Ensure that you have created the attribute in Batch before using it in Zeotap CDP. > [!NOTE] > > **Before you choose Send Install Ids to Batch** > > * Ensure all Install IDs are ingested into Zeotap before using **Send Install Ids to Batch** as an action. > * Ensure that the identifiers are sent to Batch in the following format only: > > ``` > Test_-_Batch_Send_Custom_IDs_1562_install_ids for Install IDs > Test_-_Batch_Send_Custom_IDs_1563_advertising_ids for Advertiser IDs > ``` ![Zeotap mapping screen showing the Choose your Action list with Send Advertising IDs to Batch, Send Custom Ids to Batch and Send Install Ids to Batch, and MAID mapped under Map the Fields.](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/batch/batch-2024-01-22.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=91aff2d7af483b903706aa5d28899611) The Mapping step with the Choose your Action list open and a MAID Catalogue field mapped to the Batch destination field. **6. Create the destination** Once the mapping is complete, click **Create Destination**. The created Destination then gets listed in the **Audiences** application, where it can be linked to an Audience or segment. ## Link an audience to the Batch destination For information about how to link an Audience or segment to the created Destination in the **Audiences** application, see [Link an Audience to the Destination](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > It can take up to three business days for the segment to be available at the Batch seat. Link only one Destination at a time to avoid activation issues. ## Verify the audience reached Batch The first-party and third-party audiences (segments) pushed by the Zeotap CDP appear on the Batch dashboard under the **Audiences** tab. Each row lists the audience display name, its name in Batch, its type, the Tokens / IDs count and when it was last updated. ![Batch Custom audiences table listing audiences of type Advertising ID with Display name, Name, Type, Tokens / IDs and Last update columns.](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/batch/batch-2024-07-06.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=aa0052d9c6396466e7037316313fe9a2) The Custom audiences list on the Batch Audiences tab, showing each synced audience with its type and Tokens / IDs count. > [!NOTE] > > The tokens are provided by Batch or the integrated mobile application, and Zeotap does not support these tokens. Zeotap supports MAIDs for this integration, so under the **Tokens / IDs** column you can only find values for IDs. > [!NOTE] > > **More from the Batch documentation** > > * [Which targeting options can I use to segment my user base?](https://help.batch.com/en/articles/3344016-which-targeting-options-can-i-use-to-segment-my-user-base) > * [How to exclude a custom audience from my targeting](https://help.batch.com/en/articles/3011024-how-to-exclude-a-custom-audience-from-my-targeting) ## FAQ > [accordion] Should I use the Batch connector or Batch CEP? > > Both connectors appear in the Zeotap catalogue. This page covers **Batch**, the original connector, configured with a Live API Key and a REST API Key, which sends custom audiences to Batch. [Batch CEP](/articles/integrate-customer/batch-audience-management) is a newer connector that reflects recent improvements to the Batch APIs and is recommended for new audience and profile integrations; it is configured with an API Bearer Token and a Project Key, and it can also update attributes on existing Batch profiles without creating an audience. Confirm with your team which connector to use before you start. > [accordion] Which identifiers can I send to Batch? > > MAIDs, Custom IDs and Install IDs. Which of them you can map depends on the action you choose: once the action is selected, the output identifiers the platform accepts for that action are displayed on the mapping screen. See [Choose the Output Identifiers](/articles/segment-customer/choose-the-output-identifiers). > [accordion] How long does it take for an audience to appear in Batch? > > It can take up to three business days for the segment to be available at the Batch seat after you link it to the destination. Link only one Destination at a time to avoid activation issues. > [accordion] Why does the Tokens / IDs column show no token values? > > Tokens are provided by Batch or by the integrated mobile application, and Zeotap does not support these tokens. Zeotap supports MAIDs for this integration, so the **Tokens / IDs** column on the Batch dashboard shows values only for IDs. ## Next steps * [Explore the Batch CEP connector →](/articles/integrate-customer/batch-audience-management) * [Explore the real-time Batch destination used from Journeys →](/articles/integrate-customer/batch-real-time-destination-integration) * [Explore how destinations, actions and mappings work →](/articles/integrate-customer/destinations) * [Explore linking an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore delta upload and delete functions →](/articles/segment-customer/delta-upload-and-delete-functions) * [Explore creating a Batch source →](/articles/integrate-customer/create-a-batch-source) # Batch CEP Source: https://docs.zeotap.com/articles/integrate-customer/batch-audience-management Connect Zeotap CDP to Batch CEP with an API Bearer Token and Project Key. Send audience segments to Batch as a named audience, or use Mass Update Profiles to keep Batch profile attributes, topic preferences and events in sync. ## Overview This integration connects Zeotap CDP to **Batch CEP** so you can power targeted mobile and customer engagement campaigns without manual file transfers. Once the destination is created and linked to an audience, Zeotap sends the data you mapped to Batch on the refresh frequency you choose. The connector supports two outcomes, depending on the action you pick: * **Create an audience in Batch** and populate it with the identifiers and attributes you map. * **Update attributes on existing Batch profiles**, without creating an audience. > [!NOTE] > > **Batch vs. Batch CEP** > > Two Batch destinations are available in the Zeotap catalogue: > > * **Batch** — the original connector. See [Batch](/articles/integrate-customer/batch). > * **Batch CEP** — a newer connector that reflects recent improvements to the Batch APIs and is recommended for new audience and profile integrations. > > This page covers the **Batch CEP** connector. Confirm with your team which connector to use before starting. ## Available Actions Actions are chosen on the **Mapping** screen under **Choose your Action**. A destination can hold one mapping per action, so you can set up any combination. | Action | What it does | When to use | Setup | | - | - | - | - | | **Send audiences to Batch** | Creates a named audience in Batch and populates it with the mapped identifier and any audience-level attributes. | You want a targetable audience in Batch. | [Action 1](#action-1--send-audiences-to-batch) | | **Mass Update Profiles** | Updates attributes, topic preferences and events on existing Batch profiles. **Does not create an audience.** | You want to keep profile data in sync or enrich it. | [Action 2](#action-2--mass-update-profiles) | | **Update Batch profiles** | The Journeys counterpart of *Mass Update Profiles* — updates attributes, topic preferences and events on existing Batch profiles from a journey. | You want profile updates to fire in real time as users move through a journey. | Same mapping as [Action 2](#action-2--mass-update-profiles) | > [!NOTE] > > The actions write to different places: **Send audiences to Batch** writes at the **audience** level, while **Mass Update Profiles** and **Update Batch profiles** write to the **profile**. Attributes sent with the audience action never land on the profile — see the warning in [Action 1](#action-1--send-audiences-to-batch). ## Supported Identifiers **For Send audiences to Batch** — Batch CEP supports three audience types. Pick the one that matches the identifier you are sending: * **Custom Ids** — your own internal user IDs * **Emails** — email addresses * **Install Ids** — mobile app install IDs You can also send up to **15 attributes per user** alongside the identifier. **For Mass Update Profiles and Update Batch profiles** — map at least one of the following identifiers. You may map more than one: * **Custom ID** — your own internal user ID * **Installation ID** — Batch installation identifier * **Device ID** — device identifier > [!NOTE] > > There is no email identifier for **Mass Update Profiles**. Email is a profile **attribute** (**Email Address**) for that action, not something Batch matches the profile on. ## How It Works 1. You set up Batch CEP as a destination in Zeotap CDP by entering your **API Bearer Token** and **Batch Project Key**. 2. You choose an action — **Send audiences to Batch**, **Mass Update Profiles**, or **Update Batch profiles** (from Journeys) — and configure the **field mapping** for it. 3. For **Send audiences to Batch** only, you set the **Audience Type** (`Custom Ids`, `Emails`, or `Install Ids`) so it matches the identifier you are sending. 4. You **link the destination to a segment** in Zeotap and choose a refresh frequency. 5. Once linked, Zeotap sends the data on that cadence: * **Send audiences to Batch** — Zeotap creates the audience in Batch and populates it with the identifiers and attributes you mapped, splitting large audiences into batches automatically. * **Mass Update Profiles** — Zeotap updates the mapped attributes on matching Batch profiles. No audience is created. ## Prerequisites Make sure you have everything ready before starting the setup. **In Batch:** * An active Batch account with access to the Batch dashboard. * Your **REST API Key** (also called API Bearer Token). Keep this value secret and never expose it in client applications. * Your **Project Key** — found in the Batch project settings. * *(Send audiences to Batch only)* A clear understanding of which **audience type** you will use — `Custom Ids`, `Emails`, or `Install Ids` — based on the identifier you plan to send. **In Zeotap CDP:** * Access to the **Integrate** module with permission to create new destinations. * An audience segment ready to send to Batch. * The identifier you intend to send, and any attributes you want to include: * For **Send audiences to Batch** — an email, custom ID or install ID. * For **Mass Update Profiles** — at least one of Custom ID, Installation ID or Device ID that exists on your Batch profiles. > [!WARNING] > > The REST API Key authenticates every request and is visible only to account managers. Treat it like a password and never share it in client-side code, screenshots, or chat messages. ## Get Your Credentials from Batch Before connecting Zeotap to Batch, collect two values from your Batch project: the **REST API Key** and the **Project Key**. **1. Open Batch Account Settings** Log in to your **Batch** account. Click your profile avatar at the top right and select **Account settings**. ![Batch dashboard with the profile dropdown open showing Account settings highlighted.](https://mintcdn.com/zeotap/sqJCClAg56Le4n8T/images/batch-audience-management/image2.png?fit=max\&auto=format\&n=sqJCClAg56Le4n8T\&q=85\&s=f358a7345de9f44d751e22dcb92d6f30) Figure 1 — Opening Account settings from the profile menu in the Batch dashboard. **2. Copy the Project Key and REST API Key** Open your project, then go to **Settings → General**. The **App settings** card shows your **REST API Key** (click the eye icon to reveal it) and your **Project Key**. Copy both values somewhere secure — you will paste them into Zeotap shortly. ![Batch project settings page showing Project name, REST API key, Live API Key, and Project key fields with the values redacted.](https://mintcdn.com/zeotap/AhNyxmNj8en7XevZ/images/batch-audience-management/image3.png?fit=max\&auto=format\&n=AhNyxmNj8en7XevZ\&q=85\&s=94f070229b9968c8e0c711b28fca1940) Figure 2 — Batch project Settings → General, showing where the Project Key and REST API Key live (values redacted). You should now have: * **REST API Key** (used as the API Bearer Token in Zeotap) * **Project Key** ## Create the Batch CEP Destination in Zeotap CDP ### Enter your Batch credentials **1. Open the Destinations catalogue** Log in to **Zeotap CDP** and go to **Integrate → Destinations**. Click **+ Create Destination** and search for **Batch** in the catalogue. Two cards appear — **Batch** and **Batch CEP**. Select the **Batch CEP** card. ![Zeotap Integrate Destinations catalogue showing Batch and Batch CEP cards.](https://mintcdn.com/zeotap/sqJCClAg56Le4n8T/images/batch-audience-management/image1.png?fit=max\&auto=format\&n=sqJCClAg56Le4n8T\&q=85\&s=5e147acf16042a4c7d94b40e20198ad4) Figure 3 — The Destinations catalogue with both Batch and Batch CEP cards visible after a search for Batch. **2. Enter the destination details** Fill in the configuration fields: * **Destination Name** — a descriptive label (e.g., `Batch — Q2 Mobile Audience Sync`). * **API Bearer Token** — paste the REST API Key you copied from Batch. * **Project Key** — paste the Project Key you copied from Batch. Click **Next** to proceed to the **Mapping** screen, where you choose the action. > [!NOTE] > > A destination can hold one mapping per action, so you can come back later and add the second one. The save button differs by entry point: it reads **Create Destination** when you are creating the destination with its first mapping, and **Save Mapping** when you are adding a mapping to a destination that already exists. ### Action 1 — Send audiences to Batch Use this action when you want a named, targetable audience in Batch. **1. Choose the action and map the fields** On the **Mapping** screen: 1. Under **Choose your Action**, select **Send audiences to Batch**. 2. Under **Map the Fields**, map your identifier and any attributes: * The **ID** field is the identifier each user will be added to the Batch audience under (e.g., **Email Raw** → `Id`). * Optional **Attributes** are extra fields sent alongside the ID (e.g., **Last Name** → `last_name`, **Age** → `age`). ![Zeotap mapping screen showing Last Name, Age (Integer) and Email Raw mapped to last_name, age, and Id.](https://mintcdn.com/zeotap/sqJCClAg56Le4n8T/images/batch-audience-management/image4.png?fit=max\&auto=format\&n=sqJCClAg56Le4n8T\&q=85\&s=eedbe626ea7d36b04c539abc8db296bd) Figure 4 — Mapping screen with Last Name, Age, and Email Raw mapped to Batch destination fields. > [!TIP] > > You can map up to **15 attributes per user**. Attributes are useful for personalising campaigns inside Batch — for example, addressing recipients by first name. > [!WARNING] > > **Attributes sent with this action are audience-level, not profile-level.** Attributes sent through the Audience API are not appended to user profiles. They live at the audience level as *rich audience* attributes — tied to that specific audience, not merged into the profile. They do not appear as profile attributes and cannot be used as filters in Segment or Query Builder targeting. > > Rich audience attributes are meant for personalisation, not segmentation. Once the audience is added to your orchestration targeting, call the attributes in the message body with `audienceAttribute(audience_code)`. > > If you need the attributes on the profile itself, use [Mass Update Profiles](#action-2--mass-update-profiles) instead. **2. Set the Audience Type to match your identifier** Scroll to **Additional Settings** and pick the **Audience Type** that matches the identifier you mapped above: | Identifier you are sending | Audience Type to select | | - | - | | Email addresses | **Emails** | | Your own internal user IDs | **Custom Ids** | | Mobile app install IDs | **Install Ids** | ![Additional Settings section in Zeotap with the Audience Type dropdown.](https://mintcdn.com/zeotap/sqJCClAg56Le4n8T/images/batch-audience-management/image5.png?fit=max\&auto=format\&n=sqJCClAg56Le4n8T\&q=85\&s=d1b9e89e1b91687a0ad1cefd298ffb56) Figure 5 — Additional Settings panel with the Audience Type dropdown. > [!WARNING] > > The **Audience Type must match the identifier you map**. If you send emails into a `Custom Ids` audience (or vice versa), Batch rejects the records or creates an audience that cannot be activated. Always double-check this before saving. **3. Review and create the destination** Review every value you entered: * Destination name * API Bearer Token and Project Key * Action: **Send audiences to Batch** * Field mapping (ID + any attributes) * Audience Type matches the ID you are sending Click **Create Destination**. The destination now appears under **Audiences → Destinations**, ready to link. ![Mapping summary view with Send audiences to Batch action and last_name mapped under Map the Fields.](https://mintcdn.com/zeotap/sqJCClAg56Le4n8T/images/batch-audience-management/image6.png?fit=max\&auto=format\&n=sqJCClAg56Le4n8T\&q=85\&s=88320f15d4ff60d84d47937f687695bc) Figure 6 — Mapping summary showing the chosen action and mapped attributes before saving. ### Action 2 — Mass Update Profiles Use this action to update attributes on **existing** Batch profiles — to keep profile data in sync or to enrich it. Unlike *Send audiences to Batch*, this action **does not create an audience**. > [!NOTE] > > **Update Batch profiles** is the Journeys counterpart of this action. Configure the mapping exactly as described below — the procedure is identical — then use the destination from a journey instead of linking it to a segment. **1. Select the action** On the **Mapping** screen, under **Choose your Action**, select **Mass Update Profiles**. ![Zeotap mapping screen named massupdate with the Mass Update Profiles action card selected.](https://mintcdn.com/zeotap/sqJCClAg56Le4n8T/images/batch-audience-management/image10.png?fit=max\&auto=format\&n=sqJCClAg56Le4n8T\&q=85\&s=270f35ab9557cde967ec6b9d1c9662cb) Figure 7 — Choosing the Mass Update Profiles action on the Mapping screen. **2. Map at least one identifier** Under **Identifiers**, map at least one of **Custom ID**, **Installation ID** or **Device ID**. You can map more than one. > [!WARNING] > > At least one identifier is required — it is what Batch matches the profile on. A mapping with attributes but no identifier cannot be applied. **3. Map the attributes you want to update** Under **Attributes**, map the profile fields you want to keep in sync. All attributes are optional. ![Mass Update Profiles mapping showing the Identifiers section with Custom ID, Installation ID and Device ID, and the Attributes section with Customer Tier, Zeotap Date and Firstname.](https://mintcdn.com/zeotap/sqJCClAg56Le4n8T/images/batch-audience-management/image11.png?fit=max\&auto=format\&n=sqJCClAg56Le4n8T\&q=85\&s=f74c08b6f2c09ac132ec0c65266b421b) Figure 8 — Identifiers and Attributes mapped: Email Raw to Custom ID, Age to Customer Tier, Custom_dateDM to Zeotap Date, and First Name 02 to Firstname. > [!WARNING] > > **Two fields need special date formatting: Birthday and Zeotap Date.** These are the only fields with this requirement. They use an internal format (for example `date(birthday)`) and are ingested into Batch as timestamps, so supply values in ISO 8601 UTC — for example `2012-08-12T22:30:05Z`. No other field needs this formatting. The **Attributes** section lists the profile fields the connector exposes. ![Attributes list showing Customer Tier, Zeotap Date, Firstname, Lastname, Email Address, Email Marketing and Phone Number.](https://mintcdn.com/zeotap/sqJCClAg56Le4n8T/images/batch-audience-management/image12.png?fit=max\&auto=format\&n=sqJCClAg56Le4n8T\&q=85\&s=47d35ce5c50b4abe8b2f2a73ad59a590) Figure 9 — The Attributes section of the Mass Update Profiles mapping. **4. Optional: map topic preferences** Under **Topic Preference**, map a catalogue attribute to the **Add** field to subscribe profiles to a topic. The section is repeatable — click **+ Add Mapping Field** to add more rows. **5. Optional: map events and event attributes** To send events into Batch as well: * Under **Events**, map the event **Name**. * Under **Event Attributes**, map **Label** (String) and **Tags** (List). ![Mapping screen showing Topic Preference with an Add field, Events with a Name field, and Event Attributes with Label and Tags fields.](https://mintcdn.com/zeotap/sqJCClAg56Le4n8T/images/batch-audience-management/image13.png?fit=max\&auto=format\&n=sqJCClAg56Le4n8T\&q=85\&s=f5ef73b8f008a82a907acc0338c36073) Figure 10 — The Topic Preference, Events and Event Attributes sections at the bottom of the mapping. **6. Save the mapping and link the destination** Click **Save Mapping**, then link the destination to your audience using the same flow as Action 1 — see [Link a Segment to the Batch CEP Destination](#link-a-segment-to-the-batch-cep-destination) and Figures 11 and 12. Once processing finishes, the profile updates are applied in Batch. > [!TIP] > > **Want both profile updates and an audience?** Run **Mass Update Profiles** first, then **Send audiences to Batch** on the same audience. Each action lives in its own mapping on the same destination, so you can link both. ## Link a Segment to the Batch CEP Destination With the destination created, link it to an audience segment so Zeotap starts sending data. **1. Open the segment's link menu** In Zeotap CDP, navigate to **Segment → Audiences**. Find the audience you want to send, click the three-dots (⋮) icon next to it, and select **Link to Destination**. ![Audiences list with a segment row's three-dots menu open showing Link to Destination.](https://mintcdn.com/zeotap/sqJCClAg56Le4n8T/images/batch-audience-management/image7.png?fit=max\&auto=format\&n=sqJCClAg56Le4n8T\&q=85\&s=16b720ec651b87e0cc183fea668ccf51) Figure 11 — Linking an audience to a destination from the Audiences list. **2. Select the Batch CEP destination, mapping, and refresh frequency** On the linking screen: 1. Choose the **Batch CEP** destination you created from the destination list on the right. 2. Pick the **mapping** to apply to this audience. The mapping you choose determines which action runs — the one built for *Send audiences to Batch* or the one built for *Mass Update Profiles*. If you set up both, you can link both mappings. 3. Pick a **refresh frequency** that suits your use case (e.g., one-time, scheduled, or continuous). 4. Click **Save Destination**, then save the segment setup. ![Linking screen showing mapping cards on the left and Batch destination cards on the right.](https://mintcdn.com/zeotap/sqJCClAg56Le4n8T/images/batch-audience-management/image8.png?fit=max\&auto=format\&n=sqJCClAg56Le4n8T\&q=85\&s=a1e233de75f147a153f2b7c1ab2642c6) Figure 12 — Audience-to-destination linking screen with the mapping and destinations panel. For more on linking audiences in general, see [Link an Audience to the Destination](/articles/integrate-customer/link-an-audience-to-the-destination). ## Field Mapping Reference ### Send audiences to Batch | Zeotap CDP field | Maps to (Batch) | Required / Optional | Notes | | - | - | - | - | | Audience Name (set by Zeotap) | `name` | **Required** | The name Batch uses to identify the audience. Letters, numbers, underscores (`_`), and hyphens (`-`) only. Maximum 255 characters. **Case-sensitive.** | | Audience Display Name | `display_name` | Optional | Human-readable description shown in Batch. | | Audience Type | `type` | **Required** | Must be one of `custom_ids`, `emails`, or `install_ids`, and must match the identifier you map. | | Mapped ID field | audience identifier | **Required** | The user identifier each record is added under (e.g., email, custom user ID, install ID). | | Mapped attribute fields | audience-level (*rich audience*) attributes | Optional | Up to **15 attributes per user**. These are not written to user profiles — see the warning in Action 1. | ### Mass Update Profiles This reference also applies to **Update Batch profiles**, which uses the same mapping. **Identifiers** — map at least one; you may map several: | Destination field | Type | Required / Optional | Notes | | - | - | - | - | | Custom ID | String | At least one required | Your own internal user ID. | | Installation ID | String | At least one required | Batch installation identifier. | | Device ID | String | At least one required | Device identifier. | **Attributes** — all optional. The following are visible on the mapping screen: | Destination field | Type | Notes | | - | - | - | | Customer Tier | String | | | Zeotap Date | String | Needs ISO 8601 UTC formatting — see the date warning in Action 2. Can be used as a refresh timestamp. | | Firstname | String | | | Lastname | String | | | Email Address | String | Profile email. For this action email is an attribute, not an identifier. | | Email Marketing | String | | | Phone Number | String | | **Topic Preference, Events, and Event Attributes** — all optional: | Section | Destination field | Type | Notes | | - | - | - | - | | Topic Preference | Add | String | Repeatable — use **+ Add Mapping Field** to map more topics. | | Events | Name | String | The name of the event to send into Batch. | | Event Attributes | Label | String | Attribute associated with the event. | | Event Attributes | Tags | List | List of tags associated with the event. | ## Activate and Test the Integration Once the segment is linked and saved, verify the data has reached Batch. **1. Wait for the sync** Zeotap encrypts and sends the data to Batch in the background, based on the refresh frequency you chose. **2. Verify Send audiences to Batch** Log in to **Batch**, then go to **Data → Audiences**. The audience you sent from Zeotap appears in the list. Open it and check the identifier count — it should match (or closely match) the number of users in your Zeotap segment. ![Batch Audiences list showing a synced audience with Total IDs in this audience around 5K.](https://mintcdn.com/zeotap/sqJCClAg56Le4n8T/images/batch-audience-management/image9.png?fit=max\&auto=format\&n=sqJCClAg56Le4n8T\&q=85\&s=9c732796f0adac2ca2afdcfa05d5f1de) Figure 13 — Batch Data → Audiences with the synced audience and identifier count visible. **3. Verify Mass Update Profiles** No audience is created by this action, so verify at the profile level instead: in Batch, look up a user you know was in the linked segment and confirm the attributes you mapped now appear on that profile. A successful integration looks like this: for **Send audiences to Batch**, your audience appears in Batch under **Data → Audiences** with the expected identifier count and the correct audience type, ready for campaign targeting. For **Mass Update Profiles**, the mapped attributes appear on the matching Batch profiles. > [!NOTE] > > Batch processes audience data **asynchronously**. After a successful send, Batch returns an `indexing_token` and processes the records in the background — usually in real time, but no SLA is guaranteed. If counts do not appear immediately, wait a few minutes and refresh the audience view. ## Important Notes & Limitations **Send audiences to Batch** > [!WARNING] > > **Audience Type must match the identifier.** If you send emails into a `Custom Ids` audience (or vice versa), Batch rejects the records. Always confirm the audience type before saving the destination. > [!NOTE] > > **Audience names are case-sensitive and have character restrictions.** Only letters (a–z, A–Z), numbers (0–9), underscores (`_`), and hyphens (`-`) are allowed, with a maximum of 255 characters. Names with special characters, spaces, or accents will fail. > [!NOTE] > > **Batching is automatic.** Each Update request to Batch supports up to **10,000 IDs**. For audiences larger than 10,000, Zeotap automatically splits the payload into multiple sequential requests against the same audience name — you do not need to do anything. > [!NOTE] > > **Maximum 15 attributes per user.** If you map more than 15 attributes, the additional ones are not sent. > [!NOTE] > > **Attributes stay at the audience level.** They are not merged into user profiles and cannot be used as segmentation filters. If you need attributes on the profile, use **Mass Update Profiles** instead. **Mass Update Profiles** > [!NOTE] > > **No audience is created.** This action only updates existing Batch profiles. Use *Send audiences to Batch* if you need a targetable audience. > [!WARNING] > > **At least one identifier is required** — Custom ID, Installation ID or Device ID. It is what Batch matches the profile on. > [!WARNING] > > **Birthday and Zeotap Date need ISO 8601 UTC formatting** (for example `2012-08-12T22:30:05Z`). They are the only two fields with a special date-format requirement. > [!NOTE] > > **Audience Type, the 15-attribute cap and the 10,000-ID batching rule do not apply to this action.** They are limits of the Batch Audience API, which this action does not use. ## Support If you run into issues during setup or have questions about the Zeotap-to-Batch CEP integration, reach out to your Zeotap account manager or contact the Zeotap support team. ## Next steps * [Explore the original Batch connector →](/articles/integrate-customer/batch) * [Explore linking an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore how destinations work →](/articles/integrate-customer/destinations) * [Explore creating a destination →](/articles/integrate-customer/create-a-destination) # Batch Real Time Destination Integration Source: https://docs.zeotap.com/articles/integrate-customer/batch-real-time-destination-integration Send custom audiences and events from a Zeotap Journeys workflow to Batch to power push, in-app, and email automations. ## What this is Batch is a mobile marketing automation platform for push notifications, in-app messaging, and email. The Batch real-time destination in Zeotap CDP forwards custom audiences and events from a Journeys workflow into a Batch project so a marketer can trigger Batch campaigns off Zeotap-defined segments and user traits. A custom audience passed to Batch carries custom user IDs, advertising IDs (GAID or IDFA), or install IDs, together with any event attributes you map in the destination. ## Prerequisites > [!NOTE] > > Before you create the destination, confirm the following: > > * An active Batch account with access to the Batch dashboard. > * At least one mobile application integrated with Batch. Integrated apps appear on the Batch dashboard. > * The **Live API Key** and **REST API Key** from Batch (**Settings → General** on the Batch dashboard). > * A Journeys workflow in Zeotap CDP with the filters and conditions you want to activate against. ## Obtain the Batch API keys Both keys live on the Batch dashboard under **Settings → General**. Log into Batch, open **SETTINGS** from the top panel, and copy both the **Live API Key** and the **REST API Key**. You paste both values into the Zeotap destination in the next section. ![Batch dashboard with SETTINGS highlighted in the top panel](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/batch-real-time-destination-integration/batch-real-time-destination-integration-2024-07-06.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=9a879ce27cac4652911d6d1bf57945b1) ![General tab of the Batch SETTINGS page showing the Live API Key and REST API Key](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/Imported/batch-img0002.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=447a1216270d5d9b831c6200a2aa4928) ## Create the Batch destination in Zeotap Open the Journeys workflow you want to activate, add a **Send to Destinations** node, and either pick an existing Batch destination or click **+ Add New Destination**. ![Send to Destinations window in Journeys with the list of available destinations and the Add New Destination button](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/batch-real-time-destination-integration/batch-real-time-destination-integration-2024-08-07.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=f766a33de9698fedd70857f4706e14b5) 1. Click **+ Add New Destination** and search for **Batch**. 2. Click **Batch** and enter a name for the destination. 3. Paste the **Live API Key** and **REST API Key** you copied from Batch, then click **Next**. ![Batch destination creation screen in Zeotap with fields for the Live API Key and REST API Key](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/batch-real-time-destination-integration/batch-real-time-destination-integration-2024-08-07-6.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=d24a145941d55630c3101bab2d547908) 4. On the mapping screen, under **Choose your Action**, select **Batch Journeys** as the action for sending data from the Journeys workflow. 5. Under **Map the Fields**, map each Catalogue field on the left to the corresponding Destination field on the right. Event attribute names on the Batch side accept only lowercase letters, digits, and underscores — see the naming rule below. ![Actions and mapping screen with Batch Journeys selected and Catalogue fields mapped to Destination fields](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/batch-real-time-destination-integration/batch-real-time-destination-integration-2024-08-07-7.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=b26c2a890eead7d25efb4ff199d4a28b) 6. Click **Create Destination**. The destination becomes available for activation in Journeys. > [!WARNING] > > Event attribute names sent to Batch accept only the characters `a-z0-9_`. An uppercase letter, hyphen, or space in a destination-side field name blocks the mapping from saving. Valid vs. invalid event attribute names: ```text theme={null} # Valid — lowercase letters, digits, underscore only product_view add_to_cart order_id_v2 # Invalid — will fail mapping validation ProductView # uppercase letter add-to-cart # hyphen order id # space ``` ## Activate the destination in a Journeys workflow 1. In the workflow canvas, click **+** and choose **Send to Destinations**. ![Journeys workflow canvas with the Send to Destinations node being added](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/batch-real-time-destination-integration/batch-real-time-destination-integration-2024-08-07-3.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=747854bf36e7de769d121ce2a41af6f3) 2. Search the list of available destinations and select the Batch destination you created. 3. On the **Destination Details** tab, the **Live API Key** and **REST API Key** fields prefill from the destination configuration. Configure the **Destination Settings** tab — **Choose your Action and Mapping**, **Mapping**, and **Channel Consent Rule** — then click **Save Destination**. ![Destination Details tab with the prefilled Live API Key and REST API Key fields](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/batch-real-time-destination-integration/batch-real-time-destination-integration-2024-08-07-9.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=3f313401e1d63cb050deb259f0219a8c) 4. On the **Destination Settings** tab, choose the Action and mapping for this specific workflow. ![Destination Settings tab showing the Action and mapping options](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/batch-real-time-destination-integration/batch-real-time-destination-integration-2024-08-07-8.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=aa225866f4b135dc3a3498a8250dddb5) 5. Click **Save Destination**. The destination attaches to the **Send to Destinations** node. ![Batch destination attached to the Send to Destinations node in the workflow](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/batch-real-time-destination-integration/batch-real-time-destination-integration-2024-08-07-10.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=d44072f963180d0e6e7c534158a1125b) ## Verify data is reaching Batch Open the Batch dashboard and go to **Settings → Custom data**. The user traits, events, and other attributes forwarded from Zeotap appear in this list once the first records arrive. ![Custom data list in Batch settings showing attributes forwarded from Zeotap](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/batch-integration/batch-integration-2024-01-22-4.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=727d9abfc69e6ef42f8bc1c64f369886) To make those attributes usable in Batch automations and Userbase segments, toggle each attribute on and click **save** when prompted. Hovering the cursor over **Properties** on an attribute row shows the event details that arrive with it, which you can spot-check against what you mapped in Zeotap. ![Custom data attribute row in Batch with the enable toggle and Properties details](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/batch-integration/batch-integration-2024-01-22-5.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=fbdab4f1cf61981d292db8911d400363) You have confirmed the integration works when all three of the following are true: * The Batch destination in Zeotap saved without an authentication error. * The destination appears attached to the **Send to Destinations** node in the workflow. * The attributes you mapped appear under Batch's **Settings → Custom data** list. ## Create a push trigger automation in Batch Once events reach Batch, you can trigger a campaign off them: 1. In the Batch dashboard, go to **Automations** and click **New Automation**. 2. Choose **Push notification** or **In-app message**. ![New Automation screen in Batch with Push notification and In-app message options](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/batch-real-time-destination-integration/batch-real-time-destination-integration-2024-07-06-1.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=467523fe1c86fb558d14ba7595e5a012) 3. Enter a descriptive name for the automation. 4. Under **Custom Audiences**, optionally choose the audiences the automation applies to. ![Automation setup in Batch with the Custom Audiences drop-down](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/batch-real-time-destination-integration/batch-real-time-destination-integration-2024-07-06-2.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=bc73c5af187ca78ed8c1ceff0ee944af) 5. Choose the event that triggers the notification. ![Trigger event selection for a Batch automation](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/batch-integration/batch-integration-2024-01-22-8.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=4d513cff4b7f50966d8f1a9f70c6d783) 6. Enter the message body to send to the user. 7. Click **Save and run**. > [!NOTE] > > Batch's own documentation covers automation authoring in depth: > > * [How to create a push trigger automation](https://help.batch.com/en/articles/8304310-how-to-create-a-push-trigger-automation) > * [How to create your first email trigger automation](https://help.batch.com/en/articles/8281909-how-to-create-your-first-email-trigger-automation-on-the-dashboard) ## Troubleshooting | Error string / UI message | What it means | Where to look | | - | - | - | | Destination fails to save after entering API keys | The **Live API Key** or **REST API Key** does not match the values on Batch's **Settings → General** page — a key was rotated in Batch, or a value was copied incorrectly | Batch dashboard → **Settings → General**; re-copy both keys into the Zeotap destination credentials | | Mapping cannot be saved — invalid event attribute name | A destination-side field name contains an uppercase letter, hyphen, space, or other character outside `a-z0-9_` | **Actions and mapping** screen in the Zeotap destination; rename the offending destination field | | Attributes do not appear in Batch's Userbase | The attributes reached **Settings → Custom data** but the per-attribute toggle is off, so they are not exposed to Userbase segments or automations | Batch dashboard → **Settings → Custom data**; enable the toggle for each attribute and click **save** | | **New Automation** cannot find the expected event | The event has not reached Batch yet, or it has reached **Custom data** but has not been enabled | Batch dashboard → **Settings → Custom data** (confirm the event is listed and enabled), then **Automations → New Automation** | | Workflow runs but no records land in Batch | The **Send to Destinations** node was saved without attaching the Batch destination, or the destination was attached without completing **Choose your Action and Mapping** on the **Destination Settings** tab | Journeys workflow → **Send to Destinations** node → **Destination Settings** tab | If a symptom persists after the checks above — for example, the API keys are confirmed correct but the destination still fails to save, or attributes are enabled in **Custom data** but still absent from Userbase — contact your Zeotap customer success representative. Include the workflow name, the destination name, the timestamp of the failure, and a screenshot of the error message. ## FAQ > [accordion] What identifiers can I send to Batch through this destination? > > A custom audience passed to Batch carries custom user IDs, advertising IDs (GAID or IDFA), or install IDs. Map the appropriate identifier field in the destination's **Map the Fields** screen. > [accordion] Do event attribute names have to be lowercase? > > Yes. Batch accepts only the characters `a-z0-9_` for event attribute names. Uppercase letters, hyphens, and spaces block the mapping from saving. > [accordion] Where do I paste the Live API Key and REST API Key? > > Into the destination creation screen in Zeotap after selecting **Batch** as the destination type. Both keys come from Batch's **Settings → General** page. They also prefill on the **Destination Details** tab of the **Send to Destinations** node once the destination is created. > [accordion] Why don't my attributes show up in Batch's Userbase? > > Attributes forwarded from Zeotap appear first under Batch's **Settings → Custom data**. They are not exposed to Userbase segments or automations until you toggle each attribute on from that screen and click **save**. ## Next steps * [Explore the full source and destination catalogue →](/articles/integrate-customer/creating-a-source) * [Explore the Adobe Campaign real-time integration →](/articles/integrate-customer/adobe-campaign-real-time-integration) * [Explore the Airship real-time integration →](/articles/integrate-customer/airship-real-time-destination-integration) * [Explore the Cleverpush real-time integration →](/articles/integrate-customer/cleverpush-real-time-integration) # Batch Source Source: https://docs.zeotap.com/articles/integrate-customer/batch-source The Batch source brings data from your Batch mobile engagement account into Zeotap CDP on a daily, weekly, or monthly schedule. ## What this is Batch is a mobile marketing automation platform that helps businesses engage with their users through personalised messaging across channels such as push notifications, email, SMS and in-app messages. The Batch source is the built-in connector that brings the data Batch holds about your users back into Zeotap CDP as **Customer Data (CE)**, carrying Install IDs, Advertising IDs and Custom IDs, so it can contribute to unified customer profiles alongside your other sources. It sits under the **Customer Engagement Channels** category in Sources, and it is a scheduled integration rather than a live stream. The connector authenticates with the **Live API Key** and **REST API Key** you copy from the Batch console, and data arrives as a JSON or CSV file on the sync frequency you choose when you create the source — **Daily**, **Weekly** or **Monthly**. The first sync runs as soon as the source is created; every sync after that follows the schedule. ## Prerequisites > [!NOTE] > > Before you create a Batch source, confirm: > > * You have a Batch account, and your mobile applications are already integrated with Batch — they appear on the Batch dashboard once they are. > * You can reach the **General** tab of the Batch console **SETTINGS** page, where the **Live API Key** and **REST API Key** the connector needs are shown. > * You have permission to create sources in your Zeotap CDP tenant. ## When to use a Batch source Create a Batch source when: * Your mobile messaging runs through Batch, and you want that data available in Zeotap CDP for unification, audience building and activation. * A daily, weekly or monthly refresh is timely enough for the use case. This is a file-based, scheduled integration, so it is not the way to react to a user action within moments of it happening — the freshest data available through this source is the last completed sync. * You are connecting one Batch account. As with every Zeotap source, create one source per origin rather than reusing an existing source for a second account. > [!NOTE] > > **Batch as a source, or Batch as a destination?** They are two separate integrations that point in opposite directions. This source brings Batch data *into* Zeotap CDP. To send a Zeotap audience *out* to Batch, use one of the Batch destinations — [Batch](/articles/integrate-customer/batch) or [Batch CEP](/articles/integrate-customer/batch-audience-management), which is recommended for new integrations. ## Next steps * [Explore how to create a Batch source →](/articles/integrate-customer/create-a-batch-source) * [Explore the Customer Engagement Channels category →](/articles/integrate-customer/customer-engagement-channels) * [Explore every supported source integration →](/articles/integrate-customer/creating-a-source) * [Explore Sources →](/articles/integrate-customer/sources) # Best Practices for BigQuery Source: https://docs.zeotap.com/articles/integrate-customer/best-practices-for-bigquery How to prepare a BigQuery table before Zeotap CDP ingests it as a source — carrying a user identifier, carrying country data, and matching the region to the data. BigQuery is a **source**: the practices below apply to data you bring **into** Zeotap CDP from a BigQuery table. To send data the other way — out of Zeotap CDP and into BigQuery — see the [Google BigQuery destination](/articles/integrate-customer/google-bigquery-destination) instead. A BigQuery source reads one table, identified by project, dataset and table name, on the sync frequency you set when you create it. Tables with JSON column types are not supported. Prepare the table against the three points below before you create the source; [Create and Implement a BigQuery Source](/articles/integrate-customer/create-a-bigquery-source) covers the setup itself. ## At Least One User ID per Source The table must have the details of at least one ID, such as email, cellphone, cookies or ADID. An ID is a mandatory requirement for a source, because it is what Zeotap CDP matches incoming records on. ## Country Column in Data Ensure that the Country column is present in the BigQuery table being ingested, and that it is filled with valid values. Records must be tied to a country before a data collection can be created; where the table carries no country of its own, the country can be hard coded instead. We recommend that you use ISO alpha-3 country codes. ## Data Privacy and Compliance Ensure that the region selection is in line with the data being ingested — the region you choose when creating the source must match the country of the records in the table, so that data belonging to one region is not ingested into another region's bucket. This is to ensure data privacy and compliance. For how a country resolves to a storage region, see [Region of Storage](/articles/integrate-customer/region-of-storage). ## Next steps * [Create and Implement a BigQuery Source →](/articles/integrate-customer/create-a-bigquery-source) * [Explore the BigQuery source →](/articles/integrate-customer/bigquery) * [Explore Data Warehouse sources →](/articles/integrate-customer/data-warehouse) # Best Practices for Braze Currents Source: https://docs.zeotap.com/articles/integrate-customer/best-practices-for-braze-currents Configuration and data-quality practices that keep a Braze Currents source ingesting cleanly into Zeotap. ## What this is A Braze Currents source streams event and profile data from Braze into Zeotap through batched JSON payloads. This page collects the configuration and data-quality practices that keep that stream matching to profiles, respecting regional data-privacy boundaries, and mapping cleanly into your Zeotap catalogue. Apply these practices when you create the source and each time you extend the schema. > [!NOTE] > > **Prerequisites** > > * A Braze Currents source already exists in Zeotap, or you are creating one. See [Create a Braze Currents Source](/articles/integrate-customer/create-a-braze-currents-source). > * You have access to the source's field-mapping configuration in the Zeotap CDP app. > * You know which region the records in each Braze Currents table belong to. ## Why these practices matter A Braze Currents table that arrives without an identifier, without a country value, or in the wrong regional workspace cannot be turned into a data collection and cannot participate in user matching. The table below lists the observable conditions that block ingestion or matching for a Braze Currents source, what each condition means, and where the setting lives. | Condition | What it means | Where to look | | - | - | - | | No identifier column present (email, cellphone, cookies, ADID, or equivalent) | The source cannot perform user matching | Field mapping for the source | | Country column empty and no hardcoded country set | A data collection cannot be created for those records | Field mapping, country field | | Records loaded into a region that does not match the country of the data | Data-privacy and compliance violation | Region selection at source creation | ## Include at least one user identifier per source Zeotap syncs Braze Currents tables into a Collect Braze Currents source. Each table you sync must carry the details of at least one identifier — email, cellphone, cookies, ADID, or another supported ID. Without a matchable identifier, records ingest but do not resolve to a profile. ## Align each table with the correct region Ensure the data ingested belongs to the correct region for the records in that table. Loading data into a region that does not match the country of the records breaks data-privacy and compliance requirements. Confirm the source's region setting matches the country of the records before you enable ingestion. ## Populate the country field on every record Records must be tied to a country for Zeotap to create a data collection from them. The supported standard objects contain country columns — fill those columns with valid values. If the source does not carry a per-record country, hardcode the country at the source level. Use alpha ISO-3 country codes when you send country information. A well-formed record carries an identifier plus a country value: ```json theme={null} { "email": "customer@example.com", "country": "USA" } ``` ## Map fields deliberately There is no limit on the number of columns you can ingest from Braze Currents into Zeotap. You can map each incoming column to a field in Zeotap's standard catalogue or add a custom field for it. Before you save the mapping, confirm that: * Every field is mapped to the correct Zeotap catalogue field. * Enrichers are applied wherever required and match the incoming value. > [!WARNING] > > Confirm each field mapping before you save. Every field must be mapped to the correct Zeotap catalogue field, and enrichers must be aligned with the incoming value. ## Verify the source is ingesting cleanly You know the practices above are in effect when: * Records from the Braze Currents source appear in the source's ingestion view without country-related or identifier-related rejections. * The field mapping shows each incoming column bound to a Zeotap catalogue field, with enrichers set where required. * The region selected at source creation matches the country of the records in the payload. ## Troubleshooting * **Records ingest but no profiles match.** Check that at least one identifier column — email, cellphone, cookies, ADID, or another supported ID — is populated on the incoming payload and mapped to the corresponding Zeotap identifier field. * **A data collection is not created for a batch of records.** Check that the country field is populated on the records, or that a country is hardcoded at the source level. Confirm the value is a valid alpha ISO-3 code. * **A field is ingesting under the wrong attribute.** Reopen the field mapping and confirm each incoming column points to the intended Zeotap catalogue field before you re-save. ## Next steps * [Explore the Braze Currents source overview →](/articles/integrate-customer/braze-currents) * [Explore how to create a Braze Currents source →](/articles/integrate-customer/create-a-braze-currents-source) * [Explore best practices for Flat File sources →](/articles/integrate-customer/best-practices-for-flat-file-source-2709422090) * [Explore best practices for Snowflake sources →](/articles/integrate-customer/best-practices-for-snowflake-source) # Best Practices for Flat File Source Source: https://docs.zeotap.com/articles/integrate-customer/best-practices-for-flat-file-source-2709422090 Prepare, upload and validate the files you send into a Zeotap CDP Flat File source so ingestion, Catalogue mapping and downstream segmentation work first time. ## What this is A Flat File source brings data **into** Zeotap CDP: you upload `CSV` or `JSON` files to the storage location provisioned for the source, and Zeotap ingests the records so you can map their fields to your Catalogue. This page collects the practices that keep that ingestion clean — how to shape the files, how to keep successive uploads consistent with the source definition, and what to validate before the source goes live. For the opposite direction — sending an audience **out** of Zeotap CDP to an external platform — see [Destinations](/articles/integrate-customer/destinations). These recommendations apply to every Flat File source. For a Zeotap Google Cloud Storage source the upload methods are the Zeotap CDP interface, the Google Cloud Console, gsutil, or a third-party client such as Cyberduck. ## Prerequisites > [!NOTE] > > Before these practices apply, you need: > > * A Flat File source created in Zeotap CDP, with its file format, delimiter and region already chosen — see [Create a Zeotap Google Cloud Storage Source](/articles/integrate-customer/create-a-zeotap-google-cloud-storage-source). > * Access to the upload path for that source, listed under **Path Details** on the source's **Implementation Details** tab. > * A sample data file containing real data, which you will use for the validation checks below. ## Prepare the data in your files ### Include at least one user ID per source Each file must carry at least one user ID. This can be your own first-party user ID — it must be the same ID you send in the Web JS or app SDKs — and preferably a digital identifier such as a MAID alongside it, so the records can be used for user matching. ### Include country data in every record Records must be tied to a country before data collections can be created, so always attach the country as a field in your files. If you do not, the country has to be hardcoded later. Use alpha ISO 3 country codes when sending country information. See [Configure the Country Enricher](/articles/unify-customer/configuring-the-country-enricher) for how the value is interpreted during mapping. ### Map countries to the correct region Upload each file to the region that matches the country of its records — Spanish data must not be uploaded to the US bucket, for example. If your data covers users in several countries, split the files by country first, then upload each file to the appropriate region bucket. This keeps the data privacy and compliance boundaries intact. The full country-to-region mapping is listed in [Region of Storage](/articles/integrate-customer/region-of-storage), and the regions available for upload are listed under Upload Specifications on [Create a Zeotap Google Cloud Storage Source](/articles/integrate-customer/create-a-zeotap-google-cloud-storage-source). ### Start with the fields that matter There is no restriction on the schema, but we recommend checking the [Zeotap Catalogue](/articles/unify-customer/zeotap-standard-fields) first and start with only the fields that are relevant to the source. Create new sources for newer data points you want to capture. If you start sending new fields for an existing source, map those new fields before the data can be ingested. ## Keep every upload consistent ### Use the same file format and delimiter for every file When you upload several files under one source, all of them must use the file format and delimiter defined when the source was created. If the source was created as a CSV file with the semicolon (`;`) delimiter, every subsequent upload to that source must use the same format. Failure to do this results in data corruption. CSV files must not contain double quotation marks (`"`), and their fields must be separated by a comma (`,`) only. Download the [sample file](/articles/integrate-customer/Storage/integrate-customer/Bank-flatfile.csv) for a worked example. ### Keep column-name casing identical When you upload several files under one source, always name the same attribute the same way, with the same casing. Consistent casing is what allows the column to map correctly at the collection level; a change in casing is treated as a new column. ### Upload to the exact path If you are not uploading from the Zeotap CDP interface but through another method — the Google Cloud Console, gsutil, or Cyberduck — the files must land on exactly the path listed under **Path Details** for the source. Files uploaded elsewhere can affect the processing of that data, and in turn the reporting and segment creation built on it. ## Validate before you go live Run the three checks below — on the file, against the Catalogue, and on the mapping — using a sample file before you rme. ### Validate the file Take a sample data file with actual data and check that: * The encoding type is one of the [supported file formats](/articles/integrate-customer/supported-file-formats). * The file format matches the option selected on the source. * The delimiter matches the option selected on the source. * No fields are repeated. * Every column has a header. After ingestion, confirm this on the [Preview Data tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) — a column shown as `_CX` had no header in the file. ### Validate against the Catalogue After the source is created, push a sample data file with actual data. The values passed for each field must be in line with the Catalogue definition. Check that: * The [data type](/articles/unify-customer/data-types-in-catalogue) of each value matches the Catalogue field. * The attribute type matches the Catalogue field. * Each date field's timestamp format is one of the acceptable formats. * The country value is ISO 2, ISO 3, or hardcoded — see [Configure the Country Enricher](/articles/unify-customer/configuring-the-country-enricher). * Field-name casing is consistent across the source Catalogues. ### Validate the mapping Before you save the mapping, check that: * Each field is mapped to the correct Zeotap field — see [Map the Catalogue for Customer Data](/articles/unify-customer/map-the-catalogue-for-customer-data). * [Enrichers](/articles/unify-customer/enrichers) are applied wherever required, and match the incoming value. * The timestamp format is selected from the list of supported formats. Once selected, the system continues to expect that same format for the rest of the source's lifetime — see [Configure the Timestamp Enricher](/articles/unify-customer/configuring-the-timestamp-enricher). ## Troubleshooting | Symptom | What it means | What to do | | - | - | - | | Data ingested from a later file is corrupted, while earlier files were fine | A file was uploaded with a different file format or delimiter from the one defined on the source | Re-export the file using the format and delimiter the source was created with, and re-upload it | | A column appears as `_CX` on the Preview Data tab | That column arrived without a header row entry | Add the missing header to the file and re-upload | | Ingestion starts failing on date fields that previously worked | The timestamp format in the file changed after a format was selected during mapping | Send the timestamp in the format selected for the source, or review the format in the [Timestamp Enricher](/articles/unify-customer/configuring-the-timestamp-enricher) | | The same attribute appears twice in the collection under two names | The column name's casing changed between uploads, so it was treated as a new column | Re-export with the original casing and keep it identical across every upload | ## Next steps * Explore [supported file formats →](/articles/integrate-customer/supported-file-formats) for the encoding types Zeotap accepts. * Explore [Flat Files (CE+NCE) →](/articles/integrate-customer/flat-files) for the transfer methods available for batch data. * Explore [uploading files on your Zeotap Google Cloud Storage source →](/articles/integrate-customer/implement-a-zeotap-google-cloud-storage-source) for the **Access Details** and **Path Details** your uploads use. * Explore [uploading through the Google Cloud Console →](/articles/integrate-customer/upload-files-on-gcloud-console), [with gsutil →](/articles/integrate-customer/upload-files-using-gsutil) or [with Cyberduck →](/articles/integrate-customer/upload-files-using-cyberduck) for the upload method that suits your workflow. * Explore [Sources →](/articles/integrate-customer/sources) for how sources fit into the wider ingestion flow. # Best practices for the Salesforce CRM source Source: https://docs.zeotap.com/articles/integrate-customer/best-practices-for-salesforce-crm-source Recommended practices for ingesting Salesforce CRM data into Zeotap CDP: user IDs, region of upload, country values, field selection and catalogue mapping. The Salesforce CRM source moves data **into** Zeotap CDP — the Sources module imports records from the standard objects and custom objects in your Salesforce account. Nothing is written back to Salesforce on this path; to send Zeotap audiences **out to** Salesforce, use [Salesforce CRM (Sales and Service Cloud)](/articles/integrate-customer/salesforce-crm-sales-and-service-cloud) for batch audiences or [Salesforce CRM Real Time Integration](/articles/integrate-customer/salesforce-crm-real-time-integration) for real-time records. ## What this is The practices we recommend when you set up a Salesforce CRM source and map it to the catalogue. They sit alongside the step-by-step instructions in [Create a Salesforce CRM Source](/articles/integrate-customer/creating-salesforce-crm) rather than replacing them. ## Ingest at least one user ID per source Zeotap supports data sync from all standard objects and custom objects associated with your Salesforce account. Some standard objects — Account, Contact, Lead, Case and Opportunity — contain columns that hold first-party user IDs. Select at least one of those ID columns when you choose the fields for the source. At least one ID must be mapped for every source, and it is what allows the source to perform user matching. ## Match the region of upload to the country of the records When you create the source — click **+ Create Source**, then select **CRM Data > Salesforce CRM** — you choose the region of upload under **Select your Region**. Ensure that the data you ingest belongs to the correct region as per the country of the records — that is, records carrying a country value of IND must not be uploaded to the EU region. This is to ensure data privacy and compliance. The country-to-region mapping Zeotap uses is published in [Region of Storage](/articles/integrate-customer/region-of-storage). ## Give every record a country value Providing a country is mandatory for every source. The supported standard objects contain country columns, so fill those columns with valid values. If the incoming data has no usable country column, the country has to be hardcoded when you map the catalogue — see the [Country Enricher](/articles/unify-customer/enrichers-for-data-transformation-2816770049#country-enricher) and the [Hardcode Enricher](/articles/unify-customer/enrichers-for-data-transformation-2816770049#hardcode-enricher). We recommend alpha ISO 3 country codes for sending country information — for example, `ESP` for Spain and `GBR` for the United Kingdom. ## Choose your fields before you create the source Salesforce standard objects come with a predefined set of columns. Zeotap CDP places no limit on the number of columns you ingest: map them to Zeotap's standard catalogue or add custom fields. Choose carefully, because the selection is fixed once the source exists: * Editing the field selection after source creation is not supported — changing it means creating a new source. * Some compound fields (nested objects) are not supported and choosing them can cause ingestion failure. [Create a Salesforce CRM Source](/articles/integrate-customer/creating-salesforce-crm) lists the fields concerned. After the source is created, open its **IMPLEMENTATION DETAILS** tab to confirm which fields were selected for the object. ## Check the catalogue mapping before you save it Before saving the mapping, confirm both of the following: * Each field is mapped to the correct Zeotap field. * Enrichers are applied wherever required, and match the incoming value. For the full mapping procedure, see [Map the Catalogue for Customer Data](/articles/unify-customer/map-the-catalogue-for-customer-data). ## Next steps * [Salesforce CRM](/articles/integrate-customer/salesforce-crm) — what the source supports and how often it syncs. * [Create a Salesforce CRM Source](/articles/integrate-customer/creating-salesforce-crm) — the full setup procedure, including Salesforce-side configuration. * [Map the Catalogue for Customer Data](/articles/unify-customer/map-the-catalogue-for-customer-data) — mapping the source once it reaches the Integrated state. # Best Practices for Snowflake Source Source: https://docs.zeotap.com/articles/integrate-customer/best-practices-for-snowflake-source Guidelines for structuring your Snowflake tables, country data, and catalogue mapping so a Snowflake source ingests cleanly into Zeotap CDP. If you are setting up a new Snowflake source from scratch and need the credential and connection steps (username, password, warehouse, database, schema, table), see [Create a Snowflake Source and Load Data](/articles/integrate-customer/create-a-snowflake-source). This page covers the data-shape and mapping guidelines that make that ingestion succeed once the source is created. ## What this is A Snowflake source in Zeotap CDP syncs one or more Snowflake tables into the CDP so their records can be unified into customer profiles. The quality of that unification depends on how your Snowflake tables are shaped before ingestion — whether every record carries an identifier Zeotap can match on, whether the country field lines up with the region you loaded the data into, and whether your catalogue mapping resolves each column to the right Zeotap field. This page gathers the practices that keep those three things aligned so the first sync ingests cleanly and every subsequent sync stays consistent with what you already have. ## Prerequisites > [!NOTE] > > Before you apply the practices below, confirm that: > > * You have a Snowflake account with the table(s) you want to ingest, and the connection details required to reach them (username, password, account name, warehouse, database, schema, table). See [Create a Snowflake Source and Load Data](/articles/integrate-customer/create-a-snowflake-source) for how to obtain each of these from Snowflake. > * You have access to the Zeotap CDP catalogue for the entity you are mapping to — Customer Data or Non-Customer Entity Data. > * You know which Zeotap region your data belongs to, based on the country of the records inside the table. ## Include at least one user identifier per table Each Snowflake table synced into a Zeotap CDP source must carry at least one identifier column that Zeotap can use for user matching — for example an email address, cellphone number, cookie ID, or ADID. Tables without any identifier cannot participate in user unification, so this is a hard requirement for every source, not a preference. ## Align the data region with the country of your records Load each table into the Zeotap region that matches the country of the records inside it. This alignment is required for data privacy and compliance — do not ingest records for one region into a source configured for another. If a single Snowflake table contains records from more than one region, split it upstream in Snowflake and create a separate source per region. ## Include country in every record Records must be tied to a country for Zeotap CDP to create data collections from them. The supported standard objects contain country columns — populate that column with a valid value for every record. If the country is not present in the source data, the country has to be hard-coded at the source instead. We recommend using **alpha ISO 3** country codes (for example `USA`, `DEU`, `JPN`) when sending country information. A consistent ISO 3 value keeps the country enricher predictable and avoids the mixed-format ambiguity that comes from combining names, ISO 2, and ISO 3 codes across syncs. ## Map columns to the Zeotap catalogue deliberately There is no limit on the number of columns you can ingest through a Snowflake source. You can map each column to a field in Zeotap CDP's standard catalogue, or add a custom field for a column that does not have a standard equivalent. Before saving the mapping, confirm both of the following on every column you have chosen to map: * The field is mapped to the correct Zeotap field. * Enrichers are applied wherever required, and each enricher matches the shape of the incoming value (for example, an ISO 3 country enricher for an ISO 3 country column). ## Enable change tracking before you rely on delta sync If you plan to configure the source with **Delta Queries Selection** set to `true` so Zeotap fetches only incremental updates on each sync, the Snowflake table must have change tracking enabled on Snowflake's side first. Run the following in a Snowflake SQL worksheet against the target table, replacing `${TABLE_NAME}` with the actual table name: ```sql theme={null} ALTER TABLE ${TABLE_NAME} SET CHANGE_TRACKING = TRUE; ``` Without change tracking enabled on the table, delta selection will not return the incremental updates you expect. Enable it before the source is created if you want deltas from the first sync onward. > [!NOTE] > > The sandbox environment does not support deltas — deltas are available in production only. Sandbox also supports only a daily refresh; it does not support intraday refresh (hourly, thirty-minute, or fifteen-minute frequencies). ## Why mappings and ingestion fail Common causes of Snowflake source problems: the table is missing an identifier column, the country data is missing or in the wrong format, the mapping resolves a column to the wrong Zeotap field, or Snowflake rejects the sync because the configured user lacks table privileges. The table below lists the customer-visible strings tied to these situations and where to check first. | Error string | What it means | Where to look | | - | - | - | | `No data has been received. Ensure to implement the source correctly and check again later` | The source was created but Zeotap has not received rows from the configured Snowflake table. | The **Preview Data** tab of the source in Zeotap CDP. | | `privileges error` (raised by Snowflake during Load Data) | The Snowflake user configured on the source does not have the privileges needed to read from the table. | The Snowflake **Load Data** window, and your Snowflake account administrator — see [Snowflake table privileges](https://docs.snowflake.com/en/user-guide/security-access-control-privileges#label-table-privileges). | ## Verify your source is healthy After you create the source and load data into the Snowflake table, confirm the source is working end-to-end: 1. Open the source in Zeotap CDP and check the **Preview Data** tab. Rows from your Snowflake table should appear. If the empty-state message from the error table above is shown instead, the source has not yet received data. 2. Check the source's status. When the first successful data load completes, the status transitions from `CREATED` to `INTEGRATED`. 3. Review the source's **Implementation Details** tab to confirm the warehouse, database, schema, table, sync frequency, and delta selection you configured match what you intended. If the status stays on `CREATED` past the first expected sync window, or the **Preview Data** tab remains empty, return to the error strings above and to the [Snowflake source error handling guide](/articles/integrate-customer/snowflake-source-error-handling-and-more) for next-step diagnostics. Contact support only after those checks do not resolve the symptom. ## Next steps * [Explore how to create a Snowflake source and load data →](/articles/integrate-customer/create-a-snowflake-source) * [Explore Snowflake source error handling →](/articles/integrate-customer/snowflake-source-error-handling-and-more) * [Explore FAQs for Snowflake →](/articles/integrate-customer/faqs-for-snowflake) * [Explore catalogue mapping for Customer Data →](/articles/unify-customer/map-the-catalogue-for-customer-data) * [Explore best practices for BigQuery →](/articles/integrate-customer/best-practices-for-bigquery) # Best Practices for Web JS SDK Source: https://docs.zeotap.com/articles/integrate-customer/best-practices-for-web-js-sdk ## Appropriate Consent Configurations ### TCF Consent If your website has a TCF API on the page, then the consent resolution mechanism must be TCF and not the default Optin. This helps the Zeotap SDK to also capture the `gdpr_consent` string. In some cases, you may set up a default consent resolution mechanism and invoke the Zeotap JavaScript only if the user performs any action on the CMP. However, note that we do not recommend this step. Even when you invoke the SDK with the TCF Consent Configurations, the JS communicates with the TCF API on the page and only then the JS collects/captures the events. Otherwise, the JS just sits idle. We recommend the following SDK configurations for the above scenario: ```javascript Code theme={null} { useConsent: true, checkForCMP: true } ``` ### Custom Consent If you are setting up a Custom Consent collection on your website, ensure that you also choose the same in the SDK configurations. This is required in order to collect granular consent from the website. The SDK primarily performs the following three main tasks: * Capture user events * Identify user * CookieSync With the custom consent resolution mechanism, you can provide granular consent instead of a blanket boolean (`yes/no`) for all SDK purposes. We recommend the following SDK configurations for the above scenario: ```javascript Code theme={null} { useConsent: true, checkForCMP: false } ``` After you have set up the SDK configurations, you can invoke the `setConsent` method as mentioned below. ```javascript theme={null} window.zeotap.setConsent({ track: true, cookieSync: true }) ``` ### Capturing User Identities With Collect SDK, you can collect User Identities (PIIs like email and cellphone number along with Custom Identities). The identities collected are then persisted across all the upcoming event-capturing calls. To persist user identities across the event payloads, invoke the `setUserIdentities` method and not the `setUserProperties` method. In order to persist user identities, you can use the `setUserIdentities` method as follows: #### Case 1: Incoming identities are raw and can be sent to Zeotap CDP as is SDK Configurations: ```javascript Code theme={null} { areIdentitiesHashed: false, hashIdentities: false } setUserIdentities method: window.zeotap.setUserIdentities({ email: 'xyz@gmail.com', // User PII crmID: '12345' // Custom Identity }) ``` #### Case 2: Incoming identities are raw and need be sent to Zeotap CDP after hashing SDK Configurations: ```javascript Code theme={null} { areIdentitiesHashed: false, hashIdentities: true } setUserIdentities method: window.zeotap.setUserIdentities({ email: 'xyz@gmail.com', // User PII, will be hashed crmID: '12345' // Custom Identity, consumed as is }) ``` #### Case 3: Incoming identities are hashed SDK Configurations: ```javascript Code theme={null} { areIdentitiesHashed: true } setUserIdentities method: window.zeotap.setUserIdentities({ email_sha256_lowercase: '32e19a491662fd86de7d3806b1199b76f0ee44e928d3475f05b0c8a59912c097', crmID: '12345' // Custom Identity, consumed as is }) ``` ## Google Analytics Settings With the Collect SDK, you can provision optional capturing of the GA client Id and user Id cookies for retargeting purposes on platforms like Optimize 360. To allow the SDK to capture the GA cookies, add the following configurations to the `window.zeotap.init(WRITE_KEY, { .... })` call: ```javascript Code theme={null} { //If set to false , Google Analytics ClientId will not be forwarded in POST calls allowGAClientId: true, // cookie prefix for Google Analytics Client ID, if set with , GA Client Id cookie fetch with name as '_ga' gaClientIdCookiePrefix: 'client', // cookie name for Google Analytics User ID, if set with , GA User Id cookie fetch with name as 'value' gaUserIdCookieName: 'user_ga' } ``` # BigQuery source overview Source: https://docs.zeotap.com/articles/integrate-customer/bigquery How the BigQuery source reads data from your Google BigQuery tables into Zeotap CDP, what to collect before you create it, and where the full setup steps live. ## What this is The BigQuery source brings data **into** Zeotap CDP. It connects directly to the source data residing in [BigQuery](https://cloud.google.com/bigquery/) through the Sources application and pulls records from a table on the sync frequency you choose. To send data the other way — from Zeotap CDP out to a BigQuery table — see the [Google BigQuery destination](/articles/integrate-customer/google-bigquery-destination) instead. Syncing data from Google BigQuery into Zeotap CDP strengthens your data analytics capacities. It also lets you analyse diverse datasets, create precise customer segments, curate personalised content and refine advertising strategies. This page is the entry point for the BigQuery source: what to gather before you start, and where the field-by-field setup lives. ## Prerequisites > [!NOTE] > > Before you create a BigQuery source, you need an account with BigQuery holding the data you want to import into Zeotap CDP. For that account, have the following ready: > > * **Source Name** — the name the source is listed under in Zeotap CDP once it is created. > * **Region** — where the ingested data is stored. > * **Sync frequency** — how often data is ingested from the source. A daily, weekly or monthly cadence also takes a sync time; a weekly cadence takes the day of the week; a monthly cadence takes the day of the montime, and the day of the week or day of the month. > * **Project ID** — the unique string that identifies your project on Google Cloud. > * **Dataset** — the top-level container that organises and controls access to your tables and views. > * **Table** — the table to ingest. Tables with JSON column types are not supported. > * **Service Account Owner** — choose either **Customer** or **Zeotap**. If you choose **Customer**, you also upload the service-account key JSON you created in Google Cloud. > * **Data Entity** — whether the records are **Customer Data** or **Non Customer Data**. > > Each field, the exact values supported, and the Google Cloud steps behind them are documented in [Create and Implement a BigQuery Source](/articles/integrate-customer/create-a-bigquery-source). ## Next steps * [Explore the full BigQuery source setup, including both Service Account Owner scenarios →](/articles/integrate-customer/create-a-bigquery-source) * [Explore the best practices to follow for a BigQuery source →](/articles/integrate-customer/best-practices-for-bigquery) * [Explore the Google BigQuery destination for sending audiences into BigQuery →](/articles/integrate-customer/google-bigquery-destination) * [Explore the other Data Warehouse integrations Zeotap offers →](/articles/integrate-customer/data-warehouse) # Bird - Customer Lists Source: https://docs.zeotap.com/articles/integrate-customer/bird-customer-lists Push audiences built in Zeotap CDP to customer lists in your Bird workspace: create the Bird access key, find your workspace ID, then configure and map the Bird - Customer Lists destination. ## What this is **Bird - Customer Lists** sends data out of Zeotap CDP: it pushes the audiences you build in Zeotap to the matching customer lists in your Bird workspace, where those lists can be used in any campaign created in Bird. Bird (formerly MessageBird) is a cloud communications platform that lets businesses reach customers across channels such as SMS, Voice, WhatsApp and Email through a single API. Bird appears twice in the Zeotap destinations catalogue, and the two entries are not interchangeable: * **Bird - Customer Lists** — this page. A batch destination, linked to an audience in the **Audiences** application. * **[Bird Trigger Events](/articles/integrate-customer/bird-trigger-events)** — a real-time destination that sends event data to Bird and is linked from a **Send to Destinations** node in a Journey. ## Supported identifiers and attributes This destination supports **raw email address**, **Phone**, and any other **custom attributes** you want to send to Bird. > [!NOTE] > > Event attributes cannot be sent through this destination. [Bird Trigger Events](/articles/integrate-customer/bird-trigger-events) is the Bird destination for event data. ## Prerequisites Have both of these to hand before you create the destination in Zeotap: * An **Access token** — the access key you generate in Bird. See [Set up access in Bird](#set-up-access-in-bird). * Your Bird **Workspace ID**. See [Find your workspace ID](#find-your-workspace-id). ## Set up access in Bird In Bird, HTTP requests are authorised with access keys. An access key takes its scope from an access role, and the role carries an access policy, so create the three objects in that order: policy, then role, then key. All three sit under **Settings → Security** in the Bird **Admin console**. ![The Bird Settings navigation with Security expanded to show Access Settings, Access Keys, Access Roles and Access Policies, and Workspaces listed higher up as a separate Settings item.](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/bird-customer-lists/bird-customer-lists-2025-06-27-5.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=1caded8256abe9703221212d8aa5c5fe) ### Create the access policy Bird documents this flow in [Creating an access policy](https://docs.bird.com/api/api-access/access-policies#creating-an-access-policy). **Step 1** Log in to Bird. In the bottom left-hand corner, click your name, then click **Admin console**. ![The Bird Settings Access Policies page, with the account menu open in the bottom left-hand corner and Admin console outlined.](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/bird-customer-lists/bird-customer-lists-2025-06-27.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=37fb7ab7824465591ca2e4ffecc6ae42) **Step 2** Go to **Settings → Security → Access Policies** and click **Create custom policy**. **Step 3** Under **General**, set the **name** to `zeotapintegration`. **Step 4** Under **Definition**, set: * **Effect** — **Allow** * **Action** — **any** * **Resource** — `/workspaces/*/lists` Then click **Add resource** and enter a second resource, `/workspaces/*/contacts/identifiers/**`, before clicking **Save**. ![The Create Custom Policy dialogue in Bird, showing the Definition section with Effect set to Allow, Action set to any, an empty Resource field, and the Add resource button below it.](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/bird-customer-lists/bird-customer-lists-2025-06-27-4.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=527321c60f26384c8d49325ef3da0b17) ### Create the access role Bird documents this flow in [Access roles](https://docs.bird.com/api/api-access/access-roles). **Step 1** In the Bird **Admin console**, go to **Settings → Security → Access Roles**. **Step 2** Click **Create Role**. **Step 3** Provide a **Name** for the role. In the **Permissions** section, scroll down to **Other permissions**, select the policy you created in the previous step, then click **Create Role**. ### Create the access key Create the access key only once the policy and the role exist. **Step 1** In the Bird **Admin console**, go to **Settings → Security → Access Keys**. **Step 2** Click **Add new access key**. **Step 3** In the **Add new access key** dialogue, enter a **Key name** and a **Key description**, select the role you created in the previous step from the **Roles** dropdown, then click **Save**. ![The Add new access key dialogue in Bird, with Key name and Key description fields, a Roles dropdown and an Add new role button.](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/bird-customer-lists/bird-customer-lists-2025-06-27-3.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=34c91c1b5a32e3ef7eaa4c4d18420fa3) ## Find your workspace ID The workspace ID is not an access object — it sits under **Settings → Workspaces**, alongside **Security** rather than inside it. **Step 1** Log in to Bird. In the bottom left-hand corner, click your name, then click **Admin console**. **Step 2** Go to **Settings → Workspaces**. **Step 3** Locate the workspace whose ID you need and click the **workspace name**. **Step 4** Make a note of the **Workspace ID**. ![The Bird Edit workspace panel, with the Workspace ID field at the top, above Workspace name, Workspace description, data hosting, PII strategy, default country and timezone settings.](https://mintcdn.com/zeotap/kl8L6sBUYwhq5T7t/articles/integrate-customer/Storage/integrate-customer/bird-customer-lists/bird-customer-lists-2025-06-27-1.png?fit=max\&auto=format\&n=kl8L6sBUYwhq5T7t\&q=85\&s=c3cc085a0dd2fb4b7917e21609ec3591) ## Create the Bird - Customer Lists destination **Step 1** Log in to the **Zeotap CDP App** and open **Integrate → Destinations**. **Step 2** Click **+ Create Destination**. ![The Zeotap Destinations list with the + Create Destination button highlighted in the top right corner.](https://lh7-qw.googleusercontent.com/docsz/AD_4nXfBVpesJ1euf3diCBvNynEo0YN-Cg59gkYnVlA03o6vyEMdHYeU6qkzMjJcVpVsI9mai565xYoj4eEEUEOge1_xtjVOxDapGPa5QtZODgmi2LgihfR858qHRsjtqKt9BMrTs9eEgw?key=IR5AGgFQq8zoeBtuhzt9jA) **Step 3** Under **All Destinations**, search for **Bird - Customer Lists**. ![The All Destinations catalogue in Zeotap, with the Search for a Destination box highlighted above the destination tiles.](https://lh7-qw.googleusercontent.com/docsz/AD_4nXdG_18foSzq1_0PLrYNB56Zwv76WT4ZAhhpvixA3jTGEpVnmVRrQBxFwZ20qbaRQVxfnCa1J8X_6D4hoHXgkndrDZionwCbV57uEsESSPWvoZVjiz1UeChknI3Qc3lZJf4kWcp8hQ?key=IR5AGgFQq8zoeBtuhzt9jA) **Step 4** Click **Bird - Customer Lists**. The **Enter Destination Details** screen describes the destination on the left and lists the fields the integration needs on the right: a. **Destination Name** — a name for the destination, for easy identification. b. **Access token** — the access key generated in Bird. See [Set up access in Bird](#set-up-access-in-bird). c. **Workspace ID** — the workspace ID of your Bird account. See [Find your workspace ID](#find-your-workspace-id). Review the values, then click **Next**. ![The Enter Destination Details step for Bird - Customer Lists, showing the Destination Name, Access token and Workspace ID fields with a Next button at the bottom.](https://lh7-qw.googleusercontent.com/docsz/AD_4nXdSqgO1b8sqpXlY_htvu-UyBnrfDZr6lLdqeFbq-RDYuilvkB7uC8VVUZU7cBNVBW1TlNOhDvlfY1Qd1I8tUt0SNuIeC-Rr6WzWgU8cJudUQfHY0Zie8kBjU3xtiGmqHKncpitIeA?key=IR5AGgFQq8zoeBtuhzt9jA) **Step 5** On the **Mapping** step, choose the [action](/articles/integrate-customer/destinations#configure-a-destination) and the [mapping](/articles/integrate-customer/destinations#define-the-mapping). Under **Choose your Action**, choose **Send identifiers and attributes** as the action for activating your audience (segment) in the Audiences module. You can map the following fields: * Identifier Value * First Name * Last Name * Display Name and custom fields, using **+ Add Mapping Field** ![The Zeotap mapping screen with Catalogue Field and Destination Field columns, an ID section holding the required Identifier Value row, an Attributes section with First Name and Last Name, and the + Add Mapping Field link.](https://lh7-qw.googleusercontent.com/docsz/AD_4nXc9KlH-vbMx6TMPgmwruIYrlg9abvOop-5BnllO2_TYEuSRquzQYjTxu1bAy-QWVIJLYGyteJl0iUIMHH0vPxXNUkGmlUjLGlJM872hgcDS3VxWVh3dMi92ZhqIjI7Vrakt27Hxtw?key=IR5AGgFQq8zoeBtuhzt9jA) **Step 6** Under **Additional Settings**, choose the **Identifier** for the contact from the dropdown. a. You can select either **Email** or **Phone**. b. The mapping above must carry the value that corresponds to the identifier you select here. ![The Additional Settings card on the Zeotap mapping screen, with an Identifier dropdown under the helper text Select the identifier for the contact.](https://lh7-qw.googleusercontent.com/docsz/AD_4nXcqG08tWfE0djH6umpFNuuX8G6u89L51BgJ1mzGK3zLSNppnq4qFKa0zk-OsxLI7kfn6V_QQf4etSSPQeB_dzRQLFZapX0lEFXG5IjZuAVwEwrIjfym39WuSUAyoRuUAEwACX66?key=IR5AGgFQq8zoeBtuhzt9jA) **Step 7** Click **Create Destination**. The created destination is listed in the **Audiences** application, where it can be linked to an audience or segment. ## Link an audience to the destination For how to link an audience or segment to the destination you created, see [Activate your batch audiences](/articles/integrate-customer/link-an-audience-to-the-destination). A destination is configured once with its credentials and can then be reused across several audiences — you do not need a separate Bird destination per audience. > [!NOTE] > > **Note:** > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an Audience or a segment could be a specific group of customers who are over 18 years of age and who have performed an *addToCart* event within the last 30 days. ## Verify the delivery Confirm the delivery from both sides, as described in [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked): * **In Zeotap** — open the destination and review its activity. A successful delivery records a run with a non-zero qualified count and a completed status. A failed run records an error message. * **In Bird** — open the corresponding customer list and confirm records are present. The two counts will not match exactly, because the platform applies its own match-rate filtering to the identifiers it receives, but both should be non-zero and of the same order of magnitude. ## Troubleshoot the destination If the destination does not behave as you expect, check the following: * **The access policy carries both resources.** The second resource is only added after you click **Add resource**, so a policy saved too early carries `/workspaces/*/lists` alone. * **The access key carries the right role.** The role selected in the **Roles** dropdown when you created the key must be the role built from the `zeotapintegration` policy. * **The identifier and the mapping agree.** Whichever value you choose under **Additional Settings** — **Email** or **Phone** — must also be mapped in the mapping section. ## Next steps * [Bird Trigger Events](/articles/integrate-customer/bird-trigger-events) — send real-time event data to Bird from a Journey. * [Activate your batch audiences](/articles/integrate-customer/link-an-audience-to-the-destination) — link this destination to an audience. * [Destinations](/articles/integrate-customer/destinations) — how destinations, actions and mappings fit together. # Bird Trigger Events Source: https://docs.zeotap.com/articles/integrate-customer/bird-trigger-events Send event data out of Zeotap CDP to Bird in real time from a journey, using the Bird Trigger Events destination. ## What this is Bird Trigger Events is a real-time destination: it sends event data **out of Zeotap CDP to Bird**, from a **Send to Destinations** node in a journey. Bird is a customer communication platform that helps businesses engage with their customers through channels such as email, SMS and WhatsApp. Once the destination is attached to a journey, the events in the categories you select under **Event Category** are forwarded to your Bird workspace — see [Event categories](#event-categories) for the full list. Bird has a second, separate destination in Zeotap CDP. [Bird - Customer Lists](/articles/integrate-customer/bird-customer-lists) pushes audiences built in Zeotap CDP into the customer lists in your Bird instance, for use in Bird campaigns. Both destinations send data in the same direction, from Zeotap CDP to Bird. ## Supported identifiers and actions This destination identifies a contact in Bird by either an **email address** or a **phone number**. You choose which one under **Additional Settings**, and map the matching catalogue attribute to **Identifier Value** in the mapping screen. The action you choose under **Choose your Action** determines which destination fields appear under **Map the Fields**. To send ecommerce events, choose the **Ecommerce Event** action. The screenshots on this page were taken with the **Audiences Event** action selected. ## Prerequisites Before you create the destination in Zeotap CDP, obtain three values from Bird: | Value in Bird | Field in Zeotap CDP | | :- | :- | | `workspaceId` | **Workspace ID** | | `tracking.endpoint` | **Tracking Endpoint** | | `tracking.writeKey` | **Tracking Write Key** | All three come from your Bird application configuration, in the two steps below. ## Get the tracking values from Bird ### Configure your application and obtain the configuration URL **1. Open the application settings** Navigate to the Application settings in the Developer Cloud. **2. Enable an application** Enable an Application by following the on-screen instructions. **3. Set the allowed domains** Specify your website domain(s) as the allowed domains if events will be emitted from your website directly. * If your website homepage is `https://example.com`, use `example.com` as the allowed domain. If there are any subdomains such as `shop.example.com`, list them as well. * Multiple domains can be specified with commas separating them. * If events will be emitted from servers, you can leave the allowed domains empty. **4. Copy the configuration URL** Once enabled, you will see a config page with a snippet similar to this: ```text theme={null} YOUR_CONFIG_URL: https://api.bird.com/workspaces//applications//signature/ ``` ### Retrieve the workspace ID, tracking endpoint and write key Send a GET request to the configuration URL you obtained above. ```bash theme={null} curl -X GET "YOUR_CONFIG_URL" \ -H "Content-Type: application/json" ``` The response carries the three values you need — `workspaceId`, `tracking.endpoint` and `tracking.writeKey`: ```json theme={null} { "applicationId": "", "workspaceId": "", "apiEndpoint": "https://api.bird.com", "allowedDomains": [ "myapplication.com" ], "allowedAppBundles": [ "" ], "tracking": { "connectorId": "", "enabled": true, "writeKey": "", "endpoint": "https://capture.eu-west-1.api.bird.com/tracking/track", "trackPageViews": true, "anonymousTracking": "enqueue", "trackLifecycleEvents": true }, "pushNotifications": { "enabled": false, "connectorId": "00000000-0000-0000-0000-000000000000", "endpoint": "https://capture.eu-west-1.api.bird.com/push-notifications" }, "appInbox": { "enabled": false, "connectorId": "00000000-0000-0000-0000-000000000000", "channelId": "00000000-0000-0000-0000-000000000000", "endpoint": "https://capture.eu-west-1.api.bird.com/app-inbox" } } ``` > [!TIP] > > Retrieve the configuration at the beginning of the session and cache the response for the entire tracking session. ## Create the Bird Trigger Events destination **1. Open Destinations** Log into the **Zeotap CDP App** and go to the **Destinations** application. **2. Start a new destination** Click **+ Create Destination**. **3. Find the connector** Under **All Destinations**, search for **Bird - Trigger Events**. **4. Enter the connection details** Click **Bird - Trigger Events**. A screen appears displaying details about the destination on the left. On the right-hand side you will find the fields required for the integration to be established. Enter the following: 1. A name for the destination. 2. The **Workspace ID**. 3. The **Tracking Endpoint**. 4. The **Tracking Write Key**. Click **Next** to proceed to mapping. **5. Choose the action and map the fields** In the new screen that appears, choose the appropriate action and mapping. 1. Choose the desired action under **Choose your Action**, then choose the corresponding identifiers under **Map the Fields**. 2. From the dropdown at the bottom, select either the email address or the phone number as the identifier and map it accordingly. By default, the output identifiers that are accepted by the platform — such as email IDs and phone numbers — are displayed. You can edit, add or remove an identifier from the list. 3. Click **Create Destination**. ![Destinations mapping screen with Choose your Action set to Audiences Event and a list of Event Attributes destination fields waiting to be mapped to catalogue attributes](https://lh7-qw.googleusercontent.com/docsz/AD_4nXc64KVQYSFP3u4KJgrTApRwgKANFSohrM39o_rfgNfyBgQOtL4lfuJdnXr07Bbyttfd_OR-7WgOoE-6xvNnLHxjCoqCVNyz8Wh8M3IQRHC1LTn9V_zHsPEWdObq4M3Zo89SPyoU0w?key=xvh20YjVc63hJ1WbdE77zQ) **6. Set the identifier type** Under the **Additional Settings** section, choose the **Identifier** from the dropdown. * You can select either **Email** or **Phone** as the identifier. * You need to map the value corresponding to this identifier in the mapping section mentioned above. ![Lower half of the mapping screen showing the required Identifier Value row and the Additional Settings section with the Identifier dropdown](https://lh7-qw.googleusercontent.com/docsz/AD_4nXcAwEOYH3NuZDSsTCtg2I7onaGPERjQpaqtXwVqMbPPirgMLGCcZJf6huyBQ7PYEWN2-HRdUB3yBxU6CR7zu3gw4qKSmF8PbKwQxPZmSlUKUcrNRvV3MbyuTSLYSTr79mSeKVMBPg?key=xvh20YjVc63hJ1WbdE77zQ) ## Add the destination to a journey After creating the destination, link it in the **Send to Destinations** node within the workflow. **1. Add a Send to Destinations node** In the workflow, click **+** and choose **Send to Destinations**. ![Journey canvas action menu with Send to Destinations highlighted alongside the condition, delay and split actions](https://lh7-qw.googleusercontent.com/docsz/AD_4nXeAEH-mfZ6h1vAOzqa2yrlq42dnGfhcG5KIQ2Z_HtQzx2NkJtGCdGz98ABUWEO91ccf6mu1hZXAy1WgvJ2g7LjfmBxjgGyufshcr38kCwCmhS0fEkUwLNeh3_QL1_hJxscfprqK8A?key=xvh20YjVc63hJ1WbdE77zQ) **2. Pick the destination** Choose the destination from the list of available destinations by using the search feature. ![Send to Destinations picker with the search box highlighted above a grid of existing destination cards](https://lh7-qw.googleusercontent.com/docsz/AD_4nXdCDAoGkn7brH9XGItQyaY_RR-tBtTw83U6DLJlFYiLFMpdZQoqmyEwsz07p5FhevsgaLN61z1JPXDh5ks8YCQOzVIyGOu8a0uJjtkb1JqrwhQ9gyhmTmw-ppM5FhCDiO7CWL-u?key=xvh20YjVc63hJ1WbdE77zQ) **3. Check the Destination Details tab** Under the **Destination Details** tab, the **Workspace ID**, **Tracking Write Key** and **Tracking Endpoint** fields are automatically populated based on the values you entered while creating the destination. Under **Event Category**, choose the appropriate option for what you are sending — see [Event categories](#event-categories) for the full list. ![Bird - Trigger Events panel on the Destination Details tab, showing the Destination Name, Tracking Write Key, Tracking Endpoint and Workspace ID fields with the Event Category dropdown highlighted below them](https://lh7-qw.googleusercontent.com/docsz/AD_4nXcO6a5KH9wYZTPZbUmgTcou0Yxa5HB_AWcYl98lAGBFfB9fIsFTtU6NYizniG6AxLm-bVSDDXbSKfb0g13LPjSTVvrHBICsAxKJRePp9xp-BIopqNwyJj_QitFCmUqSnRDfR80LKw?key=xvh20YjVc63hJ1WbdE77zQ) **4. Set the action and mapping** Under the **Destination Settings** tab, choose the action and mapping as per your requirement. For example, to send ecommerce events, select the **Ecommerce Event** action — see [Ecommerce attribute groups](#ecommerce-attribute-groups). **5. Save** Click **Save Destination**. ### Event categories The **Event Category** dropdown lists the following options, each shown as ` - ` — for example, `Ecommerce - Cart Updated`. | Group | Event | | :- | :- | | Ecommerce | Cart Updated, Cart Viewed, Checkout Abandoned, Checkout Updated, Collection Viewed, Order Canceled, Order Confirmed, Order Fulfilled, Product Viewed | | Conference | Incoming Call Answered, Incoming Call Unanswered, Incoming Call Voicemail, Outgoing Call Answered, Outgoing Call Unanswered | | Messaging | Message Bounced, Message Delivered, Message Delivery Failed, Message Link Clicked, Message Marked Spam, Message Opened, Message Sent, Message Subscribed, Message Unsubscribed | | Subscription | Subscription Canceled, Subscription Created, Subscription Updated | | Suppressions | Identifier Suppressed, Identifier Unsuppressed | | Survey | Csat | | Web | Form Submitted, Form Viewed, Page Viewed, Search Submitted | | Audiences | Membership Changed | The dropdown also offers a **Custom** option. ### Ecommerce attribute groups When you select the **Ecommerce Event** action, the destination fields are offered in the following groups. | Attribute group | Applies to | | :- | :- | | Event Attributes | Common for all Ecommerce events | | Cart Event Attributes | For Cart Updated and Cart Viewed events. | | Checkout Event Attributes | For Checkout Started and Checkout Updated events. | | Order Event Attributes | Common Properties for Order Related Events. | | Order Cancelled Event Attributes | Specific Properties for Order Cancelled Events | | Order Fulfilled Event Attributes | Specific Properties for Order Fulfilled Events | | Product Event Props | Properties for Product Events | > [!NOTE] > > For **Order Canceled** and **Order Fulfilled** events, map both the common **Order Event Attributes** group and the event-specific group, not the event-specific group on its own. ## Verify the destination is attached After you click **Save Destination**, the destination is attached to the **Send to Destinations** node. The node shows a card with the connector name, the destination name and the mapping you configured. ![Send to Destinations node with a Bird - Trigger Events destination card attached, showing the destination name and its Audiences Event mapping](https://lh7-qw.googleusercontent.com/docsz/AD_4nXfJFz3SgPoUGoUDTvM30qa4EvSRUZ950Ijx0cMELdpUB7WU95ZLwDxi368Hq5qf3BmZFJsT8KaDC-C-YUAktRYfmHBnZ4sQ5Px8__FByhn9itvnAFj9H_v4_h2s-PwNejl205utxQ?key=xvh20YjVc63hJ1WbdE77zQ) ## Next steps * [Bird - Customer Lists](/articles/integrate-customer/bird-customer-lists) — the other Bird destination, which pushes audiences built in Zeotap CDP into customer lists in Bird. * [Destinations](/articles/integrate-customer/destinations) — how a destination is set up and how the [field mapping](/articles/integrate-customer/destinations#define-the-mapping) works across the catalogue. * [Real-time integrations](/articles/integrate-customer/real-time-integrations) — the other real-time destinations Zeotap CDP supports. # Blacklisted Fields for Data Ingestion Source: https://docs.zeotap.com/articles/integrate-customer/blacklisted-fields-for-data-ingestion The field names Zeotap CDP blacklists during data ingestion, including the geography fields it determines automatically from the user's IP address. ## What this is Zeotap CDP blacklists a fixed set of field names during data ingestion: the records in a column that carries one of these names are not ingested. Check the field names your source sends — file column headers or event property keys — against the two tables below. ## Blacklisted geography fields Zeotap determines a user's country and city automatically from their IP address. The records in the country, city and region columns below are blacklisted for ingestion. | Blacklisted field name | | :- | | `city` | | `country` | | `country_code_iso3` | | `eu_country` | | `_fregion` | | `_fregion_src` | | `region` | | `user_country` | > [!NOTE] > > The automatic IP lookup is the stated reason for the geography field names. The published documentation does not give a reason for the remaining names. ## Other blacklisted fields Zeotap CDP blacklists the remaining field names below during ingestion in the same way. Do not use any of them as a column name for your own attributes. | Blacklisted field name | | :- | | `accept` | | `adnxs_uid` | | `CC` | | `cid` | | `cmp` | | `connection_type` | | `cookieSync` | | `datasetId` | | `_DNT` | | `eventSource` | | `_fctry_src` | | `google_cver` | | `google_error` | | `google_gid` | | `hasGdprMacro` | | `id_mid_4` | | `identify` | | `orgId` | | `payload` | | `pid` | | `protocol` | | `puid` | | `purposesAllowed` | | `purposesAllowedPub` | | `redirect` | | `referer` | | `_rules` | | `ruleType` | | `_system` | | `_test` | | `timeStamp` | | `track` | | `turn_id` | | `uc` | | `version` | | `w_k` | | `webouuid` | | `ws_uid` | | `z_p` | | `zc0` | | `zc1` | | `zcluid` | | `zdid` | | `zem1` | | `zem2` | | `zem3` | | `zem4` | | `zem5` | | `zem6` | | `zpartnerid` | | `zph1` | | `zph2` | | `zph3` | | `zph4` | | `zph5` | | `zph6` | | `zt` | | `zurl` | ## FAQ > [accordion] Why are the country and city fields blacklisted? > > Zeotap determines a user's country and city automatically from their IP address, so it blacklists those field names during ingestion. > [accordion] Does the IP lookup explain every name on this page? > > No. It covers the country, city and region field names in the first table. Zeotap CDP blacklists the names in the second table for other reasons. > [accordion] How do I check whether one of my columns clashes with a blacklisted name? > > Search this page for the exact field name. If it appears in either table, records in that field are not ingested. ## Next steps * [Explore how sources bring data into Zeotap CDP →](/articles/integrate-customer/sources) * [Explore the source integrations Zeotap CDP supports →](/articles/integrate-customer/creating-a-source) * [Explore how to implement a Web JS source →](/articles/integrate-customer/implementing-web-js-source-2744942595) # Bloomreach Source: https://docs.zeotap.com/articles/integrate-customer/bloomreach Send Zeotap CDP audiences, customer attributes and events out to a Bloomreach Engagement project, and map them to Bloomreach customer identifiers. ## What this is The Bloomreach destination sends data **out of Zeotap CDP and into Bloomreach Engagement** (formerly Exponea), so that the campaigns you run in Bloomreach are powered by unified Zeotap profiles rather than by manual file uploads. Once the destination is created, you link a Zeotap audience to it. Zeotap then writes the audience's customers, their attributes and — if you choose an events action — their events into the Bloomreach project you authenticated against. Bloomreach can act on that data straight away in email, SMS and push campaigns. In the Zeotap destination catalogue, Bloomreach is listed under the **Martech** category. ## Supported identifiers and actions When you configure the destination you pick one action, and the action determines which Bloomreach fields are available to map. | Action | What it does | | - | - | | **Add or Update Users** | Creates or updates customer profiles in Bloomreach. | | **Add Events** | Writes events against a customer profile in Bloomreach. | The **Add Events** entry appears twice in the action list — once tagged **Audiences** and once tagged **Journeys**. Pick the **Audiences** entry for the batch flow described on this page. If you pick the **Journeys** entry, the destination is driven from a journey instead; see [Activate Your Real Time Audiences](/articles/integrate-customer/activate-your-real-time-audiences). The mapping screen groups Bloomreach fields into **Attributes** and **Properties**: | Destination field | Type | Available for | Notes | | - | - | - | - | | Registered | String | Both actions | The Bloomreach registered customer identifier. | | Cookie | String | Both actions | Bloomreach cookie identifier. | | Google Analytics | String | Both actions | Google Analytics identifier held on the Bloomreach profile. | | Update Timestamp | Integer | Add or Update Users | When the profile update was made. | | Timestamp | Integer | Add Events | When the event occurred. | | Event Type | Integer | Add Events | Required. | Under **Properties**, map any further customer attributes you want to send, such as first name. Use **+ Add Mapping Field** to add rows. ## Prerequisites **In Zeotap CDP** * Access to your Zeotap CDP account with **Admin** or **Editor** permissions. * Access to the **Integrate** module, where Destinations live. Your access to an individual destination is governed by [Destination Access Rules](/articles/integrate-customer/destination-access-rules). * An audience to activate. You link it to the destination after the destination is created. **In Bloomreach Engagement** * An active Bloomreach Engagement project. * Admin access to that project, so that you can open its API settings. * The following values, collected from the project in the next section: * **Project token** * **API Key ID** * **API Secret** > [!NOTE] > > **Note:** > > Zeotap does not currently support a custom Bloomreach API base URL. If your project uses one instead of the standard `https://api.exponea.com`, contact your Zeotap customer success manager to have this changed for your organisation. ## Collect your Bloomreach API credentials Retrieve the project token and an API key pair from your Bloomreach Engagement project. **Step 1** Log in to Bloomreach Engagement. **Step 2** Click the cogwheel icon in the top bar and select **Project settings**. ![The Bloomreach Engagement Customers page with the top-bar cogwheel menu open, showing Project settings, User settings and Web integration.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-11.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=18c693b3fd64c0a961f9a88b3df633dd) **Step 3** Go to **Access Management > API** in the left sidebar. **Step 4** Copy the **Project token**. This is the value you enter in Zeotap as the Project ID. The **API Base URL** is shown on the same screen. You do not enter it in Zeotap — see the note above. **Step 5** Under **API groups**, use a group whose access type is **Private**. Every group carries its own permissions and keys. ![The Bloomreach Engagement API settings screen showing the Project token and API Base URL fields, an API group with a Private access type, the Group keys table with Key name, API Key ID and API Secret columns, and the Group permissions tabs.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-12.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=9ed8209cf5d15523ea16da8ff8e79cf9) **Step 6** Give the group the permissions the action you plan to use needs. Group permissions are split across tabs including **Customer properties**, **Events**, **Imports** and **Exports** — grant write access on the tabs that cover your action, and no more than that. **Step 7** In **Group keys**, use the existing key or click **+ Add key**, then copy the **API Key ID** and the **API Secret**. Copy the secret straight away. Bloomreach shows it once and will not display it again after you close the window. ## Create the Bloomreach destination **Step 1** Log in to the Zeotap CDP App and go to **Integrate > Destinations**. **Step 2** Click **+ Create Destination**. ![The Zeotap Destinations list with the Private Destination and Public Destination tabs and the + Create Destination button highlighted in the top right.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-13.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=949a64a944147cdc603acaac3cdee5c8) **Step 3** Under **All Destinations**, use **Search for a Destination** to find Bloomreach. ![The All Destinations catalogue in Zeotap with the Search for a Destination box highlighted above a grid of destination tiles.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-14.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=ef9a1fb86712c309e7d4f19125482b8a) ![Search results in the All Destinations catalogue showing the Bloomreach tile, categorised as Martech.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-15.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=d9446e69047cdb9170ac92fff5ee8dc9) **Step 4** Click **Bloomreach**. Details about the destination appear on the left, and the fields required to establish the integration appear on the right, under the **Destination Details** tab. On that tab, enter: * **Destination Name** — a name that makes the destination easy to identify later. * **API Secret** — the secret you copied from Bloomreach. * **API Key** — the API Key ID you copied from Bloomreach. * **Project ID** — the Bloomreach project token. ![The Destination Details tab for a Bloomreach destination in Zeotap, with the Destination Name, API Secret, API Key and Project ID fields and the Back and Save buttons.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-16.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=acb919f1f0fdbc52b7307d1fbabe7556) Review the values, then click **Save**. **Step 5** Open the **Mapping** tab. Under **Choose your Action**, select the action you want this destination to perform. ![The Choose your Action step in Zeotap with the Select Action dropdown open, listing Add Events tagged Journeys, Add Events tagged Audiences, and Add or Update Users.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-17.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=bdd6928bd0bb2f5b871d1025eb1becdf) **Step 6** Under **Map the Fields**, map each Zeotap **Catalogue Field** to the Bloomreach **Destination Field** you want it to populate. At minimum, map the identifier Zeotap should match on — **Registered** — and, for **Add Events**, the required **Event Type** field. Add any further customer attributes under **Properties** with **+ Add Mapping Field**. ![The mapping screen for the Add or Update Users action, showing the Attributes rows Registered, Update Timestamp, Cookie and Google Analytics, the + Add Mapping Field link, and the start of the Properties section with First Name.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-18.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=4f2576bcf44febf2ed0675656347488c) ![The mapping screen for the Add Events action, showing the Catalogue Field and Destination Field columns and the Attributes rows Registered, Timestamp, Cookie, Google Analytics and the required Event Type.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-19.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=a0b355e8d9a46f355f9324af2893d464) **Step 7** Click **Create Destination**. To preview the payload that your mapping will produce before you activate anything, see [Payload Preview for Destination Mappings](/articles/integrate-customer/payload-preview-for-destination-mappings). ## Link an audience to the destination Creating the destination does not send any data. Zeotap starts writing to Bloomreach only once an audience is linked to it. Open the **Audiences** application, find the audience you want to send, and link it to the Bloomreach destination you just created. The full procedure, including scheduling, is on [Activate Your Batch Audiences](/articles/integrate-customer/link-an-audience-to-the-destination#activate-in-audiences). ## Verify the sync Check both sides of the integration: 1. **In Zeotap** — open the Bloomreach destination and review its activity. A successful delivery records a completed run with a non-zero qualified count. A failed run records an error message you can use to diagnose the cause. 2. **In Bloomreach Engagement** — go to **Data & Assets > Customers** and search for a customer you know is in the audience. For the **Add or Update Users** action, confirm the mapped properties are present on the profile. For **Add Events**, confirm the event appears against the customer with the event type you mapped. The two counts will not match exactly, because Bloomreach only retains records it can resolve against the identifier you mapped. Both should be non-zero and of a similar order of magnitude. ## Troubleshoot the Bloomreach destination | Symptom | Likely cause | What to do | | - | - | - | | The destination will not save, or every delivery is rejected. | The API Key ID or API Secret is wrong, or they come from different key pairs. | Re-copy both values from the same group key in Bloomreach under **Access Management > API**. If the secret was not saved when the key was created, add a new key and use that pair. | | Deliveries are rejected even though the credentials are correct. | The Bloomreach API group does not carry the permissions the chosen action needs. Zeotap's own field hints call this out: *make sure proper permissions are enabled for the actions used*. | In Bloomreach, open the group under **API groups** and grant write access on the permission tabs your action touches — **Customer properties** for profile updates, **Events** for events. | | Data is delivered but lands in the wrong Bloomreach project. | The **Project ID** entered in Zeotap is not the project token of the project you expect. | Re-copy the **Project token** from **Project settings > Access Management > API** in the intended project. | | An **Add Events** mapping cannot be saved. | **Event Type** is a required destination field and has not been mapped. | Map a catalogue field to **Event Type**, then save again. | | Customers reach Bloomreach but are not matched to existing profiles. | The audience has no value for the identifier you mapped, or you mapped an identifier Bloomreach does not hold for those customers. | Confirm the audience populates the identifier you mapped to **Registered**, **Cookie** or **Google Analytics**, and that Bloomreach stores that same identifier on its profiles. | For failure patterns that apply to every destination, see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail). ## Next steps * [Activate Your Batch Audiences](/articles/integrate-customer/link-an-audience-to-the-destination) — link audiences and set their refresh schedule. * [Destinations](/articles/integrate-customer/destinations#configure-a-destination) — how destinations are configured and how mappings are defined. * [Payload Preview for Destination Mappings](/articles/integrate-customer/payload-preview-for-destination-mappings) — check what a mapping will send before you activate. * [Destination Access Rules](/articles/integrate-customer/destination-access-rules) — control who in your organisation can use this destination. # Braze Source: https://docs.zeotap.com/articles/integrate-customer/braze-1 Send audience membership and profile attributes from Zeotap CDP to Braze so you can activate them in email, mobile push, SMS, and in-app campaigns. ## What this is Braze is a customer engagement platform for email, mobile push, in-app messaging, and SMS. The Zeotap CDP → Braze destination pushes user profile attributes to Braze via its REST API so you can activate a Zeotap audience inside a Braze campaign. Braze's REST API does not accept segment membership directly, so Zeotap writes each audience name as a boolean **Custom Attribute** on every matching user profile in Braze, and you then re-create the matching segment inside Braze against that attribute. Two representative scenarios: * You have an app instrumented with the Braze SDK, and Zeotap CDP holds CRM data about those same customers. Use this destination to push audience membership to Braze and drive mobile push updates on customer-service events. * You have first-party e-commerce data in Zeotap and want to reach mobile identifiers (resolved through Zeotap's identity graph) with SMS or push after a basket abandon. ## Prerequisites > [!NOTE] > > Collect the following before you configure the destination: > > * **Client Name** — your Braze account's client name, visible in the Braze Console. > * **API Key** — a Braze REST API key with the **User Data** permissions enabled. If your existing key does not have those permissions, create a new key in the Braze Console under **Settings → APIs and Identifiers → API Keys**. > * **Instance** — the Braze instance your account is provisioned to (for example `US-01`, `EU-01`). Match your Braze dashboard URL to the corresponding REST endpoint using the [Instance mapping](#instance-mapping) table below; if you are unsure, open a Braze support ticket. > * Access to the **Destinations** application in Zeotap CDP. ### Instance mapping | Instance | Dashboard URL | REST endpoint | | - | - | - | | US-01 | `https://dashboard-01.braze.com` | `https://rest.iad-01.braze.com` | | US-02 | `https://dashboard-02.braze.com` | `https://rest.iad-02.braze.com` | | US-03 | `https://dashboard-03.braze.com` | `https://rest.iad-03.braze.com` | | US-04 | `https://dashboard-04.braze.com` | `https://rest.iad-04.braze.com` | | US-05 | `https://dashboard-05.braze.com` | `https://rest.iad-05.braze.com` | | US-06 | `https://dashboard-06.braze.com` | `https://rest.iad-06.braze.com` | | US-08 | `https://dashboard-08.braze.com` | `https://rest.iad-08.braze.com` | | EU-01 | `https://dashboard-01.braze.eu` | `https://rest.fra-01.braze.eu` | | EU-02 | `https://dashboard-02.braze.eu` | `https://rest.fra-02.braze.eu` | ## Supported identifiers and actions This destination accepts raw email addresses, First Name, Last Name, and Gender. The action you pick on the mapping screen controls what Zeotap sends and which segment-management features are available: | Action | What it sends | ID Extension | Delete | Delta Upload | | - | - | :-: | :-: | :-: | | **Send Identifiers to Braze** | Email addresses only. One catalogue attribute maps to the destination email field. | ✅ | ✅ | ✅ | | **Send Attributes and Identifiers to Braze** | Email plus First Name, Last Name, Gender, and other catalogue attributes mapped to Braze fields. | — | — | — | | **Send User alias, attributes and identifiers** | The above plus a Braze user alias. **External ID** and **Email** are mandatory maps. | — | — | — | | **Rename Users External IDs** | Renames an existing External ID on the Braze user profile. Map **Current External Id** and **New External Id**; both are mandatory. | — | — | — | | **Remove Deprecated External IDs** | Removes a deprecated External ID from Braze. Map **External ID**; it is mandatory. | — | — | — | > [!NOTE] > > When email is used as the identifier, Braze resolves the profile as follows: > > * If the email does not exist in Braze, an email-only user profile is created and any attributes in the request are written to it. > * If the email already exists in Braze, the incoming attributes are added to that profile. > * If more than one profile shares the same email, the profile that was updated last is prioritised. ## Create the Braze destination Work in the **Destinations** application in Zeotap CDP. 1. Open the Destinations application and start a new destination (`+ Create Destination`). ![Destinations application showing the + Create Destination button](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_1.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=92dfe8ecb29e59c9d7d57cb954e54618) 2. Under **All Destinations**, search for **Braze** and open it. ![Searching for the destination under All Destinations](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_2.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=6f5f0f5367788fb4e9e946f4b3cb5874) 3. On the destination configuration screen, enter a name for the destination and supply the three credential values from Prerequisites: **Client Name**, **API Key**, and **Instance**. ![Braze destination configuration screen with the name, Client Name, API Key, and Instance fields](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/braze-1/Braze_3.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=413194061e556a738e07015bc9ca23c7) 4. Review the values and click **Next** to go to the mapping screen. ## Choose an action and map the fields On the mapping screen, under **Choose your Action**, pick one of the actions described in [Supported identifiers and actions](#supported-identifiers-and-actions). * **Send Attributes and Identifiers to Braze** — map catalogue attributes (Email, First Name, Last Name, Gender, and any custom attributes) to their corresponding Braze fields. ![Mapping screen for the Send Attributes and Identifiers to Braze action](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/braze-1/Braze_5.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=3cd3807fd28f1bbf254605954989c447) * **Send Identifiers to Braze** — map a single catalogue attribute (email) to the destination email field. ![Mapping screen for the Send Identifiers to Braze action](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/braze-1/Braze_6.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=654b7c77f287f1b8513590c24c2d222b) * **Send User alias, attributes and identifiers** — map catalogue attributes and a Braze user alias. **External ID** and **Email** are mandatory. * **Rename Users External IDs** — map **Current External Id** (the existing External ID in Braze that you want to rename) and **New External Id** (the new External ID that replaces it). Both fields are mandatory. The API key configured for the destination must have the **users.external_ids.rename** permission. * **Remove Deprecated External IDs** — map **External ID** (the External ID you want to remove from Braze). This field is mandatory. The API key configured for the destination must have the **users.external_ids.remove** permission. Save the destination (`Create Destination`). The new destination is now listed in the **Audiences** application and is ready to be linked to an audience. ## Link an audience to the destination Attach the destination inside the **Audiences** application. For the full procedure, see [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > "Audiences" and "Segments" are used interchangeably in Zeotap CDP to refer to a customer cohort — for example, customers over 18 who performed an `addToCart` event in the last 30 days. ## Re-create the segment inside Braze Because Braze's REST API does not accept segment membership directly, you re-create the matching segment inside Braze against the boolean **Custom Attribute** that Zeotap writes on each user profile: 1. In Braze, start a new segment (`+ Create Segment`). 2. Add a filter of type **Custom Attribute** and select the segment name that was created in Zeotap. 3. Save. The segment is available to your Braze campaigns. ![Creating a segment in Braze with a Custom Attribute filter](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/3119185988.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=da252c1079a1e9a4825cf489c2ab1ac9) ## Verify the sync worked After the audience is linked and the first refresh has completed, verify end-to-end in Braze: 1. In the Braze console, search a known member of the audience by **Email ID**. 2. Open the user profile and inspect the **Custom Attributes** section. The Zeotap segment name is listed there with the value `true` for every user who is part of that segment. ![Custom Attributes section of a Braze user profile listing the Zeotap segment name with the value true](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/3120398376.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=598cefc735a748f2c89e669605aa6618) The presence of the Zeotap segment name as a custom attribute set to `true` on the expected profiles confirms the sync is working. ### Timestamp and format conventions Where your mapping carries a timestamp attribute (for example, a custom event timestamp), send the value in the format Braze expects: ``` yyyy-MM-dd'T'HH:mm:ssX ``` Apply the Zeotap **Timestamp Enricher** on the attribute to convert the value into this format before it leaves Zeotap. Format requirements to honour on ingestion so Braze accepts other values: * **Phone** — E.164 format. Zeotap performs no transformation; ingest the number already in E.164. * **Currency** — ISO 4217 alphabetic code. * **Language** — ISO 639-1 (for example, `en`). ## Troubleshoot common configuration issues | Symptom you observe | What it means | Where to look | | - | - | - | | Requests to Braze fail with an authentication error | The API key does not have the **User Data** permissions, or the **Instance** selected in Zeotap does not match your Braze REST endpoint. | Braze Console → **Settings → APIs and Identifiers → API Keys**; recheck the **Instance** value on the Zeotap destination configuration screen. | | Custom events do not appear on the Braze user profile | Both **Custom Event Name** and **Custom Event Timestamp** must be mapped. If either is not mapped, Braze cannot process the custom event. | Mapping screen of the Braze destination in Zeotap CDP. | | Purchase events do not appear on the Braze user profile | **Product ID**, **Currency**, and **Price** must all three be mapped. If any is not mapped, the purchase event is not processed. | Mapping screen of the Braze destination in Zeotap CDP. | | Two Braze profiles exist for the same person | Braze creates an email-only user profile when a request's email does not already exist. When more than one profile shares an email, the profile updated last is prioritised. | Braze user profile search by **Email ID**. | ## User disqualification from audiences When a user no longer meets an audience's criteria — or when consent or other qualification conditions no longer hold — Zeotap CDP raises a user deletion request against the audiences linked to this destination on the next refresh cycle. Disqualified users are excluded from the audiences on that audience's configured refresh frequency. This process runs automatically; no action is required from you. ## FAQ > [accordion] Why is segment membership sent as a Custom Attribute instead of a Braze Segment? > > Braze's REST API does not allow creating or maintaining Braze Segment membership from outside Braze. Zeotap works around this by writing each audience name as a boolean **Custom Attribute** on every matching user profile, and you re-create the matching segment inside Braze against that attribute. > [accordion] Which permissions does my Braze API key need? > > The API key must have the **User Data** permissions enabled. If your existing key does not have them, create a new key from **Settings → APIs and Identifiers → API Keys** in the Braze Console with those permissions and use that key in the Zeotap destination. In addition, the **Rename Users External IDs** action requires the **users.external_ids.rename** permission, and the **Remove Deprecated External IDs** action requires the **users.external_ids.remove** permission. > [accordion] How do the action types differ? > > **Send Identifiers to Braze** sends email only, and one catalogue attribute maps to the destination email field. **Send Attributes and Identifiers to Braze** sends Email, First Name, Last Name, Gender, and any custom attributes you map. **Send User alias, attributes and identifiers** sends the above plus a Braze user alias, and **External ID** and **Email** are mandatory maps. Two further actions manage External IDs rather than send profile data: **Rename Users External IDs** renames an existing External ID (map **Current External Id** and **New External Id**; both mandatory), and **Remove Deprecated External IDs** removes a deprecated External ID (map **External ID**; mandatory). > [accordion] How do I remove a user who no longer qualifies for the audience? > > You do not need to do anything. When a user disqualifies from an audience, Zeotap CDP raises a user deletion request against the audiences linked to this destination on the next refresh cycle, on that audience's configured refresh frequency. ## Next steps * [Explore the Braze Integration reference for all supported attributes and mapping types →](/articles/integrate-customer/braze-integration) * [Explore Object Sync in Braze for Journey-triggered custom-object updates →](/articles/integrate-customer/braze-journey-action) * [Explore Braze Currents as a data source into Zeotap CDP →](/articles/integrate-customer/braze-currents) * [Explore how to link an audience to the destination →](/articles/integrate-customer/link-an-audience-to-the-destination) # Braze Currents source Source: https://docs.zeotap.com/articles/integrate-customer/braze-currents Bring the engagement events Braze records about your customers into Zeotap CDP, so campaign activity forms part of the unified customer profile. ## What this is A Braze Currents source carries data **from Braze into Zeotap CDP**. Braze Currents is Braze's own continuous export of your engagement events; pointing it at Zeotap CDP means the activity Braze records is unified with the customer data you already hold, rather than staying inside Braze. Using Braze Currents as a data source in Zeotap CDP, you map your customer data to Zeotap's endpoint through batched JSON payloads. To send data the other way, **out of Zeotap CDP to Braze**, see [Braze](/articles/integrate-customer/braze-1) for activating an audience into Braze, and [Braze Integration](/articles/integrate-customer/braze-integration) for real-time orchestration from Journeys. Braze Currents sits in the **Customer Engagement Channels** source category, alongside the other engagement platforms listed under [Customer Engagement Channels](/articles/integrate-customer/customer-engagement-channels). With engagement events flowing in, you can build targeted customer segments, personalise content recommendations and optimise advertising strategies against behaviour that originated in Braze. ## Supported identifiers and events The [source integrations catalogue](/articles/integrate-customer/creating-a-source) lists Braze Currents under **Customer Engagement Channels**, carrying Customer Data (CE) only. **Identifiers.** Every Braze Currents table you sync to the source must carry at least one identifier — for example an email address, a cellphone number, a cookie or an ADID. **Events.** The source covers two families of Braze events: | Family | Examples | | :- | :- | | Customer behaviour and user events | Attribution, custom events, locations, purchases, random bucket number, sessions. | | Message engagement events | Sends, deliveries, opens, clicks, bounces, dismissals, conversions, spam reports, subscription changes and uninstalls, across email, push, SMS, WhatsApp, in-app messages and content cards. | [Braze source — attributes supported](/articles/integrations-master-list-publication/braze-source-attributes-supported) has the complete list. You choose which of these Braze sends when you configure the export on the Braze side. There is no limit on the number of columns ingested into Zeotap CDP — you can map them to the Zeotap catalogue or add custom fields. ## Prerequisites * A Braze account with access to **Partner Integrations → Data Export**, where the Currents export is created. * Access to the **Sources** application under **Integrate** in Zeotap CDP. * **A country on every record.** Records must be tied to a country for a data collection to be created. The supported standard objects contain country columns, so fill the country column with valid values — otherwise the country has to be hard coded. Use alpha ISO 3 country codes. * **Data in the right region.** Make sure the data you ingest belongs to the correct region for the table it comes from, so that data privacy and compliance requirements are met. The source form asks you to select a **Region** when you create the source. > [!NOTE] > > Speak to your customer success manager if you want a Braze Currents source created for your tenant. ## Set up the Braze Currents source Setting the integration up is two steps. First create the source in Zeotap CDP — on successful creation it generates an **API URL** and a `write_key` on the source's **IMPLEMENTATION DETAILS** tab. The API URL establishes the connection between Braze Currents and Zeotap CDP, and the `write_key` is what lets Braze ingest data into that source. See [Create a Braze Currents source](/articles/integrate-customer/create-a-braze-currents-source). Then create a **Custom Currents Export** in Braze pointed at that API URL. See [Implement a Braze Currents source](/articles/integrate-customer/implement-a-braze-currents-source). ## Verify the source is receiving data Find the source on the source listing page. A newly created source stays at status **Created** until it receives anything; once data starts flowing it moves to **Integrated**, and you can inspect the incoming records on the source's **PREVIEW DATA** tab — [Components of the Preview Data tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) explains what each field means. The source reaches **Mapped** once at least one data collection exists on top of it, built against the common taxonomy; see [Map the catalogue](/articles/unify-customer/map-the-catalogue). ## Troubleshoot the Braze Currents source **The source is still at Created and no records have arrived.** Braze only starts sending once you click **Launch Current**. Check that the **Endpoint** and **Bearer Token** in the Braze export match the API URL and `write_key` shown on the source's **IMPLEMENTATION DETAILS** tab. **Country and city are missing from the ingested records.** The country and city columns are blacklisted for ingestion, because the country and city are derived automatically from the user's IP address. [Blacklisted fields for data ingestion](/articles/integrate-customer/blacklisted-fields-for-data-ingestion) has the complete list. **Some records failed to ingest.** An alert icon appears beside the source on the listing page if any erroneous record was ingested in the last 90 days, and it stays there until the errors are fixed. Hover over the **TOTAL RECORDS INGESTED** count to see the ingested-versus-failed split and the ingestion efficiency. [Components of the source listing page](/articles/integrate-customer/components-of-the-source-listing-page) explains the columns and the source report. **Data stopped arriving after the source was paused.** Pausing data collection invalidates the write key on the source page, which stops data collection. Resume data collection from the **ACTIONS** menu on the source listing page. ## Next steps * [Create a Braze Currents source](/articles/integrate-customer/create-a-braze-currents-source) — the step-by-step setup in Zeotap CDP, ending with the API URL and `write_key`. * [Implement a Braze Currents source](/articles/integrate-customer/implement-a-braze-currents-source) — configuring the Custom Currents Export on the Braze side. * [Best practices for Braze Currents](/articles/integrate-customer/best-practices-for-braze-currents) — identifiers, country and region data, and mapping guidance before you save a mapping. * [Components of the source listing page](/articles/integrate-customer/components-of-the-source-listing-page) — statuses, ingestion counts and the source report. * [Customer Engagement Channels](/articles/integrate-customer/customer-engagement-channels) — the other engagement platforms you can bring data in from. * [Braze](/articles/integrate-customer/braze-1) and [Braze Integration](/articles/integrate-customer/braze-integration) — sending data the other way, out of Zeotap CDP to Braze. # Braze Integration Source: https://docs.zeotap.com/articles/integrate-customer/braze-integration Configure Braze as a real-time destination to send user attributes, custom events, and purchases from Zeotap CDP so you can build Braze segments and trigger campaigns. ## What this is Braze is a customer engagement platform for real-time messaging across email, mobile push, SMS, in-app, and web. This integration sends user profile attributes, custom events, and purchase events from Zeotap CDP into Braze so you can trigger campaigns, personalise messages, and build Braze segments from Zeotap audiences. Two integration methods are supported — one that pairs Zeotap with the Braze SDK on your app or website (Method 1), and one that uses Zeotap alone (Method 2). ## Prerequisites > [!NOTE] > > Gather these three values from Braze before starting. You paste all three into the Zeotap destination form. > > * **Client Name** — the name of your Braze account, shown in the Braze Console account header. > * **API Key** — a Braze REST API key with the `users.track` permission enabled under **User Data**. > * **Instance** — the Braze instance your account is provisioned on (US-01 through US-08, or EU-01 / EU-02). ### Get the API Key In the Braze Console, go to **Settings** → **APIs and Identifiers** → **API Keys**. Reuse an existing key if it already has the `users.track` permission under **User Data**. To create a new key: click **Create API Key**, enter an **API key name**, enable the **users.track** checkbox under **User Data**, and copy the generated key from the **Identifier** column. ### Identify your Instance Braze runs several instances for the dashboard and REST endpoints. Match your Braze dashboard URL to the correct REST endpoint using the table below, then select that instance from the drop-down when creating the Zeotap destination. | Instance | Dashboard URL | REST Endpoint | | :- | :- | :- | | US-01 | [https://dashboard-01.braze.com](https://dashboard-01.braze.com) | [https://rest.iad-01.braze.com](https://rest.iad-01.braze.com) | | US-02 | [https://dashboard-02.braze.com](https://dashboard-02.braze.com) | [https://rest.iad-02.braze.com](https://rest.iad-02.braze.com) | | US-03 | [https://dashboard-03.braze.com](https://dashboard-03.braze.com) | [https://rest.iad-03.braze.com](https://rest.iad-03.braze.com) | | US-04 | [https://dashboard-04.braze.com](https://dashboard-04.braze.com) | [https://rest.iad-04.braze.com](https://rest.iad-04.braze.com) | | US-05 | [https://dashboard-05.braze.com](https://dashboard-05.braze.com) | [https://rest.iad-05.braze.com](https://rest.iad-05.braze.com) | | US-06 | [https://dashboard-06.braze.com](https://dashboard-06.braze.com) | [https://rest.iad-06.braze.com](https://rest.iad-06.braze.com) | | US-08 | [https://dashboard-08.braze.com](https://dashboard-08.braze.com) | [https://rest.iad-08.braze.com](https://rest.iad-08.braze.com) | | EU-01 | [https://dashboard-01.braze.eu](https://dashboard-01.braze.eu) | [https://rest.fra-01.braze.eu](https://rest.fra-01.braze.eu) | | EU-02 | [https://dashboard-02.braze.eu](https://dashboard-02.braze.eu) | [https://rest.fra-02.braze.eu](https://rest.fra-02.braze.eu) | ## Choose your integration method Pick the method that matches whether you already ship the Braze SDK in your product. ### Method 1 — Zeotap + Braze SDK Use this method when you have the Braze SDK on your website or app. The SDK captures device-level engagement (in-app messaging, news feed, content cards, push), and Zeotap enriches the same user profiles with attributes from your CDP. Tasks: 1. Integrate the Braze SDK on your website or app. 2. Integrate Braze with Zeotap through Journeys. > [!WARNING] > > Under the **Data To Send** tab, map only User traits to Braze fields. Mapping Event and Purchase attributes on top of what the SDK already sends produces duplicate events in Braze. Map **External ID** to the same **User ID** you configured in the Braze SDK. **Use case:** create email and push notification campaigns based on custom attributes sent to Braze from Zeotap. ### Method 2 — Zeotap only Use this method when you do not run the Braze SDK. > [!NOTE] > > Without the Braze SDK, the following Braze features are not available through this integration: in-app messaging, news feed, content cards, and push notifications. Zeotap recommends mapping the hashed email from the Zeotap Catalogue to the Braze **External ID**. **Use case:** create email campaigns based on custom attributes sent to Braze from Zeotap. ## Create the Braze destination in Zeotap CDP Once the three prerequisite values are in hand, create the destination. 1. In the Zeotap CDP app, open the **Destinations** application and click **+ Create Destination**. You can also create one from a Journey's **Send to Destinations** panel, where the button is **+ Add New Destination**. ![Send to Destinations panel listing existing destinations with the Add New Destination option](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/batch-real-time-destination-integration/batch-real-time-destination-integration-2024-08-07.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=f766a33de9698fedd70857f4706e14b5) 2. Search for **Braze** and select it. 3. Enter a name for the destination, then paste the **Client Name**, **API Key**, and **Instance** from Prerequisites. Click **Next**. ![Braze destination form with Client Name, API Key, and Instance fields](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/batch-real-time-destination-integration/batch-real-time-destination-integration-2024-08-07-1.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=4a52ed210c9cc6d2b97c8d6912d52160) 4. On the mapping screen, under **Choose your Action**, select **Send Attributes and Identifiers to Braze**. Under **Map the Fields**, select the corresponding attribute for each listed Destination Field (Email, Phone, First Name, Last Name, and similar) using **Choose Catalogue Attribute**. 5. Add any custom data under **Attributes** by clicking **+ Add Mapping Field** and entering a **Key Name**, a **Catalogue Attribute** and a **Type**. Only simple key/value pairs are supported — for a purchase event, a set of properties such as `color: red`, `checkout duration: 180`, `size: 10 UK`, `brand: Nike` is valid. ![Mapping screen showing field mappings and custom data properties for Braze](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/batch-real-time-destination-integration/batch-real-time-destination-integration-2024-08-07-2.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=1070f087ab1922b5f77eb469354b23ee) 6. Click **Create Destination**. The destination becomes available to Journeys. ## Activate the destination in a Journey After the destination is created, link it inside a Journey workflow. 1. In your Journey workflow, click **+** at the point where the action should fire and choose **Send to Destinations**. ![Journey workflow with the Send to Destinations action selected](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/batch-real-time-destination-integration/batch-real-time-destination-integration-2024-08-07-3.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=747854bf36e7de769d121ce2a41af6f3) 2. Search for and select the Braze destination. ![Searching the list of available destinations from the Journey node](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys-real-time-integration/emarsys-real-time-integration-2024-08-07-3.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=905780d151c74c2199117924d8c88c89) 3. Under the **Destination Details** tab, the **Client Name**, **API Key**, and **Instance** are pre-populated from the destination you created. Enter a value in the **Audiences** field to categorise the users this node will send. 4. Under the **Destination Settings** tab, choose the Action and mapping. ![Destination Settings tab with Action and mapping options](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/batch-real-time-destination-integration/batch-real-time-destination-integration-2024-08-07-4.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=2f52f289280a6a5acd937a7bcd297d0a) 5. Click **Save Destination**. The Braze node is now attached to your Journey. ![Journey workflow showing the destination node attached after saving](https://mintcdn.com/zeotap/tJTMnKpQ_XdN4jt3/articles/integrate-customer/Storage/integrate-customer/batch-real-time-destination-integration/batch-real-time-destination-integration-2024-08-07-5.png?fit=max\&auto=format\&n=tJTMnKpQ_XdN4jt3\&q=85\&s=76c70a62f3385b00e3e706feef17f850) ## Supported attributes The following Zeotap Catalogue fields map to Braze fields. **Static Mapping** fields are pre-mapped by Zeotap; **Dropdown selection** fields are chosen from the Catalogue on the mapping screen. | Braze Field | Mapping Type | Description | | :- | :- | :- | | External ID | Dropdown selection | Persistent User Id that Braze uses to track users across devices and platforms. Map User ID to External ID — otherwise Zeotap sends email as user alias. Zeotap recommends mapping the hashed email from the Zeotap Catalogue. | | Email | Static Mapping | Mapped to Email Raw in the Zeotap Catalogue. | | Phone | Static Mapping | Mapped to Mobile Raw. Braze accepts phone numbers in E.164 format only — Zeotap does not transform values, so ingest phone numbers already in that format. See the [Braze phone number guide](https://www.braze.com/docs/user_guide/message_building_by_channel/sms/phone_numbers/user_phone_numbers/). | | First Name | Static Mapping | Mapped to First Name. | | Last Name | Static Mapping | Mapped to Last Name. | | Gender | Static Mapping | Mapped to Gender. | | Custom Event Name | Static Mapping | Mapped to Event Name. Both **Custom Event Name** and **Custom Event Timestamp** must be mapped for a custom event to be processed. See the [Braze event object docs](https://www.braze.com/docs/api/objects_filters/event_object/#event-objects). | | Custom Event Timestamp | Static Mapping | Mapped to Event Timestamp. Required alongside Custom Event Name. | | Email Subscribe | Dropdown selection | Map to an Email Marketing Preference field. Zeotap sends `opted_in` (user has explicitly registered), `unsubscribed` (user has explicitly opted out), or `subscribed` (user has neither opted in nor out). | | Push Subscribe | Dropdown selection | Map to a Push Marketing Preference field. Zeotap sends `opted_in`, `unsubscribed`, or `subscribed` with the same meanings as Email Subscribe. | | Email Open Tracking Enable | Dropdown selection | When set to `true`, adds the open-tracking pixel to all future emails sent to this user. | | Email Click Tracking Enable | Dropdown selection | When set to `true`, enables click tracking on all links in future emails sent to this user. | | Product ID | Dropdown selection | Identifier for a purchase action (Product Name / Product Category). Product ID, Currency, and Price are all required to record a purchase event. See the [Braze purchase object docs](https://www.braze.com/docs/api/objects_filters/purchase_object/). | | Currency | Dropdown selection | Purchase currency. ISO 4217 Alphabetic Currency Code required. | | Price | Dropdown selection | Purchase price. | | Quantity | Dropdown selection | Purchase quantity. | | Country | Dropdown selection | Country attribute. | | City | Dropdown selection | City attribute. | | Language | Dropdown selection | ISO-639-1 code (e.g., `en`). | | Date of Birth | Dropdown selection | Date of birth attribute. | | Custom Attribute | Custom Data Input | Any user attribute — sent to Braze as-is. | ### Example payload structure Zeotap posts to the Braze [`users/track`](https://www.braze.com/docs/api/endpoints/user_data/post_user_track/) endpoint. One request can carry attributes, events, and purchases for a user. A minimal payload shape: ```json theme={null} { "attributes": [ { "external_id": "user_12345", "email": "customer@example.com", "first_name": "Alex", "last_name": "Doe", "email_subscribe": "opted_in" } ], "events": [ { "external_id": "user_12345", "name": "movie_rented", "time": "2025-01-15T14:22:31Z", "properties": { "platform": "web", "year": 2024 } } ], "purchases": [ { "external_id": "user_12345", "product_id": "sku-988", "currency": "USD", "price": 49.99, "quantity": 1 } ] } ``` Each object in `events` requires both `name` (from Custom Event Name) and `time` (from Custom Event Timestamp). Each object in `purchases` requires `product_id`, `currency`, and `price`. ## Verification You have wired the integration correctly when all of the following are true: 1. In the Zeotap CDP app, the Braze destination is listed under **Destinations** and its Journey node shows **Save Destination** completed. 2. After a user qualifies for the Journey, that user is visible in the Braze console — search by **Email ID** or **External ID** on the Braze user dashboard. ![Braze user dashboard showing profile, custom attributes, custom events, and purchases tabs](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/Screenshot_2022-09-26_at_11-08-17_AM.jpeg?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=fa3de667af2474807b0cd6fc236e5b8f) 3. Attributes appear in the expected tab in the Braze user dashboard: * **Profile** tab — user attributes (Email, First Name, Last Name, Gender, and similar). * **Custom Attributes** tab — the custom attributes you mapped. * **Custom Events** tab — custom events (requires both Custom Event Name and Custom Event Timestamp mapped). * **Purchases** tab — purchases (requires Product ID, Currency, and Price all mapped). Once profiles and events are visible in Braze, you can build Braze segments and campaigns against them. Campaigns can be triggered in real-time or on a schedule based on user attributes, custom events, or purchases. ## Troubleshooting If data does not reach Braze, or a specific record type is missing on the user profile, cross-check against the table below. | Symptom / error condition | What it means | Where to look | | :- | :- | :- | | API Key rejected by Braze | The key does not have the `users.track` permission enabled under **User Data**. | Braze Console → **Settings** → **APIs and Identifiers** → **API Keys** — open the key and verify **User Data → users.track** is enabled. | | Custom event not processed by Braze | Either **Custom Event Name** or **Custom Event Timestamp** is not mapped. Braze requires both. | Zeotap Braze destination → mapping screen → **Data To Send** — verify both fields are mapped. | | Purchase event does not go through | **Product ID**, **Currency**, or **Price** is missing from the mapping. All three are required. | Zeotap Braze destination → mapping screen — verify all three purchase fields are mapped. | | Duplicate events in Braze (Method 1) | Event or Purchase attributes are mapped in Zeotap in addition to being captured by the Braze SDK. | Zeotap Braze destination → **Data To Send** — remove Event and Purchase mappings; keep only User traits. | | User arrives as an alias instead of a full profile | **External ID** is not mapped, so Zeotap sends email as user alias. | Zeotap Braze destination → mapping screen — map **External ID** to your User ID (or hashed email). | | Phone number rejected by Braze | Phone number is not in E.164 format. Zeotap does not transform values. | Your source data — re-ingest phone numbers already in E.164 format. | | Requests fail against the wrong REST endpoint | The **Instance** selected in Zeotap does not match your Braze dashboard URL. | Zeotap Braze destination → **Instance** field — match against the [instance table](#identify-your-instance). | > [!TIP] > > If you need to sync a custom Braze object (a row on the user profile with a schema you define) instead of user attributes, events, or purchases, use the **Object Sync in Braze** Journey action on the same destination. ## FAQ > [accordion] Which method should I use if the Braze SDK is already live in my app? > > Use Method 1. Keep the SDK responsible for Event and Purchase capture, and use Zeotap for User traits only. If Zeotap also sends Events or Purchases, Braze records duplicates. > [accordion] Do I need to hash email addresses before sending them to Braze? > > For the Email field, no — Braze accepts raw email and Zeotap maps Email Raw from the Catalogue. For the External ID field, Zeotap recommends the hashed email from the Zeotap Catalogue when you do not have a persistent User ID. > [accordion] Why do my custom events not show up under the Custom Events tab in Braze? > > Braze requires both a Custom Event Name and a Custom Event Timestamp on every event. If either is missing from the Zeotap mapping, the event is not processed by Braze. Verify both fields are mapped on the Braze destination's mapping screen. > [accordion] Can I stream Braze data back into Zeotap? > > Yes — use Braze Currents as a source. See the related pages below. ## Next steps * [Explore Braze (segment-membership flow) →](/articles/integrate-customer/braze-1) * [Explore Object Sync in Braze (Journey Action) →](/articles/integrate-customer/braze-journey-action) * [Explore Braze Currents as a source →](/articles/integrate-customer/braze-currents) * [Explore all source integrations →](/articles/integrate-customer/creating-a-source) # Braze - Object Sync (Journey Action) Source: https://docs.zeotap.com/articles/integrate-customer/braze-journey-action Send a custom Braze object out of Zeotap CDP to a user profile in Braze from a journey, adding, updating or removing rows on an object list as users qualify. ## What this is Object Sync in Braze sends data **out of Zeotap CDP into Braze** in real time: when a user qualifies at a *Send to Destinations* node in a journey, Zeotap adds, updates or removes a custom object on that user's Braze profile. It is an action on the existing Braze destination, not a destination of its own, so it is configured and activated from the journey lane. The object name and schema are fully custom — you define them per use case — so this works for any Braze custom object structure that fits your activation flow. This action lives on the **Mapping** screen of an already-configured Braze destination, so it reuses that destination's credentials — but the Braze REST API key must carry the Data Objects permissions listed under [Prerequisites](#prerequisites), and the Braze workspace must be provisioned for them. If the Braze destination does not exist yet, set it up first in [Braze Integration](/articles/integrate-customer/braze-integration). Related Braze pages: * [Braze Integration](/articles/integrate-customer/braze-integration) — the real-time Braze destination this action belongs to. * [Braze](/articles/integrate-customer/braze-1) — the batch Braze destination, activated from an audience rather than a journey. * [Braze Currents](/articles/integrate-customer/braze-currents) — the opposite direction: Braze engagement events flowing **into** Zeotap CDP as a source. ## Supported identifiers and actions The only identifier this action sends is **External ID**, and mapping it is mandatory — Braze uses it to resolve which user profile to write the object to. Everything else in the mapping is the custom object you define. Each saved mapping performs one operation on the object, chosen under **Additional Settings**: | Operation | What it does on the user profile | Identifier Key | | :- | :- | :- | | Add | Adds the object to the profile. | Not required | | Update | Modifies an existing object on the profile. | Required | | Remove | Deletes an existing object from the profile. | Required | The following table lists the supported features for this action: | Action Name | [ID EXTENSION](/articles/segment-customer/extend-your-audience#id-extension) | [DELETE](/articles/segment-customer/delta-upload-and-delete-functions) | [DELTA UPLOAD](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Object Sync in Braze | - | - | - | This action is triggered from a journey workflow rather than from a segment-membership upload, so the standard ID Extension / Delete / Delta Upload features do not apply. > [!NOTE] > > Object Sync in Braze is enabled for **Journeys** only — it cannot be linked from the Audiences/Segments flow. To send Braze data from an audience instead, use the [batch Braze destination](/articles/integrate-customer/braze-1). ## Prerequisites * **Your Braze workspace is provisioned for Accounts.** Braze calls the objects this action writes **Data Objects**. The feature is generally available, but a workspace has to be provisioned before its API key permissions appear: in Braze, open **Data Settings > Accounts** and complete the questionnaire. See [Braze: Data Objects endpoints](https://braze.com/docs/api/endpoints/custom_objects/). * **The Braze REST API key carries the Data Objects permissions.** Once the workspace is provisioned, these appear under **Settings > API Keys** in Braze. Writing an object to a user profile uses the user-relationship permissions — `data_objects.user_relationships.create` for **Add**, `.update` for **Update** and `.delete` for **Remove**. A key without them is accepted by the destination but the writes fail. * An active **Braze destination** is already configured in Zeotap CDP. If not, follow [Braze Integration](/articles/integrate-customer/braze-integration) first. * You know the **Braze object name** and **schema** you want to sync. The object name and column structure are fully custom and defined by you. * You have a journey (or are creating one) where this action will be triggered. * The rows you want to send are held in an **NCE** ([Non-Customer Entity](/articles/unify-customer/non-customer-entity-data)) or an Object you have already configured in Zeotap, with its attributes available in the Catalogue. * For **Update** or **Remove** operations: you have decided which schema field acts as the **Identifier Key** — the primary key Braze uses to look up the object on the user profile (for example, `permission_id`). ## Create the Object Sync mapping **Step 1** Open your existing Braze destination in **Integrate > Destinations** and switch to the **Mapping** tab. Click **+ New Mapping** to start a new mapping. **Step 2** Under **Choose your Action**, select **Object Sync in Braze**. The dropdown also shows other Journey-enabled Braze actions (such as *Delete User in Braze*); look for the **Journeys** tag. ![The Choose your Action dropdown open on the mapping screen, listing Delete User in Braze and Object Sync in Braze, each carrying a Journeys tag.](https://mintcdn.com/zeotap/_l6Dr_nmSyUwEK1e/articles/integrate-customer/Storage/integrate-customer/braze-journey-action/braze-journey-action-action-dropdown.png?fit=max\&auto=format\&n=_l6Dr_nmSyUwEK1e\&q=85\&s=85316ad95c345d492e63bc999ed8e4a7) **Step 3** Under **Map the Fields**, map a Catalogue attribute to the **External ID** destination field. This mapping is **mandatory** — Braze uses this value to identify the user profile to update. In the example below, the Catalogue attribute `AccountID` is mapped to `External ID`. ![The Map the Fields step with the Catalogue attribute AccountID mapped to the External ID destination field, which is flagged as required.](https://mintcdn.com/zeotap/_l6Dr_nmSyUwEK1e/articles/integrate-customer/Storage/integrate-customer/braze-journey-action/braze-journey-action-external-id.png?fit=max\&auto=format\&n=_l6Dr_nmSyUwEK1e\&q=85\&s=410483414440a8fa7bee746d88dd4aee) **Step 4** Click **+ Add Mapping Field** to add the custom object. In the new row: a. Enter the **object name** in the destination field (for example, `permission_meta`). This is the name Braze will store the object under on the user profile. b. Set the row type to **List of Object** using the dropdown on the right. c. Choose the parent object on the left — the NCE or Object you have configured in Zeotap that holds the rows you want to send. ![A new mapping row with the destination key permission_meta set to the List of Object type, and an empty child row below it prompting for a Catalogue attribute and a key name.](https://mintcdn.com/zeotap/_l6Dr_nmSyUwEK1e/articles/integrate-customer/Storage/integrate-customer/braze-journey-action/braze-journey-action-add-mapping-field.png?fit=max\&auto=format\&n=_l6Dr_nmSyUwEK1e\&q=85\&s=80a729ed5f27a5a2c6c12b19106d62b3) **Step 5** Build the **schema** field-by-field under the parent object. For each schema field, map the corresponding NCE / Object attribute on the left to the destination key name on the right. In the example below the schema has four fields: `permission_id`, `action_id`, `status`, and `updated_at`. ![The permission_meta object expanded into four child rows mapping Catalogue attributes to the destination keys permission_id, action_id, status and updated_at.](https://mintcdn.com/zeotap/_l6Dr_nmSyUwEK1e/articles/integrate-customer/Storage/integrate-customer/braze-journey-action/braze-journey-action-schema-mapped.png?fit=max\&auto=format\&n=_l6Dr_nmSyUwEK1e\&q=85\&s=06f6e8a5a6294b894c2290cf28488c62) > [!NOTE] > > The object name (for example, `permission_meta`) and the schema fields are fully customer-defined. Choose whatever names and types fit your Braze setup — Zeotap forwards the structure as-is. > > Destination key names are case-sensitive and must match the object schema in Braze exactly. **Step 6** For any **timestamp** field in the schema, use the **Timestamp Transformer** enricher so the value reaches Braze in the format Braze expects. Click the enricher icon next to the timestamp field; in the **Data Enricher** panel, choose **Timestamp Transformer** under *Choose the Enricher*, pick the attribute to reformat under *Choose Source Timestamp Attribute*, select the format `yyyy-MM-dd'T'HH:mm:ssX` under *Output Format*, and click **Save**. ![The Data Enricher panel, with Choose the Enricher set to Timestamp Transformer, a Choose Source Timestamp Attribute selector, and Output Format set to the ISO-8601 pattern.](https://mintcdn.com/zeotap/QLfKzaD9SU6BbWg_/articles/integrate-customer/Storage/integrate-customer/braze-journey-action/braze-journey-action-timestamp-enricher.png?fit=max\&auto=format\&n=QLfKzaD9SU6BbWg_\&q=85\&s=e38b1090a90827cfe97df6dce62bead5) For the other enricher types available on a mapping, see [Enrichers in Destination Mapping](/articles/segment-customer/enrichers-in-destination-mapping). **Step 7** Under **Additional Settings > Action Name**, choose the operation to perform on the Braze object: **Add**, **Update**, or **Remove**. * **Add** — adds the object to the user profile. No further configuration needed; click **Save Mapping**. ![Additional Settings with Action Name set to Add and the Identifier Key field left empty.](https://mintcdn.com/zeotap/_l6Dr_nmSyUwEK1e/articles/integrate-customer/Storage/integrate-customer/braze-journey-action/braze-journey-action-action-add.png?fit=max\&auto=format\&n=_l6Dr_nmSyUwEK1e\&q=85\&s=0b48e123ebaed47ed6122573ef401f77) * **Update** or **Remove** — modifies or deletes an existing object on the user profile. You must also fill in the **Identifier Key** field with the schema field that acts as the object's primary key in Braze (for example, `permission_id`). Click **Save Mapping**. ![Additional Settings with Action Name set to Update and the Identifier Key field filled in with permission_id.](https://mintcdn.com/zeotap/_l6Dr_nmSyUwEK1e/articles/integrate-customer/Storage/integrate-customer/braze-journey-action/braze-journey-action-action-update.png?fit=max\&auto=format\&n=_l6Dr_nmSyUwEK1e\&q=85\&s=aae687079fc0eff074e567ae4fa4219d) > [!WARNING] > > **Update** and **Remove** require an **Identifier Key**. Without it, Braze cannot determine which row in the object list to modify or delete. The Identifier Key must match the name of one of the fields you defined in the schema in the previous step, including its capitalisation. ## Add the destination to a journey Once the mapping is saved, attach it inside a journey workflow: **Step 1** Open your journey in **Orchestrate > Journeys**. At the point in the workflow where you want the object to fire, click **+** and choose **Send to Destinations**. **Step 2** Search for and select your Braze destination. Pick the **Object Sync in Braze** mapping you just created. **Step 3** Click **Save Destination**. The Object Sync action now fires for every user who reaches that node in the journey, with the operation (Add / Update / Remove) you configured in the mapping. ## Verify the sync Check the mapping before it goes live, then confirm delivery from both sides once the journey runs. **Before you save the mapping.** Click **Generate Preview** on the mapping screen to produce a [sample payload](/articles/integrate-customer/payload-preview-for-destination-mappings) and read it back. A correctly built Object Sync mapping shows the External ID, the object as a nested array, and a populated value for every schema field — including the timestamp produced by the enricher. A field that comes through empty is usually a mapping or data-type problem you can fix before activating. **After the journey runs.** The *Send to Destinations* node on the journey canvas carries success and error counts. Open the node to read the [Execution Details panel](/articles/orchestrate-customer/identify-journey-errors) for a failing delivery, and use [Journey Traces](/articles/orchestrate-customer/journey-traces) to inspect the output event that was actually sent for a single user. **In Braze.** Open a user profile that passed through the node and confirm the custom object is present with the rows and field values you expect. ## Troubleshoot Object Sync | Symptom | What it usually means | What to do | | :- | :- | :- | | The node reports `BAD_REQUEST`, or a message about mandatory fields missing or the request body not being created properly | This is the generic label shown whenever the destination rejects the request. It does not necessarily mean a field is missing from your event — the real reason is in the response the destination returned. | Open the failing node and read the delivery in [Journey Traces](/articles/orchestrate-customer/journey-traces) to see the output event that was sent. See [Journey Error Codes](/articles/orchestrate-customer/journey-error-codes) for the full code reference. | | Most users on the node succeed, a consistent minority fail | If the object list is built with a filter, a user for whom the filter matches no rows produces a payload carrying only the External ID. Braze rejects a request that holds no attributes beyond the identifier. | Review the filter criteria on the object attribute against the events the journey actually delivers, so that only users with rows to sync reach the node. | | The Update or Remove delivery succeeds, but the object on the profile is unchanged — or a second row appears instead | The **Identifier Key** does not match a destination key name in the schema. Braze then cannot locate the row to change. | Re-open the mapping and compare the Identifier Key against the key names under **Map the Fields**, character for character including case. | | The whole object is missing from the profile although every field is mapped | One field in the object is resolving to an invalid or empty value. Braze can reject the entire nested update rather than just the offending field. | Click **Generate Preview** and confirm every schema field in the resulting [payload preview](/articles/integrate-customer/payload-preview-for-destination-mappings) is populated and of the expected type, paying particular attention to timestamps. | If the failure does not match any row above, or the destination confirms it received nothing while Zeotap reports a successful delivery, raise a support ticket with the journey, the destination and the mapping you are using, the timestamp of the failing run, and the exact error text from the node. ## Next steps * [Set up the Braze destination this action runs on →](/articles/integrate-customer/braze-integration) * [Bring Braze engagement events back into Zeotap CDP →](/articles/integrate-customer/braze-currents) * [Understand Object, List of Objects and NCE support in destination upload →](/articles/segment-customer/object-list-of-objects-and-nce-support-in-destination-upload) * [Customise fields with Enrichers in Destination Mapping →](/articles/segment-customer/enrichers-in-destination-mapping) * [Preview a destination payload before activating →](/articles/integrate-customer/payload-preview-for-destination-mappings) # Brevo Source: https://docs.zeotap.com/articles/integrate-customer/brevo Send contacts from a Zeotap CDP journey into a Brevo contact list in real time. ## What this is The Brevo destination sends contact data **out of** Zeotap CDP and into a Brevo contact list in real time. Each time a customer reaches a **Send to Destinations** node in a journey, Zeotap appends that customer to the Brevo list you nominated, so an email or SMS audience in Brevo stays in step with journey activity without any file export. Zeotap CDP ships two separate Brevo destinations, and the destination catalogue lists both: * **Brevo** — this page. Real time, attached to a journey, appends contacts to one Brevo list. * **[Sendinblue (Brevo)](/articles/integrate-customer/brevo-sendinblue)** — batch, attached to an audience, pushes a list (segment) into a Brevo folder. Brevo was formerly called Sendinblue, and both names still appear in the Zeotap CDP catalogue and in the Brevo console. Zeotap CDP's [integrations list](/articles/integrations-master-list-publication/integrations-master-list) records this vendor as a Destination only, so no data flows from Brevo into Zeotap CDP and there is no opposite-direction Brevo Source page. ## Supported identifiers and actions | Item | Detail | | - | - | | Action | **Send Contacts to Brevo** | | Required identifier | Raw email address, mapped to Brevo's **Email** field | | Additional attributes | Catalogue attributes such as last name, first name and phone number, plus any custom attributes you have already created in Brevo | | Delivery | Real time, per customer, as the journey runs | | Target | A single Brevo contact list, identified by its list ID | ## Prerequisites In Zeotap CDP: * An active account with permission to create and edit destinations. For the wider destination model, see [Destinations](/articles/integrate-customer/destinations). * A journey you can edit, so the destination has somewhere to be attached. See [Create a workflow](/articles/orchestrate-customer/create-a-workflow). * The customer data or events you intend to send, available in the Catalogue. In Brevo: * An active Brevo account with API access. * Permission to generate API keys in that account. * At least one contact list created, and its list ID to hand. ## Get your Brevo API key and list ID Both values come from the Brevo console, before you touch Zeotap CDP. **Step 1** Sign in to your Brevo account at [app.brevo.com](https://app.brevo.com/). **Step 2** Open your account settings from the profile menu in the top-right corner, and go to the **API Keys** section. **Step 3** Click **Generate a new API key**, give the key a descriptive name (for example, `Zeotap Integration`), and click **Generate**. ![Brevo dialogue titled Generate a new API Key, with a Name your API key field and a Generate button](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/brevo-sendinblue/image-1.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=e5f4d18ab4c62716252ae85e20dce249) Brevo's Generate a new API Key dialogue, with a name field and Cancel and Generate buttons **Step 4** Copy the key and store it somewhere safe. Brevo's confirmation dialogue, which states that the key cannot be shown again and offers a copy control > [!WARNING] > > Brevo shows the key once. Once you close this dialogue you cannot view it again — you would have to generate a replacement key. **Step 5** Go to **Contacts → Lists**, find the list you want Zeotap to append contacts to, and note its **ID**. ![Brevo Lists table with columns for Lists, ID, Folder, Contacts, Creation date and Actions](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/brevo-sendinblue/image-3.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=c66db4fcb02de8ec9e4060cb47c039b7) Brevo's Lists table, showing the ID column alongside folder, contact count and creation date > [!NOTE] > > The sibling [Sendinblue (Brevo)](/articles/integrate-customer/brevo-sendinblue#get-a-brevo-api-key) destination documents that a Brevo API key only works when its user-data permissions are enabled. If an existing key is rejected, generate a fresh one rather than editing the old one. ## Create the Brevo destination **Step 1** Sign in to the Zeotap CDP app, go to **Integrate → Destinations**, and click **+ Create Destination**. ![Zeotap CDP Integrate Destinations screen listing existing destinations, with the Create Destination button highlighted](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/brevo-sendinblue/image-4.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=8fd6875952ddab3731b5fdc8624197e4) The Zeotap CDP Destinations screen, with the Create Destination button highlighted **Step 2** Under **All Destinations**, use the search box to find Brevo. ![Zeotap CDP All Destinations catalogue showing destination tiles and a search box](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/brevo-sendinblue/image-5.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=54dbc99e47c1eef46faabd94897c5cf2) The All Destinations catalogue with its search box highlighted **Step 3** Click the **Brevo** tile. The search returns two tiles for this vendor. Pick **Brevo** for real-time journey delivery; **Sendinblue (Brevo)** is the batch destination covered on [its own page](/articles/integrate-customer/brevo-sendinblue). ![Destination search results showing a highlighted Brevo tile next to a Sendinblue (Brevo) tile](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/brevo-sendinblue/image-6.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=fc35ddc65651dd5d8fe8bd29fa820405) Search results showing two separate tiles for this vendor, Brevo and Sendinblue (Brevo), with the Brevo tile highlighted **Step 4** On the **Destination Details** tab, enter: * **Destination Name** — a name that identifies this destination later, when you pick it from a journey. * **Brevo API Key** — the key you generated above. ![Zeotap CDP Destination Details tab showing a Destination Name field and a Brevo API Key field, alongside a Mapping tab](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/brevo-sendinblue/image-7.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=ee80338c406a9085e43eea1fcad9f098) The Destination Details tab, with the Destination Name and Brevo API Key fields The list ID is not entered here — you supply it per journey, when you attach the destination. **Step 5** Choose the action and define the mapping. Under **Choose your Action**, select **Send Contacts to Brevo**. Under **Map the Fields**, map the Catalogue fields you want to send to the matching Brevo contact attributes. The email identifier is mandatory; everything else is optional. ![Zeotap CDP mapping screen with Send Contacts to Brevo selected, and the Catalogue fields Email Raw and Last Name mapped to the Brevo Email and LASTNAME fields](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/brevo-sendinblue/image-8.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=5116f0fb64fb25f58cc5b7b9f07650d3) The Choose your Action and Map the Fields screen, mapping Catalogue fields to Brevo contact attributes A Brevo contact attribute must already exist in Brevo before it appears as a destination field here, and Brevo attribute names are entered in capitals. To create one, see [Appendix for Sendinblue](/articles/integrate-customer/appendix-for-sendinblue#add-custom-attributes). For the rules that govern actions and mappings across every destination, see [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). **Step 6** Review the values and save the destination. It is then available to any journey in the workspace. ## Attach the destination to a journey Creating the destination stores the credentials; it does not send anything on its own. Data starts flowing once you attach the destination to a **Send to Destinations** node. **Step 1** In the journey canvas, click **+** at the point where you want the delivery to happen, and choose **Send to Destinations**. ![Journey canvas Choose an action menu listing Add a Condition, Add a Delay, the two split types and Send to Destinations, with Send to Destinations highlighted](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/brevo-sendinblue/image-9.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=f5401cc9b415b70566828645d931ab23) The Choose an action menu on the journey canvas, with Send to Destinations highlighted **Step 2** Search for the Brevo destination you created, and select it. ![Send to Destinations panel showing a search box, an Add New Destination link and cards for the destinations available to the journey](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/brevo-sendinblue/image-10.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=56c452eb3f46ed8724b36ad42b2da2a7) The Send to Destinations panel, with its search box highlighted above the available destination cards **Step 3** On the **Destination Details** tab, the destination name and API key are pre-filled from the destination you created. Enter the **List ID** of the Brevo list the contacts should be appended to. ![Journey-level Brevo panel with pre-filled Destination Name and Brevo API Key fields above a highlighted List ID field and a Save Destination button](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/brevo-sendinblue/image-11.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=4579b3844b5554148c555ed44b8eca80) The journey-level Destination Details tab, where the pre-filled destination fields sit above the List ID field The list ID is a journey-level input, so one destination can feed a different Brevo list from each journey that uses it. **Step 4** On the **Destination Settings** tab, confirm the action and mapping are the ones you want for this journey. **Step 5** Click **Save Destination**. The destination is attached to the node, showing the action it will perform. ![Send to Destinations panel with an attached Brevo card labelled Send Contacts to Brevo, above the remaining available destinations and an Add Destinations button](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/brevo-sendinblue/image-12.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=a1bf48c38018811771a0e7f85a5aa54c) The Send to Destinations panel after saving, with the Brevo destination attached to the node ## Verify contacts reach Brevo Check both sides once the journey has run. 1. **In Zeotap CDP** — open the journey and read the counts on the **Send to Destinations** node. Successful deliveries and failures are counted separately at node level, so a node with a non-zero success count is delivering. For a per-customer view of what was sent, see [Journey traces](/articles/orchestrate-customer/journey-traces). 2. **In Brevo** — go to **Contacts → Lists**, open the list whose ID you entered on the journey node, and confirm the expected contacts are present. If the two counts do not match, open the journey trace for the affected customers before assuming the list is complete. ## Troubleshoot delivery failures When a delivery fails, Zeotap CDP records a failure status code on the node rather than a Brevo-specific message. Start with the journey trace logs, which carry the raw response from Brevo alongside the code. The codes most likely to appear on this destination are: * `AUTHENTICATION_ERROR` — the Brevo API key on the destination is no longer valid, or it lacks the permissions the integration needs. Generate a fresh key in Brevo and update the destination. * `BAD_REQUEST` — a required field was missing or empty in the payload. Check that the email identifier is mapped and never null before investigating anything else. * `EVENT_PARSING_FAILED` — the mapping and the Brevo attribute disagree. Confirm the attribute exists in Brevo and that its type matches the Catalogue field you mapped to it. If every customer fails at the node, the cause is usually authentication or mapping. If only a small share fail, look at consent or data quality on the affected records instead. For the full code reference and the resolution steps for each, see [Journey error codes](/articles/orchestrate-customer/journey-error-codes) and [Troubleshooting workflows](/articles/orchestrate-customer/journey-troubleshooting). ## FAQ > [accordion] Why are there two Brevo entries in the destination catalogue? > > They are two different integrations for the same vendor. **Brevo** — this page — is a real-time destination: you attach it to a journey and it appends contacts to a single Brevo list as customers flow through. **Sendinblue (Brevo)** is a batch destination: you attach it to an audience and it pushes the whole list (segment) into a Brevo folder. Choose the one that matches where you are activating from, Journeys or Audiences. > [accordion] Where do I enter the list ID — on the destination or on the journey? > > On the journey. The destination itself stores only the destination name and the Brevo API key; the **List ID** field appears when you attach the destination to a **Send to Destinations** node. One Brevo destination can therefore feed a different list from each journey that uses it. > [accordion] Does this replace the contacts already in the Brevo list? > > No. Contacts are appended to the list you name. Existing contacts stay in place, and a contact Brevo already holds is updated rather than duplicated. ## Next steps * [Set up the batch Sendinblue (Brevo) destination →](/articles/integrate-customer/brevo-sendinblue) * [Add custom attributes in Brevo →](/articles/integrate-customer/appendix-for-sendinblue#add-custom-attributes) * [Build the journey that feeds this destination →](/articles/orchestrate-customer/create-a-workflow) * [Debug a delivery with journey traces →](/articles/orchestrate-customer/journey-traces) * [Review how destinations, actions and mappings fit together →](/articles/integrate-customer/destinations) # Sendinblue (Brevo) Source: https://docs.zeotap.com/articles/integrate-customer/brevo-sendinblue Send Zeotap CDP audiences out to Sendinblue (Brevo) as contact Lists inside a Brevo Folder, using raw email addresses and custom attributes. ## What this is The Sendinblue (Brevo) destination sends data **out of Zeotap CDP to Brevo**: an audience built in Zeotap CDP is delivered to Brevo as a List of contacts inside a Folder that you nominate. Nothing flows back from Brevo into Zeotap CDP. Brevo — formerly Sendinblue — is a marketing automation platform that offers email marketing, SMS marketing, chat, CRM and automation features to help businesses engage with their audience effectively. Integrated with Zeotap CDP, it enables you to create Lists (segments) and activate them on Sendinblue (Brevo). For example, as a marketer you can use this integration to push a list of customers who signed up for an early-bird programme into Brevo, so you can tell them about the upcoming offering in the months that follow and keep them engaged and up to date. > [!NOTE] > > This page covers the **batch** destination, where a Zeotap audience is delivered to a Brevo List. Brevo also has a real-time destination that adds a user to a Brevo contact list from a journey as events occur — see [Brevo](/articles/integrate-customer/brevo). Both are outbound; there is no Sendinblue (Brevo) source page to pair with this one. The two names refer to the same vendor, which is why the product appears in the docs under both **Sendinblue (Brevo)** and **Brevo**. ### Key concepts ![Brevo Contacts screen with annotations pointing to a Folder in the list picker, a List inside that folder, and a single contact row in the contacts table.](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/brevo-sendinblue/brevo-sendinblue-2024-05-06.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=8d4551f4705c0dd294087d6475502036) * **Folders** in Sendinblue (Brevo) are the containers that store the Lists (segments). A Zeotap destination writes into one Folder, which you name when you create the destination. * **Lists** are the segments or cohorts of customers created in the Zeotap CDP Audiences module and then pushed into a Folder on the Sendinblue (Brevo) platform. * **Contacts** are the individual people in Brevo. For this integration, these are email addresses. ## Supported identifiers and actions This integration supports email addresses and custom attributes. The following table lists the available action types for the integration and the supported features for each action type: | Action name | [ID extension](/articles/segment-customer/extend-your-audience#id-extension) | [Delete](/articles/segment-customer/delta-upload-and-delete-functions) | [Delta upload](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send identifiers to Sendinblue (Brevo) | ✅ | - | - | | Send attributes to Sendinblue (Brevo) | - | - | - | * **Send identifiers to Sendinblue (Brevo)** sends raw email addresses. * **Send attributes to Sendinblue (Brevo)** sends raw email addresses together with any custom attributes you map. ## Prerequisites * An active account on Sendinblue (Brevo). * A Brevo **API key** with user data permissions enabled — see [Get a Brevo API key](#get-a-brevo-api-key). * The name of the Brevo **Folder** that you want Zeotap to write into. Segments and cohorts of customers are stored in a folder structure in Brevo. * For the **Send attributes to Sendinblue (Brevo)** action, the custom attributes you intend to map must already exist on the Brevo platform. See [Add custom attributes](/articles/integrate-customer/appendix-for-sendinblue#add-custom-attributes). * An audience defined in Zeotap CDP, plus the upstream setup every destination needs — see [Destinations prerequisites](/articles/integrate-customer/destinations#prerequisites). ## Get a Brevo API key The API key is the key associated with the Sendinblue (Brevo) account to which Zeotap sends data. You can find it in the Sendinblue (Brevo) console under your account menu (top right) → **SMTP & API** → **API Keys**. The user data permissions need to be enabled for the API key to work. If your existing API key does not have these permissions, create a new key: **Step 1** Log into the Sendinblue (Brevo) console. **Step 2** Under your profile details, click **SMTP & API**. ![Brevo home screen with the account menu open and the SMTP & API entry highlighted.](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/brevo-sendinblue/brevo_api.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=64c2cb38dbac6a0ecad763c0e073ba5e) **Step 3** In the new screen, go to the **API Keys** tab and then click **Generate a new API key**. ![Brevo SMTP & API page on the API Keys tab, listing existing keys by version, name and creation date, with the Generate a new API key button highlighted.](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/brevo-sendinblue/brevo_2_backup.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=3aed17060a5dc5f9bbc8829c374463e1) **Step 4** A window appears where you enter a name for the API key you want to generate. Once entered, click **Generate**. ![Brevo dialog titled Generate a new API Key, with a Name your API key field and Cancel and Generate buttons.](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/brevo-sendinblue/brevo_3.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=e130ebbcc448dc3f5a63dbe87f9ac314) **Step 5** Copy the API key that is displayed on the screen and store it somewhere safe. Once you exit this window, Brevo does not show the key again. > [!WARNING] > > This is the only time Brevo displays the key. If you lose it, generate a new key rather than trying to retrieve the old one. ## Create the Sendinblue (Brevo) destination **Step 1** Log into the Zeotap CDP app and go to **Integrate** → **Destinations**. **Step 2** Click **+ Create Destination**. ![Zeotap CDP Destinations list on the Private Destination tab, with a search box, a table of existing destinations, and the + Create Destination button highlighted.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/ADOBE_DMP_3.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=50d0558618336ceb78709191fcdda472) **Step 3** Under **All Destinations**, search for **Sendinblue (Brevo)**. ![Zeotap CDP All Destinations catalogue showing destination tiles, with the Search for a Destination box highlighted.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/ADOBE_DMP_4.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=a0de06ff7f37752957c9f44c072aaebd) **Step 4** Click **Sendinblue (Brevo)**. A screen appears with details about the destination on the left and the fields required for the integration on the right. Enter the details: a. Enter a name for the destination. b. Enter the **API KEY**. For how to obtain it, see [Get a Brevo API key](#get-a-brevo-api-key). c. Enter the **Folder Name** that you want Zeotap to access for sending data. Segments and cohorts of customers are stored in a folder structure in Brevo. d. Review the values you entered and click **Next**. ![Zeotap CDP Enter Destination Details step for Sendinblue (Brevo), with Destination Name, API KEY and Folder Name fields and a Next button.](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/brevo-sendinblue/brevo_1.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=f9da98a205cbcd6fd14f361ece80f069) **Step 5** On the **Mapping** step, choose the [action](/articles/integrate-customer/destinations#configure-a-destination) and the [mapping](/articles/integrate-customer/destinations#define-the-mapping). Under **Choose your Action**, select either **Send identifiers to Sendinblue (Brevo)** or **Send attributes to Sendinblue (Brevo)** as the action for activating your audiences or segments. a. **Send identifiers to Sendinblue (Brevo)** lets you send raw email addresses to Sendinblue (Brevo). ![Zeotap CDP mapping step with the Send identifiers to Sendinblue (Brevo) action selected and Email Raw chosen as the output identifier.](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/brevo-sendinblue/brevo-sendinblue-2024-05-06-1.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=fe2e052a6537435a83dad882cbf5f850) b. **Send attributes to Sendinblue (Brevo)** lets you send raw email addresses and any custom attributes to Sendinblue (Brevo). Before pushing an audience or segment with custom attributes, add the required custom attributes on the Sendinblue platform; they then appear under **Map the Fields**, as shown below. See [Add custom attributes](/articles/integrate-customer/appendix-for-sendinblue#add-custom-attributes). ![Zeotap CDP mapping step with the Send attributes to Sendinblue (Brevo) action selected and a Map the Fields table pairing Catalogue fields with Brevo destination fields such as EMAIL, FIRSTNAME, LASTNAME and SMS.](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/brevo-sendinblue/brevo-sendinblue-2024-05-06-2.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=b4e828f0ab1ff1076b4eaa1f77e362da) **Step 6** Click **Create Destination**. The created destination is listed in the Audiences application, where it can be linked to an audience or segment. > [!NOTE] > > **Working with the Actions and Mapping screen for Sendinblue (Brevo):** > > * In Sendinblue, Text-type attributes are used to store simple textual values. Ensure that a Text-type attribute under the Destination Field is mapped only against text under the Catalogue Field. For example, you can map gender under Catalogue Field against a text-type attribute under Destination Field. > * Zeotap CDP currently does not support Date-type attributes under Destination Field. > * In Sendinblue, Number-type attributes are used to store number values written in decimals. Ensure that a Number-type attribute under the Destination Field is mapped only against number under the Catalogue Field. > * In Sendinblue, you can add categories under Category Configuration. Ensure that the categories added under the Category-type attribute are exactly replicated under Destination Field for successful mapping. > * In Sendinblue, a Boolean-type attribute stores one of two possible values: Yes or No. Ensure that the Catalogue attribute corresponds to a yes or no value when it is mapped against a Boolean-type attribute under Destination Field. > * A Zeotap Catalogue attribute can be mapped only once. Once a Catalogue attribute is mapped, it cannot be mapped again against another attribute under Destination Field. ## Link an audience to the destination For how to link an audience or segment to the created destination in the **Audiences** application, see [Activate your batch audiences](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience or a segment can be a specific group of customers who are over 18 years of age and have performed an `addToCart` event within the last 30 days. ## Verify the list in Sendinblue (Brevo) To view the Lists that Zeotap pushed to the Sendinblue (Brevo) platform, log into the Sendinblue (Brevo) console and follow these steps: **Step 1** Navigate to **Contacts** → **Load a list or a segment** → **Lists**. This shows the folders that contain the contacts. ![Brevo Contacts screen with the Load a list or a segment picker open on the Lists tab, showing a set of folders.](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/brevo-sendinblue/brevo_6.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=a4944850ce94612de3954de9ed0e5150) **Step 2** Under **Lists**, either search for the List you want in the search bar, or navigate through the folder structure to it if you know where it sits. **Step 3** Select the List. A screen appears with the details of its contacts (email addresses). ![Brevo Contacts screen with a List selected, showing the contact count and a table of contacts with EMAIL, LASTNAME, FIRSTNAME and SMS columns.](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/brevo-sendinblue/brevo_7.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=88b0bfdf39dc956c2e9e73956ccd5086) ## Next steps * [Add custom attributes and columns in Sendinblue (Brevo) →](/articles/integrate-customer/appendix-for-sendinblue) * [Send data to Brevo in real time from a journey →](/articles/integrate-customer/brevo) * [Understand how destinations, actions and mappings fit together →](/articles/integrate-customer/destinations#configure-a-destination) * [Check why a destination delivery failed →](/articles/integrate-customer/destinations#why-deliveries-fail) # Channable GCS Upload Source: https://docs.zeotap.com/articles/integrate-customer/channable-gcs-upload Deliver Zeotap CDP audiences as CSV files to your Google Cloud Storage bucket, then import them into Channable. The Channable GCS Upload destination sends audience data **out of Zeotap CDP** to a Google Cloud Storage (GCS) bucket you own, as CSV files, which you then import into your Channable instance. Data moves in one direction only — nothing flows from Channable, or from your bucket, back into the CDP. Channable's other Zeotap integration, [Channable Real Time Integration](/articles/integrate-customer/channable-real-time-integration), is also outbound: it sends stock updates to Channable from a journey in real time instead of writing CSV files to a bucket. Channable appears in the [integrations master list](/articles/integrations-master-list-publication/integrations-master-list) as a destination only, so there is no Channable source page to pair this one with. ## What this is Channable is a feed management and automation platform that helps businesses streamline their product data for eCommerce, marketplaces, and advertising channels. It enables users to optimise, transform, and distribute product feeds to multiple platforms such as Google Shopping, Amazon, and Meta Ads — all from a single interface. This integration is a two-hop delivery. Zeotap CDP writes the audience to your Google Cloud Storage bucket as CSV, and Channable imports the CSV from that bucket. You configure the destination once against a bucket and folder, then reuse it for every audience you link to it. If you want the same CSV delivery into a bucket without the Channable import on the other side, use the [Google Cloud Storage destination](/articles/integrate-customer/google-cloud-storage) instead. > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an Audience or a segment could be a specific group of customers who are over 18 years of age and who have performed an `addToCart` event within the last 30 days. ## Supported action and mandatory fields This destination has a single action — **Send data to Channable** — which you choose on the **Actions and Mapping** screen when you activate an audience. The following fields are mandatory and must be mapped: * Availability * Brand * Description * ID * Image Link * Link * Price * Product Type * Sale Price * Size * Title Click **+ Add Mapping Field** to include additional fields. For the full set of fields Channable accepts on an import, see [Requirements for import files](https://helpcenter.channable.com/hc/en-us/articles/360011048779-Requirements-for-import-files) in the Channable help centre. For how mapping works across destinations, see [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). ## Prerequisites Before you create a Channable GCS Upload destination in Zeotap CDP, make sure you have: * An active **Channable** account. * A **Google Cloud Storage** bucket you can write to, plus the **bucket** name and the **folder** path inside it where files should land. * The authentication you intend to use under **Account** — either the **Zeotap Service Account** (which you whitelist on your bucket) or a **client service account JSON** file you upload during configuration. * An audience to activate, and the destination rights described in the [Destinations prerequisites](/articles/integrate-customer/destinations#prerequisites). ## Where each detail appears in Google Cloud Storage Gather the following details from your Google Cloud Storage account before you create the destination. ### Bucket This is the name of your Google Cloud Storage bucket. You can obtain it from your Google Cloud Storage account, as shown below. ![Bucket details page in the Google Cloud Storage console, with the bucket name highlighted above the Location, Storage class and Public access fields](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/gcs_bucket.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=27a98eddfc923035a9733033c5c0fc10) ### Folder In Google Cloud Storage, a folder serves as a logical container for organising stored objects within a bucket. In reality, there are no actual folders in Google Cloud Storage. Instead, the folder concept is emulated by employing object key names containing slashes ("/") to replicate a hierarchical arrangement. You can obtain this information from your Google Cloud Storage account, as shown below. ![Objects tab of a bucket in the Google Cloud Storage console, with the folder name highlighted in the breadcrumb above the folder browser](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/gcs_folder.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=ee827f65a647fe9656d55c7b3a13717c) ### Account This is the identity Zeotap CDP uses to write into your bucket. You choose it on the destination configuration screen: * **Zeotap Service Account** — the service account Zeotap provides. Whitelist it on your bucket so Zeotap CDP can push audiences (segments) to Google Cloud Storage. * **Client Service Account Json** — a service account you manage. You upload its JSON key during configuration. ## Create the Channable GCS Upload destination **Step 1** Log into the Zeotap CDP App and go to the **DESTINATIONS** application. **Step 2** Click **+ Create Destination**. ![Destinations listing in Zeotap CDP with the Create Destination button highlighted above the destination table](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/ADOBE_DMP_3_\(1\).png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=562fa59a1a1e2b76442fa98f6e6f991e) **Step 3** Under the **All Destinations** section, search for **Channable GCS Upload**. ![All Destinations catalogue in Zeotap CDP with the Search for a Destination box highlighted above the destination tiles](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/ADOBE_DMP_4_\(1\).png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=653728565c7ed5863548171765d4086f) **Step 4** Click **Channable GCS Upload**. A screen appears displaying details about the particular destination towards the left. On the right-hand side of the screen find a list of fields that are required for the integration to be established. Provide the required details as mentioned in the following steps: a. Enter a name for the Destination. Choose a name that identifies the bucket and folder it delivers to, so the destination is easy to find when you link an audience. b. In the **Destination Instance Name** field, provide a value of your choice. c. In the **Bucket** field, provide the name of the Google Cloud Storage Bucket. d. In the **Folder** field, provide the folder path in your storage location where Zeotap CDP can store your exported data. > [!NOTE] > > Provide the folder path using the structure `folder_name/sub_folder_name/`. e. Under **Account,** choose either **Zeotap Service Account** or **Client Service Account Json** using the drop-down menu, based on the type of authentication you need. ![Account drop-down open in Zeotap CDP showing the Zeotap Service Account and Client Service Account Json options](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/google-cloud-storage-2024-05-08.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=4035a760431f47f9e2282dd46a2e57d4) i. If you choose **Zeotap Service Account**, the service account Zeotap will use auto-populates under **Service Account to be Whitelisted**. Whitelist it on your bucket in Google Cloud so that Zeotap CDP can push the audiences (segments) to Google Cloud Storage. ![Account field set to Zeotap Service Account in Zeotap CDP, with the read-only Service Account to be Whitelisted field shown beneath it](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/google-cloud-storage-2024-05-08-1.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=80b9f59a37bb2c7b8b83268ea131378a) ii. If you choose **Client Service Account Json**, upload the JSON file with the required authentication information using the **+ Select File** option, so that Zeotap CDP can push the audiences to Google Cloud Storage. ![Account field set to Client Service Account Json in Zeotap CDP, with an Upload Service Account drop zone and a Select File button](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/google-cloud-storage-2024-05-08-2.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=a5bc85536732956d054503de1b2bc797) f. Review all the values entered above and then click **Next** to proceed. ![Enter Destination Details step in Zeotap CDP with the Destination Name, Destination Instance Name, Bucket, Folder and Account fields completed and the Next button at the bottom right](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/looker/looker-2025-09-03.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=ad10ea788c69e1580c5a437f3348047a) **Step 5** In the new screen that appears, choose **Send data to Channable** under **Choose your Action**, then map the fields under **Map the Fields**. Map every mandatory field listed in [Supported action and mandatory fields](#supported-action-and-mandatory-fields) above. ![Mapping screen in Zeotap CDP with Send data to Channable selected under Choose your Action and the Catalogue Field and Destination Field columns under Map the Fields](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/channable-gcs-upload/channable-gcs-upload-2025-10-16.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=344b51d0bfacecd820e3f57667ec9fd2) **Step 6** After finalising the attributes and identifiers to send, click **Create Destination**. The created Destination gets listed in the Audiences application, which can be linked to an audience. For the two entry points into destination configuration and what each part of the configuration does, see [Configure a destination](/articles/integrate-customer/destinations#configure-a-destination). ## Link an audience to the destination For information about how to link an audience or segment to the created Destination in the Audiences application, see [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination). ## Identify the segment files in your bucket Zeotap CDP writes each activation as one or more CSV files into the folder you configured. ### File name pattern ``` ${filenamePrefix}part-${sequence}_${destinationAudienceId}_${timestamp}.csv ``` The timestamp is the file generation time in epoch milliseconds (UTC), and `destinationAudienceId` is the ID associated with your audience (segment) in Zeotap CDP, which is generated by Zeotap CDP after the audience (segment) is linked to a Destination. | Variable | Description | | :- | :- | | `filenamePrefix` | The prefix for the file name, typically indicating the context or purpose of the file (for example, the segment or export type). | | `part-${sequence}` | A sequential number or identifier indicating the part or chunk number if the data is split across multiple files. | | `${destinationAudienceId}` | The unique ID assigned by Zeotap CDP to the audience (segment) after it is linked to a Destination. | | `${timestamp}` | The time the file was generated, in epoch milliseconds (UTC) — for example, `1722931200000`. | | `.csv` | The file extension, indicating that the file is in CSV (Comma-Separated Values) format. | Example file name: ``` exportpart-0_894548842_1722931200000.csv ``` ### Multipart uploads Multipart uploads allow you to upload large files in multiple parts or chunks rather than uploading the entire file in one go. In that case the file name follows this convention: ``` {partNumber}_{filenamePrefix}{fileNumber}_${channelId}_${timestamp}.csv ``` where: * `partNumber` refers to the part of the multipart upload in Google Cloud Storage. Part 0 refers to the first part. * `channelId` is the ID associated with your audience (segment) in Zeotap CDP. This is generated by Zeotap CDP after the audience (segment) is linked to a Destination. You can obtain this information as shown in the image below. * `${timestamp}` is the timestamp in epoch format. ![Audience details in the Zeotap CDP Audiences application with the Channel ID highlighted in the destination panel on the right](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/google-cloud-storage-2024-05-08-3.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=ab92718b7e470b1333769c4f5a6b2eb6) Worked example — an audience called **PublicAbove18** with **Channel ID** `12345678`, a **filename prefix** `testprefix`, and a **file number** `98765`, uploaded as the first part of a multipart upload at epoch milliseconds `1625138600`: ``` Part0_testprefix98765_12345678_1625138600.csv ``` ## Import the CSV file into Channable Once the files are in your bucket, set up the import on the Channable side. **Step 1** **Prepare your CSV file** — make sure your product data is in CSV format and stored in your GCS bucket. **Step 2** **Log in to Channable** — access your Channable account and navigate to your project. **Step 3** **Create a new import** — go to **Feeds** or **Imports** (depending on your account setup) and select **Google Cloud Storage** as the source. **Step 4** **Authorise access** — provide Channable with the permissions it needs to read your GCS bucket. This usually involves entering your project and bucket details or generating a service account key. **Step 5** **Specify the file path** — enter the path to your CSV file in the GCS bucket, for example: ```text theme={null} gs://your-bucket-name/your-file-name.csv ``` **Step 6** **Configure import options** — review and configure options such as delimiter, encoding, and field mapping to ensure your data is imported correctly. **Step 7** **Test the connection** — run a test import to confirm that Channable can access and read your CSV file. **Step 8** **Start importing** — once everything is set up, you can schedule imports or run them manually to keep your Channable instance updated with the latest data. ## Verify the audience reached Channable Confirm the delivery at each of the three hops: 1. **In Zeotap CDP** — open the linked audience–destination pair and check that the latest run completed with a non-zero qualified count. For what a successful run records and what a failed one shows, see [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). 2. **In your Google Cloud Storage bucket** — open the folder path you configured on the destination and confirm that CSV files for the audience are present, named according to the patterns above. 3. **In Channable** — run the test import described above and confirm that Channable reads the file and that the imported rows carry the fields you mapped. ## Troubleshoot the Channable GCS Upload destination | Symptom | What it means | What to do | | :- | :- | :- | | The destination fails on its first run | One or more mandatory fields were not mapped on the mapping screen | Reopen the destination's mapping and map every mandatory field listed above, then re-run | | No files appear in the folder after an audience refresh | The identity selected under **Account** cannot write to your bucket — either the Zeotap Service Account was never whitelisted on the bucket, or the client service account JSON you uploaded lacks write access | Check your bucket's access configuration in Google Cloud against the **Account** and **Service Account to be Whitelisted** values on the destination | | Files are in the bucket but Channable's import finds nothing | The import in Channable points at a different bucket or path, or Channable is not authorised to read the bucket | Re-check the file path entered in the Channable import against the bucket and folder on the destination, and re-run the authorisation step in Channable | For delivery errors that are not specific to this destination — no customers qualified, a terminated refresh, a rejected payload — see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail) and [When to contact support](/articles/integrate-customer/destinations#when-to-contact-support). ## Next steps * [Explore how to link an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore how destinations work across platforms →](/articles/integrate-customer/destinations) * [Explore the Google Cloud Storage destination →](/articles/integrate-customer/google-cloud-storage) * [Explore the Channable real-time integration →](/articles/integrate-customer/channable-real-time-integration) # Channable real-time integration Source: https://docs.zeotap.com/articles/integrate-customer/channable-real-time-integration Send stock updates from Zeotap CDP out to a Channable project in real time, from a Send to Destinations node in a journey. ## What this is This integration sends data **out of Zeotap CDP to Channable**: a journey pushes stock updates for your products into a Channable project as profiles move through the workflow. Channable is a destination only — nothing flows from Channable back into Zeotap CDP. Channable is an e-commerce automation and feed management platform. It imports your product data from a source such as an online store or ERP system, applies rules to optimise it for each channel, and distributes the resulting listings to marketplaces, ad platforms and comparison shopping engines. For marketplaces it also keeps order and stock data synchronised, which is the part this integration feeds. Channable is also available as a **batch** destination that writes CSV files to a Google Cloud Storage bucket for Channable to import. Use [Channable GCS upload](/articles/integrate-customer/channable-gcs-upload) to export audience data as a product feed; use this page to update stock levels from a journey. ## Supported action and fields This integration uses the **Send Stock Updates to Channable** action. On the mapping screen you map your **Catalogue** fields to the Channable destination fields. The fields the screen lists are: | Destination field | Type | Required | | :- | :- | :- | | ID | String | Yes | | GTIN | String | No | | Title | String | No | | Stock | Integer | Yes | Required fields are marked with a red asterisk in the mapping screen. By default the screen shows the destination fields that Channable accepts; you can edit, add or remove entries in the mapping. ## Prerequisites Before you create the destination, make sure you have: * An **active Channable account** on the subscription required for this integration. * A **configured Channable project**. * Matching **product identifiers** on both sides. * Your Channable **Company ID**, **Project ID** and **API key** — see below for where to find each one. ## Find your Channable details ### Company ID The unique ID for your entire Channable account. Log in to Channable and read the number after `/companies/` in your browser's URL. ### Project ID The ID of the specific project you want to integrate with. You may have several projects — for different stores or regions — so make sure you take the ID of the one you intend to send to. Open that project in Channable and read the number after `/projects/` in your browser's URL. ### API key Generate this in your Channable dashboard, under **My Account > Personal tokens**. In Zeotap CDP the field is labelled **API Key**, with the helper text *API Key generated in Channable*. Treat the value as a secret. ## Create the Channable destination **Step 1** Log in to the Zeotap CDP app and go to the **Destinations** application. **Step 2** Click **+ Create Destination**. **Step 3** Under **All Destinations**, search for **Channable** and select it. A panel headed **Channable : Stock Update** opens, describing the destination on the left and listing the fields required for the integration on the right. **Step 4** On the **Enter Destination Details** step, provide: a. A **Destination Name**, for easy identification later. b. The **API Key** generated in Channable. c. Your **Company ID**. Click **Next**. ![Enter Destination Details step of the Channable : Stock Update destination, with empty Destination Name, API Key and Company ID fields and a Next button.](https://lh7-qw.googleusercontent.com/docsz/AD_4nXd9y08EjsufUVNZYYpSppCQAAuPqJGP4w3Roq032zFnNGQhdry1MPu2tSq-YLw8XoptBukKJa6Fd0YG9wpwVz6V3eRWHxs1HPyhHOe2YuY9-8WjEKZRVCRgJzrb_hO4PdW5qpC39g?key=I579DRCR7uozRsaH9zUwbA) > [!NOTE] > > **Note:** > > There is no **Project ID** field on this step. You enter the Project ID on the journey node when you attach the destination — see [Activate the destination in a journey](#activate-the-destination-in-a-journey). **Step 5** On the **Mapping** step: a. Under **Choose your Action**, select **Send Stock Updates to Channable**. b. Under **Map the Fields**, map a catalogue attribute to each Channable destination field you want to send. Every field marked with an asterisk must be mapped. ![Mapping step with the action Send Stock Updates to Channable selected, and a Stock Updates mapping table pairing catalogue attributes with the ID, GTIN, Title and Stock destination fields.](https://lh7-qw.googleusercontent.com/docsz/AD_4nXebmSW9dIcps7mMcUerGKIbOS9LvLu51fAxYPfrKj3J06UnGlblf1VDX_2VFCvwe6O0EN1W6sBJp00yDCVD_Xz406ufmEehEBmZBNf-ZBvNX-AfhDiTE26GaoX6bVMhaEosE4nc_Q?key=I579DRCR7uozRsaH9zUwbA) **Step 6** Click **Create Destination**. The destination is now available to attach to a journey. ## Activate the destination in a journey A real-time Channable destination only sends data once it is attached to a **Send to Destinations** node in a journey. **Step 1** On the journey canvas, click **+** at the point where the stock update should happen and choose **Send to Destinations**. ![The Choose an action menu on the journey canvas with Send to Destinations highlighted below Add a Condition, Add a Delay, Create a Multi-branch Split and Create a True/False Split.](https://lh7-qw.googleusercontent.com/docsz/AD_4nXdHUk8I4TOpvXV1oBV-GKZYRPeqIm68FBRiMP54Uf1D09Xxn1enowUhcjsqfe9RiIgrSJ8cKXC2N6eVZDq7esjdVSCY-P8-oeXmei61hASp8A9KqjHTUib2F6rdumgPDyuA7ahqTw?key=I579DRCR7uozRsaH9zUwbA) **Step 2** Find the Channable destination you created in the list of available destinations, using the search box. ![The Send to Destinations panel with the search box highlighted above a grid of existing destination cards, and an Add New Destination link.](https://lh7-qw.googleusercontent.com/docsz/AD_4nXc5aH0eiMLAJTiVePX0B3RAu0vYjwZkfMbU_eCqkr69NxJrJtOsbo8_cdrxVRiJdZXglCUFVccAqu6Wl1quVxzHrOT5DcI7BoJUSrkEBlCLAcZRJR2RBTAY6E50hX3w9n4pD4YZVg?key=I579DRCR7uozRsaH9zUwbA) **Step 3** On the **Destination Details** tab, the **Company ID** and **API Key** are carried over from the destination you created. In the **Project ID** box, enter the Project ID of the Channable project you want to update. ![Destination Details tab of a Channable : Stock Update node, showing Destination Name, API Key and Company ID above an empty Project ID box outlined in red, with a Save Destination button.](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/channable-real-time-integration/channable-real-time-integration-2025-07-17.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=05002ef99c0524d624e501e8e65241cf) **Step 4** On the **Destination Settings** tab, choose the action and the mapping this node should use. **Step 5** Click **Save Destination**. The node is attached to the journey and shows the destination name and the action its mapping runs. ![A Send to Destinations node with an attached Channable : Stock Update card naming the destination and the Send Stock Updates to Channable mapping, above the destination picker.](https://lh7-qw.googleusercontent.com/docsz/AD_4nXfWt-T8ajhEnC6BYxu_WfP9g3IXgBnW2mg2gK6uQ3B1gbLlhwm4XgSOO2PCEnzLP03zXCTEqkFyCLL3kfaz-VIZv13-g7VfatkNU9SqJF2fnd0Kk_M3VnOvrSEGxm8TDhKCqo7h?key=I579DRCR7uozRsaH9zUwbA) ## Verify the stock updates reach Channable Check both sides: 1. **In Zeotap CDP** — open [Journey Traces](/articles/orchestrate-customer/journey-traces) for the journey and look up a profile that passed through the node. Switch the output-event view to the Channable node and confirm the payload carries the product ID and stock value you mapped. 2. **In Channable** — open the project whose Project ID you entered on the node and confirm the stock for those products reflects what was sent. ## Troubleshoot the integration Failures surface at the node itself. Open the **Execution Details** sidebar on the failed node in the journey canvas: it gives the failure status code, the timestamp, the destination name, and the Request ID you will need if you raise a support request. See [Identify Journey Errors](/articles/orchestrate-customer/identify-journey-errors) for how to read it. The error codes you are most likely to see on this destination: | Error code | What to check | | :- | :- | | `AUTHENTICATION_ERROR` | The API Key and Company ID on the destination, and the Project ID on the node. Regenerate the token in Channable if it has been revoked, and update the destination. | | `BAD_REQUEST` | The mapping. Open **Map Your Fields** for the node and confirm every field marked with an asterisk — **ID** and **Stock** — is mapped to a catalogue attribute that is actually populated. A null in a mandatory field is the most common cause. | | `EVENT_PARSING_FAILED` | The mapping and any transformation rules on the node. The payload did not parse into the shape the destination expects. | | `RATE_LIMIT` | Nothing immediately — this is transient and retried. If it persists, reduce how much the journey sends at once by adding a delay node. | | `SERVER_ERROR` / `SERVICE_UNAVAILABLE` | Channable's own availability. Both are transient and retried automatically. | For the full list, including which codes retry and which do not, see [Journey Error Codes](/articles/orchestrate-customer/journey-error-codes). ## FAQ > [accordion] Should I use this integration or Channable GCS upload? > > Use this one to update stock in real time from a journey. Use [Channable GCS upload](/articles/integrate-customer/channable-gcs-upload) to export audience data as a CSV product feed to a Google Cloud Storage bucket that Channable then imports; that route carries the full feed fields, such as availability, brand, description, image link, link, price, product type, sale price, size and title. The two are separate destinations and can run side by side. > [accordion] Where do I enter the Project ID? > > On the journey node, not on the destination. The **Enter Destination Details** step asks only for the destination name, the API Key and the Company ID; the **Project ID** box appears on the **Destination Details** tab of the **Send to Destinations** node, alongside the API Key and Company ID carried over from the destination. ## Next steps * [Set up the batch route with Channable GCS upload →](/articles/integrate-customer/channable-gcs-upload) * [Understand how destinations work in Zeotap CDP →](/articles/integrate-customer/destinations) * [Debug a single profile with Journey Traces →](/articles/orchestrate-customer/journey-traces) * [Look up a journey error code →](/articles/orchestrate-customer/journey-error-codes) # Cleverpush (Batch) Source Source: https://docs.zeotap.com/articles/integrate-customer/cleverpush-batch-source Bring subscriber data from a Cleverpush channel into Zeotap CDP with the Cleverpush (Batch) source. The Cleverpush (Batch) source brings subscriber data from a Cleverpush channel **into Zeotap CDP**. It is the batch counterpart of the [Cleverpush Real-Time Source](/articles/integrate-customer/cleverpush-real-time-source). To send audiences in the opposite direction — out of Zeotap CDP to Cleverpush — use the [Cleverpush destination](/articles/integrate-customer/cleverpush-destination) for batch delivery, or the [Cleverpush Real Time Integration](/articles/integrate-customer/cleverpush-real-time-integration) for real-time delivery. ## What this is Cleverpush is a web-based platform that enables website owners and developers to send push notifications (Push notifications are messages that can be delivered to users' devices, such as smartphones or desktop computers, even when they are not actively browsing the website.) to users who have subscribed to receive them. In the Zeotap CDP App it sits under the **Customer Engagement Channels** source category, alongside the other engagement platforms listed on [Customer Engagement Channels](/articles/integrate-customer/customer-engagement-channels). ## Supported identifiers The source fetches information related to the subscribers of a channel, such as the subscription ID, channel ID, `created_at`, country, custom attributes and segments. The **Subscription ID** is the identifier the [Cleverpush destination](/articles/integrate-customer/cleverpush-destination) needs in order to send audiences back to Cleverpush. Connecting this source is one of the two documented ways to obtain it; the other is ingesting it from a flat file. ## Prerequisites You need the following from your Cleverpush account before you create the source: * **Private API Key** — a unique identifier associated with your Cleverpush account, used to authenticate and authorise access to certain features or APIs of Cleverpush. In the Cleverpush console, it is shown under **Settings**, then **API** in the left panel. * **Channel ID** — the unique identifier assigned to the push notification channel you create within Cleverpush. It is shown on the channel's platform under **General > Advance Settings > Channel ID**. A channel must exist, and have at least one platform set up on it, before it has a Channel ID. Zeotap CDP supports Web Push, App Push and Email Push. For the channel-creation and platform-setup steps, see the [Cleverpush channel and platform setup appendix](/articles/integrate-customer/cleverpush_appendix). ## Create the Cleverpush (Batch) source In the Zeotap CDP App, open the **Sources** application under **Integrate** and click **CREATE SOURCE**. Choose **Customer Engagement Channels** as the category and **Cleverpush** as the data source, then give the source a short, descriptive name, select the **Region** of upload, enter the Private API Key and the Channel ID, and choose the **Data Entity** — either **Customer Data** or **Non Customer Data** ([what these mean](/articles/unify-customer/supported-data-entities)), and select the **Sync frequency** — **Daily**, **Weekly** or **Monthly**. For the full click-path with screenshots, see [Create a Cleverpush (Batch) Source](/articles/integrate-customer/create-a-cleverpush-batch-source). ## Verify the source is working Once created, the source appears on the **SOURCES** listing page. Open it and check: * **IMPLEMENTATION DETAILS** — shows the details recorded for the source, including the Private API Key, Channel ID, Created By and Created on values. * **[PREVIEW DATA](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab)** — shows the data flowing in once the connection between Zeotap CDP and Cleverpush is established. ## Next steps > [card] [Create a Cleverpush (Batch) Source](/articles/integrate-customer/create-a-cleverpush-batch-source) > [card] [Cleverpush channel and platform setup](/articles/integrate-customer/cleverpush_appendix) > [card] [Cleverpush Real-Time Source](/articles/integrate-customer/cleverpush-real-time-source) > [card] [Cleverpush destination](/articles/integrate-customer/cleverpush-destination) # Cleverpush Source: https://docs.zeotap.com/articles/integrate-customer/cleverpush-destination Send audience identifiers out of Zeotap CDP to Cleverpush, where they arrive as a tag you can target in a web, app or email push campaign. The Cleverpush destination sends audience identifiers **out of Zeotap CDP** to your Cleverpush account, where each activated audience arrives as a Cleverpush tag you can target in a push campaign. To bring Cleverpush subscriber data **into** Zeotap CDP instead, use the [Cleverpush (Batch) Source](/articles/integrate-customer/cleverpush-batch-source) or the [Cleverpush Real-Time Source](/articles/integrate-customer/cleverpush-real-time-source). ## What this is Cleverpush is a web-based platform that lets website owners and developers send push notifications (Push notifications are messages that can be delivered to users' devices, such as smartphones or desktop computers, even when they are not actively browsing the website.) to users who have subscribed to receive them. Integrated with Zeotap CDP, it lets marketers engage their customers in real time and at scale, across mobile applications, websites and email. This page covers the **batch** Cleverpush destination, which you configure once per Cleverpush channel and then reuse for every audience you link to it. If you want to activate users from a Journeys workflow as they qualify rather than on a scheduled audience refresh, see [Cleverpush Real Time Integration](/articles/integrate-customer/cleverpush-real-time-integration) instead. ## Supported identifiers and actions This integration supports **Subscription ID**. The destination exposes a single action: | Action | ID Extension | Delete | Delta Upload | | - | - | - | - | | Send identifiers to Cleverpush | — | — | — | The action does not support [ID Extension](/articles/segment-customer/extend-your-audience#id-extension), [Delete or Delta Upload](/articles/segment-customer/delta-upload-and-delete-functions). ## Prerequisites Before you configure the destination, make sure you have the following: * **A Cleverpush source in Zeotap CDP.** The destination matches users on their Cleverpush Subscription ID, so that identifier has to already be present in Zeotap CDP. You get it either by connecting a Cleverpush source or by ingesting a flat file. * **Your Cleverpush Private API key.** Found in the Cleverpush console under **Settings > API**. See [Private API key](#private-api-key) below. * **The Channel ID of the push notification channel you want to send to.** Found in the Cleverpush console under **Channels > Platforms > General**. See [Channel ID](#channel-id) below. ## Get your Cleverpush credentials Gather both values from the Cleverpush console before you start the destination form in Zeotap CDP. ### Private API key A Private API key is a unique identifier associated with your Cleverpush account. Cleverpush uses it to authenticate and authorise access to certain features and APIs. **Step 1** Log into the Cleverpush console and navigate to **Settings**. **Step 2** In the left panel, click **API** and copy the **Private API key** shown on the screen. **Step 3** To restrict a key to particular channels, click **Add additional API key** and select the channels where you intend to use it. ![The API page in Cleverpush Settings, with the Generate new API key button, and the Additional API keys section with its Channels selector open.](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/0f57bafc-d4c8-4078-ae21-b075ebd5f18b.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=3697a086c92cf484823301d94bb19a5a) ### Channel ID A Channel ID is a unique identifier assigned to a push notification channel you create within Cleverpush. **Step 1** Log into the Cleverpush console and open **Channels** on the top navigation bar. **Step 2** Click the channel you want to send push notifications to. If it does not exist yet, create one by clicking **Add Channel** in the drop-down menu. For the full steps, see [Create a new channel in Cleverpush](/articles/integrate-customer/appendix-cleverpush-destination#create-a-new-channel-in-cleverpush). ![The Cleverpush dashboard with the Channels drop-down open, listing the most recent channels above the All channels and Add Channel entries.](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/cleverpush-destination/Channel_ID_1.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=9ca8229eb291c985412a8ae53aef4a4c) **Step 3** Set up the platforms you want to send notifications on. Zeotap CDP supports: * Web Push * App Push * Email Push > [!NOTE] > > For the setup steps for each platform, see [Setup Web Push](/articles/integrate-customer/appendix-cleverpush-destination#set-up-web-push-in-cleverpush), [Setup App Push](/articles/integrate-customer/appendix-cleverpush-destination#set-up-app-push-in-cleverpush) and [Setup Email Push](/articles/integrate-customer/appendix-cleverpush-destination#set-up-email-push-in-cleverpush). ![A Cleverpush channel's Basic settings panel above its Platforms panel, where each platform such as Web Push or App Push can be added or removed.](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/cleverpush_b3.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=9a9b3f5e629b66c24f71fe0899679ecf) **Step 4** Open the platform you want to use and go to **General > Advanced settings**. The **Channel ID** is the first row of that panel. ![The Advanced settings panel for a Web Push platform in Cleverpush, with the Channel ID row highlighted at the top, above Subdomain and the Firebase settings.](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/cleverpush_b_4.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=06edb1df158ce93842b5c24c506e51a5) ## Create the Cleverpush destination **Step 1** In the Zeotap CDP app, go to **Integrate > Destinations**. **Step 2** Click **+ Create Destination**. ![The Destinations listing page in Zeotap CDP, with the Create Destination button highlighted above the list of configured destinations.](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/ADOBE_DMP_3.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=f6ff079e8400cd5de47f0dff153315a0) **Step 3** Under **All Destinations**, search for **Cleverpush**. ![The All Destinations catalogue in Zeotap CDP, with the search field highlighted above the grid of available destination cards.](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/ADOBE_DMP_4.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=4aff8f161b47a7403e3820fe7befeaaa) **Step 4** Click **Cleverpush**. The destination opens on the **Destination Details** step, with a description of the integration on the left and the configuration fields on the right. Fill in: a. **Destination Name** — a short, descriptive name that identifies the Cleverpush channel this destination sends to, so it is easy to find when you link an audience. b. **Private API Key** — the Private API key you copied from the Cleverpush console. c. **Channel Id** — the Channel ID of the push notification channel you want to send to. d. Review the fields and click **Next**. > [!NOTE] > > To open the help documentation for this integration from inside the product, click **Integration Guide** under **Related Links**. ![The Destination Details step of the Cleverpush destination in Zeotap CDP, showing the Destination Name, Private API Key and Channel Id fields with placeholder values, and the Integration Guide link under Related Links.](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/cleverpush_des_1.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=0f31ff8ee7a8b7878dd9aba732a02376) **Step 5** On the **Mapping** step, choose the action and the field mapping: a. Under **Choose your Action**, select **Send identifiers to Cleverpush**. Then, under **Map the Fields**, map the catalogue field that holds each user's Cleverpush Subscription ID to the **Subscription Id** destination field. The [output identifiers](/articles/segment-customer/choose-the-output-identifiers) accepted by the platform are offered by default, and you can edit that selection so that only the identifiers you intend to send are mapped to **Subscription Id**. For more on how mapping works across destinations, see [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). b. Click **Create Destination**. The destination is now available in the Audiences application and can be linked to an audience. ![The Mapping step of the Cleverpush destination in Zeotap CDP, with Send identifiers to Cleverpush selected as the action and a catalogue field mapped to the Subscription Id destination field.](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/cleverpush-destination/cleverpush_des_2.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=11cc6cd3ced258a7176174c042139d92) ## Link an audience to the destination For the steps to link an audience to a created destination, see [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination). It can take up to two hours for the audience to become available in your Cleverpush seat. > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience or a segment could be a specific group of customers who are over 18 years of age and who have performed an `addToCart` event within the last 30 days. ## Verify the audience reached Cleverpush Confirm the delivery from both sides: 1. **In Zeotap CDP** — open the destination and review its activity. A successful delivery records a run with a non-zero qualified count and a completed status; a failed run records an error message. See [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked) for what to check, and [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail) for the errors that surface on an audience–destination pair and what to do about them. 2. **In Cleverpush** — open **Create new**, select your channel, and open the **Tags** drop-down. The activated audience appears there as a tag. Selecting it updates the **Will be sent to** subscriber count shown alongside the target group, which tells you how many of your Cleverpush subscribers matched. The two counts will not match exactly, because Cleverpush only counts users it could match to an existing subscription, but both should be non-zero. ## Send a campaign to the audience in Cleverpush **Step 1** Log into the Cleverpush console and click **Create new**. ![The Cleverpush dashboard with Create new highlighted in the top navigation bar, above the clicks, opt-ins and growth summary tiles.](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/cleverpush-destination/camp_in_cleverpush_11.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=5d940e4d870ce9ff7ffbdafaf6a6df4a) **Step 2** In the **Channels** drop-down, choose the channel you created, matching the type of push notification you want to send. To create a new channel first, see [Create a new channel in Cleverpush](/articles/integrate-customer/appendix-cleverpush-destination#create-a-new-channel-in-cleverpush). ![The Create new page in Cleverpush with the Target group Channels drop-down open, listing each channel's Web Push, App Push and Email entries.](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/cleverpush-destination/camp_in_cleverpush_2.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=9ff429bbe1e26c9f7cb1a1acf45dd0ee) **Step 3** Use the **Tags** drop-down to choose the audience you want to target. The **Will be sent to** count updates to show how many subscribers the selection reaches. ![The Target group panel of a new Cleverpush campaign, with the optional Tags drop-down open and highlighted, and Countries, Languages and Platforms filters on the right.](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/cleverpush-destination/image_\(27\).png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=4c16450f6ab542a4f3a02b6ff0df1c0a) **Step 4** Under **Message**, enter the headline and text of the push notification you want to send. A live preview of the notification appears alongside. **Step 5** Review all the fields and click **Send notification**. ![A completed Cleverpush campaign with a channel and a tag selected in the Target group and the Send notification button highlighted next to Discard and Save draft.](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/cleverpush-destination/image_\(28\).png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=159db98af897e35b138c706d4e4cce67) ## Next steps * [Bring Cleverpush subscriber data into Zeotap CDP with the batch source →](/articles/integrate-customer/cleverpush-batch-source) * [Bring Cleverpush subscriber data into Zeotap CDP in real time →](/articles/integrate-customer/cleverpush-real-time-source) * [Activate from a Journeys workflow with the Cleverpush real-time integration →](/articles/integrate-customer/cleverpush-real-time-integration) * [Set up Cleverpush channels and platforms →](/articles/integrate-customer/appendix-cleverpush-destination) * [Understand how destinations work in Zeotap CDP →](/articles/integrate-customer/destinations) # Cleverpush Real-Time Integration Source: https://docs.zeotap.com/articles/integrate-customer/cleverpush-real-time-integration Send identifiers and attributes out of Zeotap CDP to Cleverpush in real time from a Journeys workflow, so you can trigger web, app and email push notifications. ## What this is The Cleverpush real-time integration sends data **out of Zeotap CDP to Cleverpush**, one user at a time, as the user moves through a workflow in Journeys. Cleverpush is a web-based platform that lets website owners and developers send push notifications (Push notifications are messages that can be delivered to users' devices, such as smartphones or desktop computers, even when they are not actively browsing the website.) to users who have subscribed to receive them. With this integration you can engage those subscribers in real time and at scale, through mobile applications, websites and emails. This page covers the **real-time destination** only — the one you attach to a **Send to Destinations** node in Journeys. Cleverpush has three other pages, and they are not interchangeable: * [Cleverpush](/articles/integrate-customer/cleverpush-destination) — the batch destination, linked to an audience rather than to a Journeys node. * [Cleverpush Real Time Source](/articles/integrate-customer/cleverpush-real-time-source) — data flowing the **opposite** way, from Cleverpush **into** Zeotap CDP in real time. * [Cleverpush (Batch) Source](/articles/integrate-customer/cleverpush-batch-source) — the same opposite direction, in batches. ## Supported identifiers and actions This integration supports Subscription ID and standard attributes such as First Name, Last Name, Gender and Email Address (Raw). You can also send custom identifiers and attributes. Which of those you can actually send depends on the action you pick on the mapping screen: | Action | What it sends | | :- | :- | | Send identifiers and attributes to Cleverpush in Realtime | Subscription ID, plus the standard attributes First Name, Last Name, Email Address (Raw) and Gender, plus any custom identifiers and attributes you add with **+ Add Mapping Field** | | Send identifiers to Cleverpush in Realtime | Subscription ID only | > [!NOTE] > > Create the standard and custom attributes in your Cleverpush account **before** you map them in Zeotap CDP. If an attribute does not exist in Cleverpush, the data is not sent correctly. See [Add identifiers and attributes in Cleverpush](#add-identifiers-and-attributes-in-cleverpush). ## Prerequisites Have the following ready before you create the destination: * **A Cleverpush account** with a channel set up for the platform you want to send on — Web Push, App Push or Email Push. To create a channel and set up a platform, see the [Cleverpush appendix](/articles/integrate-customer/appendix-cleverpush-real-time-integration), which covers all three. * **The Private API Key** for that Cleverpush account. See [Obtain the Private API Key](#obtain-the-private-api-key). * **The Channel ID** of the push notification channel you want to use. See [Obtain the Channel ID](#obtain-the-channel-id). * **The identifiers and attributes already created in Cleverpush**, so that they exist when you map them on the Zeotap CDP side. See [Add identifiers and attributes in Cleverpush](#add-identifiers-and-attributes-in-cleverpush). * **A workflow in Journeys** with the filters or conditions that select the users you want to send. See [Create a Workflow](/articles/orchestrate-customer/create-a-workflow). * **A Catalogue attribute holding each user's Cleverpush subscription ID** — this is what you map to the **Subscription Id** destination field. ## Obtain the Private API Key A Private API Key is a unique identifier associated with your Cleverpush account. Cleverpush uses it to authenticate and authorise access to certain features of the platform. **Step 1** Log into the Cleverpush console and navigate to **Settings**. **Step 2** In the left panel, click **API** and copy the **Private API key** displayed on the screen. **Step 3** If you want to add an additional API key, click **Add additional API key** and select the channel where you intend to use the key. ![Cleverpush Settings, API tab, with the Generate new API key button, and the Additional API keys section with a channel selector](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/0f57bafc-d4c8-4078-ae21-b075ebd5f18b.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=3697a086c92cf484823301d94bb19a5a) > [!WARNING] > > Treat the Private API Key as a secret. Do not paste it into tickets, screenshots or shared documents. ## Obtain the Channel ID A Channel ID is a unique identifier assigned to the push notification channel you create in Cleverpush. **Step 1** Log into the Cleverpush console and navigate to **Channels** on the top navigation bar. **Step 2** Under **Channels**, click the channel you want to use for sending push notifications. If the channel you need does not exist, create one by clicking **Add Channel** in the drop-down menu. For the full steps, see [Create a new channel in Cleverpush](/articles/integrate-customer/appendix-cleverpush-real-time-integration#create-a-channel-in-cleverpush). ![Cleverpush dashboard with the Channels drop-down open, listing the recent channels along with the All channels and Add Channel options](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/cleverpush-destination/Channel_ID_1.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=9ca8229eb291c985412a8ae53aef4a4c) **Step 3** Once the channel exists, set up the platforms you want to send notifications on. Zeotap CDP supports: * Web Push * App Push * Email Push > [!NOTE] > > For the setup steps for each of these platforms, see the [Cleverpush appendix](/articles/integrate-customer/appendix-cleverpush-real-time-integration). ![Cleverpush channel Basic settings screen with the Platforms list below it and Web Push, App Push and Email in the left-hand PLATFORMS panel](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/cleverpush_b3.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=9a9b3f5e629b66c24f71fe0899679ecf) **Step 4** Click the platform you want and navigate to **General → Advanced settings → Channel ID**. ![Cleverpush Web Push Advanced settings screen with the Channel ID row highlighted at the top](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/cleverpush_b_4.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=06edb1df158ce93842b5c24c506e51a5) ## Add identifiers and attributes in Cleverpush Add the identifiers and attributes in Cleverpush before you map them on the Zeotap CDP mapping screen. If they do not exist in Cleverpush, the data is not sent correctly. **Step 1** Log into the Cleverpush console and navigate to **Channels** on the top navigation bar. **Step 2** Under **Channels**, click the channel you want to use for sending push notifications. For more about channels, see [Obtain the Channel ID](#obtain-the-channel-id). **Step 3** Go to your platform and open **Attributes**. Under **ID**, Cleverpush lists a standard set of commonly used attributes. Select the ones you need and give each a name. ![Cleverpush Attributes screen with the ID drop-down open, showing the standard attribute IDs grouped as Single Value (indexed), Single Value, Multi Value and Custom](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush-real-time-integration/cleverpush-real-time-integration-2024-08-05-13.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=1659202b5a4025fb0cbbefdcef813ba6) For example, to add **firstname** from the standard list, choose **firstname** under **ID** and enter a display name — here, **First Name**. The standard field `firstname` is what connects the attribute in Cleverpush to the field in Zeotap CDP, so the ID must match. ![Cleverpush Attributes screen with firstname selected under ID and First Name entered under Name, next to the Add attribute button, above the list of attributes already added](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush-real-time-integration/cleverpush-real-time-integration-2024-08-05-9.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=6843135394ce0fbb03e868d98238a1d9) **Step 4** Click **Add attribute**. Add any custom identifiers or attributes the same way. Once an attribute exists in Cleverpush, you can map a Catalogue field to it on the Zeotap CDP mapping screen. ![Zeotap CDP mapping screen showing Catalogue Field to Destination Field rows under Identifiers: subscription_id to Subscription Id, Email to Email Address and First Name to First Name](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/cleverpush-real-time-integration/cleverpush-real-time-integration-2024-08-05-10.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=a8e65212276c902e69eccbe51c5ccd43) ## Create the Cleverpush destination You create this destination from inside a Journeys workflow. After you have applied filters or added conditions for your users in Journeys, activate them in Cleverpush under **Send to Destinations**. A new window appears where you set up the destination. You can reuse an existing destination from the list or create a new one by clicking **+ Add New Destination**. ![Send to Destinations panel in Journeys with a search box, the + Add New Destination link and a grid of existing destination cards](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/cleverpush-real-time-integration/cleverpush-real-time-integration-2024-08-05.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=c38b7795435c6a7d998ce5d9a02594a9) **Step 1** Click **+ Add New Destination**. **Step 2** Search for **Cleverpush**. **Step 3** Click **Cleverpush** and enter a name for the destination under **Destination Name**. **Step 4** Enter the **Private API Key** associated with your Cleverpush account. To find it, see [Obtain the Private API Key](#obtain-the-private-api-key). **Step 5** Enter the **Channel ID** of your push notification channel. To find it, see [Obtain the Channel ID](#obtain-the-channel-id). ![Step 1 of the destination wizard, Enter Destination Details, with the Destination Name, Private API Key and Channel Id fields and their in-product hints](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/cleverpush-real-time-integration/cleverpush-real-time-integration-2024-08-05-1.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=259cf539cd18ec26dd06713a68436065) **Step 6** On the mapping screen that appears, give the mapping a name, then choose your action under **Choose your Action**: a. **Send identifiers and attributes to Cleverpush in Realtime** — along with the Subscription ID you can send the standard attributes First Name, Last Name, Email Address (Raw) and Gender. Each of these must already exist in the Cleverpush console before you map it; see [Add identifiers and attributes in Cleverpush](#add-identifiers-and-attributes-in-cleverpush). Use **+ Add Mapping Field** to send custom identifiers and attributes as well — these too must exist in Cleverpush first, or the data is not sent correctly. ![Mapping screen with the Send identifiers and attributes to Cleverpush in Realtime action selected and Map the Fields rows for Subscription Id, Email Address, First Name, Last Name and Gender, plus the + Add Mapping Field link](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush-real-time-integration/cleverpush-real-time-integration-2024-08-08.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=8b9fad9b5a7d7696d632e58bfb0c7e34) b. **Send identifiers to Cleverpush in Realtime** — only the Subscription ID is sent to Cleverpush. ![Mapping step of the destination wizard with the Send identifiers to Cleverpush in Realtime action selected and a single mapped row, subscription_id to Subscription Id, above the Create Destination button](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush-real-time-integration/cleverpush-real-time-integration-2024-08-05-3.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=c3bdabd49f1a63dc943e2ed9e8a8c5f3) **Step 7** Once the mapping is complete, click **Create Destination**. The destination is created and becomes available for activation in Journeys. ## Activate the destination in a Journeys workflow After the destination exists, add the workflow-level inputs. **Step 1** Choose the destination from the list of available destinations, using the search box if needed. ![Send to Destinations panel with a Cleverpush destination card selected from the grid of available destinations](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush-real-time-integration/cleverpush-real-time-integration-2024-08-05-4.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=5fcda7e9ccc7eaa40ea3cacd3ff0be40) **Step 2** On the **Destination Details** tab, the **Private API Key** and **Channel Id** fields are populated automatically from the values you entered when you created the destination. **Step 3** Under **Audience**, choose a tag from the drop-down to categorise your users by the characteristics that matter for this workflow. Pick an existing tag or create one with **+ Create New Tag**. ![Destination Details tab for a Cleverpush destination showing the pre-filled Destination Name, Private API Key and Channel Id fields, with the Audience tag drop-down open below them](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush-real-time-integration/cleverpush-real-time-integration-2024-08-05-5.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=44b18a99238fefba9c28aed813b0a1f1) In Cleverpush, tags are labels you assign to users to group them by characteristics, interests, behaviours or demographics. Tags let you segment your subscribers and target them with relevant, personalised messages. **Step 4** On the **Destination Settings** tab, choose the action and mapping you want this node to use. The fields that will be sent are listed under **Mapping**, and **Edit Mapping** lets you change them. ![Destination Settings tab with the Choose your Action and Mapping drop-downs and the Mapping section listing the identifiers that will be sent, next to the Edit Mapping link](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush-real-time-integration/cleverpush-real-time-integration-2024-08-05-6.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=4426de2482a0a50010098214c3c21fa6) **Step 5** Click **Save Destination**. The destination is attached to the node. ![Send to Destinations panel with a Cleverpush destination attached to the node, its card showing the destination name, the mapping name and the selected action](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush-real-time-integration/cleverpush-real-time-integration-2024-08-05-7.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=0204a51be1711fafa0b86594c2fef590) ## Verify the integration is working Check the following, in order: 1. **The destination is attached.** In the **Send to Destinations** node, the Cleverpush card appears at the top of the panel and shows the destination name, the mapping name and the action you selected. 2. **The mapping is the one you intended.** Open the **Destination Settings** tab and confirm the fields listed under **Mapping** are the ones you expect. For the identifiers-and-attributes action, every attribute listed there must already exist in the Cleverpush console. 3. **A real user's payload reached the node.** Use [Journey Traces](/articles/orchestrate-customer/journey-traces) to search for a user who qualified for the workflow, then inspect the output event for the Cleverpush destination node. This shows exactly which fields were sent for that user. 4. **No node-level failures.** Open the **Execution Details** panel on the destination node in the Journey Canvas. See [Identify Journey Errors](/articles/orchestrate-customer/identify-journey-errors). ## Troubleshoot the Cleverpush real-time integration | Symptom | Most likely cause | What to do | | :- | :- | :- | | Only the subscription ID arrives in Cleverpush; no names, gender or email | The node is using the **Send identifiers to Cleverpush in Realtime** action, which sends the Subscription ID only | Open **Destination Settings** on the node and switch the action to **Send identifiers and attributes to Cleverpush in Realtime**, then map the attributes you need | | An attribute is mapped in Zeotap CDP but never appears against subscribers in Cleverpush | The attribute does not exist in the Cleverpush channel, or its **ID** in Cleverpush does not match the field being sent | In Cleverpush, open the channel's **Attributes** screen and confirm the attribute is listed with the expected **ID** — the ID, not the display name, is what connects the two platforms. See [Add identifiers and attributes in Cleverpush](#add-identifiers-and-attributes-in-cleverpush) | | A custom attribute added with **+ Add Mapping Field** is not sent | The custom attribute was not created in Cleverpush before it was mapped | Create it in the Cleverpush console first, then re-check the mapping | | The destination node reports failures in the Journey Canvas | A configuration or payload problem at the node | Open the **Execution Details** panel for the failure status code and the Request ID, then look the code up in [Journey Error Codes](/articles/orchestrate-customer/journey-error-codes). See also [Journey Troubleshooting](/articles/orchestrate-customer/journey-troubleshooting) | | The **Private API Key** or **Channel Id** on the node is not what you expect | These fields are populated from the destination definition, not set per node | Correct them on the destination itself, or create a new destination with the right values and select it on the node | ### When to escalate Contact your Zeotap CSM or TAM if the destination node still fails after the checks above. Include the workflow name, the destination name, the failure status code and the **Request ID** from the **Execution Details** panel, and the timestamp of a failed execution. ## Next steps * [Set up a channel and the Web, App and Email Push platforms in Cleverpush →](/articles/integrate-customer/appendix-cleverpush-real-time-integration) * [Create a workflow in Journeys →](/articles/orchestrate-customer/create-a-workflow) * [Debug a single user's path with Journey Traces →](/articles/orchestrate-customer/journey-traces) * [Bring Cleverpush subscriber data into Zeotap CDP in real time →](/articles/integrate-customer/cleverpush-real-time-source) * [Explore the integrations master list →](/articles/integrations-master-list-publication/integrations-master-list) # Cleverpush Real-Time Source Source: https://docs.zeotap.com/articles/integrate-customer/cleverpush-real-time-source Stream subscriber and notification events from a Cleverpush channel into Zeotap CDP over a webhook. The Cleverpush Real-Time source brings data **into Zeotap CDP**: a Cleverpush channel posts subscriber and notification events to Zeotap over a webhook as they happen. To send data in the opposite direction — out of Zeotap CDP to Cleverpush — use the [Cleverpush destination](/articles/integrate-customer/cleverpush-destination) for audiences, or the [Cleverpush Real Time Integration](/articles/integrate-customer/cleverpush-real-time-integration) destination for Journeys workflows. ## What this is Cleverpush is a web-based platform that enables website owners and developers to send push notifications (Push notifications are messages that can be delivered to users' devices, such as smartphones or desktop computers, even when they are not actively browsing the website.) to users who have subscribed to receive them. Integrated with Zeotap, it enables marketers to engage with their customers in real time and at scale. This source fetches information related to the subscribers of a Cleverpush channel, such as the subscription ID, channel ID, `created_at`, country, custom attributes and segments. In the Zeotap CDP App it sits under the **Customer Engagement Channels** source category, alongside the other engagement platforms listed on [Customer Engagement Channels](/articles/integrate-customer/customer-engagement-channels). Cleverpush has two source integrations and two destination integrations, and their names are easy to confuse. Use this table to confirm you are on the right page: | Page | Direction | What it does | | :- | :- | :- | | Cleverpush Real-Time Source (this page) | Cleverpush → Zeotap CDP | Posts subscriber and notification events to Zeotap over a webhook as they happen | | [Cleverpush (Batch) Source](/articles/integrate-customer/cleverpush-batch-source) | Cleverpush → Zeotap CDP | Fetches subscriber information from a channel in batches, using a Private API Key and a Channel ID | | [Cleverpush destination](/articles/integrate-customer/cleverpush-destination) | Zeotap CDP → Cleverpush | Sends the identifiers of a linked audience to Cleverpush | | [Cleverpush Real Time Integration](/articles/integrate-customer/cleverpush-real-time-integration) | Zeotap CDP → Cleverpush | Sends data from a Journeys workflow to Cleverpush | ## Supported identifiers The source brings in subscriber records from the Cleverpush channel it is connected to. The identifiers are: * **Channel ID** * **Subscription ID** * **Subscription platform name** (`Subscription.platformName`) Alongside them, the payload carries subscription and notification attributes including `Subscription.browserType`, `Subscription.createdAt`, `Subscription.syncedAt`, `Subscription.language`, `Subscription.country`, `Subscription.timezone`, `Subscription.customAttributes`, `Subscription.emailAddress`, `Subscription.optInIpAddress`, `Subscription.optInUrl`, `Subscription.topics`, `Notification.campaignId`, `Notification.campaignName`, `Notification.customData` and `Notification.feedGuid`. Which of these actually arrive depends on the webhook events you select in Cleverpush when you configure the webhook. The **Subscription ID** is also the identifier the [Cleverpush destination](/articles/integrate-customer/cleverpush-destination) needs in order to send audiences back to Cleverpush. Connecting a Cleverpush source is one of the two documented ways to obtain it; the other is ingesting it from a flat file. > [!NOTE] > > Although a country value appears in the Cleverpush payload, the records for the country and city columns are excluded from ingestion — Zeotap CDP resolves the country and the city from the user's IP address instead. For the complete list, see [Blacklisted fields for data ingestion](/articles/integrate-customer/blacklisted-fields-for-data-ingestion). ## Prerequisites * Access to the **Sources** application under **Integrate** in the Zeotap CDP App. * A Cleverpush channel with at least one platform set up on it. The webhook that feeds this source is configured per platform in Cleverpush, so the channel needs **Web Push**, **App Push** or **Email Push** configured before there is anywhere to add the webhook. For the channel-creation and platform-setup steps, see the [Cleverpush appendix](/articles/integrate-customer/cleverpush_appendix). * Access to the **Webhooks** settings of that platform in the Cleverpush console. You do not need a Cleverpush Private API Key or Channel ID to create this source — those are asked for by the [Cleverpush (Batch) Source](/articles/integrate-customer/cleverpush-batch-source). The real-time form asks only for a name, a region and a data entity. Authentication runs the other way round here: Cleverpush authenticates to Zeotap using the write key that Zeotap generates when the source is created. Treat that write key as a secret — copy it straight into the Cleverpush webhook rather than pasting it into a ticket, an email or a shared document. ## Create the Cleverpush Real-Time source Setting this source up takes two stages, one on each side of the integration. Each stage has its own page: **1. Create the source in Zeotap CDP** Create the source under **Sources**, choosing **Customer Engagement Channels** as the category and **Cleverpush Real-Time** as the data source, then enter a name, select a **Region** and choose the **Data Entity**. On successful creation, an **API URL** and a **Write Key** are generated and appear under the source's **IMPLEMENTATION DETAILS** tab. Both are needed for the next stage. See [Create a Cleverpush Real-Time Source](/articles/integrate-customer/create-a-cleverpush-real-time-source). **2. Configure the webhook in Cleverpush** In the Cleverpush console, open the channel and the platform you want to stream from, and add a webhook of **Type** **Custom**. Enter the API URL as the **Webhook URL**, supply the Write Key as the **Authorization Header Value**, choose the webhook events you want to send to Zeotap, and save. See [Implement a Cleverpush Real-Time Source](/articles/integrate-customer/implement-a-cleverpush-real-time-source). ## Verify the source is receiving data Open the source from the **SOURCES** listing page and check its status: * **Created** — the source exists but has not received any data yet. If it stays here, check that the webhook in Cleverpush is saved and uses the API URL and Write Key from the **IMPLEMENTATION DETAILS** tab, and that the events you expect are selected. * **Integrated** — data has started flowing in. You can now preview the incoming records on the **PREVIEW DATA** tab of the source. For what each status means, see [Components of the Source Listing Page](/articles/integrate-customer/components-of-the-source-listing-page); for how to read the sample, see [Components of the Preview Data Tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab). ## Next steps > [card] [Create a Cleverpush Real-Time Source](/articles/integrate-customer/create-a-cleverpush-real-time-source) > > Create the source in Zeotap CDP and collect the API URL and Write Key. > [card] [Implement a Cleverpush Real-Time Source](/articles/integrate-customer/implement-a-cleverpush-real-time-source) > > Configure the webhook in Cleverpush and choose the events to stream. > [card] [Cleverpush (Batch) Source](/articles/integrate-customer/cleverpush-batch-source) > > The other way to bring Cleverpush subscriber data into Zeotap CDP. > [card] [Cleverpush destination](/articles/integrate-customer/cleverpush-destination) > > Send an audience from Zeotap CDP out to Cleverpush. # Appendix for the Cleverpush sources Source: https://docs.zeotap.com/articles/integrate-customer/cleverpush_appendix Create a channel in Cleverpush and set up its Web Push, App Push and Email Push platforms, so the Cleverpush (Batch) and Cleverpush Real-Time sources have a channel to pull subscriber data from into Zeotap CDP. ## What this is The Cleverpush sources bring subscriber data from a Cleverpush channel **into Zeotap CDP**, and this page covers the Cleverpush-side groundwork they depend on: a **channel**, and the **platforms** that channel sends notifications through. Every step here happens in the Cleverpush console. Cleverpush is a web-based platform that enables website owners and developers to send push notifications (Push notifications are messages that can be delivered to users' devices, such as smartphones or desktop computers, even when they are not actively browsing the website.) to users who have subscribed to receive them. A channel is the container those notifications are sent from, and it is the channel that carries the **Channel ID** the source asks for. Zeotap CDP supports three Cleverpush platforms: **Web Push**, **App Push** and **Email Push**. Set up the ones you intend to collect subscriber data for. The Zeotap CDP side of each integration is covered on its own page: * [Create a Cleverpush (Batch) Source](/articles/integrate-customer/create-a-cleverpush-batch-source), for fetching subscriber data in batches. * [Create a Cleverpush Real-Time Source](/articles/integrate-customer/create-a-cleverpush-real-time-source) and [Implement a Cleverpush Real-Time Source](/articles/integrate-customer/implement-a-cleverpush-real-time-source), for streaming events as they happen. Data also flows the other way. To send audiences **out of Zeotap CDP to Cleverpush** so you can target them with notifications, see the [Cleverpush destination](/articles/integrate-customer/cleverpush-destination) or the [Cleverpush Real Time Integration](/articles/integrate-customer/cleverpush-real-time-integration). > [!NOTE] > > These channel and platform steps are the same for every Cleverpush integration, and each integration keeps its own copy of them. **This page is the copy for the Cleverpush sources.** If you are setting up a Cleverpush destination, use its own appendix: > > * [Appendix for Cleverpush](/articles/integrate-customer/appendix-cleverpush-destination), for the [Cleverpush](/articles/integrate-customer/cleverpush-destination) destination. > * [Appendix: Cleverpush channel and platform setup](/articles/integrate-customer/appendix-cleverpush-real-time-integration), for the [Cleverpush Real Time Integration](/articles/integrate-customer/cleverpush-real-time-integration) destination. ## Prerequisites Confirm the following before you start: * **Access to your Cleverpush console.** Every step on this page is performed there. * **For Web Push, the domain of the site** you want to send browser notifications from. The setup wizard asks for the protocol and the domain separately, without a leading `http://` or `https://` and without a trailing path. The **Own domain** option is available for HTTPS sites only. * **For App Push, your own iOS or Android app** and the ability to add a Cleverpush SDK to it. The setup screen links Cleverpush's SDK documentation for Android, iOS, Cordova, React Native, Xamarin and Flutter. ## Create a new channel in Cleverpush **1. Open the Channels menu** Log into the Cleverpush console and navigate to **Channels** on the top navigation bar. **2. Add a channel** Under **Channels**, click **Add Channel**. ![The Cleverpush dashboard with the Channels menu open, listing the most recent channels above the All channels link and the highlighted Add Channel button](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/appendix_1.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=1d9704a20a7aab593d2df1c5b3672698) **3. Fill in the basic settings and save** Under **Basic Settings**, provide the following details: a. Enter a descriptive name for the channel. b. Click **Select file** to upload an icon for the channel. c. Choose the desired **Industry** from the drop-down menu. d. Click **Save Channel**. ![The Basic settings panel of a new Cleverpush channel, with the Name field, the Icon file picker, the Industry drop-down and the Save Channel button, and the Platforms list starting below it](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/appendix_2.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=ac914d5e7186661618decfb2051eb8f5) Once the channel is saved, its **Platforms** list appears below the basic settings. Set up each platform you want to collect data for using the sections that follow. ## Set up Web Push in Cleverpush Web Push reaches desktop and Android users through browser messages. Once you have created a channel, perform the following steps to set it up: **1. Open the channel's platforms** Log into the Cleverpush console and navigate to **Channels** in the top navigation bar. Select the channel you created and navigate to **Platforms**. **2. Start the Web Push setup** Click **Setup now** next to **Web Push**. ![The Platforms list for a Cleverpush channel, with the Web Push row highlighted and its Setup now button on the right, above the App Push, Facebook Messenger and WhatsApp rows](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/web_push_1.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=3aad1d04cc6a9f765bb95cc9e34669b8) **3. Enter the domain** On **Step 1: Enter domain**, select the protocol and enter the **Domain Name** of your site. Then choose **Own Domain** or **Cleverpush Subdomain** and click **Continue**. ![Step 1 of the Cleverpush Web Push wizard, showing the protocol drop-down and domain field above the Own domain and Cleverpush Subdomain choices, with the Continue button below](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/Web_Push_2.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=0cabf8d5d5c9653b018168c61c11e241) **4. Choose the subdomain** On **Step 2: Choose subdomain**, enter a **Subdomain name** and click **Continue**. Cleverpush notes on this screen that the subdomain cannot be changed later, so choose it deliberately. ![Step 2 of the Cleverpush Web Push wizard, showing the subdomain field followed by the fixed Cleverpush domain suffix, the warning that it cannot be changed later, and the Continue button](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/web_push_3.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=6b46136f186f1380e47a47c616959439) **5. Finish the setup** On the final step, click **Setup now**. ![The Cleverpush Web Push wizard with all three steps marked complete and a single Setup now button ready to finish the configuration](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/web_push_4.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=2e3868a9bc0600c6b396f8c8ad40b6bc) ## Set up App Push in Cleverpush App Push reaches iOS and Android users through your own native app. Perform the following steps to set it up: **1. Open the channel's platforms** Log into the Cleverpush console and navigate to **Channels** in the top navigation bar. Select the channel you created and navigate to **Platforms**. **2. Start the App Push setup** Click **Setup now** next to **App Push**. ![The Platforms list for a Cleverpush channel, with the App Push row highlighted and its Setup now button on the right, between the Web Push and Facebook Messenger rows](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/App_push_1.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=bfdcb69c2b9d43ab369664bd5751897a) **3. Confirm in the App Push panel** Click **Setup now** in the panel that opens. ![The Cleverpush App Push panel opened over the dimmed Platforms list, with its description and a single Setup now button](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/app_push_2.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=3e2af0317db26fe3a2c77b81c7436a6b) **4. Add the SDK to your app** Choose the relevant SDK documents to set up App Push in your app. ![The Cleverpush App Push Implementation screen, whose App SDKs section lists documentation buttons for Android, iOS, Cordova, React Native, Xamarin and Flutter](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/app_push_3.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=1ba6cd3e59854d3b939dece637b4ad38) ## Set up Email Push in Cleverpush Email Push covers registration forms, double opt-in routines and newsletters. In the Cleverpush console this platform is listed as **Email**, further down the Platforms list than Web Push and App Push. Perform the following steps to set it up: **1. Open the channel's platforms** Log into the Cleverpush console and navigate to **Channels** in the top navigation bar. Select the channel you created and navigate to **Platforms**. **2. Start the Email setup** Scroll down the Platforms list and click **Setup now** next to **Email**. ![The lower part of the Cleverpush Platforms list, with the Email row highlighted and its Setup now button on the right, among the Telegram, SMS, Web Stories, Surveys and Wallet Push rows](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/email_push_1.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=4a90e7f64de4e577525e9948dd212c97) **3. Confirm in the Email panel** Click **Setup now** in the panel that opens. ![The Cleverpush Email panel opened over the dimmed Platforms list, with its description and a single Setup now button, and the channel's already-configured platforms listed in the left panel](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush_appendix/email_push_2.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=7d795d081673f35f8b732a8312dbff0b) ## Verify the platforms are set up Open the channel again and check the left panel: the platforms you have configured are listed there under **PLATFORMS**. A platform that is still listed only in the main **Platforms** list, with a **Setup now** button beside it, has not been set up yet. This matters for the source you are about to create. The **Channel ID** that the Cleverpush (Batch) source asks for is read from a platform's settings, so the channel needs at least one platform set up before there is a Channel ID to copy. For where to find it, see [Create a Cleverpush (Batch) Source](/articles/integrate-customer/create-a-cleverpush-batch-source). ## Next steps > [card] [Create a Cleverpush (Batch) Source](/articles/integrate-customer/create-a-cleverpush-batch-source) > > Gather the Private API Key and Channel ID, then create the batch source in Zeotap CDP. > [card] [Create a Cleverpush Real-Time Source](/articles/integrate-customer/create-a-cleverpush-real-time-source) > > Create the real-time source, then add its webhook to the platform you set up here. > [card] [Cleverpush (Batch) Source](/articles/integrate-customer/cleverpush-batch-source) > > What the batch integration fetches and where it sits in the source catalogue. > [card] [Cleverpush destination](/articles/integrate-customer/cleverpush-destination) > > The opposite direction: send audiences out of Zeotap CDP to Cleverpush. # Components of the Source Listing Page Source: https://docs.zeotap.com/articles/integrate-customer/components-of-the-source-listing-page Reference guide to the columns, statuses, actions, and reports on the Sources listing page in the Zeotap CDP. ## What this is The Source Listing page is the main view in the Zeotap CDP's Integrate module where every source you have created is displayed alongside its category, lifecycle status, record counts, and last-refresh timestamps. Use it to check whether a new source is receiving data, whether an existing source has ingestion errors, and to open the Source Report for a deeper look at ingestion trends. This page describes each column, the source statuses you can see, the actions available from the row menu, the column-visibility control, and the four charts that make up the Source Report. ![Source Listing page showing sources with their status, record counts, and timestamps](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/components-of-the-source-listing-page/components-of-the-source-listing-page-2024-09-23.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=51f868fa19ab73d5384d2c05ced92e13) ## Prerequisites > [!NOTE] > > To read the Source Listing page you need access to the Integrate module in the Zeotap CDP App and at least one source created in your account. If no sources exist yet, create one first — for example, a [Snowflake source](/articles/integrate-customer/create-a-snowflake-source), a [Databricks source](/articles/integrate-customer/set-up-a-databricks-source), a [Batch source](/articles/integrate-customer/create-a-batch-source), or a [Web Pixel, Web iFrame, or App Pixel source](/articles/integrate-customer/2676392376). ## Read the columns on the Source Listing page The Source Listing page displays the following columns for every source in your account. | Column | What it shows | | - | - | | **ID** | An identifier auto-generated by the system when the source is created. | | **Source Name** | The name you provided when creating the source. Under the name three additional details are shown: a **Category** icon indicating the source category, the **Data Source** (for example, Flat File, Website Events), and a **Data Entity** tag of either `CE` (Customer Data) or `NCE` (Non-Customer Entity Data). An alert icon appears beside the source when an erroneous record has been ingested in the last 90 days, and remains until the errors are fixed. For flat files, the erroneous files have to be deleted and replaced with corrected files. | | **Status** | The current lifecycle state of the source. See the [status reference](#status-reference) below. | | **Total Records Ingested** | The total count of records ingested and available for activation from this source, over the source's lifetime. Hover the number to see a pie-chart breakdown — described in [Interpret the Total Records pie chart](#interpret-the-total-records-pie-chart). | | **Last Ingested** | The timestamp of the last fully processed record or file for this source. | | **Created Date** | The date the source was created. | | **Created By** | The user ID of the user who created the source. | | *(row menu)* | A three-dot icon at the end of each row, with no column header of its own, exposes the actions permitted by the source's current status. See [Actions available from the row menu](#actions-available-from-the-row-menu). | ### Status reference The Status column shows one of the following values. | Status | What it means | | - | - | | `Created` | The source exists in the Sources module but has not yet received any data. | | `Integrated` | Data has started flowing into the source, but taxonomy standardisation has not been applied. Incoming data can be previewed on the source's **Preview Data** tab. | | `Mapped` | At least one data collection has been created on top of the source using the common taxonomy. | | `Archived` | The source is archived for future ingestion. See [Archived Source](/articles/integrate-customer/archived-source) for details. | | `Paused` | Both data collection and data ingestion are paused. | | `Paused (Collection)` | Data collection is paused; the write key on the source page is invalidated. | | `Paused (Ingestion)` | Data ingestion is paused. | ## Interpret the Total Records pie chart Hovering the number in the **Total Records Ingested** column opens a pie-chart pop-up with four values: * **Ingested** — the total number of records ingested and available for activation. * **Failed** — the records that failed to ingest during ingestion. * **Ingestion Efficiency** — the percentage of ingested records against total records received. * **Last Refreshed Date** — the date and time the values in the pop-up were last updated. The counts cover the lifetime of the source — from the date it was created in Zeotap CDP. ![Total Records pie-chart pop-up showing Ingested, Failed, Ingestion Efficiency, and Last Refreshed Date](https://mintcdn.com/zeotap/puXmsvA7x0OblYvo/articles/integrate-customer/Storage/integrate-customer/project-collect-internal/totalrecords_pie.png?fit=max\&auto=format\&n=puXmsvA7x0OblYvo\&q=85\&s=68425796ce20b4b72ca4e10308e266e1) ## Actions available from the row menu Clicking the three dots at the end of a source row opens a drop-down. The actions offered depend on the source's status and source type: pause, rename, archive, edit mapping, pause data collection, pause data ingestion, resume data collection, and resume data ingestion. > [!WARNING] > > Pausing data collection invalidates the write key on the source page and stops all data collection into that source. To avoid errors on the source page, remove the tags before you pause collection. * Pausing both data ingestion and data collection moves the source to the `Paused` state. * Saving the mapping for a paused source moves the source to the `Mapped` state. ## Open the Source Report The **Source Dashboard** button above the table opens a report that shows the data journey and record-status information in one place, through four charts. You can also reach it from the **SOURCE REPORT** tab on a source's details page. The report dashboard refreshes every 8 hours. ### Chart 1 — Source Ingestion Trend Visualises cumulative event data over time. The y-axis is the cumulative count of ingested records; the x-axis is the start of the week. The chart supports filtering by **24h**, **7d**, **30d**, or **90d**, and the filtered view can be downloaded as CSV. ![Source Ingestion Trend chart showing cumulative ingested records over time](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/components-of-the-source-listing-page/components-of-the-source-listing-page-2024-09-23-2.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=10d31c6db1f2d4e60a8b3cc161eda463) ### Chart 2 — Batch vs Streaming Ingestion Trend Displays the count of ingested events over time, split between **Batch Sources** and **Streaming Sources**. The y-axis is the number of ingested events; the x-axis is the date. ![Batch vs Streaming Ingestion Trend chart comparing batch and streaming sources](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/components-of-the-source-listing-page/components-of-the-source-listing-page-2024-09-23-3.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=fa5dcb77131cb0d33e2f65ddb274c925) ### Chart 3 — Top Sources Ingestion Trend Displays the number of ingested events over time for your top data sources, ranked by cumulative ingestion records. Filter the chart by time period — **24h**, **7d**, **30d**, or **90d**. ![Top Sources Ingestion Trend chart showing ingested events for top data sources](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/components-of-the-source-listing-page/components-of-the-source-listing-page-2024-09-23-4.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=c45ea9eb657e798e141551abed9239c6) ### Chart 4 — Batch Sources Report A tabular report on batch sources with the following columns: **Date** (the date the batch was received), **Source Name**, **Source Type** (for example, Zeotap Google Cloud, SFTP, JS, Web pixel), **File Name** (the name of the file ingested), **Status** (the current status of the batch), **Received Records** (the number of records received from the source), and **Ingested Records** (the number of records successfully ingested). ![Batch Sources Report table listing batch files with received and ingested record counts](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/components-of-the-source-listing-page/components-of-the-source-listing-page-2024-09-23-5.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=4fe77e3e9956dc94bee2b38fc70ab622) ## Choose which columns are visible The column-selection drop-down above the table lets you show or hide columns. The following four columns are mandatory and cannot be deselected: **ID**, **Source Name**, **Status**, and **Total Records Ingested**. Every other column can be toggled on or off. ![Column-selection drop-down on the Source Listing page with mandatory columns locked](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/components-of-the-source-listing-page/components-of-the-source-listing-page-2024-08-12-3.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=caf2d54b80453204bd93e43ab13a9b0c) ## Verify you are reading the page correctly You are reading the Source Listing correctly when: * The **Status** column matches the source's stage — a source you just created shows `Created`, a source with data flowing but no data collection shows `Integrated`, and a source with at least one data collection shows `Mapped`. * Hovering **Total Records Ingested** opens the pie chart with **Ingested**, **Failed**, **Ingestion Efficiency**, and **Last Refreshed Date** populated. * The **Last Ingested** timestamp advances after each successful sync. * The Source Report opens from **Source Dashboard** and its **Last Refreshed Date** is within the last 8 hours. ## Why this happens Use the table below to map a signal on the Source Listing page to what it means and where to look for more detail. | Signal | What it means | Where to look | | - | - | - | | Alert icon beside a source name | An erroneous record has been ingested in the last 90 days | Sources listing → the affected source row; open the source for record-level detail | | Status `Created` | The source exists but has not received data yet | Sources listing → Status column | | Status `Integrated` | Data is flowing but taxonomy standardisation has not been applied | Sources listing → Status column; then the source's **Preview Data** tab | | Status `Paused (Collection)` | Data collection is paused and the write key on the source page is invalidated | Sources listing → Status column; row menu → resume data collection | | Status `Paused (Ingestion)` | Data ingestion is paused | Sources listing → Status column; row menu → resume data ingestion | | Status `Paused` | Both data collection and data ingestion are paused | Sources listing → Status column; row menu → resume both | | `Ingestion Efficiency` below 100% | Some records failed to ingest | Hover **Total Records Ingested** to see the **Failed** count | ## When to contact support Contact your Zeotap customer success representative, or the Zeotap support team at [support@zeotap.com](mailto:support@zeotap.com), when: * An alert icon persists on a source row after you have deleted and replaced the erroneous flat files. * The **Last Ingested** timestamp has not advanced across two successive sync intervals for a source in `Integrated` or `Mapped` state. * The **Ingestion Efficiency** value stays below 100% and you cannot identify the failed records from the source's Preview Data tab. * The Source Report dashboard has not refreshed for more than 8 hours. Include the following in your request so support does not have to ask for it: the source ID, the source name, the current Status value, the Last Ingested timestamp, and a screenshot of the Total Records pie chart pop-up. ## Next steps * Explore [Archived Source](/articles/integrate-customer/archived-source) → * Explore [Create a Snowflake Source and Load Data](/articles/integrate-customer/create-a-snowflake-source) → * Explore [Set Up a Databricks Source](/articles/integrate-customer/set-up-a-databricks-source) → * Explore [Create a Batch Source](/articles/integrate-customer/create-a-batch-source) → * Explore [Create a Web Pixel/Web iFrame/App Pixel Source](/articles/integrate-customer/2676392376) → ## FAQ > [accordion] Why does an alert icon still appear on my source row? > > The alert icon remains until every erroneous record ingested in the last 90 days is resolved. For flat-file sources, that means deleting the erroneous files and replacing them with corrected files. If the icon persists after you have replaced the files, contact support with the source ID and the timestamp of the replacement upload. > [accordion] How current are the numbers in the Source Report charts? > > The Source Report dashboard refreshes every 8 hours. The **Last Refreshed Date** shown in the Total Records pie-chart pop-up tells you exactly when the values on the row itself were last updated. > [accordion] Can I hide the ID or Status columns from the listing? > > No. **ID**, **Source Name**, **Status**, and **Total Records Ingested** are mandatory and cannot be removed from the column selector. Every other column can be toggled on or off. > [accordion] What is the difference between Paused, Paused (Collection), and Paused (Ingestion)? > > `Paused (Collection)` stops data being collected at the source and invalidates the write key. `Paused (Ingestion)` stops data being ingested into Zeotap CDP but leaves collection intact. `Paused` means both are stopped — pausing both from the row menu is what moves a source to the `Paused` state. # Create a Batch Source Source: https://docs.zeotap.com/articles/integrate-customer/create-a-batch-source Create a Batch source in Zeotap CDP to ingest user data from Batch on a schedule you choose, using Batch's built-in connector under Customer Engagement Channels. ## What this is A Batch source brings user data out of [Batch](/articles/integrate-customer/batch-source) — a mobile marketing automation platform for push notifications, email, SMS and in-app messaging — and into Zeotap CDP. Batch is listed under the **Customer Engagement Channels** category and uses Batch's built-in connector, so no custom pipeline is required: you authenticate with two keys taken from the Batch dashboard, then Zeotap fetches data on the sync frequency you choose, as JSON or CSV files. Creating the source is only the first stage. Once records are arriving, map the source's fields to the catalogue so they resolve into unified customer profiles — see [Map the Catalogue](/articles/unify-customer/map-the-catalogue). ## Prerequisites > [!NOTE] > > Before you create a Batch source, confirm: > > * You have a Batch account and can open the Batch dashboard. > * You have permission to create sources in your Zeotap CDP tenant. > * You know the region where the records live, so you can set the region of upload — see [Region of Storage](/articles/integrate-customer/region-of-storage). ## Obtain your Batch API keys Collect the following details from the Batch console before you start in Zeotap CDP. **1. Open the Batch settings page** Navigate to the Batch dashboard and click **SETTINGS** from the top panel, as shown below. ![SETTINGS in the top panel of the Batch dashboard](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/create-a-batch-source/create-a-batch-source-2024-07-06-1.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=1665349650b7854f0fffed2733af73e0) **2. Copy the Live API Key and the REST API Key** The **General** tab of the **SETTINGS** page displays the API keys. Copy the **Live API Key** and the **REST API Key** — you enter both while creating the source in Zeotap CDP. ![General tab of the Batch SETTINGS page, showing the Live API Key and REST API Key](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/create-a-batch-source/create-a-batch-source-2024-02-06-1.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=5004961392b860bd71f2a7a9f31cfab9) ## Create the source Perform the following steps to establish a connection with Batch by using their built-in connector through Sources. **1. Open the Sources application** Navigate to the **Sources** application under **Integrate**, in the Zeotap CDP App. **2. Start a new source** Click **CREATE SOURCE**. **3. Choose the category** Choose **Customer Engagement Channels** as the Category. ![Customer Engagement Channels selected as the source Category](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/create-a-batch-source/create-a-batch-source-2024-02-06-2.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=62ba476089a8fdf7aa41d81b91476ebd) **4. Choose Batch as the data source** Click **Batch** as the Data Source. ![Batch selected as the Data Source within Customer Engagement Channels](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/create-a-batch-source/create-a-batch-source-2024-02-06-3.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=55e9b7520652f20e8ee312d084bdea2d) **5. Enter the source details** In the window that appears, provide the following details: * **Source Name** — enter a name for the source. * **REST API Key** and **Live API Key** — enter the keys you obtained from Batch. * **Data Entity** — select the entity type for the data you are ingesting. A Batch source carries **Customer Data (CE)** only. To know more about Customer Data and Non Customer Data, refer to [Supported Data Entities](/articles/unify-customer/supported-data-entities). * **Region** — select the region of upload. * **Sync Frequency** — choose the desired frequency from the drop-down list. The first data sync takes place once you create the source; subsequent syncs take place based on the frequency you select here. Zeotap currently supports **Daily**, **Weekly** and **Monthly**. * **File Type** — choose either **JSON** or **CSV** from the drop-down menu. If you choose **CSV**, you must also provide the **file delimiter**: a character or sequence of characters used to separate individual data fields within a file. This can be a **comma**, **tab** or **semicolon**. ![Batch source configuration window with the API keys, Data Entity, Region, Sync Frequency and File Type fields](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/create-a-batch-source/create-a-batch-source-2024-02-06-5.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=565fd46974c1e0d439d5e9844c8482bd) **6. Create the source** Click **CREATE SOURCE**. ## Verify the source was created * The new source appears on the **SOURCES** listing page. * Open the source you created. The **IMPLEMENTATION DETAILS** tab carries the essential details of that source. * The first data sync runs as soon as the source is created. Open the **SOURCE REPORT** tab on the source detail page to follow the ingestion health and status of the source — see [Source Report](/articles/integrate-customer/source-report). * Map the source's fields to the catalogue before you use it downstream. An unmapped source does not resolve into unified profiles and cannot be used in an audience. ## Troubleshooting * **No new data after the first sync** — after the initial sync that runs at creation, Zeotap fetches data on the **Sync Frequency** you selected, so the next run of a weekly or monthly source can be several days away. Check the last run on the **SOURCE REPORT** tab. * **Data is arriving but the source is not selectable in an audience** — the source has not been mapped to the catalogue yet. See [Map the Catalogue](/articles/unify-customer/map-the-catalogue). * **The source has stopped ingesting altogether** — check whether it has been archived. Archiving retains the data already ingested but pauses all future ingestion; unarchiving resumes it. See [Archived Source](/articles/integrate-customer/archived-source). * **You want to be alerted when ingestion fails, rather than checking the report** — Zeotap can email designated recipients on pull-failure, ingestion-failure, delayed-ingestion and no-data conditions. See [Sources](/articles/integrate-customer/sources) for the alert conditions, and contact your Zeotap customer success representative to enable them for your organisation. ## FAQ > [accordion] When does the first sync happen, and how often after that? > > The first data sync takes place once you create the source. Every subsequent sync follows the **Sync Frequency** you chose during creation — **Daily**, **Weekly** or **Monthly**. > [accordion] Do I have to provide a file delimiter? > > Only when you choose **CSV** as the **File Type**. The delimiter is the character or sequence of characters that separates individual data fields within the file, and it can be a comma, a tab or a semicolon. JSON files need no delimiter. > [accordion] Where do I find the details of the source after creating it? > > Open the source from the **SOURCES** listing page. The **IMPLEMENTATION DETAILS** tab carries the essential details of the source, and the **SOURCE REPORT** tab carries its ingestion health and status. > [accordion] How soon after mapping does ingestion begin? > > Once a source is mapped, ingestion may take up to 15 minutes to begin; the delay accounts for processing the data collected between the time the source was integrated and when it was mapped. For sources that share data as files, ingestion of each file begins within 15 minutes of the file being dropped successfully. See [Exploring Source Reports](/articles/integrate-customer/exploring-source-reports). ## Next steps * [Explore the Batch source overview →](/articles/integrate-customer/batch-source) * [Explore the Customer Engagement Channels category →](/articles/integrate-customer/customer-engagement-channels) * [Explore how to map a source to the catalogue →](/articles/unify-customer/map-the-catalogue) * [Explore the Source Report tab →](/articles/integrate-customer/source-report) * [Explore sending audiences to Batch as a destination →](/articles/integrate-customer/batch) # Create and Implement a BigQuery Source Source: https://docs.zeotap.com/articles/integrate-customer/create-a-bigquery-source Bring data into Zeotap CDP from a Google BigQuery table — gather the project, dataset and table details, create the Data Warehouse source, and grant Zeotap read access in the Google Cloud console. This page covers the **Google BigQuery source** — pulling data **into** Zeotap CDP from a table in your BigQuery project. To send Zeotap audience data **out** to BigQuery instead, see [Google BigQuery destination](/articles/integrate-customer/google-bigquery-destination). ## What this is Zeotap simplifies the data onboarding process by letting you connect directly to the source data residing in [BigQuery](https://cloud.google.com/bigquery/) through the Sources application, within Zeotap CDP. The integration sits in the **Data Warehouse** source category: you point it at one project, dataset and table, choose how often Zeotap re-reads that table, and the records are ingested as either Customer Data or Non Customer Data. You can harness the Zeotap–Google BigQuery source integration to strengthen your data analytics capacities. It also empowers you to analyse diverse datasets, create precise customer segments, curate personalised content and refine advertising strategies. Setting up the integration takes two passes: 1. Create a Google BigQuery source within Zeotap CDP. 2. Integrate the created source with the Google BigQuery platform. ## Prerequisites > [!NOTE] > > Before you create a BigQuery source in the Sources application, confirm: > > * You have an account with BigQuery, and the data you want to import into Zeotap already resides in that account. > * You know the **Project ID**, **Dataset** and **Table** that hold the data — see [Gather the BigQuery and sync details](#gather-the-bigquery-and-sync-details). > * You have decided the **Region** the data is ingested into and the **Sync frequency** the source should run on. > * You have decided who the **Service Account Owner** is — **Customer** or **Zeotap**. If **Customer**, create the JSON key file in Google Cloud beforehand and have it ready to upload. > * The table you are ingesting does not use JSON column types. Zeotap CDP does not support tables with JSON column types. ## Supported identifiers and data entities You can ingest any identifier or attribute of your choice from a BigQuery table into Zeotap CDP. The BigQuery source supports **delta fetch**, so a run can be restricted to the rows that changed since the previous run. ### Data entities Zeotap supports the following two groups of data entities: * **Customer Data** — refers to a wide range of information, such as demographic, behavioural, product-related, derived and modelled information. This data is gathered from various brand interfaces, platforms, tools and services. * **Non-customer Entity Data** — refers to data that is not directly tied to a user but to an attribute associated with the user. The most common forms of Non-Customer Entity Data are product catalogues, order data, feed data, campaign data, account data and so on. In the source form this group is labelled **Non Customer Data**. For more information on the data entities supported by Zeotap CDP, see [Supported data entities](/articles/unify-customer/supported-data-entities). ## Gather the BigQuery and sync details Collect the following before you open the source form. The Zeotap-side settings come first, then the values you read out of the Google Cloud console. * **Source Name** — the name you will see within Zeotap once you successfully create the source. * **Region** — the region where the data needs to be stored. Zeotap currently supports data ingestion in the following regions: * **EU** — all EU countries' data is ingested to the bucket provisioned for you in the EU region. * **UK** — the United Kingdom's data is ingested to the bucket provisioned for you in the UK region. * **Sync frequency** — defines how often data is ingested from the source. Zeotap currently supports Sync once, Every hour, Every 3 hours, Every 6 hours, Every 12 hours, Daily, Weekly and Monthly. * **Sync Time** — when you choose **Daily**, **Weekly** or **Monthly** as the sync frequency, you can specify the exact time for the sync to occur. * **Sync Period** — indicates whether the selected **Sync Time** is in the **AM** or **PM**. * **Sync Day** — if **Weekly** sync is selected, you can specify the **day of the week** on which the sync should run. * **Monthly Sync date** — if **Monthly** sync is selected, you can specify the **day of the month** on which the sync should run. * **Data Entity** — whether the records you are ingesting are **Customer Data** or **Non Customer Data**. See [Data entities](#data-entities) for what each group covers. ### Project ID A Project ID is a unique string that differentiates your project from all others on Google Cloud. You can use the [Google Cloud console](https://cloud.google.com/resource-manager/docs/creating-managing-projects?hl=en) to generate a Project ID. You can find the Project ID in the Google Cloud console [Dashboard page](https://console.cloud.google.com/projectselector2/home/dashboard). In the example below, the Project name is **My Sample Project** and the Project ID is **my-sample-project-191923**. ![Google Cloud console dashboard showing the Project name and Project ID](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-bigquery-source/create-a-bigquery-source-2023-05-22.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=2b7303c6c70f903ed69ca389eb51e417) ### Dataset Datasets are top-level containers that are used to organise and control access to your tables and views. In the example below, the Dataset is **GBQ_dataset**. ![BigQuery explorer showing a dataset inside a project](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-bigquery-source/create-a-bigquery-source-2023-05-22-1.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=2620ef432f1d75ee3117b689d89cf016) ### Table A BigQuery table contains individual records organised in rows. Each record is composed of columns/fields. Every table is defined by a schema that describes the column names, data types and other information. In the example below, the tables are **Demotest, DemotestBQ, Table006, Table007** and **TableBQ**. Zeotap CDP does not currently support tables with JSON column types. ![BigQuery explorer showing the tables inside a dataset](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-bigquery-source/create-a-bigquery-source-2023-05-22-2.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=17b5a050b30db03450ae77b5cc76e0f6) ### Service Account Owner In the Google BigQuery source integration, a Service Account Owner refers to a user account that has owner privileges for configuring and overseeing significant queries within the integration. This ownership entails the authority to view, modify and manage the data in Google BigQuery. The responsibilities of a Service Account Owner in Google BigQuery include performing administrative tasks, managing passwords and permissions, and configuring service accounts for integration with external data sources within the Google Cloud Platform (GCP). Select the Service Account Owner based on your requirement. You can choose either **Customer** or **Zeotap**: * If you select **Customer**, a section appears where you upload the JSON key file that you have created. Click **+ SELECT FILE** to upload the JSON key file. To learn how to create a JSON key file, see [Create and delete service account keys](https://cloud.google.com/iam/docs/keys-create-delete) in the Google Cloud documentation. * If you select **Zeotap**, you can proceed directly to the **Data Entity** selection step. ### Service Account Key JSON The Service Account Key JSON is necessary to use a service account from outside of Google Cloud, such as on other platforms or on-premises. For information on creating a Service Account Key JSON in the Google Cloud console, see [Create and delete service account keys](https://cloud.google.com/iam/docs/keys-create-delete). ![Google Cloud console panel for creating a service account key in JSON format](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-bigquery-source/create-a-bigquery-source-2023-05-22-3.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=271123eb8ae7e230598bda807485916d) Once you create a JSON key, store the key file securely so you can authenticate your service account later. The downloaded key has the following format, where `PRIVATE_KEY` is the private portion of the public/private key pair: ```json theme={null} { "type": "service_account", "project_id": "PROJECT_ID", "private_key_id": "KEY_ID", "private_key": "-----BEGIN PRIVATE KEY-----\nPRIVATE_KEY\n-----END PRIVATE KEY-----\n", "client_email": "SERVICE_ACCOUNT_EMAIL", "client_id": "CLIENT_ID", "auth_uri": "https://accounts.google.com/o/oauth2/auth", "token_uri": "https://accounts.google.com/o/oauth2/token", "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs", "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/SERVICE_ACCOUNT_EMAIL" } ``` > [!WARNING] > > The service-account key grants access to your BigQuery data. Keep the JSON file out of tickets, chat threads and version control. ## Create the BigQuery source in Zeotap CDP After you have obtained all the information described above, perform the following steps to create a BigQuery source within Zeotap CDP. **1. Open the Sources application** Navigate to the Sources application in the Zeotap CDP App. **2. Start a new source** Click **CREATE SOURCE**. **3. Choose the category** Choose **Data Warehouse** as the Category. ![Source category picker with Data Warehouse selected](https://mintcdn.com/zeotap/1FGgO964H8EKim6t/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/create_snowflake_1.png?fit=max\&auto=format\&n=1FGgO964H8EKim6t\&q=85\&s=f4e37183d8d62b4a2ef55a4501114c69) **4. Choose Google BigQuery** Select **Google BigQuery** as the data source. ![Data Warehouse source picker with Google BigQuery listed](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-bigquery-source/create-a-bigquery-source-2024-10-21.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=435ca2831084454676dd0a633b2c4dc2) **5. Enter the BigQuery details** Enter the information below, based on your BigQuery account. How to procure each of these details is covered in [Gather the BigQuery and sync details](#gather-the-bigquery-and-sync-details). * Sync frequency * Project ID * Dataset * Table ![BigQuery source form showing the sync frequency, project, dataset and table fields](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-bigquery-source/create-a-bigquery-source-2023-05-23.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=791402d7f36f099ed1941e72b21bdbee) **6. Select the Service Account Owner** Select the **Service Account Owner** based on your requirement. You can choose either **Customer** or **Zeotap**. * If you select **Customer**, a section appears where you upload the JSON key file that you have already created. Click **+ SELECT FILE** to upload it. To learn how to create a JSON key file, see [Create and delete service account keys](https://cloud.google.com/iam/docs/keys-create-delete). * If you select **Zeotap**, proceed directly to the **Data Entity** selection step. ![Service Account Owner set to Customer, with the JSON key file upload control](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-bigquery-source/create-a-bigquery-source-2023-05-22-7.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=c5e697fd35cb5f5e7e2fcbc248decaee) **7. Choose the Data Entity** Under **Data Entity**, depending on the type of data that you want to ingest, choose either **Customer Data** or **Non Customer Data**, then proceed with the source creation. For what each group covers, see [Data entities](#data-entities). ![Data Entity selection offering Customer Data and Non Customer Data](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-bigquery-source/create-a-bigquery-source-2023-05-22-8.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=c2eba12725b0e6ad75490980f5344edb) **8. Set the Delta Queries Selection** Under **Delta Queries Selection**, decide whether or not you want to consider deltas (data additions/changes) in a dataset for a specific time period, based on the values of the timestamp column. Based on your requirement, select either **true** or **false**. ![Delta Queries Selection toggle set on the BigQuery source form](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-bigquery-source/create-a-bigquery-source-2023-05-22-9.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=3a41aecd8ce7a3ca7b8f03b03280b736) If you select **true**, the fields **Delta Column Name** and **Delta Column Data Type** are enabled, and you must provide the following details: * Under **Delta Column Name**, provide the name of the column that you want to fetch data from. * Under **Delta Column Data Type**, choose the time increment for fetching the data from the selected column. ![Delta Column Name and Delta Column Data Type fields enabled](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-bigquery-source/create-a-bigquery-source-2023-05-22-10.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=5ef77403530a5665787eb96ce739fe03) If you select **false**, you are not required to make any additional selections. You can proceed directly to the source creation step. **9. Create the source** Click **CREATE SOURCE**. ## Integrate the created source with the Google BigQuery platform Upon successfully creating the source within Zeotap CDP, go to the **IMPLEMENTATION DETAILS** tab. Under this tab, you can find details about the created source, based on the Service Account Owner selected. ### Scenario 1 — Zeotap is the Service Account Owner If you selected **Zeotap** as the **Service Account Owner** while creating the source, perform the following steps to integrate the source with the Google BigQuery platform. **1. Copy the Service URL** In the **IMPLEMENTATION DETAILS** tab, under **Access Details**, copy the **Service URL**. ![Access Details section of the Implementation Details tab showing the Service URL](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-bigquery-source/create-a-bigquery-source-2023-05-22-12.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=dde2c58c5bfb90eee8ada3501d5f69fe) **2. Open your BigQuery project** Go to the Google BigQuery console and open your project. **3. Open the project in a new tab** On your project, click the three dots and click **Open in > New tab**. ![BigQuery project overflow menu with the Open in New tab option](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-bigquery-source/create-a-bigquery-source-2023-05-22-13.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=d5bac87376bc52982998284cb5c2dbdf) **4. Open the permissions panel** In the new tab, click **SHARING** and then click **Permissions**. ![Sharing menu in BigQuery with the Permissions option](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-bigquery-source/create-a-bigquery-source-2023-05-22-19.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=e1e6eeb6bcac0ea962b9d9c3e1f06a7d) **5. Add a principal** Click **ADD PRINCIPAL**. ![BigQuery permissions panel with the Add Principal control](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-bigquery-source/create-a-bigquery-source-2023-05-22-15.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=6e6c72135b792d05182b43d53026c2de) **6. Paste the Service URL** Under **Add principals**, in the **New principals** field, paste the **Service URL** that you copied earlier. **7. Assign the role** Under **Assign roles**, choose **BigQuery > BigQuery Data Viewer**. ![Assign roles picker with BigQuery Data Viewer selected](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-bigquery-source/create-a-bigquery-source-2023-05-22-16.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=70f32c22ed12814e1b731289969f5b41) **8. Save the grant** Click **SAVE**. **9. Test the connection** Return to the **IMPLEMENTATION DETAILS** tab. Beside the **Service URL** field, click **TEST CONNECTION**. ![TEST CONNECTION control beside the Service URL field](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-bigquery-source/create-a-bigquery-source-2023-05-22-17.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=fda21f292d3a340cd61b15fb4fc5bda0) **10. Confirm the result** Upon successful integration, a message appears confirming that the connection is successfully established, allowing you to begin data ingestion. ![Confirmation message that the BigQuery connection was successfully established](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-bigquery-source/create-a-bigquery-source-2023-05-22-18.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=a25f94072ef8b3fd40ba787e30ca3807) ### Scenario 2 — Customer is the Service Account Owner If you selected **Customer** as the **Service Account Owner** while creating the source, the **IMPLEMENTATION DETAILS** tab appears as shown in the image below. In this case, no additional steps are needed to integrate the source with the Google BigQuery platform. ![Implementation Details tab for a BigQuery source with Customer as the Service Account Owner](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-bigquery-source/CUSTOMER_gbq.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=8d1e21121984c306b5928c657ced8b41) ## Verify the source is ingesting data * **Scenario 1 only** — **TEST CONNECTION** on the **IMPLEMENTATION DETAILS** tab returns a message confirming that the connection is successfully established. * The source appears on the Sources listing. Once data begins flowing into the source, the source status changes to **Integrated** and the **Preview Data** tab is populated. Open that tab to confirm the columns and values that arrived before you map them in the Catalogue — see [Components of the Preview Data tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab). ## Troubleshooting | What you see | What to check | | - | - | | **TEST CONNECTION** does not confirm the connection (Scenario 1) | Re-open **SHARING → Permissions** on the BigQuery project and confirm that the principal you added is exactly the **Service URL** shown under **Access Details**, and that the role assigned to it is **BigQuery Data Viewer**. | | The table you want to ingest cannot be used | Confirm the table does not contain JSON column types — tables with JSON column types are not supported. | | Fewer rows arrive on each run than you expect | **Delta Queries Selection** is set to **true**, so only rows whose timestamp column falls in the delta window are fetched. Confirm **Delta Column Name** names the timestamp column you intended and that **Delta Column Data Type** matches its time increment, or set **Delta Queries Selection** to **false** to re-read the full table on every run. | If the source still does not connect after re-checking the values above, contact the Zeotap support team at [support@zeotap.com](mailto:support@zeotap.com). Include the source name, the Service Account Owner you selected, the Project ID, Dataset and Table, and the time of the failed attempt. ## FAQ > [accordion] Should I choose Customer or Zeotap as the Service Account Owner? > > Both are supported. If you choose **Zeotap**, you grant the Zeotap **Service URL** the **BigQuery Data Viewer** role on your project after the source is created (Scenario 1). If you choose **Customer**, you upload your own service-account JSON key during source creation and no further steps are needed on the BigQuery side (Scenario 2). > [accordion] How often can the BigQuery source sync? > > The supported sync frequencies are Sync once, Every hour, Every 3 hours, Every 6 hours, Every 12 hours, Daily, Weekly and Monthly. For Daily, Weekly and Monthly you also set a Sync Time and Sync Period (AM/PM), plus the day of the week for Weekly and the day of the month for Monthly. > [accordion] Can I ingest only the rows that changed since the last sync? > > Yes. Set **Delta Queries Selection** to **true**, then name the timestamp column under **Delta Column Name** and choose the time increment under **Delta Column Data Type**. Setting it to **false** re-reads the full table on every run. > [accordion] Are tables with JSON columns supported? > > No. Zeotap CDP does not currently support BigQuery tables with JSON column types. > [accordion] Can I also send Zeotap data out to BigQuery? > > Yes, through a separate integration. See [Google BigQuery destination](/articles/integrate-customer/google-bigquery-destination). ## Next steps * [Explore the BigQuery source overview →](/articles/integrate-customer/bigquery) * [Explore best practices for BigQuery →](/articles/integrate-customer/best-practices-for-bigquery) * [Explore how to map the Catalogue for Customer Data (CE) →](/articles/unify-customer/map-the-catalogue-for-customer-data) * [Explore how to map the Catalogue for Non-Customer Entity (NCE) data →](/articles/unify-customer/map-the-catalogue-for-non-customer-entity-data) * [Explore how to add a Non-Customer Entity (NCE) attribute in the Catalogue →](/articles/unify-customer/adding-a-non-customer-entity-category) * [Explore the Join Key Enricher and how to configure it →](/articles/unify-customer/configuring-the-join-key-enricher) * [Explore the Google BigQuery destination →](/articles/integrate-customer/google-bigquery-destination) * [Explore the other Data Warehouse sources →](/articles/integrate-customer/data-warehouse) # Create a Braze Currents source Source: https://docs.zeotap.com/articles/integrate-customer/create-a-braze-currents-source Create a Braze Currents source so that engagement events streamed from Braze flow into Zeotap CDP, and collect the API URL and write key that Braze needs to send them. ## What this is A Braze Currents source brings data **into** Zeotap CDP: Braze streams your engagement events out of the Braze platform and Zeotap ingests them as batched JSON payloads. For background on the integration and a worked use case, see [Braze Currents](/articles/integrate-customer/braze-currents). Creating the source is the first of two steps. This page covers the Zeotap CDP side — naming the source, choosing its region and data entity, and collecting the **API URL** and **write key** that are generated for it. The Braze side, where you create the Current and paste those two values in, is covered in [Implement a Braze Currents source](/articles/integrate-customer/implement-a-braze-currents-source). Data flowing the other way — audiences built in Zeotap CDP and pushed out to Braze for engagement — goes through the [Braze destination](/articles/integrate-customer/braze-1) instead. ## Supported identifiers and data A Braze Currents source carries customer data (CE) only. See [Source integrations](/articles/integrate-customer/creating-a-source) for how it sits alongside the other source types. Every record must carry at least one identifier — for example an email address, a phone number, a cookie ID or an advertising ID. Records that carry none cannot be ingested. See [Best practices for Braze Currents](/articles/integrate-customer/best-practices-for-braze-currents). For the customer behaviour, user events and message engagement events that this source accepts, see [Braze source — attributes supported](/articles/integrations-master-list-publication/braze-source-attributes-supported). ## Prerequisites Before you start, make sure you have: * Access to the **Sources** application under **Integrate** in the Zeotap CDP App. * A Braze account from which you can create a Current under **Partner Integrations > Data Export**, and a contact email address to attach to it. * The region that the incoming data belongs to. Ingest data against the region it belongs to, for data privacy and compliance reasons. * Country values on your records. Records must be tied to a country; Zeotap recommends alpha ISO 3 country codes. > [!NOTE] > > **Note:** > > If the Braze Currents source is not available in your workspace, contact your customer success manager to have it enabled. ## Create the Braze Currents source **Step 1** Log into the Zeotap CDP App and navigate to the **Sources** application under **Integrate.** **Step 2** Click **CREATE SOURCE**. **Step 3** Choose **Customer Engagement Channels** as the Category. ![The Data Source step of the CREATE SOURCE dialog, with the Customer Engagement Channels category selected from the list of source categories.](https://mintcdn.com/zeotap/kEe8zTZlpZky9cq1/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/cec.png?fit=max\&auto=format\&n=kEe8zTZlpZky9cq1\&q=85\&s=41028ad62acb6759bd67c8d9a3e6a4bb) **Step 4** Click **Braze Currents** as the Data Source. ![The Customer Engagement Channels data source list in the CREATE SOURCE dialog, with the Braze Currents tile selected.](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-braze-currents-source/create-a-braze-currents-source-2025-04-01.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=52f48530309b5cada09a55b669bb9bc3) **Step 5** Enter a name for the source. **Step 6** Select a **Region** using the option button provided. If you are unsure which region applies, use the country-to-region mapping reference linked beside the field. **Step 7** Select **Customer Data** as the **Data Entity**. ![The Source Details step of the CREATE SOURCE dialog, showing the Source Name field, the Select your Region option buttons and the Data Entity option buttons.](https://mintcdn.com/zeotap/kEe8zTZlpZky9cq1/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/create_braze_currents_2.png?fit=max\&auto=format\&n=kEe8zTZlpZky9cq1\&q=85\&s=ea6b230b79ea2f6f3b68600a4738d90e) **Step 8** Click **CREATE SOURCE**. Upon successful creation, an **API URL** and a write_key is generated and is available under the **IMPLEMENTATION DETAILS** tab as shown in the image below. The API URL and the write_key are essential to complete the integration. ![The IMPLEMENTATION DETAILS tab of a newly created Braze Currents source, showing the source status, region and data entity, and the notice that the key becomes usable a short while after creation.](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-braze-currents-source/create-a-braze-currents-source-2024-01-11.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=32dcfd18aa989d02e0655a83002f4d1b) > [!NOTE] > > **Note:** > > The app displays a notice that assets are still being created for the write key and that it should be used after 30 minutes. Wait for that period before configuring the Current in Braze. ## Verify the source was created * Open the source and check the **IMPLEMENTATION DETAILS** tab. The **API URL** and write_key are both present, and the source shows its created date, region and data entity. * On the source listing, the status is **Created** — this means the source exists but has not received any data yet. Once data starts flowing it becomes **Integrated**, and once at least one data collection is built on top of it, **Mapped**. See [Components of the source listing page](/articles/integrate-customer/components-of-the-source-listing-page). * After you have configured the Current in Braze, open the **PREVIEW DATA** tab. It shows a sample from the last five ingested files. See [Components of the Preview Data tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab). ## Troubleshoot | Symptom | What to check | | :- | :- | | Braze rejects the credentials, or no data arrives shortly after you launch the Current | The write key is not usable immediately. Wait the 30 minutes that the app asks for, then retry. Also confirm that the API URL was entered as the endpoint and the write_key as the bearer token in Braze — see [Implement a Braze Currents source](/articles/integrate-customer/implement-a-braze-currents-source). | | The source stays in **Created** | The status only moves to **Integrated** once data reaches Zeotap. Confirm that the Current has been launched in Braze and that events are selected for export. | | No preview is available under **PREVIEW DATA** | An error message states the reason. Fix the issue and try again after some time, and confirm that the source is implemented correctly. | | An alert icon appears beside the source on the listing | Erroneous records were ingested in the last 90 days. The icon remains until the errors are fixed. | | Records are dropped during ingestion | Each record needs at least one identifier and a valid country value. Some fields are excluded from ingestion by design — see [Blacklisted fields for data ingestion](/articles/integrate-customer/blacklisted-fields-for-data-ingestion). | | The write key stops working after you pause the source | Pausing data collection invalidates the write key on the source page. Resume data collection from the source's **ACTIONS** menu, then re-open the **IMPLEMENTATION DETAILS** tab and confirm the write key shown there still matches the Bearer Token configured in Braze. See [Components of the source listing page](/articles/integrate-customer/components-of-the-source-listing-page). | If the problem persists, contact support at [support@zeotap.com](mailto:support@zeotap.com). ## Next steps * [Implement a Braze Currents source](/articles/integrate-customer/implement-a-braze-currents-source) — configure the Current in Braze using the API URL and write key. * [Best practices for Braze Currents](/articles/integrate-customer/best-practices-for-braze-currents) — identifiers, country values and catalogue mapping. * [Braze destination](/articles/integrate-customer/braze-1) — send audiences from Zeotap CDP to Braze. # Create a Cleverpush (Batch) source Source: https://docs.zeotap.com/articles/integrate-customer/create-a-cleverpush-batch-source Create a Cleverpush (Batch) source in Zeotap CDP to bring subscriber data from a Cleverpush channel into the CDP, using a Private API Key and a Channel ID. ## What this is A Cleverpush (Batch) source brings subscriber data from a Cleverpush channel **into** Zeotap CDP. Cleverpush is a web-based platform that enables website owners and developers to send push notifications (Push notifications are messages that can be delivered to users' devices, such as smartphones or desktop computers, even when they are not actively browsing the website.) to users who have subscribed to receive them. This page is the click-path: you collect two values from your Cleverpush account, then create the source in the Zeotap CDP App. For what the integration is and where it sits in the catalogue, see the [Cleverpush (Batch) Source](/articles/integrate-customer/cleverpush-batch-source) overview. Two neighbouring Cleverpush integrations are easy to pick by mistake: * To stream events as they happen rather than fetching subscriber data in batches, use the [Cleverpush Real-Time Source](/articles/integrate-customer/cleverpush-real-time-source). On the data-source list, the **Cleverpush Real Time** tile sits directly above the **Cleverpush** tile used here. * To send data the other way — **out of** Zeotap CDP to Cleverpush, so you can target an audience with push notifications — use the [Cleverpush destination](/articles/integrate-customer/cleverpush-destination). ## Supported identifiers The source fetches information related to the subscribers of a channel, such as the subscription ID, channel ID, `created_at`, country, custom attributes and segments. The **Subscription ID** is the identifier the [Cleverpush destination](/articles/integrate-customer/cleverpush-destination) needs in order to send audiences back to Cleverpush. Connecting a Cleverpush source is one of the two documented ways to obtain it; the other is ingesting it from a flat file. ## Prerequisites Have the following ready before you start: * Access to the **Sources** application under **Integrate** in the Zeotap CDP App. * A **Private API Key** from your Cleverpush account — a unique identifier associated with the account, used to authenticate and authorise access to certain features or APIs of Cleverpush. * A **Channel ID** — the unique identifier assigned to the push notification channel you create within Cleverpush. The two sections below cover where each value lives in the Cleverpush console. ## Obtain the Private API Key from Cleverpush **1. Open the API settings** Log into the Cleverpush console and navigate to **Settings**. **2. Copy the Private API key** In the left panel, click **API** and copy the **Private API key** displayed on the screen. **3. Optionally, add an additional API key** If you wish to add an additional API key, click **Add additional API key** and select the channel where you intend to use this key. Additional keys can be restricted to the channels you select, so make sure the key you use covers the channel you are ingesting from. ![The API page of the Cleverpush settings, with the Generate new API key button, and the Additional API keys section where a key is restricted to selected channels](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/0f57bafc-d4c8-4078-ae21-b075ebd5f18b.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=3697a086c92cf484823301d94bb19a5a) Treat the Private API Key as a secret: paste it straight into the source form rather than into a ticket, an email or a shared document. ## Obtain the Channel ID from Cleverpush A channel's Channel ID is shown in the settings of a platform on that channel, so create the channel and set up at least one platform before you look for it, so work through these steps in order. **1. Open the channel** Log into the Cleverpush console and navigate to **Channels** on the top navigation bar. Click the channel that you wish to use for sending push notifications. If the channel does not exist yet, create one by clicking **Add Channel** in the drop-down menu — see [Create a new channel in Cleverpush](/articles/integrate-customer/cleverpush_appendix#create-a-new-channel-in-cleverpush). ![The Cleverpush dashboard with the Channels menu open, listing the latest channels along with the All channels and Add Channel options](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/cleverpush_b_2.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=89055e7549d7f5ebcea8f3d402fc0bf3) **2. Set up a platform on the channel** Once the channel is created, set up the platforms on which you want to send notifications. Zeotap CDP supports the following platforms: * Web Push * App Push * Email Push For the Web Push and App Push setup steps, see the [Cleverpush appendix](/articles/integrate-customer/cleverpush_appendix#set-up-web-push-in-cleverpush). ![The Basic settings of a Cleverpush channel, with the channel name and industry fields above the Platforms list, where Web Push and App Push are already added](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/cleverpush_b3.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=9a9b3f5e629b66c24f71fe0899679ecf) **3. Read the Channel ID** Click the platform you set up and navigate to **General → Advanced settings**. The **Channel ID** is the first field on that page. ![The Advanced settings page of a Cleverpush Web Push platform, with the Channel ID field highlighted above the subdomain and Firebase settings](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/cleverpush_b_4.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=06edb1df158ce93842b5c24c506e51a5) ## Create the Cleverpush (Batch) source **1. Open the Sources application** In the Zeotap CDP App, go to **Integrate → Sources**. **2. Start a new source** Click **CREATE SOURCE**. **3. Choose the category** On the **Data Source** step, choose **Customer Engagement Channels** — *Ingest Data from engagement channels*. ![The CREATE SOURCE dialog on the Data Source step, with the Customer Engagement Channels category highlighted among the available source categories](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/cleverpush_b_5.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=efdc6b34006c3580fdde9605f8132613) **4. Select the Cleverpush data source** Select the **Cleverpush** tile — *Integrate with Cleverpush*. Take care not to pick **Cleverpush Real Time** directly above it, which creates the real-time webhook source instead and does not ask for a Private API Key or a Channel ID. ![The Data Source list with the Cleverpush tile highlighted, and the separate Cleverpush Real Time tile listed directly above it](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/cleverpush_b_6.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=7aaf1afc2b4a3a16395db8d4e91b3503) **5. Enter the source details** On the **Source Details** step: 1. In **Source Name**, enter a short, descriptive name. Make the vendor and the direction obvious, so the source is easy to pick out on the listing later. 2. Under **Select your Region**, choose the region this source uploads to. 3. Enter the **Private API Key** you obtained from the Cleverpush account. 4. Enter the **Channel ID** you obtained from the Cleverpush account. 5. Under **Data Entity**, choose **Customer Data** or **Non Customer Data**, depending on the type of data you want to ingest. See [Supported data entities](/articles/unify-customer/supported-data-entities). ![The Source Details step of the CREATE SOURCE dialog, showing the Source Name, Select your Region, Private API Key, Channel ID and Data Entity fields with placeholder values](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/cleverpush_b_7.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=4189c65c274917f5f7889f97da37cb67) **6. Create the source** Click **CREATE SOURCE**. ## Verify the source was created The new source appears on the **SOURCES** listing page. Open it and check the **IMPLEMENTATION DETAILS** tab, which records the **Created By**, **Created Date**, **Region** and **Data Entity** values, along with the **Private API Key** (masked) and the **Channel ID** you entered. Confirm the region and data entity match what you selected. ![The IMPLEMENTATION DETAILS tab of a created Cleverpush source, showing the Created By, Created Date, Region and Data Entity summary above the Private API Key field and the Channel ID field](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/cleverpush_b_8.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=c5202979096eaaf164d5c6568db8ce18) The source's status tells you how far the integration has got: * **Created** — the source exists in Sources but has not received any data yet. * **Integrated** — data has started flowing in. At this point you can preview the incoming records on the **PREVIEW DATA** tab. For what every status means, see [Components of the Source Listing Page](/articles/integrate-customer/components-of-the-source-listing-page); for how to read the incoming sample, see [Components of the Preview Data tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab). ## Troubleshoot the source * **The channel has no Channel ID.** A channel only exposes a Channel ID through one of its platforms. Set up **Web Push**, **App Push** or **Email Push** on the channel first, then open that platform and go to **General → Advanced settings**. * **You used an additional API key.** Additional API keys in Cleverpush are restricted to the channels selected when they were created. If you entered one of those instead of the account's Private API key, check that it covers the channel whose Channel ID you entered. * **The status stays Created.** No data has reached the source yet. Re-check on the **IMPLEMENTATION DETAILS** tab that the Channel ID recorded there is the channel you meant to ingest from, and that the Private API Key you entered belongs to the same Cleverpush account. ## Next steps > [card] [Cleverpush (Batch) Source](/articles/integrate-customer/cleverpush-batch-source) > > What the integration brings in and where it sits in the source catalogue. > [card] [Cleverpush appendix](/articles/integrate-customer/cleverpush_appendix) > > Create a channel in Cleverpush and set up Web Push, App Push or Email Push on it. > [card] [Components of the Preview Data tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) > > Check the records arriving from Cleverpush once the source is integrated. > [card] [Cleverpush destination](/articles/integrate-customer/cleverpush-destination) > > Send an audience the other way, out of Zeotap CDP to Cleverpush. # Create a Cleverpush Real-Time source Source: https://docs.zeotap.com/articles/integrate-customer/create-a-cleverpush-real-time-source Create a Cleverpush Real-Time source in Zeotap CDP so a Cleverpush channel can stream subscriber and notification events into the CDP over a webhook. ## What this is A Cleverpush Real-Time source brings data **into** Zeotap CDP. Cleverpush is a web-based platform that lets website owners and developers send push notifications to users who have subscribed to receive them. With this source in place, Cleverpush posts subscriber and notification events from one of your channels to Zeotap CDP over a webhook as they happen. Setting the integration up takes two pages. This one covers the Zeotap CDP side: you create the source, and Zeotap generates the **API URL** and **Write key** that identify it. You then paste those two values into a webhook on the Cleverpush side — see [Implement a Cleverpush Real-Time Source](/articles/integrate-customer/implement-a-cleverpush-real-time-source). Three neighbouring Cleverpush integrations are easy to confuse with this one: * To fetch subscriber data in batches instead of streaming it, use the [Cleverpush (Batch) Source](/articles/integrate-customer/cleverpush-batch-source). * To send data the other way — **out of** Zeotap CDP to Cleverpush, so you can target an audience with push notifications — use the [Cleverpush destination](/articles/integrate-customer/cleverpush-destination). * [Cleverpush Real Time Integration](/articles/integrate-customer/cleverpush-real-time-integration) is despite its name also an outbound integration: it sends data from a Journeys workflow to Cleverpush. ## Supported identifiers The source brings in subscriber records from the Cleverpush channel it is connected to. The identifiers are: * **Channel ID** * **Subscription ID** * **Subscription platform name** (`Subscription.platformName`) Alongside them, the payload carries subscription and notification attributes including `Subscription.browserType`, `Subscription.createdAt`, `Subscription.syncedAt`, `Subscription.language`, `Subscription.country`, `Subscription.timezone`, `Subscription.customAttributes`, `Subscription.emailAddress`, `Subscription.optInIpAddress`, `Subscription.optInUrl`, `Subscription.topics`, `Notification.campaignId`, `Notification.campaignName`, `Notification.customData` and `Notification.feedGuid`. Which of these actually arrive depends on the webhook events you select in Cleverpush, which you choose when you configure the webhook. > [!NOTE] > > Cleverpush sends a country value, but Zeotap CDP works the country and city out automatically from the user's IP address, so those two columns are excluded from ingestion. For the full list, see [Blacklisted fields for data ingestion](/articles/integrate-customer/blacklisted-fields-for-data-ingestion). ## Prerequisites * **A Cleverpush channel with at least one platform configured.** The webhook that feeds this source is configured per platform in Cleverpush, so the channel needs at least one platform — **Web Push**, **App Push** or **Email Push** — set up before there is anywhere to add it. See [Create a new channel in Cleverpush](/articles/integrate-customer/cleverpush_appendix#create-a-new-channel-in-cleverpush) and [Setup Web Push in Cleverpush](/articles/integrate-customer/cleverpush_appendix#set-up-web-push-in-cleverpush). * **Access to the Sources application** under **Integrate** in the Zeotap CDP App. You do not need any Cleverpush credentials to create this source. The [Cleverpush (Batch) source](/articles/integrate-customer/create-a-cleverpush-batch-source) asks for a Private API Key and a Channel ID up front; the real-time form asks only for a name, a region and a data entity. Authentication runs the other way round here — Cleverpush authenticates to Zeotap using the Write key that this page generates for you. ## Create the Cleverpush Real-Time source **1. Open the Sources application** Sign in to the Zeotap CDP App and go to **Integrate → Sources**. **2. Start a new source** Click **CREATE SOURCE**. **3. Choose the category** On the **Data Source** step, choose **Customer Engagement Channels** — *Ingest Data from engagement channels*. ![CREATE SOURCE dialog on the Data Source step, with the Customer Engagement Channels category highlighted among the available source categories](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-real-time-source/clevr_real_1.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=8a88f45d2af43b715bf484b56972863e) **4. Select the Cleverpush Real Time source** Select the **Cleverpush Real Time** tile — *Integrate with Cleverpush Webhook to get real-time data*. Take care not to pick the **Cleverpush** tile directly beneath it. That one creates the batch source, which asks for a Private API Key and a Channel ID instead. ![Data Source list with the Cleverpush Real Time tile highlighted, and the separate Cleverpush tile for the batch source listed directly below it](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-real-time-source/Cleverpush_real_time_1.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=f23aecda0fcdabd3d0e91ab3e259796e) **5. Enter the source details** On the **Source Details** step: 1. In **Source Name**, enter a short, descriptive name. Make the vendor and the direction obvious, so the source is easy to pick out on the listing later. 2. Under **Select your Region**, choose the region this source uploads to. 3. Under **Data Entity**, choose **Customer Data** or **Non Customer Data**, depending on the type of data you want to ingest. See [Supported data entities](/articles/unify-customer/supported-data-entities). ![Source Details step of the CREATE SOURCE dialog, showing the Source Name field, the Select your Region option and the Customer Data / Non Customer Data entity options](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-real-time-source/Cleverpush-rearl_time_2.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=6ac9e58f0b0537df88d43e0681d33a60) **6. Create the source** Click **CREATE SOURCE**. Zeotap generates the API URL and Write key for the new source straight away. ## Verify the source was created The new source opens on its own page with its status shown beside the name, and it is added to the **SOURCES** listing under **Integrate → Sources**. A source you have just created shows the status **Created**, which means it exists but has not received any data yet. It moves to **Integrated** once data starts arriving — see [Components of the Source Listing Page](/articles/integrate-customer/components-of-the-source-listing-page) for what each status means. On the **IMPLEMENTATION DETAILS** tab, check the following: * **Created By**, **Created Date**, **Region** and **Data Entity** — confirm the region and data entity match what you selected. * **API URL** — the endpoint Cleverpush posts to. This is the value you enter as the webhook URL on the Cleverpush side. Use the copy button beside the field. * **Write key** — the value Cleverpush sends as the authorisation header value, so Zeotap can tell which source the incoming data belongs to. Copy it the same way. Both values are needed to finish the integration. Treat the Write key as a secret: copy it straight into Cleverpush rather than pasting it into a ticket, an email or a shared document. ![A created Cleverpush Real Time source on its IMPLEMENTATION DETAILS tab, showing the Created By, Created Date, Region and Data Entity summary above the Access Details section and Write key fields, whose values are redacted in this screenshot](https://mintcdn.com/zeotap/0tBKU68VEaZ-cZhs/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-real-time-source/Cleverpush_real_time_3.png?fit=max\&auto=format\&n=0tBKU68VEaZ-cZhs\&q=85\&s=f344b6c6271aea6d5b4be83ffd375e50) The **PREVIEW DATA**, **CATALOGUE MAPPING** and **SOURCE REPORT** tabs stay empty until data starts arriving. Once the webhook is live in Cleverpush, the records flowing in appear under **PREVIEW DATA** — see [Components of the Preview Data Tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab). ## Next steps * [Configure the webhook in Cleverpush to finish the integration →](/articles/integrate-customer/implement-a-cleverpush-real-time-source) * [Read the Cleverpush Real-Time Source overview →](/articles/integrate-customer/cleverpush-real-time-source) * [Check the data arriving on the Preview Data tab →](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) * [Send audiences out of Zeotap CDP to Cleverpush →](/articles/integrate-customer/cleverpush-destination) # Create a Destination Source: https://docs.zeotap.com/articles/integrate-customer/create-a-destination Register a new destination in the Zeotap CDP so audiences and journeys can activate to the target platform. ## What this is A **Destination** in Zeotap CDP is a connection to an external platform — an advertising channel, engagement platform, DMP, or data warehouse — that receives activated audience data from Zeotap. Creating a destination is a one-time setup: you register the target platform with the credentials it needs, choose the action Zeotap should call, and map Zeotap identifiers to the fields the platform expects. Once saved, the destination becomes available in the **Audiences** application, and any audience or journey can activate to it without re-entering credentials. The credential and mapping fields differ per platform, but the outer flow described on this page is the same for every integration. ## Prerequisites > [!NOTE] > > Before you begin, make sure you have: > > * **Access** to the **Destinations** module under **Integrate** in the Zeotap CDP App. > * **Credentials** for the target platform (for example, an API key or REST key from the platform's console). Credential requirements are platform-specific — see the destination-specific integration page for details. > * **A decision on the action and field mapping** you want to configure: which platform action Zeotap should call, and which Zeotap identifiers map to which destination fields. ## Register the destination **1. Open the Destinations module** Log into the Zeotap CDP App and go to **Destinations** under **Integrate**. **2. Start a new destination** Click **+ Create Destination**. ![Destinations module showing the + Create Destination button](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-destination/create-a-destination-2023-09-12.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=4fd703faf99ca382ad22f8cf1c7b444f) **3. Choose the target platform** Under **All Destinations**, search for the platform you want to send data to and select it. ![All Destinations catalogue with the platform search field](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-destination/create-a-destination-2023-11-07.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=f728195aad07ffb7e77b04c4335300f2) **4. Enter the destination credentials** Fill in the credential and configuration fields the platform requires and click **Next**. The fields differ per destination — the screen below shows Adform as one example. ![Credential and configuration fields for the Adform destination](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/adform-2023-11-07-1.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=287f792e1397789f2cca1e61b2f339df) ## Configure the action and field mapping **1. Choose your Action** Under **Choose your Action**, pick the platform action Zeotap should call when it delivers audience data. See [Actions](/articles/integrate-customer/destinations#key-concepts) for the full list and what each does. **2. Map the fields** Under **Map the Fields**, map Zeotap identifiers to the corresponding destination fields. By default, Zeotap displays the [Output Identifiers](https://docs.zeotap.com/smart/project-segment/choose-the-output-identifiers) that the platform accepts — MAIDs, cookies, email IDs, and others. You can edit, add, or remove identifiers from this list — see [Mappings](/articles/integrate-customer/destinations#define-the-mapping) for the exact controls. ![Choose your Action and Map the Fields panels with the Save Mapping button](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/adform-2023-11-07-2.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=0831f0b71d0790a0963ca610c6838680) **3. Save the mapping** Click **Save Mapping**. The destination is registered and becomes available in the **Audiences** application. The following example lists the default Output Identifier categories a destination surfaces on the mapping screen: ```text theme={null} # Default Output Identifiers exposed on the mapping screen MAID # mobile advertising ID (GAID / IDFA) Cookie Email # ...plus any additional identifiers the destination supports ``` ## Verify the destination is available To confirm the destination is ready to use: 1. Go to **Destinations** under **Integrate**. The new destination appears in the destinations list. 2. Open any audience — the destination appears in the list of available destinations for activation, ready to [activate your cohort of customers](https://docs.zeotap.com/smart/project-segment/link-the-destination). ![Newly created destination listed among the available destinations for an audience](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-destination/create-a-destination-2023-09-12-3.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=93dc1caa06e95abd230f6c6bfc367bc8) ## Troubleshoot If the destination did not register as expected, work through the conditions below. | Condition | What it means | Where to look | | - | - | - | | **Save Mapping** unavailable | The **Choose your Action** selection or a required entry under **Map the Fields** is incomplete | The **Choose your Action** and **Map the Fields** panels on the mapping screen | | Destination absent from the **Audiences** application after saving | The destination was not saved to completion — the workflow was closed before **Save Mapping** confirmed | The **Destinations** list under **Integrate** — confirm the destination is present before opening an audience | If the destination still does not appear or behave as expected after these checks, contact your Zeotap customer success representative. Include: * The destination name and target platform. * The action selected under **Choose your Action**. * The field mapping you configured under **Map the Fields**. * The exact wording of any message shown on the credential or mapping screen. ## FAQ > [accordion] Do I need to create a separate destination for each audience? > > No. A destination is registered once and then linked to any number of audiences or journeys from the **Audiences** application. > [accordion] Can I change the action or field mapping after saving? > > Yes. Open the destination from the **Destinations** list under **Integrate** and edit the action or mapping. See [Mappings](/articles/integrate-customer/destinations#define-the-mapping) for how to add, edit, or remove identifiers. > [accordion] Which identifiers can I map to a destination? > > Each destination exposes the identifiers its platform accepts — MAIDs, cookies, email IDs, and others. Zeotap displays the default accepted set on the mapping screen, and you can adjust that set within the identifiers the destination supports. ## Next steps * [Explore Destination Access Rules →](/articles/integrate-customer/destination-access-rules) — control which audience and journey folders can activate to a given destination. * [Explore the Batch real-time destination integration →](/articles/integrate-customer/batch-real-time-destination-integration) — see a worked example of destination setup for a mobile engagement platform. * [Explore Snowflake source creation →](/articles/integrate-customer/create-a-snowflake-source) — set up the source side of an end-to-end data flow that feeds the destinations you create here. # Create a Dotdigital source Source: https://docs.zeotap.com/articles/integrate-customer/create-a-dotdigital-source Connect your Dotdigital account to Zeotap CDP so that contact, campaign and preference data is fetched from Dotdigital into Zeotap CDP on a schedule you choose. ## What this is The Dotdigital source brings data **into** Zeotap CDP: Zeotap fetches the customer data held in your Dotdigital account through HTTP REST API calls, receives it as JSON responses and ingests it into Zeotap CDP. Data does not travel back to Dotdigital through this integration — to send audiences the other way, out of Zeotap CDP and into Dotdigital, use the [Dotdigital destination](/articles/integrate-customer/dotdigital-1). Dotdigital is a marketing automation platform providing a CRM and a multichannel messaging suite (email, SMS, social media, push notifications and more). In Zeotap CDP the integration sits under the **Customer Engagement Channels** source category, alongside the other engagement-channel integrations listed on the [Customer Engagement Channels](/articles/integrate-customer/customer-engagement-channels) page. A retailer, for example, can pull the customer data held in Dotdigital's CRM and messaging suite into Zeotap CDP, then use it to build targeted segments, personalise campaigns across channels and tune messaging for engagement, conversion and loyalty. See [Dotdigital](/articles/integrate-customer/dotdigital) for the overview of this integration and its other pages. ## Supported standard objects Choose one of the following scopes in Dotdigital before you create the source in Zeotap CDP, then select the matching **Standard object** on the source form: * Contacts * Campaigns * Preferences * Campaign Opens * Campaign Clicks * Campaign Page Views For the attributes fetched for each of these objects, see [Dotdigital — attributes supported](/articles/integrations-master-list-publication/dotdigital-attributes-supported). Dotdigital is also listed among the supported batch integrations in [Source integrations](/articles/integrate-customer/creating-a-source). ## Prerequisites Have the following ready before you start. ### A Dotdigital API user account To use the [Dotdigital developer platform](https://developer.dotdigital.com/reference) or Dotdigital's public APIs, you need an API user account in Dotdigital. Create one before you begin this integration — Dotdigital documents the steps in [Create an API user](https://support.dotdigital.com/hc/en-gb/articles/115001718730-Create-an-API-user). ### The API user's ID and password Each API user created in Dotdigital is assigned a username and password, which authenticate an operation or call. Once you have these credentials you can establish the connection from Zeotap CDP. The [Dotdigital destination](/articles/integrate-customer/dotdigital-1) page walks through the same API user setup inside the Dotdigital console, with screenshots, if you would rather follow it there. ### Your Dotdigital region Dotdigital accounts belong to different regions depending on where they are based in the world, and an API endpoint belonging to a different region cannot be used. Confirm which region your account is in before you start; the region codes and API domains are tabulated on the [Dotdigital destination](/articles/integrate-customer/dotdigital-1) page. ### A sync frequency The first sync runs as soon as the source is created. Subsequent syncs run on the frequency you select. The supported frequencies are: * Daily * Weekly * Monthly ## Create the Dotdigital source Perform the following steps to establish a connection with Dotdigital using the built-in connector in Sources. **Step 1** Navigate to the **Sources** application under **Integrate**, in the Zeotap CDP App. **Step 2** Click **CREATE SOURCE**. **Step 3** Choose **Customer Engagement Channels** as the Category. ![The Data Source step of the Create Source dialog, listing the source categories with Customer Engagement Channels selected.](https://mintcdn.com/zeotap/kEe8zTZlpZky9cq1/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/cec.png?fit=max\&auto=format\&n=kEe8zTZlpZky9cq1\&q=85\&s=41028ad62acb6759bd67c8d9a3e6a4bb) **Step 4** Click **Dot Digital** as the Data Source. ![The Customer Engagement Channels data sources listed in the Create Source dialog, with the Dot Digital tile highlighted.](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-dotdigital-source/create-a-dotdigital-source-2025-04-01.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=56ae7e6eafcb4e1d1da1c5626fc8601e) **Step 5** In the window that appears, provide the following details: a. Enter a name for the source. b. Enter the **User ID** and **Password** of the Dotdigital API user. c. Select your **Region** using the option button. d. Choose the desired **Sync frequency** from the drop-down list. This sets how often the data is auto-updated into Zeotap CDP. e. Choose the appropriate **Standard object** for the source from the drop-down list. ![The Source Details step of the Create Source dialog, with empty Source Name, User ID and Password fields above the region option button and the sync frequency and standard object drop-down lists.](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-dotdigital-source/create-a-dotdigital-source-2024-01-08.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=fa48786d51dec11fe90f9c730f965e6b) **Step 6** Click **CREATE SOURCE**. ## Verify the source Open the created source and select the **IMPLEMENTATION DETAILS** tab. It shows who created the source and when, the region it was created against, how far the data has been processed, and the User ID and password that Zeotap uses to make the API calls and fetch the target data from Dotdigital. ![The Implementation Details tab of a created Dotdigital source, showing the Created By, Created On, Region and Last Processed Till summary above a User Details panel.](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-dotdigital-source-2023-04-12-3.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=04a1857b0aca6ce193a16e79e8b3d662) On the source listing page, the source's **STATUS** tells you how far the data has got: **Created** while the source exists but has not yet received data, **Integrated** once data starts flowing in, and **Mapped** once at least one data collection exists on top of it. The **LAST INGESTED** and **TOTAL RECORDS INGESTED** columns on the same page show the most recent ingestion and the running record count. For what each column reports, see [Components of the source listing page](/articles/integrate-customer/components-of-the-source-listing-page). ## Next steps * [Dotdigital — attributes supported](/articles/integrations-master-list-publication/dotdigital-attributes-supported) — the attributes fetched for each standard object. * [Components of the source listing page](/articles/integrate-customer/components-of-the-source-listing-page) — statuses, ingestion counts and the actions available on a source. * [Dotdigital destination](/articles/integrate-customer/dotdigital-1) — sending audiences from Zeotap CDP out to Dotdigital. * [Sources](/articles/integrate-customer/sources) — the other source categories and data sources available in Zeotap CDP. # Create a HubSpot source Source: https://docs.zeotap.com/articles/integrate-customer/create-a-hubspot-source Ingest Contacts or Companies from your HubSpot CRM into Zeotap CDP on a schedule, using a bearer token from a HubSpot private app. ## What this is A HubSpot source brings CRM records **from HubSpot into Zeotap CDP**. You pick one standard object (Contacts or Companies), select the fields you want from that object, and Zeotap fetches them on the sync frequency you choose. Data moves in one direction on this page: HubSpot to Zeotap CDP. To send data the other way — pushing Contacts and Contact Lists **from Zeotap CDP out to HubSpot** — see the [HubSpot destination](/articles/integrate-customer/hubspot). For background on this integration, see [HubSpot source](/articles/integrate-customer/hubspot-source). ## Supported objects and sync options | Setting | What you can choose | | :- | :- | | **Standard object** | **Contacts** or **Companies**. A source ingests one standard object. | | **Data entity** | **Customer Data** or **Non Customer Data**, depending on the type of data you want to ingest. See [supported data entities](/articles/unify-customer/supported-data-entities). | | **Select your Region** | The region of upload. | | **Sync frequency** | **Daily**, **Weekly** or **Monthly**. The first sync runs once you create the source; subsequent syncs follow the frequency you select. | | **Delta Queries Selection** | **false** — retrieves the complete dataset during the initial fetch and transfers the entire dataset during each subsequent synchronisation, regardless of any changes made. This ensures the full dataset is updated at each sync frequency. **true** — receives all available data during the initial fetch and thereafter exclusively gathers incremental updates (deltas) as per the sync frequency configured. | > [!NOTE] > > **Note:** > > Note that we currently support only one user ID per source and one campaign per source. ## Prerequisites Ensure that you take care of the following prerequisites before creating a HubSpot source: * **HubSpot account** – Ensure that you have an active account on HubSpot. For more information about how to create a HubSpot account, refer [here](https://knowledge.hubspot.com/get-started/set-up-your-account). * **Bearer token (access token)** – A bearer token in HubSpot is a unique string of characters that authenticates a user or application to access a resource. It grants limited access to a user or application for a specific period, allowing them to perform actions on behalf of the user who generated the token. Create one from a HubSpot private app, as described in the next section. ## Create a private app in HubSpot and copy the bearer token Perform the following steps in your HubSpot account: **Step 1** In your HubSpot account, click the **settings icon** in the main navigation bar. **Step 2** In the left sidebar menu, navigate to **Integrations > Private Apps**. **Step 3** Click **Create private app**. **Step 4** On the **Basic Info** tab, configure your app details: * Enter your app's **name**. * Hover over the placeholder logo, then click the **upload icon** to upload a square image to serve as the app logo. * Enter a **description** for your app. ![The Basic Info tab of a HubSpot private app, with the Name, Logo and Description fields.](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-hubspot-source/create-a-hubspot-source-2024-12-20-3.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=491bdcc1fca0913425e4529cc5b03d54) **Step 5** In the **Scopes** tab, at the top of the page, click **+ Add new scope** and add the following scopes: **Contacts** * crm.objects.contacts.read * crm.objects.contacts.write **Companies** * crm.objects.companies.read * crm.objects.companies.write **Step 6** Click **Update** after adding the required scopes. **Step 7** In the top-right corner, click **Create app > Continue Creating**. **Step 8** In the new window, click **Show token** to view and copy the bearer token. For more information about access tokens for private apps, refer [here](https://developers.hubspot.com/docs/api/private-apps#make-api-calls-with-your-app-s-access-token). ![HubSpot's 'Your private app was created' dialog, with the access token field and the Show token control beside it.](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-hubspot-source/create-a-hubspot-source-2024-12-20-2.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=55d9494607e0dc1fda7525ff55bcb46c) ## Create the HubSpot source Once you have the bearer token and have decided on the object, sync frequency and delta queries selection, perform the following steps in the Zeotap CDP App: **Step 1** Navigate to the **Sources** application under **Integrate**. **Step 2** Click **Create Source**. **Step 3** Choose **CRM Data** as the category. ![The Select Category step of the Create Source wizard, with CRM Data highlighted among the source categories.](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-hubspot-source/create-a-hubspot-source-2024-12-19-3.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=92ea1f81144b99102df4c9da185f7b8e) **Step 4** Click **Hubspot** as the data source. ![The Select Data Source step, listing Salesforce CRM, Hubspot and Microsoft Dynamics CRM, with Hubspot highlighted.](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-hubspot-source/create-a-hubspot-source-2024-12-19-4.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=be507181623cf9e4781838b71477c79d) **Step 5** Enter a short and descriptive name for the source. **Step 6** Enter the **Bearer Token** that you copied from your HubSpot private app. **Step 7** Choose either **Contacts** or **Companies** as the **Standard object**. **Step 8** Under **Data Entity**, depending on the type of data that you want to ingest, choose either **Customer Data** or **Non Customer Data**. To know more about Customer Data and Non Customer Data, refer [here](/articles/unify-customer/supported-data-entities). **Step 9** Select your region of upload and the sync frequency. **Step 10** Under **Delta Queries Selection**, select **true** or **false** based on the requirement. See [Supported objects and sync options](#supported-objects-and-sync-options) for what each setting does. **Step 11** Click **Next** to proceed to the **Filter** step, where you select fields. ![The Source Details step of the Create Source wizard, showing the source name, bearer token, standard object, data entity, region and sync frequency fields.](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-hubspot-source/create-a-hubspot-source-2024-12-19.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=a6fc23b47c8e775356fb7b6bd70ebfff) **Step 12** In the window that appears, based on the object (Contacts or Companies) selected in the previous step, a list of fields is displayed. Select the desired fields using the check boxes. Use **Select All** to select all the fields available for that object in your HubSpot account. If you know the field names, you can select them after searching in the search box. ![The Filter step of the Create Source wizard, with a field search box, a checkbox list of object fields, and the Select All and Clear All controls.](https://mintcdn.com/zeotap/5K-Zf-MYwWXwJWp5/articles/integrate-customer/Storage/integrate-customer/creating-salesforce-crm/creating-salesforce-crm-2024-07-02-2.png?fit=max\&auto=format\&n=5K-Zf-MYwWXwJWp5\&q=85\&s=3982bb12d54022564c8b89e1008f8f92) > [!NOTE] > > **Note:** > > Currently, editing the field selection after source creation is not allowed. If you wish to do so, then you need to create a new source in Zeotap CDP. **Step 13** Review the selected fields and click **Create Source**. ![The Sources listing page with a newly created HubSpot source highlighted in the CRM Data category, showing status Created.](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-hubspot-source/create-a-hubspot-source-2024-12-20-5.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=7f093c62bed043a19984fd3a9b07a8af) ## Verify the source **Step 1** Confirm that the new source appears on the **Sources** listing page with the status **Created**, which indicates that the source has been created but is yet to receive any data. For what each column and status means, see [Components of the Source Listing Page](/articles/integrate-customer/components-of-the-source-listing-page). **Step 2** Open the source and check the **IMPLEMENTATION DETAILS** tab. It shows the created by and created date information, the data entity, region, sync frequency, standard object and delta queries selection you chose, along with the fields selected for the object. ![The IMPLEMENTATION DETAILS tab of a created HubSpot source, showing the source configuration summary and the list of selected fields.](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-hubspot-source/create-a-hubspot-source-2024-12-19-2.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=9b78761218a01a1365954ef044843e10) **Step 3** Once the connection between Zeotap and HubSpot is successfully established and data starts flowing in, the status of the source changes to **Integrated** and you can examine a sample of the incoming data under the **[PREVIEW DATA](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab)** tab. ## Troubleshoot the source | Symptom | What to do | | :- | :- | | You need to change which fields are ingested. | Editing the field selection after source creation is not allowed. Create a new HubSpot source in Zeotap CDP with the field selection you want. | | No preview is available under **PREVIEW DATA**. | An error message is displayed stating the reason. Use **View Error Log** on that tab to review the errors, confirm that the source is implemented correctly, and try again after some time. See [Components of the Preview Data Tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab). If you need further assistance, contact support at `support@zeotap.com`. | ## Next steps * Map the ingested fields to the Catalogue — see [Map the Catalogue for Customer Data](/articles/unify-customer/map-the-catalogue-for-customer-data). * Learn what qualifies as Customer Data — see [Customer Data](/articles/unify-customer/customer-data). * Send audiences the other way, from Zeotap CDP to HubSpot — see [HubSpot destination](/articles/integrate-customer/hubspot). # Create a Microsoft Dynamics CRM source Source: https://docs.zeotap.com/articles/integrate-customer/create-a-ms-dynamics-crm-source Register an app in the Azure portal, give it access to your Dynamics 365 environment, and create the source in Zeotap CDP so that Dynamics CRM data flows into the platform. ## What this is A Microsoft Dynamics CRM source brings data **from** your Dynamics 365 environment **into** Zeotap CDP, where it can be unified and segmented. The integration runs in that direction only — the [integrations master list](/articles/integrations-master-list-publication/integrations-master-list) lists Microsoft Dynamics CRM as a Source, so there is no matching Dynamics CRM destination for sending audiences back out to Dynamics. Setting the source up takes three parts, in this order: 1. Register an app in the Azure portal and collect its credentials. 2. Give that app access to the Dynamics 365 environment you want to read from. 3. Create the source in Zeotap CDP using those credentials. For what the integration is for and an example use case, see [MS Dynamics Source](/articles/integrate-customer/ms-dynamics-source). For the other CRM systems Zeotap CDP can read from, see [CRM Data](/articles/integrate-customer/crm-data). ## Supported identifiers and data | What | Supported | | - | - | | **Category** | CRM Data | | **Integration type** | Batch | | **Identifiers and attributes** | Any identifiers and attributes | | **Data entity** | Customer Data or Non Customer Data — you choose one per source | | **Dynamics entity** | You name the entity to ingest, for example account, campaign or incident (case) | The identifier and integration-type entries come from the [integrations master list](/articles/integrations-master-list-publication/integrations-master-list). To understand the difference between Customer Data and Non-Customer Entity data, see [Supported Data Entities](/articles/unify-customer/supported-data-entities). ## Prerequisites Register an app in your Dynamics 365 instance and keep the following details to hand before you create the source in Zeotap CDP: * App Client ID * Tenant ID * App Client Secret * Organization URL The first three come from the app registration in the [Azure portal](#register-an-app-in-the-azure-portal); the Organization URL comes from your environment in the [Power Automate portal](#grant-the-app-permissions-in-the-power-automate-portal). ## Register an app in the Azure portal Perform the following steps to register an app and generate the App Client ID, Tenant ID and App Client Secret: **Step 1** Log into the [Azure portal](https://portal.azure.com/). **Step 2** On the homepage, select **App registrations** > **New registration**. ![The Azure home page with App registrations highlighted under Azure services, and the App registrations page below it with New registration highlighted.](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-ms-dynamics-crm-source/create-an-ms-dynamics-crm-source-2024-09-19-1.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=e3572a4cd5d4ba0ac7b2943d7c1a4d8f) **Step 3** In the Application Registration form, provide the following information: * Under **Name**, enter a meaningful name for the registration app. * Under **Supported Account Types**, select **Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant)** using the radio button as shown in the image below. * Leave the redirect URL blank. ![The Register an application form, with a name typed into the Name field, the multitenant option selected under Supported account types, and Redirect URI left empty.](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-ms-dynamics-crm-source/create-an-ms-dynamics-crm-source-2024-09-19-2.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=9d2fc32b25a7a5b87001d13e599aea20) **Step 4** Select **Register**. Once the app is registered, you can copy the values displayed for Application (client) ID and Directory (tenant) ID. These values are required for integrating MS Dynamics with Zeotap CDP. ![The registered app's Overview page, with the Application (client) ID and Directory (tenant) ID rows highlighted in the Essentials panel.](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-ms-dynamics-crm-source/create-an-ms-dynamics-crm-source-2024-09-19-3.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=9f88dc2cea593161c4f7c3ddc74663d8) **Step 5** Next, you must provide the necessary permissions for the API. To do so, in the left navigation panel, click **API permissions**. **Step 6** In the new screen that appears, under the **Microsoft APIs** tab, click **Dynamics CRM**. **Step 7** In the **Request API permissions** screen that appears, click **Delegated permissions**. **Step 8** Under **Select permissions**, use the checkbox to select the `user_impersonation` permission and click **Add permissions**. ![The Request API permissions panel for Dynamics CRM, with Delegated permissions selected and the user_impersonation permission ticked.](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-ms-dynamics-crm-source/create-an-ms-dynamics-crm-source-2024-09-19-4.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=f26eca3c4312ca524fd44de2ba9ab6b2) **Step 9** Next, in the left navigation panel, go to **Certificates & secrets** > **New client secret**. **Step 10** In the new window that appears, provide the following details: a. In the **Description** field, enter a short description for the client secret. b. For **Expires**, choose the validity of the client secret using the drop-down menu. c. Click **Add**. ![The Add a client secret panel, with a Description field and an Expires drop-down set to a validity period.](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-ms-dynamics-crm-source/create-an-ms-dynamics-crm-source-2024-09-19-5.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=2a8dbbcd7bdd78b911e2b803ec9660c7) **Step 11** To find the client secret added, in the left navigation panel, click **Certificates & secrets** and go to the **Client secrets** tab as shown below. ![The Client secrets tab listing one secret with its description and expiry date, and the Value and Secret ID columns highlighted.](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-ms-dynamics-crm-source/create-an-ms-dynamics-crm-source-2024-09-19-6.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=bf642c7702f2ff6c90ef9a2a8e3d117b) **Step 12** Copy the value displayed under **Value**. This is the App Client Secret required when creating a MS Dynamics CRM source in Zeotap CDP. The value is shown only once, so copy and save it securely. **Step 13** As a final step, navigate again to **API permissions** and click **Grant admin consent** as shown below. This completes the app registration process on MS Dynamics. ![The app's API permissions page with API permissions selected in the left navigation and Grant admin consent highlighted above the configured Dynamics CRM permission.](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-ms-dynamics-crm-source/create-an-ms-dynamics-crm-source-2024-09-19-7.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=aa9d584431ccfb8eaf44526e1b2a460a) ## Grant the app permissions in the Power Automate portal The app now exists in your directory, but it cannot read your Dynamics data until you add it as an application user on the environment. This section is also where you find the Organization URL. **Step 1** Log into the Power Automate portal at [https://admin.powerplatform.microsoft.com/](https://admin.powerplatform.microsoft.com/). **Step 2** In the left navigation panel, click **Environments** and then choose the environment where your Dynamics CRM is located as shown below. ![The Environments list in the Power Platform admin center, with one environment selected from the list of environments and their types and states.](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-ms-dynamics-crm-source/create-an-ms-dynamics-crm-source-2024-09-19-8.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=d427cdbc1cf861bff06dbc4b85628389) **Step 3** Click **Settings**. Under **Details**, find the Environment URL as shown in the image below. This is the Organization URL required when creating the MS Dynamics CRM source in Zeotap CDP. ![The environment's Details panel with the Environment URL row highlighted, above the State, Region and Refresh cadence rows.](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-ms-dynamics-crm-source/create-an-ms-dynamics-crm-source-2024-09-19-9.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=3b3d94089fb83a2f9e5db1a938b97011) **Step 4** Next, under **Users + permissions**, click **Application users**. ![The environment Settings page with Application users highlighted under the expanded Users + permissions group.](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-ms-dynamics-crm-source/create-an-ms-dynamics-crm-source-2024-09-19-10.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=e836154113165dbc1d09d2cfe288b32d) **Step 5** In the new screen that appears, click **+ New app user**. **Step 6** In the **Create a new app user** window, under App, choose the Business unit using the drop-down menu and then click **+ Add an app**. ![The Application users page with New app user highlighted, and the Create a new app user panel open showing Add an app and the Business unit drop-down.](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-ms-dynamics-crm-source/create-an-ms-dynamics-crm-source-2024-09-19-11.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=7accffe482f429f715fc223690c718b4) **Step 7** In the new window that appears, search for the app that you registered earlier and click **Add**. ![The Add an app from Microsoft Entra ID panel with the registered app selected in the results list and the Add button highlighted.](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-ms-dynamics-crm-source/create-an-ms-dynamics-crm-source-2024-09-19-12.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=ddb4fd428fb330592385cf2184013318) **Step 8** Once done, you will be taken back to the **Create a new app user** window. Next to **Security roles**, select the **Edit** icon as shown below. ![The Create a new app user panel with the edit icon next to Security roles highlighted.](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-ms-dynamics-crm-source/create-an-ms-dynamics-crm-source-2024-09-19-14.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=b8d99e9fbe1e308bd4a6fd2e56139b66) **Step 9** Provide the following permissions for your app: * **Basic User** * **Service Reader** **Step 10** Once done, click **Save** and then click **Create**. After a few seconds, you will see your app user listed. This completes the configuration part. Next, you need to create an MS Dynamics source in Zeotap CDP. ## Create the Microsoft Dynamics CRM source Perform the following steps to create an MS Dynamics CRM source in the Zeotap CDP App: **Step 1** Navigate to the Sources application in the Zeotap CDP App. **Step 2** Click **CREATE SOURCE**. **Step 3** Choose **CRM Data** as the **Category**. ![Step 1 of Create Source, with CRM Data selected in the list of source categories.](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-ms-dynamics-crm-source/create-an-ms-dynamics-crm-source-2024-09-19-15.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=cb7f6b92184f919002e232faf43c2805) **Step 4** Click **Microsoft Dynamics CRM** as the **Data Source**. ![The Select Data Source step listing Salesforce CRM and Microsoft Dynamics CRM, with Microsoft Dynamics CRM selected.](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-ms-dynamics-crm-source/create-an-ms-dynamics-crm-source-2024-09-19-17.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=fdb9f3aa89dba8b073c8b5d79ffc59e0) **Step 5** In the window that appears, enter a short and descriptive name for the source. **Step 6** Select the Region of upload. **Step 7** Enter the App Client ID, App Client Secret, Tenant ID and Organization URL obtained from the Azure portal and the Power Automate portal in the respective fields. For more information about how to obtain these values, see [Register an app in the Azure portal](#register-an-app-in-the-azure-portal) and [Grant the app permissions in the Power Automate portal](#grant-the-app-permissions-in-the-power-automate-portal). ![Step 2 of Create Source, Source Details, showing the Source Name, Select your Region, App Client ID, App Client Secret, Tenant ID and Organization url fields.](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-ms-dynamics-crm-source/create-an-ms-dynamics-crm-source-2024-09-19-16.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=9dee349b57727b22dc9387afbe196206) **Step 8** Provide the desired **Entity** name. For example, account, campaign and incident (case) can be used to track and support sales, marketing and service activities. To learn more about what entities mean in MS Dynamics, see the [Microsoft documentation on entities](https://learn.microsoft.com/en-us/dynamics365/customerengagement/on-premises/developer/introduction-entities?view=op-9-1). **Step 9** Under **Data Entity**, depending on the type of data you want to ingest, choose either **Customer Data** or **Non Customer Data** and proceed with the source creation. To know more about Customer Data and Non Customer Data, see [Supported Data Entities](/articles/unify-customer/supported-data-entities). **Step 10** Review the fields entered above and click **Create Source**. ## Verify the source The created Microsoft Dynamics CRM source is listed on the source listing page. Open it and check the **IMPLEMENTATION DETAILS** tab, where you can find details about the source. Once data starts flowing in, you can examine a sample of it on the **PREVIEW DATA** tab, and the status of the source changes to *Integrated*. See [Components of the Preview Data Tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) for what each option on that tab does. ## Troubleshoot the source **You did not copy the client secret.** The **Value** of a client secret is shown only once, when the secret is created. If you did not save it, you cannot read it back from the Azure portal — add a new client secret as described in [Register an app in the Azure portal](#register-an-app-in-the-azure-portal) and copy the value at that point. **No preview data appears.** If no preview is available, an error message is displayed on the **PREVIEW DATA** tab stating the reason. Fix the issue reported there, check that the source is implemented correctly, and try again after some time. See [Components of the Preview Data Tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab). For anything else, reach out to the Zeotap support team at [support@zeotap.com](mailto:support@zeotap.com). ## Next steps * Map the ingested data in the Catalogue — see [Map the Catalogue for Customer Data](/articles/unify-customer/map-the-catalogue-for-customer-data) for Customer Data (CE), or [Map the Catalogue for Non-Customer Entity Data](/articles/unify-customer/map-the-catalogue-for-non-customer-entity-data) for Non-Customer Entity (NCE) data. * Check what Customer Data and Non-Customer Entity data cover in [Supported Data Entities](/articles/unify-customer/supported-data-entities). * Read more about the integration itself in [MS Dynamics Source](/articles/integrate-customer/ms-dynamics-source). # Create a Pub/Sub Batch Source Source: https://docs.zeotap.com/articles/integrate-customer/create-a-pub-sub-batch-source Create a Pub/Sub Batch source to bring batched messages from a Google Pub/Sub topic you own into Zeotap CDP. ## What this is The Pub/Sub Batch source brings data **into** Zeotap CDP: you publish batched messages to a Google Pub/Sub topic in your own Google Cloud project, and Zeotap CDP subscribes to that topic and ingests the messages as a source. It is one of the [Message Queue](/articles/integrate-customer/message-queue) source integrations, alongside the real-time [Pub/Sub Stream](/articles/integrate-customer/pub-sub-stream) source. Use it when you want to hand Zeotap many messages per request rather than one at a time — see [Pub/Sub Batch](/articles/integrate-customer/pub-sub-batch) for the concept. This page covers the source direction only. To send data **out** of Zeotap CDP to a Pub/Sub topic you own, use the [Google Pub/Sub](/articles/integrate-customer/google-pub-sub) destination instead. ## Prerequisites > [!NOTE] > > Before you start, gather the following. The first item blocks ingestion if you skip it, so arrange it before you begin the setup. > > * **Storage access for the Zeotap service account — arrange this first.** Your Pub/Sub service account will not have the permissions it needs to access the storage bucket, and until those permissions are granted, Batch Pub/Sub subscriptions will be unable to push files to cloud storage. Reach out to your Zeotap POC **before** setting up the Pub/Sub Batch source so that the required access permissions are granted. > * **A Topic ID** from your Google Pub/Sub account, in the fully qualified form described under **Get the Topic ID** below. Use a topic that is not already attached to a Pub/Sub Stream source. > * **Permission to attach a subscription** granted to the Zeotap service account on your Pub/Sub instance, as described under **Grant the Zeotap service account access**. > * **A decision on the Data Entity** you will ingest — Customer Data or Non Customer Data. See [Supported data entities](/articles/unify-customer/supported-data-entities). > * **Messages in the expected JSON shape**, minified, as shown under **Format your messages**. ## How the Pub/Sub Batch source works Pub/Sub Batch upload sends multiple messages to a Pub/Sub topic in a single request, which saves network requests and improves the performance and scalability of your applications. Zeotap CDP consumes those messages from your side of the integration: 1. Your application publishes batched messages to a topic in your Google Cloud project. 2. You grant the Zeotap service account permission to attach a subscription to that topic. 3. Zeotap CDP attaches a subscription, and the Batch Pub/Sub subscription pushes the messages to cloud storage as files — which is why the service account also needs the storage access covered in the prerequisites. 4. The records arrive on your Zeotap CDP source, where you can preview and map them. ## Gather your Pub/Sub details ### 1. Get the Topic ID A Topic ID in Google Pub/Sub represents the unique identifier for the topic. Topics enable the categorisation or grouping of messages according to specific subjects or themes. It allows consumers to selectively subscribe to and receive messages based on their interest in specific topics. To obtain the Topic ID, navigate to the Pub/Sub catalog on the Google Cloud console, locate the desired topic and click on its name to view its details, where you can find the Topic ID. **Note that while creating a source in Zeotap CDP, you need to furnish the fully qualified Topic ID in the format:** `project/folder/topic/topic_id`**.** > [!NOTE] > > We recommend using different Topic IDs for Pub/Sub Batch and Pub/Sub Stream sources. If you use the same Topic ID for both sources, you will receive the same data in both sources. ### 2. Grant the Zeotap service account access In Pub/Sub, a service account is a type of identity that is used to authenticate and authorise communication between Zeotap CDP and your Pub/Sub account. You can find the service account details while creating a source for Pub/Sub Batch in Zeotap CDP, and again on the **IMPLEMENTATION DETAILS** tab after the source is created. Provide the following permission to that service account in your Pub/Sub instance: `Attach a subscription to a topic: pubsub.topics.attachSubscription` ### 3. Format your messages When sending data from the Pub/Sub Batch source to Zeotap CDP, adhere to the following format, and keep the JSON data in minified/compact form. ```json theme={null} { "event_id": "MnaBHikPVjICP5OZgyAL1", "event_eventName": "selectCategory", "event_categoryName": "Chairs", "event_eventTimestamp": 1715084201414, "user_zs": "60212de5-252a-4219-a05c-c6efcc973365", "user_zi": "0836edce-84bf-48c3-8db9-b6bda6b129d1", "user_zi_domain": ".zeotap.com", "user_country": "FRA", "page_path": "/otis-malt-sofa", "page_referrer": "", "page_url": "https://example.com/otis-malt-sofa", "page_page_category": "Otis Malt Sofa", "page_page_category_level": "2", "page_page_name": "Otis Malt Sofa", "page_page_domain": "example.com", "page_id": "Kzc4PTvs09DVQd8U1XAxL", "meta": {}, "version": "4.3.5" } ``` The records for the `country` and `city` columns are blacklisted for ingestion because Zeotap resolves them from the user's IP address automatically. For the complete list, see [Blacklisted fields for data ingestion](/articles/integrate-customer/blacklisted-fields-for-data-ingestion). ## Create the Pub/Sub Batch source Perform the following steps to create a Pub/Sub Batch source: 1. Log into the Zeotap CDP App and navigate to the **Sources** application under **Integrate**. 2. Click **CREATE SOURCE**. 3. Choose **Message Queue** as the Category. ![Source creation flow with Message Queue selected as the Category](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-pub-sub-streaming-source/create-a-pub-sub-streaming-source-2024-05-16.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=b215ca1521fed2674132a9ab5e252b3f) The Category step of the source creation flow. Screenshot captured on the Pub/Sub Stream source form. 4. Click **Pub/Sub - Batch** as the Data Source. ![Data Source picker with Pub/Sub - Batch selected](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-pub-sub-batch-source/create-a-pub-sub-batch-source-2024-05-27.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=931d7c5d0bf40cfbc6509c43d2c4a66b) Selecting Pub/Sub - Batch as the Data Source. 5. Enter a short and descriptive name for the source. 6. By default, the **region** is chosen as **Europe (EU)**. See [Region of storage](/articles/integrate-customer/region-of-storage) for what the region controls. 7. Under **Data Entity**, depending on the type of data that you want to ingest, choose either **Customer Data** or **Non Customer Data** and proceed with the source creation. To know more about Customer Data and Non Customer Data, refer to [Supported data entities](/articles/unify-customer/supported-data-entities). 8. Enter the **Topic ID** obtained from your Pub/Sub account, as described under **Get the Topic ID** above. 9. Under **Service Account**, the Zeotap service account is displayed. Ensure that you provide access to that service account on the Google Cloud console. This allows Zeotap CDP to fetch data from Pub/Sub. ![Source creation form showing the Zeotap service account under the Service Account field](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-pub-sub-streaming-source/create-a-pub-sub-streaming-source-2024-05-16-2.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=e67a14d9f11e159b4a97efe60e6b5e3a) The Service Account field on the source creation form. Screenshot captured on the Pub/Sub Stream source form. 10. Click **CREATE SOURCE**. **Expected result:** the source is created, and the **Topic ID** and Service Account used for the integration are displayed under the **IMPLEMENTATION DETAILS** tab, along with all the important information related to the integration. ![IMPLEMENTATION DETAILS tab showing the Topic ID and service account used for the integration](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-pub-sub-batch-source/create-a-pub-sub-batch-source-2024-05-27-1.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=bd838b4effb1fbd30c2299abdf856f60) The IMPLEMENTATION DETAILS tab of a created Pub/Sub Batch source. ## Verify the source You have set the source up correctly when all of the following hold: * The new source appears on the Sources listing page. * The **IMPLEMENTATION DETAILS** tab of the source displays the **Topic ID** and the Service Account used for the integration, along with the rest of the information related to the integration. * After you publish messages to the topic, records appear on the source's **PREVIEW** tab. See [the fields on the Preview Data tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) for how to read it. If no records appear, work through the troubleshooting table below. ## Troubleshoot the Pub/Sub Batch source | Symptom | What it means | Where to look | | - | - | - | | Messages are published to the topic, but no files reach cloud storage and no records reach the source | The Zeotap service account has not been granted access to the storage bucket, so the Batch Pub/Sub subscription cannot push files | Reach out to your Zeotap POC to have the storage access permissions granted, as described in **Prerequisites** | | Zeotap CDP cannot attach a subscription to your topic | The Zeotap service account is missing the attach-subscription permission on your Pub/Sub instance | Your topic's permissions in the Google Cloud console — grant `pubsub.topics.attachSubscription` to the service account shown under **Service Account** | | The same records appear in both your Pub/Sub Batch and Pub/Sub Stream sources | Both sources are configured with the same Topic ID | The **Topic ID** on the **IMPLEMENTATION DETAILS** tab of each source — give each source its own topic | | A `country` or `city` field you published is missing from the ingested records | Those fields are blacklisted for ingestion | [Blacklisted fields for data ingestion](/articles/integrate-customer/blacklisted-fields-for-data-ingestion) | | Messages reach the topic but are not ingested as expected | The JSON is not in the minified/compact form and field shape the source expects | The sample under **Format your messages**, and your publisher's serialisation settings | If you need any assistance to set up this integration, you can reach out to your Zeotap POC. ## FAQ > [accordion] Is the Pub/Sub Batch source the same as the Google Pub/Sub destination? > > No. The Pub/Sub Batch source brings data from your Pub/Sub topic **into** Zeotap CDP. The [Google Pub/Sub](/articles/integrate-customer/google-pub-sub) destination sends data **out** of Zeotap CDP to a topic you own. Despite the similar names, the two are not interchangeable — pick the one that matches the direction your data needs to travel. > [accordion] Can I use the same Topic ID for my Pub/Sub Batch and Pub/Sub Stream sources? > > Use different Topic IDs. If you configure the same Topic ID on both sources, you will receive the same data in both sources. > [accordion] How is the Pub/Sub Batch source different from the Pub/Sub Stream source? > > Pub/Sub Batch sends multiple messages to a topic in a single request, which saves network requests and improves the performance and scalability of your applications. Pub/Sub Stream publishes to a topic and delivers to subscribers as soon as new messages arrive, for real-time exchange. The two sources also expect different payload shapes — compare the sample under **Format your messages** on this page with the sample on [Create a Pub/Sub Stream Source](/articles/integrate-customer/create-a-pub-sub-streaming-source). > [accordion] Which data entities can a Pub/Sub Batch source ingest? > > Both Customer Data (CE) and Non-Customer Entity (NCE) Data. You choose which one applies under **Data Entity** during source creation. > [accordion] Does the Pub/Sub Batch source support delta fetch? > > No. Delta fetch is not supported on the Pub/Sub Batch source, nor on the Pub/Sub Stream source. > [accordion] Where do I find the Zeotap service account I need to grant access to? > > It is displayed under **Service Account** while you are creating the source, and again on the **IMPLEMENTATION DETAILS** tab after the source is created. ## Next steps * Explore [Pub/Sub Batch →](/articles/integrate-customer/pub-sub-batch) for what this source does and when to choose it. * Explore [Create a Pub/Sub Stream Source →](/articles/integrate-customer/create-a-pub-sub-streaming-source) for the real-time counterpart. * Explore [Message Queue →](/articles/integrate-customer/message-queue) for the other queue-based source integrations. * Explore [the Google Pub/Sub destination →](/articles/integrate-customer/google-pub-sub) for sending data out of Zeotap CDP. * Explore [Blacklisted fields for data ingestion →](/articles/integrate-customer/blacklisted-fields-for-data-ingestion) before you finalise your payload. * Explore [Source alerts →](/articles/integrate-customer/source-alerts) to be notified when this source stops receiving data. # Create a Pub/Sub Stream Source Source: https://docs.zeotap.com/articles/integrate-customer/create-a-pub-sub-streaming-source Create a Pub/Sub Stream source to bring messages into Zeotap CDP from a Google Pub/Sub topic as they are published. ## What this is The Pub/Sub Stream source is an **inbound** integration: it brings data **into** Zeotap CDP from a Google Pub/Sub topic that you own. You publish messages to your topic, Zeotap CDP consumes them from a subscription attached to that topic, and the records land in the source ready for preview and mapping. This page covers the **streaming** variant, which carries messages one at a time as they are published. If you want to hand Zeotap CDP messages in bundles instead, use [Create a Pub/Sub Batch Source](/articles/integrate-customer/create-a-pub-sub-batch-source) — it is a separate source with its own topic, its own flattened payload shape, and its own creation flow. > [!NOTE] > > Pub/Sub appears in Zeotap CDP in both directions, and the names are similar. This page is the **source** (data in). To send data **out** of Zeotap CDP to a Pub/Sub topic, see the [Google Pub/Sub destination](/articles/integrate-customer/google-pub-sub) instead. ## Prerequisites > [!NOTE] > > Before you begin, confirm the following: > > * You have access to the **Sources** application in the Zeotap CDP App, with permission to create a source. > * You have a Google Pub/Sub topic to publish to, and you can read its **Topic ID** from the Pub/Sub catalog in the Google Cloud console. > * You can grant permissions on that topic in Google Cloud, so that the Zeotap service account shown during source creation can attach a subscription to it. > * You use a **different Topic ID** from the one used by any Pub/Sub Batch source. See [Keep the stream and batch topics separate](#keep-the-stream-and-batch-topics-separate). > * You know which **Data Entity** applies to the data you will send — Customer Data or Non Customer Data. See [Supported data entities](/articles/unify-customer/supported-data-entities). > * Your publisher can emit the JSON payload shape described in [Send data in the expected format](#send-data-in-the-expected-format). ## How the Pub/Sub Stream source works Pub/Sub decouples the system producing messages from the system processing them. Messages are published to a **topic**, and any consumer interested in that topic subscribes to it and receives messages as they arrive. In this integration, your application is the publisher and Zeotap CDP is the consumer: 1. You create the source in Zeotap CDP and give it the fully qualified Topic ID of your Pub/Sub topic. 2. Zeotap CDP shows you a service account. You grant that account permission to attach a subscription to the topic in your Google Cloud project. 3. Zeotap CDP consumes the published messages through that subscription and ingests them into the source. Because the subscription is attached to the topic you name, the topic determines which source receives the data — which is why a stream source and a batch source should each have a topic of their own. ## Prepare your Pub/Sub topic A **Topic ID** in Google Pub/Sub is the unique identifier for a topic. Topics enable the categorisation or grouping of messages according to specific subjects or themes, and allow consumers to selectively subscribe to and receive messages based on their interest in specific topics. To obtain the Topic ID, navigate to the Pub/Sub catalog in the Google Cloud console, locate the desired topic, and click its name to view its details, where you can find the Topic ID. **While creating a source in Zeotap CDP, you need to furnish the fully qualified Topic ID in the format:** `project/folder/topic/topic_id`**.** ### Keep the stream and batch topics separate We recommend using different Topic IDs for Pub/Sub batch and stream sources. If you use the same Topic ID for both sources, you will receive the same data in both sources. ## Create the Pub/Sub Stream source Perform these steps in the Zeotap CDP App: 1. Log into the Zeotap CDP App and navigate to the **Sources** application under **Integrate**. 2. Click **CREATE SOURCE**. 3. Choose **Message Queue** as the Category. ![Source creation flow with Message Queue chosen as the Category](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-pub-sub-streaming-source/create-a-pub-sub-streaming-source-2024-05-16.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=b215ca1521fed2674132a9ab5e252b3f) 4. Click **Pub/Sub Stream** as the Data Source. ![Pub/Sub Stream selected as the Data Source under the Message Queue category](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-pub-sub-streaming-source/create-a-pub-sub-streaming-source-2024-05-27.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=4587b1bfd2867e4ea3b8a61b235dba5a) 5. Enter a short and descriptive name for the source. 6. By default, the **region** is chosen as **Europe (EU)**. See [Region of storage](/articles/integrate-customer/region-of-storage) for the country-to-region mapping Zeotap uses. 7. Under **Data Entity**, choose either **Customer Data** or **Non Customer Data**, depending on the type of data that you want to ingest. See [Supported data entities](/articles/unify-customer/supported-data-entities). 8. Enter the **Topic ID** obtained from your Pub/Sub account, in the fully qualified format described under **Prepare your Pub/Sub topic** above. 9. Under **Service Account**, note the Zeotap service account that is displayed. You will grant this account access on your topic in the next section, which is what allows Zeotap CDP to consume messages from Pub/Sub. ![Source creation form with the Service Account field](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-pub-sub-streaming-source/create-a-pub-sub-streaming-source-2024-05-16-2.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=e67a14d9f11e159b4a97efe60e6b5e3a) 10. Click **CREATE SOURCE**. Upon successful creation, the **Topic ID** and the service account used for the integration are displayed under the **IMPLEMENTATION DETAILS** tab, along with the rest of the information related to the integration. ![IMPLEMENTATION DETAILS tab of the created source listing the Topic ID and the service account](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-pub-sub-streaming-source/create-a-pub-sub-streaming-source-2024-05-16-3.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=d5f3f43f3abac45330e08f9c409536aa) ## Grant the Zeotap service account access to your topic A service account in Pub/Sub is a type of identity used to authenticate and authorise communication between Zeotap CDP and your Pub/Sub account. The account for your source is shown during source creation and on the source's **IMPLEMENTATION DETAILS** tab. In your Pub/Sub instance, provide the following permission to that service account: `Attach a subscription to a topic: pubsub.topics.attachSubscription` Without this permission, Zeotap CDP cannot attach a subscription to your topic, and no messages reach the source. ## Send data in the expected format When sending data from the Pub/Sub streaming source to Zeotap CDP, ensure that you adhere to the following format. Replace the sample values with your own. ```json theme={null} { "event": { "id": "MnaBHikPVjICP5OZgyAL1", "eventName": "selectCategory", "categoryName": "Chairs", "eventTimestamp": 1715084201414 }, "user": { "zs": "60212de5-252a-4219-a05c-c6efcc973365", "zi": "0836edce-84bf-48c3-8db9-b6bda6b129d1", "zi_domain": ".example.com", "country": "FRA" }, "page": { "path": "/otis-malt-sofa", "referrer": "", "url": "https://example.com/otis-malt-sofa", "page_category": "Otis Malt Sofa", "page_category_level": "2", "page_name": "Otis Malt Sofa", "page_domain": "example.com", "id": "Kzc4PTvs09DVQd8U1XAxL" }, "meta": {}, "version": "" } ``` > [!NOTE] > > The records for the `country` and `city` columns are blacklisted for ingestion, because Zeotap CDP uses the user's IP address to determine the `country` and `city` automatically. For the complete list of blacklisted fields, see [Blacklisted fields for data ingestion](/articles/integrate-customer/blacklisted-fields-for-data-ingestion). ## Verify the integration You have set the source up correctly when all of the following are true: * The source's **IMPLEMENTATION DETAILS** tab shows the Topic ID and the service account you configured. * On the Sources listing page, the source moves from the **Created** status to **Integrated** once data starts flowing in. See [Components of the Source Listing Page](/articles/integrate-customer/components-of-the-source-listing-page). * The source's **PREVIEW DATA** tab shows a sample of the incoming records. See [Components of the Preview Data tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab). If the source is still in the **Created** status after you have published messages, work through the section below. ## Troubleshoot the integration | Condition | What it means | Where to look | | - | - | - | | The source stays in the **Created** status after you publish messages | No data has reached the source yet — either the service account has not been granted the subscription permission on your topic, or the Topic ID on the source does not match the topic you are publishing to | The topic's permissions in Google Cloud, and the **Topic ID** on the source's **IMPLEMENTATION DETAILS** tab | | The same records appear in both your Pub/Sub Stream and Pub/Sub Batch sources | Both sources are pointing at the same topic | The Topic ID configured on each source — give the stream source and the batch source a topic each | | Records reach the source, but `country` and `city` are empty in **PREVIEW DATA** | Those columns are blacklisted for ingestion and are derived from the user's IP address instead | [Blacklisted fields for data ingestion](/articles/integrate-customer/blacklisted-fields-for-data-ingestion) | If you need any assistance to set up this integration, you can reach out to your Zeotap POC. ## FAQ > [accordion] What is the difference between the Pub/Sub Stream source and the Pub/Sub Batch source? > > The Pub/Sub Stream source carries messages as they are published to the topic. The Pub/Sub Batch source is a separate source type, created from the **Pub/Sub - Batch** data source tile, for messages handed over in bundles. Each has its own creation flow and its own payload shape — see [Create a Pub/Sub Batch Source](/articles/integrate-customer/create-a-pub-sub-batch-source). > [accordion] Can I use one Topic ID for both my stream and batch sources? > > We recommend against it. If you use the same Topic ID for both sources, you will receive the same data in both sources. Use a separate topic for each. > [accordion] Is this the same as the Google Pub/Sub destination? > > No. This page creates a **source**, which brings data into Zeotap CDP. The [Google Pub/Sub destination](/articles/integrate-customer/google-pub-sub) sends data out of Zeotap CDP to a Pub/Sub topic. They are configured separately, in different applications. > [accordion] Which data entities does this source support? > > The Pub/Sub Stream source supports Customer Data (CE) and Non-Customer Entity (NCE) data. You choose which applies under **Data Entity** during source creation — see [Supported data entities](/articles/unify-customer/supported-data-entities). > [accordion] Where do I find the service account after the source is created? > > Open the source and go to the **IMPLEMENTATION DETAILS** tab. The Topic ID and the service account used for the integration are both listed there. ## Next steps * Explore [Pub/Sub Stream →](/articles/integrate-customer/pub-sub-stream) for the concept behind this source and where real-time messaging fits. * Explore [Create a Pub/Sub Batch Source →](/articles/integrate-customer/create-a-pub-sub-batch-source) if you also need a batched feed from Pub/Sub. * Explore [Message Queue →](/articles/integrate-customer/message-queue) for the other message queue sources Zeotap CDP supports. * Explore [Components of the Preview Data tab →](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) to read the records that arrive from your topic. * Explore [Google Pub/Sub destination →](/articles/integrate-customer/google-pub-sub) to send data from Zeotap CDP back out to a Pub/Sub topic. # Create a Snowflake Source and Load Data Source: https://docs.zeotap.com/articles/integrate-customer/create-a-snowflake-source Bring data from a Snowflake table into Zeotap CDP: gather your Snowflake credentials, enable delta fetch, create the source, load the data and verify it arrives. ## What this is The Snowflake **source** brings data **into** Zeotap CDP: you point Zeotap CDP at a table in your own Snowflake account, and Zeotap CDP pulls that table on a schedule you choose. To send Zeotap CDP audiences **out** to Snowflake instead, see the [Snowflake destination](/articles/integrate-customer/snowflake-destination). This page covers the full setup: the Snowflake account details you need to collect, how to enable delta fetch on the table, how to create the source in the **Sources** module, how to load data from Snowflake, and how to confirm the data arrived. > [!NOTE] > > **Note:** > > * The sandbox environment does not support deltas, but they are available in production. > * The sandbox supports only a daily refresh, which occurs once every 24 hours. It does not support intraday refresh. ## Prerequisites > [!NOTE] > > Before you create a Snowflake source in the **Sources** module, ensure that you have: > > * An account with [Snowflake](https://app.snowflake.com/), containing the data that you want to import into Zeotap CDP. > * The **Username**, **Account Name**, **Warehouse**, **Database**, **Schema** and **Table** values for that account, and either the user's **Password** or an RSA **Key Pair** to authenticate with. [Gather your Snowflake account details](#gather-your-snowflake-account-details) explains where to find each one. > * The warehouse you intend to use in **Started** (Active) status. > * Delta fetch already enabled on the table, if you plan to set **Delta Queries Selection** to **true**. See [Enable delta fetch in Snowflake](#enable-delta-fetch-in-snowflake). ## Supported data and identifiers * **Data entity** — a Snowflake source can carry either [Customer Data](/articles/unify-customer/customer-data) (CE) or [Non Customer Data](/articles/unify-customer/non-customer-entity-data) (NCE). You choose which when you create the source. * **Identifiers** — the table must carry at least one identifier, such as email, cellphone, cookie or ADID. * **Columns** — there is no limit on the number of columns ingested. Map them to Zeotap CDP's standard catalogue or add custom fields. For the country, region and mapping rules that apply to the incoming table, see [Best Practices for Snowflake Source](/articles/integrate-customer/best-practices-for-snowflake-source). ## Gather your Snowflake account details Collect the following values from Snowflake before you open the **Sources** module. ### Username This is the username used to log in to your [Snowflake account](https://app.snowflake.com/). ### Password This is the password for the above user. You need this only if you select **Password** as the **Authentication Type** while creating the source. ### Key Pair Instead of a password, you can authenticate using an RSA key pair. You need this only if you select **Key Pair** as the **Authentication Type** while creating the source. Snowflake requires a minimum of a 2048-bit RSA key pair in the Privacy Enhanced Mail (PEM) format, generated using the PKCS#8 standard. Perform the following steps to generate the key pair and register it against your Snowflake user: **Step 1** Generate a private key. To generate an **encrypted** private key (recommended), run the following command. You are prompted for a passphrase, which you later enter in the **Private Key Passphrase** field in Zeotap CDP. ```bash theme={null} openssl genrsa 2048 | openssl pkcs8 -topk8 -v2 des3 -inform PEM -out rsa_key.p8 ``` To generate an **unencrypted** private key, run the following command instead. In this case, leave the **Private Key Passphrase** field empty in Zeotap CDP. ```bash theme={null} openssl genrsa 2048 | openssl pkcs8 -topk8 -inform PEM -out rsa_key.p8 -nocrypt ``` **Step 2** Generate the public key from the private key that you created above. ```bash theme={null} openssl rsa -in rsa_key.p8 -pubout -out rsa_key.pub ``` **Step 3** Assign the public key to your Snowflake user by running the following command in a Snowflake worksheet. Replace `example_user` with your Snowflake username, `my_key` with a name of your choice for the key pair, and the value of `PUBLIC_KEY` with the contents of `rsa_key.pub`. ```sql theme={null} ALTER USER example_user ADD KEY PAIR my_key PUBLIC_KEY = 'MIIBIjANBgkqh...'; ``` **Step 4** Verify that the public key registered in Snowflake matches your local key by comparing their fingerprints. Run the following in Snowflake: ```sql theme={null} DESC USER example_user ->> SELECT SUBSTR( (SELECT "value" FROM $1 WHERE "property" = 'RSA_PUBLIC_KEY_FP'), LEN('SHA256:') + 1) AS key; ``` Then run the following locally and confirm that both values match: ```bash theme={null} openssl rsa -pubin -in rsa_key.pub -outform DER | openssl dgst -sha256 -binary | openssl enc -base64 ``` > [!NOTE] > > **The two halves of the key pair go to different places:** > > * The **private** key file (`rsa_key.p8`) is the file that you upload to Zeotap CDP under **Upload PEM file**. > * The **public** key (`rsa_key.pub`) is the one that you register against your Snowflake user. ### Account Name This is the account ID of your cluster, which is a combination of your *Organization name* and *Account name* on Snowflake. Perform the following steps to obtain it: **Step 1** Select your profile in the lower-left corner of the Snowflake screen. Navigate to **Account**, and then click **View Account Details** under your account. **Step 2** Copy the **Account Identifier** displayed under the **Account** tab, which is your **Account Name** in Zeotap CDP. ![Account Identifier shown under the Account tab in Snowflake](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-a-snowflake-source/create-a-snowflake-source-2025-01-23-4.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=88d38391d9d52235bfece80304f280f9) ### Warehouse A [virtual warehouse](https://docs.snowflake.com/en/user-guide/warehouses), often referred to simply as a "warehouse", is a cluster of compute resources in Snowflake. Ensure that the warehouse you use is in **Started** (Active) status when integrating with Zeotap CDP. To obtain the warehouse details, perform the following steps: **Step 1** Navigate to **Admin** > **Warehouses**. **Step 2** Copy the **Warehouse Name** as shown in the image below. To create a new warehouse, click **+ Warehouse** in the top-right corner of the screen. ![Warehouse list in Snowflake with the Warehouse Name column and the + Warehouse button](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-a-snowflake-source/create-a-snowflake-source-2025-01-23-6.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=4c85492a20c43ac17b0884fb38e09e2f) > [!NOTE] > > **Note:** > > You can resume a suspended (that is, inactive) warehouse by following the steps provided in the [Snowflake documentation](https://docs.snowflake.com/en/user-guide/warehouses-tasks#starting-or-resuming-a-warehouse). ### Database All data in Snowflake is maintained in databases. Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views. To obtain the **Database** details from Snowflake, navigate to **Databases** under **Data** > click the desired Database and copy the **Database Name** as shown in the image below. > [!NOTE] > > **Note that each source creates its own schemas and tables, so we recommend to create a new database for this purpose to avoid name conflicts with existing data**. To learn how to create a new database, refer to the [Snowflake documentation](https://docs.snowflake.com/en/sql-reference/sql/create-database). ![Database list under Data in Snowflake, showing the Database Name](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-a-snowflake-source/create-a-snowflake-source-2025-01-23-14.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=4cdfd31a6d5c9c97ea2fab0e5b971c81) ### Schema A schema is a container for all objects such as tables, views and stored procedures in the same logical namespace. To obtain the schema details from Snowflake, navigate to **Databases** under **Data** > under the desired Database > click the **Schemas** tab and copy the **Schema Name** as shown in the image below. ![Schemas tab of a Snowflake database, showing the Schema Name](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-a-snowflake-source/create-a-snowflake-source-2025-01-23-17.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=3c17243e39c49b0d5f7a9e93549659a7) ### Table A table is a container for rows of data organised and described by columns, which can be used for data storage, analysis and querying. To obtain the **Table** details from Snowflake, navigate to **Databases** under **Data** > under the desired Database > click the desired Schema > click **Tables** and copy the desired **Table Name** as shown in the image below. ![Tables list under a Snowflake schema, showing the Table Name](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-a-snowflake-source/create-a-snowflake-source-2025-01-23-16.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=5e388dd0628fb9b8894ea791ecbdcd60) ## Enable delta fetch in Snowflake Complete this section **before** you create the source if you intend to set **Delta Queries Selection** to **true**. To enable delta fetch on the desired table, perform the following steps: **Step 1** In the Snowflake console, navigate to **Projects** > **Worksheets**. **Step 2** Click **create New SQL** worksheet. ![Creating a new SQL worksheet under Projects in the Snowflake console](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/snowflake-destination/snowflake-destination-2025-01-29-10.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=c14524016326971994dc989472251212) **Step 3** Choose the **Database** and **Schema** in which to run the command, as shown below. ![Selecting the Database and Schema for a Snowflake SQL worksheet](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/snowflake-destination/snowflake-destination-2025-01-29-11.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=c1c34f30af571dbb71156187602ff83c) **Step 4** Enter the command `ALTER TABLE ${TABLE_NAME} SET CHANGE_TRACKING = TRUE;` in the right-hand side of the screen. **Step 5** Replace `${TABLE_NAME}` with the actual table name and click the **Run** button. ![Running the ALTER TABLE SET CHANGE_TRACKING command in a Snowflake worksheet](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-a-snowflake-source/create-a-snowflake-source-2025-02-06-2.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=7b5ef53cf80c4c2c7d21770471cd78f4) **Step 6** Once this process is complete, the selected table is configured to support delta fetches. ## Create the Snowflake source in Zeotap CDP Once you have obtained the above details from Snowflake, perform the following steps to create a Snowflake source in the Zeotap CDP App: **Step 1** In the Zeotap CDP App, navigate to **Integrate** > **Sources**. **Step 2** Click **+ Create Source**. **Step 3** Choose **Data Warehouse** as the **Category**. ![Choosing Data Warehouse as the source Category in Zeotap CDP](https://mintcdn.com/zeotap/1FGgO964H8EKim6t/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/create_snowflake_1.png?fit=max\&auto=format\&n=1FGgO964H8EKim6t\&q=85\&s=f4e37183d8d62b4a2ef55a4501114c69) **Step 4** Click **Snowflake** as the **Data Source**. ![Selecting Snowflake as the Data Source in Zeotap CDP](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-a-snowflake-source/create-a-snowflake-source-2024-10-21.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=7b9474fe83e8d39d6f2dee2d0f87747f) **Step 5** Enter the information below based on your Snowflake account. For more information about how to obtain these values from Snowflake, see [Gather your Snowflake account details](#gather-your-snowflake-account-details). a. Under **Source name**, enter a descriptive name for your source. b. Select the **region** of upload as per your requirement. c. Choose the desired **Sync Frequency** using the drop-down. The first data sync takes place once you create the source. However, the subsequent syncs occur based on the sync frequency that you chose. Currently, we support the following sync frequencies: * **Daily** * **Weekly** * **Monthly** * **Hourly** * **Thirty Minutes** * **Fifteen Minutes** d. Provide the **Username**, **Account name**, **Warehouse**, **Database**, **Schema** and **Table** details that you obtained from your Snowflake account. ![Snowflake source configuration form in Zeotap CDP with the connection fields](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-a-snowflake-source/create-a-snowflake-source-2025-01-23-12.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=d97c41d75de5642be1363713881c7e4c) e. Under **Data Entity**, depending on the type of data that you want to ingest, choose either [Customer Data](/articles/unify-customer/customer-data) or [Non Customer Data](/articles/unify-customer/non-customer-entity-data). ![Data Entity option on the Snowflake source form in Zeotap CDP](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-a-snowflake-source/create-a-snowflake-source-2025-02-06-1.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=6f2a94f0098b102497a5c4cd862e8547) f. Under **Delta Queries Selection**, you can choose whether or not you want to consider deltas (data additions/changes) in a table. Based on your requirement, select either **true** or **false**. ![Delta Queries Selection option on the Snowflake source form in Zeotap CDP](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-a-snowflake-source/create-a-snowflake-source-2025-02-06.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=72b5d89edcd6880d0aa5053a5ea3e2de) * If you select **true**, Zeotap CDP exclusively gathers incremental updates (deltas) as per the sync frequency configured. * If you select **false**, then Zeotap CDP retrieves and transfers the entire dataset during each subsequent synchronisation, regardless of any changes made. This process ensures the full dataset is updated at each sync frequency. > [!WARNING] > > If you want to use **Delta Queries Selection**, ensure that you perform the steps under [Enable delta fetch in Snowflake](#enable-delta-fetch-in-snowflake) **before** you create the Snowflake source. g. Under **Authentication Type**, choose how Zeotap CDP authenticates with your Snowflake account. * Choose **Password** to authenticate using the Snowflake user's password, and enter it under **Password**. ![The Authentication Type field on the Snowflake source form in Zeotap CDP, with Password selected and an empty Password field below it](https://mintcdn.com/zeotap/tmmJdRu3IYxHov39/articles/integrate-customer/Storage/integrate-customer/create-a-snowflake-source/create-a-snowflake-source-2026-10-01.png?fit=max\&auto=format\&n=tmmJdRu3IYxHov39\&q=85\&s=e991010d522bf880383dd45c09845b11) * Choose **Key Pair** to authenticate using an RSA key pair. Under **Upload PEM file**, click **+ Select File** and upload the private key file (`rsa_key.p8`) that you generated. If the private key is encrypted, enter its passphrase under **Private Key Passphrase**; if it is unencrypted, leave the field empty. For more information about how to generate the key pair, refer to the [Key Pair](#key-pair) section. ![The Authentication Type field on the Snowflake source form in Zeotap CDP, with Key Pair selected, showing the Upload PEM file area with a + Select File button and an empty Private Key Passphrase field](https://mintcdn.com/zeotap/tmmJdRu3IYxHov39/articles/integrate-customer/Storage/integrate-customer/create-a-snowflake-source/create-a-snowflake-source-2026-10-01-1.png?fit=max\&auto=format\&n=tmmJdRu3IYxHov39\&q=85\&s=3634f5eaa206e22a12ad9c3a34750c59) **Step 6** Review all the fields entered and click **Create Source**. The newly created source is listed on the [Source Listing](/articles/integrate-customer/components-of-the-source-listing-page) page. You can verify the details of the created source in the **Implementation Details** tab, as shown below. ![Implementation Details tab of a created Snowflake source in Zeotap CDP](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-a-snowflake-source/create-a-snowflake-source-2025-01-23-10.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=bc381575ca30d26ca10563bf1f9b9cd4) > [!NOTE] > > **Note:** > > You can create a maximum of five Non-Customer Entity Data (NCE) sources in an account. This default limit applies to both archived and active NCE sources within an organisation. To increase the limit, reach out to your Zeotap POC. ## Load data from Snowflake into the source After successfully creating a Snowflake source in Zeotap CDP by providing details such as Username, Password, Warehouse, Database, Schema, Table and more, you can start loading the data from your Snowflake account to Zeotap CDP. To do so, perform the following steps: **Step 1** Log into your [Snowflake account](https://app.snowflake.com/). **Step 2** Ensure that the **Warehouse** name matches the Warehouse name you provided while creating the source in Zeotap CDP by navigating to your account details. **Step 3** In the left navigation panel, click **Databases** under **Data**. A list of databases appears. ![List of databases under Data in the Snowflake left navigation panel](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-snowflake-source/create-a-snowflake-source-2024-03-27-1.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=8829dfd5e218db30f0a042742555b678) **Step 4** Click the **Database** that you provided while creating the source in Zeotap CDP. **Step 5** Under the chosen Database, click **Schemas**. ![Schemas listed under the chosen database in Snowflake](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-snowflake-source/create-a-snowflake-source-2024-03-27-2.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=b49d317116cb8fb10df4b537a9b1007f) **Step 6** In the list of Schemas that appears, click the Schema provided while creating the source in Zeotap CDP and go to the **Tables** tab. ![Tables tab of the selected schema in Snowflake](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-snowflake-source/create-a-snowflake-source-2024-03-27-4.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=a0f9399c5eb8516a07e06e6a9a108de7) **Step 7** In the list of tables, click the table that you provided while creating the source in Zeotap CDP and click **Load Data**. If you encounter a privileges error, see the [Snowflake documentation on table privileges](https://docs.snowflake.com/en/user-guide/security-access-control-privileges#label-table-privileges) and contact your Snowflake account administrator. ![Load Data option on a table in Snowflake](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-snowflake-source/create-a-snowflake-source-2024-03-27-7.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=b77c36b03c56655f645ca9063e2e24de) **Step 8** Use the **Load Data into Table** window that appears to load the data files in one of the following formats: `CSV/TSV, JSON, ORC, AVRO, PARQUET, or XML`. ![Load Data into Table window in Snowflake with the supported file formats](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-snowflake-source/create-a-snowflake-source-2024-03-27-8.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=a7c334b8e5b96cfb7271ea4f0b511ecd) ## Verify the source is receiving data Upon completing the load, you can verify the data flowing into your Snowflake source in Zeotap CDP under the **Preview Data** tab. At this stage, the status of the source changes from **CREATED** to **INTEGRATED**. ![Preview Data tab of a Snowflake source in Zeotap CDP showing ingested records](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-a-snowflake-source/create-a-snowflake-source-2025-01-23-19.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=7fbc64c8dff5e4f922bb55fe66d11a36) ## Troubleshooting | Symptom | What it means | What to do | | - | - | - | | The **Preview Data** tab shows "No data has been received. Ensure to implement the source correctly and check again later" | Zeotap CDP has not received any records from the table yet | Reach out to our support team at [support@zeotap.com](mailto:support@zeotap.com). | | A privileges error appears when you click **Load Data** in Snowflake | Your Snowflake user does not hold the privileges the load requires on that table | See the [Snowflake documentation on table privileges](https://docs.snowflake.com/en/user-guide/security-access-control-privileges#label-table-privileges) and contact your Snowflake account administrator. | | The warehouse is suspended (inactive) | Zeotap CDP requires the warehouse to be in **Started** (Active) status while it integrates with it | Resume the warehouse using the steps in the [Snowflake documentation](https://docs.snowflake.com/en/user-guide/warehouses-tasks#starting-or-resuming-a-warehouse). | | Snowflake reports that an IP address is not allowed to access the account | A network policy on the Snowflake account or user excludes the connecting IP address | Work through [Error Handling and More](/articles/integrate-customer/snowflake-source-error-handling-and-more). | | Only full datasets arrive when you expected incremental updates | **Delta Queries Selection** is **false**, or change tracking was never enabled on the table | Confirm the setting on the source, and complete [Enable delta fetch in Snowflake](#enable-delta-fetch-in-snowflake). Note that the sandbox environment does not support deltas. | ## Next steps * Explore [Best Practices for Snowflake Source →](/articles/integrate-customer/best-practices-for-snowflake-source) for the identifier, country and mapping rules that apply to the incoming table. * Explore [Error Handling and More →](/articles/integrate-customer/snowflake-source-error-handling-and-more) for the network-policy error, supported regions and PII handling. * Explore [FAQs for Snowflake →](/articles/integrate-customer/faqs-for-snowflake) for answers on sync behaviour. * Explore [Catalogue Mapping for Customer Data (CE) →](/articles/unify-customer/map-the-catalogue-for-customer-data) to map the ingested columns for a CE source. * Explore [Catalogue Mapping for Non-Customer Data (NCE) →](/articles/unify-customer/map-the-catalogue-for-non-customer-entity-data) to map the ingested columns for an NCE source. * Explore the [Snowflake destination →](/articles/integrate-customer/snowflake-destination) to send Zeotap CDP audiences out to Snowflake. # Create a Zeotap Google Cloud Storage Source Source: https://docs.zeotap.com/articles/integrate-customer/create-a-zeotap-google-cloud-storage-source Create a Zeotap Google Cloud Storage source to bring CSV and JSON files into Zeotap CDP, and meet the region, format, size, schema and PII requirements before you upload. ## What this is Zeotap Google Cloud Storage is a **source** — it brings batch data **into** Zeotap CDP from CSV or JSON files that you upload to a Google Cloud Storage bucket Zeotap provisions for you. To send data in the opposite direction, and deliver an audience out of Zeotap CDP into a Google Cloud Storage bucket you own, use the [Google Cloud Storage destination](/articles/integrate-customer/google-cloud-storage) instead. The source sits in the **Flat Files** category and carries both Customer Data (CE) and Non-Customer Entity (NCE) data. This page covers creating the source in Zeotap CDP, the upload methods available once it exists, and the region, format, size, schema and PII requirements your files must meet. For background on the integration itself, see [Zeotap Google Cloud Storage](/articles/integrate-customer/zeotap-google-cloud-storage). ## Prerequisites > [!NOTE] > > Before you create the source, decide the following — most of them are fixed on the source when you create it: > > * **File format** — CSV or JSON, and the field delimiter your text files use. > * **Region of upload** — EU, US or IN. See [Supported regions](#supported-regions) below. > * **Data entity** — Customer Data or Non Customer Data. See [Supported Data Entities](/articles/unify-customer/supported-data-entities). > * **PGP encryption** — whether files are encrypted before they are sent to Zeotap CDP. See [PGP encryption in sources](/articles/integrate-customer/pgp-encryption-in-sources). > * **Identifiers** — which identifier every record will carry, so incoming rows can be matched to profiles. ## Supported identifiers Every record you upload must be tied to at least one identifier — preferably both your organisation's first-party user ID (the same ID you send in the Web JS or app SDKs) and a digital identifier such as a MAID. That pairing is what lets Zeotap CDP match incoming rows to existing customer profiles. For Non-Customer Entity data, the identifier must represent the entity itself rather than a customer — for example an order ID, product ID or account ID. Customer and NCE Catalogue attributes cannot be shared across the two entity groups. See [Supported Data Entities](/articles/unify-customer/supported-data-entities) for the full picture. ## Create the Zeotap Google Cloud Storage source in Zeotap CDP **1. Open the Sources application** Navigate to the **Sources** application under **Integrate**, in the Zeotap CDP App. **2. Start a new source** Click **+ Create Source**. ![The Sources listing in the Integrate module with the + Create Source button highlighted](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-a-zeotap-google-cloud-storage-source/create-a-zeotap-google-cloud-storage-source-2025-01-15-3.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=1afaef9639656bf02be7c7000b98f4b0) **3. Choose the category** Choose **Flat Files** as the Category. ![The Flat Files category selected on the source creation screen](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-a-zeotap-google-cloud-storage-source/create-a-zeotap-google-cloud-storage-source-2025-01-15.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=7c6eb34ef06168390143a2d8159cec38) **4. Choose the data source** Under **SELECT DATA SOURCE**, click **Zeotap Google Cloud Storage**. ![The Select data source step of Create Source, with Zeotap Google Cloud Storage selected alongside SFTP(Push) and SFTP(Pull)](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-a-zeotap-google-cloud-storage-source/create-a-zeotap-google-cloud-storage-source-2025-01-15-1.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=f6176327dafc52f032adc6ff9485a7af) **5. Provide the source details** In the **SOURCE DETAILS** step that appears, provide the following: a. Enter a short and descriptive **Source Name**. b. Choose the file format under **What is your file type?**. c. Choose the field delimiter under **What is the file delimiter?**, and pick the region of upload under **Select your Region** — **Europe (EU)**. d. Under **Data Entity**, choose either **Customer Data** or **Non Customer Data**, depending on the type of data you want to ingest, and proceed with the source creation. To know more about Customer Data and Non Customer Data, refer to [Supported Data Entities](/articles/unify-customer/supported-data-entities). e. Under **PGP encrypted**, select **True** or **False**, depending on whether you want to encrypt your data before sending it to Zeotap CDP. If you select **True**, then you can download the PGP Public key from the **Implementation Details** tab after source creation. To learn more about PGP encryption, refer to [PGP encryption in sources](/articles/integrate-customer/pgp-encryption-in-sources). ![The Source Details step showing Source Name, file type, file delimiter, Select your Region, Data Entity and PGP encrypted fields](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-a-zeotap-google-cloud-storage-source/create-a-zeotap-google-cloud-storage-source-2025-01-15-2.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=fe469ce627bf71f6446203a42bdb4001) **6. Create the source** Once you have provided all the necessary inputs, click **Create Source**. The created source appears on the sources listing page as shown below. ![The new Flat Files source listed in the Sources listing with the status Created](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-a-zeotap-google-cloud-storage-source/create-a-zeotap-google-cloud-storage-source-2025-01-15-4.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=a4dfa55ff4c76e20a4ff85b6cb577887) **7. Open the Implementation Details tab** Click the created source and go to the **Implementation Details** tab. Here, you can find important information related to the source such as created date, created by, file format, region and so on, along with some critical details for uploading your files. > [!NOTE] > > **Note:** > > In case of NCE sources, note that you can only create a maximum of **five sources** in an account. This default limit applies to both archived and active NCE sources within an organisation. ## Upload your files The following file upload methods are supported once the source exists. Each one writes into the bucket path shown under **Path Details** on the source's **Implementation Details** tab. > [card] [Zeotap CDP UI](/articles/integrate-customer/implement-a-zeotap-google-cloud-storage-source) > [card] [Google Cloud Console](/articles/integrate-customer/upload-files-on-gcloud-console) > [card] [gsutil](/articles/integrate-customer/upload-files-using-gsutil) > [card] [Cyberduck](/articles/integrate-customer/upload-files-using-cyberduck) ## Upload specifications While uploading the files, ensure that the specifications mentioned below are taken care of. ### Supported regions Currently, we support the uploading of files in the following three regions: * EU – All EU countries' data can be uploaded to the bucket provisioned for you in the EU * US – All NORAM and LATAM countries' data can be uploaded to the bucket provisioned for you in the US * IN – All Indian data can be uploaded to the bucket provisioned for you in IN The full list of Country to Region mapping can be found in the [Region of Storage](/articles/integrate-customer/region-of-storage) topic. ### Supported formats Currently, you can upload files of the following formats: * Text files with field delimiters such as comma, tab or semicolon * Record delimiter like newline * Text files with JSON records When selecting CSV and JSON as the file formats, you can upload files with the following extensions: * `.csv` * `.txt` * `.txt.gz` ### Supported size When uploading files from the Sources module in Zeotap CDP, ensure that every file is less than 100 MB in size. Currently, there is no size restriction for files uploaded directly to the bucket with the GCloud Console, gsutil or Cyberduck, that are uploaded directly to the bucket using any of the methods mentioned above. ### Supported schema There is no restriction on the schema of the files that you upload. While creating the corresponding collection(s), the columns can be mapped to the standard Catalogue. For CSV files, we treat the first row as column headers. Therefore, the first row of the file must *always* be the column name with the proper casing. Ensure that all the headers are present. Also, note that except space and (\_) underscore, no other special characters are allowed. Any mismatch with the above requirement can lead to an ingestion failure. We can support files with multiple schemas if they logically belong to the same source (for example, user and event data from a campaign source) as long as the file format and delimiter remain the same. Refer to the [Zeotap Catalogue](/articles/unify-customer/zeotap-standard-fields) topic and name your fields accordingly. You can also use it to define the data type of your source data fields. ### Supported PII Zeotap CDP accepts both hashed and Raw PII (Personally Identifiable Information) into your Zeotap account. For hashed emails and cell phone numbers, adhere to these [hashing guidelines](/articles/unify-customer/hashing-guidelines). You can also use our [hashing tool](https://content.zeotap.com/tools/index.html) to convert your IDs to the right hashes before uploading them to your source. For raw personal identifiers (PII), we mask the PII information across the UI for all roles once you classify them in your organisation's Catalogue. Flagging the raw PII fields in your organisation's Catalogue is a critical step and is the responsibility of the org. The encrypted data is only available to the downstream systems for activation purpose. > [!NOTE] > > **Note:** > > We use the RSA Encryption Algorithm. ## Verify the source After you click **Create Source**, the source appears on the **Available** tab of the Sources listing with the status **Created**, its ID, and the **Flat Files** category. Once you upload files to the source, you can view the incoming data on the [Preview Data](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) tab. When data begins flowing in, the source status changes from **Created** to **Integrated** and the Preview Data tab is populated — that is the confirmation that ingestion is working end to end. ## Troubleshooting | Symptom | What it means | Where to look | Fix | | - | - | - | - | | The source status stays **Created** and the Preview Data tab is empty | No file has been ingested yet — the status only changes to **Integrated** once data arrives | The **STATUS** column on the Sources listing, and the **Preview Data** tab | Confirm your files were uploaded to the bucket path shown under **Path Details** on the **Implementation Details** tab, using one of the upload methods above | | Ingestion fails after an upload | The CSV header row does not meet the schema requirement — a missing header, wrong casing, or a special character other than space or underscore | The first row of the uploaded file | Correct the header row so every column name uses the proper casing and contains no special characters other than space and underscore, then upload the file again | | A file is too large to upload from the Zeotap CDP UI | Files uploaded from the Sources module must be less than 100 MB | The file size on your machine | Upload larger files directly to the bucket with the Google Cloud Console, gsutil or Cyberduck — there is no size restriction on those methods | | Files are not picked up from a PGP-encrypted source | The source was created with **PGP encrypted** set to **True**, so it accepts files only in the `.pgp` format, and only under the encrypted folder path | The **Implementation Details** tab, where the Public PGP Key is available for download | Encrypt the files with the Public PGP Key from **Implementation Details** and upload them in `.pgp` format | ## FAQ > [accordion] How large can a single file be? > > Files uploaded from the Sources module in Zeotap CDP must be less than 100 MB. There is currently no size restriction on files written directly into the bucket with the Google Cloud Console, gsutil or Cyberduck. > [accordion] Can one source carry files with more than one schema? > > Yes. Files with multiple schemas are supported if they logically belong to the same source — for example, user and event data from a campaign source — as long as the file format and the delimiter remain the same. > [accordion] Do I have to hash identifiers before I upload? > > No. Zeotap CDP accepts both hashed and raw PII. If you do hash emails and cell phone numbers, follow the [hashing guidelines](/articles/unify-customer/hashing-guidelines) so the values match. If you send raw PII, classify those fields in your organisation's Catalogue so they are masked across the UI. > [accordion] Where do I get the PGP public key? > > Select **True** under **PGP encrypted** while creating the source, then download the PGP Public key from the **Implementation Details** tab after the source is created. ## Next steps * [Explore implementing the source →](/articles/integrate-customer/implement-a-zeotap-google-cloud-storage-source) — find the Access Details and Path Details, and upload files straight from the Zeotap CDP UI * [Explore best practices for flat-file sources →](/articles/integrate-customer/best-practices-for-flat-file-source-2709422090) — the file conventions that keep a source ingesting cleanly * [Explore the Preview Data tab →](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) — read a sample of what arrived before you map it * [Explore mapping the Catalogue for Customer Data →](/articles/unify-customer/map-the-catalogue-for-customer-data) — map the columns of a CE file to Catalogue attributes * [Explore mapping the Catalogue for Non-Customer Entity data →](/articles/unify-customer/map-the-catalogue-for-non-customer-entity-data) — map the columns of an NCE file * [Explore adding a Non-Customer Entity category →](/articles/unify-customer/adding-a-non-customer-entity-category) — add an NCE attribute to the Catalogue * [Explore configuring the Join Key Enricher →](/articles/unify-customer/configuring-the-join-key-enricher) — join entity data to customer profiles * [Explore the Google Cloud Storage destination →](/articles/integrate-customer/google-cloud-storage) — send audiences out of Zeotap CDP into a bucket you own # Create an Adjust source Source: https://docs.zeotap.com/articles/integrate-customer/create-an-adjust-source Create a Server-to-Server source in Zeotap CDP and enable the Zeotap module in Adjust, so mobile app activity measured by Adjust flows into the CDP automatically. ## What this is Adjust is a mobile measurement partner that attributes and records what happens in your mobile app. This integration brings that activity **into Zeotap CDP** — installs, reattributions, sessions, events, reinstalls and uninstalls — so it sits alongside the rest of your customer data and can be used to build audiences, apply consent filters and activate to your downstream channels. The integration has two halves: 1. **In Zeotap CDP**, you create a Server-to-Server source. On creation, Zeotap generates a **write key** for that source, shown on its **IMPLEMENTATION DETAILS** tab. 2. **In Adjust**, you enable the Zeotap module in Campaign Lab and paste that write key in. From then on, Adjust sends a callback to Zeotap each time the activity occurs. No Adjust credentials are entered in Zeotap CDP, and no engineering work is needed in your app — authentication runs the other way round, with Adjust authenticating to Zeotap using the write key this page generates for you. > [!NOTE] > > Adjust treats Zeotap as a **partner it shares data with**, which is what makes this a **source** in Zeotap CDP. If you are used to thinking of Adjust as a destination, note that the data flows from Adjust to Zeotap, not the other way. ## Prerequisites > [!NOTE] > > Before you start, confirm the following: > > **In Zeotap CDP:** > > * **Access to the Sources application** under **Integrate**, with permission to create a source. > * **The region for this source**, decided in advance. It has to correspond to the **Region** you select in Adjust. See [Region of storage](/articles/integrate-customer/region-of-storage). > * **The data entity for this source** — **Customer Data** or **Non Customer Data**. See [Supported Data Entities](/articles/unify-customer/supported-data-entities). > > **In Adjust:** > > * **Access to Campaign Lab** in the Adjust dashboard, with permission to enable partner integrations and edit data-sharing settings. > * **The app you want to share data for**, and the platform — Android, iOS, or both. > * **The in-app events you want to map**, if you plan to share events. ## Create the Server-to-Server source in Zeotap CDP This is where the write key comes from. For the full reference on this source type, see [Create and Implement the Server-to-Server Source](/articles/integrate-customer/implementing-server-to-server-source-2665709918). **1. Open the Sources application** Log into the Zeotap CDP app, open the **Sources** application under **Integrate**, and click **+ Create Source**. **2. Choose the category and data source** Choose **Server to Server** as the Category, then click **HTTP API** as the Data Source. ![The CREATE SOURCE dialog with Server to Server selected as the Category](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/implementing-server-to-server-source-2665709918/s2s_1.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=6fadad1c43beb728868827bc87d56905) ![The CREATE SOURCE dialog with HTTP API selected as the Data Source](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/implementing-server-to-server-source-2665709918/s2s_2.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=d5caa2dc6eedc17be589d32e13670f5c) **3. Enter the source details** In the source creation window, enter: 1. A short, descriptive **name** that makes the origin obvious — for example, `Adjust - Android - Installs`. 2. The **region** of upload where the data will be stored. It has to correspond to the **Region** you select in Adjust. See [Region of storage](/articles/integrate-customer/region-of-storage) for guidance. 3. Under **Data Entity**, choose **Customer Data** or **Non Customer Data**, depending on the payload. ![The source creation window showing the source name field, the region selection and the Data Entity options](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/implementing-server-to-server-source-2665709918/s2s_3.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=95a4bc5cc7f3493269bf307f9f3eeb11) **4. Create the source** Click **CREATE SOURCE**. The new source appears on the source listing page with the **Created** status. ![The source listing page showing the newly created source with the Created status](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/implementing-server-to-server-source-2665709918/implementing-server-to-server-source-2665709918-2024-11-15.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=750ea5238db09a4f0952cded041c3399) **5. Copy the write key** Open the source and go to the **IMPLEMENTATION DETAILS** tab. Copy the **write key** — for this integration it is the only value you need, as Adjust supplies the endpoint itself. ![The IMPLEMENTATION DETAILS tab of a Server-to-Server source, showing the write key and the API URL](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/implementing-server-to-server-source-2665709918/implementing-server-to-server-source-2665709918-2024-11-15-1.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=30c2df3ddfd9b485ce004810518dc63b) Treat the write key as a secret: copy it straight into Adjust rather than pasting it into a ticket, an email or a shared document. > [!WARNING] > > Wait 30 minutes after source creation before using the write key. Requests made before the key propagates will fail authentication. ## Decide how many sources you need Each write key belongs to one source. You can point several activity types at the same source by reusing its write key, or keep them apart by creating a source per activity type. * **Installs and reattributions share one write key.** They use the same schema, and in Adjust they are controlled by a single field. * **Sessions, events, reinstalls, reattribution reinstalls and uninstalls each have their own field** in Adjust. Give a field a write key if you want that activity, and leave it blank if you do not. Repeat the steps above for each source you decide to create, and keep a note of which write key belongs to which activity. ## Configure the Zeotap module in Adjust **1. Find Zeotap in Campaign Lab** In the Adjust dashboard, open **Campaign Lab** and open the **Network selection** screen. Search for **Zeotap**, select it, and click **Next**. ![Adjust's Network selection screen with zeotap typed in the search box and the Zeotap partner card shown as the only result](https://mintcdn.com/zeotap/laU3nbmKUiJttZ2x/articles/integrate-customer/Storage/integrate-customer/create-an-adjust-source/adjust_1.png?fit=max\&auto=format\&n=laU3nbmKUiJttZ2x\&q=85\&s=5bc1e2f550f0641bb8bb93de3795b13e) **2. Choose your app** On the **App selection** screen, choose the app you want to share data for, then click **Next**. **3. Enable data sharing for each platform** The **Enable data sharing** window has a separate section for **Android** and for **iOS**. Complete each platform you want to send data for, then click **Enable**. ![Adjust's Enable data sharing window showing the Android section with the Enabled toggle, Region and Default Country Code dropdowns, the Write Key field, and the optional Sessions, Events, Reinstalls, Reattribution Reinstalls and Uninstalls write key fields](https://mintcdn.com/zeotap/laU3nbmKUiJttZ2x/articles/integrate-customer/Storage/integrate-customer/create-an-adjust-source/adjust_2.png?fit=max\&auto=format\&n=laU3nbmKUiJttZ2x\&q=85\&s=63d5deb75587486cc1e055277c5fc105) 1. Turn the **Enabled** toggle on for the platform. 2. Select your **Region** — **eu** or **us**. This has to match the region of your Zeotap source. 3. Select a **Default Country Code**. 4. Enter your **Write Key**. This is the main key, and it covers **installs and reattributions**. 5. Enter the optional write keys for any other activity you want to share, and leave blank anything you do not: **Sessions Write Key**, **Events Write Key**, **Reinstalls Write Key**, **Reattribution Reinstalls Write Key**, **Uninstalls Write Key**. ![The Region dropdown in Adjust expanded, showing the two options eu and us](https://mintcdn.com/zeotap/laU3nbmKUiJttZ2x/articles/integrate-customer/Storage/integrate-customer/create-an-adjust-source/adjust_3.png?fit=max\&auto=format\&n=laU3nbmKUiJttZ2x\&q=85\&s=a0271caf38dbd80cbce87a71b7e8b435) > [!WARNING] > > **Region is mandatory.** If no region is selected, the module is not enabled at all. > [!NOTE] > > Adjust offers only **eu** and **us**. If the region on your Zeotap source is not one of those two, check with your Zeotap account manager which Adjust region to select before you enable the module — sending to the wrong region means the data is not accepted. ![The Default Country Code dropdown in Adjust expanded, showing an alphabetical list of countries](https://mintcdn.com/zeotap/laU3nbmKUiJttZ2x/articles/integrate-customer/Storage/integrate-customer/create-an-adjust-source/adjust_4.png?fit=max\&auto=format\&n=laU3nbmKUiJttZ2x\&q=85\&s=c3de60f227816d4cdaaa7e05966cabf9) > [!NOTE] > > **Why a default country code is required.** Zeotap needs a country value on every record, and Adjust cannot always determine one — on server-to-server activities, for example, where no IP address is shared. When Adjust has no country for a record it sends this default instead, so the record is accepted rather than dropped. **4. Set your data-sharing options** Once the module is enabled, control what is shared on the **Select data sharing options** screen. For what each option covers on Adjust's side, see Adjust's [Choose data sharing options](https://help.adjust.com/en/article/data-sharing-ad-network). **Installs** and **Reattributions** are shared by default, from all attribution sources. Tick any additional activity you want — **Send ad revenue**, **Sessions**, **Uninstalls and reinstalls**, or **In-app revenue (from in-app purchases)**. ![Adjust's Select data sharing options screen for Android, showing that installs and reattributions are shared by default and the checkboxes for ad revenue, sessions, uninstalls and reinstalls, and in-app revenue](https://mintcdn.com/zeotap/laU3nbmKUiJttZ2x/articles/integrate-customer/Storage/integrate-customer/create-an-adjust-source/adjust_5.png?fit=max\&auto=format\&n=laU3nbmKUiJttZ2x\&q=85\&s=42fbe6f2e36e9848db921eab5148a4d9) > [!NOTE] > > Ticking a box here is not enough on its own. Enabling an activity tells Adjust you want it, but the callback only fires once the corresponding **write key** has been entered. To share **In-app revenue**, Adjust additionally requires that you map the events which generate revenue. **5. Map your events** Only needed if you are sharing in-app events. Go to **Map your events**, select the events you want to share, map them to the values you want Zeotap to receive, and save the mapping. Data for any event you have not mapped is not sent, even with the **Events Write Key** in place. > [!NOTE] > > **Write key format.** Adjust validates each write key as a UUID — 32 hexadecimal characters in an `8-4-4-4-12` pattern, for example `550e8400-e29b-41d4-a716-446655440000`. Paste the key exactly as Zeotap generated it, with no leading or trailing spaces. ## What Adjust sends to Zeotap Each activity arrives as five groups of fields — **event**, **page**, **user**, **consent** and **device**. None of this needs configuring: Adjust populates and sends it once the module is enabled. | Group | Fields | Notes | | :- | :- | :- | | **event** | `activity_kind`, `event`, `created_at`, `created_at_milli` | What happened and when | | **event** | `installed_at`, `reattributed_at`, `reinstalled_at`, `uninstalled_at`, `last_session_time` | Lifecycle timestamps | | **event** | `click_time`, `impression_time`, `engagement_time` | Engagement timestamps | | **event** | `conversion_duration`, `time_to_uninstall`, `time_to_reinstall` | Elapsed time measures | | **event** | `network_name`, `campaign_name`, `adgroup_name`, `creative_name`, `search_term` | Campaign attribution | | **event** | `tracker_name`, `is_organic`, `match_type` | Link and attribution quality | | **page** | `app_name`, `app_id`, `app_version_short`, `platform`, `environment`, `store`, `store_type` | App and store context | | **user** | `adid`, `idfa`, `idfv`, `gps_adid`, `android_id` | Device identifiers. At least one has to be present | | **user** | `country` | **Mandatory.** Two-letter ISO country code. Falls back to your **Default Country Code** when Adjust has no value | | **consent** | `tracking_enabled` | `1` if tracking is enabled, `0` if not | | **device** | `device_type`, `device_name`, `device_model`, `device_manufacturer` | Device hardware | | **device** | `os_name`, `os_version`, `sdk_version` | OS and SDK | | **device** | `isp`, `connection_type`, `ip_address`, `proxy_ip_address` | Connectivity and IP | | **device** | `country`, `country_subdivision`, `city`, `postal_code`, `region`, `language` | Geography and locale | ## Verify data is arriving Trigger the activity in your app — a fresh install is the simplest test, since installs are shared by default. The source's status on the Sources listing tells you how far the integration has progressed: | Status | What it means | | :- | :- | | **Created** | The source exists in Zeotap CDP but has not received any data yet. | | **Integrated** | Data has started flowing into the source, but taxonomy standardisation has not been applied yet. You can preview the incoming data on the source's **PREVIEW DATA** tab. | | **Mapped** | At least one data collection has been created on top of the integrated source, based on the common taxonomy. | For the full set of statuses and the other columns on the listing, see [Components of the Source Listing Page](/articles/integrate-customer/components-of-the-source-listing-page). Once the status reaches **Integrated**, check the data itself: * The **PREVIEW DATA** tab shows a sample of the data received. See [Components of the Preview Data Tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab). * The **SOURCE REPORT** tab gives the ingestion health and status of the source. See [Exploring Source Reports](/articles/integrate-customer/exploring-source-reports). ## Troubleshoot the integration | What you see | What it means | What to do | | :- | :- | :- | | The source stays at **Created** and no data arrives | The source exists but nothing has reached it yet | Confirm 30 minutes have passed since the source was created, and that the write key in Adjust matches the one on this source's **IMPLEMENTATION DETAILS** tab | | Records arrive for some activities but not others | A write key was left blank for that activity, so Adjust never fires the callback | Enter the write key for that activity in the Adjust module | | An activity is ticked under data-sharing options but still does not arrive | Ticking the option enables it in Adjust, but the callback needs the matching write key | Enter the corresponding write key, and for events confirm the event is mapped | | Events do not arrive although the **Events Write Key** is set | Unmapped events are not shared | Map the event under **Map your events** in Adjust | | Data appears to be going somewhere else | The **Region** in Adjust does not match the region of the Zeotap source | Correct one of the two so they agree | | No preview is available on the **PREVIEW DATA** tab | An error message is displayed stating the reason | Fix the issue reported, then try again after some time | If you need further assistance, contact Zeotap support at **[support@zeotap.com](mailto:support@zeotap.com)** with the source name and its ID from the Sources listing. For questions about the Adjust dashboard itself, contact Adjust support. ## Limitations * **Three fields are not shared by Adjust.** Adjust does not pass `att_status`, `event_token` or `tracker_token` to partners. You still receive the event name (`event`) and the tracker name (`tracker_name`), so in most cases nothing is lost. * **ATT status needs app development work.** Because Adjust does not forward ATT status alongside device identifiers, the only way to receive it is to pass it as a partner parameter from your app, which requires a change in the app on both platforms — see Adjust's documentation on global partner parameters for [iOS](https://dev.adjust.com/en/sdk/ios/features/session-parameters/#global-partner-parameters) and [Android](https://dev.adjust.com/en/sdk/android/features/session-parameters/#global-partner-parameters). If you do not need ATT status, `tracking_enabled` gives you a simpler signal — but the two are not equivalent: ATT status has four values (0 Not determined, 1 Restricted, 2 Denied, 3 Authorized) where `tracking_enabled` has two. * **A blank write key means no data, by design.** Zeotap does not accept data without a valid write key, so Adjust skips that callback rather than sending it. ## Next steps * [Explore the Server-to-Server source in full →](/articles/integrate-customer/implementing-server-to-server-source-2665709918) * [Map the ingested data to the Catalogue →](/articles/unify-customer/map-the-catalogue-for-customer-data) * [Explore what the Preview Data tab shows →](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) * [Explore the source report →](/articles/integrate-customer/exploring-source-reports) # Create an Adobe Experience Platform Tag Extension Source Source: https://docs.zeotap.com/articles/integrate-customer/create-an-adobe-experience-platform-tag-extension-source Create the Adobe Experience Platform Tag Extension source that brings web events and user identities from your Adobe Launch property into Zeotap CDP. ## What this is The Adobe Experience Platform Tag Extension source is an **inbound** integration: it brings web events and user identities from your website into Zeotap CDP through the Zeotap Collect Tag Extension deployed in Adobe Experience Platform Tags (Adobe Launch). Data flows one way — into Zeotap CDP. This source does not send anything back out to Adobe; activating audiences to a downstream platform is a destination, not a source. Creating the source is the first of two stages. On this page you create the source record in the **Sources** application and pick up the write key it generates. The second stage — installing the extension ([Installing the Zeotap Collect Extension](/articles/sdks/adobe-launch/installation)), configuring it, and setting the Rules that fire events — is covered in [Implement an Adobe Experience Platform Tag Extension Source](/articles/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source). For background on what the extension does and when to use it, see [Adobe Experience Platform Tag Extension](/articles/integrate-customer/adobe-experience-platform-tag-extension). ## Prerequisites > [!NOTE] > > Before you begin, confirm the following: > > * You have access to the **Sources** application under **Integrate** in the Zeotap CDP App, with permission to create a source. > * You know which **region** of upload your data must be stored in. See [Region of storage](/articles/integrate-customer/region-of-storage). > * The data you plan to send is **Customer Data (CE)** — this is the only data entity the Adobe Experience Platform Tag Extension source supports. See [Supported data entities](/articles/unify-customer/supported-data-entities). > * You have access to **Adobe Experience Platform Tags (Adobe Launch)** with edit permissions, and a published Adobe Launch property for your website. See [Installing the Zeotap Collect Extension](/articles/sdks/adobe-launch/installation). ## Create the Adobe Experience Platform Tag Extension source Perform these steps in the Zeotap CDP App: 1. Navigate to the **Sources** application under **Integrate**. 2. Click **CREATE SOURCE**. 3. Choose **Tag Managers** as the Category. ![Choosing Tag Managers as the Category in the source creation flow](https://mintcdn.com/zeotap/kEe8zTZlpZky9cq1/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/create_adobe_1.png?fit=max\&auto=format\&n=kEe8zTZlpZky9cq1\&q=85\&s=3e5f034f4ad91bb356cb86967efa2fb1) 4. Click **Adobe Experience Platform Tag Extension** as the Data Source. ![Selecting Adobe Experience Platform Tag Extension as the Data Source](https://mintcdn.com/zeotap/kEe8zTZlpZky9cq1/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/create_adobe_2.png?fit=max\&auto=format\&n=kEe8zTZlpZky9cq1\&q=85\&s=1a933092f568b33970fedee9888c49d1) 5. Enter a short, descriptive name for the source. 6. Under **Select your Region**, choose where your data is stored, and set **Data Entity** to **Customer Data**. ![Source creation window with the Source Name, Select your Region and Data Entity fields](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-an-adobe-experience-platform-tag-extension-source/create-an-adobe-experience-platform-tag-extension-source-2024-12-17.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=4d88bdd88c7a1ce3aa7e6ee4c1aa77bc) 7. Click **CREATE SOURCE**. The new source is created and its detail page opens on the **IMPLEMENTATION DETAILS** tab; it also appears on the **SOURCES** listing page. ![Source detail page for the new source, on the IMPLEMENTATION DETAILS tab](https://mintcdn.com/zeotap/kEe8zTZlpZky9cq1/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/create_adobe_4.png?fit=max\&auto=format\&n=kEe8zTZlpZky9cq1\&q=85\&s=b8a0d8a859915a4fa2aaaaf437b1ccc2) ## Collect the write key Open the new source from the **SOURCES** listing page and go to the **IMPLEMENTATION DETAILS** tab. The **WRITE KEY** is shown there with a copy button. When you create an Adobe Experience Platform Tag Extension source in your Sources account, a **Write Key** is auto-generated by the system. It is a mandatory field for recording events. Provide this key when you configure the Zeotap Collect Extension in Adobe Experience Platform — it is entered in the extension's **Write Key** field during configuration. See [Configuring the Zeotap Collect Extension](/articles/sdks/adobe-launch/configure) for where the field sits in the Adobe Launch configuration screen. ## Verify the source You have created the source correctly when all of the following hold: * The source appears on the **SOURCES** listing page with the status **Created**. **Created** means the source exists in Sources but has not received any data yet — expected until the extension is live on your site. See [Components of the Source Listing page](/articles/integrate-customer/components-of-the-source-listing-page) for the full list of statuses. * A write key has been generated for the source, and you have entered it in the Zeotap Collect Extension configuration in Adobe Launch. * After the source is taken live through the implementation steps and events begin arriving, the status changes to **Integrated** and the **PREVIEW DATA** tab is populated. Use the [Preview Data tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) to see the incoming data. ## Troubleshoot source creation | Condition | What it means | Where to look | | - | - | - | | The source stays in **Created** status | No events have reached the source yet — the extension is not live on your site, or its Rules are not firing | Complete the [implementation steps](/articles/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source), then re-check the status on the source listing page | | The **PREVIEW DATA** tab is empty | The source has not moved past **Created**, so there is no ingested sample to show | The source status on the **SOURCES** listing page | | Event POST calls do not return 204 or 200 | The extension is firing, but the events are being rejected | Verify that the write key configured in the extension matches the one generated for this source — see the checklist on the [implementation page](/articles/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source) | ## FAQ > [accordion] Does this source send data out of Zeotap CDP to Adobe? > > No. This is a source, so data flows only into Zeotap CDP — the Zeotap Collect Extension in your Adobe Launch property captures web events and identities and sends them in. Sending audiences out to another platform is handled by a destination, not by this source. > [accordion] Which data entity does this source support? > > Customer Data (CE) only. The Adobe Experience Platform Tag Extension source is listed under the **Tag Managers** category and supports Customer Data (CE) — see [Source Integrations (Batch+Real-Time)](/articles/integrate-customer/creating-a-source). > [accordion] How is this different from the Google Tag Manager source? > > Both sit under the [Tag Managers (CE)](/articles/integrate-customer/tag-managers) category and both bring web events into Zeotap CDP, but they are separate sources with separate creation flows. This one is deployed as the Zeotap Collect Tag Extension in Adobe Experience Platform Tags (Adobe Launch); the [Google Tag Manager](/articles/integrate-customer/google-tag-manager) source is deployed as the Zeotap Collect Tag custom template on Google Tag Manager. ## Next steps * [Implement the Adobe Experience Platform Tag Extension source →](/articles/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source) * [Install the Zeotap Collect Extension in Adobe Launch →](/articles/sdks/adobe-launch/installation) * [Configure the Zeotap Collect Extension →](/articles/sdks/adobe-launch/configure) * [Read the ingested sample on the Preview Data tab →](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) * [Map the Catalogue for Customer Data (CE) →](/articles/unify-customer/map-the-catalogue-for-customer-data) # Create an Airship (Batch) source Source: https://docs.zeotap.com/articles/integrate-customer/create-an-airship-batch-source Set up the Airship (Batch) source to bring Named Users, their Airship channel identifiers and their attributes from Airship into Zeotap CDP. ## What this is The Airship (Batch) source brings data **into Zeotap CDP from Airship**: it ingests Named Users together with their Airship channel identifiers and the attributes held against them. It is a batch source, so it is created and managed under **Integrate > Sources** rather than from a journey. Airship generates its own channel identifiers for the Android and iOS devices registered against a Named User, and those identifiers are specific to Airship. Ingesting them through this source is what lets you build audiences on an Airship channel identifier, and activate against one, rather than on a Named User alone. The attributes that arrive alongside the identifiers can be mapped in the catalogue and used for segmentation and personalised activation. For an overview of the connector, see [Airship (Batch) source](/articles/integrate-customer/airship-batch-source). Data flowing the other way — out of Zeotap CDP to Airship — is covered by the Airship destinations: * [Airship Static Lists](/articles/integrate-customer/airship) — send Named Users to an Airship list from an audience. * [Airship Real Time Integration](/articles/integrate-customer/airship-real-time-destination-integration) — send events to Airship from a journey. If you want to stream data in from Airship as it happens instead of in batch, see [Create an Airship Real-Time Data Streaming source](/articles/integrate-customer/create-an-airship-real-time-data-streaming-source). ## Supported identifiers This source is listed under the **Customer Engagement Channels** category and supports the following identifiers: | Identifier | Description | | :- | :- | | Named User | The Airship identifier that maps your own customer-chosen IDs to one or more registered devices. | | Airship Channel ID | The device-level identifier Airship generates for a registered device, such as an Android or iOS channel. | Delta fetch is not supported for this source. ## Prerequisites Ensure that you take care of the following prerequisites before creating an Airship (Batch) source: * **Bearer Token (Access Token)** — a bearer token in Airship is a unique string of characters that authenticates a user or application to access a resource. It grants limited access to a user or application for a specific period, allowing them to perform actions on behalf of the user who generated the token. See [Create a bearer token in Airship](#create-a-bearer-token-in-airship) below. * **Named Users** — a Named User is a proprietary identifier that maps customer-chosen IDs. In other words, a Named User is an individual consumer who can have more than one mobile device registered with your app. For example, Named User `john_doe_123` can have a personal Android phone and an iPad, on both of which he has opted in for push notifications. If you want to reach John on both devices, associate the Channel (device) identifiers for each device to the Named User `john_doe_123`, and push to the Named User. This sends out notifications to both associated devices. Optionally, you can also [match the Airship channel ID to a Zeotap attribute](#match-the-airship-channel-id-to-a-zeotap-attribute) to enhance customer profiles in Zeotap CDP. ## Create a bearer token in Airship Perform the following steps in Airship to create the bearer token: **Step 1** Log into the Airship console and navigate to **Settings**. **Step 2** Under **Settings**, select **Project Configuration** and click **Manage** for Tokens. **Step 3** Click **Create Token**. ![The Tokens page in the Airship console, listing existing tokens by name, role and creation date, with the Create Token button highlighted.](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-an-airship-batch-source/create-an-airship-batch-source-2024-01-08.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=c673704ece0ce55c9c6989af42d9b944) **Step 4** In **Name**, enter a token name. This is just a friendly name to help you recognise your tokens in Airship. **Step 5** Select the **Role** you want to grant for this token. For additional information, see [Airship API Security](https://docs.airship.com/guides/messaging/user-guide/admin/security/api-security/). * **Audience Modification:** Grants read and write permission to audience APIs, including channels, named users, segments, lists and so on. Use this permission for users sending custom events into Airship. * **All Access:** Grants full access to your Airship project, except Acoustic integrations. You must use this permission when creating a token for an inbound message handling web-hook. **Step 6** Click **Create token**. ![The Airship Create Token dialogue, with a Name field for the token identifier and a Role drop-down.](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-an-airship-batch-source/create-an-airship-batch-source-2024-01-08-1.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=6a97b8afe8f8bfddef005c9fd9a6c93a) **Step 7** Copy the **Access Token** value, then click **Got it** to close the window. ![The Airship token confirmation dialogue, showing the App Key and Access Token fields, a notice to keep both confidential, and a Got it button.](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-an-airship-batch-source/create-an-airship-batch-source-2024-01-08-2.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=25e3c3560a1be08963b1f2606f01eaec) > [!WARNING] > > Airship asks you to save and protect the App Key and Access Token as confidential data, to prevent unauthorised access and use. ## Match the Airship channel ID to a Zeotap attribute In addition to the Named Users, you can also match the Airship channel ID with a Zeotap attribute to enhance customer profiles in the Zeotap system. The following get method can be used to retrieve the Airship channel ID through our SDK from the Airship SDK: ```javascript Code theme={null} UA.then(sdk => { sdk.getChannel().then(channel => { zeotap.setUserIdentities("Airship_Channel_id" : channel.id) }) }) ``` > [!NOTE] > > **Note:** > > For more information about how to fetch the custom identities through Zeotap's SDKs, refer [here](/articles/sdks/web-js/api-reference/set-user-identities#custom-identities). ## Create the Airship (Batch) source Once you have all the necessary information mentioned above, perform the following steps to create an Airship (Batch) source: **Step 1** Navigate to the **Sources** application under **Integrate**, in the Zeotap CDP App. **Step 2** Click **Create Source**. **Step 3** Choose **Customer Engagement Channels** as the Category. ![The Create Source dialogue in Zeotap CDP, showing the data source categories with Customer Engagement Channels highlighted.](https://mintcdn.com/zeotap/kEe8zTZlpZky9cq1/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/cec.png?fit=max\&auto=format\&n=kEe8zTZlpZky9cq1\&q=85\&s=41028ad62acb6759bd67c8d9a3e6a4bb) **Step 4** Click **Airship** as the Data Source. ![The data source list in the Create Source dialogue, with Airship highlighted above Airship Real Time Data Streaming.](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-an-airship-batch-source/create-an-airship-batch-source-2024-01-11.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=fcd294071dc5872d5035b1c3f1f0e369) **Step 5** In **Source Name**, enter a short and descriptive name for the source. **Step 6** Enter the **Bearer Token** you created in [Create a bearer token in Airship](#create-a-bearer-token-in-airship). **Step 7** Under **Standard object**, select the Airship object you want to ingest — for example, **Named Users**. **Step 8** Under **Data Entity**, depending on the type of data that you want to ingest, choose either **Customer Data** or **Non Customer Data** and proceed with the source creation. To know more about Customer Data and Non Customer Data, refer [here](/articles/unify-customer/supported-data-entities). **Step 9** Under **Select your Region**, select the Region of upload. **Step 10** Under **Sync frequency**, choose how often Zeotap CDP pulls data from Airship. **Step 11** Click **Create Source**. ![The Source Details step of the Create Source dialogue, showing the Source Name, Bearer Token, Standard object, Data Entity and Select your Region fields above the Create Source button.](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-an-airship-batch-source/create-an-airship-batch-source-2024-01-08-3.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=23c19afe4f52d198f1f7c8f4501b7b6e) **Step 12** Upon successfully creating the source, it appears on the **SOURCES** listing page. You can open the created source and find essential details about the created source such as Bearer token, Created by, Created on information and more under the **IMPLEMENTATION DETAILS** tab. ## Verify the source is ingesting data Once the connection between Zeotap and Airship is successfully established, you can view the data flowing into the system under the **[PREVIEW DATA](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab)** tab. The preview shows a sample from the last five files that were ingested, and the status of the source changes to *Integrated* once data starts flowing in. If no preview is available, an error message is displayed stating the reason. See [Components of the Preview Data tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) for the options on that screen, including the error log. ## Next steps * Map the ingested identifiers and attributes so they can be used for segmentation — see [Map the Catalogue](/articles/unify-customer/map-the-catalogue). * Activate back to Airship through [Airship Static Lists](/articles/integrate-customer/airship) or [Airship Real Time Integration](/articles/integrate-customer/airship-real-time-destination-integration). * Compare this connector with the other inbound options in [Source Integrations (Batch+Real-Time)](/articles/integrate-customer/creating-a-source). # Create an Airship Real-Time Data Streaming Source Source: https://docs.zeotap.com/articles/integrate-customer/create-an-airship-real-time-data-streaming-source Create the source that streams events from your Airship project into Zeotap CDP, and collect the API URL and write key needed to connect Airship to it. ## What this is Airship Real-Time Data Streaming is a **source**: data flows **into Zeotap CDP from Airship**. As events occur in your Airship project, Airship streams them to Zeotap over a webhook connection, so the interactions your customers have with your Airship-powered messaging become available for unification, segmentation and activation alongside the rest of your customer data. Airship is a customer engagement platform that helps marketers deliver personalised and relevant experiences to their customers across multiple channels and touchpoints. Creating the source is the first of two steps. This page covers the Zeotap CDP side — creating the source and collecting the credentials Airship needs. The Airship side, where you point Airship's Real-Time Data Streaming webhook at Zeotap, is covered in [Implement an Airship Real-Time Data Streaming Source](/articles/integrate-customer/implement-an-airship-real-time-data-streaming-source). > [!NOTE] > > **Choosing between the two Airship sources.** Use this source to ingest **events** as they happen. > To bulk-ingest Named Users and their attributes instead, use the > [Airship (Batch) source](/articles/integrate-customer/airship-batch-source). The two are separate > tiles in the Zeotap CDP App and are created separately. Sending data the other way — from Zeotap CDP out to Airship — is a destination, not a source. See [Airship Real Time Integration](/articles/integrate-customer/airship-real-time-destination-integration) for the real-time destination, or [Airship Static Lists](/articles/integrate-customer/airship) for the list-based destination. ## Supported identifiers In addition to the Named Users, you can also match the Airship channel ID with the Zeotap attribute to enhance customer profiles in the Zeotap system. The following get method can be used to retrieve the Airship channel ID through our SDK from the Airship SDK: ```javascript Code theme={null} UA.then(sdk => { sdk.getChannel().then(channel => { zeotap.setUserIdentities("Airship_Channel_id" : channel.id) }) }) ``` > [!NOTE] > > **Note:** > > For more information about how to fetch the custom identities through Zeotap's SDKs, refer > [here](/articles/sdks/web-js/api-reference/set-user-identities#custom-identities). ## Prerequisites Before you create the source, make sure you have: * **An Airship project with Real-Time Data Streaming available.** You configure the webhook on the Airship side after the source exists, so you need access to that project's settings. See [Implement an Airship Real-Time Data Streaming Source](/articles/integrate-customer/implement-an-airship-real-time-data-streaming-source). * **Your Airship region.** This is the region for which your account subscription is registered. Confirm it with your Airship account manager. * **A decision on the data entity.** You choose **Customer Data** or **Non Customer Data** while creating the source. To know more about Customer Data and Non Customer Data, refer [here](/articles/unify-customer/supported-data-entities). ## Create the Airship Real-Time Data Streaming source Perform the following steps to create an Airship Real-Time Data Streaming source: **Step 1** Log into the Zeotap CDP App and navigate to the **Sources** application under **Integrate.** **Step 2** Click **Create Source**. **Step 3** Choose **Customer Engagement Channels** as the Category. ![The Create Source dialog on the Data Source step, listing source categories including App Events, Flat Files, Server to Server, Tag Managers, CRM Data, Data Warehouse and Customer Engagement Channels, with Customer Engagement Channels selected.](https://mintcdn.com/zeotap/kEe8zTZlpZky9cq1/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/cec.png?fit=max\&auto=format\&n=kEe8zTZlpZky9cq1\&q=85\&s=41028ad62acb6759bd67c8d9a3e6a4bb) **Step 4** Click **Airship Real Time Data Streaming** as the Data Source. The same list also contains a separate **Airship** tile, which creates the batch source. Make sure you select the Real Time Data Streaming tile. ![The Select Data Source list inside the Create Source dialog, showing Braze currents (Beta), Dot Digital, Hubspot, Airship and Airship Real Time Data Streaming, with Airship Real Time Data Streaming selected.](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-an-airship-real-time-source/create-an-airship-real-time-source-2024-01-11.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=bcab3529104aa529616f1c2742685d78) **Step 5** Under **Source Name**, enter a short and descriptive name for the source. **Step 6** Select your region under **Select your Region**. **Step 7** Under **Data Entity**, depending on the type of data that you want to ingest, choose either **Customer Data** or **Non Customer Data** and proceed with the source creation. To know more about Customer Data and Non Customer Data, refer [here](/articles/unify-customer/supported-data-entities). ![The Source Details step of the Create Source dialog, with the Source Name field, the Select your Region option, the Data Entity choice between Customer Data and Non Customer Data, and the Create Source button.](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-an-airship-real-time-source/create-an-airship-real-time-source-2024-01-10.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=dffbb4b5168aa566c5b1e2f541036656) **Step 8** Click **Create Source**. Upon successful creation, an **API URL** and a write_key is generated and is available under the **IMPLEMENTATION DETAILS** tab as shown in the image below. The API URL and write key are essential for the implementation of this integration — copy both before you move on. ![The IMPLEMENTATION DETAILS tab of a created Airship Real Time Data Streaming source, showing Created By, Created Date, Region and Data Entity, an API URL field and a WRITE KEY field each with a copy button, alongside the PREVIEW DATA, CATALOGUE MAPPING and SOURCE REPORT tabs.](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-an-airship-real-time-data-streaming-source/create-an-airship-real-time-data-streaming-source-2024-01-17.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=78b8a396efc352b366473214a3d69696) ## Verify the source is receiving data Once the streaming connection between Airship and Zeotap is established, you can view the data flowing into the system under the **[PREVIEW DATA](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab)** tab. The preview shows a sample from the last five files that were ingested, and once data starts flowing the status of the source changes to **Integrated**. ## Troubleshoot the Airship Real-Time Data Streaming source **No preview data appears.** If no preview is available, an error message is displayed on the **PREVIEW DATA** tab stating the reason. Confirm the webhook on the Airship side is activated and points at the API URL from the **IMPLEMENTATION DETAILS** tab, then try again after some time. See [Components of the Preview Data Tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) for the error list and how to reach support. **Some columns never arrive.** A set of columns is blacklisted for ingestion because the system derives those values automatically from the user's IP address. For the complete list, see [Blacklisted Fields for Data Ingestion](/articles/integrate-customer/blacklisted-fields-for-data-ingestion). ## Next steps * [Implement an Airship Real-Time Data Streaming Source](/articles/integrate-customer/implement-an-airship-real-time-data-streaming-source) — configure the webhook in Airship using the API URL and write key you just copied. * [Map the Catalogue](/articles/unify-customer/map-the-catalogue) — map the incoming event fields so they can be used in audiences and journeys. * [Airship Real-Time Data Streaming Source](/articles/integrate-customer/airship-real-time-data-streaming-source) — overview of this source. * [Source Integrations (Batch+Real-Time)](/articles/integrate-customer/creating-a-source) — the full list of sources Zeotap CDP supports. # Create an Insider source Source: https://docs.zeotap.com/articles/integrate-customer/create-an-insider-source Create the Zeotap CDP source that receives event data from Insider, and collect the API URL and write key needed to finish the webhook setup on the Insider side. ## What this is An Insider Webhook source brings event data **into Zeotap CDP** from your Insider account — page views, user events, email and messaging events, and the attributes you attach to them. This page covers the Zeotap CDP half of the integration: creating the source, and collecting the two values the webhook needs. The webhook itself is configured inside Insider afterwards, in [Implement an Insider source](/articles/integrate-customer/implement-an-insider-source). Create the source first — the API URL and write key it generates are what you paste into Insider. To send data the other way, **out of Zeotap CDP** to Insider for activation and targeting, use the [Insider destination](/articles/integrate-customer/insider) instead. ## Prerequisites * Access to the **Sources** application under **Integrate** in the Zeotap CDP App. * An Insider account with access to **Integrations** > **External Integrations**, where the webhook is configured in the next step of the integration. ## Create the Insider source **Step 1** Log into the Zeotap CDP App and navigate to the **Sources** application under **Integrate**. **Step 2** Click **CREATE SOURCE**. **Step 3** Choose **Customer Engagement Channels** as the category. ![CREATE SOURCE dialog listing source categories, with Customer Engagement Channels selected at the bottom of the list.](https://mintcdn.com/zeotap/kEe8zTZlpZky9cq1/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/cec.png?fit=max\&auto=format\&n=kEe8zTZlpZky9cq1\&q=85\&s=41028ad62acb6759bd67c8d9a3e6a4bb) Step 1 of the CREATE SOURCE dialog — choosing a source category. **Step 4** Click **Insider Webhook** as the data source. ![CREATE SOURCE dialog showing customer engagement channel data sources, with the Insider Webhook option selected.](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-insider-source/create-an-insider-source-2025-04-01.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=177d85fa6dd8e227cca10ab7c6960592) The Customer Engagement Channels list, with Insider Webhook selected. **Step 5** Enter a **Source Name**. **Step 6** Select your **Region** — **Europe (EU)** or **United Kingdom (UK)**. **Step 7** Select the **Data Entity**. Customer Engagement Channel sources carry **Customer Data**. ![Source Details step of the CREATE SOURCE dialog, with the Source Name field, the Region options Europe (EU) and United Kingdom (UK), and the Data Entity options Customer Data and Non Customer Data.](https://mintcdn.com/zeotap/kEe8zTZlpZky9cq1/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/create_braze_currents_2.png?fit=max\&auto=format\&n=kEe8zTZlpZky9cq1\&q=85\&s=ea6b230b79ea2f6f3b68600a4738d90e) Step 2 of the CREATE SOURCE dialog — source name, region and data entity. **Step 8** Click **CREATE SOURCE**. On successful creation, an **API URL** and a **write key** are generated for the source and appear under **Access Details** on the **IMPLEMENTATION DETAILS** tab. Use the copy icon beside each field to copy them. Both values are needed to complete the integration in Insider: the API URL is the endpoint the webhook posts to, and the write key is what lets Insider ingest data into this source securely. Store the write key as you would any other credential. ![Source detail page for an Insider Webhook source with status Created, showing the IMPLEMENTATION DETAILS, PREVIEW DATA, CATALOGUE MAPPING and SOURCE REPORT tabs and the Access Details panel containing the API URL and write key fields with their copy buttons.](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-insider-source/create-an-insider-source-2025-04-01-1.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=efd6ef7f9c5f5055824b38c8b3f5445d) The source detail page of a newly created source, on its IMPLEMENTATION DETAILS tab. ## Verify the source was created The new source opens on its **IMPLEMENTATION DETAILS** tab, alongside the **PREVIEW DATA**, **CATALOGUE MAPPING** and **SOURCE REPORT** tabs, and carries the status **Created**. Status tells you how far the source has progressed: * **Created** — the source exists, but has not received any data yet. An Insider source stays at **Created** until you finish configuring the webhook in Insider and it sends its first event. * **Integrated** — data has started flowing in, but taxonomy standardisation has not been applied yet. You can inspect the incoming data on the source's **PREVIEW DATA** tab. * **Mapped** — at least one data collection has been created on top of the integrated source, based on the common taxonomy. For the full set of statuses and the other columns on the source listing, see [Components of the source listing page](/articles/integrate-customer/components-of-the-source-listing-page). ## Troubleshoot the source **The source never leaves the Created status.** Nothing has reached it yet. Check the webhook in Insider: the endpoint must be the API URL from the **IMPLEMENTATION DETAILS** tab, the `Authorization` header must carry the write key from the same tab, and the integration must be launched as **Active** rather than left as **Draft** or **Paused**. Insider's **Test Webhook** button reports the response status for a test request. The steps are in [Implement an Insider source](/articles/integrate-customer/implement-an-insider-source). **An alert icon appears beside the source in the listing.** An erroneous record was ingested in the last 90 days. The icon remains until the errors are fixed. **Data stops arriving after the source is paused.** Pausing data collection invalidates the write key on the source, which stops collection. Resume data collection from the three-dot **ACTIONS** menu against the source on the source listing. To be notified by email when a source fails, configure [Source alerts](/articles/integrate-customer/source-alerts). ## Next steps * [Implement an Insider source](/articles/integrate-customer/implement-an-insider-source) — configure the webhook inside Insider using the API URL and write key from this source, choose the events and attributes to send, and launch the integration. * [Insider Webhook](/articles/integrate-customer/insider-webhook) — overview of the Insider source integration. * [Insider](/articles/integrate-customer/insider) — the opposite direction: send audiences and events from Zeotap CDP to Insider. # Create an iOS SDK source Source: https://docs.zeotap.com/articles/integrate-customer/create-an-ios-sdk-source Create the iOS Native SDK source that brings app data into Zeotap CDP and issues the write key your iOS app authenticates with. ## What this is An iOS SDK source brings data **into** Zeotap CDP: your iOS app sends events, page visit information and user identities to Zeotap through the Zeotap Collect iOS SDK. It is an [App Events](/articles/integrate-customer/app-events) source carrying Customer Data (CE), alongside its counterpart the [Android SDK source](/articles/integrate-customer/creating-android-sdk-source). Creating the source is what issues the **write key** your app authenticates with, so do this before any app-side work. For background on the connector itself, see the [iOS SDK source overview](/articles/integrate-customer/ios-sdk). > [card] [Implementing the iOS SDK?](/articles/sdks/ios/intro) > > This page covers creating the source in the Zeotap CDP. For SDK installation, init options, and tracking methods, head to the **iOS SDK** docs. ## Supported identifiers Identifiers reach this source through the SDK's identity call rather than through source configuration — there is nothing to map while creating the source. You can send standardised PII such as email or phone number, either raw or pre-hashed, as well as your own first-party identifiers such as a CRM or loyalty ID. For the identifier keys and the hashing strategy that governs them, see [Track User Identities](/articles/sdks/ios/api-reference/set-user-identities). ## Prerequisites * An iOS app to integrate the SDK into. * Access to Zeotap CDP, and to the **Sources** application under **Integrate**. * The SDK's own build requirements — supported iOS, Xcode and Swift versions — are listed under [Prerequisites in the iOS SDK docs](/articles/sdks/ios/intro). Check them before you start app-side work. ## Create the iOS SDK source **1. Open Sources** Navigate to the **Sources** application under **Integrate**, in the Zeotap CDP App. **2. Start a new source** Click **Create Source** on the source listing page. **3. Choose the category** Under **SELECT CATEGORY**, choose **App Events**. ![The Create Source dialog on the Data Source step, with App Events selected in the Select Category list.](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-ios-sdk-source/create_iOS_1.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=add5fdae27e4b2df5f5067f6d5cd7159) **4. Choose the data source** Under **SELECT DATA SOURCE**, choose **iOS Native SDK**. ![The Select Data Source list showing App Pixel API, Android Native SDK and iOS Native SDK, with iOS Native SDK selected.](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-ios-sdk-source/create_iOS_2.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=b214433bd0296f6a46464f91226894c0) **5. Name the source** On the **Source Details** step, enter a short and descriptive **Source Name**. **6. Select the region** Under **Select your Region**, select the region your data is uploaded to. The dialog links to the reference that maps a country to a region. ![The Source Details step with a source name entered and a region selected under Select your Region.](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-ios-sdk-source/create_iOS_3.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=2b668f005eb14c98b40df2e26d0524d9) **7. Create the source** Click **CREATE SOURCE**. **8. Collect the write key and the SDK** The new source opens on its **IMPLEMENTATION DETAILS** tab, which displays the **WRITE KEY** and a link to download the SDK. Copy the write key — this is the value the SDK initialises with — then click the link to download the SDK as a zip and unzip the file. ![The new source's Implementation Details tab, showing the Write Key field with a copy control and the SDK download link.](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-ios-sdk-source/create_iOS_4.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=f10e531f3a5ae53e7b79175561931621) You can return to the **IMPLEMENTATION DETAILS** tab at any time to read the write key again — see [Write Key](/articles/sdks/ios/configurations/write-key). ## Verify the source is receiving data **1. Check the source status** A newly created source sits at the **Created** status, meaning it exists but has not received any data yet. Once data starts flowing in, the status changes to **Integrated**. The full list of statuses is described in [Components of the Source Listing Page](/articles/integrate-customer/components-of-the-source-listing-page). **2. Preview the incoming data** Open the **PREVIEW DATA** tab on the source to examine a sample of the data that has reached the system. If no preview is available, an error message explains why. See [Components of the Preview Data Tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab). **3. Check ingestion health** The **SOURCE REPORT** tab reports the ingestion health and status of the source over time. See [Source Report](/articles/integrate-customer/source-report). ## Troubleshoot the iOS SDK source **Your first events are not accepted straight after creating the source.** Confirm the app is initialising with the write key from this source, and not one copied from a different source or a different account. **The source stays at Created and never moves to Integrated.** That status means no data has reached the source yet, so the problem is on the app side rather than in the source configuration. Re-check the SDK installation and initialisation against the [iOS SDK quick start](/articles/sdks/ios/quick-start). **Data collection stopped after a change in the CDP.** If pause data collection was used on this source — from the three-dot menu in the **ACTIONS** column of the source listing page — that invalidates the source's write key and stops collection until it is resumed. The precautions that go with this action are described in [Components of the Source Listing Page](/articles/integrate-customer/components-of-the-source-listing-page). If the source is configured correctly and data still does not arrive, contact support at [support@zeotap.com](mailto:support@zeotap.com) with the source name and the time window you tested. ## Next steps > [card] [Implement the iOS SDK](/articles/sdks/ios/quick-start) > > Install the SDK, initialise it with your write key, and start tracking events. > [card] [Map the catalogue](/articles/unify-customer/map-the-catalogue-for-customer-data) > > Apply the common taxonomy to the incoming data so it can be used for audiences. > [card] [Using React Native?](/articles/sdks/react-native/quick-start) > > The React Native package takes this source's write key as its iOS write key. > [card] [Create the Android source](/articles/integrate-customer/creating-android-sdk-source) > > Set up the matching App Events source for your Android app. # Create an SFTP (Pull) Source Source: https://docs.zeotap.com/articles/integrate-customer/create-an-sftp-pull-source Create an SFTP (Pull) source so Zeotap CDP connects to the SFTP server you host and pulls your data files into the platform. ## What this is The SFTP (Pull) source brings data **into** Zeotap CDP from an SFTP folder that you host. You give Zeotap CDP the connection details and folder path of your own SFTP server, and Zeotap CDP connects on the sync frequency you choose, authenticates using either a User ID and password or SSH keys (public and private key), and pulls the files it finds. This page covers creating the source in the Zeotap CDP App; uploading the public key to your server and opening access to Zeotap CDP is covered in [Implement the SFTP Pull Source](/articles/integrate-customer/implement-the-sftp-pull-source). ## Prerequisites > [!NOTE] > > Before you create the source, confirm the following: > > * You have access to the **Sources** application in the Zeotap CDP App, with permission to create a source. > * You host an SFTP server that Zeotap CDP can reach, and you know its **User Id**, **Host** and **Port**. > * You know the absolute folder path on that server that Zeotap CDP should read from. > * You can authorise Zeotap CDP's access with either a User ID and password or SSH keys (public and private key). > * Your files are in CSV or JSON format and carry at least one identifier. See [SFTP (Secure File Transfer Protocol)](/articles/integrate-customer/sftp-secure-file-transfer-protocol). > * You know which **Data Entity** applies — Customer Data or Non Customer Data. See [Supported data entities](/articles/unify-customer/supported-data-entities). > * If your SFTP server restricts inbound connections by IP, you are able to allowlist Zeotap's IP address. The address to allowlist is published in [Implement the SFTP Pull Source](/articles/integrate-customer/implement-the-sftp-pull-source). ## SFTP (Pull) or SFTP (Push)? The two SFTP sources differ in who hosts the SFTP folder, and that decides who moves the files and what each side has to configure. Create the SFTP (Pull) source when the folder belongs to you. | | **SFTP (Pull)** — this page | **SFTP (Push)** | | :- | - | - | | Who hosts the SFTP folder | You, on your own server | Zeotap CDP | | Who moves the files | Zeotap CDP connects and pulls them on the sync frequency you set | You push them to the Zeotap CDP folder | | What you configure | **User Id**, **Host**, **Port**, the folder path, and either a password or SSH keys | At creation, the file format, delimiter, region of upload and whether files are PGP-encrypted; at implementation, the upload itself, using the User ID, Server IP and private key from the source's **Implementation Details** tab | | Where to set it up | This page, then [Implement the SFTP Pull Source](/articles/integrate-customer/implement-the-sftp-pull-source) | [Create an SFTP (Push) Source](/articles/integrate-customer/creating-sftp-push-source), then [Implement the SFTP (Push) Source](/articles/integrate-customer/implementing-sftp-push-source) | ## Create the SFTP (Pull) source Perform these steps in the Zeotap CDP App. ### 1. Open the source creation flow Navigate to the **Sources** application under **Integrate**, then click **Create Source**. ### 2. Choose Flat Files as the category Choose **Flat Files** as the Category. ![Choosing Flat Files as the Category in the source creation flow](https://mintcdn.com/zeotap/1FGgO964H8EKim6t/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/create_sftp_1.png?fit=max\&auto=format\&n=1FGgO964H8EKim6t\&q=85\&s=d007fc111e64f8c7de344b5c07b00da5) ### 3. Choose SFTP(Pull) as the data source Click **SFTP(Pull)** as the Data Source. A source creation window opens. ![Selecting SFTP(Pull) as the Data Source under the Flat Files category](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-sftp-pull-source/create-an-sftp-pull-source-2023-11-20.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=0d74fe29bb7cf851895244ca3dc3fc21) ### 4. Name the source and choose the file format Enter a short and descriptive name for the source, then choose the file format in which you store your data under **What is your file type?**. ### 5. Enter the SFTP connection details Enter the **User Id**, **Host** and **Port** details of your SFTP source: * **User Id** is a credential that Zeotap CDP can use to authenticate and authorise access to your SFTP server. * **Host** represents the server or the computer where the SFTP service is running. It is typically an IP address or a domain name. * **Port** is a specific communication endpoint on the host that the SFTP service uses. ### 6. Set the folder path Under **Folder**, enter the file path of the SFTP storage location that Zeotap CDP pulls your data from. > [!WARNING] > > Enter an absolute path such as `/home/user/data/`. The form accepts a relative path such as `../data/`, but Zeotap CDP cannot resolve it and no files are picked up. ### 7. Set the sync frequency and delta behaviour Choose the **Sync Frequency** for pulling data from the drop-down menu, then set **Delta Query Selection** to **true** or **false** based on your requirement: * **false** — Zeotap CDP pulls all files in the configured folder during each run. * **true** — Zeotap CDP pulls only the files created after the previous pull. ### 8. Choose the data entity Under **Data Entity**, choose either **Customer Data** or **Non Customer Data**, depending on the type of data that you want to ingest. To know more about Customer Data and Non Customer Data, refer to [Supported data entities](/articles/unify-customer/supported-data-entities). > [!NOTE] > > You can create a maximum of five Non-Customer Entity (NCE) sources in an account. This default limit applies to both archived and active NCE sources within an organisation. ![The SFTP (Pull) source creation window with its configuration fields](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-sftp-pull-source/create-an-sftp-pull-source-2023-11-20-1.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=28c3be6475dbdd3718b3628809cb1583) ### 9. Create the source Click **CREATE SOURCE**. The new source appears on the source listing page. ## Complete the implementation Creating the source does not finish the integration — Zeotap CDP cannot reach your server until you open access to it: 1. Raise a ticket with Zeotap's Support Team to complete the source creation process. 2. Download the public key from the source's **IMPLEMENTATION DETAILS** tab and upload it to your SFTP server, and allowlist Zeotap's IP address if your server restricts inbound connections. Both steps are covered in [Implement the SFTP Pull Source](/articles/integrate-customer/implement-the-sftp-pull-source). ## Verify the source Track the source's **STATUS** on the source listing page: * **Created** — the source exists in Sources but has not yet received any data. A newly created SFTP (Pull) source sits here until the implementation is complete and the first pull runs. * **Integrated** — data has started flowing into the source. At this point you can preview the incoming records on the source's **PREVIEW DATA** tab. * **Mapped** — at least one data collection has been created on top of the integrated source. For the full list of statuses and listing-page columns, see [Components of the Source Listing Page](/articles/integrate-customer/components-of-the-source-listing-page). ## Troubleshoot the SFTP (Pull) source | Condition | What it means | Where to look | | - | - | - | | The source stays in **Created** and never reaches **Integrated** | The implementation is not complete — the public key has not been uploaded to your SFTP server, or the support ticket has not been raised | Your server's authorised keys, and [Implement the SFTP Pull Source](/articles/integrate-customer/implement-the-sftp-pull-source) | | Zeotap CDP cannot connect to your SFTP server | The **User Id**, **Host** or **Port** on the source does not match your server, or the credentials no longer authorise access | The values you entered at step 5 when creating the source, checked against your SFTP server, and the account those credentials belong to | | The connection succeeds but no files are picked up | The **Folder** value is a relative path, or points to a location where your files do not land | The **Folder** field on the source — it must be an absolute path such as `/home/user/data/` | | Connections from Zeotap CDP are refused by your network | Your server restricts inbound connections by IP and Zeotap's IP address is not allowlisted | Your firewall or SFTP access rules — the address to allowlist is in [Implement the SFTP Pull Source](/articles/integrate-customer/implement-the-sftp-pull-source) | | The same files are ingested on every run | **Delta Query Selection** is set to **false**, so every run pulls all files in the folder | The **Delta Query Selection** field on the source | | You cannot create another Non Customer Data source | The account has reached the limit of five NCE sources, which counts archived NCE sources as well as active ones | The source listing page — the Data Entity tag beside each source name shows whether it is CE or NCE, and sources in the **Archived** status still count towards the limit | ## FAQ > [accordion] Should I create an SFTP (Pull) or an SFTP (Push) source? > > It depends on who hosts the SFTP folder. Create SFTP (Pull) when the folder sits on your own server and you want Zeotap CDP to fetch files from it. Create [SFTP (Push)](/articles/integrate-customer/creating-sftp-push-source) when you would rather upload files yourself to a folder hosted by Zeotap CDP. > [accordion] What does Delta Query Selection change? > > It controls how much of the folder each run reads. Set to **false**, Zeotap CDP pulls all files in the configured folder during every run. Set to **true**, it pulls only the files created after the previous pull. > [accordion] Is the source ready to receive data as soon as I create it? > > No. After creating the source, raise a ticket with Zeotap's Support Team to complete the source creation process, then upload the public key from the **IMPLEMENTATION DETAILS** tab to your SFTP server and allowlist Zeotap's IP address if your server restricts inbound connections. See [Implement the SFTP Pull Source](/articles/integrate-customer/implement-the-sftp-pull-source). > [accordion] How many Non-Customer Entity sources can I create? > > Five per account by default. The limit counts both archived and active NCE sources within an organisation, so archiving an unused NCE source does not free up a slot. ## Next steps * Explore [implementing the SFTP Pull source →](/articles/integrate-customer/implement-the-sftp-pull-source) to upload the public key and open access to your server. * Explore [creating an SFTP (Push) source →](/articles/integrate-customer/creating-sftp-push-source) if you would rather push files to a folder hosted by Zeotap CDP. * Explore [SFTP (Secure File Transfer Protocol) →](/articles/integrate-customer/sftp-secure-file-transfer-protocol) for how both SFTP source types fit together. * Explore [best practices for flat file sources →](/articles/integrate-customer/best-practices-for-flat-file-source-2709422090) before you send your first files. * Explore [how to map the Catalogue for Customer Data →](/articles/unify-customer/map-the-catalogue-for-customer-data). * Explore [how to map the Catalogue for Non-Customer Entity data →](/articles/unify-customer/map-the-catalogue-for-non-customer-entity-data). * Explore [how to add a Non-Customer Entity attribute in the Catalogue →](/articles/unify-customer/adding-a-non-customer-entity-category). * Explore [how to configure the Join Key Enricher →](/articles/unify-customer/configuring-the-join-key-enricher). # Create and Implement a Databricks Source Source: https://docs.zeotap.com/articles/integrate-customer/create-and-implement-a-databricks-source Connect a Databricks table to Zeotap CDP as a data source using either the JDBC or Job-based connector. This page is the complete reference for the Databricks source — components, prerequisites, and full setup. For a shorter setup-only walkthrough that skips the reference material, see [Set Up a Databricks Source](/articles/integrate-customer/set-up-a-databricks-source). ## What this is A Databricks source lets Zeotap CDP ingest data from a table in your Databricks workspace on a defined refresh schedule. Two connection mechanisms are supported — **JDBC**, which reads through a Databricks SQL warehouse, and **Job Based**, which runs a Databricks job to move the data. The Job-based approach is the recommended path for tables above 1 million records, since JDBC may encounter issues at that data volume. Data ingested from Databricks lands in either the **Customer Data** or **Non Customer Data** entity in Zeotap CDP. ## Prerequisites > [!NOTE] > > Setting up a Databricks source requires access to your Databricks workspace with permission to create a service principal, generate the credentials for your chosen mechanism (OAuth Client ID and Client Secret, or a personal access token), and read the target table. You also need access to the Sources application in the Zeotap CDP App. ### Required permissions in Databricks The user or service principal used for authentication must have: * **Unrestricted Cluster Access**, or a cluster policy that permits creating the required node-type clusters. * **SELECT** permission on the required tables. * **USE SCHEMA** permission on the relevant schema. ### Components needed for every Databricks source Obtain these four values from your Databricks account before you create the source in Zeotap CDP. #### Databricks Host The Databricks Host is the unique URL assigned to your Databricks workspace. You can find it in the URL for the Databricks account. ![The Databricks workspace URL in the browser address bar, which is the Databricks Host value](https://mintcdn.com/zeotap/5K-Zf-MYwWXwJWp5/articles/integrate-customer/Storage/integrate-customer/create-and-implement-a-databricks-source/create-and-implement-a-databricks-source-2025-09-02.png?fit=max\&auto=format\&n=5K-Zf-MYwWXwJWp5\&q=85\&s=8efd20803e181ac98cae733b8adb0b55) #### Catalog Name In Databricks, a catalog acts like a folder system. It organises schemas and databases into a hierarchy, allowing users to group tables and views logically. ![Catalog listing in the Databricks workspace](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-and-implement-a-databricks-source/create-and-implement-a-databricks-source-2024-11-05-3.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=b764ec431dd016bfa865230407675fd8) #### Schema Name In Databricks, a schema is essentially a database that contains tables. It serves as a container for organising and managing related tables, providing a structured way to store and retrieve data. ![Schema listed under a catalog in the Databricks workspace](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-and-implement-a-databricks-source/create-and-implement-a-databricks-source-2024-11-05-4.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=57c5bcaae32421ca4f5a510527224980) #### Table Name This is the name of the table within the schema that you want to ingest. ![Table listed under a schema in the Databricks workspace](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-and-implement-a-databricks-source/create-and-implement-a-databricks-source-2024-11-05-5.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=4dd2d856e9a3717341714e24f3dccdb8) ### Additional components for the JDBC mechanism * **HTTP Path** of a Databricks SQL warehouse. * **Client ID** and **Client Secret** from an OAuth service principal. * **Partition Column** or **Unique Column** (see [Partition Column and Unique Column](#partition-column-and-unique-column)). Before entering JDBC credentials in Zeotap CDP, complete the OAuth setup in Databricks by following the [Databricks OAuth M2M documentation](https://docs.databricks.com/en/dev-tools/auth/oauth-m2m.html#authenticate-access-to-databricks-with-a-service-principal-using-oauth-oauth-m2m): > [card] [1. Create a Service Principal](https://docs.databricks.com/en/dev-tools/auth/oauth-m2m.html#step-1-create-a-service-principal) > [card] [2. Assign Workspace-Level Permissions to the Service Principal](https://docs.databricks.com/en/dev-tools/auth/oauth-m2m.html#step-2-assign-workspace-level-permissions-to-the-databricks-service-principal) > [card] [3. Create an OAuth Secret for the Service Principal](https://docs.databricks.com/en/dev-tools/auth/oauth-m2m.html#step-3-create-an-oauth-secret-for-a-service-principal) #### Databricks Client ID and Client Secret Before you can use OAuth to authenticate to Databricks, you must first create an OAuth Client Secret, which is used to generate OAuth access tokens. A service principal can hold up to five OAuth secrets. Account admins and workspace admins can create an OAuth secret for a service principal. For the specific procedure to generate the Client ID and Client Secret, see [step 3 of the Databricks OAuth documentation](https://docs.databricks.com/en/dev-tools/auth/oauth-m2m.html#step-3-create-an-oauth-secret-for-a-service-principal). To create a service principal and generate its **Client ID** and **Client Secret**, go to **Identity and Access → Service Principals → Add Service Principal → Generate Secret** in your Databricks workspace: **1. Open Service Principals** Go to **Identity and Access → Service Principals** and click **Add service principal**. ![Identity and Access settings in Databricks with the Add service principal action](https://mintcdn.com/zeotap/Ns0gcOUUBi0QRyu3/articles/integrate-customer/Storage/integrate-customer/create-and-implement-a-databricks-source/create-and-implement-a-databricks-source-serviceprincipal-1.png?fit=max\&auto=format\&n=Ns0gcOUUBi0QRyu3\&q=85\&s=bb1b78309eb39a72c809ed383b466417) **2. Add the service principal** Select an existing service principal from your account, or create a new one, then click **Add service principal**. ![Selecting an existing service principal or creating a new one before clicking Add service principal](https://mintcdn.com/zeotap/Ns0gcOUUBi0QRyu3/articles/integrate-customer/Storage/integrate-customer/create-and-implement-a-databricks-source/create-and-implement-a-databricks-source-serviceprincipal-2.png?fit=max\&auto=format\&n=Ns0gcOUUBi0QRyu3\&q=85\&s=833f29775fa7255983134649e292d6eb) **3. Generate the secret** Open the service principal, go to the **Secrets** tab, and click **Generate secret**. Copy the generated **Client ID** and **Client Secret** — the secret value is shown only once. ![Secrets tab of a Databricks service principal with the Generate secret action](https://mintcdn.com/zeotap/Ns0gcOUUBi0QRyu3/articles/integrate-customer/Storage/integrate-customer/create-and-implement-a-databricks-source/create-and-implement-a-databricks-source-serviceprincipal-3.png?fit=max\&auto=format\&n=Ns0gcOUUBi0QRyu3\&q=85\&s=33d5635b191feb8c71761e23b0d21948) #### HTTP Path To locate the HTTP Path in Databricks, perform the following steps: **1. Open SQL Warehouses** Log in to your Databricks instance and, under **SQL**, click **SQL Warehouses**. ![SQL Warehouses entry under SQL in the Databricks navigation](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-and-implement-a-databricks-source/create-and-implement-a-databricks-source-2024-11-05-2.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=786342b8ffc6f9d8fe88409aa56afb66) **2. Select the SQL warehouse** Click the desired SQL warehouse. If no SQL warehouse exists, create one by clicking **Create SQL Warehouse**. ![SQL warehouse list in Databricks with the Create SQL Warehouse option](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-and-implement-a-databricks-source/create-and-implement-a-databricks-source-2024-11-05.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=6fd4fa7e86d85d85756e99fa0440e795) **3. Open Connection details** On the SQL warehouse summary page, go to the **Connection details** tab. ![Connection details tab on the Databricks SQL warehouse summary page](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-and-implement-a-databricks-source/create-and-implement-a-databricks-source-2024-11-05-1.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=af6894b0175c82e1ad94cbdc0cebbad2) **4. Copy the HTTP Path** Copy the **HTTP Path** value from the displayed information. #### Partition Column and Unique Column A **Partition Column** is a key used to organise large tables into smaller, logical groups. For example, data can be partitioned by date or region, so queries targeting a specific time range or location run much faster. If no Partition Column exists on the source table, use any **Unique Column** instead — a column whose values are different in every row. When only a Unique Column is available, Zeotap CDP: 1. Creates a temporary view and runs the read queries over that view. 2. Drops the view once all the data has been fetched. ### Additional components for the Job-based mechanism For the Job Based approach, select an **Auth Type** and provide the corresponding credentials. The supported auth types are **PAT Token** and **Service Principal**. #### PAT Token A Personal Access Token (PAT) can be generated in Databricks under **Settings → User setting → Developer → Generate new token**. ![Generate new token under Developer in the Databricks user settings](https://mintcdn.com/zeotap/5K-Zf-MYwWXwJWp5/articles/integrate-customer/Storage/integrate-customer/create-and-implement-a-databricks-source/create-and-implement-a-databricks-source-2025-09-02-1.png?fit=max\&auto=format\&n=5K-Zf-MYwWXwJWp5\&q=85\&s=f04fc7a25f5dca5e73352dd404159fc0) **Required PAT scopes.** When using PAT authentication, the token must carry the following scopes: * **jobs** * **secrets** * **sql** * **unity-catalog** * **workspace** These scopes are required for: * Creating and running jobs * Managing secret scopes * Accessing tables via SQL and Unity Catalog * Creating notebooks and workspace artefacts #### Service Principal Provide the **Client ID** and **Client Secret** of your Databricks service principal. These are the same credentials used for the JDBC approach — see [Databricks Client ID and Client Secret](#databricks-client-id-and-client-secret) for how to create the service principal and generate the OAuth secret. ## Choose a connection mechanism > [!TIP] > > Use **Job Based** for tables above 1 million records. Use **JDBC** for smaller tables and ad-hoc use cases where a SQL warehouse is already provisioned. | Mechanism | Best for | Credentials required | | :- | :- | :- | | **JDBC** | Tables under 1M records | Client ID, Client Secret, HTTP Path, Partition or Unique Column | | **Job Based** (recommended) | Tables above 1M records | An **Auth Type** — either **PAT Token** (Access Token) or **Service Principal** (Client ID and Client Secret) | ## Configure the source in Zeotap CDP Once you have gathered the Databricks components, create the source in the Zeotap CDP App. **1. Open the Sources application** In the Zeotap CDP App, open the **Sources** application under **Integrate**, then click **CREATE SOURCE**. **2. Select Data Warehouse as the category** Under **Category**, choose **Data Warehouse**. ![Choosing Data Warehouse as the source category](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-amazon-s3-source/sf_1_\(1\).png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=146e94f6110f76970d52baf2ab1e964b) **3. Select Databricks as the data source** Click **Databricks** as the Data Source. ![Selecting Databricks as the data source](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-and-implement-a-databricks-source/create-and-implement-a-databricks-source-2024-10-21-5.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=37be59c74bd04bf3496f418430749c73) **4. Name the source and pick the region** Enter a short, descriptive **Source Name** and choose the **Region** of upload. **5. Set the Refresh Frequency** Choose the **Refresh Frequency** from the drop-down. The first sync runs when the source is created; subsequent syncs follow the frequency you select. Supported frequencies: * Sync once * Every hour * Every 3 hours * Every 6 hours * Every 12 hours * Daily * Weekly * Monthly For Daily, Weekly, and Monthly, set **Sync Time** (the exact time for the sync to occur), **Sync Period** (whether the Sync Time is AM or PM), and — for Monthly — the **Monthly Sync date** (the day of the month on which the sync should run). **6. Enter host, catalog, schema, and table** Enter your Databricks workspace URL in the **Databricks Host** field, followed by **Catalog Name**, **Schema Name**, and **Table Name**. ![Databricks Host, Catalog Name, Schema Name, and Table Name fields](https://mintcdn.com/zeotap/5K-Zf-MYwWXwJWp5/articles/integrate-customer/Storage/integrate-customer/create-and-implement-a-databricks-source/create-and-implement-a-databricks-source-2025-09-02-4.png?fit=max\&auto=format\&n=5K-Zf-MYwWXwJWp5\&q=85\&s=c6c91942a14f124511ef6abea3710a23) **7. Choose the data entity** Under **Data Entity**, select **Customer Data** or **Non Customer Data** depending on the type of data you are ingesting. For the distinction, see [Supported Data Entities](https://docs.zeotap.com/articles/unify-customer/supported-data-entities). **8. Configure Delta Queries Selection** Under **Delta Queries Selection**, decide whether to consider deltas (data additions and changes) in the table based on a timestamp column. Choose **true** or **false**: ![Delta Queries Selection with true and false options](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-bigquery-source/create-a-bigquery-source-2023-05-22-9.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=3a41aecd8ce7a3ca7b8f03b03280b736) * **true** — only new and updated values, based on the timestamp in the delta column, are fetched. **Delta Column Name** and **Delta Column Data Type** become active: enter the name of the column to fetch data from, and choose the time increment for fetching the data from that column. * **false** — no additional selections are needed. Zeotap CDP fetches all existing data from the table on every run. ![Delta Column Name and Delta Column Data Type fields shown when Delta Queries Selection is true](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-bigquery-source/create-a-bigquery-source-2023-05-22-10.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=5ef77403530a5665787eb96ce739fe03) **9. Select the connection mechanism** Select the mechanism used to pull the data. The currently supported options are **JDBC** and **Job Based**. ![Connection mechanism selection showing JDBC and Job Based options](https://mintcdn.com/zeotap/5K-Zf-MYwWXwJWp5/articles/integrate-customer/Storage/integrate-customer/create-and-implement-a-databricks-source/create-and-implement-a-databricks-source-2025-09-02-5.png?fit=max\&auto=format\&n=5K-Zf-MYwWXwJWp5\&q=85\&s=90edfec0123599c3d6bcaeeda1f6a399) **10. Enter the credentials for the chosen mechanism** **If you selected JDBC**, enter the following values (see [Additional components for the JDBC mechanism](#additional-components-for-the-jdbc-mechanism) for how to obtain them): * Client ID * Client Secret * HTTP Path * Partition Table Details (Partition Column Name, Partition Column Type) * Unique Column Name ![JDBC credential fields for the Databricks source](https://mintcdn.com/zeotap/5K-Zf-MYwWXwJWp5/articles/integrate-customer/Storage/integrate-customer/create-and-implement-a-databricks-source/create-and-implement-a-databricks-source-2025-09-02-6.png?fit=max\&auto=format\&n=5K-Zf-MYwWXwJWp5\&q=85\&s=ae2a87fad3f52e8713dc654755e3ea57) ![Remaining JDBC credential fields on the Databricks source configuration screen](https://mintcdn.com/zeotap/5K-Zf-MYwWXwJWp5/articles/integrate-customer/Storage/integrate-customer/create-and-implement-a-databricks-source/create-and-implement-a-databricks-source-2025-09-15-1.png?fit=max\&auto=format\&n=5K-Zf-MYwWXwJWp5\&q=85\&s=58654c09340cad0db341df6ec4e2a1a6) **If you selected Job Based**, choose the **Auth Type** and enter the corresponding credentials (see [Additional components for the Job-based mechanism](#additional-components-for-the-job-based-mechanism)). If the Auth Type is **PAT Token**, enter the **Access Token**: ![Job Based mechanism with Auth Type set to PAT Token and the Access Token field](https://mintcdn.com/zeotap/Ns0gcOUUBi0QRyu3/articles/integrate-customer/Storage/integrate-customer/create-and-implement-a-databricks-source/create-and-implement-a-databricks-source-jobbased-pat-token.png?fit=max\&auto=format\&n=Ns0gcOUUBi0QRyu3\&q=85\&s=f954325b8676c2dc6db56a863ca33b4e) If the Auth Type is **Service Principal**, enter the **Client ID** and **Client Secret**: ![Job Based mechanism with Auth Type set to Service Principal and the Client ID and Client Secret fields](https://mintcdn.com/zeotap/Ns0gcOUUBi0QRyu3/articles/integrate-customer/Storage/integrate-customer/create-and-implement-a-databricks-source/create-and-implement-a-databricks-source-jobbased-service-principal.png?fit=max\&auto=format\&n=Ns0gcOUUBi0QRyu3\&q=85\&s=c9bf3eea81751d43c3f275074d9eb6ff) **11. Select the fields to ingest** Click **Next** to proceed to field selection. A list of fields is displayed: tick the columns you want to ingest, use **Select All** to pick every column available in your Databricks account, or search by name if you already know the field names. **12. Create the source** Click **CREATE SOURCE**. The source appears on the Sources listing page. ### Field-level requirements The fields a Databricks source configuration collects: | Field | Required | Value | | :- | :- | :- | | **Source Name** | Always | A short, descriptive name for the source | | **Region** | Always | The region of upload | | **Refresh Frequency** | Always | Sync once, Every hour, Every 3 hours, Every 6 hours, Every 12 hours, Daily, Weekly, or Monthly | | **Sync Time** | Daily, Weekly, Monthly | The exact time for the sync to occur | | **Sync Period** | Daily, Weekly, Monthly | AM or PM | | **Monthly Sync date** | Monthly only | The day of the month on which the sync should run | | **Databricks Host** | Always | Your Databricks workspace URL | | **Catalog Name** | Always | The catalog that holds the schema | | **Schema Name** | Always | The schema within the catalog | | **Table Name** | Always | The table within the schema | | **Data Entity** | Always | Customer Data or Non Customer Data | | **Delta Queries Selection** | Always | true or false | | **Delta Column Name** | Delta Queries Selection = true | The timestamp column to fetch data from | | **Delta Column Data Type** | Delta Queries Selection = true | The time increment for fetching the data | Connection fields, by mechanism: | Mechanism | Field | Required | Value | | :- | :- | :- | :- | | JDBC | **Client ID** | Always | OAuth client ID of the service principal | | JDBC | **Client Secret** | Always | OAuth client secret of the service principal | | JDBC | **HTTP Path** | Always | HTTP Path of the Databricks SQL warehouse | | JDBC | **Partition Column Name** / **Partition Column Type** | When the table has a partition column | The partition key and its type | | JDBC | **Unique Column Name** | When no partition column exists | A column whose value differs in every row | | Job Based | **Auth Type** | Always | PAT Token or Service Principal | | Job Based | **Access Token** | Auth Type = PAT Token | The Databricks personal access token, with the scopes listed above | | Job Based | **Client ID** and **Client Secret** | Auth Type = Service Principal | The service principal's OAuth credentials | ## Verify the source is integrated Open the source from the Sources listing and go to the **IMPLEMENTATION DETAILS** tab. A successfully created source shows all the relevant information about the created source on this tab and appears on the Sources listing with the **Integrated** status. ![IMPLEMENTATION DETAILS tab of a created Databricks source](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-and-implement-a-databricks-source/create-and-implement-a-databricks-source-2024-10-21-8.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=c46d108cec47e0fca57503d3d1dcdfac) The first data transfer starts when the source is created; its duration depends on the volume of data in the source table. ## Troubleshooting If the source does not reach **Integrated**, or the first sync does not produce data, check the conditions below. | Condition | What it means | Where to look | | :- | :- | :- | | Authentication rejected during source creation | The Client ID or Client Secret does not have workspace-level permissions on the Databricks side | Re-run [step 2 of the Databricks OAuth setup](https://docs.databricks.com/en/dev-tools/auth/oauth-m2m.html#step-2-assign-workspace-level-permissions-to-the-databricks-service-principal) to assign workspace-level permissions to the service principal | | The Job Based mechanism cannot start its job | The authenticating user or service principal does not have **Unrestricted Cluster Access**, or the cluster policy does not permit creating the required node-type clusters | Databricks workspace → cluster access and cluster policies for the user or service principal | | The table cannot be read even though authentication succeeds | The **SELECT** permission on the table or the **USE SCHEMA** permission on the schema is missing | Databricks → the target catalog, schema, and table permissions | | A PAT-authenticated Job Based source fails | The personal access token is missing one of the required scopes (**jobs**, **secrets**, **sql**, **unity-catalog**, **workspace**) | Databricks → **Settings → User setting → Developer**; regenerate the token with all required scopes | | First sync runs long for a large table | The JDBC mechanism was selected on a table above 1M records | Use the **Job Based** mechanism for tables above 1M records | | No rows arrive after a delta-enabled sync | The **Delta Column Name** does not point at a timestamp that advances between runs | Zeotap CDP → source → **IMPLEMENTATION DETAILS** tab; re-check the Delta Column configuration against the source table | | HTTP Path field rejected | The HTTP Path was copied from a different warehouse | Databricks → **SQL Warehouses → \ → Connection details → HTTP Path** | If the source configuration passes every check but no data arrives after the first refresh, contact the Zeotap support team at [support@zeotap.com](mailto:support@zeotap.com). Include: * The source name and connection mechanism (JDBC or Job Based), and for Job Based the Auth Type. * The refresh frequency. * The timestamp of the last completed sync (if any). * The Databricks catalog, schema, and table names. ## FAQ > [accordion] Which connection mechanism should I pick — JDBC or Job Based? > > Pick **Job Based** for any table above 1 million records; JDBC may encounter issues at that data volume. For smaller tables, either mechanism works — JDBC reuses an existing SQL warehouse and needs the Client ID, Client Secret, HTTP Path, and either a Partition Column or a Unique Column. > [accordion] Which Auth Type should I use for the Job Based mechanism? > > Both are supported. **PAT Token** needs a single Databricks personal access token carrying the **jobs**, **secrets**, **sql**, **unity-catalog**, and **workspace** scopes. **Service Principal** reuses the same **Client ID** and **Client Secret** you would generate for the JDBC mechanism, so it is the simpler choice if that service principal already exists. > [accordion] What if the source table has no partition column? > > Provide a **Unique Column** instead — a column whose values are different in every row. Zeotap CDP creates a temporary view over the table to run the read queries and drops the view after all the data is fetched. > [accordion] How long does the first sync take? > > The initial data transfer from Databricks to Zeotap CDP starts when the source is created and may take time depending on the data volume. Subsequent runs follow the Refresh Frequency and, when Delta Queries Selection is set to **true**, pull only the delta since the last successful sync. ## Next steps * [Explore the shorter Databricks setup walkthrough →](/articles/integrate-customer/set-up-a-databricks-source) * [Explore the BigQuery source setup →](/articles/integrate-customer/create-a-bigquery-source) * [Explore the Amazon S3 source setup →](/articles/integrate-customer/create-and-implement-an-amazon-s3-source) * [Explore how to map ingested data in the Catalogue →](https://docs.zeotap.com/articles/unify-customer/map-the-catalogue-for-customer-data) # Create and Implement an Amazon S3 Source Source: https://docs.zeotap.com/articles/integrate-customer/create-and-implement-an-amazon-s3-source Create an Amazon S3 source to import CSV or JSON files from your S3 bucket into Zeotap CDP on a schedule, with optional delta fetch. This page covers the Amazon S3 **source** — bringing data **into** Zeotap CDP from a bucket in your own Amazon (AWS) S3 account. If you want to send Zeotap audiences **out** to an S3 bucket instead, see the [Amazon S3 destination](/articles/integrate-customer/amazon-s3-destination). For the overview of the S3 source integration, see [Amazon S3](/articles/integrate-customer/amazon-s3). ## What this is The Amazon S3 source connects Zeotap CDP directly to data that already resides in your S3 bucket, so you do not have to move files anywhere else first. You create it from the **Sources** application under **Integrate**, in the **Data Warehouse** category. Once the source is created, Zeotap CDP reads CSV or JSON files from the bucket and folder you nominate. The first sync starts as soon as you create the source; every sync after that follows the **Sync frequency** you chose. **Delta Queries Selection** controls whether a sync picks up only the data that changed in your bucket since the last sync. ## Prerequisites > [!NOTE] > > Before you create an Amazon S3 source in Zeotap CDP, you must have an account with Amazon S3, and the data intended for import to Zeotap CDP must reside within that account. > > Collect the following details from that account before you start — each one is explained in [Collect the Amazon S3 details](#collect-the-amazon-s3-details): > > * **Bucket Name** — the S3 bucket holding your data. > * **S3 Bucket Region** — the geographical location of that bucket. > * **Folder** — the folder path inside the bucket that holds the files to import. > * **Access Token** and **Secret Access Token** — the credentials Zeotap CDP uses to read the bucket. ## Supported data and identifiers | Property | Value | | :- | :- | | Category | Data Warehouse | | Data entities supported | Customer Data (CE) and Non-Customer Entity (NCE) data | | Identifiers and attributes | Any identifiers or attributes | | File formats | CSV and JSON | | Delta fetch | Supported, via **Delta Queries Selection** | For the full list of source integrations and what each one supports, see [Source Integrations (Batch+Real-Time)](/articles/integrate-customer/creating-a-source). To understand Customer Data and Non-Customer Entity data, see [Supported data entities](/articles/unify-customer/supported-data-entities). ## Collect the Amazon S3 details > [card] [Bucket Name](#bucket-name) > [card] [S3 Bucket Region](#s3-bucket-region) > [card] [Folder](#folder) > [card] [Access Token and Secret Access Token](#access-token-and-secret-access-token) ### Bucket Name This is the name of your S3 bucket. You can obtain this information on your Amazon S3 account by navigating to **Buckets**. In the example shown below, **test-adobe-s3-bucket** is the bucket name. ![Amazon S3 bucket detail page for the example bucket, with the bucket name shown as the page heading](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-an-amazon-s3-source/amazon_s3_pre_1_\(1\).png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=285e645295f67b8e7ed9880ed63f79fe) ### S3 Bucket Region This is the geographical location where the Amazon S3 storage is available. You can obtain this information by navigating to the **Properties** tab under the Amazon S3 bucket as shown in the image below. ![Properties tab of an Amazon S3 bucket, showing the AWS Region of the bucket](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-an-amazon-s3-source/amazon_s3_pre_2_\(1\).png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=d4920504cf29017e61b52e67b48d80d6) ### Folder In Amazon S3, a folder serves as a logical container for organising stored objects within a bucket. In reality, there are no actual folders in Amazon S3. Instead, the folder concept is emulated by employing object key names containing slashes ("/") to replicate a hierarchical arrangement. You can obtain this information from your Amazon S3 account by navigating to the **Objects** tab under the Amazon S3 bucket as shown in the image below. ![Objects tab of an Amazon S3 bucket, listing a folder inside the bucket prefix](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-amazon-s3-source/amazon_s3_pre_3_\(1\).png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=6b21f4fa5854f281b445578813dcc048) ### Access Token and Secret Access Token These are the security tokens that provide secure access to your Amazon S3 resources. You can obtain the Access Token and Secret Access Token by navigating to the **AWS IAM Credentials** tab under **Security credentials** in your Amazon S3 account. Ensure that you have the following permissions to create Access token and Secret access token for your own IAM user: * `iam:ListAccessKeys` – Allows listing the access keys for an IAM user. * `iam:CreateAccessKey` – Allows creating new access keys for an IAM user. ## Create the Amazon S3 source in Zeotap CDP Once you have obtained the above details from your Amazon S3 account, perform the following steps to create an Amazon S3 Source in the Zeotap CDP App: **Step 1** Navigate to the **Sources** application under **Integrate**, in the Zeotap CDP App. **Step 2** Click **CREATE SOURCE**. **Step 3** Choose **Data Warehouse** as the Category. ![Category step of the Create Source wizard, with Data Warehouse selected](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-amazon-s3-source/sf_1_\(1\).png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=146e94f6110f76970d52baf2ab1e964b) **Step 4** Under **SELECT DATA SOURCE**, click **Amazon S3**. ![Data Source step of the Create Source wizard, with Amazon S3 selected from the Data Warehouse list](https://mintcdn.com/zeotap/5K-Zf-MYwWXwJWp5/articles/integrate-customer/Storage/integrate-customer/create-and-implement-an-amazon-s3-source/create-and-implement-an-amazon-s3-source-2024-10-21.png?fit=max\&auto=format\&n=5K-Zf-MYwWXwJWp5\&q=85\&s=7dc9b12703331242ba8c31bc02947e8f) **Step 5** Enter a short and descriptive name for the Source. **Step 6** Choose the **Region** of upload — the region in which the ingested data is stored. This is not the same field as the **S3 Bucket Region** you enter later, which is the location of your own S3 bucket. **Step 7** Enter the **Access Token** and **Secret Access Token** that you obtained from your Amazon S3 account. **Step 8** Enter the **Bucket Name** of your Amazon S3 bucket. ![Source Details step showing the Source Name, Region, Access Token, Secret Access Token and Bucket Name fields](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-an-amazon-s3-source/Screenshot_2024-04-02_at_5.17.47_PM.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=cf6a61bf985c7b9ed7b9b86b89a5e8ac) **Step 9** Provide the **Folder** path inside that bucket that holds the data you want Zeotap CDP to import. **Step 10** Enter the **S3 Bucket Region** associated with the bucket from which you want Zeotap CDP to fetch the data. **Step 11** Choose the desired **Sync frequency** from the drop-down menu. Note that the first sync is initiated once you create the source. However, the subsequent syncs occur based on the sync frequency you choose. Currently, we support the following sync frequencies: a. Daily b. Weekly c. Monthly **Step 12** Set **Delta Queries Selection** to either **true** or **false** based on your requirement. If you select **true**, then Zeotap CDP fetches all the data that has been updated in your S3 bucket after the last data sync between your S3 account and Zeotap CDP. **Step 13** Choose the file type. Currently, Zeotap CDP supports **CSV** and **JSON** formats. **Step 14** Under **Data Entity**, depending on the type of data you want to ingest, choose either **Customer Data** or **Non Customer Data** and proceed with the Source creation. To know more about Customer Data and Non Customer Data, refer [here](/articles/unify-customer/supported-data-entities). ![Source Details step showing the Bucket Name, Folder, S3 Bucket Region, Sync frequency, Delta Queries Selection, file type and Data Entity fields](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-amazon-s3-source/image-20240405-074844.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=42017973a6885a1bf840ab4e36c14e70) **Step 15** Click **CREATE SOURCE**. ## Verify the source Upon successfully creating the source, you can view all the relevant information about the created source under the **IMPLEMENTATION DETAILS** tab. ![Implementation Details tab of a created Amazon S3 source, listing the region, sync frequency, delta queries selection, file format, data entity and bucket details](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-an-amazon-s3-source/Amazon_S3_imple.png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=d9273731356263b27ddb085e1bf1fa4f) Check that the values shown there match what you entered — the **Region**, **Sync frequency**, **Delta Queries Selection**, **File Format** and **Data Entity** are all displayed. The **S3 Bucket Region**, **Access Token**, **Secret Access Token**, **Bucket Name** and **Folder** values are masked once the source is saved. The same view carries the **PREVIEW DATA** tab, where you can confirm that records from your bucket are arriving with the attribute names and values you expect, the **SOURCE REPORT** tab (see [Source Report](/articles/integrate-customer/source-report)), and the **CATALOGUE MAPPING** tab, which is where you map those fields into your Catalogue. ## Next steps * Map the incoming fields into your Catalogue — see [Map the Catalogue for Customer Data](/articles/unify-customer/map-the-catalogue-for-customer-data), or [Map the Catalogue for Non-Customer Entity data](/articles/unify-customer/map-the-catalogue-for-non-customer-entity-data) if you chose **Non Customer Data**. * Review the other Data Warehouse integrations in [Data Warehouse (CE+NCE)](/articles/integrate-customer/data-warehouse). * To send audiences from Zeotap CDP back out to Amazon S3, set up the [Amazon S3 destination](/articles/integrate-customer/amazon-s3-destination). > [!NOTE] > > **Note:** > > For assistance with Amazon S3 source setup or other questions, reach out to the Zeotap support team at [support@zeotap.com](mailto:support@zeotap.com). # Create a MoEngage Events stream source Source: https://docs.zeotap.com/articles/integrate-customer/creating-a-moengage-stream Create a MoEngage Events stream source in Zeotap CDP so engagement events flow from MoEngage into the CDP, and collect the API URL and write key that complete the integration. ## What this is A **MoEngage Events stream** source brings data **into Zeotap CDP**. MoEngage streams the engagement events recorded on its platform out to Zeotap CDP, where they are ingested and can be mapped to the Catalogue and used alongside the rest of your customer data. For more about the integration, see [Moengage Source](/articles/integrate-customer/moengage-source). For the opposite direction — sending data **out of Zeotap CDP to MoEngage** — use a MoEngage destination instead: [Moengage](/articles/integrate-customer/moengage) to sync users and send events from a journey, or [Moengage Audience](/articles/integrate-customer/moengage-audience) to sync an audience. Creating the source is the Zeotap CDP half of the integration. It generates two values — an **API URL** and a **write key** — that are needed to complete the integration on the MoEngage side. No MoEngage credentials are entered in Zeotap CDP. ## Prerequisites > [!NOTE] > > Before you start, confirm the following: > > * **An active MoEngage account**, and access within it to configure MoEngage Streams for your workspace. The MoEngage-side configuration is what starts the flow of events. > * **Access to the Sources application** under **Integrate** in the Zeotap CDP app, so you can create a source. > * **The region and the data entity for this source**, decided in advance. Both are required on the create form, and the data entity determines whether the source is treated as customer data or non customer data. See [Supported Data Entities](/articles/unify-customer/supported-data-entities). ## Create the MoEngage Events stream source **1. Open the Sources application** Log into the Zeotap CDP app and navigate to the **Sources** application under **Integrate**. **2. Start a new source** Click **CREATE SOURCE**. **3. Choose Customer Engagement Channels as the category** On the **Data Source** step, choose **Customer Engagement Channels**. ![The CREATE SOURCE dialog on the Data Source step, listing the source categories with Customer Engagement Channels selected](https://mintcdn.com/zeotap/49y1_9uVgJhUhPeD/articles/integrate-customer/Storage/integrate-customer/integrate-customer/working-with-the-source-listing-page/cec.png?fit=max\&auto=format\&n=49y1_9uVgJhUhPeD\&q=85\&s=104262dfa0aa70a3600c907670094be0) **4. Choose MoEngage Events stream as the data source** In the list of customer engagement channels, select **MoEngage Events stream**. ![The customer engagement channel list in the CREATE SOURCE dialog, with the MoEngage Events stream entry selected](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-30.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=99d282b026e99e15cc0efbf992bc7033) **5. Enter the source details** On the **Source Details** step: 1. In **Source Name**, enter a short, descriptive name for the source. 2. Under **Select your Region**, select a region using the option button provided. The form links to a document that maps a country to a region if you are unsure which to pick. 3. Under **Data Entity**, depending on the type of data that you want to ingest, choose either **Customer Data** or **Non Customer Data**. To know more, refer to [Supported Data Entities](/articles/unify-customer/supported-data-entities). ![The Source Details step of the CREATE SOURCE dialog, showing the Source Name field, the Select your Region option buttons and the Data Entity option buttons](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-31.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=2c5acb04d88d7ad567c94c08d088139f) **6. Create the source** Click **CREATE SOURCE**. On successful creation, an **API URL** and a **write key** are generated for this source and appear under its **IMPLEMENTATION DETAILS** tab. Both are essential to complete the integration. ![The IMPLEMENTATION DETAILS tab of a MoEngage Events stream source, showing the source status alongside its data entity and region, above the Access Details section](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-32.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=59c283a9cac2a1c39154977d945921d0) ## Connect MoEngage to the source Open the source and note the two values on its **IMPLEMENTATION DETAILS** tab: * The **API URL** establishes the connection between MoEngage and Zeotap CDP. * The **write key** is used to securely ingest data from MoEngage into Zeotap CDP. Both values are generated for this source alone, so keep them to the MoEngage configuration that uses them. The same tab carries in-product instructions, under **HOW TO INTEGRATE WITH MOENGAGE**, that begin with logging in to your MoEngage account. Follow those to configure the events stream on the MoEngage side; that configuration is not documented here. ## Verify the source is receiving data The source's status on the Sources listing tells you how far the integration has progressed: | Status | What it means | | :- | :- | | **Created** | The source exists in Zeotap CDP but has not received any data yet. | | **Integrated** | Data has started flowing into the source, but taxonomy standardisation has not been applied yet. You can preview the incoming data on the source's **PREVIEW DATA** tab. | | **Mapped** | At least one data collection has been created on top of the integrated source, based on the common taxonomy. | For the full set of statuses and the other columns on the listing, see [Components of the Source Listing Page](/articles/integrate-customer/components-of-the-source-listing-page). Once the status reaches **Integrated**, check the data itself: * The **PREVIEW DATA** tab shows a sample of the data that has been received. See [Components of the Preview Data Tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab). * The **SOURCE REPORT** tab gives the ingestion health and status of the source. See [Exploring Source Reports](/articles/integrate-customer/exploring-source-reports). ## Troubleshoot the source | What you see | What it means | What to do | | :- | :- | :- | | The source stays at **Created** and no data arrives | The source has been created, but nothing has been sent to it yet | Confirm the MoEngage-side configuration uses the API URL and write key shown on this source's **IMPLEMENTATION DETAILS** tab | | No preview is available on the **PREVIEW DATA** tab | An error message is displayed stating the reason | Fix the issue reported and try again after some time, and confirm the source is implemented correctly | | Records are arriving but some are rejected | There are errors in the data received, before Catalogue mapping — for example missing column names or a file format issue | Use **View Error Log** on the **PREVIEW DATA** tab to review the errors | If you need further assistance, contact Zeotap support at **[support@zeotap.com](mailto:support@zeotap.com)** with the source name and its ID from the Sources listing. ## Next steps * [Map the ingested data to the Catalogue →](/articles/unify-customer/map-the-catalogue-for-customer-data) * [Explore what the Preview Data tab shows →](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) * [Explore the source report →](/articles/integrate-customer/exploring-source-reports) * [Send data from Zeotap CDP back to MoEngage →](/articles/integrate-customer/moengage) # Source Integrations (Batch and Real-Time) Source: https://docs.zeotap.com/articles/integrate-customer/creating-a-source Choose the right connector to bring customer data from your systems into the Zeotap CDP — SDKs for web and app events, CRM connectors, flat-file transfers, warehouses, and message queues. ## What this is A **source** in Zeotap CDP is a connector that brings data from one of your systems — a website, mobile app, CRM, warehouse, file store, or message queue — into the customer profile store. Every source belongs to a **category** (Website Events, App Events, CRM Data, Customer Engagement Channels, Flat Files, Tag Manager, Server-to-Server, Data Warehouse, or Message Queue), supports either Customer Entity (`CE`) data only or `CE + NCE` (Non-Customer Entity) data, and either performs a full pull on each run or supports **delta fetch** — pulling only new or changed records. Pick a connector based on the upstream system, the data types it holds, and whether delta fetch is required to keep sync volumes manageable. ## Prerequisites > [!NOTE] > > Before you create a source, confirm you have: > > * **Workspace access** with a role that allows source creation. > * **Credentials or connection details** for the upstream system — API key, service-account key, SFTP host and key pair, warehouse connection string, or the ability to place an SDK snippet on your site or app. > * **A defined identifier strategy** — the customer identifier (email, phone, customer ID, device ID, or a hashed variant) that ties records from this source to profiles in the CDP. > * **A field-level mapping plan** — the source fields you want to ingest and how they map onto attributes in the Zeotap catalogue. ## Choose a source connector Pick a connector from the category that matches your upstream system. **Data supported** shows whether the connector ingests only customer-entity records (`CE`) or also non-customer-entity records (`NCE`, for example products, stores, or transactions). **Delta fetch supported** shows whether the connector pulls only new or changed records on each scheduled run. ### Website events | Source | Data supported | Attributes supported | Delta fetch supported | | - | - | - | - | | [Web JavaScript](/articles/integrate-customer/creating-web-js-source-2676490558) | CE only | See [Web JS quick start](/articles/sdks/web-js/quick-start) | No | | [Web Pixel / Web IFrame / App Pixel](/articles/integrate-customer/2676392376) | CE only | — | No | ### App events | Source | Data supported | Attributes supported | Delta fetch supported | | - | - | - | - | | [Adjust](/articles/integrate-customer/create-an-adjust-source) | CE only | Installs, reattributions, sessions, events, reinstalls, uninstalls | No | | [Android SDK](/articles/integrate-customer/creating-android-sdk-source) | CE only | See [Android SDK](/articles/sdks/android/intro) | No | | [iOS SDK](/articles/integrate-customer/create-an-ios-sdk-source) | CE only | See [iOS SDK](/articles/sdks/ios/intro) | No | | [React Native package](/articles/sdks/react-native/intro) | CE only | See [React Native](/articles/sdks/react-native/intro) | No | ### CRM data | Source | Data supported | Attributes supported | Delta fetch supported | | - | - | - | - | | [HubSpot](/articles/integrate-customer/hubspot-source) | CE + NCE | Any identifiers or attributes | Yes | | [Microsoft Dynamics CRM](/articles/integrate-customer/create-an-ms-dynamics-crm-source) | CE + NCE | Any identifiers or attributes | Yes | | [Salesforce CRM](/articles/integrate-customer/creating-salesforce-crm) | CE + NCE | Any identifiers or attributes | No | ### Customer engagement channels | Source | Data supported | Attributes supported | Delta fetch supported | | - | - | - | - | | [Batch](/articles/integrate-customer/create-a-batch-source) | CE only | — | No | | [Braze Currents](/articles/integrate-customer/create-a-braze-currents-source) | CE only | — | No | | [Dotdigital](/articles/integrate-customer/create-a-dotdigital-source) | CE only | Contacts, Campaigns, Preferences, Campaign Opens, Campaign Clicks, Campaign Page Views | No | | [Airship (Batch)](/articles/integrate-customer/create-an-airship-batch-source) | CE only | Named User, Airship Channel ID | No | | [Airship (Real-Time)](/articles/integrate-customer/create-an-airship-real-time-data-streaming-source) | CE only | Airship Channel ID | No | | [Cleverpush (Batch)](/articles/integrate-customer/create-a-cleverpush-batch-source) | CE only | Channel ID | No | | [Cleverpush (Real-Time)](/articles/integrate-customer/create-a-cleverpush-real-time-source) | CE only | Channel ID | No | ### Flat files | Source | Data supported | Attributes supported | Delta fetch supported | | - | - | - | - | | [Zeotap Google Cloud Storage](/articles/integrate-customer/create-a-zeotap-google-cloud-storage-source) | CE + NCE | See [Implement a Zeotap GCS source](/articles/integrate-customer/implement-a-zeotap-google-cloud-storage-source) | No | | [SFTP (Push)](/articles/integrate-customer/creating-sftp-push-source) | CE + NCE | See [Implement SFTP Push](/articles/integrate-customer/implementing-sftp-push-source) | No | | [SFTP (Pull)](/articles/integrate-customer/create-an-sftp-pull-source) | CE + NCE | See [Implement SFTP Pull](/articles/integrate-customer/implement-the-sftp-pull-source) | Yes | ### Tag manager | Source | Data supported | Attributes supported | Delta fetch supported | | - | - | - | - | | [Adobe Experience Platform Tag Extension](/articles/integrate-customer/create-an-adobe-experience-platform-tag-extension-source) | CE only | See [Implement AEP Tag Extension](/articles/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source) | No | | [Google Tag Manager](/articles/integrate-customer/creating-tag-manager-source-2676490586) | CE only | — | No | ### Server-to-server (S2S) | Source | Data supported | Attributes supported | Delta fetch supported | | - | - | - | - | | [Server-to-Server (S2S)](/articles/integrate-customer/implementing-server-to-server-source-2665709918) | CE + NCE | — | No | ### Data warehouse | Source | Data supported | Attributes supported | Delta fetch supported | | - | - | - | - | | [Snowflake](/articles/integrate-customer/create-a-snowflake-source) | CE + NCE | See [Snowflake appendix](/articles/integrate-customer/snowflake-appendix) | No | | [BigQuery](/articles/integrate-customer/create-a-bigquery-source) | CE + NCE | Any identifiers or attributes | Yes | | [Amazon S3](/articles/integrate-customer/create-and-implement-an-amazon-s3-source) | CE + NCE | Any identifiers or attributes | Yes | | [Databricks](/articles/integrate-customer/create-and-implement-a-databricks-source) | CE + NCE | Any identifiers or attributes | Yes | ### Message queue | Source | Data supported | Attributes supported | Delta fetch supported | | - | - | - | - | | [Pub/Sub Stream](/articles/integrate-customer/pub-sub-stream) | CE + NCE | — | No | | [Pub/Sub Batch](/articles/integrate-customer/pub-sub-batch) | CE + NCE | — | No | ## Prepare your source data Flat-file connectors (Zeotap Google Cloud Storage, SFTP Push, SFTP Pull, Amazon S3) and CRM connectors that export CSV read the file per RFC 4180. If a text field in the CSV contains a double-quote character, escape it by doubling the quote. An unescaped `"` inside a quoted field causes the parser to treat the following newline as part of the field and consume every subsequent row into that field — those rows do not land as profiles, and the record count in the source's activity view is lower than the row count of the input file. ```csv theme={null} id,first_name,last_name 1,John,Smith 2,Jane,"O""Brien" 3,Alex,"Yemni"" and family" ``` > [!WARNING] > > A single unescaped `"` in a CSV field silently drops every record after it in the same file. Validate flat-file exports against RFC 4180 before scheduling the source. ## Verify the source is integrated Open the sources list in Zeotap CDP and confirm the following for your new source: * The source's status shows as **Integrated**. * The **Map Source** action is available on the source's row. If **Map Source** is greyed out immediately after integration, reload the sources list — the action becomes available once the sources list refreshes. * The preview shows a sample of records read from the upstream system. * After the first scheduled run, the source's activity view lists a successful pull and an ingested record count that matches the row count of the input for the pull window. ## Troubleshooting Source runs fail at three points: reading data from the upstream system, parsing the records Zeotap received, and mapping the parsed records into the catalogue. The customer-visible symptoms below name each failure and where to inspect it. | Error string | What it means | Where to look | | - | - | - | | `Map Source` action disabled after integration | The source integrated, but the sources list has not refreshed to enable the mapping action | Reload the sources list; if the action stays disabled, open the source's detail view | | Records missing from profiles for a specific input file | The CSV contained an unescaped `"` in a text field, so the parser consumed the following rows into one field and dropped them | Compare the input row count to the ingested record count in the source's activity view for the affected file | | Scheduled pull runs at the wrong hour | Source trigger times are stored and evaluated in UTC; the visible schedule reflects that stored UTC hour | The source's schedule configuration on the source detail view | If the ingested record count for a scheduled run is zero and none of the above applies, open a support ticket with the source ID, the run timestamp, and a sample of the input file (or the upstream export job ID for API-based connectors). ## Next steps * [Explore the Web JavaScript source setup →](/articles/integrate-customer/creating-web-js-source-2676490558) * [Explore the HubSpot CRM source →](/articles/integrate-customer/hubspot-source) * [Explore the Snowflake data warehouse source →](/articles/integrate-customer/create-a-snowflake-source) * [Explore the SFTP (Pull) delta-fetch source →](/articles/integrate-customer/create-an-sftp-pull-source) * [Explore the full Sources and Destinations master list →](https://docs.zeotap.com/smart/project-integrations-master-list/integrations-master-list) ## FAQ > [accordion] What is the difference between CE and NCE data? > > Customer Entity (CE) data describes a person — an identifier such as email, phone, customer ID, or device ID, together with attributes attached to that person. Non-Customer Entity (NCE) data describes something other than a person — for example products, stores, or transactions — that you want to reference from customer profiles or use inside audiences and journeys. Connectors marked `CE + NCE` in the tables above accept both record types. > [accordion] Which connectors support delta fetch? > > HubSpot, SFTP (Pull), BigQuery, Amazon S3, and Databricks pull only new or changed records on each scheduled run. Every other connector in the tables above performs a full pull per run. > [accordion] Why does my scheduled source run at a different hour than I configured? > > Source trigger times are stored and evaluated in UTC. Convert the configured UTC hour to your local timezone before comparing it against the run time you observed. > [accordion] Does the Web JavaScript source affect page load performance? > > The Zeotap Collect Tag loads asynchronously and does not block the rest of the page. See the [Web JavaScript source](/articles/integrate-customer/creating-web-js-source-2676490558) for placement guidance. # Create an Emarsys source Source: https://docs.zeotap.com/articles/integrate-customer/creating-an-emarsys-source Pull email campaign response data and the associated contacts from Emarsys into Zeotap CDP by creating an Emarsys source. ## What this is An Emarsys source brings data **into** Zeotap CDP: it connects to your Emarsys account and pulls detailed email engagement data for a given email campaign, along with the contacts associated with that response data. In the Create Source dialog, the Emarsys tile describes itself as an integration with the SAP Emarsys platform to pull campaign and customer engagement data. Once the data is in Zeotap CDP, you can map it to the catalogue and use it for analysis and segmentation. For the wider description of what this integration does, see [Emarsys Source](/articles/integrate-customer/emarsys-source). For the opposite direction — sending audiences and events **out of** Zeotap CDP to Emarsys — see the [Emarsys destination](/articles/integrate-customer/emarsys) and the [Emarsys real-time integration](/articles/integrate-customer/emarsys-real-time-integration). ## Supported identifiers and fields You choose what the source ingests at the **Filter** step of source creation. The fields are offered in two groups: * **Filter analysis fields** — campaign and link-level fields such as Campaign title, Section header, Section group, Link title, URL, Time and Link category. * **Filter standard object fields** — contact fields such as Interests, Title, Salutation, First Name, Last Name and Email. Both lists are longer than the visible window and each has its own search box, so use **Search Fields** to find a field, or **Select All** / **Clear All** to set the whole group at once. ## Prerequisites Before you start, obtain the following from Emarsys: * **Client ID** and **Client secret** — created under **Management > Security Settings > API Credentials** in Emarsys. The Client secret is shown only once, so save it somewhere secure as soon as it is generated. For the full steps, and for the permissions the API credential needs, see [Getting Emarsys credentials](/articles/integrate-customer/getting-emarsys-credentials). * **Email Campaign ID** — the identifier of the Emarsys email campaign whose response data you want to pull. ## Create the Emarsys source **Step 1** Log into the Zeotap CDP App and navigate to the **Sources** application under **Integrate**. **Step 2** Click **CREATE SOURCE**. **Step 3** Choose **Customer Engagement Channels** as the Category. ![The Data Source step of the Create Source dialog, with Customer Engagement Channels selected from the list of source categories.](https://mintcdn.com/zeotap/49y1_9uVgJhUhPeD/articles/integrate-customer/Storage/integrate-customer/integrate-customer/working-with-the-source-listing-page/cec.png?fit=max\&auto=format\&n=49y1_9uVgJhUhPeD\&q=85\&s=104262dfa0aa70a3600c907670094be0) **Step 4** Click **Emarsys** as the Data Source. ![The Data Source step of the Create Source dialog, with Emarsys selected from the list of customer engagement channel integrations.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-33.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=47d2d80d84890f162400ccd63b9d0557) **Step 5** Enter a name for the source. **Step 6** Complete the rest of the Source Details form: * **Client ID** and **Client Secret** — the credentials you created in Emarsys. * **Sync frequency** — how often the source runs, chosen from the drop-down list. * **Data Entity** — Customer Data. To know more about the data entities Zeotap CDP supports, refer [here](/articles/unify-customer/supported-data-entities). * **Email Campaign ID** — the campaign whose response data you want to pull. * **Sources** — choose the source accordingly. Currently we only support one source at a time. * **Select your Region** — choose the region of upload. ![The lower half of the Source Details step, showing the Sync frequency, Data Entity, Email Campaign ID, Sources and region fields, with the Next button.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-35.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=f5f6a54c2351878423d1ffae37f033d6) **Step 7** Click **Next**. You will be able to choose from a variety of fields to ingest data. Select all that are needed and click **CREATE SOURCE**. ![The Filter step of the Create Source dialog, showing the Filter analysis fields list with a search box and Select All and Clear All controls.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-36.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=cdd9c6a5350d152e90c078eeb76198c0) ![The Filter step scrolled down to Filter standard object fields, listing contact fields such as Interests, Title, Salutation, First Name, Last Name and Email.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-37.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=cfe47b4ffce8c9721488372ffe712e14) ## Verify the source Upon successful creation, files start getting ingested and refreshed according to the sync frequency you selected. Open the source from the Sources listing page to check it: * The source header shows the source name and the **MAPPED** status. * The **SOURCE REPORT** tab shows the file ingestion details for the selected period, including the total files dropped and a per-file table of status, records ingested, size and type. To know more about what appears here, refer to [Source Report](/articles/integrate-customer/source-report). * The **IMPLEMENTATION DETAILS** tab shows the configuration of the created source. * The **PREVIEW DATA** tab shows the data flowing in. To know more about this tab, refer [here](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab). ![A created Emarsys source open on the Source Report tab, showing the source status, the total files dropped count and the file ingestion table.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-38.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=072c354a2c9408b58a0b843295b01cc7) Once data is arriving, map it to the catalogue from the **CATALOGUE MAPPING** tab. For the steps, refer to [Map the Catalogue for Customer Data](/articles/unify-customer/map-the-catalogue-for-customer-data). ## Troubleshoot the source * **Files are listed but records are not ingested.** Open the **SOURCE REPORT** tab and click **View Logs** against the file. The ingestion log explains the errors identified while ingesting a file or a record — see [Understanding the Ingestion Log Error](/articles/integrate-customer/understanding-the-ingestion-log-error). * **A field was mapped incorrectly.** You can change the mapping of an existing source from the **PREVIEW DATA** or **CATALOGUE MAPPING** tab — see [Editing a Catalogue Mapping](/articles/unify-customer/editing-a-mapping). ## Next steps > [card] [Map the catalogue](/articles/unify-customer/map-the-catalogue-for-customer-data) > [card] [Source Report](/articles/integrate-customer/source-report) > [card] [Emarsys destination](/articles/integrate-customer/emarsys) > [card] [Emarsys real-time integration](/articles/integrate-customer/emarsys-real-time-integration) # Create an Android SDK source Source: https://docs.zeotap.com/articles/integrate-customer/creating-android-sdk-source Create the Android Native SDK source in Zeotap CDP, choose its region, and collect the write key your Android app needs to start sending events. ## What this is The Android SDK source carries data **into** Zeotap CDP: your Android app sends events, page visit information, user logins and user properties to Zeotap through the Zeotap Collect Android SDK. It is a Customer Data (CE) source and does not carry non-customer entity (NCE) data. Setting it up is a two-part job and this page covers the first part. Creating the source in the CDP issues a **write key**; a developer then builds the SDK into the app and initialises it with that key. Nothing reaches the CDP until both parts are done. > [card] [Implementing the Android SDK?](/articles/sdks/android/intro) > > This page covers creating the source in the Zeotap CDP. For SDK installation, init options, and tracking methods, head to the **Android SDK** docs. For what this source is for and a worked example, see [Android SDK](/articles/integrate-customer/android-sdk). The equivalent source for Apple devices is [Create an iOS SDK Source](/articles/integrate-customer/create-an-ios-sdk-source). ## Supported identifiers Identifiers are not configured on the source — your app sets them through the SDK. The SDK accepts: * **Standardised PII**, such as email address and phone number, sent either raw or pre-hashed. * **Custom identifiers** of your own, such as a CRM ID or a loyalty ID. See [Track User Identities](/articles/sdks/android/api-reference/set-user-identities) for the method, the hashing options and which keys to use for each. ## Create the Android SDK source **1. Open Sources** In the Zeotap CDP App, go to **Integrate** and open the **Sources** application. **2. Start a new source** Click **Create Source**. **3. Choose the category** Under **Select category**, choose **App Events**. ![The Data Source step of source creation, listing the source categories with App Events selected.](https://mintcdn.com/zeotap/kEe8zTZlpZky9cq1/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/create_android_1.png?fit=max\&auto=format\&n=kEe8zTZlpZky9cq1\&q=85\&s=96affe4416f2666ac437059570dd075c) **4. Choose the data source** Under **Select data source**, choose **Android Native SDK**. ![The data sources available under App Events, with Android Native SDK selected.](https://mintcdn.com/zeotap/kEe8zTZlpZky9cq1/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/create_android_2.png?fit=max\&auto=format\&n=kEe8zTZlpZky9cq1\&q=85\&s=cdd4e1c332d414413624e5ebbc1336c4) **5. Name the source** On the **Source Details** step, enter a short, descriptive **Source Name**. This is how the source is identified on the Sources listing page, so make it specific to the app. **6. Pick the region** Choose an option under **Select your Region**. A link under the field opens the country-to-region mapping Zeotap uses; the same mapping is published as [Region of Storage](/articles/integrate-customer/region-of-storage). ![The Source Details step, showing the Source Name field and the region options.](https://mintcdn.com/zeotap/kEe8zTZlpZky9cq1/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/create_android_3.png?fit=max\&auto=format\&n=kEe8zTZlpZky9cq1\&q=85\&s=90e537e42cc0c35cd0696ec47a544025) **7. Create the source** Click **CREATE SOURCE**. The new source appears on the Sources listing page. **8. Collect the write key** Open the source and go to the **IMPLEMENTATION DETAILS** tab. It shows the source's status, created date and region, the **WRITE KEY**, and a link to download the Android Native SDK. Copy the write key and hand it to whoever is implementing the SDK. ![The Implementation Details tab of a newly created Android Native SDK source, showing the source status, the write key row and the SDK download link.](https://mintcdn.com/zeotap/kEe8zTZlpZky9cq1/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/create_android_4.png?fit=max\&auto=format\&n=kEe8zTZlpZky9cq1\&q=85\&s=7bd0c0ada27bad73760b8d9624dccffe) > [!NOTE] > > A newly issued write key is not live straight away. The tab asks you to wait about 30 minutes before sending data with it, while Zeotap creates the assets that receive data from that key. ## Verify the source A new source sits at status **Created** until it receives its first data. Once events start arriving it moves to **Integrated**, and you can inspect a sample of what came in on the **PREVIEW DATA** tab. It moves to **Mapped** once at least one data collection has been created on top of it. * [Components of the Preview Data Tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) — what the preview shows and how to refresh it. * [Components of the Source Listing Page](/articles/integrate-customer/components-of-the-source-listing-page) — every source status, the ingested-record counts and the actions available on a source. ## Troubleshoot the source **The source is still at Created and nothing has arrived.** Give a newly issued write key about 30 minutes before you expect data. Then confirm the app is initialised with the write key from *this* source: a key copied with stray spaces, or taken from a different source, is the usual cause. Check too that the SDK is actually initialised in the app; see the [Quick Start Guide](/articles/sdks/android/quick-start). **The PREVIEW DATA tab shows an error instead of a sample.** The tab states the reason. Address what it reports, make sure the source has been implemented as documented, and try again after a short wait. **Data was arriving and has stopped.** Check whether data collection has been paused on the source: pausing data collection invalidates the source's write key, so events sent with it are no longer collected. The three-dot **ACTIONS** menu on the Sources listing page offers pause and resume for both data collection and data ingestion, depending on the source type and status. ## Next steps > [card] [Quick Start Guide](/articles/sdks/android/quick-start) > > Add the SDK to the app and initialise it with the write key. > [card] [Write Key](/articles/sdks/android/configurations/write-key) > > Find the key again later and see where it goes in the init call. > [card] [Map the Catalogue for Customer Data](/articles/unify-customer/map-the-catalogue-for-customer-data) > > Map the incoming fields so the data can be used in audiences and journeys. > [card] [Source Report](/articles/integrate-customer/source-report) > > Check ingestion volumes and errors for the source. # Create a Salesforce CRM source Source: https://docs.zeotap.com/articles/integrate-customer/creating-salesforce-crm Bring standard and custom Salesforce objects into Zeotap CDP as a CRM Data source — set up a connected app, obtain a refresh token, then create and verify the source. ## What this is The Salesforce CRM source brings data **into** Zeotap CDP from your Salesforce account: you pick a Salesforce object and the fields you want from it, and Zeotap fetches those records on the sync frequency you choose. Data travels the other way — **out of** Zeotap CDP and into Salesforce — through the Salesforce CRM destinations. Use [Salesforce CRM (Sales and Service Cloud)](/articles/integrate-customer/salesforce-crm-sales-and-service-cloud) to send audience data to standard objects, or [Salesforce CRM Real Time Integration](/articles/integrate-customer/salesforce-crm-real-time-integration) to send records from a journey in real time. For an overview of the source and a worked use case, see [Salesforce CRM](/articles/integrate-customer/salesforce-crm). ## Supported objects and fields Zeotap automatically fetches all the standard and custom Salesforce objects created in your Salesforce account, and lists the fields available on the object you select. Some standard objects — Account, Contact, Lead, Case and Opportunity — contain columns that correspond to first-party user IDs, which can facilitate user matching. Make sure you ingest a user ID in those cases. For more on this and on country values, see [Best Practices for Salesforce CRM Source](/articles/integrate-customer/best-practices-for-salesforce-crm-source). You select one **Standard object** per source. Alongside the object and its fields, you choose: * **Record Type** – whether to ingest active records, deleted records, or all records. * **Custom Fields** – whether to also query relationship fields on that object. * **Fetch Mode** – whether every sync carries the full dataset, or only incremental updates after the first fetch. ## Prerequisites Before you create the source, make sure you have the following: * **A Salesforce account.** Create an account in [Salesforce](https://www.salesforce.com/in/?ir=1), or use your existing paid account. If you do not have a paid account, go to the [Salesforce Developer Edition](https://developer.salesforce.com/signup) and create a new developer account. Do not create a free trial account, as sometimes you cannot enable the API for your Salesforce account using a free trial account. * **A connected app** in your Salesforce org. See [Set up a connected app in Salesforce](#set-up-a-connected-app-in-salesforce). * **Consumer Key and Consumer Secret** from that connected app. See [Set the OAuth policies and read the consumer key and secret](#set-the-oauth-policies-and-read-the-consumer-key-and-secret). * **Refresh Token.** See [Obtain the refresh token](#obtain-the-refresh-token). * **Domain** – the part of the URL you log in to Salesforce with that comes before `.my.salesforce.com/`. For example, if you log in at `https://zeotap--devops.my.salesforce.com/`, your domain is `zeotap--devops`. * **Callback URL** – `https://login.salesforce.com/`. You set this on the connected app. > [!NOTE] > > **Note:** > > The first sync runs as soon as you create the source, and it retrieves the complete dataset for the object you selected. Subsequent syncs follow the sync frequency and the fetch mode you configured. Plan for that first load when the object holds a large history. ## Set up a connected app in Salesforce Zeotap reads your Salesforce data through a connected app that you create and own in your own Salesforce org. Create the app, set its OAuth policies, then use it to obtain an authorisation code and a refresh token. ### Create the connected app **Step 1** Log in to Salesforce as an Administrator. **Step 2** From the account drop-down list appearing in the top-right corner, click **Setup**. **Step 3** In the left-hand pane, go to **Apps > App Manager**. **Step 4** Click **New Connected App** in the top-right corner. **Step 5** On the **New Connected App** page, enter the following required fields under **Basic Information**: a. **Connected App Name** b. **API Name** c. **Contact Email** **Step 6** Go to **API (Enable OAuth Settings)** and select **Enable OAuth Settings**. a. In the **Callback URL** field, enter `https://login.salesforce.com/`. b. Under **Selected OAuth Scopes**, select the following options: i. **Access and manage your data (api)** ii. **Perform requests on your behalf at any time (refresh_token, offline_access)** iii. **Provide access to your data via the Web (web)** c. Click **Add**. **Step 7** Click **Save** to save the changes for the new connected app. ![The API (Enable OAuth Settings) section of a Salesforce connected app, with Enable OAuth Settings ticked, the Callback URL filled in, and three scopes moved into the Selected OAuth Scopes list.](https://mintcdn.com/zeotap/xGzkHY-dcQy5tLit/articles/integrate-customer/Storage/integrate-customer/Create_a%20_Connected_App.png?fit=max\&auto=format\&n=xGzkHY-dcQy5tLit\&q=85\&s=4f1ac2674dd6b775eb2b3be0ba37e979) ### Set the OAuth policies and read the consumer key and secret In the **Connected Apps** list (**Apps > App Manager**), perform the following steps: **Step 1** Find the app that you just created and then click **Manage**. **Step 2** On the page that opens, click **Edit**. **Step 3** Under **OAuth Policies**, make the following selections: a. In the **Permitted Users** drop-down list, select **All users may self-authorize**. b. For **Refresh Token Policy**, select **Refresh token is valid until revoked**. **Step 4** Save the changes. ![The OAuth Policies section of a connected app, showing Permitted Users set to All users may self-authorize and the Refresh Token Policy set to Refresh token is valid until revoked.](https://mintcdn.com/zeotap/5K-Zf-MYwWXwJWp5/articles/integrate-customer/Storage/integrate-customer/creating-salesforce-crm/Manage_a_Connected_App-1_\(1\).png?fit=max\&auto=format\&n=5K-Zf-MYwWXwJWp5\&q=85\&s=f8be21a1c0bc2e7e106d8504e08baec4) **Step 5** Go back to the **Connected Apps** list (**Apps > App Manager**). **Step 6** Click the app that you just created and then click **View**. **Step 7** Go to the **API (Enable OAuth Settings)** section and note down the **Consumer Key** and **Consumer Secret**. These two details are required while creating the Salesforce CRM source in the Zeotap CDP App. ![The API (Enable OAuth Settings) section of a saved connected app, with the Consumer Key row and the Consumer Secret row highlighted; the secret sits behind a Click to reveal link.](https://mintcdn.com/zeotap/5K-Zf-MYwWXwJWp5/articles/integrate-customer/Storage/integrate-customer/creating-salesforce-crm/Manage_a_Connected_App-2_\(1\).png?fit=max\&auto=format\&n=5K-Zf-MYwWXwJWp5\&q=85\&s=bda20d6544ade053745818d215b483a0) ### Obtain the authorisation code Perform the following steps to obtain the authorisation code from Salesforce: **Step 1** Log in to Salesforce as an Administrator. **Step 2** Enter the request URL mentioned below in a new tab to get the code. i. Replace `` with the Consumer Key that you obtained from the above section. ii. Replace `` with your domain name. ```bash Code theme={null} https://.my.salesforce.com/services/oauth2/authorize?response_type=code&client_id=&redirect_uri=https://login.salesforce.com/ ``` **Step 3** Allow access to alert pop-ups if any. Your browser is redirected to a URL as this - ```bash Code theme={null} https://login.salesforce.com/?code=aPrxYXyxzkuBzbDGdwv67qekAQredtrsWqty38LsdhfREyTRbvdjvTqdbvxPVC__4Cb9xGKDGErtOw%3D%3D ``` **Step 4** Obtain the authorisation code from the query string - `aPrxYXyxzkuBzbDGdwv67qekAQredtrsWqty38LsdhfREyTRbvdjvTqdbvxPVC__4Cb9xGKDGErtOw%3D%3D` ![A browser address bar after the redirect, with the code query-string parameter of the login.salesforce.com URL selected.](https://mintcdn.com/zeotap/5K-Zf-MYwWXwJWp5/articles/integrate-customer/Storage/integrate-customer/creating-salesforce-crm/Obtain_the_Authorisation_Code_\(1\).png?fit=max\&auto=format\&n=5K-Zf-MYwWXwJWp5\&q=85\&s=f53e32fb0de2f18563c1733d1ce2cbec) ### Obtain the refresh token **Step 1** Send the curl request mentioned below to Salesforce's own OAuth token endpoint to obtain the refresh token. You can use the Postman client to import the curl below and send the request. a. Replace `` with your domain. b. Replace `` with the authorisation code that you obtained from the above section. c. Replace `` and `` with the keys that you obtained while creating the connected app. ```bash Code theme={null} curl --request POST 'https://.my.salesforce.com/services/oauth2/token?code=&grant_type=authorization_code&client_id=&client_secret=&redirect_uri=https://login.salesforce.com/' ``` **Step 2** You can obtain the `refresh_token` from the response mentioned below. ```json Code theme={null} { "access_token":"00D2v000001XKxi__SOMETHING", "refresh_token":"5Aep861dlMxAL.LhVTuPRa__SOMETHING", "signature":"MK/YGMNQhPSSnKtYicXlaU__SOMETHING", "scope":"refresh_token web api", "instance_url":"https://ap15.salesforce.com", "id":"https://login.salesforce.com/id/00D2vKxiEAG/0045Q09vAAL", "token_type":"Bearer", "issued_at":"1570030000198" } ``` ## Create the Salesforce CRM source Once you have the connected app details, perform the following steps to create a Salesforce CRM source in the Zeotap CDP App: **Step 1** Navigate to the **Sources** application under **Integrate**, in the Zeotap CDP App. **Step 2** Click **CREATE SOURCE**. **Step 3** Choose **CRM Data** as the **Category**. ![Step 1 of the CREATE SOURCE wizard, Data Source, with the CRM Data category selected from the list of source categories.](https://mintcdn.com/zeotap/5K-Zf-MYwWXwJWp5/articles/integrate-customer/Storage/integrate-customer/creating-salesforce-crm/create_salesforce_1_\(1\).png?fit=max\&auto=format\&n=5K-Zf-MYwWXwJWp5\&q=85\&s=388421943bae89eaef3119eecbb90159) **Step 4** Click **Salesforce CRM** at the **Data Source**. ![The SELECT DATA SOURCE list showing Salesforce CRM selected, with Microsoft Dynamics CRM listed below it.](https://mintcdn.com/zeotap/5K-Zf-MYwWXwJWp5/articles/integrate-customer/Storage/integrate-customer/creating-salesforce-crm/creating-salesforce-crm-2024-09-19.png?fit=max\&auto=format\&n=5K-Zf-MYwWXwJWp5\&q=85\&s=e42aaf3e325ea63dd0259b75123d5f22) **Step 5** Enter a short and descriptive name for the source in **Source Name**. **Step 6** Under **Select your Region**, choose the region of upload. **Step 7** Choose the desired **Sync frequency** from the drop-down list. The first sync takes place once you create the source. However, the subsequent syncs take place based on the sync frequency you selected. Currently, we support the following sync frequencies: a. Sync once b. Every hour c. Every 3 hours d. Every 6 hours e. Every 12 hours f. Daily g. Weekly h. Monthly i. **Sync time** – When you choose **Daily**, **Weekly**, or **Monthly** as the sync frequency, you can specify the exact time for the sync to occur. ii. **Sync Period** – Indicates whether the selected **Sync time** is in the **AM** or **PM**. iii. **Monthly Sync date** – If **Monthly** sync is selected, you can specify the **day of the month** on which the sync should run. **Step 8** Enter the **Client ID**. This is the Consumer Key from your connected app — see [Set the OAuth policies and read the consumer key and secret](#set-the-oauth-policies-and-read-the-consumer-key-and-secret). **Step 9** Enter the **Client Secret**. This is the Consumer Secret from your connected app. **Step 10** Enter the **Refresh Token** as obtained under [Obtain the refresh token](#obtain-the-refresh-token). **Step 11** Enter the **Domain**. **Step 12** Under **Data Entity**, depending on the type of data you want to ingest, choose either **Customer Data** or **Non Customer Data** and proceed with the source creation. To know more about Customer Data and Non Customer Data, refer to [Supported Data Entities](/articles/unify-customer/supported-data-entities). **Step 13** Under **Fetch Mode**, select either **Full** or **Delta** based on the requirement. a. **Full** – Receives all available data during the initial fetch and thereafter consistently fetches data as per the sync frequency configured. b. **Delta** – Receives all available data during the initial fetch and thereafter exclusively gathers incremental updates (deltas) as per the sync frequency configured. ![Step 2 of the wizard, Source Details, showing the Source Name, Select your Region, Sync frequency and Sync time fields.](https://mintcdn.com/zeotap/5K-Zf-MYwWXwJWp5/articles/integrate-customer/Storage/integrate-customer/creating-salesforce-crm/creating-salesforce-crm-2025-09-10-3.png?fit=max\&auto=format\&n=5K-Zf-MYwWXwJWp5\&q=85\&s=4bf4010b8ca313ede95554c33cd6231b) **Step 14** Choose from the drop-down what **Record Type** you want to ingest: a. **Active Records** — All non-deleted records. b. **Deleted Records** — All deleted records. c. **All Records** — All records. **Step 15** If you want to add custom relationship fields, set the **Custom Fields** option to **true** and enter the fields you want to ingest in the **Relationship Fields** box that appears. ![The Record Type drop-down set to All Records, Custom Fields set to true, and a Relationship Fields box containing two relationship field names.](https://mintcdn.com/zeotap/5jqEMeXCr_Lmm-mS/articles/integrate-customer/Storage/integrate-customer/creating-salesforce-crm/creating-salesforce-crm-record-type-custom-fields.png?fit=max\&auto=format\&n=5jqEMeXCr_Lmm-mS\&q=85\&s=f2db12339ee65534cff9994577526187) > [!NOTE] > > **Note:** > > The relationship fields must be related to the object you are ingesting — otherwise the query will not work. > > The relationship fields must be added in the same format as they are used in a query. For example: `Owner.Name, Parent.Name` for the Account object. **Step 16** Choose the appropriate **Standard object**. We automatically fetch all the standard and custom Salesforce objects created in your Salesforce account. ![The lower half of the Source Details step, showing the Refresh Token, Domain, Data Entity, Fetch Mode and Standard object fields.](https://mintcdn.com/zeotap/5K-Zf-MYwWXwJWp5/articles/integrate-customer/Storage/integrate-customer/creating-salesforce-crm/creating-salesforce-crm-2025-09-10.png?fit=max\&auto=format\&n=5K-Zf-MYwWXwJWp5\&q=85\&s=0e442b1f2d1a1a98a3b8e351b363183d) ![The Standard object drop-down open, listing Salesforce objects in alphabetical order.](https://mintcdn.com/zeotap/5K-Zf-MYwWXwJWp5/articles/integrate-customer/Storage/integrate-customer/creating-salesforce-crm/creating-salesforce-crm-2025-09-10-2.png?fit=max\&auto=format\&n=5K-Zf-MYwWXwJWp5\&q=85\&s=1d37e15c7ce36953ff45cf51149b3f5e) **Step 17** Click **Next** to proceed to fields selection. **Step 18** In the **Filter** step that appears, a list of fields is displayed, based on the object selected in the previous step. You can select the desired fields using the check boxes. Use **Select All** to select all the fields available for that object in your Salesforce account, or **Clear All** to clear the selection. If you know the field names, you can select them after searching in the **Search Fields** box. ![Step 3 of the wizard, Filter, with the FILTER STANDARD OBJECT FIELDS panel, a Search Fields box, Select All and Clear All links, and a checkbox list of object fields. Callouts point at the search box and at the two links.](https://mintcdn.com/zeotap/5K-Zf-MYwWXwJWp5/articles/integrate-customer/Storage/integrate-customer/creating-salesforce-crm/creating-salesforce-crm-2024-07-02-2.png?fit=max\&auto=format\&n=5K-Zf-MYwWXwJWp5\&q=85\&s=3982bb12d54022564c8b89e1008f8f92) > [!NOTE] > > **Note:** > > *Ensure that you consider the following points while choosing the fields in the above step:* > > * *Currently, editing the field selection after source creation is not allowed. If you wish to do so, then you need to create a new source in Zeotap CDP.* > * *Zeotap CDP does not support the following compound fields (nested objects) and choosing them during source creation might cause ingestion failure:* > * `PersonMailingAddress ` > * `PersonOtherAddress` > * `ShippingAddress` > * `BillingAddress` > * `Address` > * `MailingAddress` > * `OtherAddress` > * `Subject` > * `Description` > * `Comments` **Step 19** Review the selected fields and click **Create Source**. ## Verify the source **Step 1** The created Salesforce CRM source is listed on the source listing page. ![The Sources listing page filtered to the CRM Data category, showing source rows with their ID, name, status, total records, last ingested and created date.](https://mintcdn.com/zeotap/5K-Zf-MYwWXwJWp5/articles/integrate-customer/Storage/integrate-customer/creating-salesforce-crm/SF_CRM.png?fit=max\&auto=format\&n=5K-Zf-MYwWXwJWp5\&q=85\&s=2f3453fe1221ca08be261e4978892fc7) **Step 2** Open the source and check the **IMPLEMENTATION DETAILS** tab. It shows who created the source and when, the region, sync frequency, data entity, fetch mode and standard object, the access details you entered, and the fields selected for the object. ![The IMPLEMENTATION DETAILS tab of a created Salesforce CRM source, with the summary row, the Access Details section and the Selected Fields chips. The source is marked INTEGRATED.](https://mintcdn.com/zeotap/5K-Zf-MYwWXwJWp5/articles/integrate-customer/Storage/integrate-customer/creating-salesforce-crm/creating-salesforce-crm-2024-07-02-3.png?fit=max\&auto=format\&n=5K-Zf-MYwWXwJWp5\&q=85\&s=56b5e0171066ed908a4ad39d7b28a059) **Step 3** Once the connection between Zeotap and Salesforce is established, you can view the data flowing into the system under the **PREVIEW DATA** tab. Once data starts flowing in, the status of the source changes to *Integrated*. See [Components of the Preview Data Tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab). **Step 4** Use the **SOURCE REPORT** tab to check how many records were received, ingested and failed. See [Exploring Source Reports](/articles/integrate-customer/exploring-source-reports). ## Troubleshoot the Salesforce CRM source > [accordion] 'REST API is not enabled for this Organization' > > This error denotes that the REST API is not enabled for this organisation. Perform the following steps in Salesforce to resolve it: > > **Step 1** > > Click the gear icon in the top-right corner and then click **Setup**. > > ![The Salesforce gear menu open in the top-right corner, with Setup at the top of the menu.](https://mintcdn.com/zeotap/xGzkHY-dcQy5tLit/articles/integrate-customer/Storage/integrate-customer/Errors_Encountered-1_\(1\).png?fit=max\&auto=format\&n=xGzkHY-dcQy5tLit\&q=85\&s=df8d8d2fdd407674df5c307cceef3231) > > **Step 2** > > Under **ADMINISTRATION**, go to **Users** and click **Profiles**. > > ![The Salesforce Setup left-hand pane with the ADMINISTRATION section expanded and Profiles selected under Users.](https://mintcdn.com/zeotap/xGzkHY-dcQy5tLit/articles/integrate-customer/Storage/integrate-customer/Errors_Encountered-2_\(1\).png?fit=max\&auto=format\&n=xGzkHY-dcQy5tLit\&q=85\&s=8c857af23e0c1d09d7b5cfa74264eb02) > > **Step 3** > > Click **Edit** for the specific profile that you want to update. > > **Step 4** > > Under the **Administrative Permissions** section, select the **API Enabled** checkbox. > > ![The Administrative Permissions grid on a Salesforce profile, with the API Enabled checkbox highlighted and ticked.](https://mintcdn.com/zeotap/xGzkHY-dcQy5tLit/articles/integrate-customer/Storage/integrate-customer/Errors_Encountered-3_\(1\).png?fit=max\&auto=format\&n=xGzkHY-dcQy5tLit\&q=85\&s=eeae13d3e8dbdf6b6f3a99d850b2748d) > > **Step 5** > > Scroll to the bottom of the page and click **Save** to save your changes. > [accordion] Records are ingested but some of them fail > > Open the source and check the **SOURCE REPORT** tab: it shows the total records received, in progress, ingested and failed for the source. See [Exploring Source Reports](/articles/integrate-customer/exploring-source-reports). > > Two common causes are worth ruling out first: > > * **Compound fields were selected.** Zeotap CDP does not support the compound fields listed above, and selecting them during source creation might cause ingestion failure. > * **Country values are missing or invalid.** Records must be tied to a country, with valid values in the country column, and the data must belong to the region you selected. See [Best Practices for Salesforce CRM Source](/articles/integrate-customer/best-practices-for-salesforce-crm-source). > [accordion] You need to change which fields the source ingests > > Editing the field selection after source creation is not allowed. To ingest a different set of fields, create a new source in Zeotap CDP with the selection you want. ## Next steps * Map the ingested fields to Zeotap's catalogue — see [Map the Catalogue for Customer Data](/articles/unify-customer/map-the-catalogue-for-customer-data). * Review [Best Practices for Salesforce CRM Source](/articles/integrate-customer/best-practices-for-salesforce-crm-source) before you add more objects. * For background on the data you are ingesting, see [Customer Data](/articles/unify-customer/customer-data). * To send audience data back to Salesforce, see [Salesforce CRM (Sales and Service Cloud)](/articles/integrate-customer/salesforce-crm-sales-and-service-cloud) or [Salesforce CRM Real Time Integration](/articles/integrate-customer/salesforce-crm-real-time-integration). # Create an SFTP (Push) Source Source: https://docs.zeotap.com/articles/integrate-customer/creating-sftp-push-source Create the flat-file source that gives you an SFTP folder hosted by Zeotap CDP, then push your CSV or JSON files into it for ingestion. ## What this is The SFTP (Push) source brings batch files **into** Zeotap CDP. Zeotap CDP hosts the SFTP folder, issues the credentials for it, and you upload your CSV or JSON files from your own server to that folder — Zeotap CDP then ingests what lands there. Use this source when you want to control the timing of each delivery and would rather push files than expose an SFTP server of your own. This page covers creating the source in the Zeotap CDP App. The upload itself — folder structure, commands, and file specifications — is covered in [Implement the SFTP (Push) source](/articles/integrate-customer/implementing-sftp-push-source). For background on the protocol and both SFTP source types, see [SFTP (Secure File Transfer Protocol)](/articles/integrate-customer/sftp-secure-file-transfer-protocol). ## Prerequisites > [!NOTE] > > Before you create the source, confirm: > > * You have access to the **Sources** application in the Zeotap CDP App, under **Integrate**, with permission to create a source. > * Your data is in CSV or JSON format, and every record carries at least one identifier. For optimal user matching, provide both your organisation's first-party user ID and a digital identifier such as a MAID. > * You know which **Region** your data must be stored in, and whether it is **Customer Data** or **Non Customer Data**. See [Region of storage](/articles/integrate-customer/region-of-storage) and [Supported data entities](/articles/unify-customer/supported-data-entities). > * You have decided whether the files will be PGP-encrypted. **PGP Encrypted** is one of the fields you set while creating the source. See [PGP encryption in sources](/articles/integrate-customer/pgp-encryption-in-sources). > * Your Zeotap Admin has whitelisted the IP address you will upload from. ## How the Push and Pull SFTP sources differ Both SFTP sources move batch files into Zeotap CDP; they differ in who owns the SFTP server and who initiates the transfer. Create the one that matches where the folder lives. | | SFTP (Push) — this page | [SFTP (Pull)](/articles/integrate-customer/create-an-sftp-pull-source) | | - | - | - | | Who hosts the SFTP folder | Zeotap CDP | You | | Who moves the files | You upload files from your server using SFTP | Zeotap CDP pulls from your external SFTP server | | Credentials | Zeotap CDP issues a **User ID**, **Server IP** and **Private Key** on the source's **IMPLEMENTATION DETAILS** tab | You supply the **User Id**, **Host** and **Port** of your server at creation; Zeotap CDP authenticates with a User ID/Password or SSH keys | | Scheduling | You decide when to upload | You set a **Sync Frequency** at creation | | Implementation guide | [Implement the SFTP (Push) source](/articles/integrate-customer/implementing-sftp-push-source) | [Implement the SFTP (Pull) source](/articles/integrate-customer/implement-the-sftp-pull-source) | ## Create the SFTP (Push) source Perform these steps in the Zeotap CDP App: 1. Navigate to the **Sources** application under **Integrate**. 2. Click **Create Source**. 3. Choose **Flat Files** as the Category. ![Select Category step of the Create Source dialog, with Flat Files selected](https://mintcdn.com/zeotap/1FGgO964H8EKim6t/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/create_sftp_1.png?fit=max\&auto=format\&n=1FGgO964H8EKim6t\&q=85\&s=d007fc111e64f8c7de344b5c07b00da5) 4. Click **SFTP(Push)** as the Data Source. ![Select Data Source step of the Create Source dialog, with SFTP(Push) selected alongside SFTP(Pull) and Zeotap Google Cloud Storage](https://mintcdn.com/zeotap/5K-Zf-MYwWXwJWp5/articles/integrate-customer/Storage/integrate-customer/creating-sftp-push-source/creating-sftp-push-source-2023-11-20.png?fit=max\&auto=format\&n=5K-Zf-MYwWXwJWp5\&q=85\&s=9cddb470b529e88c0f4b75d1ac108346) 5. In the **Source Details** window that appears, provide the following details: 1. Enter a short and descriptive **name** for the source. 2. Choose the **file type** for sending data to Zeotap CDP using the drop-down menu. 3. Choose the **delimiter** and the **Region** of upload. To map a country to a region, see [Region of storage](/articles/integrate-customer/region-of-storage). 4. Under **Data Entity**, choose either **Customer Data** or **Non Customer Data**, depending on the type of data you want to ingest. See [Supported data entities](/articles/unify-customer/supported-data-entities). 5. Under **PGP Encrypted**, select **True** or **False**, depending on whether you want to encrypt your data before sending it to Zeotap CDP. If you select **True**, you can download the PGP public key from the **Implementation Details** tab after source creation. See [PGP encryption in sources](/articles/integrate-customer/pgp-encryption-in-sources). ![Source Details step showing the Source Name, file type, Region, Data Entity and PGP encrypted fields, with JSON selected as the file type](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-29.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=0184cd382e416801c3d666eb894ba4eb) 6. Click **Create Source**. > [!WARNING] > > Creating the source in the app is only the first half of the setup. After you create an SFTP (Push) source, raise a ticket with Zeotap's Support Team to complete the source creation process. Your Zeotap Admin must also whitelist the IP address you will upload from — you cannot proceed with the integration if your IP is not whitelisted. > [!NOTE] > > You can create a maximum of five Non-Customer Entity (NCE) sources in an account. This default limit applies to both archived and active NCE sources within an organisation. To increase the limit, reach out to your Zeotap POC. ## Verify the source was created The source is ready for implementation when all of the following are true: * The new source appears on the **Available** tab of the source listing page with the **Created** status. * The source's **IMPLEMENTATION DETAILS** tab lists, under **Access Details**, the **User ID**, the **Server IP**, and a link to download the **Private Key**. * If you set **PGP Encrypted** to **True**, the same tab also offers the PGP public key for download. The source stays at **Created** until data arrives. After your first successful file upload, its status changes from **Created** to **Integrated** under the **SOURCES** tab, and the records appear in the source's **[PREVIEW DATA](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab)** tab. ## Troubleshoot source creation | Condition | What it means | Where to look | | - | - | - | | You cannot connect to the SFTP folder to upload files | Your upload IP may not be whitelisted — you cannot proceed with the integration if it is not | Confirm with your Zeotap Admin that your upload IP is whitelisted | | The source stays at **Created** after you upload a file | Zeotap CDP has not registered a successful upload for this source yet | The folder structure and file name you uploaded — see [Implement the SFTP (Push) source](/articles/integrate-customer/implementing-sftp-push-source) | | The **IMPLEMENTATION DETAILS** tab offers no PGP public key | The source was created with **PGP Encrypted** set to **False**; the public key is offered on the source's **Implementation Details** tab only when it is set to **True** | The **PGP Encrypted** value on the source, and [PGP encryption in sources](/articles/integrate-customer/pgp-encryption-in-sources) | | An encrypted file is uploaded but never ingested | PGP files must carry the `.pgp` extension and sit under the `pgpencrypted/` folder path | Your uploaded file name and folder path — see [PGP encryption in sources](/articles/integrate-customer/pgp-encryption-in-sources) | | You have already created five NCE sources | Five is the default per-account limit, and archived NCE sources count towards it | The **ARCHIVED** tab of the source listing page; contact your Zeotap POC to increase the limit | ## FAQ > [accordion] Should I create a Push source or a Pull source? > > Create an SFTP (Push) source when the SFTP folder is hosted at Zeotap CDP's end and you want to push files to it. Create an [SFTP (Pull) source](/articles/integrate-customer/create-an-sftp-pull-source) when the SFTP folder is hosted at your end and Zeotap CDP should pull the data from it, authenticating with either a User ID/Password or SSH keys. > [accordion] Do I have to do anything after clicking Create Source? > > Yes. Raise a ticket with Zeotap's Support Team to complete the source creation process, and have your Zeotap Admin whitelist the IP address you will upload from. Then follow [Implement the SFTP (Push) source](/articles/integrate-customer/implementing-sftp-push-source) to download the private key and upload your first file. > [accordion] Where do I find the SFTP credentials for the folder? > > On the source's **IMPLEMENTATION DETAILS** tab, under **Access Details** — it lists the **User ID**, the **Server IP**, and a link to download the **Private Key**. Download the private key and keep a note of the User ID and Server IP; they are required later in the implementation. > [accordion] Which file formats can I push to the folder? > > Text files with field delimiters such as comma, tab or semicolon and a newline record delimiter, or text files with JSON records. When you select CSV or JSON as the file format, the supported extensions are `.csv`, `.txt` and `.txt.gz`. For the full upload specifications, including schema and PII handling, see [Implement the SFTP (Push) source](/articles/integrate-customer/implementing-sftp-push-source). > [accordion] Can I encrypt the files before I push them? > > Yes. Set **PGP Encrypted** to **True** while creating the source, then download the PGP public key from the **Implementation Details** tab and encrypt each file with it before upload. Encrypted files must carry the `.pgp` extension and go under the `pgpencrypted/` folder path. See [PGP encryption in sources](/articles/integrate-customer/pgp-encryption-in-sources). ## Next steps * [Explore how to implement the SFTP (Push) source →](/articles/integrate-customer/implementing-sftp-push-source) * [Explore the SFTP (Pull) source →](/articles/integrate-customer/create-an-sftp-pull-source) * [Explore PGP encryption in sources →](/articles/integrate-customer/pgp-encryption-in-sources) * [Explore the fields on the PREVIEW DATA tab →](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) * [Explore how to map the Catalogue for Customer Data →](/articles/unify-customer/map-the-catalogue-for-customer-data) * [Explore how to map the Catalogue for Non-Customer Entity data →](/articles/unify-customer/map-the-catalogue-for-non-customer-entity-data) * [Explore how to add a Non-Customer Entity attribute in the Catalogue →](/articles/unify-customer/adding-a-non-customer-entity-category) * [Explore how to configure the Join Key Enricher →](/articles/unify-customer/configuring-the-join-key-enricher) # Create a Google Tag Manager Source Source: https://docs.zeotap.com/articles/integrate-customer/creating-tag-manager-source-2676490586 Create the Zeotap CDP source that receives web events and user data from the Zeotap Collect Tag running in your Google Tag Manager container. ## What this is A Google Tag Manager source brings data **into** Zeotap CDP: it is the entry point that receives the events and user information the Zeotap Collect Tag captures as customers navigate your website, and it issues the write key that tag is configured with. You create the source first, in the Zeotap CDP application; you then configure the Zeotap Collect Tag inside your Google Tag Manager (GTM) container, which is covered on [Implement the Google Tag Manager Source](/articles/integrate-customer/implementing-google-tag-manager-source-2665775403). Google Tag Manager is one of the two tag managers Zeotap integrates with. The other is the [Adobe Experience Platform Tag Extension](/articles/integrate-customer/adobe-experience-platform-tag-extension), which has its own [create page](/articles/integrate-customer/create-an-adobe-experience-platform-tag-extension-source). ## Prerequisites > [!NOTE] > > Before you create the source, confirm: > > * You can open the **Sources** application under **Integrate** in Zeotap CDP and create sources there. > * You know the **region of upload** for the data this source will carry. > * You have decided on a short, descriptive source name. Zeotap treats each source as one origin of data, so if you send events from more than one website, create a separate source for each — see [Sources](/articles/integrate-customer/sources). > * For the implementation that follows, you have a Google Tag Manager account with the GTM container installed on your site, and a data layer set up to carry the event information you want to capture. See [Google Tag Manager](/articles/integrate-customer/google-tag-manager). ## Create the Google Tag Manager source ### 1. Open the Sources application Navigate to the **Sources** application under **Integrate** in the Zeotap CDP application, then click **CREATE SOURCE**. ### 2. Choose Tag Managers as the category Choose **Tag Managers** as the **Category**. ![Source creation screen with Tag Managers selected as the source category](https://mintcdn.com/zeotap/kEe8zTZlpZky9cq1/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/create_gtm_1.png?fit=max\&auto=format\&n=kEe8zTZlpZky9cq1\&q=85\&s=ec22475a5b0a835aabaf9b118be5b61e) ### 3. Choose Google Tag Manager as the data source Click **Google Tag Manager** as the **Data Source**. ![Tag Managers category expanded, with Google Tag Manager selected as the data source](https://mintcdn.com/zeotap/kEe8zTZlpZky9cq1/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/create_gtm_2.png?fit=max\&auto=format\&n=kEe8zTZlpZky9cq1\&q=85\&s=1907f9368360d448e6e13a51da4f3f6d) ### 4. Name the source and set the region and data entity Enter a short and descriptive name for the source. Then choose the **region of upload**, and choose **Data Entity** as **Customer Data**. To know more about the data entities Zeotap supports, see [Supported Data Entities](/articles/unify-customer/supported-data-entities). ![Source configuration form showing the source name, region of upload and Data Entity set to Customer Data](https://mintcdn.com/zeotap/Yl1hDNuL3ftKLMn2/articles/integrate-customer/Storage/integrate-customer/creating-tag-manager-source-2676490586/creating-tag-manager-source-2676490586-2024-12-17.png?fit=max\&auto=format\&n=Yl1hDNuL3ftKLMn2\&q=85\&s=0ebc2b05ec2dd17de0c92786f1160126) ### 5. Create the source Click **CREATE SOURCE**. **Expected result:** the new source appears on the **SOURCES** listing page, and Zeotap generates a write key for it. The write key is shown in the source details, and it is the value you enter in the **Write Key** field when you configure the Zeotap Collect Tag in GTM — it is mandatory for recording events. ## Verify the source Creating the source does not by itself start data flowing — the source only receives data once the Zeotap Collect Tag is configured and live in your GTM container. 1. Confirm the source is listed on the **SOURCES** listing page with the name you entered. 2. Complete the tag configuration in GTM, following [Implement the Google Tag Manager Source](/articles/integrate-customer/implementing-google-tag-manager-source-2665775403). 3. Once the source has been taken live, open the **[PREVIEW](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab)** tab on the source to see incoming data. When data begins flowing, the source status changes to **Integrated** and the Preview Data tab is populated. While the status is still **Created**, no data has arrived yet. ## Troubleshoot the new source | Symptom | What it means | Where to look | | - | - | - | | The Preview Data tab is empty and the source status is still **Created** | No data has reached the source yet — the tag configuration is not live | Complete [Implement the Google Tag Manager Source](/articles/integrate-customer/implementing-google-tag-manager-source-2665775403), then check the tag fires in the GTM Tag Assistant preview | | The tag fires in GTM but nothing arrives on the source | The tag is sending to a different write key than the one this source issued | The **Write Key** field of the Zeotap Collect Tag in GTM, compared against the write key in this source's details | | The source previously received data and has stopped | The source may have been [archived](/articles/integrate-customer/archived-source) — all future ingestion is paused until the source is unarchived | The source's state on the **SOURCES** listing page | ## FAQ **Can I use this source for a tag manager other than Google Tag Manager?** No. This source type is Google Tag Manager. For Adobe Experience Platform Tag Extension, create [an Adobe Experience Platform Tag Extension source](/articles/integrate-customer/create-an-adobe-experience-platform-tag-extension-source) instead. Both sit under the [Tag Managers](/articles/integrate-customer/tag-managers) category. **Why do I choose Customer Data as the Data Entity?** Tag Manager sources carry Customer Data (CE) only — see the data supported per source on [Source Integrations (Batch+Real-Time)](/articles/integrate-customer/creating-a-source). **Do I need my GTM account ready before I create the source?** You can create the source first — the write key it generates is what you carry into GTM. But before you can implement the tag, you need a GTM account with the container installed on your site. ## Next steps * Explore [Implement the Google Tag Manager Source →](/articles/integrate-customer/implementing-google-tag-manager-source-2665775403) to add and configure the Zeotap Collect Tag template in your GTM container. * Explore [Google Tag Manager →](/articles/integrate-customer/google-tag-manager) for what the Zeotap Collect Tag captures and the data layer it depends on. * Explore [Map the Catalogue for Customer Data →](/articles/unify-customer/map-the-catalogue-for-customer-data) to map the incoming fields once data arrives. * Explore [Components of the Preview Data Tab →](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) to read the sample of ingested records before you map it. * Explore [Region of Storage →](/articles/integrate-customer/region-of-storage) for the country-to-region mapping Zeotap uses to store data. # Create a Web JavaScript source Source: https://docs.zeotap.com/articles/integrate-customer/creating-web-js-source-2676490558 Create a Web JavaScript source so the zeotap.js library can send website event data from your own site into Zeotap CDP. ## What this is A Web JavaScript source brings data **into** Zeotap CDP. The `zeotap.js` client-side library runs on your own website and sends what it tracks — page visits, user logins, user details and any other activity you choose to track — to the source you create here. Data flows one way, into the platform; to send data back out to a partner platform, use a [destination](/articles/integrate-customer/destinations). > [card] [Implementing the Web JS SDK?](/articles/sdks/web-js/quick-start) > > This page covers creating the Source in the Zeotap CDP. For SDK installation, init options, tracking methods, and consent, head to the **Web JavaScript SDK** docs. Web JavaScript is one of the **Website Events** data sources. To track visitors with a pixel or an iframe instead, see [Create a Web Pixel/Web iFrame/App Pixel Source](/articles/integrate-customer/2676392376). For background on the source itself, see [Web JavaScript SDK](/articles/integrate-customer/web-javascript). | | | | - | - | | **Category** | Website Events | | **Data source** | Web JavaScript | | **Data supported** | Customer Data (CE) only | | **Delta fetch supported** | No | ## Prerequisites * Access to the **Sources** application under **Integrate** in the Zeotap CDP App. * Someone who can add a script to the `` of your website. The SDK snippet goes in after the source exists. ## Create the Web JavaScript source **1. Open Sources** Navigate to the **Sources** application under **Integrate**, in the Zeotap CDP App. **2. Start a new source** Click **Create Source**. **3. Choose the category** Under **Select category**, choose **Website Events**. ![The Create Source dialog on the Data Source step, with Website Events selected under Select category alongside App Events, Flat Files, Server to Server, Tag Managers, CRM Data and Data Warehouse.](https://mintcdn.com/zeotap/1FGgO964H8EKim6t/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/create_wjs_1.png?fit=max\&auto=format\&n=1FGgO964H8EKim6t\&q=85\&s=7f32ba4ede3b8c09ed8f5a2645d6021e) **4. Choose the data source** Under **Select data source**, choose **Web JavaScript**. ![The Select data source step with Web JavaScript selected, listed above the other two Website Events options, Web Pixel API and IFrame.](https://mintcdn.com/zeotap/1FGgO964H8EKim6t/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/create_wjs_2.png?fit=max\&auto=format\&n=1FGgO964H8EKim6t\&q=85\&s=212670a2efcc57b8521c3cd34ad0d284) **5. Name the source** On the **Source Details** step, enter a short and descriptive **Source Name**. This field is required. **6. Add the website URL** Add the **Website URL**. The Website URL is optional, but we recommend that you add it in order to track the websites being onboarded. **7. Select the region** Under **Select your Region**, choose where this source's data is stored. This field is required. To check which region a country maps to, see [Region of Storage](/articles/integrate-customer/region-of-storage). ![The Source Details step with a source name and website URL filled in, and Europe (EU) ticked under Select your Region next to a United Kingdom (UK) option.](https://mintcdn.com/zeotap/1FGgO964H8EKim6t/articles/integrate-customer/Storage/integrate-customer/working-with-the-source-listing-page/create_wjs_3.png?fit=max\&auto=format\&n=1FGgO964H8EKim6t\&q=85\&s=db59ea648eef18ac5f09d9ec8d73d0b8) **8. Create the source** Click **CREATE SOURCE**. The created source appears on the **SOURCES** listing page. ## Add the SDK to your website Open the new source from the listing page and go to its **IMPLEMENTATION DETAILS** tab. The tab holds the snippet code and the authorisation key for this source. The Web JavaScript SDK docs refer to that key as the [write key](/articles/sdks/web-js/configurations/write-key) — it is the value you pass when the library initialises. Paste the snippet into the `` of your website, then set user identities and start tracking events. The [Quick Start Guide](/articles/sdks/web-js/quick-start) walks through all three, and the [Web JavaScript SDK docs](/articles/sdks/web-js/intro) cover configuration options, consent and the full API. ## Verify the source is receiving data Once the source has been taken live based on the implementation steps available, use the **[PREVIEW DATA](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab)** tab to see incoming data. Once data starts flowing into the system, the status of the source changes to **Integrated**. For ingestion health and event counts over time, see the [Source Report](/articles/integrate-customer/source-report). ## Troubleshoot the source **The snippet is live but no data reaches the source.** Check the consent configuration on your site. If you initialised the SDK with `useConsent: true`, it queues events until a consent signal arrives — so a consent management platform that has not granted consent — or a consent call that never runs — holds the data at the browser. See [Consent Strategy](/articles/sdks/web-js/consent/consent-strategy). **Columns look duplicated, or the preview and mapping are unavailable.** Two tracked fields sharing a name produce duplicate columns and can make the preview and the mapping unavailable for the source. Field names are converted to lower case when the schema is generated, so names that differ only by capitalisation count as the same name. Give every field you track a distinct name. ## Next steps * [Quick Start Guide](/articles/sdks/web-js/quick-start) — install the snippet, set user identities and start tracking events. * [Map the Catalogue for Customer Data (CE)](/articles/unify-customer/map-the-catalogue-for-customer-data) — map the fields this source collects so they can be used downstream. * [Customer Data](/articles/unify-customer/customer-data) — what Customer Data (CE) means in Zeotap CDP. * [Source Integrations (Batch+Real-Time)](/articles/integrate-customer/creating-a-source) — the full list of sources Zeotap CDP supports. # Criteo Source: https://docs.zeotap.com/articles/integrate-customer/criteo Send Zeotap CDP audience identifiers to your Criteo Ad Account as contact lists for activation. This page covers the Criteo destination, which sends audience identifiers from Zeotap CDP to your Criteo Ad Account. For uploading offline transaction data such as in-store purchases, see [Criteo Offline Sales Reporting](/articles/integrate-customer/criteo-offline-sales-reporting). For activating audiences on Criteo Retail Media (retailer and marketplace placements), see [Criteo Retail Media](/articles/integrate-customer/criteo-retail-media). ## What this is Criteo is a digital advertising platform for self-service ad campaigns and audience targeting. The Zeotap CDP Criteo destination is a batch integration that sends audience identifiers to your Criteo Ad Account so the audience can be activated as a Criteo contact list. The integration is configured once per Criteo Ad Account and then reused by every audience you link to it; users who fall out of the audience are removed from the contact list automatically. ## Supported identifiers The Criteo destination accepts the following identifier types: * Mobile advertising IDs (MAIDs) * Raw email addresses * Hashed email addresses (SHA-256) * Criteo Cookies (Gum IDs) ## Available actions | Action | ID Extension | Delete | Delta Upload | | - | - | - | - | | Send identifiers to Criteo | ✅ | ✅ | — | The destination exposes a single action, **Send identifiers to Criteo**. It supports [ID Extension](/articles/segment-customer/extend-your-audience#id-extension) for expanding an audience against Criteo's graph and [Delete](/articles/segment-customer/delta-upload-and-delete-functions) for removing users from the Criteo contact list when they no longer qualify. Delta Upload is not supported — each refresh sends the full qualifying set rather than only the changes. ## Prerequisites > [!NOTE] > > Before you configure the destination, gather: > > * **Your Criteo Advertiser ID** (also called the Criteo Ad Account ID). This is the only Criteo identifier the integration requires. > * **A single-use authorization URL** issued by your Zeotap representative. The URL expires the first time it is opened, so request it only when you are ready to sign in and approve the connection in one sitting. > * **Criteo login credentials** for an account with permission to approve the Zeotap CDP app on the Criteo consent dashboard. ## Grant Zeotap access to your Criteo account Opening the single-use URL takes you to the Criteo login page. After you sign in with your Criteo credentials, Criteo presents a consent dashboard listing every permission the Zeotap CDP app is requesting. Approve those permissions to authorize the connection. Once Criteo records your consent, you can proceed to create the destination in Zeotap CDP. ![](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/3170664609.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=ea4b51bc71f2f0189e6023fc2c325e9f) > [!WARNING] > > The authorization URL is single-use. If you open it before you are ready to complete the sign-in and consent steps, it expires and your Zeotap representative will need to issue a new one. ## Create the Criteo destination In your Zeotap CDP workspace, add a new destination of type **Criteo**. The configuration form needs three inputs: ![](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_1.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=92dfe8ecb29e59c9d7d57cb954e54618) ![](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_2.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=6f5f0f5367788fb4e9e946f4b3cb5874) 1. **A name for the destination.** Choose a name that identifies the Criteo Ad Account it connects to (for example, the brand or market the account serves) so the destination is easy to find when you link an audience. 2. **The Advertiser ID.** Paste the Criteo Ad Account ID you gathered in the prerequisites. ![](https://mintcdn.com/zeotap/IaZjYE7XwRssOe8Q/articles/integrate-customer/Storage/integrate-customer/tabmo-hawk/criterio_2.png?fit=max\&auto=format\&n=IaZjYE7XwRssOe8Q\&q=85\&s=f5918f75e183f741ed0939a102a77887) 3. **Action and identifier mapping.** Select the **Send identifiers to Criteo** action, then map the Zeotap output identifiers you want to send. You can map any combination of MAIDs, raw email addresses, hashed email addresses (SHA-256), and Criteo Cookies (Gum IDs); add or remove rows so only the identifiers you intend to send remain in the mapping. ![](https://mintcdn.com/zeotap/Yl1hDNuL3ftKLMn2/articles/integrate-customer/Storage/integrate-customer/criteo/criteo-2023-11-08-2.png?fit=max\&auto=format\&n=Yl1hDNuL3ftKLMn2\&q=85\&s=38dfd463d88cd77d7ea60bb55b29dd8e) Save the destination once these inputs are complete. A saved configuration is equivalent to the following shape: ```json theme={null} { "destination_type": "criteo", "name": "criteo-eu-prospecting", "advertiser_id": "", "action": "send_identifiers_to_criteo", "identifier_mapping": [ "maid", "email_raw", "email_sha256", "criteo_cookie_gum_id" ] } ``` ## Verify the destination is ready After you save the destination, confirm: * The destination is listed among your saved destinations and is selectable when you link an audience. * The Advertiser ID shown on the destination matches the Criteo Ad Account ID you entered. * The Criteo connection reflects the consent you granted — a destination whose consent step did not complete will not be available for activation. If any of these checks fail, repeat the authorization step with a fresh single-use URL from your Zeotap representative and re-save the destination. ## Link an audience to the destination Once the destination is verified, link it to the audience you want to activate. For the end-to-end linking workflow, see [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination). For the timing of when Criteo accepts the uploaded contact list into a campaign-ready audience, confirm the current expectation with your Criteo representative — it depends on Criteo-side processing that Zeotap does not control. > [!NOTE] > > The terms "audience" and "segment" refer to the same thing in Zeotap CDP — a group of users defined by a set of criteria (for example, users over 18 who triggered an `addToCart` event in the last 30 days). ## How user disqualification works The Criteo destination supports automatic user disqualification. When a user no longer satisfies the linked audience's criteria — because attribute values changed, consent was revoked, or another condition stopped being met — Zeotap CDP issues a delete for that user to Criteo on the next refresh of the audience. This is a programmatic behaviour: you do not configure or trigger it manually. The refresh frequency you set on each linked audience controls when removals are propagated. For the underlying mechanism, see [Delta Upload and Delete Functions](/articles/segment-customer/delta-upload-and-delete-functions). ## Troubleshooting | Symptom | What it means | Where to look | | - | - | - | | The authorization URL shows an expired or already-used message | The single-use URL was opened before, so the token is no longer valid | Request a new single-use URL from your Zeotap representative and complete the sign-in and consent steps in the same session | | The Criteo destination is missing when you try to link an audience | The destination was not saved, or the Criteo consent step did not complete | Re-open the destination configuration, confirm the Advertiser ID is present, re-run the authorization if needed, and save again | | An activation to Criteo completes but no users are matched on the Criteo side | The identifier types mapped on the destination are not the identifiers Criteo holds for those users | Review the identifier mapping on the destination and confirm the mapped identifiers (MAIDs, raw or SHA-256 emails, Criteo Cookies) are actually present on the source audience | If the destination is configured correctly and the issue persists, contact your Zeotap representative. Include in your request: * The destination name and the Advertiser ID it is configured with * The audience ID and the timestamp of the last refresh * The identifier types you mapped to Criteo * A description of what you observed on the Criteo side (no users in the contact list, fewer users than expected, etc.) ## FAQ > [accordion] Which identifiers can I send to Criteo through this integration? > > The destination accepts MAIDs, raw email addresses, hashed email addresses (SHA-256), and Criteo Cookies (Gum IDs). You map any combination of these on the destination's identifier mapping. > [accordion] Do I need anything from Criteo other than the Advertiser ID? > > No. The Advertiser ID (your Criteo Ad Account ID) is the only Criteo detail required to configure the destination. Authorization itself is handled through the single-use URL your Zeotap representative provides. > [accordion] Does this integration support Delta Upload? > > No. The Send identifiers to Criteo action supports ID Extension and Delete; it does not support Delta Upload. Each refresh sends the full qualifying set rather than only the changes since the previous refresh. > [accordion] Are users automatically removed from the Criteo contact list when they leave the audience? > > Yes. When a user no longer qualifies for the linked audience, Zeotap CDP issues a delete to Criteo on that audience's next refresh. No manual action is required on your side; the cadence is governed by the refresh frequency configured on the audience. ## Next steps * [Explore Criteo Retail Media →](/articles/integrate-customer/criteo-retail-media) * [Explore Criteo Offline Sales Reporting →](/articles/integrate-customer/criteo-offline-sales-reporting) * [Explore how to link an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore Delta Upload and Delete Functions →](/articles/segment-customer/delta-upload-and-delete-functions) # Criteo Offline Sales Reporting Source: https://docs.zeotap.com/articles/integrate-customer/criteo-offline-sales-reporting Send offline transaction data from Zeotap CDP to Criteo through a Journeys workflow, so Criteo can attribute in-store and call-centre sales back to your campaigns. The Criteo Offline Sales Reporting destination sends offline transaction data **out of Zeotap CDP to Criteo**. It is a real-time integration: records leave Zeotap CDP from a Journeys workflow through a **Send to Destinations** node, rather than on an audience refresh. For sending audience identifiers to your Criteo Ad Account as a contact list, see [Criteo](/articles/integrate-customer/criteo). For activating audiences against retailer and marketplace placements, see [Criteo Retail Media](/articles/integrate-customer/criteo-retail-media). ## What this is Criteo is a commerce media company that shows personalised ads to potential customers across the internet, primarily through retargeting. Offline Sales Reporting connects offline transaction data — in-store purchases, call-centre sales — back to your digital campaigns. Criteo matches those offline conversions to ad interactions using privacy-safe identifiers, so you can measure campaign impact across channels and weigh ad spend towards the audiences and strategies that drive both online and offline results. In Zeotap CDP the integration is configured once as a destination, with your Criteo **Client Name** and a field mapping. You then attach that destination to a Journeys workflow, and the records that reach the **Send to Destinations** node are forwarded to Criteo. ## Supported identifiers and actions The integration supports email addresses, both raw and hashed, and event IDs. The destination exposes a single action, **Send Offline Data to Criteo**. On the mapping screen, you pair your catalogue attributes with the Criteo destination fields the action expects. The following fields are mandatory: * Email (Raw / MD5 / SHA256) * Event Id * Timestamp * Item ID * Item's Price * Item's Quantity * Store ID * Site Type * IP * User Segment * Account By default, the mapping screen lists the output identifiers the platform accepts, such as email. You can edit that list, and add or remove identifiers from it. ## Prerequisites > [!NOTE] > > Before you configure the destination, confirm you have: > > * An **active Criteo account**. > * Your **Client Name**, in the format `organizationname_offlinesales`. > * A Journeys workflow to attach the destination to, or the ability to create one. See [Create a Workflow](/articles/orchestrate-customer/create-a-workflow). > * A Zeotap CDP user with access to the **Destinations** application. > * Catalogue attributes in your workspace that carry the mandatory fields listed above, so you can complete the mapping. ## Create the Criteo - Offline Sales Reporting destination **1. Open the Destinations application** Log in to the Zeotap CDP App and go to **Integrate → Destinations**. **2. Start a new destination** Click **+ Create Destination**. **3. Find the connector** Under **All Destinations**, search for **Criteo - Offline Sales Reporting** and click it. **4. Enter the destination details** A screen appears with details about the destination on the left and the fields required for the integration on the right. Complete both: * **Destination Name** — a name that identifies this destination for you, so it is easy to find when you attach it to a workflow. * **Client Name** — the Client Name you gathered in the prerequisites. Click **Next** to move on to the mapping step. ![Enter Destination Details step of the Criteo - Offline Sales Reporting destination, with empty Destination Name and Client Name fields and a two-step Destination Details / Mapping breadcrumb](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/criteo-offline-sales-reporting/image-1.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=5416d41ec4fb50f2f6ee0cf293b06234) **5. Choose the action and map the fields** On the **Mapping** step, give the mapping a name, then: * Under **Choose your Action**, select **Send Offline Data to Criteo**. * Under **Map the Fields**, pair each catalogue attribute with the Criteo destination field it should populate. Cover every mandatory field listed above. Click **Create Destination** to save the destination together with its mapping. ![Mapping step with Send Offline Data to Criteo selected under Choose your Action, and a Map the Fields table pairing catalogue attributes with Criteo destination fields](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/criteo-offline-sales-reporting/image-2.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=f44728ab4dd28451a88d49d1a521076b) ## Add the destination to a journey A saved destination does nothing on its own. To start sending data, attach it to the **Send to Destinations** node of a Journeys workflow. **1. Add a Send to Destinations node** In the workflow, click **+** and choose **Send to Destinations**. ![Choose an action menu on the journey canvas, with Send to Destinations highlighted below the condition, delay and split options](https://mintcdn.com/zeotap/Yl1hDNuL3ftKLMn2/articles/integrate-customer/Storage/integrate-customer/criteo-offline-sales-reporting/image-3.png?fit=max\&auto=format\&n=Yl1hDNuL3ftKLMn2\&q=85\&s=d656205d87eb04e9127a7826373da83a) **2. Select the destination** Use the search box to find the destination you created, and select it from the list of available destinations. ![Send to Destinations panel with a search box above a grid of saved destination cards, each labelled with its connector](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/criteo-offline-sales-reporting/image-4.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=fbee8af839401f3380139d3b313079aa) **3. Check the Destination Details tab** On the **Destination Details** tab, the **Client Name** field is populated automatically from the value you entered when you created the destination. **4. Set the action and mapping for this workflow** On the **Destination Settings** tab, choose the action and mapping you want this workflow to use. **5. Save** Click **Save Destination**. The destination is attached to the node. ![Send to Destinations node with the Criteo - Offline Sales Reporting destination attached as a card showing its selected action, above the list of other available destinations](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/criteo-offline-sales-reporting/image-5.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=1cf2befbb896cef33348841f3b954f35) ## Verify the destination is attached After you save, confirm the following before you rely on the integration: * The destination appears when you search for it in the **Send to Destinations** node, which means it saved successfully. * Inside the node, the attached card shows the Criteo - Offline Sales Reporting connector, your destination name, and **Send Offline Data to Criteo** as the action. * On the **Destination Details** tab, the **Client Name** carried over from the destination you created and matches the `organizationname_offlinesales` value you entered. For confirmation that Criteo has received and matched the offline conversions, check Criteo's own reporting, or ask your Criteo representative where offline conversions surface for your account. That processing happens on Criteo's side and is not visible in Zeotap CDP. ## Troubleshoot delivery to Criteo This page documents no failure conditions specific to Criteo Offline Sales Reporting. The checks below are the general ones for a real-time destination. | Symptom | What it usually means | Where to look | | - | - | - | | The destination does not appear when you search for it in the **Send to Destinations** node | The destination was not saved, or the mapping step was never completed | Re-open the destination configuration, confirm the Client Name and the mapping are present, and save again | | Records enter the journey but nothing reaches Criteo | A profile failed at a specific node, or a mandatory field in the mapping was empty for those profiles | The **Execution Details** panel on the failed node — see [Identify Journey Errors](/articles/orchestrate-customer/identify-journey-errors) | | You need to know what happened to one specific user | Per-user delivery detail is not shown in the aggregate node counts | [Journey Traces](/articles/orchestrate-customer/journey-traces), which shows the data received, how it was transformed, and what was delivered to each destination | If the destination is configured as described above and records still do not arrive, contact your Zeotap representative. Include the destination name, the workflow and its published state, the mapping you configured, and what you observed on the Criteo side. ## Next steps * Explore [Criteo →](/articles/integrate-customer/criteo) to send audience identifiers to your Criteo Ad Account as a contact list. * Explore [Criteo Retail Media →](/articles/integrate-customer/criteo-retail-media) to activate audiences on retailer and marketplace placements. * Explore [Real-Time Integrations →](/articles/integrate-customer/real-time-integrations) for the other destinations that run from a Journeys workflow. * Explore [Create a Workflow →](/articles/orchestrate-customer/create-a-workflow) to build the journey this destination attaches to. * Explore [Destinations →](/articles/integrate-customer/destinations) for how destinations are configured and mapped in general. # Criteo Retail Media Source: https://docs.zeotap.com/articles/integrate-customer/criteo-retail-media Send Zeotap CDP audiences to Criteo Retail Media so you can target shoppers on retailer and marketplace properties. ## What this is Criteo Retail Media is a digital advertising platform that places ads near the digital point of sale on retailer and marketplace websites and apps. When you connect it as a Zeotap CDP destination, an audience you build in Zeotap becomes a contact-list segment inside Criteo that you target from your campaigns. This page walks through the one-time setup: collecting the credentials Criteo requires, connecting the destination in Zeotap CDP, choosing the identifier you want to send, and confirming the segment lands in Criteo. Two identifier paths are available. Send **email addresses** (raw or SHA256-hashed) for offsite targeting, or send a **customer identifier** — the user ID for a logged-in shopper on the retailer's own website — for onsite targeting. The path you pick determines which action you select on the destination and which permissions your Criteo account needs. ## Supported identifiers and actions This integration supports email addresses (raw and SHA256-hashed) and a customer identifier (the user ID for a logged-in user on the retailer's website). | Action | [ID extension](/articles/segment-customer/extend-your-audience#id-extension) | [Delete](/articles/integrate-customer/delta-upload-and-delete-functions) | [Delta upload](/articles/integrate-customer/delta-upload-and-delete-functions) | | - | - | - | - | | Send Email to Criteo - Retail media | ✅ | ✅ | - | ## Prerequisites > [!NOTE] > > Collect these before you start — the destination cannot be saved without them. > > * **Criteo Advertiser ID.** Sign in to your Criteo account (Commerce Yield or Commerce Max) and open **Settings > Overview**. Criteo labels this value **Account ID**; you enter it as the **Advertiser ID** when you create the destination in Zeotap CDP. If you cannot find it, check the setup email Criteo sent when your account was provisioned, or contact Criteo support. > * **Criteo admin access.** The person completing the Criteo authorization step must have admin access to the Criteo account being connected. Without admin rights the authorization will not succeed and the destination cannot be saved. > * **Offsite permission for email-based segments.** To push email-based segments — or any other offsite identifier — the retailer ID you are using must have `offsite` permissions enabled in Criteo Retail Media. Request this from your Criteo representative if it has not been granted. > * **Access to the Zeotap CDP Destinations application** on your workspace. ### Hashing emails before upload This integration accepts both raw and SHA256-hashed emails, so pre-hashing on your side is optional. When your governance policy requires that raw emails never leave your environment, hash them yourself after normalising (lowercase, trim whitespace). A minimal Python example: ```python theme={null} import hashlib def hash_email(email: str) -> str: normalised = email.strip().lower() return hashlib.sha256(normalised.encode("utf-8")).hexdigest() print(hash_email("Shopper@Example.com")) # 64-char lowercase hex string ``` Send the hex digest as the mapped value for the email field on the `Send Email to Criteo - Retail media` action. ## Create the Criteo Retail Media destination Complete the following in Zeotap CDP. 1. Create a new destination and pick **Criteo Retail Media** from the destination catalogue. Give it a descriptive name so you can distinguish it from other Criteo integrations you own — [Criteo](/articles/integrate-customer/criteo) and [Criteo Offline Sales Reporting](/articles/integrate-customer/criteo-offline-sales-reporting) — which cover different use cases. ![Criteo Retail Media in the destination catalogue](https://mintcdn.com/zeotap/Yl1hDNuL3ftKLMn2/articles/integrate-customer/Storage/integrate-customer/criteo-retail-media/criteo-retail-media-2024-08-13-1.png?fit=max\&auto=format\&n=Yl1hDNuL3ftKLMn2\&q=85\&s=2649a5e6b1730d03cec613903dc11b79) 2. Enter the **Advertiser ID** you collected in the prerequisites. 3. Start the Criteo connection. Zeotap CDP redirects you to the Criteo sign-in page. Sign in with an account that has admin access on the Criteo side, then approve the request that grants Zeotap CDP access to your Criteo account. ![Criteo sign-in page shown after starting the connection](https://mintcdn.com/zeotap/Yl1hDNuL3ftKLMn2/articles/integrate-customer/Storage/integrate-customer/criteo-retail-media/criteo-retail-media-2024-08-13-2.png?fit=max\&auto=format\&n=Yl1hDNuL3ftKLMn2\&q=85\&s=d3ecec838d4b4e4c45e5553b18495028) > [!WARNING] > > Only an admin on the Criteo account can complete this authorization. A non-admin sign-in will not produce a working destination — you will need to redo this step with the correct account. ![Criteo approval screen granting Zeotap CDP access](https://mintcdn.com/zeotap/Yl1hDNuL3ftKLMn2/articles/integrate-customer/Storage/integrate-customer/criteo-retail-media/criteo-retail-media-2024-08-13-3.png?fit=max\&auto=format\&n=Yl1hDNuL3ftKLMn2\&q=85\&s=a09b04005aab2c6eb065fee691fa587f) 4. After you approve, Zeotap CDP returns you to the destination configuration screen, where the OAuth authorization is handled automatically in the background. ![Destination configuration screen with the Destination Name and Advertiser ID fields and the authorization option](https://mintcdn.com/zeotap/Yl1hDNuL3ftKLMn2/articles/integrate-customer/Storage/integrate-customer/criteo-retail-media/criteo-retail-media-2024-08-13-4.png?fit=max\&auto=format\&n=Yl1hDNuL3ftKLMn2\&q=85\&s=05731e776814da1b063f42440d5051a9) 5. Select the action that matches the identifier you want to send: * **Send Email to Criteo - Retail media** — for raw or SHA256-hashed email addresses. Requires the offsite permission on your retailer ID. 6. Map the output identifiers from your Zeotap CDP schema onto the fields Criteo expects for the action you selected, then save the destination. ![Mapping output identifiers to the fields Criteo expects](https://mintcdn.com/zeotap/Yl1hDNuL3ftKLMn2/articles/integrate-customer/Storage/integrate-customer/criteo-retail-media/criteo-retail-media-2024-08-13-5.png?fit=max\&auto=format\&n=Yl1hDNuL3ftKLMn2\&q=85\&s=0056f1d069cf293257645331f1eb1284) Once saved, the destination becomes available in the Audiences application and can be linked to any audience (segment). ## Verify the destination is active To confirm the setup worked end-to-end: 1. In Zeotap CDP, link the new destination to a small test audience and let the next refresh run. 2. Sign in to Criteo (Commerce Yield or Commerce Max), go to **Shared Library > Audiences and Segments** and open the **Contact List** tab. The audience pushed from Zeotap CDP appears there under the name you gave the audience. ![The Contact List tab in Criteo showing audiences pushed from Zeotap CDP](https://mintcdn.com/zeotap/Yl1hDNuL3ftKLMn2/articles/integrate-customer/Storage/integrate-customer/criteo-retail-media/criteo-retail-media-2024-08-13-7.png?fit=max\&auto=format\&n=Yl1hDNuL3ftKLMn2\&q=85\&s=462f1a936e1bb9c55a1470deb6b896c4) If the audience shows up with a member count that matches what Zeotap CDP reported for that refresh, the connection, the Criteo authorization, and the identifier mapping are all working. If it does not appear, see the troubleshooting section below. ## Troubleshooting * **Authorization did not complete.** Confirm the person who signed in to Criteo has admin access on that Criteo account. Reopen the destination, restart the Criteo connection, and redo the sign-in and approval step with an admin account. * **Access token expired and did not refresh.** Zeotap CDP uses the refresh token Criteo returned during authorization to renew the access token automatically. If refresh fails — for example, because the authorizing admin lost admin access, or the Criteo application authorization was revoked on the Criteo side — reopen the destination and redo the Criteo sign-in and approval step to regenerate both tokens. * **Email-based action rejected by Criteo.** Confirm that your retailer ID has `offsite` permissions enabled in Criteo Retail Media. Without that permission, Criteo accepts only onsite identifiers on this integration. * **Audience does not appear in Criteo.** Confirm the audience refresh completed successfully on the Zeotap side and that the destination is linked to the audience. If the refresh succeeded but the segment is still not visible in Criteo, contact your Zeotap customer success representative. * **Wrong Criteo integration.** Zeotap CDP offers three Criteo destinations. If you need programmatic Criteo activation with MAIDs, cookies (Gum IDs), or hashed emails, use [Criteo](/articles/integrate-customer/criteo) instead. For attributing offline transactions back to campaigns, use [Criteo Offline Sales Reporting](/articles/integrate-customer/criteo-offline-sales-reporting). When you contact support, include the destination name, the Criteo Advertiser ID, the action you selected, and the name of the audience that did not deliver. ## Next steps * [Explore Criteo →](/articles/integrate-customer/criteo) — the programmatic Criteo destination for MAIDs, Adform-style cookies (Gum IDs), and hashed emails. * [Explore Criteo Offline Sales Reporting →](/articles/integrate-customer/criteo-offline-sales-reporting) — connect in-store or call-centre transactions back to your digital campaigns. * [Explore the Integrations Master List →](/articles/integrations-master-list-publication/integrations-master-list) — see every source and destination Zeotap CDP supports. # CRM Data Source: https://docs.zeotap.com/articles/integrate-customer/crm-data CRM Data sources connect to HubSpot, Microsoft Dynamics CRM, or Salesforce CRM with credentials you generate there, and pull one object into Zeotap CDP on a sync schedule you set. ## What this is CRM Data is one of the nine source categories in Zeotap CDP. A CRM Data source connects to a customer relationship management platform you already run — HubSpot, Microsoft Dynamics CRM, or Salesforce CRM — and brings the records it holds, and the customer interactions attached to them, into the CDP for unification and segmentation. What sets this category apart is *how* the data arrives. A CRM Data source is credential-based and scheduled: you generate credentials on the CRM side, point Zeotap at one object in it, choose the fields you want, and Zeotap fetches them for you. The first fetch runs as soon as the source is created; every later fetch follows the sync frequency you picked. Setup happens entirely in the CRM and in Zeotap CDP — register an app in the CRM, then create the source against it. ## Prerequisites > [!NOTE] > > Before you create a CRM Data source, confirm: > > * You have permission to create sources in your Zeotap CDP tenant. > * You can generate the credentials the platform needs on the CRM side — a private app in HubSpot, an app registration in the Azure portal for Microsoft Dynamics CRM, and a connected app for Salesforce CRM. > * You know which object or entity you want to ingest, and which of its fields. > * You know the region of upload for this source, and whether the records describe customers (**Customer Data**) or a related entity such as transactions, accounts, or a product catalogue (**Non Customer Data**). See [Supported Data Entities](/articles/unify-customer/supported-data-entities). ## Key concepts These are the settings that shape a CRM Data source, with the per-platform differences noted below. The field selection cannot be changed once the source exists, so settle that one before you start. * **Credentials** — Zeotap authenticates against your CRM with credentials you create there. The set differs per platform; see the table below. * **Object or entity scope** — one source ingests one object. For HubSpot, that is **Contacts** or **Companies**. For Microsoft Dynamics CRM, it is an entity name such as `account`, `campaign`, or `incident` (case). For Salesforce CRM, it is any standard or custom object associated with your Salesforce account — Zeotap fetches the available list for you. * **Field selection** — for HubSpot and Salesforce CRM sources you choose which fields of the selected object to ingest, using the check boxes, the **Select All** control, or the search box, and that selection is fixed once the source exists. A Microsoft Dynamics CRM source takes an **Entity** name instead and has no field-selection step. * **Sync frequency** — the first sync runs on creation, and subsequent syncs follow the frequency you select. HubSpot offers Daily, Weekly, and Monthly. Salesforce CRM offers Sync once, Every hour, Every 3 hours, Every 6 hours, Every 12 hours, Daily, Weekly, and Monthly, and for the last three you also set the sync time (and, for Monthly, the day of the month). * **Fetch mode** — HubSpot and Salesforce CRM sources set this through **Delta Queries Selection**, a **true**/**false** choice. **false** transfers the entire dataset on every sync regardless of what changed; **true** takes the whole dataset on the first fetch and then collects only incremental updates. **true** is the lighter option for a CRM that changes a few records at a time. * **Data entity** — **Customer Data** or **Non Customer Data**, chosen during creation, determines how the ingested records are catalogued downstream. ## Choose a CRM integration Zeotap offers three CRM Data integrations. Pick the one matching the CRM you run; the differences that matter at setup time are what a single source can pull and what you have to generate on the CRM side. | Integration | What one source ingests | Credentials you generate in the CRM | | - | - | - | | **HubSpot** | One standard object — **Contacts** or **Companies** | A bearer token from a HubSpot private app | | **Microsoft Dynamics CRM** | One Dynamics entity, for example `account`, `campaign`, or `incident` (case) | App client ID, tenant ID, app client secret, and the organisation URL of your Dynamics environment | | **Salesforce CRM** | One standard or custom Salesforce object | **Client ID**, **Client Secret**, **Refresh Token**, and **Domain** | > [!TIP] > > Several Salesforce standard objects — Account, Contact, Lead, Case, and Opportunity — hold columns that correspond to first-party user IDs, which can facilitate user matching. Make sure the user ID field is part of your field selection when the object carries one. > [card] [HubSpot](/articles/integrate-customer/hubspot-source) > [card] [Microsoft Dynamics CRM](/articles/integrate-customer/ms-dynamics-source) > [card] [Salesforce CRM](/articles/integrate-customer/salesforce-crm) ## FAQ > [accordion] Can one CRM Data source ingest more than one object? > > No. Each source is created against a single object or entity — Contacts or Companies for HubSpot, one entity for Microsoft Dynamics CRM, one standard or custom object for Salesforce CRM. To bring in a second object, create a second CRM Data source for it. > [accordion] Can I change which fields a CRM source ingests after it is created? > > Not for HubSpot or Salesforce CRM sources — editing the field selection after source creation is not supported. Create a new source in Zeotap CDP with the field selection you want. This is why it is worth confirming the field list before you finish creating the source. > [accordion] How soon does CRM data start arriving? > > The first sync runs once the source is created, so you do not have to wait for the schedule to come round. Open the source and check the [Preview Data tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) to confirm what arrived, then map those fields in the catalogue. > [accordion] Do I have to re-fetch the whole CRM every sync? > > Not where a fetch mode is offered. Set **Delta Queries Selection** to **true** and the source takes the full dataset once, then collects only incremental updates on each later sync. **false** re-transfers the entire dataset every sync regardless of what changed, which is rarely what you want on a large object. ## Next steps * [Explore all nine source categories →](/articles/integrate-customer/sources) * [Explore the full list of supported source integrations →](/articles/integrate-customer/creating-a-source) * [Explore Customer Data and Non-Customer Entity data →](/articles/unify-customer/supported-data-entities) * [Explore mapping an ingested source to the catalogue →](/articles/unify-customer/map-the-catalogue) * [Explore best practices for Salesforce CRM sources →](/articles/integrate-customer/best-practices-for-salesforce-crm-source) # Customer Engagement Channels (CE) Source: https://docs.zeotap.com/articles/integrate-customer/customer-engagement-channels Customer Engagement Channels sources bring subscriber lists, channel identifiers and campaign engagement data from your email, push and messaging platforms into Zeotap CDP. ## What this is Customer Engagement Channels are the communication channels and touchpoints through which you interact with your customers — email, push notification, SMS and in-app messaging platforms. As a source category in Zeotap CDP, they bring the data those platforms already hold back into the CDP: the subscribers you can reach, the channel identifiers you reach them on, the attributes and segments the platform keeps about them, and how they responded to your campaigns. That engagement data is what makes this category distinct from the other source categories. A [Website Events](/articles/integrate-customer/website-events) source describes what a customer did on your own properties; a Customer Engagement Channels source describes what a customer did with your messaging. Both resolve onto the same unified profile, so campaign response becomes available as audience criteria alongside everything else you ingest. ## Prerequisites > [!NOTE] > > Before you create a Customer Engagement Channels source, confirm: > > * You have permission to create sources in your Zeotap CDP tenant. > * You have an account on the engagement platform. Where Zeotap CDP fetches data from the platform, you also need the credentials that platform requires — the source's creation guide lists exactly which. > * Your catalogue has the target attributes defined, or you are ready to add them during mapping. > * Every record you ingest carries at least one identifier that refers to a specific customer — for these sources that is normally the platform's own subscriber or channel identifier. ## What these sources bring in The data a Customer Engagement Channels source ingests falls into three groups: * **Subscriber and channel identifiers** — the identifiers the messaging platform uses to reach a person, such as an Airship Named User or Airship Channel ID, or a Cleverpush subscription ID and channel ID. These are the identifiers that let an engagement record resolve onto a customer profile, so map them to catalogue identifiers first. * **Subscriber attributes and segments** — the profile fields the platform holds about a subscriber, such as country, creation date, preferences, custom attributes and the segments the subscriber belongs to. * **Campaign engagement events** — how people responded to your messaging. Dotdigital supplies contacts, campaigns, preferences, campaign opens, campaign clicks and campaign page views. Emarsys supplies the contacts behind a given behaviour on a given campaign, such as opens, clicks and bounces. Braze Currents and Moengage Streams supply a continuous export of engagement events. Every source in this category carries **Customer Data (CE)** only — data tied directly to an individual customer. Non-Customer Entity (NCE) data such as product catalogues, order feeds or account data is not ingested through these sources; use a [Flat Files](/articles/integrate-customer/flat-files) or [Data Warehouse](/articles/integrate-customer/data-warehouse) source for that. The **(CE)** suffix in the navigation label records exactly this restriction. See [Supported Data Entities](/articles/unify-customer/supported-data-entities) for the difference between the two entity groups. For the sources that fetch from the platform — Batch, Braze Currents, Dotdigital, Airship (Batch), Airship Real-Time Data Streaming, Cleverpush (Batch) and Cleverpush Real-Time — [Source Integrations (Batch+Real-Time)](/articles/integrate-customer/creating-a-source) records delta fetch as not supported. It does not list Emarsys Source, Insider Webhook or Moengage Source. ## Choose a source in this category First pick the platform your engagement data lives in, then the variant that matches how fresh you need that data to be. The integrations deliver in three shapes: * **Continuous event export** — the platform exports engagement events continuously, and Zeotap ingests them as batched JSON payloads. Braze Currents and Moengage Streams work this way. Choose these when you want an ongoing feed of campaign response rather than a periodic snapshot. * **Real-time** — the integration delivers subscriber and channel data in real time rather than in a batch run. Airship Real-Time Data Streaming and Cleverpush Real-Time Source work this way. Choose these when you want subscription and channel changes delivered in real time. * **Batch fetch** — Zeotap retrieves the data set from the platform and ingests the response. Batch, Dotdigital, Emarsys, Airship (Batch) and Cleverpush (Batch) Source work this way. Choose these when a periodic refresh of subscribers, attributes and campaign engagement is enough. The [Insider Webhook](/articles/integrate-customer/insider-webhook) source is documented on its own page. Where a platform appears twice — Airship and Cleverpush each offer a batch and a real-time variant — the two are separate sources, created and mapped independently. > [!NOTE] > > **Batch** is the name of a mobile marketing automation platform, not a delivery mode. **Batch Source** is the integration with that platform, and it is unrelated to the **(Batch)** in **Airship (Batch)** and **Cleverpush (Batch) Source**, which does mean a fetch rather than a stream. ## Available Customer Engagement Channels sources Zeotap offers the following Customer Engagement Channels source integrations. Each card opens that platform's overview page. > [card] [Batch Source](/articles/integrate-customer/batch-source) > [card] [Braze Currents](/articles/integrate-customer/braze-currents) > [card] [Dotdigital](/articles/integrate-customer/dotdigital) > [card] [Airship (Batch)](/articles/integrate-customer/airship-batch-source) > [card] [Airship Real-Time Data Streaming](/articles/integrate-customer/airship-real-time-data-streaming-source) > [card] [Cleverpush (Batch) Source](/articles/integrate-customer/cleverpush-batch-source) > [card] [Cleverpush Real-Time Source](/articles/integrate-customer/cleverpush-real-time-source) > [card] [Emarsys Source](/articles/integrate-customer/emarsys-source) > [card] [Insider Webhook](/articles/integrate-customer/insider-webhook) > [card] [Moengage Source](/articles/integrate-customer/moengage-source) For Braze Currents, reach out to your customer success manager to have a [Braze Currents source](/articles/integrate-customer/create-a-braze-currents-source) set up. ## FAQ > [accordion] Why is Batch Source listed under Customer Engagement Channels? > > Batch is a mobile marketing automation platform that engages users through push notifications, email, SMS and in-app messages, so it belongs with the other engagement platforms. The name is a coincidence — it does not describe how the source delivers data. See [Create a Batch Source](/articles/integrate-customer/create-a-batch-source). > [accordion] Can a Customer Engagement Channels source bring in Non-Customer Entity data? > > No. Every source in this category carries Customer Data (CE) only. To ingest Non-Customer Entity data such as a product catalogue, an order feed or account data, use a [Flat Files](/articles/integrate-customer/flat-files) or [Data Warehouse](/articles/integrate-customer/data-warehouse) source, both of which support CE and NCE data. > [accordion] Do these sources fetch only the records that changed since the last run? > > Not for the sources the reference covers. [Source Integrations (Batch+Real-Time)](/articles/integrate-customer/creating-a-source) records delta fetch as not supported for Batch, Braze Currents, Dotdigital, Airship and Cleverpush sources; it does not list Emarsys Source, Insider Webhook or Moengage Source. The [Source Integrations (Batch+Real-Time)](/articles/integrate-customer/creating-a-source) reference records delta-fetch support for every source Zeotap offers. > [accordion] Which identifiers do these sources send? > > The engagement platform's own subscriber and channel identifiers — for example an Airship Named User or Airship Channel ID, or a Cleverpush subscription ID and channel ID. Every record ingested into Zeotap CDP must carry at least one identifier that refers to a specific customer, so map these identifiers to their catalogue counterparts before you rely on the source in an audience. See [Map the Catalogue](/articles/unify-customer/map-the-catalogue). ## Next steps * [Explore how sources work in Zeotap CDP →](/articles/integrate-customer/sources) * [Explore the full source-integration reference →](/articles/integrate-customer/creating-a-source) * [Explore Supported Data Entities →](/articles/unify-customer/supported-data-entities) * [Explore how to map fields to the catalogue →](/articles/unify-customer/map-the-catalogue) * [Explore the CRM Data source category →](/articles/integrate-customer/crm-data) # Data Warehouse (CE+NCE) Source: https://docs.zeotap.com/articles/integrate-customer/data-warehouse Data Warehouse sources connect Zeotap CDP directly to a table or bucket you already own — Snowflake, BigQuery, Amazon S3, Databricks or Microsoft Fabric — and pull records from it on a schedule you set. ## What this is A data warehouse is a centralised, integrated repository that stores large volumes of structured and unstructured data drawn from many systems. It is built to support business intelligence and analytics work by giving that data a scalable, high-performance environment for storage, processing and analysis. For customer data in particular, a warehouse such as Snowflake or BigQuery is often where the most complete view of a customer already lives — joined, cleaned and modelled. Bringing it into Zeotap CDP lets you act on it: make data-driven decisions, personalise customer experiences, sharpen marketing strategies and improve overall customer satisfaction. **Data Warehouse** is the source category that brings that data in. Instead of exporting files and pushing them to Zeotap, you give Zeotap CDP read access to a table — or, for Amazon S3, to a bucket and folder — and Zeotap pulls records from it on the schedule you choose. It is also the literal label you select in the source-creation form: every connector listed on this page is created by choosing **Data Warehouse** as the **Category**. Data Warehouse sources carry both **Customer Data (CE)** and **Non-Customer Entity (NCE)** data, so the same category covers customer profiles and the reference data around them — product catalogues, order data, campaign data and similar. ## Prerequisites > [!NOTE] > > Before you create a Data Warehouse source, confirm: > > * You have permission to create sources in your Zeotap CDP tenant. > * You have an account with the warehouse or storage service, and the data you want to import already resides in it. > * You have read credentials Zeotap CDP can use, and the exact location of the object to read — warehouse, database, schema and table for Snowflake; project, dataset and table for BigQuery; bucket, bucket region and folder for Amazon S3; catalog, schema and table for Databricks; database and table for Microsoft Fabric. Each connector's setup page lists the precise fields it asks for. > * You know the region of upload for the source, and your [Catalogue](/articles/unify-customer/catalogue) has the target attributes defined, or you are ready to add them during mapping. ## Key concepts Every Data Warehouse source, whichever connector you pick, is configured around the same few settings. * **Category and Data Source** — in **CREATE SOURCE** you first choose **Data Warehouse** as the Category, then the specific connector as the Data Source. The rest of the form is connector-specific. * **Sync Frequency** — how often Zeotap CDP re-reads the source. The Microsoft Fabric source form labels this **Refresh Frequency**. The first sync runs as soon as the source is created; every sync after that follows the frequency you set. Some connectors add further fields for these cadences — for BigQuery and Databricks you also set the sync time and, for a weekly or monthly cadence, the day. The cadences on offer differ by connector, so check the setup page for the one you are creating. * **Delta Queries Selection** — offered by the connectors that support incremental sync. Set to **true** and Zeotap CDP gathers only the additions and changes made since the last sync; the connector's setup page names the fields that identify them. Set to **false** and the full dataset is retrieved and transferred on every sync, whether or not anything changed. For a Snowflake source, prepare the table as described on its setup page before you switch delta queries on. * **Data Entity** — mark the source as [Customer Data](/articles/unify-customer/customer-data) or [Non Customer Data](/articles/unify-customer/non-customer-entity-data), depending on whether the records describe customers or the entities around them. * **Region of upload** — the storage region for the ingested records, chosen when you create the source. See [Region of Storage](/articles/integrate-customer/region-of-storage). ## Choose a connector Zeotap CDP offers five Data Warehouse source integrations. > [card] [Snowflake](/articles/integrate-customer/snowflake) > [card] [BigQuery](/articles/integrate-customer/bigquery) > [card] [Amazon S3](/articles/integrate-customer/amazon-s3) > [card] [Databricks](/articles/integrate-customer/databricks) > [card] [Microsoft Fabric](/articles/integrate-customer/microsoft-fabric) Pick the connector that matches where the data sits today. There is no need to move data between warehouses first — each connector reads the system it is named for. | Connector | Zeotap CDP reads | Full setup | | - | - | - | | **Snowflake** | A table in a Snowflake warehouse, database and schema, using a Snowflake username and password. | [Create a Snowflake Source](/articles/integrate-customer/create-a-snowflake-source) | | **BigQuery** | A table in a BigQuery project and dataset. Tables with JSON column types are not supported. | [Create a BigQuery Source](/articles/integrate-customer/create-a-bigquery-source) | | **Amazon S3** | The objects held in a bucket and folder in your own AWS account, using an access token and secret access token. | [Create and Implement an Amazon S3 Source](/articles/integrate-customer/create-and-implement-an-amazon-s3-source) | | **Databricks** | A table addressed by catalog, schema and table name, over either a JDBC or a job-based connection. | [Create and Implement a Databricks Source](/articles/integrate-customer/create-and-implement-a-databricks-source) | | **Microsoft Fabric** | A table or view in a Microsoft Fabric database, reached through a service principal. | [Microsoft Fabric](/articles/integrate-customer/microsoft-fabric) | > [!NOTE] > > **Amazon S3 is object storage, not a query engine.** Zeotap CDP does not run a query against it — it reads the objects held in the bucket and folder you point it at. Amazon S3 sits in this category because it is configured and scheduled exactly like the warehouse connectors: read credentials, a location, a Sync Frequency and a Delta Queries setting, all under the **Data Warehouse** category in the source form. If instead your data leaves its origin system as CSV or JSON files delivered to Zeotap over SFTP or Zeotap Google Cloud Storage, use [Flat Files](/articles/integrate-customer/flat-files). ## Create a Data Warehouse source The first four steps are identical for all five connectors. The connection fields in step 5 are the part that differs, and each connector's setup page walks through them field by field. **1. Open the Sources application** In the Zeotap CDP App, navigate to **Integrate** → **Sources**. **2. Start a new source** Click **CREATE SOURCE**. **Expected result:** the source-category picker opens. **3. Choose Data Warehouse as the Category** Select **Data Warehouse**. **Expected result:** the Data Warehouse connectors are listed as the available Data Sources. **4. Choose the Data Source** Select **Snowflake**, **Google BigQuery**, **Amazon S3**, **Databricks** or **Microsoft Fabric**. **Expected result:** the configuration form for that connector opens. **5. Enter the source details** Give the source a descriptive name, select the region of upload, and choose the Sync Frequency. Then enter the connection details for your warehouse or bucket and set the **Data Entity**. Where the connector supports incremental sync, also set **Delta Queries Selection**. For the exact fields and where to find each value in your own account, follow the connector's setup page linked in the table above. **6. Review and create** Check the values you entered and create the source. **Expected result:** the new source appears on the [Source Listing](/articles/integrate-customer/components-of-the-source-listing-page) page. ## Verify the source was created The source is configured correctly when: * It appears on the Source Listing page under the name you gave it. * Its **Implementation Details** tab shows the connection parameters you entered. * The first data sync begins once the source is created, and later syncs follow the Sync Frequency you selected. The initial transfer scales with the volume of the table or bucket, so a large dataset takes longer than a small one to complete its first sync. ## FAQ > [accordion] Why is Amazon S3 grouped with the data warehouses? > > Because that is how it is created: the source form asks you to choose **Data Warehouse** as the Category before you select Amazon S3 as the Data Source, and the settings that follow — credentials, location, Sync Frequency, Delta Queries Selection — are the same ones the warehouse connectors use. Amazon S3 itself is object storage: Zeotap CDP reads the objects in the bucket and folder you name rather than querying a table. > [accordion] How often does Zeotap CDP re-read my table? > > As often as the Sync Frequency you set when creating the source. The first sync runs immediately on creation, and every sync after that follows the chosen cadence. For a daily, weekly or monthly cadence you also pick the time of day and the relevant day. The cadences offered differ by connector, so check the setup page for the one you are using. > [accordion] Do I have to re-ingest the whole table on every sync? > > No, where the connector supports incremental sync. Set **Delta Queries Selection** to **true** and Zeotap CDP fetches only the additions and changes made since the last sync. Leave it **false** and the full dataset is transferred on every sync, regardless of what changed. A Snowflake table needs preparing before delta queries can be used — its setup page covers the steps. > [accordion] Can a Data Warehouse source carry data that is not about customers? > > Yes. Data Warehouse sources support both Customer Data (CE) and Non-Customer Entity (NCE) data. Set the **Data Entity** field on the source to match what the table holds: customer profiles, or reference data such as product catalogues, orders and campaigns. ## Next steps * [Explore the Snowflake source →](/articles/integrate-customer/snowflake) * [Explore the BigQuery source →](/articles/integrate-customer/bigquery) * [Explore the Amazon S3 source →](/articles/integrate-customer/amazon-s3) * [Explore the Databricks source →](/articles/integrate-customer/databricks) * [Explore the Microsoft Fabric source →](/articles/integrate-customer/microsoft-fabric) * [Explore every source integration Zeotap CDP supports →](/articles/integrate-customer/creating-a-source) * [Explore how sources work across all nine categories →](/articles/integrate-customer/sources) # Databricks source overview Source: https://docs.zeotap.com/articles/integrate-customer/databricks How the Databricks source fits into Zeotap CDP, what to gather from your Databricks workspace, and where to find the full setup steps. ## What this is Databricks is a unified analytics platform built around Apache Spark. Zeotap CDP integrates with it as a **data warehouse source** under the Integrate module, pulling records from a Databricks table on the schedule you choose so your CDP profiles stay in sync. This page is the entry point for the Databricks source: it explains the two supported connection modes, what you gather from Databricks before creating the source, how to verify the source is working, and where to find the full field-by-field setup. > [!NOTE] > > **Databricks works as both a source and a destination.** This page covers the **source** side — pulling data from Databricks into Zeotap CDP. If you want to activate audiences into Databricks tables instead, see [Databricks destination](/articles/integrate-customer/databricks_destination). ## Prerequisites Before you create a Databricks source in Zeotap CDP, collect the following from your Databricks workspace: * **Databricks Host** — the workspace URL, taken from your browser address bar on the Databricks account. * **Catalog Name**, **Schema Name**, and **Table Name** — the three-level identifier that points at the table you want to ingest. * **Connection credentials** — either OAuth for JDBC (Client ID + Client Secret + HTTP Path) or a personal access token with a Cluster ID and Warehouse ID for the Job-based mode. The field-by-field walkthrough — including how to create the service principal, generate the OAuth secret, and locate the HTTP Path — is documented in [Create and Implement a Databricks Source](/articles/integrate-customer/create-and-implement-a-databricks-source). > [!WARNING] > > **Keep credentials out of shared channels.** The Client Secret, the personal access token, and any service-account JSON grant access to your Databricks workspace and the linked cloud-storage bucket. Do not paste them into tickets, chat threads, or version control. ## Choose a connection mode Zeotap CDP supports two mechanisms for pulling data from Databricks. Choose based on the size of the table you are ingesting. | Mode | When to use | Credentials required | | - | - | - | | **JDBC** | Tables under 1 million records. | OAuth Client ID, Client Secret, and HTTP Path. The HTTP Path is found under SQL Warehouses → Connection details in Databricks. | | **Job-based** | Recommended for tables above 1 million records. | Personal access token (or service-principal credentials), Cluster ID, and Warehouse ID. | > [!TIP] > > For tables above 1 million records, start with **Job-based**. The setup guide flags that JDBC can hit performance issues at that volume. ## What you configure in the source form The Zeotap CDP source form has three settings you decide up front, in addition to the Databricks connection fields: 1. **Sync Frequency** — how often Zeotap CDP re-reads the Databricks table. Supported cadences are Sync once, Every hour, Every 3 hours, Every 6 hours, Every 12 hours, Daily, Weekly, and Monthly. For Daily / Weekly / Monthly you also pick a Sync Time (AM/PM) and, for Monthly, the day of the month. 2. **Data Entity** — mark the source as **Customer Data** or **Non Customer Data**, depending on whether the records are customer profiles or reference / lookup data. 3. **Delta Queries Selection** — set to **true** to fetch only rows that changed since the last run (based on a timestamp column you name), or **false** to re-ingest the full table on every run. The step-by-step form entry is documented in [Set Up a Databricks Source](/articles/integrate-customer/set-up-a-databricks-source). Values you collect from Databricks map to the source form as follows: ```yaml theme={null} # Fields to enter in the Zeotap CDP Databricks source form # Source details (both modes) databricks_host: # Workspace URL from your browser address bar catalog_name: # Unity Catalog / Metastore catalog holding the schema schema_name: # Database inside the catalog table_name: # Target table to ingest # JDBC mode credentials client_id: # OAuth client ID from the Databricks service principal client_secret: # OAuth secret for that service principal http_path: # Databricks -> SQL Warehouses -> Connection details # Job-based mode credentials access_token: # Databricks -> Settings -> User Settings -> Developer -> Generate new token cluster_id: # Databricks -> Compute -> cluster name -> automatically added tags warehouse_id: # Databricks -> SQL Warehouses -> select warehouse -> Warehouse ID ``` ## Verify the source is working You know the source is configured correctly when: * The Databricks source appears in the Sources listing with a status of **Integrated**. * The **Implementation Details** tab on the source shows the connection parameters you entered. * The first data sync starts once the source is created; subsequent runs follow the Sync Frequency you selected. The initial data transfer scales with table volume — large tables take longer than small ones to complete the first sync. ## Why a source fails to connect | Error string | What it means | Where to look | | - | - | - | | Source does not reach the **Integrated** status after creation | Zeotap CDP could not connect to Databricks with the credentials supplied. | Re-check the Databricks Host value and re-verify the OAuth client or access token in your Databricks account. | | First sync starts but does not finish on a table above 1 million records | JDBC hits performance limits at large volume. | Recreate the source using the **Job-based** connection mode instead of JDBC. | | OAuth credentials rejected in JDBC mode | The service principal is missing workspace permissions, or the OAuth secret has been rotated or revoked. | Databricks → the service principal's workspace-level permissions and OAuth secrets. | | Access token rejected in Job-based mode | The personal access token has expired or been revoked. | Databricks → Settings → User Settings → Developer → regenerate the token, then edit the source with the new value. | If the source still does not reach **Integrated** after re-checking the credentials and the connection mode, contact the Zeotap support team at [support@zeotap.com](mailto:support@zeotap.com). Include the source name, the connection mode selected (JDBC or Job-based), the Databricks Host value, and the timestamp of the failed sync. ## Next steps * [Explore the full Databricks source setup reference →](/articles/integrate-customer/create-and-implement-a-databricks-source) * [Explore the step-by-step walkthrough for creating a Databricks source →](/articles/integrate-customer/set-up-a-databricks-source) * [Explore the Databricks destination for activating audiences into Databricks →](/articles/integrate-customer/databricks_destination) * [Explore other Data Warehouse sources supported by Zeotap CDP →](/articles/integrate-customer/data-warehouse) # Databricks Source: https://docs.zeotap.com/articles/integrate-customer/databricks_destination Databricks as a Zeotap CDP destination — activate an audience out of Zeotap into a Databricks table, staged through a Google Cloud Storage bucket and loaded by Databricks Autoloader. ## What this destination does This page covers Databricks as a **destination** — data flowing **out of** Zeotap CDP into your Databricks workspace. Databricks is a cloud-based data platform that unifies data engineering, data science, and analytics on a single collaborative workspace, built around Apache Spark. It enables organisations to process large-scale data, build machine learning models, and perform advanced analytics efficiently. Integrated with Zeotap, you can push an audience created in Zeotap CDP to your Databricks instance. Delivery runs in two hops. Zeotap CDP writes the audience as a JSON file into a Google Cloud Storage (GCS) bucket that you own, and Databricks Autoloader picks that file up from the bucket and loads the records into Delta tables, at the catalog, schema, and table you nominate. > [!NOTE] > > **Databricks works in both directions.** This page covers the destination side. To pull data the other way — from a Databricks table **into** Zeotap CDP — see [Databricks source overview](/articles/integrate-customer/databricks). ## Prerequisites > [!NOTE] > > Before you create a Databricks destination in Zeotap CDP, have the following ready. The section below shows where each value lives. > > * **Databricks Host** — your Databricks workspace URL. > * **Databricks access token** — a personal access token used to authenticate API calls. > * **Cluster ID** — the ID of the Databricks cluster the job runs on. > * **Catalog** — the catalog name within Unity Catalog or the Databricks metastore (for example, `zeotap_new`). > * **Schema** — the schema name where the table exists or will be created (for example, `db_promotion`). > * **Table** — the target table name for loading the data (for example, `activation`). > * **GCP bucket** — the Google Cloud Storage bucket where the exported data is delivered. This is your own bucket; the data lands there before Databricks Autoloader picks it up into Delta tables. > * **GCP project ID** — the project that owns that GCS bucket. > * **Service account** — either a **Client Service Account JSON** that you supply, or the **Zeotap Service Account**. See [Choose the service account](#choose-the-service-account). > > Only the **GCP** upload type is supported today, so a GCS bucket is required for every Databricks destination. > [!NOTE] > > **Catalog is not Catalogue.** On this page, **Catalog** keeps Databricks' own spelling because it refers to a Unity Catalog (or metastore) catalog — the top level of the `catalog.schema.table` identifier inside your workspace. It is not the Zeotap CDP **Catalogue**, which is where your ingested fields are mapped to customer attributes before activation. ## Supported identifiers and actions You can send any identifier or attribute of your choice from Zeotap CDP to Databricks using this integration. | Action Name | [ID EXTENSION](/articles/segment-customer/extend-your-audience#id-extension) | [DELETE](/articles/segment-customer/delta-upload-and-delete-functions) | [DELTA UPLOAD](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :-: | :-: | :-: | | Send attributes and identifiers to Databricks | — | — | — | > [!NOTE] > > Sending of event data is not supported currently. ## Find the Databricks and Google Cloud values ### Databricks Host The host is in the URL for your Databricks account. ![Databricks workspace URL shown in the browser address bar, which is the Databricks Host value](https://mintcdn.com/zeotap/Yl1hDNuL3ftKLMn2/articles/integrate-customer/Storage/integrate-customer/databricks_destination/databricks_destination-2025-06-10.png?fit=max\&auto=format\&n=Yl1hDNuL3ftKLMn2\&q=85\&s=96ba03123377fbf8213f8db288c08a92) ### Databricks access token Access tokens are managed under **Settings → User Settings → Developer → Generate new token**. ![Generate new token option under Developer in Databricks user settings](https://mintcdn.com/zeotap/Yl1hDNuL3ftKLMn2/articles/integrate-customer/Storage/integrate-customer/databricks_destination/databricks_destination-2025-06-10-1.png?fit=max\&auto=format\&n=Yl1hDNuL3ftKLMn2\&q=85\&s=cea5b80d4d1134bd895db0dc7ab1cc6b) ### Cluster ID The cluster ID is found under **Compute → cluster name → automatically added tags**. ![Cluster ID listed under the automatically added tags of a Databricks cluster](https://mintcdn.com/zeotap/Yl1hDNuL3ftKLMn2/articles/integrate-customer/Storage/integrate-customer/databricks_destination/databricks_destination-2025-06-10-2.png?fit=max\&auto=format\&n=Yl1hDNuL3ftKLMn2\&q=85\&s=d6c6f122f4e43c9b00305e5bf5c726f0) ### Catalog, Schema, and Table Together these three values form the destination table in Databricks: * **Catalog** — the catalog name within Unity Catalog or the Databricks metastore, for example `zeotap_new`. * **Schema** — the schema name where the table exists or will be created, for example `db_promotion`. * **Table** — the target table name for loading the data, for example `activation`. ![Catalog, schema, and table shown in the Databricks catalog explorer](https://mintcdn.com/zeotap/Yl1hDNuL3ftKLMn2/articles/integrate-customer/Storage/integrate-customer/databricks_destination/databricks_destination-2025-06-10-3.png?fit=max\&auto=format\&n=Yl1hDNuL3ftKLMn2\&q=85\&s=75cf4716292553cd6b1dc1f2e10eab00) ### GCP bucket and project ID The **GCP bucket** is the name of the Google Cloud Storage bucket where the exported data is delivered. This is your own bucket — the data is placed there before being picked up by Databricks Autoloader into Delta tables. The **GCP project ID** is the project that owns that bucket. ![Bucket details page in the Google Cloud console with the Cloud Storage bucket name highlighted](https://mintcdn.com/zeotap/Yl1hDNuL3ftKLMn2/articles/integrate-customer/Storage/integrate-customer/databricks_destination/databricks_destination-2025-06-10-4.png?fit=max\&auto=format\&n=Yl1hDNuL3ftKLMn2\&q=85\&s=0f0bd06b4ac52c3586e12c630ea1e709) ### Choose the service account Zeotap CDP needs to write the audience file into your GCS bucket. Pick one of the two authentication options: * **Client Service Account JSON** — a service account that you provide. Zeotap CDP uses it to upload the transformed audience (segment) data into your GCS bucket. The uploaded data is then picked up automatically by Databricks Autoloader for further processing and loading into Databricks tables. * **Zeotap Service Account** — the service account Zeotap uses to access the Google Cloud Storage account. Whitelist it on your bucket so audiences (segments) can be pushed from Zeotap CDP to Google Cloud Storage. ## Create the Databricks destination in Zeotap CDP **1. Open the Destinations application** Log into the Zeotap CDP App and go to the **DESTINATIONS** application. **2. Start a new destination** Click **+ Create Destination**. ![Create Destination button in the Zeotap CDP Destinations application](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/integrate-customer/amazon-s3-destination/ADOBE_DMP_3_\(1\).png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=8af304a0fb2280e517f24a4a2ad84e21) **3. Find Databricks under All Destinations** Under the **All Destinations** section, search for Databricks. ![Searching for a destination under the All Destinations section](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/integrate-customer/amazon-s3-destination/ADOBE_DMP_4_\(1\).png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=f6ada97715a2a4a0469fef53698ac3b9) **4. Enter the connection details** Click **Databricks**. A screen appears with details about the destination on the left, and on the right the fields required to establish the integration. Provide the following: a. Enter a name for the Destination. b. Enter the **Destination Instance Name**. c. In the **Databricks Host** field, enter your Databricks workspace URL. d. In the **Databricks Access token** field, provide the Databricks personal access token for API authentication. e. In the **Cluster ID** field, enter the Databricks cluster ID where the job should run. f. In the **Catalog** field, enter the Unity Catalog name used for table registration in Databricks. g. In the **Schema** field, enter the schema (or database) name in the Databricks metastore. h. In the **Table** field, enter the table name where the data should be written in Databricks. i. In the **Upload Type** drop-down, choose the upload type that defines the kind of connection or location you want to push your data to. Currently only **GCP** upload type is supported. j. In the **Bucket** field, enter the name of the Google Cloud Storage bucket where input files are stored. k. In the **Project Id** field, enter the Google Cloud project ID associated with your GCS bucket. l. Under **Account**, choose either **Zeotap Service Account** or **Client Service Account Json** from the drop-down, based on the type of authentication you need: * If you choose **Zeotap Service Account**, whitelist the service account provided by Zeotap CDP so audiences (segments) can be pushed from Zeotap CDP to Google Cloud Storage. The service account information auto-populates under **Service Account to be Whitelisted**. * If you choose **Client Service Account Json**, upload the JSON file carrying the required authentication information using the **+ Select File** option, so that Zeotap CDP can push the audiences to Google Cloud Storage. **5. Choose the action and define the mapping** In the new screen that appears, choose the appropriate [action and mapping](/articles/integrate-customer/destinations#define-the-mapping). Under **Choose your Action**, select **Send JSON file to GCS** as the action for activating your audience (segment) in Audiences. You can send any number of identifiers and attributes to your **Databricks** instance using this action. ![Choose your Action step with the mapping fields for the Databricks destination](https://mintcdn.com/zeotap/Yl1hDNuL3ftKLMn2/articles/integrate-customer/Storage/integrate-customer/databricks_destination/databricks_destination-2025-06-10-5.png?fit=max\&auto=format\&n=Yl1hDNuL3ftKLMn2\&q=85\&s=d2812d1dedc5b3caa6c8ff6706921fcf) **6. Create the destination** Click **Create Destination**. The created Destination gets listed in the **Audiences** application, ready to be linked to an audience. ## Link an audience to the destination Attach the destination you just created to a Zeotap audience from the **Audiences** application. For the full walkthrough, see [Link an Audience to the Destination](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts that share a defined criterion — for example, customers over 18 who performed an `addToCart` event in the last 30 days. ## Verify the destination worked After linking an audience and triggering an activation, confirm delivery end to end: 1. In Zeotap CDP, confirm the destination is listed in the **Audiences** application and linked to the audience you activated. 2. In your GCS bucket, confirm the activation run produced a JSON file. 3. In Databricks, query the `catalog.schema.table` you configured and confirm the rows have arrived with the identifiers and attributes you mapped. If the JSON file is in the bucket but the Databricks table has no new rows, the hand-off from GCS to Databricks is the part to check — Autoloader reads the bucket, not Zeotap CDP. If neither the bucket nor the table has data, work through the table below. ## Troubleshooting | Symptom | What it means | Where to look | | - | - | - | | No file appears in the GCS bucket after an activation run | The service account is not whitelisted on the bucket, or the **Bucket** / **Project Id** value on the destination does not point at the bucket you are watching | Google Cloud → the target bucket → its permissions. Zeotap CDP → the destination configuration | | The **Client Service Account Json** is rejected, or uploads fail with it | The uploaded key belongs to a service account that cannot write to the target bucket | Google Cloud → the service account behind the JSON key → its access on the target bucket | | Files land in the GCS bucket but no rows appear in the Databricks table | Databricks Autoloader has not ingested yet, or it is not watching the bucket path the files land in | Databricks → the Autoloader stream or job that reads your GCS bucket | | The destination rejects the Databricks credentials | The personal access token has expired or been revoked | Databricks → **Settings → User Settings → Developer** → generate a new token, then edit the destination with the new value | | Rows arrive in Databricks but not where you expect them | The **Catalog**, **Schema**, or **Table** value on the destination points at a different three-level identifier than the one you are querying | Zeotap CDP → the destination configuration. Compare it with `catalog.schema.table` in Databricks | If deliveries still fail after these checks, contact the Zeotap support team at [support@zeotap.com](mailto:support@zeotap.com). Include the destination name, the Databricks catalog, schema, and table, the GCS bucket name, and the time of the failed run. ## FAQ > [accordion] Can I send event data to Databricks with this destination? > > No. Sending of event data is not supported currently. You can send any identifier or attribute of your choice from Zeotap CDP to Databricks. > [accordion] Can I stage the files somewhere other than Google Cloud Storage? > > No. Only the **GCP** upload type is supported today, so every Databricks destination writes to a GCS bucket first and Databricks Autoloader reads from there. > [accordion] Should I use the Zeotap Service Account or my own service account JSON? > > Either works. Choose **Zeotap Service Account** if you would rather whitelist the service account Zeotap provides on your bucket — the value auto-populates under **Service Account to be Whitelisted** during setup. Choose **Client Service Account Json** if you would rather supply your own service account key and upload it with the **+ Select File** option. > [accordion] Is the Catalog field the same as the Zeotap Catalogue? > > No. **Catalog** on the destination form is the Databricks Unity Catalog (or metastore) catalog that holds your schema and table. The Zeotap CDP **Catalogue** is a separate concept — the layer where ingested fields are mapped to customer attributes before you build an audience. > [accordion] What actually writes the rows into my Databricks table? > > Databricks Autoloader does. Zeotap CDP's part ends when the audience file is written into your GCS bucket; Autoloader picks the file up from there and loads the records into Delta tables. The **Schema** you enter is where the table exists or will be created, and the **Table** is the target table the data is loaded into. ## Next steps * [Explore the Databricks source →](/articles/integrate-customer/databricks) — pull data from a Databricks table into Zeotap CDP * [Explore linking an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) — activate an audience against the destination you just created * [Explore how destinations, actions, and mappings fit together →](/articles/integrate-customer/destinations#key-concepts) * [Explore ID extension for audiences →](/articles/segment-customer/extend-your-audience#id-extension) — expand your audience across identifier types before sending to Databricks * [Explore delta upload and delete functions →](/articles/segment-customer/delta-upload-and-delete-functions) # Decentriq Source: https://docs.zeotap.com/articles/integrate-customer/decentriq Send audience data from Zeotap CDP to a Decentriq datalab as a batch destination, for privacy-safe collaboration in a data clean room. Decentriq is a **batch destination**: data flows out of Zeotap CDP to Decentriq, where it lands in a datalab for privacy-safe collaboration in a data clean room. You activate it by linking an audience to the destination, not from a journey. Zeotap CDP does not offer a Decentriq source, so this page has no opposite-direction counterpart — Decentriq appears in the [integrations master list](/articles/integrations-master-list-publication/integrations-master-list) as a destination only. ## What this is A Decentriq destination connects one Zeotap CDP organisation to one Decentriq datalab. Once connected, the audiences you activate are delivered to that datalab as datasets that Decentriq validates and makes available inside the clean room, so you and your partners can collaborate on overlapping customers without either side exposing raw customer records. Data is encrypted on the client side before it is uploaded to Decentriq. Zeotap sends three kinds of data, each through its own action: the matching identifiers that let Decentriq find common users, the segment memberships that describe what those users are interested in, and the demographic attributes that describe who they are. The in-product guidance on the destination form frames this as a publisher contribution — the audience data you send forms the base audience that a partner's seed audience is matched against in Decentriq's Media DCR. ## Supported identifiers and actions A Decentriq datalab is keyed on a single matching identifier, which you choose when you create the datalab. The identifier types available for the matching dataset are SHA-256 hashed email, phone number, hashed phone number, OneID, Utiq, netID, First-id and RampID. Each kind of data is sent by its own action, selected in the destination's **Mapping** step. The destination fields each action requires are: | Action | Destination fields | | :- | :- | | Send Matching as Publisher | User Id, Matching ID | | Send Segments as Publisher | User Id, Segment List | | Send Demographics as Publisher | User Id, Age, Gender | The **User Id** value groups a user's records together across the three actions, so map it from the same Catalogue attribute every time. If the same person carries one value in the matching data and a different value in the segments data, Decentriq treats them as two users. ## Prerequisites > [!NOTE] > > **Before you start, make sure you have:** > > **In Decentriq** > > * An active Decentriq account that can create datalabs and generate API tokens. > * A datalab that will receive the data, created with the data types you intend to send. > * An API token, generated in Decentriq and copied. > * The Data Lab ID of that datalab. > * The email address of the Decentriq account you are using. > > **In Zeotap CDP** > > * Rights to create a destination in the organisation that will own it. See the prerequisites on [Destinations](/articles/integrate-customer/destinations#prerequisites). > * An [audience](/articles/segment-customer/create-an-audience) holding the cohort you want to send. > * The Catalogue attributes you will map — a user identifier, your segment membership attribute, and age and gender if you are sending demographics. ## Set up the Decentriq side Decide which data types the datalab will hold and generate the credentials before you open Zeotap, because the datalab's configuration cannot be worked around from the Zeotap side. **Step 1** Log in to Decentriq. **Step 2** Open the account menu from the avatar at the bottom of the left sidebar. ![The Decentriq platform home page with the account menu open, listing API tokens, Delete account and Log out.](https://mintcdn.com/zeotap/5jqEMeXCr_Lmm-mS/articles/integrate-customer/Storage/integrate-customer/decentriq/decentriq-p4-1.jpeg?fit=max\&auto=format\&n=5jqEMeXCr_Lmm-mS\&q=85\&s=b5f6fef4b38867860f9c815bcd79c953) **Step 3** Select **API tokens**. **Step 4** Use **Add new access token** to create a token, or pick one you already hold. Copy it with the copy icon on the token's row and keep it somewhere secure — you will paste it into Zeotap. ![The Decentriq API tokens page with the Add new access token field and an existing token row showing copy and delete icons.](https://mintcdn.com/zeotap/5jqEMeXCr_Lmm-mS/articles/integrate-customer/Storage/integrate-customer/decentriq/decentriq-p4-2.jpeg?fit=max\&auto=format\&n=5jqEMeXCr_Lmm-mS\&q=85\&s=7bb6f1f4ed31d7d84cf0a3ea9b0066b6) **Step 5** Go to **Datalabs** and open the datalab you want to use, or create one. In the **Create new datalab** dialog, give the datalab a **Name**, then choose the data it will hold. **Use matching data** is always on and cannot be cleared. Tick **Use demographics data** and **Use segments data** for whichever of those you intend to send. Leave **Use user embedding data** unticked — this integration does not send embeddings. Select the **Matching ID** the datalab will be keyed on, then click **Create Datalab**. ![The Create new datalab dialog in Decentriq, with a Name field, tickboxes for matching, demographics, segments and user embedding data, and a Matching ID selector.](https://mintcdn.com/zeotap/5jqEMeXCr_Lmm-mS/articles/integrate-customer/Storage/integrate-customer/decentriq/decentriq-p5-3.jpeg?fit=max\&auto=format\&n=5jqEMeXCr_Lmm-mS\&q=85\&s=b1aef120ad73e7657f3ddda1c74c46da) > [!WARNING] > > The data types are fixed when the datalab is created. If you later activate an audience carrying segments or demographics to a datalab that was created without them, that data has nowhere to land. **Step 6** Copy the datalab's ID and note the email address of the Decentriq account you are signed in as. You should now have four values: the Decentriq account email, the API token, the Data Lab ID, and a note of which data types the datalab accepts. ## Create the Decentriq destination **Step 1** In Zeotap CDP, go to **Integrate** > **Destinations** and click **+ Create Destination**. ![The Integrate Destinations list in Zeotap CDP, with the Private Destination tab open and the Create Destination button in the top right.](https://mintcdn.com/zeotap/5jqEMeXCr_Lmm-mS/articles/integrate-customer/Storage/integrate-customer/decentriq/decentriq-p6-4.png?fit=max\&auto=format\&n=5jqEMeXCr_Lmm-mS\&q=85\&s=f4d72b065afcbc805046f54d133445e5) **Step 2** Under **All Destinations**, search for Decentriq and select the Decentriq card. ![The All Destinations catalogue in Zeotap CDP with the Search for a Destination box above a grid of destination cards.](https://mintcdn.com/zeotap/5jqEMeXCr_Lmm-mS/articles/integrate-customer/Storage/integrate-customer/decentriq/decentriq-p6-5.png?fit=max\&auto=format\&n=5jqEMeXCr_Lmm-mS\&q=85\&s=9f628ff4af141c971e51dd8deb0c7939) **Step 3** On **Enter Destination Details**, complete the four fields: a. **Destination Name** — a name that identifies this connection in the destinations list. b. **Decentriq API Token** — the token you copied from Decentriq. c. **Decentriq Email** — the email address of your Decentriq account. d. **Decentriq Data Lab ID** — the ID of the datalab that will receive the data. ![The Enter Destination Details step of the Decentriq destination wizard, showing the Destination Name, Decentriq API Token, Decentriq Email and Decentriq Data Lab ID fields.](https://mintcdn.com/zeotap/5jqEMeXCr_Lmm-mS/articles/integrate-customer/Storage/integrate-customer/decentriq/decentriq-p7-6.png?fit=max\&auto=format\&n=5jqEMeXCr_Lmm-mS\&q=85\&s=a4ee5d618a01b7f30c41b12f1069bd17) **Step 4** Move on to the **Mapping** step. Under **Choose your Action**, select **Send Matching as Publisher**, then under **Map the Fields** map a Catalogue attribute to each destination field: **User Id** and **Matching ID**. Map **Matching ID** from the identifier the datalab is keyed on. An identifier the datalab was not created for will not match. ![The mapping step with Send Matching as Publisher selected and the Map the Fields table showing Catalogue Field entries against the User Id and Matching ID destination fields.](https://mintcdn.com/zeotap/5jqEMeXCr_Lmm-mS/articles/integrate-customer/Storage/integrate-customer/decentriq/decentriq-p7-7.png?fit=max\&auto=format\&n=5jqEMeXCr_Lmm-mS\&q=85\&s=78e4228bce67990c832f8246b2c5a414) **Step 5** To send demographics, use the **Send Demographics as Publisher** action and map **User Id**, **Age** and **Gender**. ![The mapping step with Send Demographics as Publisher selected and the Map the Fields table showing the User Id, Age and Gender destination fields.](https://mintcdn.com/zeotap/5jqEMeXCr_Lmm-mS/articles/integrate-customer/Storage/integrate-customer/decentriq/decentriq-p8-8.png?fit=max\&auto=format\&n=5jqEMeXCr_Lmm-mS\&q=85\&s=fb93a1423fa0824f17202dcb905d260a) **Step 6** To send segment memberships, use the **Send Segments as Publisher** action and map **User Id** and **Segment List**. Segment List carries a **Segment Name** sub-attribute — map it from your segment membership attribute so Decentriq receives readable segment names rather than raw IDs. ![The mapping step with Send Segments as Publisher selected and the Map the Fields table showing the User Id and Segment List destination fields.](https://mintcdn.com/zeotap/5jqEMeXCr_Lmm-mS/articles/integrate-customer/Storage/integrate-customer/decentriq/decentriq-p8-9.png?fit=max\&auto=format\&n=5jqEMeXCr_Lmm-mS\&q=85\&s=f05eb6d118408ef1849e4c2079ed9ac2) **Step 7** Review the details and the mapping, then save the destination. A destination can carry more than one mapping, one per action — see [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping) for how actions and mappings relate. ### What Decentriq expects in each dataset The data arrives in Decentriq as datasets. These constraints apply to what you send: | Dataset | Field | Notes | | :- | :- | :- | | Matching | User Id | The internal user identifier. Must be consistent across all three datasets and cannot be null. | | Matching | Matching ID | The identifier used to match with partners. Must be unique per row — duplicate values cause validation errors. | | Segments | User Id | The same user identifier as above. A user can appear on several rows, one per segment. | | Segments | Segments | The readable segment name, for example "Tech Enthusiasts". Spell it consistently. A minimum of 10 and a maximum of 2,000 distinct segments. | | Demographics | User Id | The same user identifier as above. Unique in this dataset — one row per user. | | Demographics | Age | An age bracket as a string, for example "18-25". A maximum of 10 age buckets is recommended. | | Demographics | Gender | A gender value as a string. Spell it consistently — "M" and "Male" count as two values. A maximum of 5 gender values is recommended. | > [!WARNING] > > Inconsistent spelling is the quietest failure here. A segment sent as both "Tech Enthusiasts" and "tech enthusiasts", or a gender sent as both "M" and "Male", is counted twice in the clean room and splits your analysis across values that should have been one. ## Link an audience to the destination Decentriq is a batch destination, so you activate it by linking an audience to it in the **Audiences** or **Target** application — not from a journey. The action and mapping you created above are selected there, under **Choose your Action and Mapping**. For the full activation flow, including output identifiers and refresh frequency, see [Activate your batch audiences](/articles/integrate-customer/link-an-audience-to-the-destination). Send each kind of data by linking the audience with the matching action: one activation per action, against the same destination. ## Verify the data landed in Decentriq **Step 1** In Zeotap CDP, confirm the audience–destination pair completed its refresh with a non-zero qualified count. **Step 2** In Decentriq, open the datalab. It carries a **Validated** status once the data it received has passed validation. **Step 3** Check the datalab's statistics. **Share of users per segment** lists the segment names that arrived and the share of users in each; **Share of users per number of segments** shows how many segments users belong to. Confirm the segment names are the ones you expected and that none appear twice under different spellings. ![A Decentriq datalab marked Validated, with bar charts for share of users per segment and share of users per number of segments.](https://mintcdn.com/zeotap/5jqEMeXCr_Lmm-mS/articles/integrate-customer/Storage/integrate-customer/decentriq/decentriq-p11-10.jpeg?fit=max\&auto=format\&n=5jqEMeXCr_Lmm-mS\&q=85\&s=1e65a6730ebea7478b83a4f1e571c71f) The user count in Decentriq will be lower than the audience count in Zeotap — only users carrying the datalab's matching identifier can be matched. A count that is non-zero and in the same order of magnitude as the audience is the expected result. ## Troubleshoot the Decentriq destination | Symptom | What to check | | :- | :- | | The datalab shows no new data although the Zeotap refresh completed | Confirm the **Decentriq Data Lab ID** on the destination is the datalab you are looking at, and that the API token has not been deleted or regenerated in Decentriq. Then review the destination's activity for a delivery error — see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail). | | Segments or demographics never arrive, but matching data does | The datalab was created without **Use segments data** or **Use demographics data**. Those data types are fixed at creation, so the data has nowhere to land. Create a datalab with the right data types and point a destination at it. | | Validation fails on the matching dataset | Duplicate values in **Matching ID**. Each row must carry a unique value. | | A user appears in the matching data but not in their segments or demographics | **User Id** was mapped from a different Catalogue attribute in one of the mappings. Map it from the same attribute in all three. | | The match rate is far lower than expected | The identifier mapped to **Matching ID** is not the one the datalab is keyed on, or it has thin coverage across your users. Check the datalab's **Matching ID** selection against the mapping. | | The same segment appears twice in the datalab's statistics | Two spellings of one segment name reached Decentriq. Correct the source values and re-activate. | | The audience–destination pair stays in progress with no error | Compare the pair's status against what the datalab actually shows. If the datalab has the data but Zeotap still reports in progress, or neither moves beyond the expected refresh window, raise a support ticket — see [When to contact support](/articles/integrate-customer/destinations#when-to-contact-support) for the details to include. | ## FAQ > [accordion] Can I send more than one matching identifier per user? > > No. A datalab is keyed on a single **Matching ID**, chosen when the datalab is created, and each user is matched on that one identifier. Choose the identifier with the broadest, most reliable coverage across your users, because it sets the ceiling on your match rate. To match on a different identifier, create a second datalab keyed on it and a destination pointing at that datalab. > [accordion] Can I send segments or demographics without matching data? > > No. **Use matching data** is always on in the **Create new datalab** dialog and cannot be cleared, because the matching identifiers are what let Decentriq resolve a user at all. Segments and demographics describe users that the matching dataset has already identified. ## Next steps * [Activate your batch audiences →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Understand destinations, actions and mappings →](/articles/integrate-customer/destinations) * [Control which folders can use this destination →](/articles/integrate-customer/destination-access-rules) # Destination Access Rules Source: https://docs.zeotap.com/articles/integrate-customer/destination-access-rules Block specific destinations from individual audience and journey folders so each team activates only to the channels they should reach. ## What this is Destination Access Rules are a governance layer that lets admins block specific destinations from selected audience and journey folders. They control which activation channels each team can send to — useful when a destination is high-cost, regulated, region-specific, or reserved for compliance-reviewed audiences. They apply to the entire destination — there is no attribute-level or mapping-level granularity, because the concern here is which channel a team can activate to, not what data leaves in each record. Destination Access Rules are the third layer of Zeotap's governance model, alongside Folder Access Control and Mandatory Templates. For the full model, see [Access Rules](/articles/admin-customer/access-rules). ## When to use Destination Access Rules * **Restrict premium or high-cost channels.** A destination that carries significant activation cost stays available only in a compliance-reviewed folder and is blocked from other folders. * **Prevent unauthorised channel use.** A destination reserved for regulated communications is blocked from folders whose teams should not send through it. * **Enforce channel governance by region.** A destination configured for one market is blocked from folders that build audiences for other markets. * **Protect brand safety.** A high-visibility channel is blocked from folders whose audiences have not been reviewed. ## Prerequisites > [!NOTE] > > You need permission to view and edit access rules in your org. If your role does not include it, ask an admin — several built-in admin and manager roles carry this permission by default, and it can also be added to a custom role. See [Access Rules](/articles/admin-customer/access-rules) for the exact list of roles and how the governance layers fit together. ## How Destination Access Rules work By default, every destination is available across every folder — nothing is restricted until an admin configures a rule. Once a blocklist rule is configured for a destination: * The destination is blocked from the folders named in the rule. * All other folders retain access. * Subfolders inherit the restriction from their parent folder. * Folders created after the rule is set retain full access — a new folder must be added to the rule for the restriction to apply. * Moving a folder updates its restrictions to match the new parent: a restricted subfolder moved under an unrestricted parent loses the restriction, and an unrestricted subfolder moved under a restricted parent picks up the restriction. * Archive folders are outside the scope of access rules. ## Configure a rule for a destination Open the destination you want to govern and go to its access-rule view. From there you can: ![Access rule view of a destination before any rule is configured, showing the No Permission Configured empty state.](https://mintcdn.com/zeotap/zpfGPCWDn29TN7ot/articles/integrate-customer/Storage/integrate-customer/destination-access-rules/destination-empty-state.png?fit=max\&auto=format\&n=zpfGPCWDn29TN7ot\&q=85\&s=05ea3288184f65c1b96ff87ae9a8c590) 1. **Add a rule** — pick the audience and journey folders where the destination should be blocked, and save. The saved rule then lists the folders it covers. ![Select Folders dialog for choosing the audience and journey folders the destination is blocked from.](https://mintcdn.com/zeotap/zpfGPCWDn29TN7ot/articles/integrate-customer/Storage/integrate-customer/destination-access-rules/destination-select-folders.png?fit=max\&auto=format\&n=zpfGPCWDn29TN7ot\&q=85\&s=c3d6c7ae2057c911d90a9b6fd39d0a37) ![Saved destination access rule listing the blocked audience and journey folders.](https://mintcdn.com/zeotap/zpfGPCWDn29TN7ot/articles/integrate-customer/Storage/integrate-customer/destination-access-rules/destination-rule-listed.png?fit=max\&auto=format\&n=zpfGPCWDn29TN7ot\&q=85\&s=5295e09cd77c666c2342a9fcd631fbb9) 2. **Edit an existing rule** — add or remove folders on the rule's folder list and save. 3. **Delete a rule** — clear every folder from the rule, or remove individual folders one at a time. A worked example — restricting a premium DMP to a single compliance folder: ```json theme={null} { "destination": "premium-dmp", "blocked_folders": { "audiences": ["marketing/eu", "marketing/us", "growth/acquisition"], "journeys": ["marketing/eu"] }, "unrestricted_folders": ["compliance/reviewed-segments"] } ``` Any audience or journey built inside `marketing/eu`, `marketing/us`, or `growth/acquisition` cannot use the `premium-dmp` destination. Audiences built inside `compliance/reviewed-segments` continue to reach it. Any subfolder under `marketing/eu` inherits the same block. > [!WARNING] > > A blocked destination does not stop existing audiences and journeys from running — their active syncs continue. It does stop republishing: any audience or journey that used the now-blocked destination is flagged and cannot publish further changes until the conflict is resolved. ## Verify the rule is in effect You know the rule is applied when all of the following are true in a blocked folder: * Building a new audience in that folder, the destination is absent from the destination list. * Building a new journey in that folder, the destination is absent from the destination list. * Any existing audience or journey in that folder that used the destination shows a restricted-destination warning — both on the folder view and on the audience or journey definition itself. * Republishing changes to a flagged audience or journey is blocked until the destination is removed from the definition or the rule is updated. ![Journey builder canvas with a restricted-destination warning banner explaining which destination is blocked and what action is required.](https://mintcdn.com/zeotap/zpfGPCWDn29TN7ot/articles/integrate-customer/Storage/integrate-customer/destination-access-rules/destination-flagged-journey.png?fit=max\&auto=format\&n=zpfGPCWDn29TN7ot\&q=85\&s=28440e51d58436db4b95edaf908c5720) ## Troubleshooting | What you see | What it means | Where to look | | - | - | - | | The destination is missing from the destination list in a folder | The destination is blocked from that folder (or a parent folder) by a rule | The destination's access-rule view — check which folders the rule covers | | A restricted-destination warning on an audience after a rule change | The audience uses a destination that a rule now blocks from its folder | The audience definition — remove the destination, or ask an admin to update the rule | | A restricted-destination warning on a journey after a rule change | The journey uses a destination that a rule now blocks from its folder | The journey definition — remove the destination, or ask an admin to update the rule | | Republishing a flagged audience or journey is not allowed | Zeotap blocks republish until the destination conflict is resolved | The audience or journey definition — resolve the flag first | | A newly-created folder still shows a destination that other folders block | New folders are not added to existing rules automatically | The destination's access-rule view — add the new folder to the rule | | A moved subfolder's destination access changed unexpectedly | Moved folders inherit the new parent's restrictions | Confirm the move is intentional; if not, move the folder back or update the rule | ## FAQ > [accordion] Does blocking a destination stop audiences that already sync to it? > > No. Existing audiences and journeys continue to run against the destination without interruption. They are flagged for review and cannot publish further changes until the conflict is resolved, but their active syncs are not paused. > [accordion] Can I block a destination for only some attributes or mappings? > > No. Destination Access Rules apply to the entire destination. For attribute-level control, use [Source Access Rules](/articles/integrate-customer/source-access-rules) on the source that carries the attribute. > [accordion] Do new folders inherit existing destination rules? > > No. A folder created after a rule was set retains full access to the destination. The folder must be added to the rule explicitly for the block to apply. > [accordion] What happens if I move a restricted folder? > > The folder's restrictions update to match its new parent. A restricted subfolder moved under an unrestricted parent loses the restriction; an unrestricted subfolder moved under a restricted parent picks up the restriction. ## Next steps * Explore [Access Rules](/articles/admin-customer/access-rules) — the full governance model, the roles that can configure rules, and how the three layers fit together → * Explore [Source Access Rules](/articles/integrate-customer/source-access-rules) — the attribute-level control that complements destination-level blocking → * Explore [Batch Real Time Destination Integration](/articles/integrate-customer/batch-real-time-destination-integration) — a representative destination you can govern with these rules → * Explore [Amazon Conversions API](/articles/integrate-customer/amazon-conversions-api) — another destination that fits governance by folder → # Batch Destination Integrations Source: https://docs.zeotap.com/articles/integrate-customer/destination-batch-integrations How Zeotap CDP delivers audiences and events to destinations in scheduled batches, and how to configure and verify one. ## What this is Batch destination integrations in Zeotap CDP deliver audiences and events to downstream platforms in scheduled bulk transfers rather than one record at a time. Each batch is assembled from your linked segment and sent to the destination — either through the platform's API (as with Batch CEP) or as a file drop into cloud storage the destination reads from (as with Adobe Campaign, which supports S3 or Azure). This page explains the shared model, the fields common to batch destinations, and how to verify a delivery landed. For the full catalogue of every supported source and destination, see the [integrations master list](/articles/integrations-master-list-publication/integrations-master-list). ## Prerequisites > [!NOTE] > > Before configuring a batch destination, gather: > > * Access to the Zeotap CDP **Integrate** module with permission to create destinations. > * Credentials for the destination platform — for API-based batch destinations, an API key or bearer token (for example, the Batch REST API Key and Project Key); for storage-based batch destinations, cloud storage credentials (for example, an S3 access key and secret, or an Azure account key). > * The segment or audience you plan to link, and the identifier type it carries (email, custom ID, MAID, or install ID). > * A refresh frequency decision (one-time, scheduled, or continuous) that fits your campaign cadence. ## How batch delivery works Batch delivery groups records into a single unit of work before sending. The exact trigger depends on the destination: * **API-based batch destinations** split large audiences into sequential API requests against the same named audience. For Batch CEP, each request supports up to 10,000 IDs, and Zeotap splits larger audiences automatically. * **Storage-based batch destinations** aggregate records and drop a file when either a size threshold or a processing-time threshold is reached — whichever hits first. Adobe Campaign supports a maximum batch size of 10 MB and a maximum processing time of 15 minutes. For storage-based destinations, the delivered file follows a fixed naming pattern using the prefix you configure, a file number, the channel ID, and an epoch timestamp: ```text theme={null} {filenamePrefix}{fileNumber}_${channelId}_${timestamp}.csv ``` The filename prefix accepts plain text without special characters such as underscores (`_`), spaces, or symbols (`#`, `@`, `$`, `%`, `&`, `*`). ## Configure a batch destination The setup shape is common across batch destinations; exact field names differ per connector, so follow the connector-specific page for the destination you are using. 1. Open the Destinations catalogue in Zeotap CDP and create a new destination for the platform you want to send to. 2. Enter the connection credentials the destination requires — an API key or bearer token for API-based batch destinations, or cloud storage credentials (bucket or container, folder, access key, and filename prefix) for storage-based batch destinations. 3. Choose the action and map fields. Map the identifier (email, custom ID, MAID, or install ID) and any attributes you want to send. For Batch CEP, up to 15 attributes per user are sent; attributes mapped beyond the fifteenth are not sent. 4. For destinations that use an audience type field (for example, Batch CEP), set the audience type so it matches the identifier you mapped — `Custom Ids`, `Emails`, or `Install Ids`. If the audience type does not match the identifier, Batch rejects the records or creates an audience that cannot be activated. 5. Save the destination, then link it to your segment and pick a refresh frequency. For the general linking flow, see [Link an Audience to the Destination](/articles/integrate-customer/link-an-audience-to-the-destination). ## Verify the delivery worked You verify a batch delivery in the destination platform, not in Zeotap CDP: * **API-based batch destinations** — the audience appears in the destination platform's audience list with an identifier count close to your segment size. In Batch, open **Data → Audiences**, open the audience Zeotap created, and check the identifier count. Batch processes records asynchronously; if counts do not appear immediately, refresh the audience view a few minutes later. * **Storage-based batch destinations** — the CSV file lands in the bucket or container and folder you configured, named to the `{filenamePrefix}{fileNumber}_${channelId}_${timestamp}.csv` pattern. A successful delivery shows the expected identifier count in the destination platform with the correct audience type, or a file at the expected path in your cloud storage. ## Troubleshoot common issues | What you see | What it means | Where to look | | - | - | - | | Batch rejects the records, or the audience cannot be activated | The Batch CEP audience type does not match the mapped identifier (for example, mapping an email into a `Custom Ids` audience) | Zeotap destination configuration; then, in Batch, the audience under **Data → Audiences** | | Some mapped attributes do not appear in Batch | More than 15 attributes were mapped; attributes beyond the fifteenth are not sent | Zeotap destination mapping | | Batch CEP audience creation fails | Audience name contains characters outside letters, numbers, underscores, and hyphens; contains spaces or accents; or exceeds 255 characters | Zeotap destination configuration (audience name field) | For destination-specific setup and error handling, see the connector page for the destination you are using. ## Next steps * [Explore the Batch CEP destination setup →](/articles/integrate-customer/batch-audience-management) * [Explore the original Batch destination →](/articles/integrate-customer/batch) * [Explore Adobe Campaign real-time integration with batching options →](/articles/integrate-customer/adobe-campaign-real-time-integration) * [Explore the batch and real-time destination integration reference →](/articles/integrate-customer/batch-real-time-destination-integration) # Destinations Source: https://docs.zeotap.com/articles/integrate-customer/destinations Send unified customer data from Zeotap CDP to external marketing and advertising platforms for activation. ## What Destinations are Destinations are the activation layer of Zeotap CDP. After you ingest sources, unify customer profiles, and build an audience, a destination is where that audience is sent — a connected ad account, marketing platform, CRM, or warehouse that runs the campaign or stores the data. Each destination wraps three things you configure together: the **platform** (the external system such as Meta, Pinterest, Braze, Criteo, Google DV360, Amazon, Adform, or BigQuery), the **action** the destination performs on each delivery (for example, sending identifiers to a custom audience, syncing custom-event payloads, or upserting CRM records), and the **mapping** that controls which Catalogue fields and identifiers are sent for that action. A destination is not the same as a platform. A platform is the external product family; a destination is one specific ad account, workspace, or endpoint inside that platform. You can configure several destinations against the same platform — for example, one Meta destination per ad account, each scoped to a region or business unit — and reuse each one across audiences and journeys. ## Prerequisites > [!NOTE] > > Before you activate an audience to a destination, complete the upstream setup: > > * A **source** is connected and ingesting data — see [creating a source](/articles/integrate-customer/creating-a-source). > * The ingested fields are **mapped to the Catalogue** so identifiers and attributes resolve correctly downstream. > * An **audience** is defined with the criteria for the cohort you want to activate. > * Your role grants destination edit rights on the organisation that owns the destination. For the role-to-permission matrix, see [User Roles and Access](/articles/admin-customer/user-roles-and-access). > * For the platform side: credentials (API keys, ad-account IDs) for the external destination, plus any platform-specific limits — for example, Meta caps each ad account at 500 custom audiences, after which new audience syncs to that account fail. ## Key concepts * **Platform** — the external marketing or advertising product Zeotap delivers to. * **Destination** — a specific account or workspace inside a platform, configured once in Zeotap with credentials and reused across audiences and journeys. * **Action** — the operation the destination performs on each delivery: sending identifiers to a custom audience, upserting a CRM record, sending a custom behavioural event, exporting rows to a warehouse table, and so on. Each platform exposes a defined set of actions. * **Mapping** — the per-action configuration that names which Catalogue fields and output identifiers (such as MAIDs, cookies, hashed email IDs, and custom user IDs) Zeotap sends, and how each field maps to the destination's expected schema. A destination can carry several mappings, one per action. ## Configure a destination Destinations are configured in two places, and both create the same object: * From the **Destinations** module, when you want to set up the destination ahead of time and reuse it across audiences and journeys. See [Create a Destination](/articles/integrate-customer/create-a-destination). * From the **Audience** module while activating an audience, when you want to set up the destination inline at the moment of activation. Whichever entry point you use, the configuration covers the same three parts: enter the platform credentials, choose the action, and define the mapping. ### Define the mapping The mapping is where you control exactly what leaves Zeotap. For each action, Zeotap pre-populates the output identifiers the platform accepts (MAIDs, cookies, hashed email IDs, custom user IDs, and similar). From there, refine the mapping by: * **Selecting which identifiers to send** — keep the defaults the platform accepts, or narrow the list so only specific identifiers are delivered. ![](https://mintcdn.com/zeotap/Yl1hDNuL3ftKLMn2/articles/integrate-customer/Storage/integrate-customer/destinations/destinations-2023-11-07-1.png?fit=max\&auto=format\&n=Yl1hDNuL3ftKLMn2\&q=85\&s=895de22f70c508a84a3978fd7febcfec) * **Adding Catalogue fields** — extend the mapping with additional Catalogue attributes the action supports, such as event timestamps, monetary values, or custom event properties. ![](https://mintcdn.com/zeotap/Yl1hDNuL3ftKLMn2/articles/integrate-customer/Storage/integrate-customer/destinations/destinations-2023-11-07-2.png?fit=max\&auto=format\&n=Yl1hDNuL3ftKLMn2\&q=85\&s=5ed6ff1c05c1ca47c1dca80bc6662e50) * **Removing fields** — drop any field that is not required for the destination. Each action you configure needs its own mapping. A destination that performs more than one action (for example, sending identifiers to a custom audience and forwarding offline conversions) carries one mapping per action. A finished mapping produces a structured payload the destination receives. For offline conversions to Pinterest, for example, the outbound payload must include mandatory fields such as `event_id` and `event_time`, and the mapping is what guarantees they are populated: ```json theme={null} { "data": [ { "action_source": "offline", "event_name": "checkout", "event_id": "", "event_time": 1771545600, "user_data": { "em": "" }, "custom_data": { "currency": "EUR", "value": "189.94" } } ] } ``` If a mapping omits a field the destination requires, the destination rejects the payload — see [Why deliveries fail](#why-deliveries-fail). Before activating, you can [generate a payload preview](/articles/integrate-customer/payload-preview-for-destination-mappings) from the mapping screen to confirm the mapping produces the payload you expect. ## Activate an audience to a destination Once an audience is defined, you activate it to one or more destinations. You can activate immediately or schedule activation for later. At activation time you either pick a destination that already exists for your organisation or create a new one inline using the same configuration steps as the Destinations module. ![](https://mintcdn.com/zeotap/Yl1hDNuL3ftKLMn2/articles/integrate-customer/Storage/integrate-customer/destinations/destinations-2023-11-07-4.png?fit=max\&auto=format\&n=Yl1hDNuL3ftKLMn2\&q=85\&s=3ad1e1383e7e4f939b2450c7f7cc7aa9) ![](https://mintcdn.com/zeotap/Yl1hDNuL3ftKLMn2/articles/integrate-customer/Storage/integrate-customer/destinations/destinations-2023-11-07-3.png?fit=max\&auto=format\&n=Yl1hDNuL3ftKLMn2\&q=85\&s=584ba931ef0dc00f01afda8420997a8b) After activation, the audience and the destination are linked as an audience–destination pair. The pair tracks its own state — whether the latest refresh succeeded, when it last ran, how many customers were delivered — independent of the audience definition itself. ## Verify the activation worked After activating an audience to a destination, confirm delivery from two sides: 1. **In Zeotap** — open the affected destination and review its activity. A successful delivery records a run with a non-zero qualified count and a completed status. A run that fails records an error message you can use to diagnose the cause. 2. **In the destination platform** — open the corresponding custom audience, list, or table in the platform itself (for example, the Meta ad account's custom audiences page, the Braze segment, or the BigQuery table) and confirm the expected record count is present. The two counts will not match exactly — every platform applies its own match-rate filtering on the identifiers it receives — but both should be non-zero and within the same order of magnitude as the audience estimator's count. ## Why deliveries fail A destination delivery can fail at several points: the audience can return zero qualifying customers at runtime, the platform can reject the payload, or the platform's own account limits can be reached. The following errors surface on the audience–destination pair when this happens: | Error string | What it means | Where to look | | - | - | - | | `No customers qualified` | The audience definition returned zero qualifying records at the moment the refresh ran, even when the audience estimator showed a non-zero count. | The audience–destination pair's status, and the audience's own activity history. | | `Invalid permissions! Access denied.` | Your account does not hold the required role on the organisation that owns the destination. This surfaces in cross-org and parent–child org setups where role evaluation does not resolve against the target organisation. | The destination's settings page; your role assignments in [User Roles and Access](/articles/admin-customer/user-roles-and-access). | | `Destination Workflow failed due to inactivity for 24 hours` | A scheduled refresh produced no progress for 24 hours and the workflow was terminated. An automatic refresh is then queued. | The destination's activity history. | | `Refreshing audience membership data` (stuck) | The audience–destination pair is held in an in-progress state even after the downstream platform delivery has completed. | The audience–destination pair's status, compared against the actual delivery state in the external platform. | | `event_id is a required property, event_time is a required property` (or a similar mandatory-field rejection) | The destination platform rejected the payload because the mapping omitted a field the platform requires. | The destination's activity history; review the mapping for the action and confirm every mandatory field is populated. | | `You can not create CUSTOM audience because you can only have up to 500 audiences of this type.` | The external ad account has reached the platform's per-account custom-audience cap. New audience syncs to that account fail until existing audiences are removed or a different ad account is used. | The destination's activity history; the external ad account's audience list. | These are platform- and configuration-level errors you can act on directly. Errors that point to internal infrastructure require a support ticket. ## When to contact support Open a support ticket when: * The error on the audience–destination pair does not match any of the rows above, or it surfaces as a generic message with no platform-specific detail. * The destination platform confirms it received zero events, but Zeotap reports a successful refresh with a non-zero qualified count. * An audience–destination pair stays in an in-progress state for longer than the destination's expected refresh window and there is no error recorded. * A refresh that was previously running on schedule stops running entirely with no error recorded. Include in your request: the audience ID, the destination ID, the audience–destination pair ID, the timestamp of the last successful run, the timestamp and exact text of the failing run, and a screenshot of the destination's activity view. ## FAQ > [accordion] Why does the audience estimator show users but the destination delivers zero? > > The estimator queries the raw ingested tables directly, while activation runs against a unified store that is rebuilt on a fixed cadence. Data ingested between two unified-store refresh cycles is visible to the estimator but is not yet visible to activation, so a brand-new audience built on freshly ingested data can estimate non-zero and deliver zero on its first run. The next refresh, once the unified store has caught up, returns the expected count. > [accordion] Can I configure the same platform more than once? > > Yes. A destination is a single account inside a platform, not the platform itself. You can configure as many destinations as your organisation needs — for example, one Meta destination per ad account, or one BigQuery destination per target dataset — and activate any audience to any of them. > [accordion] Why was my refresh terminated after 24 hours? > > A destination workflow that records no progress for 24 hours is terminated and an automatic refresh is queued. This protects long-stuck deliveries from holding resources indefinitely. The next refresh runs against the latest unified-store data; persistent termination across runs is a signal to open a support ticket. > [accordion] What happens when an Access Rule blocks a destination on my folder? > > The destination does not appear in the activation list for that folder. Audiences and journeys already using the now-restricted destination keep running, but are flagged for review and cannot be republished until the conflict is resolved. See [Destination Access Rules](/articles/integrate-customer/destination-access-rules). ## Next steps * [Explore Destination Access Rules →](/articles/integrate-customer/destination-access-rules) * [Explore the full Access Rules governance model →](/articles/admin-customer/access-rules) * [Explore a worked destination integration with Batch →](/articles/integrate-customer/batch-real-time-destination-integration) * [Explore user roles and access for destinations →](/articles/admin-customer/user-roles-and-access) # Dotdigital Source: https://docs.zeotap.com/articles/integrate-customer/dotdigital Bring contact, campaign and engagement data from Dotdigital into Zeotap CDP on a scheduled sync. The Dotdigital source brings your customer data from Dotdigital **into** Zeotap CDP. To send audiences the other way — **out of** Zeotap CDP to Dotdigital — see the [Dotdigital destination](/articles/integrate-customer/dotdigital-1). ## What this is Dotdigital is a marketing automation platform that provides a CRM and multichannel (including email, SMS, social media, push notifications and more) messaging suite for marketers. Once the source is connected, Zeotap fetches your customer data residing in the Dotdigital platform through HTTP REST API calls and receives the target data as JSON responses, which are then ingested into the Zeotap system. The source syncs on a schedule rather than streaming in real time: the first sync runs when you create the source, and the ones after that follow the frequency you pick — daily, weekly or monthly. For example, a retailer whose customer information already sits in Dotdigital's CRM and messaging suite can bring that data into Zeotap CDP to build targeted customer segments, personalise campaigns across channels, and optimise messaging for engagement, conversions and loyalty. ## Supported objects Each Dotdigital source pulls one standard object. The objects you can choose from are: * Contacts * Campaigns * Preferences * Campaign Opens * Campaign Clicks * Campaign Page Views For the attributes each object carries, see [Dotdigital — attributes supported](/articles/integrations-master-list-publication/dotdigital-attributes-supported). ## Set up the source Setting the source up has two stages: 1. **In Dotdigital** — create an API user account. It gives you the User ID and password that Zeotap uses to authenticate its calls, and your Dotdigital account belongs to a region you will need to select later. 2. **In Zeotap CDP** — in the **Sources** application under **Integrate**, create a source with **Customer Engagement Channels** as the category, supply those credentials and the region, then choose the sync frequency and the standard object you want to pull. For the full walkthrough, see [Create a Dotdigital source](/articles/integrate-customer/create-a-dotdigital-source). ## Next steps * [Create a Dotdigital source](/articles/integrate-customer/create-a-dotdigital-source) — the step-by-step setup, including what to have ready before you start. * [Dotdigital destination](/articles/integrate-customer/dotdigital-1) — send audience identifiers from Zeotap CDP out to Dotdigital. * [Customer Engagement Channels (CE)](/articles/integrate-customer/customer-engagement-channels) — the other engagement-channel sources Zeotap supports. # Dotdigital (New) Source: https://docs.zeotap.com/articles/integrate-customer/dotdigital-1 Send Zeotap CDP audiences out to Dotdigital as address books, using raw email addresses, so your marketers can target them from a Dotdigital email campaign. ## What this is The Dotdigital destination sends audiences **out of Zeotap CDP to Dotdigital**, where each activated audience arrives as an address book that your marketers can target from an email campaign. Dotdigital is a customer engagement platform that helps digital marketers and developers deliver communications across the customer journey. They harness the power of customer data, powering engagement, conversion and loyalty for brands as they grow and scale. To move data in the opposite direction — from Dotdigital **into** Zeotap CDP — use the Dotdigital source instead. See [Dotdigital source](/articles/integrate-customer/dotdigital) and [Create a Dotdigital source](/articles/integrate-customer/create-a-dotdigital-source). ## Supported identifiers and actions This integration supports raw emails only. The following table lists the available action types for the integration and the supported features for each action type: | Action name | [ID extension](/articles/segment-customer/extend-your-audience#id-extension) | [Delete](/articles/segment-customer/delta-upload-and-delete-functions) | [Delta upload](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send identifiers to Dotdigital | ✅ | ✅ | - | ## Prerequisites Ensure that you have the following details about your Dotdigital account available before you create the destination: * **API user ID** * **API password** * **Region** The next two sections explain how to obtain each of them from the Dotdigital console. ## Set up Dotdigital ### Create an API user Before creating a destination, set up the API user and the corresponding password from the Dotdigital console. To do so, perform the following steps: **Step 1** Log in to the Dotdigital console. **Step 2** Click the three dots at the bottom-left corner of the screen and then click **Access**. ![The Dotdigital Access page with the bottom-left account menu open and Access highlighted](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dotdigital-2022-12-06.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=fa7edb03638c372ab076d329ee5a705a) **Step 3** Navigate to the **API users** tab and then click **NEW USER**. ![The API users tab of the Dotdigital Access page, with the NEW USER button highlighted above the list of existing API users](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dotdigital-2022-12-06-1.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=ed535e727bd143448bf6c6f45b09eabc) **Step 4** Enter the following details for the API user: a. Email address is auto-populated. b. Enter a **Password** and confirm it. c. Select the **Status** as **Enabled**. ![The Dotdigital Manage users form showing the auto-populated email address, the password and confirm password fields, the Status option set to Enabled, and the SAVE button highlighted](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dotdigital-2022-12-06-2.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=57e8e48fe87fed139da2501d2865ed3f) **Step 5** Click **Save**. ### Identify your region Dotdigital accounts belong to different regions, depending upon where they are based in the world. Note that you are not allowed to use an API endpoint belonging to a different region. ![The API users tab of the Dotdigital Access page, with the banner stating the account's API endpoint highlighted](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dotdigital-2022-12-06-3.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=95feee99f444e984245cddf389ce8f2f) In the above image, under the **API users** tab, you can see that the API endpoint is mentioned as `https://r1-api.dotdigital.com`. Here, r1 refers to Europe. Similarly, the regions and their corresponding region codes are tabulated below. | Region | Region ID | API domain | | :- | :- | :- | | Europe | `r1` | `r1-api.dotdigital.com` | | North America | `r2` | `r2-api.dotdigital.com` | | Asia Pacific | `r3` | `r3-api.dotdigital.com` | > [!NOTE] > > **Note:** > > To know how to identify the correct API endpoint on your account, see the [Dotdigital API conventions](https://developer.dotdigital.com/docs/api-conventions). ## Create the Dotdigital destination Perform the following steps to create a destination for Dotdigital: **Step 1** Log in to the Zeotap CDP app and go to **Integrate** > **Destinations**. **Step 2** Click **+ Create Destination**. ![The Zeotap CDP destinations listing, with the + Create Destination button highlighted in the top-right corner](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/ADOBE_DMP_3.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=50d0558618336ceb78709191fcdda472) **Step 3** Under **All Destinations**, search for **Dotdigital**. ![The All Destinations catalogue of destination tiles, with the search box highlighted](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/adobe-campaign/ADOBE_DMP_4.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=a0de06ff7f37752957c9f44c072aaebd) **Step 4** Click **Dotdigital**. A screen appears displaying details about the particular destination towards the left. On the right-hand side of the screen find a list of fields that are required for the integration to be established. Enter the required details as mentioned in the following steps: a. Enter a name for the destination. b. Enter the **API User ID**. c. Enter the **Password** that you created while setting up the API user. d. Select the **Region** of your Dotdigital account using the drop-down menu. The options are **Europe**, **North America** and **Asia Pacific**. e. Review all the values entered above and then click **Next** to proceed. ![The Enter Destination Details step of the Dotdigital destination, with fields for destination name, API User ID, Password and Region, and the Next button at the bottom right](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dotdigital_1.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=8b2ad19385866db4eb63c32535cd19c3) **Step 5** In the new screen that appears, choose the appropriate action and mapping as explained below. a. Choose the desired [action](/articles/integrate-customer/destinations#configure-a-destination) under **Choose your Action** and then choose the corresponding identifiers under **Choose your Output IDs to send to destinations**. By default, the [output identifiers](/articles/segment-customer/choose-the-output-identifiers) that are accepted by the platform such as MAIDs, cookies, email IDs and more are displayed. However, you can edit, add or remove an identifier from the list. To do so, see [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). b. Click **Create Destination**. The created destination gets listed in the **Audiences** application, which can be linked to an audience or segment. ![The mapping step of the Dotdigital destination, with Send identifiers to Dotdigital selected as the action and the Email Raw catalogue field mapped to the Email Raw destination field](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dotdigital_2.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=024d06bd00ff0cd1b613a0cbd8506163) ## Link an audience to the destination For information about how to link an audience or segment to the created destination in the **Audiences** application, see [Activate your batch audiences](/articles/integrate-customer/link-an-audience-to-the-destination). Note that if the segment size is small, then it is immediately populated at the Dotdigital seat. Otherwise, allow up to three business days for the segment to become available at the Dotdigital seat, as stated on the **Enter Destination Details** screen. > [!NOTE] > > **Note:** > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience or a segment can be a specific group of customers who are over 18 years of age and have performed an `addToCart` event within the last 30 days. ## How disqualified users are removed This integration supports user disqualification from audiences. That is, a user can be disqualified from an audience (segment) for various reasons, such as not meeting audience criteria, consent requirements or other conditions set for a particular audience. * When a user disqualifies from an audience, Zeotap CDP initiates a user deletion request in the next refresh cycle. These requests are sent to the audiences linked to the specific destination. * The disqualified users are excluded from the audiences based on the configured refresh frequency for a particular audience. * User disqualification is a programmatic process that works automatically. You do not need to specify anything to trigger the disqualification and exclusion of users from audiences. ## Verify the audience reached Dotdigital In the Dotdigital console, the segments pushed by Zeotap CDP appear under **Contacts** > **All contacts** > **Address books**. ![The Address books tab of the Dotdigital All contacts page, listing address books with their contact counts and an entry whose last modified by column shows API](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dotdigital-2022-12-06-5.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=2de784bad23d8ef6612743dcb946e2b9) ## Use the audience in a Dotdigital campaign To use a segment that you have created, log in to the Dotdigital console and perform the following steps: **Step 1** Under **Email campaigns**, click **New campaign**. ![The Dotdigital Email campaigns menu open with New campaign highlighted, and the Create, Content, Test, Contacts and Send steps shown at the top right](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dotdigital-2022-12-06-6.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=5b01cb357b4e14a4c47f0b42fb241586) **Step 2** Based on the use case, configure the **Create**, **Content** and **Test** tabs. **Step 3** In the **Contacts** tab, select the desired audience from the **Address books** displayed. ![The Contacts step of a Dotdigital campaign, showing the Choose an audience section with the Address books tab selected and an address book listed for selection](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dotdigital-2022-12-06-7.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=6c90bfd8452ce892785c7feed6b31df6) **Step 4** Click **SAVE & CONTINUE**. ## Troubleshoot the Dotdigital destination * **The region does not match your account.** You are not allowed to use an API endpoint belonging to a different region. Compare the API endpoint shown in the banner on the Dotdigital **API users** tab with the **Region** selected on the destination, and correct the destination if they differ. * **The audience does not appear in Dotdigital.** Look under **Contacts** > **All contacts** > **Address books** rather than under **Segments** — audiences activated from Zeotap CDP arrive as address books. For delivery errors reported on the Zeotap CDP side, see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail) and [When to contact support](/articles/integrate-customer/destinations#when-to-contact-support). ## Next steps * [Bring Dotdigital data into Zeotap CDP with the Dotdigital source →](/articles/integrate-customer/dotdigital) * [Activate your batch audiences →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Understand delta upload and delete functions →](/articles/segment-customer/delta-upload-and-delete-functions) * [Choose the output identifiers for a destination →](/articles/segment-customer/choose-the-output-identifiers) * [Explore how destinations work →](/articles/integrate-customer/destinations) # Dynamic Yield Source: https://docs.zeotap.com/articles/integrate-customer/dynamic-yield Send Zeotap CDP audiences, identifiers and attributes out to a Dynamic Yield User Data feed over Dynamic Yield's User Data API, then use them to build audiences and on-site personalisation campaigns. ## What this is Dynamic Yield is a **destination**: data flows out of Zeotap CDP to Dynamic Yield. Zeotap pushes the identifiers and attributes of an audience into a Dynamic Yield **User Data feed** using Dynamic Yield's User Data API, so the segments you build in Zeotap become audience conditions you can target in Dynamic Yield. Dynamic Yield is a personalisation platform that builds actionable customer segments in real-time, enabling marketers to increase revenue through personalisation, recommendations, automatic optimisation and one-to-one messaging. Its User Data API updates the User Data feed with the information used to create audiences from specified targeting conditions. The API carries a reduced load and works well for updating small numbers of users. Zeotap has four Dynamic Yield integrations. All four send data **to** Dynamic Yield — there is no Dynamic Yield source in this documentation, so data never flows back into Zeotap CDP from Dynamic Yield. | Integration | Use it to send | | - | - | | **Dynamic Yield** (this page) | Audience membership, identifiers and attributes, over the User Data API. Best for smaller updates. | | [Dynamic Yield: CSV upload](/articles/integrate-customer/dynamic-yield-csv-upload) | The same user data as a CSV file rather than API calls. Suited to large volumes. | | [Dynamic Yield Events](/articles/integrate-customer/dynamic-yield-events) | Real-time user interaction and behavioural events, over the Events API. | | [Dynamic Yield (RealTime)](/articles/integrate-customer/dynamic-yield-realtime) | The Journey ID, streamed as soon as a user qualifies for a Journey. | ## Supported identifiers and actions This integration supports SHA256 Hashed email, MAIDs, and Membership ID. You can also send any custom identifier and attributes — but you must first create them under the Data Feed in Dynamic Yield, as described in [Prerequisites](#prerequisites). The following table lists the available action types for the integration and the supported features for each: | Action name | [ID EXTENSION](/articles/segment-customer/extend-your-audience#id-extension) | [DELETE](/articles/segment-customer/delta-upload-and-delete-functions) | [DELTA UPLOAD](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send identifiers to Dynamic Yield | ✅ | - | - | | Send attributes and identifiers to Dynamic Yield Audiences | - | - | - | | Send attributes to Dynamic Yield (Array Operations) | - | - | - | ## Prerequisites Before you can push segments to Dynamic Yield, set up the User Data feed on the Dynamic Yield side: 1. Create a User Feed and obtain the Feed ID. 2. Choose a unique user identifier, or create one. 3. Decide which attributes (columns) to pass in the API, and set up the schema that determines where and how the information is stored in Dynamic Yield. 4. Create an API key. Once the Data Feed is set up, you can start sending audiences (segments) from Zeotap CDP to Dynamic Yield. > [!NOTE] > > For more information, refer to the [Dynamic Yield documentation](https://support.dynamicyield.com/hc/en-us/articles/4409595248017-Update-Your-User-Profile-Data-by-API#h_01HEQKN0GWZG127TJ14WAAJH77). ## Set up the user data feed in Dynamic Yield ### Step 1: Create a user feed and get the Feed ID In Dynamic Yield, a User Feed ID is a unique identifier for a set of user data feeds that drive personalised experiences across channels. A user feed can hold a variety of user data points, such as browsing history, purchase history and demographic information. **Step 1** Log in to your Dynamic Yield account. **Step 2** In the left navigation panel, click **Audience Hub**. **Step 3** Under Audience Hub, go to the **Extensions** tab. **Step 4** Under **Profile**, click **Add Source**. ![Dynamic Yield Audience Hub, Extensions tab: the User Data Enrichment card with an Events row and a Profile row, and the Add Source control on the Profile row.](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2024-12-04-2.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=43993753db6a8d32dcc1265ceaf0731a) **Step 5** On the screen that appears, under **Feed Source**, select **Sync via API**. The **Feed key** shown beneath it is your **User Feed ID** — copy it, and use it when you create the destination in Zeotap CDP. ### Step 2: Choose a unique user identifier or create one Under **Unique User Identifier**, you can choose **Email Address (CUID)** or **DYID** by default. To add a custom identifier instead: **Step 1** On the top bar, click **Settings > General Settings**. ![Dynamic Yield Settings menu open on the top bar, listing Integrations, API Keys, API Logs, Data Privacy and General Settings.](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2024-12-06-1.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=20495e11b263d904b75387b640c56a41) **Step 2** Under **User Identifier Types**, click **Add Identifier Type**, enter a name in **Identifier Name**, and click **Add**. ![Dynamic Yield User Identifier Types panel showing existing identifier chips, with the Add Identifier Type dialog open, showing the Identifier Name field and the Add and Cancel buttons.](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2024-12-06-3.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=9bd7a707128e89f3d24b9f9bc14d23d9) **Step 3** The new identifier is then listed under **User Unique Identifier** on the User Feed creation screen. ### Step 3: Define the data schema Under **Data Schema**, define the identifiers and attributes you want to send to Dynamic Yield. The **Schema Creator** gives you a no-code way to build it. ![Dynamic Yield Data Schema section with an empty schema editor and the Read documentation, Schema Creator and Copy example to clipboard links beside it.](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2024-12-06-6.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=d678895622aa303d136f28f7f562c981) **Step 1** Click **Schema Creator**. You can either build a schema from scratch or modify an existing one. ![Dynamic Yield User Data Schema Creator start screen offering Start from Scratch or Change an Existing Schema.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2024-12-06-7.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=09084f8bfd1e55bde9de92077527ba9f) **Step 2** If you choose **Start from Scratch**, fill in the row for each field: a. Under **Column name in your user data source**, enter the identifier name exactly as it appears in your data source. > [!WARNING] > > Use this same name in the **Destination** field (right-hand side) of the mapping screen when you [create the destination in Zeotap CDP](#create-the-dynamic-yield-destination). The name is **case-sensitive** — if `first_name` is your destination field in Zeotap, enter exactly `first_name` under **Column name in your user data source**. b. Under **Condition name in your audiences**, enter the name you want to see in Dynamic Yield audiences. c. Choose the **Condition type**. What you need here depends on the action you plan to use in Zeotap: | Zeotap action | What the schema must contain | | :- | :- | | **Send attributes and identifiers to Dynamic Yield Audiences** | Include **segment_id** and **segment_name**, in the format shown below. You can also map the **Membership ID** field. You can include any number of attributes and identifiers, depending on your use case. | | **Send attributes to Dynamic Yield (Array Operations)** | Include the **Membership ID**, in the format shown below. This action sends only the identifier (Email, Phone or Custom ID) — additional attributes are not supported. | d. For both actions, set the **Membership ID** field's **Condition Type** to **Text Array**. ![Dynamic Yield User Data Schema Creator with four rows built: segment_id and segment_name as Text, membership_ids as a Dropdown, and email as Text.](https://lh7-qw.googleusercontent.com/docsz/AD_4nXfuyTExR5-csgJINuhoSfIP1zzcaAbmdzb5YKkRilNxsZ3o52KV3x0DJdXoN65aZD3AWQH__DK6ASjdkn-6GconMHe8WQuOG1JlbzEpb2n9cU3cACFNvPwz3hUn_x70EdPRM4tUMQ?key=2az9z0GBMdA44qIboDxWBLSH) ![The generated schema JSON for the same four fields, with membership_ids typed as an array of strings and the remaining fields as strings, beside a Copy to clipboard control.](https://lh7-qw.googleusercontent.com/docsz/AD_4nXeotfMUSWykRwUO8bWuVASX7zpYe7Tdv2J2PmqbB9wBJZ3lyh55vsM43BG1hXtlGojZZWi9xSIeBxflTO_7EnGJLauKPMDs_BMYO1xUx-6t_WcAiw7v5uvcr_cneqHk6FlHHrF9qg?key=2az9z0GBMdA44qIboDxWBLSH) e. When the schema is complete, use **Copy to Clipboard** to copy it. **Step 3** Paste the copied schema into the space provided under **Data Schema**. ![Dynamic Yield Data Schema editor holding the pasted JSON, with a Sites/Apps targeting selector and the Save as Draft, Save & Activate and Cancel buttons below it.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2024-12-06-9.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=aacea9a3286e310cc84e98e805ca8de6) > [!NOTE] > > At this stage you may see an error such as `Illegal Character in: {Your Data Feed}`. If that happens, remove any special characters — hyphens or underscores, for example — from the data feed name. > > If you are editing an existing data feed and adding a field, include `"default": null` after `"uiType": "input"` in the data schema before you save it. **Step 4** Click **Save & Activate**. The User Feed is then listed on the **Data Feeds** page. ![Dynamic Yield Data Feeds page listing user data feeds with Type, Last Successful Sync, Sync Status, Settings Modified, Used By and Entries columns.](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2024-12-06-10.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=411ca961aeff4dc03107b6d9eb6b4065) ### Step 4: Create the API access token You need an API key to enter while creating the destination in Zeotap CDP. **Step 1** In the Dynamic Yield console, click **Settings > API Keys**, then click **New Key**. ![Dynamic Yield Audience Hub with the Settings item on the top bar highlighted and a Click here pointer aimed at it.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2025-01-26.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=20c8bf0dba41b1291f863a15120b9afe) **Step 2** In the window that appears: a. Enter a name, and internal notes if you want them. b. Under **Source**, select either **Server-side** or **Client-side**. Each type works only with its designated endpoint. c. In the **ACL** section, tick **User Data Profile**. d. Click **Save**. ![Dynamic Yield Create API Key dialog with Name and Notes fields, a Server-side or Client-side source choice, and ACL checkboxes for Experience API, User Data Profile and User Data Events.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2025-01-26-1.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=c4e17898ae24244b8fe92bab4fcfdb7f) **Step 3** The new API key is added to the list, where you can copy it for use in the next section. ![Dynamic Yield API Keys list showing each key's name, ACL scope, source and last-modified date, with a copy control in the Key column.](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2024-05-17-3.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=2780b0ee7c432ec10e99e479403102e5) ## Create the Dynamic Yield destination Once you have the prerequisites, create the destination in Zeotap CDP: **Step 1** Log in to the Zeotap CDP app and go to the **Destinations** application. **Step 2** Click **+ Create Destination**. ![Zeotap CDP Destinations list under Integrate, with Private and Public Destination tabs and the + Create Destination button.](https://mintcdn.com/zeotap/xGzkHY-dcQy5tLit/articles/integrate-customer/Storage/integrate-customer/ADOBE_DMP_3.png?fit=max\&auto=format\&n=xGzkHY-dcQy5tLit\&q=85\&s=102da1a60a97d389369069c7bad552ab) **Step 3** Under **All Destinations**, search for **Dynamic Yield**. ![Zeotap CDP All Destinations catalogue with the search box highlighted above a grid of destination cards.](https://mintcdn.com/zeotap/xGzkHY-dcQy5tLit/articles/integrate-customer/Storage/integrate-customer/ADOBE_DMP_4.png?fit=max\&auto=format\&n=xGzkHY-dcQy5tLit\&q=85\&s=6a7ff3c41d25bca380ad1cdfe0d1f678) **Step 4** Click **Dynamic Yield**. The left of the screen describes the destination; the right lists the fields the integration needs. Enter: a. A **name** for the destination. b. The **User Feed ID** (the feedKey) and the **API Access Token** you obtained from Dynamic Yield — see [Prerequisites](#prerequisites). c. Under **Cluster Region**, the region of your Dynamic Yield data centre. d. Under **User Unique Identifier in Dynamic Yield**, the identifier type you chose when creating the User Data Feed. Choose **Hashed Email Address** or **Custom Identifier**. * **Hashed Email Address** enables a **Unique Identifier for Email** field, auto-populated with the value `ihe`. * **Custom Identifier** requires the identifier name you added in Dynamic Yield. See [Prerequisites](#prerequisites) for how that identifier is created. e. Review the values, then click **Next** to go to mapping. ![Zeotap CDP Enter Destination Details screen for Dynamic Yield, with fields for the feedKey, API Access Token, Cluster Region and User Unique Identifier in Dynamic Yield.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2025-02-01-1.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=583e10112adbc59f75bb448869bc71f3) **Step 5** On the **Action and Mapping** screen, choose the action that matches what you want to send, then map the **Catalogue** fields to the **Destination** fields. a. **Send identifiers to Dynamic Yield** sends email addresses only. b. **Send attributes and identifiers to Dynamic Yield Audiences** and **Send attributes to Dynamic Yield (Array Operations)** let you send identifiers and attributes. Note the following: i. You can map the **Membership ID** field. * For **Send attributes and identifiers to Dynamic Yield Audiences**, Zeotap sends a full refresh of the entire **Membership ID** list on every upload. Zeotap also sends the **Segment ID** and **Segment Name** the user belongs to, provided you included those fields in the User data schema in Dynamic Yield — you do not map them on the Zeotap mapping screen. * For **Send attributes to Dynamic Yield (Array Operations)**, Zeotap sends only the updated values for the **membership_id** field. A full data refresh is sent each month so that no data is lost. ii. If you are sending an **Email address** with either of these two actions, map the value `ihe` in the **Destination** field (right-hand side). iii. If you are using a custom identifier, enter in the **Destination** field the exact value you defined in Dynamic Yield when you created the identifier. For example, if the identifier is named `customer_id` in Dynamic Yield, enter `customer_id` in the Destination field in Zeotap. ![Zeotap CDP Action and Mapping screen with the Dynamic Yield action selected and two attribute mappings: Segment Membership to Segment Membership, and Email SHA256 Lowercase to ihe.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2025-02-01-2.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=7182f7649bc0881424a0c92d2a35dee4) **Step 6** When the mapping is complete, click **Create Destination**. The destination becomes available in the **Audiences** application, where you can link it to an audience (segment). ## Link an audience to the destination For how to link an audience to the destination in the **Audiences** application, see [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination). For the generic mapping and activation behaviour shared by all destinations, see [Configure a destination](/articles/integrate-customer/destinations#configure-a-destination) and [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). Depending on the volume of data sent and your position in the data pipeline, it can take up to two business days for audiences (segments) to be available in the Dynamic Yield seat. > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience or a segment can be a specific group of customers who are over 18 years of age and have performed an `addToCart` event within the last 30 days. ## Verify the data reached Dynamic Yield Check both sides: 1. **In Zeotap** — open the destination and review its activity. A successful delivery records a run with a non-zero qualified count and a completed status; a failed run records an error message. See [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). 2. **In Dynamic Yield** — open the **Data Feeds** page. The row for your user feed shows **Last Successful Sync**, **Sync Status**, **Used By** and **Entries**, so you can confirm the feed has received data and is attached to an audience. Allow for the delivery window described above before treating an empty feed as a failure. ## Build audiences and campaigns in Dynamic Yield Once the feed carries your Zeotap data, turn it into a Dynamic Yield audience: **Step 1** Log in to the Dynamic Yield UI. **Step 2** Under the **Audience** tab, go to **Audience Manager** and click **Create Audience**. ![Dynamic Yield Audience Hub, Audience Manager tab, with the Create Audience button above the All Audiences table.](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2024-05-17-14.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=ddafe533faf8c0b65bdfb16abae6d8f0) **Step 3** From the options, select **User Attributes**. ![Dynamic Yield audience type picker offering User Attributes and Campaign Traffic.](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2024-05-17-15.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=ca5b5f4f896f1cc5ad158bb36ae56d91) **Step 4** Enter a name for the audience. **Step 5** Under **Conditions**: a. In the first field, choose the User Data Feed to include in this audience. b. In the second field, select the Segment ID, Segment Name, or any other identifier or attribute you sent from Zeotap. Add further conditions for as many attributes as you need. c. In the third field, choose the operator — `Is`, `contains`, `equals` and so on. d. In the fourth field, choose a value. The values populate from the User Data Feed you selected. e. Set the condition timeframe to at most 30 days. Options for 3 months and 1 year are shown but cannot be selected — choosing one returns the message "Projected performance is not supported for audience time frame over 30 days". f. When the conditions are set, click **Save Audience**. ![Dynamic Yield New Audience screen with a condition row built from a user data feed and a Membership IDs attribute, and the Projected Audience Performance panel below.](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2024-05-17-16.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=8aba4292fb09f660677a0f030b9b79c8) **Step 6** Under the **Projected Audience Performance** tab, you can see the projected audience size for the selected timeframe. **Step 7** Use the audiences created here to build campaigns under **Web Personalization** in Dynamic Yield. ![Dynamic Yield Web Personalization campaigns screen and the campaign type picker, offering client-side types such as Dynamic Content, Recommendations, Overlay and Notification alongside server-side API types.](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2024-12-06-14.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=44422d94d7e360cfb91eb4ee9a8d0cd6) ## Troubleshoot the Dynamic Yield integration | Symptom | Cause | What to do | | :- | :- | :- | | Saving the schema returns `Illegal Character in: {Your Data Feed}` | The data feed name contains a special character. | Remove hyphens, underscores and other special characters from the data feed name, then save again. | | Saving an edited data feed fails after you add a field | The added field is missing its default. | Include `"default": null` after `"uiType": "input"` in the data schema before saving. | | An attribute arrives in Dynamic Yield under the wrong name, or not at all | The **Column name in your user data source** in the Dynamic Yield schema does not match the **Destination** field in the Zeotap mapping. The match is case-sensitive. | Compare the two names character for character and correct whichever is wrong. | | Email addresses do not land against the profile | The **Destination** field for the email mapping is not `ihe`. | Map the value `ihe` in the Destination field on the Zeotap mapping screen. | | A custom identifier does not resolve | The Destination field value differs from the identifier name defined in Dynamic Yield. | Enter the exact identifier name defined in Dynamic Yield — for example `customer_id`. | | An audience timeframe of 3 months or 1 year cannot be selected | Dynamic Yield does not support projected performance beyond 30 days. | Keep the condition timeframe at 30 days or less. | | The audience has not appeared in the Dynamic Yield seat | The delivery is still in flight. | Allow up to two business days, depending on data volume and your position in the pipeline, then re-check the **Data Feeds** page. | | The Zeotap destination records a failed run | A destination-level failure rather than a Dynamic Yield configuration problem. | See [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail), and [When to contact support](/articles/integrate-customer/destinations#when-to-contact-support) if the error is not listed there. | ## Next steps * [Send the same user data as a CSV instead →](/articles/integrate-customer/dynamic-yield-csv-upload) * [Send behavioural events to Dynamic Yield →](/articles/integrate-customer/dynamic-yield-events) * [Stream the Journey ID to Dynamic Yield in real time →](/articles/integrate-customer/dynamic-yield-realtime) * [Link an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Understand how destinations work →](/articles/integrate-customer/destinations) * [Extend an audience with ID Extension →](/articles/segment-customer/extend-your-audience#id-extension) # Dynamic Yield: CSV upload Source: https://docs.zeotap.com/articles/integrate-customer/dynamic-yield-csv-upload Send audiences from Zeotap CDP to a Dynamic Yield User Data Feed as CSV files delivered to the feed's S3 bucket, for use in Dynamic Yield audiences and campaigns. ## What this is This integration sends data **out of Zeotap CDP to Dynamic Yield**: Zeotap writes CSV files to the S3 bucket behind a Dynamic Yield User Data Feed, and Dynamic Yield turns the contents into audience conditions you can target on. Nothing flows back from Dynamic Yield into Zeotap CDP. Dynamic Yield is a personalisation platform that builds actionable customer segments in real-time, enabling marketers to increase revenue through personalisation, recommendations, automatic optimisation and one-to-one messaging. Use the CSV upload method when you are sending large volumes of data. If you want to update the same User Data Feed over the Dynamic Yield API instead, use the other Dynamic Yield integrations: > [card] [Dynamic Yield](/articles/integrate-customer/dynamic-yield) > > Batch destination that updates the User Data Feed over the Dynamic Yield User Data API. > [card] [Dynamic Yield (RealTime)](/articles/integrate-customer/dynamic-yield-realtime) > > Streams the Journey ID to Dynamic Yield as soon as a user qualifies for a Journey. > [card] [Dynamic Yield Events](/articles/integrate-customer/dynamic-yield-events) > > Sends real-time user interaction and behavioural events over the Dynamic Yield Events API. ## Supported identifiers and actions This integration supports SHA256 Hashed email, MAIDs, and Membership ID. You can also send any custom identifier and attributes, provided you have created them under the Data Feed in Dynamic Yield as described in [Prerequisites](#prerequisites). The following table lists the available action for the integration and the supported features for it: | Action name | [ID extension](/articles/segment-customer/extend-your-audience#id-extension) | Delete | Delta upload | | :- | :- | :- | :- | | Send CSV to User Data Feed | – | – | – | A dash means the feature is not available for this action. ## Prerequisites Before pushing audiences to Dynamic Yield, set up the User Data Feed on the Dynamic Yield side: 1. Create a User Feed and obtain the S3 URL and credentials associated with the User Feed. 2. Choose a unique user identifier or create one, and give it an identifier column name. You provide that column name again when you create the destination in Zeotap. 3. Decide which attributes (columns) to pass to Dynamic Yield and set up the schema that determines where and how the information is stored in Dynamic Yield. Once the Data Feed is set up, you can start sending audiences (segments) from Zeotap CDP to Dynamic Yield. > [!NOTE] > > For more information, refer to the [Dynamic Yield documentation](https://support.dynamicyield.com/hc/en-us/articles/360021867314-Update-Your-User-Profile-Data-by-CSV-Upload). ## Set up the User Data Feed in Dynamic Yield ### Create a User Feed and generate the S3 credentials In Dynamic Yield, a User Feed ID is a unique identifier for a set of user data feeds used to drive personalised experiences across channels. A user feed can contain a variety of user data points, such as browsing history, purchase history and demographic information. To create a new User Feed and obtain the corresponding S3 credentials: **1. Open Audience Hub** Log into your Dynamic Yield account and, in the left navigation panel, click **Audience Hub**. **2. Add a profile source** Under Audience Hub, go to the **Extensions** tab. Under **Profile**, click **Add Source**. ![Dynamic Yield Audience Hub Extensions tab, with the Add Source control under the Profile section](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2024-12-04-2.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=43993753db6a8d32dcc1265ceaf0731a) **3. Choose the CSV feed source** In the screen that appears, under **Feed Source**, select **Upload a CSV file**, then click **Create a Bucket**. **4. Copy the bucket details and keys** Copy the **Bucket Path**, **Access Key** and **Secret Key** from the **CSV Storage** panel. You need all three when you create the destination in Zeotap. Store them somewhere secure — Dynamic Yield shows them at generation time. **5. Set the identifier and delimiters, then click Done** Click **Done**, then complete the feed settings: a. Under the **User Unique Type** dropdown, select the unique identifier type. This can be **Email Address**, **DYID** or any other customer identifier you have created. See [Choose or create a unique user identifier](#choose-or-create-a-unique-user-identifier). b. Enter a name for the identifier in **Identifier Column Name**. You must enter this exact value in the right-hand field on the mapping screen when you create the destination in Zeotap. c. Select **Semicolon (;)** under the **Field Value Delimiter** dropdown. d. Select **Comma (,)** under the **Array Value Delimiter** dropdown. ![Dynamic Yield feed settings with Identifier Column Name set to customer_id, Field Value Delimiter set to Semicolon and Array Value Delimiter set to Comma, all highlighted](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-csv-upload/dynamic-yield-csv-upload-2025-09-23.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=e2bc1aed8007cd0ce71fd4dfbbce88a9) ### Choose or create a unique user identifier Under **Unique User Identifier**, you can choose **Email Address (CUID)** or **DYID** by default. To add a custom identifier: **1. Open General Settings** On the top bar, click **Settings** > **General Settings**. ![Dynamic Yield top bar with the Settings menu open and General Settings selected](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2024-12-06-1.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=20495e11b263d904b75387b640c56a41) **2. Add an identifier type** Under **User Identifier Types**, click **Add Identifier Type**, enter a name in **Identifier Name**, and click **Add**. ![Dynamic Yield User Identifier Types settings with the Add Identifier Type dialog open, showing the Identifier Name field and the Add and Cancel buttons](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2024-12-06-3.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=9bd7a707128e89f3d24b9f9bc14d23d9) **3. Confirm it appears on the feed screen** The new identifier is listed under **User Unique Identifier** on the User Feed creation screen. ### Define the data schema Under **Data Schema**, define the identifiers and attributes you want to send to Dynamic Yield. Use the **Schema Creator** to build the schema. ![Dynamic Yield Data Schema section of the feed screen with the Schema Creator link alongside the schema editor](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2024-12-06-6.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=d678895622aa303d136f28f7f562c981) **1. Open the Schema Creator** Click **Schema Creator**. You can either create a schema from scratch or modify an existing schema. ![Dynamic Yield Schema Creator entry screen offering the options to start a new schema or edit an existing one](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2024-12-06-7.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=09084f8bfd1e55bde9de92077527ba9f) **2. Build the schema** If you choose **Start from Scratch**, provide the following in the screen that appears: a. Under **Column name in your user data source**, enter the identifier name as provided in your data source. Use the same name in the **Destination** field (right-hand side) on the mapping screen when [creating a destination in Zeotap CDP](/articles/integrate-customer/dynamic-yield#create-the-dynamic-yield-destination). For example, if you use `first_name` as the destination field in Zeotap, enter that exact name (case sensitive) in the **Column name in your user data source** column. b. Under **Condition name in your audiences**, enter the identifier name as you want to see it in the audiences. c. Choose the **Condition type** as per your requirement. Include the **Membership ID** in the schema using the format shown below. d. The **Membership ID** field must have the **Condition Type** set to **Text Array**. ![Dynamic Yield User Data Schema Creator with rows for segment_id, segment_name, membership_ids and email, each with a condition name and condition type](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-77.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=05198ba9802a6eb8c48b92cfbb8938e8) ![Generated Dynamic Yield schema JSON listing membership_ids as an array of strings alongside email, segment_id and segment_name, with a Copy to clipboard control](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-78.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=599bfbf46631a28f1a51a7a95d529fa3) e. Use **Copy to Clipboard** to copy the schema. **3. Paste the schema into the feed** Paste the copied schema into the space provided under **Data Schema**. ![Dynamic Yield Data Schema editor with the pasted schema JSON in place](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2024-12-06-9.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=aacea9a3286e310cc84e98e805ca8de6) **4. Save and activate** Click **Save & Activate**. The User Feed is then listed on the **Data Feeds** page. ![Dynamic Yield Data Feeds page listing the saved and activated User Feed](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2024-12-06-10.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=411ca961aeff4dc03107b6d9eb6b4065) > [!WARNING] > > At this stage you may hit the error **Illegal Character in: `{Your Data Feed}`**. If this happens, remove any special characters, such as hyphens or underscores, from the data feed name. > > If you are editing an existing data feed and adding a field, include `"default": null` after `"uiType": "input"` in the data schema before saving. ## Create the Dynamic Yield CSV upload destination Once the prerequisites are in place, create the destination in Zeotap CDP: **1. Open Destinations** Log into the Zeotap CDP app and go to the **Destinations** application, then click **+ Create Destination**. ![Zeotap CDP Destinations list on the Private Destination tab with the Create Destination button highlighted at the top right](https://mintcdn.com/zeotap/xGzkHY-dcQy5tLit/articles/integrate-customer/Storage/integrate-customer/ADOBE_DMP_3.png?fit=max\&auto=format\&n=xGzkHY-dcQy5tLit\&q=85\&s=102da1a60a97d389369069c7bad552ab) **2. Find the destination in the catalogue** Under **All Destinations**, search for **Dynamic Yield : CSV Upload**. ![Zeotap CDP All Destinations catalogue with the Search for a Destination box highlighted above the destination tiles](https://mintcdn.com/zeotap/xGzkHY-dcQy5tLit/articles/integrate-customer/Storage/integrate-customer/ADOBE_DMP_4.png?fit=max\&auto=format\&n=xGzkHY-dcQy5tLit\&q=85\&s=6a7ff3c41d25bca380ad1cdfe0d1f678) **3. Enter the destination details** Click **Dynamic Yield : CSV Upload**. Details about the destination appear on the left and the fields required for the integration appear on the right. Enter: a. A name for the destination. b. The **Bucket Path**, **Access Key**, **Secret Key** and **S3 bucket region** obtained from Dynamic Yield. See [Create a User Feed and generate the S3 credentials](#create-a-user-feed-and-generate-the-s3-credentials). > [!NOTE] > > Remove the `s3://` prefix when you enter the value in the **Bucket Path** field. If the bucket path in Dynamic Yield is `s3://com.dy-external.crm/`, enter `com.dy-external.crm/` in the **Bucket Path** field in Zeotap. c. Under **User Unique Identifier in Dynamic Yield**, choose the identifier type you selected when [creating the User Data Feed](https://support.dynamicyield.com/hc/en-us/articles/4409595248017-Update-Your-User-Data-Feed-by-API). You can choose either **Hashed Email Address** or **Custom Identifier**. i. If you choose **Hashed Email Address**, a field called **Unique Identifier for Email** is enabled with the auto-populated value `ihe`. ii. If you choose **Custom Identifier**, enter the customer identifier you added in Dynamic Yield. See [Choose or create a unique user identifier](#choose-or-create-a-unique-user-identifier). ![Zeotap CDP Enter Destination Details step for a Dynamic Yield destination, with the User Unique Identifier in Dynamic Yield dropdown open showing the Email address (CUID) and Custom Identifier choices](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2025-02-01-1.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=583e10112adbc59f75bb448869bc71f3) d. Review the values you entered, then click **Next** to proceed to mapping. **4. Choose the action and map the fields** On the **Action and Mapping** screen, select **Upload CSV to User Feed** as the action, then map the **Catalogue** and **Destination** fields. a. Map the **Segment Membership** field. Map the identifier field (email address or customer ID) using **+ Add Mapping Field**. i. You can send additional identifiers and attributes using the same button, provided they are already defined in the schema associated with the User Feed in Dynamic Yield. b. If you are sending an **Email address**, map the value `ihe` in the **Destination** field (right-hand side). c. If you are using a custom identifier, enter the exact value you defined in Dynamic Yield when you created the identifier into the **Destination** field. For example, if the identifier is named `customer_id` in Dynamic Yield, enter `customer_id` in the **Destination** field in Zeotap. ![Zeotap CDP Action and Mapping screen for a Dynamic Yield destination, mapping Segment Membership to Segment Membership and Email SHA256 Lowercase to the destination field ihe](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2025-02-01-2.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=7182f7649bc0881424a0c92d2a35dee4) **5. Create the destination** Click **Create Destination**. The destination is then listed in the **Audiences** application, where it can be linked to an audience (segment). ## Link an audience to the destination For how to link an audience to the destination in the **Audiences** application, see [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > The terms *audience* and *segment* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience or segment can be a group of customers who are over 18 years of age and have performed an `addToCart` event within the last 30 days. ## Verify the delivery 1. In Dynamic Yield, confirm the User Feed appears on the **Data Feeds** page after you clicked **Save & Activate**. 2. In Zeotap CDP, confirm the destination is listed in the **Audiences** application and the audience is linked to it. 3. In Dynamic Yield, build an audience condition on the feed (see below). When the values you sent from Zeotap populate in the condition's value dropdown, the data has landed. Allow up to two business days for audiences (segments) to be available in the Dynamic Yield seat, depending on the volume of data sent and your sequence in the data pipeline. ## Build audiences and campaigns in Dynamic Yield **1. Create an audience** Log into the Dynamic Yield UI. Under the **Audience** tab, go to **Audience Manager** and click **Create Audience**. ![Dynamic Yield Audience Manager with the Create Audience button](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2024-05-17-14.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=ddafe533faf8c0b65bdfb16abae6d8f0) **2. Select User Attributes** From the options, select **User Attributes**. ![Dynamic Yield audience type chooser with the User Attributes option](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2024-05-17-15.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=ca5b5f4f896f1cc5ad158bb36ae56d91) **3. Set the conditions** Enter a name for the audience, then under **Conditions** provide the following: a. In the first field, choose the **User Data Feed** you want to include. b. In the second field, select the Segment ID, Segment Name, and any other identifiers and attributes you sent from Zeotap. You can add as many attributes as you need by adding new conditions. c. In the third field, choose the operator for the condition, such as `Is`, `contains` or `equals`. d. In the fourth field, choose a value from the drop-down list. The values populate according to the User Data Feed you chose. e. You can set the timeframe of the condition. Dynamic Yield offers current session, 1 day, 7 days, 30 days, 3 months and 1 year, but projected audience performance is only supported up to 30 days. f. Once all the conditions are set, click **Save Audience**. ![Dynamic Yield audience condition builder with a User Data Feed, attribute, operator and value selected](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2024-05-17-16.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=8aba4292fb09f660677a0f030b9b79c8) **4. Check the projected size and use the audience** Under the **Projected Audience Performance** tab you can view the projected audience size for the timeframe selected. Use the audiences you create here to build campaigns under **Web Personalisation** in Dynamic Yield. ![Dynamic Yield Web Personalisation campaign screen where a saved audience can be targeted](https://mintcdn.com/zeotap/LCxSbw6jRjl6WDYA/articles/integrate-customer/Storage/integrate-customer/dynamic-yield/dynamic-yield-2024-12-06-14.png?fit=max\&auto=format\&n=LCxSbw6jRjl6WDYA\&q=85\&s=44422d94d7e360cfb91eb4ee9a8d0cd6) ## Troubleshoot the integration | What you see | What to do | | :- | :- | | **Illegal Character in: `{Your Data Feed}`** when saving the schema | Remove any special characters, such as hyphens or underscores, from the data feed name. | | A field you added to an existing data feed will not save | Include `"default": null` after `"uiType": "input"` in the data schema before saving. | | Audiences from Zeotap are not visible in the Dynamic Yield seat yet | Allow up to two business days, depending on the volume of data sent and your sequence in the data pipeline. | | **Projected performance is not supported for audience time frame over 30 days** when setting an audience condition | Set the condition timeframe to 30 days or less. The 3-month and 1-year options are shown but cannot be selected. | | The identifier column does not match | The value in the **Identifier Column Name** field in Dynamic Yield and the value in the **Destination** field on the Zeotap mapping screen must be identical, including case. | ## Next steps * [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination) * [Dynamic Yield](/articles/integrate-customer/dynamic-yield) — update the same User Data Feed over the API instead of by CSV * [Dynamic Yield (RealTime)](/articles/integrate-customer/dynamic-yield-realtime) — stream Journey enrolments as they happen * [Dynamic Yield Events](/articles/integrate-customer/dynamic-yield-events) — send behavioural events * [Extend your audience](/articles/segment-customer/extend-your-audience#id-extension) # Dynamic Yield (RealTime) Source: https://docs.zeotap.com/articles/integrate-customer/dynamic-yield-realtime Stream the Journey ID, identifiers and attributes out of Zeotap CDP to Dynamic Yield in real time, so on-site experiences react to the journey a user is enrolled in. ## What this is Dynamic Yield (RealTime) is a **real-time destination**: data flows **out of Zeotap CDP into Dynamic Yield**, pushed from a journey as soon as a user qualifies for it. The destination attaches to a **Send to Destinations** node inside a journey workflow — it is not linked to an audience. Dynamic Yield is a personalisation platform that builds actionable customer segments in real time, enabling marketers to increase revenue through personalisation, recommendations, automatic optimisation, and one-to-one messaging. This integration streams the **Journey ID** to Dynamic Yield the moment a user enters the journey, so on-site experiences can be personalised based on the journey the user is currently enrolled in. > [!NOTE] > > Other Dynamic Yield integrations: > > * [Dynamic Yield](/articles/integrate-customer/dynamic-yield) — the batch destination, driven from an audience rather than a journey. > * [Dynamic Yield (CSV Upload)](/articles/integrate-customer/dynamic-yield-csv-upload) — the batch file-based destination. > * [Dynamic Yield Events](/articles/integrate-customer/dynamic-yield-events) — the real-time destination for behavioural events such as add-to-cart and purchase. ## Supported identifiers and actions This integration supports SHA256 hashed email, MAIDs, and the Journey ID. You can also send any custom identifier and attributes — but every one of them must first exist in the Dynamic Yield data feed schema, as described in [Prerequisites](#prerequisites). The following table lists the available action type for the integration and the supported features for that action type: | Action name | [ID EXTENSION](/articles/segment-customer/extend-your-audience#id-extension) | [DELETE](/articles/segment-customer/delta-upload-and-delete-functions) | [DELTA UPLOAD](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send attributes and identifiers to Dynamic Yield in RealTime | ✅ | - | - | ## Prerequisites Before Zeotap CDP can send anything, set up a **user data feed** in Dynamic Yield. You need four things from the Dynamic Yield side: 1. A user data feed, and its **Feed key**. 2. A unique user identifier — either one of the built-in types or one you create. 3. A data schema that defines the identifiers and attributes the feed accepts, including the Journey ID field. 4. A server-side **API key** with the user data permission. Once the data feed is active, you can start sending journey enrolments from Zeotap CDP to Dynamic Yield. > [!NOTE] > > For more information, refer to the [Dynamic Yield documentation](https://support.dynamicyield.com/hc/en-us/articles/4409595248017-Update-Your-User-Profile-Data-by-API). ## Set up the user data feed in Dynamic Yield ### Step 1 — Create a user feed and copy the Feed key In Dynamic Yield, a user data feed holds the user data points that drive personalised experiences across channels — for example browsing history, purchase history and demographic information. Each feed has its own **Feed key**, which you paste into Zeotap CDP when you create the destination. **Step 1** Log in to your Dynamic Yield account. **Step 2** In the left navigation panel, click **Audience Hub**. **Step 3** Under **Audience Hub**, open the **Extensions** tab. **Step 4** Under **Profile**, click **Add Source**. ![Audience Hub Extensions tab showing the User Data Enrichment card with an Events row and a Profile row; Add Source sits at the right of the Profile row](https://mintcdn.com/zeotap/xzZ7DaVdxdIveMg2/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-realtime/dynamic-yield-realtime-add-source.png?fit=max\&auto=format\&n=xzZ7DaVdxdIveMg2\&q=85\&s=39a966ae703a071ec62f42eb2fac3996) **Step 5** On the **Create User Data** screen, give the feed a **Name**. The name you choose is also used as the name of the audience condition in Dynamic Yield, so pick something you will recognise later. **Step 6** Under **Feed Source**, select **Sync via API**. The **Feed key** appears directly below it. Copy it — this is the **User Feed ID** you paste into Zeotap CDP while creating the destination. ![Create User Data screen with the Name field, and a Feed Source section offering Sync via API — which displays a Feed key and an API Documentation link — or Upload a CSV file](https://mintcdn.com/zeotap/xzZ7DaVdxdIveMg2/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-realtime/dynamic-yield-realtime-feed-key.png?fit=max\&auto=format\&n=xzZ7DaVdxdIveMg2\&q=85\&s=16dd07633ae5656459eee69e852f3b2e) ### Step 2 — Choose or create a unique user identifier Under **User Unique Identifier** on the feed screen you can pick a built-in type such as **Email Address (CUID)** or **DYID**. To add your own identifier type instead: **Step 1** On the top bar, click **Settings > General Settings**. ![Dynamic Yield top-bar Settings menu listing Integrations, API Keys, API Logs, Data Privacy and General Settings](https://mintcdn.com/zeotap/xzZ7DaVdxdIveMg2/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-realtime/dynamic-yield-realtime-settings-menu.png?fit=max\&auto=format\&n=xzZ7DaVdxdIveMg2\&q=85\&s=fcb76c15d2239ade0a25d3d43e1149db) **Step 2** Under **User Identifier Types**, click **Add Identifier Type**, choose **Phone Number** or **Other**, and click **Add**. If you choose **Other**, type the name of your custom identifier. ![User Identifier Types panel with existing identifier chips, and the Add Identifier Type dialog offering Phone Number or Other with a free-text name field](https://mintcdn.com/zeotap/xzZ7DaVdxdIveMg2/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-realtime/dynamic-yield-realtime-add-identifier-type.png?fit=max\&auto=format\&n=xzZ7DaVdxdIveMg2\&q=85\&s=e1be8e7919e4a4f5deb1a3ac5ea8998c) **Step 3** The new identifier then appears in the **User Unique Identifier** list on the feed screen. ![Create User Data screen with the User Unique Identifier dropdown open, listing Email Address (CUID), two custom identifier types, and DYID](https://mintcdn.com/zeotap/xzZ7DaVdxdIveMg2/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-realtime/dynamic-yield-realtime-custom-identifier-listed.png?fit=max\&auto=format\&n=xzZ7DaVdxdIveMg2\&q=85\&s=f2e576b3794e85333b684d0843598b7b) ### Step 3 — Define the data schema Under **Data Schema**, define the identifiers and attributes you want the feed to accept. Use the **Schema Creator** for a no-code way to build it. ![Data Schema section with an empty code editor and links for Read documentation, Schema Creator and Copy example to clipboard](https://mintcdn.com/zeotap/xzZ7DaVdxdIveMg2/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-realtime/dynamic-yield-realtime-data-schema.png?fit=max\&auto=format\&n=xzZ7DaVdxdIveMg2\&q=85\&s=aa8e7f21e59602f24fa88e2338afa27c) **Step 1** Click **Schema Creator**, then choose **Start from Scratch** or **Change an Existing Schema**. ![User Data Schema Creator start screen offering Start from Scratch or Change an Existing Schema](https://mintcdn.com/zeotap/xzZ7DaVdxdIveMg2/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-realtime/dynamic-yield-realtime-schema-creator-start.png?fit=max\&auto=format\&n=xzZ7DaVdxdIveMg2\&q=85\&s=dfbba31eeb36c1ace3c8ba020be96adf) **Step 2** Add a condition for the Journey ID: * Under **Column name in your user data source**, enter `journey_id`. * Under **Condition name in your audiences**, enter the name you want to see in Dynamic Yield audience conditions — for example `Journey ID`. * Set **Condition type** to **Text**. > [!WARNING] > > The `journey_id` column name is **case-sensitive** and must match exactly between Dynamic Yield and the Zeotap CDP mapping screen. ![Schema Creator row with Column name journey_id, Condition name Journey ID and Condition type Text, above an Add Condition button](https://mintcdn.com/zeotap/xzZ7DaVdxdIveMg2/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-realtime/dynamic-yield-realtime-schema-creator-form.png?fit=max\&auto=format\&n=xzZ7DaVdxdIveMg2\&q=85\&s=2fb3362caf2d7691cbab2ba4b33ddae1) **Step 3** Under **Your Schema**, click **Copy to clipboard**. ![Your Schema panel in the Schema Creator showing the generated JSON for the journey_id field next to a Copy to clipboard button](https://mintcdn.com/zeotap/xzZ7DaVdxdIveMg2/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-realtime/dynamic-yield-realtime-schema-pasted.png?fit=max\&auto=format\&n=xzZ7DaVdxdIveMg2\&q=85\&s=d24fc95b43333462a3bfb611c1ca4de7) **Step 4** Paste the schema into the **Data Schema** editor on the feed screen, choose the sites or apps the audience condition should appear on, and click **Activate**. (**Save as Draft** keeps the feed, but a draft feed does not receive data.) The feed is then listed on the **Data Feed** page. ![Feed screen with the Unique Identifier Type set, the pasted Data Schema JSON for journey_id, a Sites/Apps targeting selector, and Activate, Save as Draft and Cancel buttons](https://mintcdn.com/zeotap/xzZ7DaVdxdIveMg2/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-realtime/dynamic-yield-realtime-feed-saved.png?fit=max\&auto=format\&n=xzZ7DaVdxdIveMg2\&q=85\&s=eb9632dd4c0f3f4bb265de85a7b39e3d) > [!NOTE] > > If saving fails with an error such as `Illegal Character in: {Your Data Feed}`, remove special characters — for example hyphens or underscores — from the data feed name. If you are editing an existing data feed and adding a field, include `"default": null` after `"uiType": "input"` in the schema before saving. ### Step 4 — Create the API access token Create an API key in Dynamic Yield and paste it into Zeotap CDP while creating the destination. **Step 1** In the Dynamic Yield console, click **Settings > API Keys**, then click **New Key**. ![Audience Hub Extensions tab with the Settings item in the top bar highlighted](https://mintcdn.com/zeotap/xzZ7DaVdxdIveMg2/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-realtime/dynamic-yield-realtime-api-keys-nav.png?fit=max\&auto=format\&n=xzZ7DaVdxdIveMg2\&q=85\&s=0a46d36ec0a25771356dc422bc4385c8) **Step 2** In the **Create API Key** dialog: * Enter a **Name**, and optionally fill in **Notes (Optional)**. * Under **Source**, select **Server-side**. * Under **ACL**, select the **User Data Profile** permission. * Click **Save**. ![Create API Key dialog with Name and Notes fields, a Source choice of Server-side or Client-side, and ACL checkboxes for Experience API, User Data Profile and User Data Events](https://mintcdn.com/zeotap/xzZ7DaVdxdIveMg2/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-realtime/dynamic-yield-realtime-create-api-key.png?fit=max\&auto=format\&n=xzZ7DaVdxdIveMg2\&q=85\&s=597f0ec941179f3af3e81d84ca742833) **Step 3** The new key is listed on the **API Keys** page with its ACL and source. Use the copy control in the **Key** column to copy it for the next section. ![API Keys table listing keys by Name, a copy control in the Key column, ACL tags, Source and Last Modified date](https://mintcdn.com/zeotap/xzZ7DaVdxdIveMg2/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-realtime/dynamic-yield-realtime-api-keys-list.png?fit=max\&auto=format\&n=xzZ7DaVdxdIveMg2\&q=85\&s=39f876f6b76cff79e5d00aa819f7a78b) ## Create the Dynamic Yield (RealTime) destination With the Feed key and API key in hand, create the destination in Zeotap CDP: **Step 1** In Zeotap CDP, go to **Integrate > Destinations**. **Step 2** Click **+ Create Destination**. ![Zeotap CDP Destinations listing with Private Destination and Public Destination tabs, a search box, and the Create Destination button](https://mintcdn.com/zeotap/xzZ7DaVdxdIveMg2/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-realtime/dynamic-yield-realtime-zeotap-destinations.png?fit=max\&auto=format\&n=xzZ7DaVdxdIveMg2\&q=85\&s=d22e4f287ad49a0698c3435a1a7cd960) **Step 3** Under **All Destinations**, search for **Dynamic Yield**. ![All Destinations catalogue with the Search for a Destination box highlighted above a grid of destination cards](https://mintcdn.com/zeotap/xzZ7DaVdxdIveMg2/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-realtime/dynamic-yield-realtime-zeotap-search.png?fit=max\&auto=format\&n=xzZ7DaVdxdIveMg2\&q=85\&s=de93b8771c00f8666d6f5d0a6a15883c) **Step 4** Click **Dynamic Yield**. On the **Enter Destination Details** screen, the left panel describes the integration and lists what you need; enter your details on the right: * Enter a **Name** for the destination. * Enter the **User Feed ID** you copied from your Dynamic Yield data feed, and the **API Access Token** you generated in Dynamic Yield. * Under **Cluster Region**, select the region of your Dynamic Yield data centre. * Under **User Unique Identifier in Dynamic Yield**, choose the identifier type that matches the one set on your Dynamic Yield data feed — **Email address(CUID)** or **Custom Identifier**. * For the email option, a **Unique Identifier for Email** field is enabled and pre-filled with the value `ihe`. * For **Custom Identifier**, enter the identifier name exactly as you defined it in Dynamic Yield. The same name is used on the mapping screen, so it must match your Dynamic Yield configuration precisely. * Review the values and click **Next**. ![Enter Destination Details step for Dynamic Yield with fields for the User Feed ID, API Access Token and Cluster Region, and the User Unique Identifier dropdown open on Email address(CUID) and Custom Identifier](https://mintcdn.com/zeotap/xzZ7DaVdxdIveMg2/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-realtime/dynamic-yield-realtime-destination-form.png?fit=max\&auto=format\&n=xzZ7DaVdxdIveMg2\&q=85\&s=7b30d4f4556b0265caef7ef2338ffc51) **Step 5** Under **Choose your Action**, select **Send attributes and identifiers to Dynamic Yield in RealTime**. Under **Map the Fields**, the **Destination Field** column is already populated — you only choose the matching **Catalogue Field** on the left: * **CUID** — select the identifier you configured during destination creation (your hashed email address or your custom identifier). * **Journey ID** — open the Catalogue dropdown, switch to the **Platform Attributes** tab and select **Journey ID**. When a user qualifies for a journey, that journey's ID is sent to Dynamic Yield in real time. Use **+ Add Mapping Field** under **Attributes** to send any further attributes your schema defines. ![Action and mapping step with the action set to Send attributes and identifiers to Dynamic Yield in RealTime, and a mapping table whose Destination Field column lists CUID and Journey ID as required string fields](https://mintcdn.com/zeotap/xzZ7DaVdxdIveMg2/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-realtime/dynamic-yield-realtime-mapping.png?fit=max\&auto=format\&n=xzZ7DaVdxdIveMg2\&q=85\&s=4b539e9827061904b5ae62ee571f0a48) > [!NOTE] > > If you are using a custom identifier, the custom CUID name entered here must be identical to the identifier you defined in Dynamic Yield and supplied during destination setup. **Step 6** Click **Save Mapping**. The destination can now be attached to a journey. ## Add the destination to a journey A real-time destination is driven from a journey. Attach it to a **Send to Destinations** node in the journey workflow: **Step 1** In the workflow, click **+** and choose **Send to Destinations**. ![Journey canvas node menu headed Choose an action, listing Add a Condition, Add a Delay, Create a Multi-branch Split, Create a True/False Split and Send to Destinations](https://mintcdn.com/zeotap/4Dur5DFq2fyd71SA/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-realtime/dynamic-yield-realtime-action-picker.png?fit=max\&auto=format\&n=4Dur5DFq2fyd71SA\&q=85\&s=9714babc8549f1a7635f0eed51d9e600) **Step 2** Find your Dynamic Yield destination with the search box and select it. ![Send to Destinations picker with a search box above a grid of existing destination cards, each showing its channel and ID](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-realtime/dynamic-yield-realtime-destinations-list.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=92a39c216ab7dcf313db96e56d0d25cd) **Step 3** Under the **Destination Details** tab, the fields are populated automatically from the values you entered while creating the destination. **Step 4** Click **Save Destination**. The destination card is attached to the node and shows the channel, the destination name and the selected action. Every user who qualifies for the journey now has their Journey ID sent to Dynamic Yield in real time. ![Send to Destinations node with an attached Dynamic Yield destination card showing the destination name, its ID and the selected RealTime action, beside an Add New Destination link](https://mintcdn.com/zeotap/xzZ7DaVdxdIveMg2/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-realtime/dynamic-yield-realtime-journey-node.png?fit=max\&auto=format\&n=xzZ7DaVdxdIveMg2\&q=85\&s=ccf32be5b1fbe88849cfc20ad9076ccb) For the wider journey workflow, see [Create a workflow](/articles/orchestrate-customer/create-a-workflow) and [Add or delete a node](/articles/orchestrate-customer/add-or-delete-a-node). ## Verify the Journey ID reaches Dynamic Yield **Step 1** **In Zeotap CDP** — use [Journey Traces](/articles/orchestrate-customer/journey-traces) to pick a user who entered the journey and inspect the output event sent to the Dynamic Yield node. The Journey ID you mapped should appear in that payload. **Step 2** **In Dynamic Yield** — open **Audience Hub > Extensions**. The **Profile** table lists your feed with its **Entries**, **Last Successful Sync** and **Sync Status**. A recent successful sync and a rising entry count mean data is landing. **Step 3** **In Dynamic Yield** — for request-level detail, open **Settings > API Logs** and look for the calls made against your feed. **Step 4** Finally, build an audience condition on the Journey ID (below) and check the projected audience size is non-zero. ## Use the Journey ID in Dynamic Yield Once the Journey ID is arriving, build audiences on it and use those audiences in campaigns. > [!NOTE] > > The terms *audiences* and *segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience or a segment can be a specific group of customers who are over 18 years of age and have performed an `addToCart` event within the last 30 days. **Step 1** Log in to Dynamic Yield and go to **Audience Hub > Audience Manager**, then click **+ Create Audience**. ![Audience Hub Audience Manager tab with a Primary Audiences panel above the All Audiences table and the Create Audience button](https://mintcdn.com/zeotap/xzZ7DaVdxdIveMg2/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-realtime/dynamic-yield-realtime-audience-manager.png?fit=max\&auto=format\&n=xzZ7DaVdxdIveMg2\&q=85\&s=9d7e2b0076a69a68a503e65c7a1752e2) **Step 2** Select **User Attributes**. ![Audience type chooser offering User Attributes, described as past behaviour, technology, geo and other user properties, or Campaign Traffic](https://mintcdn.com/zeotap/xzZ7DaVdxdIveMg2/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-realtime/dynamic-yield-realtime-user-attributes.png?fit=max\&auto=format\&n=xzZ7DaVdxdIveMg2\&q=85\&s=6fe4027c4115196a4a33e6651a1074de) **Step 3** Enter a name for the audience. **Step 4** Under **Conditions**, build the rule: * In the first field, choose the user data feed you created. * In the second field, choose the identifier or attribute sent from Zeotap — for the Journey ID, the condition name you set in the schema. You can add further conditions for any other attributes you send. * In the third field, choose the operator — for example `contains`. * In the fourth field, choose a value. Values populate from the data in the chosen feed. * Set the timeframe up to **30 days**. Longer options such as 3 months or 1 year are listed but cannot be selected — choosing one shows the error *"Projected performance is not supported for audience time frame over 30 days"*. * Click **Save Audience**. ![Audience conditions row built on a Realtime Journey ID feed with a journey IDs attribute, a contains operator and a value, above a 30-day timeframe selector and a Save Audience button](https://mintcdn.com/zeotap/xzZ7DaVdxdIveMg2/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-realtime/dynamic-yield-realtime-audience-conditions.png?fit=max\&auto=format\&n=xzZ7DaVdxdIveMg2\&q=85\&s=c31167bb9957c872af45f46f9f976de6) **Step 5** The **Projected Audience Performance** tab shows the projected audience size for the selected timeframe. **Step 6** Use the audience when building campaigns under **Web Personalization** in Dynamic Yield. ![Dynamic Yield Web Personalization screen with a New Campaign button and the campaign type chooser split into client-side implementations such as Dynamic Content, Recommendations, Overlay and Notification, and server-side implementations](https://mintcdn.com/zeotap/xzZ7DaVdxdIveMg2/articles/integrate-customer/Storage/integrate-customer/dynamic-yield-realtime/dynamic-yield-realtime-campaign-types.png?fit=max\&auto=format\&n=xzZ7DaVdxdIveMg2\&q=85\&s=14093040c87b6657c5441a007f81d9ca) ## Troubleshoot Dynamic Yield (RealTime) | Symptom | What to check | | :- | :- | | Saving the schema fails with `Illegal Character in: {Your Data Feed}` | Remove special characters such as hyphens or underscores from the data feed name, then save again. | | A field added to an existing feed will not save | Include `"default": null` after `"uiType": "input"` for the new field before saving. New fields must be nullable and added at the end of an active schema; existing fields cannot be deleted, reordered or re-typed. | | The Journey ID does not appear as an audience condition in Dynamic Yield | Confirm the feed is **Activated** rather than saved as a draft, that the schema contains the Journey ID field, and that the feed is targeted at the right site or app. The condition is named after the data feed and the condition name you set in the schema. | | An audience timeframe longer than 30 days cannot be selected | Dynamic Yield rejects it with *"Projected performance is not supported for audience time frame over 30 days"*. Keep the condition timeframe at 30 days or less. | | Deliveries are rejected or throttled during large journey entries | Dynamic Yield applies its own API rate limits per key. Check **Settings > API Logs** in Dynamic Yield for rejected calls, and stagger high-volume journey entries. | | Users qualify in Zeotap but nothing reaches Dynamic Yield | Check the journey executed as expected before blaming the destination — see [Identify journey errors](/articles/orchestrate-customer/identify-journey-errors), [Journey error codes](/articles/orchestrate-customer/journey-error-codes) and [Journey troubleshooting](/articles/orchestrate-customer/journey-troubleshooting). Then confirm the API key still carries the user data permission and has not been deleted. | | The CUID is rejected or no profile is updated | The identifier type on the Dynamic Yield feed, the **User Unique Identifier in Dynamic Yield** value on the destination, and the catalogue field mapped to **CUID** must all describe the same identifier. A custom identifier name must match character for character. | ## Next steps * [Create a workflow](/articles/orchestrate-customer/create-a-workflow) — build the journey this destination runs from. * [Journey Traces](/articles/orchestrate-customer/journey-traces) — inspect what a single user's journey actually sent. * [Destinations](/articles/integrate-customer/destinations) — how destinations are configured and mapped across Zeotap CDP. * [Dynamic Yield](/articles/integrate-customer/dynamic-yield) — the batch destination, for sending audience membership rather than journey enrolment. * [Dynamic Yield Events](/articles/integrate-customer/dynamic-yield-events) — the real-time destination for behavioural events. # ELAINE real-time integration Source: https://docs.zeotap.com/articles/integrate-customer/elaine-real-time-integration Send event data out of Zeotap CDP to ELAINE in real time from a Journeys workflow, using the Elaine - Trigger Events destination. ## What this is The ELAINE real-time integration sends event data **out of Zeotap CDP to ELAINE**, as each customer reaches the **Send to Destinations** node of a Journeys workflow. Data does not flow back from ELAINE into Zeotap CDP. ELAINE is a marketing platform that lets businesses manage recipient profiles, orchestrate marketing automation campaigns, and deliver triggered transactional messages. The ELAINE API allows external systems, such as CDPs, to interact with these capabilities by sending recipient data and triggering specific marketing actions based on events or desired outcomes. Zeotap CDP offers two separate ELAINE destinations, and both send data outbound from Zeotap CDP: * **Elaine - Trigger Events** — this page. A real-time destination that sends event data from a journey. * **[ELAINE](/articles/integrate-customer/artegic-elaine)** — a batch destination that sends identifiers and attributes into ELAINE recipient groups over SFTP. The two use different credentials and are configured independently. Read the page for the one you are setting up. ## Supported identifiers and actions This integration identifies and matches recipients using the **Email** destination field. | Action | What it does | | :- | :- | | **Send Events to Elaine** | Sends the mapped recipient data to ELAINE as the event you named on the destination. | ## Prerequisites Obtain the following from your ELAINE account before you begin: * An active **ELAINE account** with access to the API. * An **ELAINE Base URL** — you enter this as **Domain URL** on the destination. * An **API Key** — you enter this as **Access token** on the destination. Contact your ELAINE representative to obtain it. * Defined **Events and Campaigns**. You supply the event name when you create the destination. You also need a Journeys workflow to attach the destination to. See [Create a Workflow](/articles/orchestrate-customer/create-a-workflow). ## Create the ELAINE destination **Step 1** Log into Zeotap CDP and go to **Integrate > Destinations**. **Step 2** Click **+ Create Destination**. **Step 3** Under **All Destinations**, search for **Elaine - Trigger Events**. **Step 4** Click **Elaine - Trigger Events**. The **Enter Destination Details** screen appears, with a description of the destination on the left and the fields required to establish the integration on the right. Enter the following: a. **Destination Name** — a name for the destination, for easy identification. b. **Access token** — the access token generated in ELAINE. c. **Domain URL** — the base URL for your ELAINE API services. d. **Event Name** — the name of the event to trigger in ELAINE. Then click **Next** to move to the mapping step. ![The Enter Destination Details step of the Elaine - Trigger Events destination, showing the empty Destination Name, Access token, Domain URL and Event Name fields on the right and the ELAINE description panel on the left.](https://lh7-qw.googleusercontent.com/docsz/AD_4nXe6uFCtxlpdie5ZEhMUEe8DfKPY3a9kWLOqV5ftK-nnM_jGOlC1skaYS0FmvX1yUneP9qDNrnrbS9d2PHQn_rtimYG4rEWF2k5W4A-azvfK-hUHFluT-DpNBKY3QOPC2gnTG2GB?key=CHOe9X52n9XGr7BptecwYw) **Step 5** On the **Mapping** step, name the mapping, then choose the action and the field mapping: a. Under **Choose your Action**, select **Send Events to Elaine**. b. Under **Map the Fields**, map your catalogue attribute to the **Email** destination field in the **Recipient Data** group. Email is mandatory. Use **+ Add Mapping Field** to add further rows. c. Click **Create Destination**. ![The Mapping step of the ELAINE destination, showing Send Events to Elaine selected under Choose your Action, and a Map the Fields table with one Recipient Data row pointing a catalogue attribute at the required Email destination field.](https://lh7-qw.googleusercontent.com/docsz/AD_4nXfkdVC3E5zV1KIxYJOCutogs4YbdiDKsbcE_Ekd62Y0I4kkcraoIJtaidh36Q0Ne7cs6wKGHnEcnDTN3fxLA8lwvDBNN1pScEQbROA2DKoMJhT-bJKkGHB5lUSvSWMu0DrOtUNyAg?key=CHOe9X52n9XGr7BptecwYw) ## Activate the destination in a journey Once the destination exists, link it in the **Send to Destinations** node of your workflow. **Step 1** In the workflow, click **+** and choose **Send to Destinations**. ![The Choose an action menu on a Journeys workflow node, with Send to Destinations highlighted and its tooltip explaining that it forwards customer data to channels that send emails, show ads or run analytics.](https://lh7-qw.googleusercontent.com/docsz/AD_4nXdIS7n15uTOF5JEvVdyPMJPniXpa-0uaN9u70SH9r9VGoc5_zqf4sWpIJI7fTIrm_--cGdrdrEhlLDybim0-mqcjSxAKh90geoi67KjRzKytgqCxetaaFpkp2v35IwuWqmIqxEeWw?key=CHOe9X52n9XGr7BptecwYw) **Step 2** Choose the destination from the list of available destinations by using the search feature. You can also create one here with **+ Add New Destination** — see [Activate Your Real Time Audiences](/articles/integrate-customer/activate-your-real-time-audiences). **Step 3** Under the **Destination Details** tab, the **Access token** field is populated automatically from the value you entered when you created the destination. **Step 4** Under the **Destination Settings** tab, choose the action and mapping for this journey. **Step 5** Click **Save Destination**. The destination is attached to the node, showing its name, the selected action and the mapping. ![The Send to Destinations panel with an Elaine - Trigger Events destination attached to the node, showing the destination name and the Send Events to Elaine mapping, above the list of other available destinations.](https://lh7-qw.googleusercontent.com/docsz/AD_4nXeKFZEjJ1DTOcBc8pDtdmIFswd1iBeaQlxG7wGTYhDi6OdfVIlXmI7Ni7QWkn1NHPlK4U8CLL90srwkyW1yoMDKrdZZ6PpsPV2G5kLPsMtf-dyFP2GAQoiz4mC9i1BA-fgODdIy?key=CHOe9X52n9XGr7BptecwYw) ## Verify the integration works Confirm delivery from both sides. **In Zeotap CDP** * On the Journey canvas, check the destination node. Nodes with failures show red indicators and successful deliveries show green ones. Click the node to open the execution detail panel with the specific error code and affected record count. See [Identify Journey Errors](/articles/orchestrate-customer/identify-journey-errors). * To confirm what was actually sent for a given customer, use [Journey Traces](/articles/orchestrate-customer/journey-traces). It shows the raw input event that triggered the journey and the transformed output event sent to each destination node. **In ELAINE** * Confirm that the event you named on the destination was received, and that the campaign it triggers ran. A successful send shows a green indicator on the destination node and a matching event in ELAINE. If the node shows a red indicator, open it for the error code and look the code up in the troubleshooting table below. ## Troubleshoot this integration Start with the Journey Trace logs for the failing execution: they include the response from the destination, which often carries more context than the error code alone. Then check the scope — if every user is failing at the node, the cause is usually authentication or mapping; if only a small percentage fail, it is usually consent or data quality. See [Troubleshooting Workflows](/articles/orchestrate-customer/journey-troubleshooting). | Error code | Likely cause on this integration | First action | | :- | :- | :- | | `AUTHENTICATION_ERROR` | The access token has expired, or it was rotated in ELAINE without being updated in Zeotap CDP. | Open the destination and enter the current credentials. | | `ENDPOINT_NOT_FOUND` | The Domain URL on the destination is wrong or no longer valid. | Verify the destination's endpoint URL configuration. | | `BAD_REQUEST` / `EVENT_PARSING_FAILED` | A required field is missing from the payload — most often the Email destination field was not mapped. | Validate the required fields and payload format against the mapping. | | `CONSENT_NOT_PROVIDED` | The customer does not carry the consent the journey requires. | Check the user consent attributes and the destination mapping. | | `RATE_LIMIT` / `SERVER_ERROR` / `SERVICE_UNAVAILABLE` | Transient. These retry automatically. | Wait and monitor; check ELAINE's status for outages. | For the full definitions, root causes and resolution steps, see [Journey Error Codes](/articles/orchestrate-customer/journey-error-codes). ## Next steps * [Set up the batch ELAINE destination →](/articles/integrate-customer/artegic-elaine) * [Create a workflow in Journeys →](/articles/orchestrate-customer/create-a-workflow) * [Activate your real-time audiences →](/articles/integrate-customer/activate-your-real-time-audiences) * [Review the Destinations overview →](/articles/integrate-customer/destinations#configure-a-destination) * [Look up a journey error code →](/articles/orchestrate-customer/journey-error-codes) # Eloqua Source: https://docs.zeotap.com/articles/integrate-customer/eloqua Eloqua is a real-time destination: from a Zeotap CDP journey, Zeotap triggers a pre-built Oracle Eloqua email asset to a single contact, addressed by that contact's Eloqua contact ID. ## What this is **Eloqua is a real-time destination.** Data flows out of Zeotap CDP to Oracle Eloqua: when a customer reaches a **Send to Destinations** node in a journey, Zeotap sends that customer's Eloqua contact ID to Oracle Eloqua and asks Eloqua to deliver a pre-built email asset to them. Zeotap calls Oracle Eloqua's Email Deployment API on your behalf. You do not call any API yourself. Oracle Eloqua is a B2B marketing automation platform for building and running cross-channel campaigns across email, display advertising and landing pages. This integration uses the one capability that suits journeys: triggering an individual, event-driven email send to a named contact at the moment the journey reaches the node. Two things follow from that design: * **Zeotap never creates or edits email content.** The email asset must already exist and be approved inside Eloqua. Zeotap only instructs Eloqua to send that existing asset to a resolved contact. * **The integration is one-way.** Zeotap does not read data back from Eloqua. For the current list of what Zeotap connects to, and in which direction, see the [integrations master list](/articles/integrations-master-list-publication/integrations-master-list). This page covers the real-time, journey-driven destination. For how destinations work in general, see [Destinations](/articles/integrate-customer/destinations); for the other journey-driven connectors, see [Real-time integrations](/articles/integrate-customer/real-time-integrations). ## Supported identifiers and actions The integration exposes a single action. It does not support ID extension, delete, or delta upload: | Action name | [ID extension](/articles/segment-customer/extend-your-audience#id-extension) | [Delete](/articles/segment-customer/delta-upload-and-delete-functions) | [Delta upload](/articles/segment-customer/delta-upload-and-delete-functions) | | - | :-: | :-: | :-: | | Trigger Emails in Eloqua | — | — | — | The action does not send a standard Zeotap identifier such as an email address or a hashed email. It sends **Eloqua's own internal contact ID** — the numeric primary key Eloqua assigns to a contact in your instance. Eloqua's Email Deployment API addresses contacts by that key and does not accept an email address in its place, so the contact ID has to be present on the Zeotap customer profile before the journey runs. ## Prerequisites Complete all of the following before you create the destination. Everything in this list is done on the Oracle Eloqua side or in your Zeotap catalogue — there is no Zeotap API step. * An **Oracle Eloqua account with REST API access enabled**, and the **Company Name**, **Username** and **Password** for it. The account needs enough permission in Eloqua to create email deployments. * The **Eloqua region** (pod) your instance runs on — for example `p03`. You can read it from your Eloqua login URL after you sign in, or resolve it by calling Oracle Eloqua's own `GET https://login.eloqua.com/id` endpoint with those credentials. * The **email asset pre-built inside Eloqua**, and its **Email Asset ID** noted down. Zeotap cannot create the asset for you. * The **Eloqua contact ID available as an attribute on the Zeotap customer profile**, so the journey has something to map. Enrich it onto the profile before you go live. > [!NOTE] > > Oracle Eloqua applies a rate limit of 60 API requests per minute to your instance, shared across every integration that talks to it. Factor in any other tools already calling that instance when you size a journey that fires at volume. ## Create the Eloqua destination Once you have the prerequisites, create the destination in the Destinations module. **1. Open the Destinations module** Log in to the Zeotap CDP app and go to **Integrate > Destinations**. **2. Click + Create Destination** On the Destinations landing page, click **+ Create Destination** in the top right. ![Destinations listing page under Integrate, showing the Private Destination and Public Destination tabs, a table of existing destinations, and the Create Destination button highlighted in the top right.](https://mintcdn.com/zeotap/5TJOQa7awRX8en1h/articles/integrate-customer/Storage/integrate-customer/eloqua/destinations-listing.png?fit=max\&auto=format\&n=5TJOQa7awRX8en1h\&q=85\&s=2a343020cb181ec9d5d0cfdca8fbcf0a) Figure 1 — Destinations listing page with the Create Destination button highlighted. **3. Search for Eloqua in the catalogue** Under **All Destinations**, use **Search for a Destination** to find **Eloqua**, then select the **Eloqua** card. ![All Destinations catalogue listing destination cards by platform name and category, with the Search for a Destination field highlighted.](https://mintcdn.com/zeotap/5TJOQa7awRX8en1h/articles/integrate-customer/Storage/integrate-customer/eloqua/destinations-catalogue.png?fit=max\&auto=format\&n=5TJOQa7awRX8en1h\&q=85\&s=5fddf37e7288ab92ff679a14058cb36a) Figure 2 — All Destinations catalogue with the search field highlighted. **4. Enter the destination details** On the **Enter Destination Details** screen, fill in: * **Destination Name** — a descriptive label for this connection, so you can identify it later. * **Username** — the username of your Eloqua account, prefixed with your Company Name (see the tip below). * **Password** — the password for your Eloqua account. * **Region** — the Eloqua region (pod) your instance runs on. > [!TIP] > > Eloqua authenticates on a combined company-and-user string, so the **Username** field is not just your login name. Enter your **Company Name** and **Username** separated by a single backslash. For example, if your company is `Acme` and your username is `jdoe`, enter: > > ``` > Acme\jdoe > ``` ![Enter Destination Details screen for Eloqua, showing the Destination Name, Username, Password and Region fields, with a Destination Details and Mapping step indicator above and Back and Next buttons below.](https://mintcdn.com/zeotap/5TJOQa7awRX8en1h/articles/integrate-customer/Storage/integrate-customer/eloqua/destination-details-form.png?fit=max\&auto=format\&n=5TJOQa7awRX8en1h\&q=85\&s=b4beefdbde75d200a9531f32bb7fb6d6) Figure 3 — Enter Destination Details screen for Eloqua. Review the values and click **Next** to move to the mapping step. **5. Choose the action and map the contact ID** On the mapping screen: 1. Give the mapping a name in place of **Untitled Mapping**, so you can recognise it on the journey node later. 2. Under **Choose your Action**, select **Trigger Emails in Eloqua**. This is the only action this destination offers. 3. Under **Map the Fields**, the **Contact Id** destination field is already in place and is mandatory. Against it, use **Choose Catalogue Attribute** to pick the catalogue attribute that holds the Eloqua contact ID. ![Mapping screen titled Untitled Mapping, with Choose your Action set to Trigger Emails in Eloqua and a Map the Fields table pairing a Choose Catalogue Attribute dropdown with the required Contact Id destination field of type String.](https://mintcdn.com/zeotap/5TJOQa7awRX8en1h/articles/integrate-customer/Storage/integrate-customer/eloqua/action-and-mapping.png?fit=max\&auto=format\&n=5TJOQa7awRX8en1h\&q=85\&s=5f0232f29935df72f663f2255e2c86ca) Figure 4 — Mapping screen with the action set to Trigger Emails in Eloqua and the Contact Id destination field awaiting a catalogue attribute. **6. Create the destination** Click **Save Mapping**, then **Create Destination**. The destination is now available to attach to a journey. ## Add the destination to a journey The Eloqua destination does nothing on its own — it fires only from a journey node. Build or open a workflow in [Journeys](/articles/orchestrate-customer/create-a-workflow), then attach the destination at the point where the email should go out. **1. Add a Send to Destinations action** In the workflow, click **+** at the point where the email should fire and choose **Send to Destinations** from the **Choose an action** menu. ![Choose an action menu in a journey workflow listing Add a Condition, Add a Delay, Create a Multi-branch Split, Create a True/False Split and Send to Destinations, with Send to Destinations highlighted and a tooltip explaining that it forwards customer data to channels that send emails, show ads or run analytics.](https://mintcdn.com/zeotap/5TJOQa7awRX8en1h/articles/integrate-customer/Storage/integrate-customer/eloqua/journey-add-action-menu.png?fit=max\&auto=format\&n=5TJOQa7awRX8en1h\&q=85\&s=91ae1b278c9a65639fbcc326a9bf9c4d) Figure 5 — Choose an action menu in the journey workflow, with Send to Destinations highlighted. **2. Select the Eloqua destination** In the **Send to Destinations** panel, use **Search** to find the Eloqua destination you created, then select its card. You can also create one here with **+ Add New Destination** if you skipped the step above. ![Send to Destinations panel with a Search field and an Add New Destination link, showing a grid of selectable destination cards each labelled with its platform and destination name.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/eloqua/journey-destination-search.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=41397342a5a1037e4381d5c2587eb9e5) Figure 6 — Send to Destinations panel listing the destinations available to attach. **3. Configure the email send** The connection fields — **Destination Name**, **Username**, **Password** and **Region** — are already filled in from the destination you created. Complete the journey-specific fields: * **Email ID** — the Email Asset ID of the pre-built email in Eloqua. This is the numeric identifier of the asset you want to trigger; find it in your Eloqua instance. * **Email Name** — the email asset name as it appears in Eloqua. Used for reference only; it does not affect delivery. * **Name** — a label for this deployment instance. It identifies the send inside Eloqua and does not affect the email content or delivery. ![Eloqua destination panel inside a journey, showing the pre-filled Destination Name, Username, Password and Region fields followed by the Email ID, Email Name and Name fields, with Cancel and Save Destination buttons.](https://mintcdn.com/zeotap/5TJOQa7awRX8en1h/articles/integrate-customer/Storage/integrate-customer/eloqua/journey-eloqua-settings.png?fit=max\&auto=format\&n=5TJOQa7awRX8en1h\&q=85\&s=f806054b55c33ed9959de3c636977c46) Figure 7 — Eloqua destination settings inside the journey node. **4. Save the destination** Click **Save Destination**. The node now shows the attached Eloqua destination with its mapping and action. ![Send to Destinations node showing an attached Eloqua destination card with the destination name, the mapping name and the Trigger Emails in Eloqua action, plus a delete control and an Add New Destination link.](https://mintcdn.com/zeotap/5TJOQa7awRX8en1h/articles/integrate-customer/Storage/integrate-customer/eloqua/journey-eloqua-attached.png?fit=max\&auto=format\&n=5TJOQa7awRX8en1h\&q=85\&s=e931394aa9e550d9797e5ce8738f0060) Figure 8 — Journey node with the Eloqua destination attached. ## Verify the trigger fired Nothing is sent until the workflow is live, so publish first and then confirm the send from the Eloqua side. 1. **Publish the workflow.** Click **Publish Workflow**. The workflow moves to a **Published** status in the workflow listing. 2. **Send one contact through.** Let a single customer who has a valid Eloqua contact ID on their profile reach the node. 3. **Check the contact in Eloqua.** Open that contact's activity history in your Eloqua instance. A send triggered this way is recorded there with a send type of `QuickSend`, against the email asset whose ID you entered. 4. **Confirm receipt.** The contact should receive the pre-built email as it is defined in Eloqua. If the activity history shows no record at all for that contact, work through the table below before raising a ticket. ## Troubleshoot Eloqua email triggers | Symptom | Likely cause | What to check | | - | - | - | | The destination will not connect, or the credentials are rejected. | The **Username** was entered without the Company Name prefix, or the **Region** does not match the pod your instance runs on. | Re-enter **Username** as `CompanyName\Username`. Confirm the region against your Eloqua login URL. | | No email for a specific customer, and no record in their Eloqua activity history. | The mapped catalogue attribute was empty for that customer, or it holds an email address rather than Eloqua's numeric contact ID. | Check the attribute you mapped to **Contact Id** on that customer's profile. It must carry the Eloqua contact ID, not an email address. | | No email for any customer, and no records in Eloqua at all. | The **Email ID** does not match a live email asset in Eloqua — a typo, or the asset was deleted or never published. | Re-check the Email Asset ID in your Eloqua instance and re-enter it on the journey node. | | Sends work at low volume but drop out when the journey fires at scale. | Your Eloqua instance is hitting its 60-requests-per-minute API limit, which is shared with every other integration calling that instance. | Review what else is calling the same Eloqua instance, and the rate the journey node fires at. | | The contact exists in Eloqua and the asset is valid, but the email is still not delivered. | Eloqua's own send rules are suppressing the contact. By default this integration does not send to globally unsubscribed contacts, hard-bounced contacts, or contacts on Eloqua's master exclusion list. Contacts unsubscribed only from the email's group are still sent to. | Check that contact's subscription status, bounceback status and master exclusion membership in Eloqua. | If none of these apply, raise a support ticket and include: the destination name, the journey and node where the send should have fired, the Email Asset ID you configured, the Eloqua contact ID of an affected customer, and the timestamp at which the customer reached the node. ## FAQ > [accordion] Can I write or edit the email content in Zeotap? > > No. The email asset is built, edited and approved entirely in Oracle Eloqua. Zeotap only instructs Eloqua to send an asset that already exists, identified by its Email Asset ID. Change the content in Eloqua and the next trigger picks it up — you do not need to touch the journey node unless the asset ID changes. > [accordion] Why does the mapping ask for a contact ID instead of an email address? > > Eloqua's Email Deployment API addresses a contact by Eloqua's own internal numeric ID, which is its primary key for that contact, and will not accept an email address in its place. That ID therefore has to be resolved onto the Zeotap customer profile before the journey runs. If the attribute you map is empty for a customer, no email is triggered for them. > [accordion] Does the destination decide which email is sent? > > No. The destination holds only the connection to your Eloqua instance and the contact ID mapping. **Email ID**, **Email Name** and **Name** are set on the journey node, so the email a trigger sends is decided per node rather than once per destination. ## Next steps * [Build the journey that drives the trigger →](/articles/orchestrate-customer/create-a-workflow) * [Understand how destinations work in general →](/articles/integrate-customer/destinations) * [Browse the other real-time integrations →](/articles/integrate-customer/real-time-integrations) * [Check what else Zeotap connects to, and in which direction →](/articles/integrations-master-list-publication/integrations-master-list) # Send audiences to Emarsys Source: https://docs.zeotap.com/articles/integrate-customer/emarsys Configure the Emarsys destination in Zeotap CDP to activate audiences, contact lists, and triggered events in your Emarsys marketing automation account. ## What this is Emarsys is a marketing automation platform for personalised email, SMS, and multi-channel campaigns. The Zeotap CDP Emarsys destination sends contacts, attributes, and triggered events from your Zeotap audiences into an Emarsys account, where you can address them in Contact Lists or Automation (Interaction) Programs. This page walks you through gathering the Emarsys credentials Zeotap CDP needs, creating the destination, choosing an action (send-to-contact-list, triggered event, or the deprecated identifiers-only action), mapping Catalogue fields to Emarsys fields, and verifying that pushed audiences arrive in Emarsys. ## Prerequisites > [!NOTE] > > Before you create the Emarsys destination in Zeotap CDP, gather these values from your Emarsys account: > > * **User name (API ID)** and **Secret** for an Emarsys API user with the required permissions (see below). > * **Key ID** — the Emarsys **Field ID** of the primary identifier you want Zeotap to use. Standard system fields have predefined Field IDs (for example, `3` for Email). > * For the **Send triggered event** action: the **Event ID** of an External Event created in Emarsys. > * If your primary identifier is a **custom ID**, it must be activated by the Emarsys Support Team before the destination will accept it. ### Supported identifiers and attributes The Emarsys destination accepts: * Email address (raw) * First Name, Last Name * Gender * Date of birth * Phone, Mobile * City * Company, Company address * City (office) * Opt-in — accepted values are `Yes` / `No` or `True` / `False`. For other values, contact your Zeotap point of contact. * Custom Fields (identifiers or attributes) ### Available actions | Action | [ID Extension](/articles/segment-customer/extend-your-audience#id-extension) | [DELETE](https://docs.zeotap.com/articles/#!integrate-customer/delta-upload-and-delete-functions) | [Delta Upload](https://docs.zeotap.com/articles/#!integrate-customer/delta-upload-and-delete-functions) | | :- | :-: | :-: | :-: | | Send identifiers to Emarsys (Deprecated) | ✅ | — | — | | Send contacts to contact list (Audience) | — | — | — | | Send triggered event (Audience) | — | — | — | Sample accepted values for the Opt-in field: ```text theme={null} Opt-in: Yes Opt-in: No Opt-in: True Opt-in: False ``` ## Obtain the User name (API ID) and Secret from Emarsys The **User name (API ID)** and **Secret** authenticate Zeotap's API calls to Emarsys. **Step 1** In Emarsys, go to **Management > Account Management > Security Settings > API**. ![The Emarsys Security Settings page reached from Management, Account Management, Security Settings, showing the API Credentials list and the banner announcing that WSSE authentication is deprecated with final sunset at the end of 2026. The credential IDs are redacted.](https://mintcdn.com/zeotap/AhNyxmNj8en7XevZ/articles/integrate-customer/Storage/integrate-customer/emarsys/emarsys-security-settings-2026-10-30.png?fit=max\&auto=format\&n=AhNyxmNj8en7XevZ\&q=85\&s=a32116085a59a9a639326daa12213d28) **Step 2** Under **API Credentials**, click **Create API Credentials**. ![Create API Credentials button under API Credentials in Emarsys](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys-real-time-integration/emarsys-real-time-integration-2025-01-17.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=cb0cf4b34cf29b878ce3b848af6679a0) **Step 3** Under **Create API Credentials**, select **WSSE (Deprecated)** as the authentication method. WSSE (Web Services Security Extensions) creates credentials that use WSSE over SSL and require a custom `X-WSSE` header on each request. [Learn more](https://dev.emarsys.com/docs/emarsys-core-api-guides/branches/main/b3c3a1eba8515-authentication). ![WSSE authentication method selected in the Create API Credentials window](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/emarsys-2025-01-16-2.png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=fb32f4aa188d9551d2583cc459c355b8) **Step 4** Enter the **Password** associated with your Emarsys account to complete credential creation. **Step 5** Copy the **ID** (this is the **User name** in Zeotap CDP) and the **Client Secret**. > [!WARNING] > > The **Client Secret** is visible only while you remain on this page. Copy it to a secure location before navigating away — Emarsys does not display it again, and losing it requires creating a new credential. ![ID and Client Secret shown under API Credentials after creation](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/emarsys-2025-01-16-3.png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=aec0787f78ab917fcd1ac85dbb481231) **Step 6** Scroll to **Permissions** and enable the following for this API user: * Under **contact**: `contacts.update`. ![contacts.update permission enabled under contact](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/emarsys_permission_2_\(1\).png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=a5423545ea54ae11e2d0e29b6508a6f7) * Under **contactlist**: `contactlist.contact.add`, `contactlist.contact.delete`, `contactlist.create`. ![contactlist permissions enabled under contactlist](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/emarsys_permission_3_\(1\).png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=7af10a8163c4a7005333d49764811bdc) * Under **externalevent**: `externalevent.create`, `externalevent.trigger`. ![externalevent.create and externalevent.trigger permissions enabled under externalevent](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/image_\(58\)_\(1\).png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=051956b8805f1b540b37163689a96fa6) ## Obtain the Key ID (Field ID) from Emarsys The **Key ID** is the Emarsys **Field ID** of your primary identifier. System fields (raw email, first name, last name, and others) have predefined Key IDs — for example, the Key ID for **Email** is `3`. Use system-field IDs directly, or create a custom field for a custom identifier. See the [Emarsys system fields reference](https://help.emarsys.com/hc/en-us/articles/115004637665-Overview-The-Emarsys-system-fields). > [!NOTE] > > To use a **custom ID** as the primary identifier, create a custom field in Emarsys and use its Field ID as the Key ID in Zeotap CDP. The custom ID must be activated by the [Emarsys Support Team](https://emarsys.zendesk.com/auth/v2/login/signin?return_to=https%3A%2F%2Fhelp.emarsys.com%2Fhc%2Fen-us%2Frequests%2Fnew) before Emarsys will accept it as a primary identifier. > > ![Custom field used as the primary identifier in Emarsys](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/emarsys-2025-01-24.png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=a99ad108b65907c7a3d8a6fd759abd3f) **Step 1** In Emarsys, go to **Management > Data Management > Field Editor**. ![Emarsys navigation to Management, Data Management, Field Editor](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys/Emarsys_sym_1.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=8651b563aa45ee0d29393ae66b846559) **Step 2** Click **Create Field**. ![Create Field button in the Field Editor](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/emarsys-2024-06-18.png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=675b643811390216adaaf0920e3a4d33) **Step 3** In the **Field Generator** page, enter a **Name**, a **String ID**, and a **Type** for your identifier, then click **Save** to generate a Field ID. ![Field Generator page with Name, String ID, and Type fields](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/emarsys_sym_2.png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=6dcd684b9dab045800a6aa134bbbff42) **Step 4** The new identifier appears in the **Field Editor** list. Copy its **Field ID** — you will paste it into the **Key ID** field when you create the destination in Zeotap CDP. ![Field Editor list showing the Field ID of the new identifier](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/emarsys-2024-06-18-1.png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=38d6748d815cb82b946084c43dba9e1f) ## Create the Emarsys destination in Zeotap CDP With the User name, Secret, and Key ID in hand, create the destination in Zeotap CDP. **Step 1** Log into Zeotap CDP and open the **DESTINATIONS** application. **Step 2** Click **+ Create Destination**. ![Create Destination button in the Destinations application](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_1.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=92dfe8ecb29e59c9d7d57cb954e54618) **Step 3** Under **All Destinations**, search for **Emarsys**. ![Searching for a destination under All Destinations](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_2.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=6f5f0f5367788fb4e9e946f4b3cb5874) **Step 4** Click **Emarsys** and enter the connection details on the right-hand side: * A **Name** for the destination. * **User name** — the **ID** from Emarsys API Credentials. * **Secret Key** — the **Client Secret** from Emarsys API Credentials. * **Key ID** — the Emarsys **Field ID** of your primary identifier. > [!NOTE] > > To use a `custom_ID` as the `key_ID`, first have Emarsys Support activate the custom ID on your account. Review the values, then click **Next**. ![Emarsys destination connection details form in Zeotap CDP](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/emarsys_enhance_new_1.png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=46b970e6af4b00175e96a890431fed9f) **Step 5** Under **Choose your Action**, pick the action that matches how the audience will be consumed in Emarsys. **a. Send Identifiers to Emarsys (Deprecated)** — sends only email addresses to Emarsys. Kept for legacy destinations; pick one of the actions below for new destinations. ![Send Identifiers to Emarsys action selected](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/emarsys-2024-12-09-1.png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=87fc368ff05202166e5e111b451ec033) **b. Send contacts to contact list (Audience)** — sends all mapped identifiers and attributes to an Emarsys contact list. Map fields under **Map the Fields**. To send a custom field, click **Add Mapping Field**, pick a **Catalogue field**, and enter the Emarsys **Field ID** of the custom field under **Destination Field**. ![Send contacts to contact list action with field mapping](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/emarsys-2024-12-09.png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=26e70d63b3afee5ee56d86103b09835a) **c. Send triggered event (Audience)** — sends identifiers or attributes as the payload of an Emarsys External Event, as one of: * [Array/List of primitives](https://docs.zeotap.com/articles/unify-customer/data-types-in-catalogue/a/h2_299610936) (List of String / Integer / Double / Boolean), or * [Objects](https://docs.zeotap.com/articles/unify-customer/data-types-in-catalogue/a/h2_2051284657) or [Array/List of Objects](https://docs.zeotap.com/articles/unify-customer/data-types-in-catalogue/a/h2_1596665070). ![Send triggered event action selected](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/emarsys-2024-12-09-2.png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=8e745d64d2b54e35bc99befe5c0ff0fe) For this action you do **not** need to pre-create fields on the Emarsys side (unlike the other audience actions). Use the data-type drop-down to pick the type for each attribute or identifier and map Catalogue fields to Destination fields. The name you enter as the **Destination Field** is the attribute name that appears in Emarsys. If you pick **Objects** or **List of Objects**, map each object property under its parent. See [data types in Catalogue](https://docs.zeotap.com/articles/unify-customer/data-types-in-catalogue) for guidance on when to use each type. ![Mapping object properties under a parent object in the triggered event action](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/emarsys-2024-12-03-2.png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=4ea3fab8fa0ad268c75dbcb7bce5d118) > [!NOTE] > > In the **Destinations Settings** window, provide the **Event ID** of the Emarsys External Event that will receive the data. See [Emarsys Real Time Integration](/articles/integrate-customer/emarsys-real-time-integration#h3_399174679) for how to create an External Event and copy its Event ID. ![Destinations Settings window with the Event ID field](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/emarsys-2024-12-04.png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=3c861deb05ad8b4e53482d69db90f354) **Step 6** Click **Create Destination**. The destination is now available in the **Audiences** application for linking to an audience or segment. ## Link an audience to the Emarsys destination For step-by-step instructions on linking an audience or segment to the destination in the **Audiences** application, see [Link an Audience to the Destination](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > The terms **Audiences** and **Segments** refer to the same object — a customer cohort defined by criteria. For example, an audience or segment can be customers over 18 who performed an `addToCart` event in the last 30 days. ## Verify the audience arrived in Emarsys After you link an audience and it runs, confirm the data landed in Emarsys. **For the Send contacts to contact list action:** **Step 1** Log into Emarsys and go to **Contacts > Contact Lists**. > [!NOTE] > > A **Contact List** in Emarsys is an audience (segment) created in the Zeotap CDP Audiences application and pushed through this destination. ![Emarsys navigation to Contacts, Contact Lists](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/image-20240313-173552.png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=7367bc10ec5123d54dfaa86d91ed6f17) **Step 2** Under **Contact Lists**, confirm your Zeotap CDP audience appears with the expected name and contact count. ![Contact Lists page showing audiences pushed from Zeotap CDP](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/image-20240313-173732.png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=95de2545821ca8c8f7f3badafd0d4830) **For the Send triggered event action:** open the corresponding External Event in **Management > Data Management > External Event** and confirm the Automation (Interaction) Program bound to that Event ID advances contacts through its journey after the audience runs. ## Troubleshooting | Condition | What it means | Where to look | | - | - | - | | Destination rejects the User name or Secret Key | The WSSE credential does not match, or the Secret was not copied while it was visible on the Emarsys credentials screen | Emarsys → Management → Account Management → Security Settings → API → API Credentials | | Contacts are not created or updated in Emarsys | The API user is missing the `contacts.update` permission | Emarsys → Management → Account Management → Security Settings → API → Permissions → contact | | The contact list is not created, or contacts are not added or removed from it | The API user is missing one of `contactlist.create`, `contactlist.contact.add`, `contactlist.contact.delete` | Emarsys → Management → Account Management → Security Settings → API → Permissions → contactlist | | Triggered event does not fire in the Automation Program | The API user is missing `externalevent.create` or `externalevent.trigger`, or the wrong **Event ID** was entered under **Destinations Settings** | Emarsys → Management → Data Management → External Event; Zeotap CDP → Destinations → Emarsys → Destinations Settings | | Destination refuses a custom identifier as the Key ID | The custom field has not been activated by Emarsys Support | Emarsys Support Team (Zendesk) | | Opt-in values are not accepted | Opt-in accepts only `Yes` / `No` or `True` / `False`; other values are rejected | Opt-in field mapping in the Zeotap CDP destination form | If the condition does not match any row above, contact your Zeotap point of contact. Include the destination name, the action selected, the mapping you configured, and (for triggered events) the Emarsys External Event ID. ## FAQ > [accordion] What is the difference between the three Emarsys actions? > > **Send Identifiers to Emarsys (Deprecated)** sends only email addresses and is kept for legacy destinations. **Send contacts to contact list (Audience)** sends all mapped identifiers and attributes into an Emarsys contact list. **Send triggered event (Audience)** sends identifiers or attributes as the payload of an Emarsys External Event, so an Automation (Interaction) Program can react to the audience in real time. > [accordion] Where do I find the Key ID for standard fields like Email? > > Standard Emarsys system fields have predefined Field IDs — for example, `3` for Email. See the [Emarsys system fields reference](https://help.emarsys.com/hc/en-us/articles/115004637665-Overview-The-Emarsys-system-fields) for the full list. Enter the Field ID directly in the **Key ID** field when creating the destination — no new field is required in Emarsys. > [accordion] Do I need to create an Emarsys field for the triggered-event action? > > No. For **Send triggered event (Audience)**, Emarsys does not require a pre-created field. The name you enter as the **Destination Field** in Zeotap CDP becomes the attribute name on the External Event payload in Emarsys. > [accordion] Why can I not copy the Client Secret later? > > Emarsys displays the Client Secret only once, on the same page where the API credential is created. After you navigate away, the Secret is not shown again. If you lose it, create a new API credential in Emarsys and update the destination in Zeotap CDP with the new Secret. ## Next steps * [Explore Emarsys Real-Time Integration →](/articles/integrate-customer/emarsys-real-time-integration) * [Explore Creating an Emarsys Source →](/articles/integrate-customer/creating-an-emarsys-source) * [Explore the Emarsys Source for email engagement data →](/articles/integrate-customer/emarsys-source) * [Explore Getting Emarsys Credentials →](/articles/integrate-customer/getting-emarsys-credentials) * [Explore linking an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) # Emarsys real-time integration Source: https://docs.zeotap.com/articles/integrate-customer/emarsys-real-time-integration Send customer events out of Zeotap CDP to Emarsys as they happen, so an Emarsys interaction program can respond to them in real time. ## What this is The Emarsys real-time integration sends data **out of** Zeotap CDP to Emarsys: as a customer passes through a Journeys workflow, Zeotap CDP triggers an external event in your Emarsys account, and an Emarsys interaction program acts on it immediately. Emarsys is a marketing automation platform for building personalised marketing campaigns. Because the events arrive as they happen rather than on a batch schedule, you can react while the customer is still in the moment. For example, you can target customers who abandon their cart: Zeotap CDP records the abandonment in Emarsys as it occurs, and the interaction program sends an immediate follow-up message with an incentive to complete the purchase. > [!NOTE] > > **Sending data the other way, or in batches?** > > * To pull email campaign response data and contacts **into** Zeotap CDP, see the [Emarsys source](/articles/integrate-customer/emarsys-source). > * To push audiences to Emarsys contact lists on a batch schedule rather than per event, see the [Emarsys destination](/articles/integrate-customer/emarsys). ## Supported identifiers and actions The **Key ID** identifies your contacts in Emarsys. It is the Field ID of your main identifier in your Emarsys account — for example, the Field ID for email is `3`. To use a custom identifier instead, create a custom field in Emarsys and use its Field ID as the Key ID. See [Find the field ID (key ID) in Emarsys](#find-the-field-id-key-id-in-emarsys). Under **Choose your Action** on the destination form you can pick: | Action | What it does | | :- | :- | | Send triggered event (Journeys) | Sends the data from the workflow to the external event in Emarsys. | | Create or Update Contacts | Creates or updates contacts in Emarsys from the data sent by the workflow. | | Delete Contacts from Emarsys | Deletes contacts in Emarsys, matched on the Key ID you map. For example, with Key ID `3` mapped to an email field from the Catalogue, contacts are deleted by the email address that moved through the journey. | The following Emarsys fields are available in the mapping: | Emarsys field | Mapping | | :- | :- | | First Name | Mapped automatically to First Name in the Zeotap Catalogue. You can edit the mapping. | | Last Name | Mapped automatically to Last Name in the Zeotap Catalogue. You can edit the mapping. | | Annual Income | Map the relevant Catalogue field on the left. | | Gender | Map the relevant Catalogue field on the left. | | City | Map the relevant Catalogue field on the left. | | Company | Map the relevant Catalogue field on the left. | | Company Address | Map the relevant Catalogue field on the left. | | Country | Map the relevant Catalogue field on the left. | | Department | Map the relevant Catalogue field on the left. | | Date of Birth | Map the relevant Catalogue field on the left. | | Industry | Map the relevant Catalogue field on the left. | | Job Position | Map the relevant Catalogue field on the left. | | Office City | Map the relevant Catalogue field on the left. | | Office Country | Map the relevant Catalogue field on the left. | | Opt-in | Map the relevant Catalogue field on the left. The acceptable values for this field are `Yes/No` or `True/False`. | You can also map custom fields: give the destination field any name you like, and the attribute appears in Emarsys under that name. ## Prerequisites Before you configure anything in Zeotap CDP, you need: * **An Emarsys account** with access to **Management > Data Management > External Event**, **Management > Data Management > Field Editor** and **Management > Account Management > Security Settings**. * **The Interactions Program add-on in Emarsys.** The integration triggers an interaction program, so the add-on has to be in place on your Emarsys account. * **Contacts already in Emarsys.** The contact information of the customers you target must exist in Emarsys under **Contacts**. Without it the external event cannot be triggered and the automation program fails. [Learn more](https://help.emarsys.com/hc/en-us/articles/115004635409-Contact-lists-Managing-contact-lists) * **A workflow in Journeys** to send the data from. See [Create a workflow](/articles/orchestrate-customer/create-a-workflow). Then complete the four Emarsys-side tasks below and keep the values they produce — you enter them into Zeotap CDP later. > [card] [1. Create an external event and copy the event ID](#create-an-external-event-in-emarsys) > [card] [2. Create an interaction program using the event ID](#create-an-interaction-program-in-emarsys) > [card] [3. Find the field ID (key ID)](#find-the-field-id-key-id-in-emarsys) > [card] [4. Create API credentials](#create-api-credentials-in-emarsys) ## Set up Emarsys ### Create an external event in Emarsys External events are triggers that let you respond to custom API events performed by your customers, such as Cart Abandoned, Order Confirmation or Subscription Renewal. When a customer performs an action that matches one of these events, the external event triggers a response from the [interaction program](#create-an-interaction-program-in-emarsys) you configure around it. **Step 1** Log into your [Emarsys account](https://suite55.emarsys.net) and navigate to **Management > Data Management > External Event**. ![The Emarsys navigation with the Management menu open and Data Management, External Event selected.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys-real-time-integration/emarsys-real-time-integration-2024-08-08-7.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=91d6938995cb35e8ad9c3a0f1577efc1) **Step 2** Click **Create External Event**. ![The External Events page in Emarsys with the Create External Event button.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys-real-time-integration/emarsys-real-time-integration-2024-08-08-3.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=67c38bfde8c6b2ea58f3f0cceca7be6e) **Step 3** Enter a **Name** for the external event and click **Create**. Use the same name for the external event as the **Workflow Title** you give the Journeys workflow — it makes the two easier to match up later. ![The Create External Event dialog in Emarsys, with a Name field and a Create button.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys-real-time-integration/emarsys-real-time-integration-2024-08-08-6.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=677ddd8f21a2a8c10496724e39958a19) **Step 4** The event now appears in the **External Events** list. Copy its **External Event ID**. You need it when you create the interaction program in the next step, and again when you [link the destination to a workflow](#link-the-destination-to-a-workflow) in Zeotap CDP. ![The External Events list in Emarsys, showing the External Event ID column beside each event name and creation date, with the ID of the newly created event highlighted.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys-real-time-integration/emarsys-real-time-integration-2024-08-08-5.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=83240086fee3647ec8b66d0c4740b3a7) ### Create an interaction program in Emarsys Interaction programs in Emarsys are real-time responses to customer events and actions. They drive automated journeys that adapt to customer activity, so you can send timely, relevant and personalised messages — for example, delivery status updates such as "Delivery Successful" or "Your Order Has Been Shipped", or a free-shipping Web Channel campaign for contacts who have viewed product pages repeatedly without adding anything to their cart. > [!NOTE] > > **Note:** > > Procure the **Interactions Program** add-on in Emarsys to use this integration. **Step 1** Log into your [Emarsys account](https://suite55.emarsys.net) and navigate to **Automation > Automation Programs**. ![The Emarsys navigation with the Automation menu open and Automation Programs selected.](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/interaction_1.png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=a69fc9f83fee3c12ab0098f5d666423f) **Step 2** On the **Automation Programs** screen, click **Create Program**. ![The Automation Programs screen in Emarsys, listing existing programs with their status and type, and the Create Program button.](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/interaction_2.png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=ecd6c2d77fa3fad4511eaec4dea047d8) **Step 3** Click **Event-based journeys**, then **External Event**. ![The Create Program dialogs in Emarsys: the program-type list with Event-based journeys selected, and the event-source list beside it with External Event selected.](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/interaction_4.png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=0d85ff076f2716f721c117e5f0e9b3ea) **Step 4** Double-click the **External Event** trigger node. This is the entry point for your journey in Emarsys. ![The interaction program canvas in Emarsys with the External Event trigger node on it.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys-real-time-integration/emarsys-real-time-integration-2024-08-08-10.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=0efd9c999d82b3f17fe02bf4bb7f8a65) **Step 5** In the **External Event** dialog: * Under **Trigger Event**, choose the [external event](#create-an-external-event-in-emarsys) you created. Its **External Event ID** is shown below the drop-down. * **Trigger event timeout** is set to **Disable timeout** by default. Change it to **Set a custom trigger event timeout** if you need one. [Learn more](https://help.emarsys.com/hc/en-us/articles/360016952737-End-user-guides-Setting-up-the-trigger-event-timeout) * Click **Done**. ![The External Event dialog in Emarsys, with the Trigger Event drop-down, the read-only External Event ID and the trigger event timeout options.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys-real-time-integration/emarsys-real-time-integration-2024-08-08-16.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=213965fd6405f12be1c61b48ea5d77f2) > [!NOTE] > > **Note:** > > The contact information of your target customers must already exist in Emarsys under **Contacts**. Without it the external event cannot be triggered and the automation program fails. [Learn more](https://help.emarsys.com/hc/en-us/articles/115004635409-Contact-lists-Managing-contact-lists) **Step 6** Build out the rest of the [automation program](https://help.emarsys.com/hc/en-us/articles/360003898918-Overview-Interactions-Overview) for your use case. In the example below, the cart-abandonment external event acts as the trigger and passes the details of customers who abandoned their cart to a **Send SMS** node, which sends the follow-up message. Create the SMS campaign before you use it in the automation program. ![A two-node Emarsys interaction program: a cart-abandonment external event trigger connected to a Send SMS node that still carries a configuration warning badge, ending at the finish node.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys-real-time-integration/emarsys-real-time-integration-2024-08-20.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=2b5fa8f417d11a70123219ca00d0cbed) You can combine the [action nodes](https://help.emarsys.com/hc/en-us/articles/360020803437-Nodes-Interactions-Action-nodes) and [channel nodes](https://help.emarsys.com/hc/en-us/articles/360020803397-Nodes-Interactions-Channel-nodes) available in Emarsys in the same way, and use attribute-level information in your campaigns — tracking the customer's first name, for instance, lets you personalise the message with it. > [!NOTE] > > **Note:** > > You can create and update contact lists as part of your automation program, but doing so adds a delay to your real-time journeys. ### Find the field ID (key ID) in Emarsys The Field ID in Emarsys is the unique identifier of a contact data field, and it is what keeps data mapping and synchronisation between Emarsys and Zeotap CDP accurate. You enter the Field ID of your main identifier as the **Key ID** when you [create the destination](#create-the-emarsys-destination) — for example, the Field ID for email is `3`. Emarsys accounts include roughly 50 standard fields for contact data, known as [system fields](https://help.emarsys.com/hc/en-us/articles/115004637605-Overview-Contact-data-fields-Overview). You can also create [custom fields](https://help.emarsys.com/hc/en-us/articles/115004634689-End-user-guides-Creating-custom-fields) of your own. > [!NOTE] > > **Note:** > > To use a custom ID, create a custom field in Emarsys and use its Field ID when you create the destination in Zeotap CDP. The custom ID must be activated by the [Emarsys support team](https://emarsys.zendesk.com/auth/v2/login/signin?return_to=https%3A%2F%2Fhelp.emarsys.com%2Fhc%2Fen-us%2Frequests%2Fnew\&theme=hc\&locale=en-us\&brand_id=38892\&auth_origin=38892%2Ctrue%2Ctrue). > > ![The Field Editor in Emarsys on the Custom fields tab, listing custom fields with their Field ID, Field name, Category and Field type.](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/emarsys-2025-01-24.png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=a99ad108b65907c7a3d8a6fd759abd3f) **Step 1** Log into your [Emarsys account](https://suite55.emarsys.net) and navigate to **Management > Data Management > Field Editor**. ![The Emarsys navigation with the Management menu open and Data Management, Field Editor selected.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys/Emarsys_sym_1.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=8651b563aa45ee0d29393ae66b846559) **Step 2** To add an identifier of your own, click **Create Field**. ![The Field Editor in Emarsys with the Create Field button.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys-real-time-integration/emarsys-real-time-integration-2024-08-08-13.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=c87efedf5fdb179976d1da5854af04e8) **Step 3** On the **Field Generator** screen, enter a **Name** and a **String ID** for your identifier, choose its **Type**, and click **Create**. [Learn more](https://help.emarsys.com/hc/en-us/articles/115004634729-Overview-Available-field-types) ![The Field Generator screen in Emarsys, with the Name, String ID and Type fields and the Create button.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys-real-time-integration/emarsys-real-time-integration-2024-08-08-14.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=da81fda5f79fac37a73a4bf5ac901b34) **Step 4** The identifier appears in the **Field Editor** list. Copy the **Field ID** of your main identifier and use it as the **Key ID** when you [create the destination](#create-the-emarsys-destination). ![The Field Editor list in Emarsys with the Field ID column highlighted beside each field's string ID, name, category and type.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys-real-time-integration/emarsys-real-time-integration-2024-08-08-12.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=6e98b3c50febb58d1f3cec18a32f3124) ### Create API credentials in Emarsys The **User name (API ID)** and **Secret** authenticate the calls Zeotap CDP makes to Emarsys. **Step 1** Log into your Emarsys account and navigate to **Management > Account Management > Security Settings > API Credentials**. ![The Emarsys Security Settings page reached from Management, Account Management, Security Settings, showing the API Credentials list and the banner announcing that WSSE authentication is deprecated with final sunset at the end of 2026. The credential IDs are redacted.](https://mintcdn.com/zeotap/AhNyxmNj8en7XevZ/articles/integrate-customer/Storage/integrate-customer/emarsys/emarsys-security-settings-2026-10-30.png?fit=max\&auto=format\&n=AhNyxmNj8en7XevZ\&q=85\&s=a32116085a59a9a639326daa12213d28) **Step 2** Under **API Credentials**, click **Create API Credentials**. ![The API Credentials section of Emarsys Security Settings, with the Create API Credentials button.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys-real-time-integration/emarsys-real-time-integration-2025-01-17.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=cb0cf4b34cf29b878ce3b848af6679a0) **Step 3** Choose your API authentication method. Zeotap CDP currently supports **WSSE (Deprecated)** only; support for Open ID Connect is planned. Selecting WSSE — Web Services Security Extensions — creates API credentials that use WSSE authentication over SSL, which adds a custom `X-WSSE` header to each request. [Learn more](https://dev.emarsys.com/docs/emarsys-core-api-guides/branches/main/b3c3a1eba8515-authentication) ![The Create API Credentials dialog in Emarsys, offering OpenID Connect and WSSE as the two authentication methods.](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/emarsys-2025-01-16-2.png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=fb32f4aa188d9551d2583cc459c355b8) **Step 4** Enter the **Password** for your Emarsys account to complete the credential creation. **Step 5** The **ID** (the **User name** in Zeotap CDP) and **Client Secret** now appear under **API Credentials**. Copy them both before you go anywhere else — the secret is only available while you stay on this page, and you cannot copy it after navigating away. ![The API Credentials section of Emarsys Security Settings after a credential is created, showing the ID field, the Client Secret field and the banner warning that the secret is only available while you stay on the page.](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/emarsys-2025-01-16-3.png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=aec0787f78ab917fcd1ac85dbb481231) **Step 6** Scroll down to **Permissions** and enable the following for the credential: * Under **contact** — **contact.update** and **contact.create**. Also enable **contact.delete** if you want to use the Delete Contacts from Emarsys action. ![The contact permission list for an Emarsys API credential, with contact.create and contact.update switched on and the remaining contact permissions switched off.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys/Screenshot_2025-04-10_at_4-31-26_PM.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=1100d9cfb4dcdc67208285a53587048e) * Under **contactlist** — **contactlist.contact.add**, **contactlist.contact.delete** and **contactlist.create**. ![The contactlist permission list for an Emarsys API credential, with a toggle beside each permission.](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/emarsys_permission_3_\(1\).png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=7af10a8163c4a7005333d49764811bdc) * Under **externalevent** — **externalevent.create** and **externalevent.trigger**. ![The externalevent permission list for an Emarsys API credential, with externalevent.create and externalevent.trigger switched on.](https://mintcdn.com/zeotap/vzDgpNKaht27Bxzv/articles/integrate-customer/Storage/integrate-customer/emarsys/image_\(58\)_\(1\).png?fit=max\&auto=format\&n=vzDgpNKaht27Bxzv\&q=85\&s=051956b8805f1b540b37163689a96fa6) ## Create the Emarsys destination With the Emarsys values in hand, create the destination from inside a Journeys workflow. Build the workflow first, applying whatever filters and conditions select the customers you want — see [Create a workflow](/articles/orchestrate-customer/create-a-workflow). **Step 1** In the workflow, click **+** at the node level and choose **Send to Destinations**. ![The node action menu in a Journeys workflow, with Send to Destinations highlighted among the other node actions.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys-real-time-integration/emarsys-real-time-integration-2024-08-08-15.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=aaedb67bb184679d0ad1c7bc2fcbe33a) **Step 2** Go to **Integrate > Destinations**, click **+ Create Destination**, then search for and click **Emarsys**. **Step 3** On the **Enter Destination Details** step, fill in: * **Destination Name** — a name for the destination. * **User Name** — the name of the Emarsys account Zeotap sends data to. See [Create API credentials in Emarsys](#create-api-credentials-in-emarsys). * **Secret Key** — the secret from the same Emarsys API credential. * **Key Id** — the Field ID of your main identifier. See [Find the field ID (key ID) in Emarsys](#find-the-field-id-key-id-in-emarsys). ![The Enter Destination Details step of the Emarsys destination form, with the Destination Name, User Name, Secret Key and Key Id fields and the guidance that email uses key ID 3.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys-real-time-integration/emarsys-real-time-integration-2024-08-07.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=5d7215c9180d16b5d4d2b08548a8dc58) **Step 4** On the **Mapping** step, choose one action under **Choose your Action** and map the fields beneath it. * **Send triggered event (Journeys)** sends the data from the workflow to Emarsys. Under **Map the Fields**, pair each Catalogue field on the left with the Emarsys destination field on the right. ![The Mapping step of the Emarsys destination form with Send triggered event (Journeys) chosen, and the Map the Fields table pairing Catalogue attributes with Emarsys destination fields.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys-real-time-integration/emarsys-real-time-integration-2024-12-09.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=4013e75ab112ab36995573b2dec5e976) * **Create or Update Contacts** creates or updates contacts in Emarsys from the data the workflow sends. The same **Map the Fields** list of identifiers and attributes appears. ![The Choose your Action step of the Emarsys destination form with Create or Update Contacts selected.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys/Screenshot_2025-04-10_at_4-58-18_PM.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=c8941aa355ba7e6bd9e642ee674b8c02) * **Delete Contacts from Emarsys** deletes contacts matched on the Key ID you map. In the example below, Key ID `3` (email in Emarsys) is mapped to an email field from the Catalogue, so contacts are deleted by the email address that moved through the journey. You can map a different Key ID instead — see the Emarsys [contact system fields](https://dev.emarsys.com/docs/core-api-reference/7f3e853b57d26-contact-system-fields). ![The Choose your Action and Map the Fields steps with Delete Contacts from Emarsys selected and the Email Raw catalogue attribute mapped to destination key 3.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys-real-time-integration/emarsys-real-time-integration-2025-09-24.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=87a8622aab8acbc8bbdf6edea8a61647) **Step 5** Click **Create Destination**. The destination is created and becomes available for activation in Journeys. ## Link the destination to a workflow Once the destination exists, attach it to the **Send to Destinations** node in your workflow. **Step 1** In the workflow, click **+** at the node level and choose **Send to Destinations**. ![The node action menu in a Journeys workflow, with Send to Destinations highlighted among the other node actions.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys-real-time-integration/emarsys-real-time-integration-2024-08-07-2.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=0fa604622a36b0291df4e6594161c614) **Step 2** Find your destination with the search box. ![The Send to Destinations panel with the search box highlighted above a grid of existing destination cards.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys-real-time-integration/emarsys-real-time-integration-2024-08-07-3.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=905780d151c74c2199117924d8c88c89) **Step 3** On the **Destination Details** tab, the **User Name**, **Secret Key** and **Key Id** fields are already filled in from the destination you created. Enter the **Event Id** — the [External Event ID](#create-an-external-event-in-emarsys) from Emarsys, which is the trigger point on the Emarsys side. ![The Destination Details tab of an Emarsys destination in a workflow, with the Destination Name, User Name, Secret Key and Key Id fields pre-filled and read-only, and an editable Event Id field beneath them.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys-real-time-integration/emarsys-real-time-integration-2024-08-07-4.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=8bf4db9370fd631759b2a13971561411) **Step 4** On the **Destination Settings** tab, choose the action and mapping you want this node to use. ![The Destination Settings tab of an Emarsys destination in a workflow, with an action and a mapping chosen and the mapped output attributes listed below.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys-real-time-integration/emarsys-real-time-integration-2024-12-09-1.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=fca1e211ebe4607b0510e4e5263bb15f) **Step 5** Click **Save Destination**. The destination is attached to the node. ![The Send to Destinations panel with an Emarsys destination card attached, showing its name and the chosen mapping above the list of other available destinations.](https://mintcdn.com/zeotap/XvfkMbxDmHsFyji6/articles/integrate-customer/Storage/integrate-customer/emarsys-real-time-integration/emarsys-real-time-integration-2024-08-07-6.png?fit=max\&auto=format\&n=XvfkMbxDmHsFyji6\&q=85\&s=29cd64bc923df5dff9744c226040f2ad) **Step 6** Click **Add Destinations**. You can attach more than one destination to the same node. ![The Send to Destinations panel with a destination already attached — a Salesforce Marketing Cloud Personalization example — a search box, a grid of available destination cards and the Add Destinations button highlighted.](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26-4.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=fd6df4739a5d2a393fd1c77112c833ff) **Step 7** The linked destinations now appear in the **Send to Destinations** node. Carry on building the workflow from the **+** control, and enter a name for the workflow in the text box so it can be saved. **Step 8** When the conditions and filters are in place, either click **Save Draft** to come back and edit the workflow before publishing, or **Next: Define Re-entry Criteria** to set whether a customer can re-enter the same workflow. See [Add re-entry criteria](/articles/orchestrate-customer/add-re-entry-criteria). ![A Journeys workflow canvas with a workflow name entered, an attributes node, an event node and a Send to Destination node, and the Cancel, Save Draft and Next: Define Re-entry Criteria buttons along the bottom. The destination chip in this example capture belongs to another integration.](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26-7.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=b115f3bbc04540d675d2e9145a7f91d6) **Step 9** Click **Publish Workflow**. The workflow appears on the workflow listing screen with a **Published** status. ## Verify the integration * **Check the node metrics.** Metrics are available for every published workflow and show how many users passed through each node over the last 7 days, so you can confirm traffic is reaching the **Send to Destinations** node. See [Understand metrics](/articles/orchestrate-customer/understand-metrics). For the total number of users the workflow sent out, use the **ACTIVATED USERS** column on the listing screen. * **Trace a single customer.** Journey Traces shows the output event sent to each destination node for an individual user, which is the quickest way to confirm the payload Emarsys received. See [Journey traces](/articles/orchestrate-customer/journey-traces). * **Check Emarsys.** On **Automation > Automation Programs**, the program's **Status**, **Entry** and **Entry Configuration** confirm that it is active and that it is driven by the external event you created. ## Troubleshoot the integration * **The automation program never runs.** The contacts you are targeting must already exist in Emarsys under **Contacts**. If a contact is missing, the external event cannot be triggered and the automation program fails. * **The event ID is missing on the node.** The **Event Id** is not carried over from the destination — you enter it on the **Destination Details** tab each time you link the destination to a workflow node. Use the [External Event ID](#create-an-external-event-in-emarsys) from Emarsys. * **A custom identifier is not accepted.** Create the matching custom field in Emarsys first, and have the custom ID activated by the [Emarsys support team](https://emarsys.zendesk.com/auth/v2/login/signin?return_to=https%3A%2F%2Fhelp.emarsys.com%2Fhc%2Fen-us%2Frequests%2Fnew\&theme=hc\&locale=en-us\&brand_id=38892\&auth_origin=38892%2Ctrue%2Ctrue). * **You did not copy the secret in time.** The secret is only shown while you stay on the Emarsys API Credentials page and cannot be retrieved afterwards — create a new API credential and update the destination with it. * **Contacts are not created, updated or deleted.** Check the permissions on the Emarsys API credential: **contact.create** and **contact.update** for Create or Update Contacts, **contact.delete** for Delete Contacts from Emarsys, and **externalevent.create** and **externalevent.trigger** for the triggered event. * **Opt-in values are rejected.** The acceptable values for the Opt-in field are `Yes/No` or `True/False`. * **The workflow reports execution errors.** Start from the failed node — see [Identify journey errors](/articles/orchestrate-customer/identify-journey-errors), [Journey error codes](/articles/orchestrate-customer/journey-error-codes) and [Troubleshooting workflows](/articles/orchestrate-customer/journey-troubleshooting). ## Next steps > [card] [Create a workflow](/articles/orchestrate-customer/create-a-workflow) > [card] [Add re-entry criteria](/articles/orchestrate-customer/add-re-entry-criteria) > [card] [Journey traces](/articles/orchestrate-customer/journey-traces) > [card] [Emarsys destination (batch)](/articles/integrate-customer/emarsys) > [card] [Emarsys source](/articles/integrate-customer/emarsys-source) # Emarsys source Source: https://docs.zeotap.com/articles/integrate-customer/emarsys-source Pull email engagement data from Emarsys into Zeotap CDP, so campaign opens, clicks and bounces — and the contacts behind them — are available for unification and activation. ## What this is The Emarsys source moves data **into** Zeotap CDP: it connects to your Emarsys account and pulls detailed email engagement data for a given email campaign. Emarsys is a marketing automation platform that uses email marketing as its primary medium for delivering personalised campaigns. The integration works in two stages against the Emarsys API. It first requests the response data for the campaign you have configured, then retrieves the list of contacts associated with that data. This lets you bring in metrics and contact lists based on specific behaviours, such as opens, clicks and bounces. For example, after sending a "Flash Sale" campaign, you can pull the contacts who clicked a link in it and build a high-intent audience for a follow-up SMS campaign. > [!NOTE] > > **Sending data the other way?** This page covers the inbound direction only. To send audiences and attributes from Zeotap CDP to Emarsys, see the [Emarsys destination](/articles/integrate-customer/emarsys). To send customer events to Emarsys as they happen, see the [Emarsys real time integration](/articles/integrate-customer/emarsys-real-time-integration). ## Set up the Emarsys source Setting up the source takes two stages, each covered on its own page. ### 1. Get your Emarsys credentials In Emarsys, you create an API credential under **Management > Security Settings** and note the **Client ID** and **Client secret** that Emarsys generates, together with the permissions that credential needs. The Client secret is displayed only once, so save it somewhere secure before you navigate away — if you lose it, you have to generate a new set of credentials. You need an active Emarsys account with administrative privileges to do this. See [Getting Emarsys Credentials](/articles/integrate-customer/getting-emarsys-credentials). ### 2. Create the source in Zeotap CDP In the Zeotap CDP **Sources** application under **Integrate**, you create a source under the **Customer Engagement Channels** category and choose **Emarsys** as the data source. The source form takes the Client ID and Client Secret from the previous stage plus the Email Campaign ID whose engagement data you want, and only one source is supported at a time. You then pick the fields to ingest before creating the source. See [Creating an Emarsys Source](/articles/integrate-customer/creating-an-emarsys-source). ## Next steps * Once the source is created, data starts being ingested and is refreshed according to the source's Refresh Frequency. You can then map the incoming data to your [catalogue](/articles/unify-customer/catalogue). * Check the source's status, ingested record counts and last ingestion time on the source listing page — see [Components of the Source Listing Page](/articles/integrate-customer/components-of-the-source-listing-page). * For the other engagement platforms Zeotap can read from, see [Customer Engagement Channels](/articles/integrate-customer/customer-engagement-channels). * To activate Zeotap CDP audiences back into Emarsys, see the [Emarsys destination](/articles/integrate-customer/emarsys). # Exploring Source Reports Source: https://docs.zeotap.com/articles/integrate-customer/exploring-source-reports Read a source report in Zeotap CDP: the Data Ingestion Details panel for lifetime record counts and ingestion efficiency, and the File Ingestion Details panel for per-file status, record counts, size and ingestion logs. ## What this is The source report shows the ingestion health and status of a single source. It is available on the source details page under the **SOURCE REPORT** tab, and it is broadly divided into two panels: * **Data Ingestion Details** — lifetime record counts for the source, the split between records received, in progress, ingested and failed, and the ingestion efficiency. * **File Ingestion Details** — one row per file shared with Zeotap CDP, with its ingestion status for real-time and batch activation, its record counts, its size and its ingestion logs. This panel is only visible for batch data sources where data is being shared in files. ## Prerequisites > [!NOTE] > > Before you open a source report, confirm: > > * The source is created and its mapping is saved. Ingestion begins only after the source is mapped. > * The source has completed at least one ingestion attempt, so the report has data to display. > * You have permission to view source reports for the source you are investigating. ## Open the source report **1. Open Sources** Open **Sources** in Zeotap CDP to see the source listing. **2. Open the source** Click the source name to navigate to the source report screen. **3. Select the SOURCE REPORT tab** On the source details page, select the **SOURCE REPORT** tab. **Expected result:** the Data Ingestion Details panel opens, followed by the File Ingestion Details panel for batch sources that share data in files. ## Panel 1: Data Ingestion Details ![Data Ingestion Details panel showing record counts, a pie chart and the ingestion efficiency for a source.](https://mintcdn.com/zeotap/xYI7J3lLAExguMI0/articles/integrate-customer/Storage/integrate-customer/exploring-source-reports/exploring-source-reports-2024-08-09.png?fit=max\&auto=format\&n=xYI7J3lLAExguMI0\&q=85\&s=1898ac371b234f2e663b93145a189b9e) Figure 1 — The Data Ingestion Details panel on the SOURCE REPORT tab. The Data Ingestion Details panel displays the count for the source lifetime and provides the following information: * **Total Records Received** — the total records received, minus the total in-progress records. * **Total Records In Progress** — the count of records that are being ingested. * **Total Records Ingested** — the count of records that are ingested and available for activation. * **Total Records Failed** — the count of records that failed to ingest during ingestion. * **Pie chart** — a visual representation of the records received versus in progress, versus failed, versus ingested. * **Ingestion Efficiency** — the percentage of total records ingested versus total records received (for the ingested records). If the status is **Failed**, the ingestion efficiency is shown as **NA**. * **Download Report** — clicking **Download Report** downloads an image snapshot of the source report in `.png` format. ### View Graph **View Graph** is only visible for streaming sources where Zeotap fetches or collects data. It displays the trend graph of the data received and processed for the source, by status. You can view the graph for periods ranging from the last 7 to 90 days, or set a custom date range, and you can filter by status. ![Trend graph of records received and processed for a streaming source over a selected date range.](https://mintcdn.com/zeotap/xYI7J3lLAExguMI0/articles/integrate-customer/Storage/integrate-customer/exploring-source-reports/exploring-source-reports-2024-08-09-1.png?fit=max\&auto=format\&n=xYI7J3lLAExguMI0\&q=85\&s=c52f955715598efa39e272779b6926b7) Figure 2 — The trend graph of data received and processed for a streaming source, with the date-range and status filters. > [!NOTE] > > Once a source is mapped, ingestion may take up to **15 minutes** to begin. This delay accounts for processing the data collected between the time the source was integrated and when it was mapped. After the initial ingestion starts, all subsequent records are ingested in real time as they arrive. ## Panel 2: File Ingestion Details The **File Ingestion Details** panel provides information about the file name, the status of ingestion for both real-time and batch activations, the count of records ingested versus the total record count, the file size (for flat files), and logs related to the ingestion process. This panel is only visible for batch data sources where data is being shared in files. ![File Ingestion Details panel listing files with their ingestion status, records ingested, size and type.](https://mintcdn.com/zeotap/xYI7J3lLAExguMI0/articles/integrate-customer/Storage/integrate-customer/exploring-source-reports/exploring-source-reports-2024-08-09-2.png?fit=max\&auto=format\&n=xYI7J3lLAExguMI0\&q=85\&s=6d1e2f7fff003cd378c80bef315333be) Figure 3 — The File Ingestion Details panel, one row per file shared with Zeotap CDP. You can filter the file ingestion details for the last 7, 30 or 90 days, with 7 days as the default filter. The panel also provides details on the total number of files dropped and shows their status. ![Date-range filter on the File Ingestion Details panel with the count of files dropped and their status.](https://mintcdn.com/zeotap/xYI7J3lLAExguMI0/articles/integrate-customer/Storage/integrate-customer/exploring-source-reports/exploring-source-reports-2024-08-09-3.png?fit=max\&auto=format\&n=xYI7J3lLAExguMI0\&q=85\&s=109b98c52865a6eb693d5f09525d086d) Figure 4 — The date filter, and the count of files dropped with their status. ### Columns in the File Ingestion Details panel | # | Column | What it shows | | :- | :- | :- | | 1 | File Name | The name of the file shared with Zeotap CDP. | | 2 | Status | The status of the file drop and of ingestion, for both real-time and batch activation types. See [Status indicators](#status-indicators). | | 3 | Records Ingested | The count of the records currently being ingested, or available, corresponding to the real-time or batch ingestion status. It also includes the date and timestamp when the file was dropped for ingestion. | | 4 | Size | The size of the dropped file. | | 5 | Type | The dropped file type. | | 6 | View Logs | Opens a detailed view of the file ingestion and its status. See [Ingestion logs](#ingestion-logs). | > [!NOTE] > > For batch sources, ingestion of each file begins within **15 minutes** from the time the source is mapped and the file is successfully dropped. ### Status indicators The **Status** column carries three indicators: one for the file drop itself, one for real-time activation and one for batch activation. A file becomes ready for real-time activation first — that is an intermediate state before the file moves on to batch activation. ![Status indicators for file drop and for real-time and batch activation ingestion.](https://mintcdn.com/zeotap/xYI7J3lLAExguMI0/articles/integrate-customer/Storage/integrate-customer/exploring-source-reports/exploring-source-reports-2024-08-09-4.png?fit=max\&auto=format\&n=xYI7J3lLAExguMI0\&q=85\&s=f3f8b53b566b6e9919c2102432b3e1fb) Figure 5 — The status of file drop and ingestion, shown for both real-time and batch activation types. | Indicator | What it means | | :- | :- | | ![Status indicator for File received.](https://mintcdn.com/zeotap/xYI7J3lLAExguMI0/articles/integrate-customer/Storage/integrate-customer/exploring-source-reports/exploring-source-reports-2024-08-09-5.png?fit=max\&auto=format\&n=xYI7J3lLAExguMI0\&q=85\&s=ecfca172e06abf58adcaa5bde7b1bcd2) | File received. | | ![Status indicator for ingestion not started for real-time activation.](https://mintcdn.com/zeotap/xYI7J3lLAExguMI0/articles/integrate-customer/Storage/integrate-customer/exploring-source-reports/exploring-source-reports-2024-08-09-6.png?fit=max\&auto=format\&n=xYI7J3lLAExguMI0\&q=85\&s=83b0536b2e27586fb92f3eb34159e81e) | Ingestion not started for real-time activation. | | ![Status indicator for ingestion in progress for real-time activation.](https://mintcdn.com/zeotap/xYI7J3lLAExguMI0/articles/integrate-customer/Storage/integrate-customer/exploring-source-reports/exploring-source-reports-2024-08-09-7.png?fit=max\&auto=format\&n=xYI7J3lLAExguMI0\&q=85\&s=48debee7f1c4d3406dbf7dedd1d6f563) | Ingestion for real-time activation, for example through Journeys, is in progress. | | ![Status indicator for ingestion complete for real-time activation.](https://mintcdn.com/zeotap/xYI7J3lLAExguMI0/articles/integrate-customer/Storage/integrate-customer/exploring-source-reports/exploring-source-reports-2024-08-09-8.png?fit=max\&auto=format\&n=xYI7J3lLAExguMI0\&q=85\&s=76592cfc4e1577fc96bd6208399249da) | Ingestion complete for real-time activation. | | ![Status indicator for ingestion not started for batch activation.](https://mintcdn.com/zeotap/xYI7J3lLAExguMI0/articles/integrate-customer/Storage/integrate-customer/exploring-source-reports/exploring-source-reports-2024-08-09-9.png?fit=max\&auto=format\&n=xYI7J3lLAExguMI0\&q=85\&s=0508e336ee26e69a4b039d33e252c028) | Ingestion not started for batch activation. | | ![Status indicator for ingestion in progress for batch activation.](https://mintcdn.com/zeotap/xYI7J3lLAExguMI0/articles/integrate-customer/Storage/integrate-customer/exploring-source-reports/exploring-source-reports-2024-08-09-10.png?fit=max\&auto=format\&n=xYI7J3lLAExguMI0\&q=85\&s=8257c03764144004e8d924a11b73414e) | Ingestion for batch activation, through Audiences, is in progress. | | ![Status indicator for ingestion complete for batch activation.](https://mintcdn.com/zeotap/xYI7J3lLAExguMI0/articles/integrate-customer/Storage/integrate-customer/exploring-source-reports/exploring-source-reports-2024-08-09-11.png?fit=max\&auto=format\&n=xYI7J3lLAExguMI0\&q=85\&s=2e0bfd2c77fe41e6d7a561fe5cd5b9d3) | Ingestion is complete for batch activation. | ### Ingestion logs **View Logs** provides a detailed view of the file ingestion and its status. It also displays a list of errors identified in case of failure. To match an error title to the change required in your source data, see [Understanding the Ingestion Log Error](/articles/integrate-customer/understanding-the-ingestion-log-error). ![Ingestion log view for a file, listing the ingestion status and the errors identified.](https://mintcdn.com/zeotap/xYI7J3lLAExguMI0/articles/integrate-customer/Storage/integrate-customer/exploring-source-reports/exploring-source-reports-2024-08-09-12.png?fit=max\&auto=format\&n=xYI7J3lLAExguMI0\&q=85\&s=6da28f17fed796852dd059c7ace665d8) Figure 6 — The Ingestion Log opened from View Logs, showing when the file was dropped, when ingestion started, and the records ingested versus rejected. ## Verify that a file was ingested **1. Open the SOURCE REPORT tab** Open the source and select the **SOURCE REPORT** tab. **2. Set the date filter to cover the file drop** In **File Ingestion Details**, set the filter to the last 7, 30 or 90 days so that it covers the day the file was dropped. The default filter is 7 days. **3. Find the file and read its status** Locate the row for the file by its name, then read the **Status** column against the [status indicators](#status-indicators). A fully ingested file shows ingestion complete for real-time activation and ingestion complete for batch activation. **4. Compare the record counts** Check **Records Ingested** against the total record count for the file. If records are missing, open **View Logs** for the row to see the errors identified. ## Troubleshooting * **The File Ingestion Details panel is not visible.** The panel is only visible for batch data sources where data is being shared in files. A streaming source shows only the Data Ingestion Details panel. * **View Graph is not available.** The graph is only visible for streaming sources where Zeotap fetches or collects data. * **Records are counted as failed.** Open **View Logs** for the file to read the errors identified, then correct the source data using [Understanding the Ingestion Log Error](/articles/integrate-customer/understanding-the-ingestion-log-error) and re-ingest. ## FAQ > [accordion] How soon after mapping does data appear in the source report? > > Once a source is mapped, ingestion may take up to 15 minutes to begin, because the data collected between integration and mapping is processed first. After the initial ingestion starts, subsequent records are ingested in real time as they arrive. For batch sources, ingestion of each file begins within 15 minutes from the time the source is mapped and the file is successfully dropped. > [accordion] Why does Ingestion Efficiency show NA? > > Ingestion efficiency is the percentage of total records ingested versus total records received. When the status is **Failed**, the ingestion efficiency is shown as **NA** instead of a percentage. > [accordion] Why does one file show two different ingestion statuses? > > The **Status** column reports ingestion separately for real-time activation and for batch activation. A file becomes ready for real-time activation first, which is an intermediate state before it moves on to batch activation, so a file can show ingestion complete for real-time activation while batch activation is still in progress. > [accordion] Can I export the source report? > > Yes. Click **Download Report** on the Data Ingestion Details panel to download an image snapshot of the source report in `.png` format. ## Next steps * [Explore the Source Report tab →](/articles/integrate-customer/source-report) * [Explore ingestion log errors →](/articles/integrate-customer/understanding-the-ingestion-log-error) * [Explore the Source Listing page and its ingestion charts →](/articles/integrate-customer/components-of-the-source-listing-page) * [Explore sources and how they bring data into Zeotap CDP →](/articles/integrate-customer/sources) # Facebook Source: https://docs.zeotap.com/articles/integrate-customer/facebook Send Zeotap CDP audiences to a Meta Custom Audience linked to your Facebook Ad Account for targeted advertising. ## What this is The Facebook destination pushes audience membership from Zeotap CDP into a Meta Custom Audience attached to a Facebook Ad Account managed through Meta Business Manager. It uses mobile advertising IDs (MAIDs) as the match key and supports adding members (ID extension) and removing members (delete), so the Custom Audience in Facebook stays aligned with the source segment in Zeotap CDP. Once linked, you can target the audience across Facebook's ad placements. For richer identifier support — hashed emails, phone numbers, names, and Facebook External IDs — with access-token authentication, use [Facebook 1P (Meta)](/articles/integrate-customer/facebook-1p) instead. For server-to-server event tracking, use [Facebook Conversions API](/articles/integrate-customer/facebook-conversions-api). ## Prerequisites > [!NOTE] > > Complete each of the following before creating the destination in Zeotap CDP: > > * A Meta Business Manager account with a Facebook Ad Account linked to it. > * The 16 digit **Ad Account ID** for that Facebook Ad Account. > * Accepted Custom Audiences Terms of Service for the Ad Account. Open the [Custom Audiences Terms of Service page](https://business.facebook.com/ads/manage/customaudiences/tos/?act=) and click **Accept** in the left corner. This step is mandated by Facebook from September 2021. > * An audience in the Zeotap CDP **Audiences** application with MAID identifiers available for activation. ### Locate your Ad Account ID The Ad Account ID is a 16 digit number identifying the Facebook Ad Account that will receive audience data. Find it in Facebook **Ads Manager** under the **Account** drop-down menu. Confirm the Ad Account is linked to your Facebook Business Manager before proceeding. ## Supported identifiers and actions This integration supports MAID identifiers for both Targeting and Audiences. | Action | [ID Extension](/articles/segment-customer/extend-your-audience#id-extension) | Delete | Delta Upload | | - | - | - | - | | Send identifiers to Facebook | ✅ | ✅ | — | MAID identifier formats accepted by the destination: ```text theme={null} # Google Advertising ID (GAID) 38400000-8cf0-11bd-b23e-10b96e40000d # Apple Identifier for Advertisers (IDFA) 6D92078A-8246-4BA4-AE5B-76104861E7DC ``` ## Configure the Facebook destination **1. Open the Destinations application** Log into the Zeotap CDP App and go to the **DESTINATIONS** application. Click **+ Create Destination** to open the destination catalogue. ![Destinations application with the + Create Destination button](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_1.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=92dfe8ecb29e59c9d7d57cb954e54618) **2. Select Facebook from the catalogue** Under **All Destinations**, search for **Facebook** and click the Facebook tile. The right pane displays the fields required to establish the integration. ![Searching the All Destinations catalogue](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_2.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=6f5f0f5367788fb4e9e946f4b3cb5874) **3. Enter the destination details** Provide the destination configuration: a. Enter a name for the destination. b. Enter the 16 digit **Ad Account ID** located above. c. Review the values and click **Next**. ![Facebook destination details form with name and Ad Account ID fields](https://mintcdn.com/zeotap/iO8h5JmzK8FO_MOm/articles/integrate-customer/Storage/integrate-customer/facebook/facebook-2023-11-08.png?fit=max\&auto=format\&n=iO8h5JmzK8FO_MOm\&q=85\&s=15818b16a33ec84c40f78bfd8fb4cd16) **4. Choose the action and map identifiers** Under **Choose your Action**, select the desired [action](/articles/integrate-customer/destinations#actionsanchor). Under **Map the Fields**, the [Output Identifiers](https://docs.zeotap.com/articles/segment-customer/choose-the-output-identifiers) accepted by the platform (MAIDs, cookies, email IDs, and more) are displayed by default. Edit, add, or remove identifiers as needed — see the [mapping reference](/articles/integrate-customer/destinations#mappingsanchor) for the field-mapping options. ![Choose your Action and Map the Fields screen for the Facebook destination](https://mintcdn.com/zeotap/iO8h5JmzK8FO_MOm/articles/integrate-customer/Storage/integrate-customer/facebook/facebook-2023-11-08-1.png?fit=max\&auto=format\&n=iO8h5JmzK8FO_MOm\&q=85\&s=b9c51b878bef2f04b77e98fefa1090f0) Click **Create Destination**. The saved destination is listed in the **Target** and **Audiences** applications and can be linked to an audience or segment. ## Link an audience to the destination Attach the saved destination to an audience or segment in the **Target** and **Audiences** applications. Follow the steps in [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > The terms **Audiences** and **Segments** are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience can be a group of customers over 18 years of age who performed an `addToCart` event within the last 30 days. ## Verify the audience reached Facebook An audience takes up to one business day to become available at the Facebook seat after activation. Confirm the sync by logging into the Facebook console, opening **All tools**, and selecting **Audiences** — the segments pushed from Zeotap CDP are listed there under the Ad Account you configured. The audience appears in the list with the name assigned in Zeotap CDP. ![Facebook All tools menu with Audiences selected](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/Facebook_Viewing_Segments.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=537ec55002eb95ca6ed1eda44786dcc4) ![Audiences pushed from Zeotap CDP listed in the Facebook Audiences screen](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/Facebook_Audience_Screen.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=b547b2317f43d3300b760b5d49e657e1) ## Troubleshooting Common customer-observable issues when configuring or activating the Facebook destination: | Error / symptom | What it means | Where to look | | - | - | - | | Destination creation blocked at the **Ad Account ID** field | The value entered is not the required 16 digit numeric Ad Account ID | The **Account** drop-down in Facebook Ads Manager | | Custom Audiences Terms of Service prompt appears on the Facebook Ad Account | The Custom Audiences ToS have not been accepted for this Ad Account | The [Custom Audiences Terms of Service page](https://business.facebook.com/ads/manage/customaudiences/tos/?act=) — click **Accept** in the left corner | | Segment activated in Zeotap CDP but not visible in the Facebook Audiences list | Less than one business day has passed since activation, or the Ad Account selected in Facebook does not match the one configured in the destination | The Ad Account selector in Facebook Ads Manager — confirm it matches the 16 digit ID configured in the Zeotap destination | | The Facebook Ad Account is not selectable in Meta Business Manager | The Ad Account is not linked to the Business Manager used for the integration | Meta Business Manager → the Ad Account linkage for that business portfolio | If the audience does not appear after one business day and the Ad Account ID matches, contact your Zeotap customer success representative with the destination name, the last 4 digits of the Ad Account ID, the audience name, and the activation timestamp. ## FAQ > [accordion] Which identifiers can I send through this destination? > > This destination accepts MAID identifiers (GAIDs and IDFAs) for both Targeting and Audiences. To send hashed emails, phone numbers, names, or Facebook External IDs, use the [Facebook 1P (Meta)](/articles/integrate-customer/facebook-1p) destination instead. > [accordion] How long does it take for an audience to appear in the Facebook Ad Account? > > Up to one business day from activation in Zeotap CDP to availability at the Facebook seat. > [accordion] Do I need to accept the Custom Audiences Terms of Service for each Ad Account? > > Yes. Acceptance is scoped to each Facebook Ad Account. Open the [Custom Audiences ToS page](https://business.facebook.com/ads/manage/customaudiences/tos/?act=) while signed into the Ad Account and click **Accept** in the left corner. > [accordion] Can I remove members from the Facebook Custom Audience after activation? > > Yes. The Send identifiers to Facebook action supports Delete, which removes members from the Custom Audience when they drop out of the source segment in Zeotap CDP. ## Next steps * [Explore Facebook 1P (Meta) for richer identifier support →](/articles/integrate-customer/facebook-1p) * [Explore Facebook Conversions API for server-to-server event tracking →](/articles/integrate-customer/facebook-conversions-api) * [Explore Facebook Enhanced Conversions API for offline conversion data →](/articles/integrate-customer/facebook-enhanced-conversions-api-capi) * [Explore how to link an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore ID Extension for expanding audience match →](/articles/segment-customer/extend-your-audience#id-extension) # Facebook 1P (Meta) Source: https://docs.zeotap.com/articles/integrate-customer/facebook-1p Configure the Facebook 1P (Meta) destination to send Zeotap CDP audiences to Facebook Custom Audiences for targeting across Facebook, Instagram, Audience Network, and Messenger. ## What this is Facebook 1P (Meta) is a Zeotap CDP destination that pushes audience segments into Meta as Custom Audiences. Once linked, your audience is available for targeting across Facebook, Instagram, Audience Network, and Messenger — you choose which apps at the placement stage of campaign setup. The integration supports two action types: send a single identifier per profile, or send multiple user identifiers per profile to raise the match rate. The terms **Facebook** and **Meta** refer to the same platform throughout this page. ## Supported actions, identifiers, and features | Action | Supported identifiers/attributes | Supported features | | - | - | - | | Send Identifiers to Facebook 1P | MAIDs; Email address (SHA256); Phone number (SHA256); [Facebook External ID](#facebook-external-id) | Audience Boost and Delete | | Send Multiple User Identifiers to Facebook 1P | MAIDs; Email address (SHA256); Phone number (SHA256); Gender; Date of birth; First Name and Last Name; State; City; ZIP Code; Country Code; [Facebook External ID](#facebook-external-id) | Audience Boost and Delete | > [!TIP] > > To raise the match rate, use **Send Multiple User Identifiers to Facebook 1P** so every identifier on a profile is sent as a single user record. ### Facebook External ID A Facebook External ID is a unique string that represents a user on an advertiser's system — for example, a loyalty membership ID, internal user ID, or external cookie ID. For a given event, Facebook uses the `external_id` to match a record to a user on its platform. Before sending an External ID to Facebook, [add the identifier in your Zeotap Catalogue](/articles/unify-customer/add-a-catalogue-field), then map it when you create the destination. For background, see Meta's [Custom Audiences External Identifiers guide](https://developers.facebook.com/docs/marketing-api/audiences/guides/custom-audiences/#external_identifiers). See [How External IDs flow between a brand and Facebook](#how-external-ids-flow-between-a-brand-and-facebook) for the end-to-end capture flow. ## Prerequisites Complete the following before you create the destination in Zeotap CDP: * **Full Access to a Facebook Ad Account** — the 16-digit Facebook Ad Account ID linked to your Facebook Business Manager, with **People with full control** access for the user who will set up the integration. * **Accepted Facebook Audiences Terms of Service** — the ad account has accepted the Custom Audiences ToS at [business.facebook.com/ads/manage/customaudiences/tos/](https://business.facebook.com/ads/manage/customaudiences/tos/?act=). This has been mandatory since September 2021. * **An app in the Facebook Developers portal** — created at [developers.facebook.com](https://developers.facebook.com/) and signed off through [App Review](https://developers.facebook.com/docs/app-review) and [Business Verification](https://developers.facebook.com/docs/development/release/business-verification). If a Zeotap partner has already created the app on your behalf under the name **Zeotap CDP** via OAuth2, skip this step. * **An Access Token** — either a System User Access Token or a Page Access Token (see [Generate an access token](#generate-an-access-token)). * **Your Facebook Graph API version** — for example, `17.0`. Enter only the numerical part when configuring the destination; do not include the `v` prefix. ### Grant Full Access to the Ad Account Confirm your Facebook user has full control of the Ad Account that will receive audience data. From Facebook Business Manager at [business.facebook.com](https://business.facebook.com/), select the business portfolio in the top-right corner, open **Settings → Accounts → Ad Accounts**, select the ad account, and open **Ad Account Access**. Under **People with full control**, your account must appear. To grant Full Access to another user, click **Manage** next to their name, then **Assign People**, and select them from the people with access to your Meta Business portfolio. ![](https://mintcdn.com/zeotap/iO8h5JmzK8FO_MOm/articles/integrate-customer/Storage/integrate-customer/facebook-1p/facebook-1p-2024-09-17-7.png?fit=max\&auto=format\&n=iO8h5JmzK8FO_MOm\&q=85\&s=d6f1d5cd18f49d00a32a0c861b8793ad) ### Accept the Facebook Audiences Terms of Service Sign in to your Facebook Ad Account at [adsmanager.facebook.com](https://adsmanager.facebook.com/), confirm the correct ad account is selected in the top-right dropdown, and open **Audiences** from the left navigation. If the ToS has not been accepted, you are prompted to accept it. If it has already been accepted, you see options to create new audiences. ![](https://mintcdn.com/zeotap/xYI7J3lLAExguMI0/articles/integrate-customer/Storage/integrate-customer/facebook-1p/facebook-1p-2024-09-11-4.png?fit=max\&auto=format\&n=xYI7J3lLAExguMI0\&q=85\&s=70b453e4ba6fb127ae515dbabfe47ff6) ### Obtain the App ID Sign in at [developers.facebook.com](https://developers.facebook.com/), open **My Apps** in the top navigation, and read the App ID listed under the app name on your dashboard. ![](https://mintcdn.com/zeotap/iO8h5JmzK8FO_MOm/articles/integrate-customer/Storage/integrate-customer/facebook-1p/facebook-1p-2024-09-17-6.png?fit=max\&auto=format\&n=iO8h5JmzK8FO_MOm\&q=85\&s=445c013315f528f70f3c12661823c3a9) ### Generate an access token The Access Token authenticates Zeotap CDP on the Facebook platform. Two types are supported: * **System User Access Token** — for programmatic, automated actions on business clients' Ad objects or Pages without re-authentication. See Meta's [System User Tokens](https://developers.facebook.com/docs/facebook-login/guides/access-tokens/#usertokens). * **Page Access Token** — for reading, writing, and modifying data on a Facebook Page. Retrieved from a long-lived user access token; this token does not expire. See Meta's [Page Tokens](https://developers.facebook.com/docs/facebook-login/guides/access-tokens/#pagetokens). > [!WARNING] > > An incorrect or expired access token causes segment activation to fail. Use the never-expiring page token where available, and validate it in Meta's [Access Token Debugger](https://developers.facebook.com/tools/accesstoken) before pasting it into Zeotap CDP. For debugging an invalid token, see Meta's [Access Token Debugging guide](https://developers.facebook.com/docs/facebook-login/guides/access-tokens/debugging). #### Generate a System User Access Token In Facebook Business Manager, open **Settings → Users → System users** and click **+ Add**. ![](https://mintcdn.com/zeotap/xYI7J3lLAExguMI0/articles/integrate-customer/Storage/integrate-customer/facebook-1p/facebook-1p-2024-07-19.png?fit=max\&auto=format\&n=xYI7J3lLAExguMI0\&q=85\&s=9febe39c00460ae45e81118cdf6f1fbe) Enter a name, select the role (**Admin** or **Employee**), and click **Create system user**. One Admin and one Employee user is supported per business; attempting to create more displays: ![](https://mintcdn.com/zeotap/iO8h5JmzK8FO_MOm/articles/integrate-customer/Storage/integrate-customer/facebook-1p/facebook-1p-2025-01-20-2.png?fit=max\&auto=format\&n=iO8h5JmzK8FO_MOm\&q=85\&s=68f4833c234f14a718c1fe1de03ceebf) `This business has reached the maximum number of system users. The maximum number of system users allowed is 1.` Under **Select app**, choose your app from the drop-down and click **Next**. ![](https://mintcdn.com/zeotap/xYI7J3lLAExguMI0/articles/integrate-customer/Storage/integrate-customer/facebook-1p/facebook-1p-2024-07-19-1.png?fit=max\&auto=format\&n=xYI7J3lLAExguMI0\&q=85\&s=cd8fa0dab5de3adacb87f41317e7eed2) In **Set expiration**, choose **60 days** or **Never**. Facebook recommends **60 days**. ![](https://mintcdn.com/zeotap/xYI7J3lLAExguMI0/articles/integrate-customer/Storage/integrate-customer/facebook-1p/facebook-1p-2024-07-19-2.png?fit=max\&auto=format\&n=xYI7J3lLAExguMI0\&q=85\&s=595c7e057037df764d98766a636a7140) In **Assign Permissions**, select: * `ads_read` * `ads_management` * `pages_manage_ads` * `pages_show_list` For what each permission grants, see Meta's [Permissions Reference](https://developers.facebook.com/docs/permissions/reference). ![](https://mintcdn.com/zeotap/xYI7J3lLAExguMI0/articles/integrate-customer/Storage/integrate-customer/facebook-1p/facebook-1p-2024-07-19-3.png?fit=max\&auto=format\&n=xYI7J3lLAExguMI0\&q=85\&s=cd6ae9c93339519c037960ccba2ff333) Review the permissions and click **Generate token**. Copy the token and store it for the destination setup. ![](https://mintcdn.com/zeotap/xYI7J3lLAExguMI0/articles/integrate-customer/Storage/integrate-customer/facebook-1p/facebook-1p-2024-07-19-4.png?fit=max\&auto=format\&n=xYI7J3lLAExguMI0\&q=85\&s=9cdace8ea8a34e87d98511b21f070622) Validate the token at the [Access Token Tool](https://developers.facebook.com/tools/accesstoken) — open the **access token debugger**, paste the token, and click **Debug**. ![](https://mintcdn.com/zeotap/iO8h5JmzK8FO_MOm/articles/integrate-customer/Storage/integrate-customer/facebook-1p/facebook-1p-2025-01-20.png?fit=max\&auto=format\&n=iO8h5JmzK8FO_MOm\&q=85\&s=f9b8fd5982afd61f6885701558c205df) > [!NOTE] > > Whenever you change the access granted to the system user, generate a new access token and update the destination in Zeotap CDP. #### Generate a Page Access Token A Page admin must grant your app the required Page permission. With that granted, retrieve the never-expiring Page Access Token from a long-lived user access token. Open the [Facebook Graph API Explorer](https://developers.facebook.com/tools/explorer/), select your app from the **Application** drop-down, then select **Get user access token** from the next drop-down. ![](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/fbk1p_getuser_accesstoken.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=613160ff6a58a288b6a385dea78e06f0) In **Add a Permission**, select **Event Groups Pages** and select: * `ads_read` * `ads_management` * `pages_manage_ads` Click **Generate Access Token**. A popup prompts you to select the relevant Page. ![](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/fbk1p_shortlived_ip.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=3617450a3c3b704b025cc40fa1ec98be) Click **Next** to confirm the requested permissions. ![](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/fbk1p_requested.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=cbb0c4e7994d6f7af37ccbef2d5a08e7) Click **Debug** on the token. The short-lived user access token expires after one hour. To extend it, click **Extend Access Token** — this returns the long-lived access token. If **Extend Access Token** is not shown and the token expires within two months, you already hold the long-lived token; skip this step. ![](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/fbk1p_extnd_accsstoken.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=61d26facc8a842be743104df73c1ace0) Paste the long-lived user access token into the **Access Token** field, change the API endpoint to `/me/accounts`, and click **Submit**. The response lists each Page and its page access token (the never-expiring token). Copy the access token of the relevant Page and note the API version used in the request — both are required when you configure the destination in Zeotap CDP. ![](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/fbk1p_meaccount.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=7d5248f5c271f5b5510538f0b5faa783) Alternatively, run the equivalent request from Postman: ```bash theme={null} curl --location --request GET 'https://graph.facebook.com/v12.0/{your-user-id}/accounts?access_token={long-lived-access-token}' ``` Replace `{your-user-id}` with the App-Scoped User ID and `{long-lived-access-token}` with the long-lived token you generated. ![](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/fbk1p_accesstoken_postman.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=565d6833276b8cab130fa33fa509202b) Verify the page access token does not expire — paste it into the Access Token Debugger and click **Debug**. ![](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/fbk1p_accesstoken_debug.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=c7c38869b561b3702a3fcb842b5e5a9c) ### Obtain your Facebook Graph API version Read the Graph API version from the left-hand side of the Access Token Tool while generating the token. When configuring the destination in Zeotap CDP, enter only the numerical part — for `v17.0`, enter `17.0`. ## Create the Facebook 1P destination in Zeotap CDP In Zeotap CDP, open the **Destinations** application and start a new destination by clicking **+ Create Destination**. ![](https://mintcdn.com/zeotap/xYI7J3lLAExguMI0/articles/integrate-customer/Storage/integrate-customer/facebook-1p/ADOBE_DMP_3.png?fit=max\&auto=format\&n=xYI7J3lLAExguMI0\&q=85\&s=faac0fd8ef98248ea3988b0b76d0f0c6) Search **All Destinations** for **Facebook 1P** and select it. ![](https://mintcdn.com/zeotap/xYI7J3lLAExguMI0/articles/integrate-customer/Storage/integrate-customer/facebook-1p/ADOBE_DMP_4.png?fit=max\&auto=format\&n=xYI7J3lLAExguMI0\&q=85\&s=3ba5802e717bdad20433027c6d9f4eb7) On the destination configuration screen, enter: * A name for the destination * The **Ad Account ID** (the 16-digit ID associated with Facebook Business Manager) * The **Access Token** you obtained above * The **API Version** (numerical part only — for `v17.0`, enter `17.0`) Review the values and click **Next**. ![](https://mintcdn.com/zeotap/iO8h5JmzK8FO_MOm/articles/integrate-customer/Storage/integrate-customer/facebook-1p/facebook-1p-2025-01-22-2.png?fit=max\&auto=format\&n=iO8h5JmzK8FO_MOm\&q=85\&s=df90b3e724b1cb1d88d0411ec5202e95) ### Choose the action and map identifiers Under **Choose your Action**, pick one: * **Send Identifiers to Facebook 1P** — populates MAIDs, email addresses, cellphone numbers, and Facebook External ID. Each identifier is sent as an individual user profile. ![](https://mintcdn.com/zeotap/xYI7J3lLAExguMI0/articles/integrate-customer/Storage/integrate-customer/facebook-1p/facebook-1p-2024-02-06.png?fit=max\&auto=format\&n=xYI7J3lLAExguMI0\&q=85\&s=44e008565c13cc7a87555fcf9b467b8e) * **Send Multiple User Identifiers to Facebook 1P** — populates Facebook External ID, email addresses, MAIDs, cellphone numbers, gender, date of birth, first/last name, city, state, ZIP, and country. All identifiers selected in the mapping screen are sent as a single user profile, which raises the match rate. ![](https://mintcdn.com/zeotap/xYI7J3lLAExguMI0/articles/integrate-customer/Storage/integrate-customer/facebook-1p/facebook-1p-2024-02-06-1.png?fit=max\&auto=format\&n=xYI7J3lLAExguMI0\&q=85\&s=abde93581376607116e94a8033c0033f) ### How Zeotap formats each attribute for Facebook Facebook requires specific formatting and hashing for each attribute. Zeotap CDP performs the transformations listed below, so you only need to ingest the source attribute into your Zeotap Catalogue. | Attribute | Facebook requirement | Zeotap CDP transformation | | - | - | - | | External ID | Hashing **not** required | Sent as-is | | Email address | Hashing required; trim leading/trailing whitespace; lowercase all characters | Map from `Email SHA256 Lowercase` in the Zeotap Catalogue. Consult your Zeotap representative on ingesting this identifier. | | Phone number | Hashing required; remove symbols, letters, and leading zeroes | Map from `Cellphone Number Withcode Sha256` in the Zeotap Catalogue. Consult your Zeotap representative on ingesting this identifier. | | Gender | Hashing required; `m` for male, `f` for female | Zeotap extracts the first letter of the Gender value, lowercases it, hashes it, and sends it | | Date of birth | Hashing required; send `YYYY`, `MM`, `DD` separately | Ingest Date of Birth as a timestamp field; Zeotap performs the split and hash | | First Name, Last Name | Hashing required; a–z only, lowercase, no punctuation; special characters in UTF-8 | Zeotap performs the transformation | | State | Hashing required; 2-character ANSI code, lowercase; non-US states normalised lowercase with no punctuation, special characters, or whitespace | Zeotap hashes the ingested State value and sends it | | City | Hashing required; a–z only, lowercase, no punctuation, special characters, or whitespace | Zeotap hashes the ingested City value and sends it | | ZIP Code | Hashing required; lowercase, no whitespace; US — first 5 digits; UK — Area/District/Sector | Zeotap removes whitespace, hashes the result, and sends it. Example: UK ZIP `SW1A 2AA` is sent as the SHA256 of `SW1A2AA`. | | Country Code | Hashing required; lowercase 2-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) | Map from `Country` in the Zeotap Catalogue. If you map another attribute, ingest a 3-letter country code; Zeotap converts it to the 2-letter code. | | Mobile Advertising ID (MAID) | Hashing **not** required; lowercase, keep hyphens | Sent as-is | After reviewing the mapping, click **Create Destination**. The destination appears in the Audiences application, ready to be linked. ![](https://mintcdn.com/zeotap/5K-Zf-MYwWXwJWp5/articles/integrate-customer/Storage/integrate-customer/creating-salesforce-crm/1ed3e73c-019e-44df-aaee-7d8704cccb52.png?fit=max\&auto=format\&n=5K-Zf-MYwWXwJWp5\&q=85\&s=987ffbc3670aeb234416e1ca1ba67272) ## Link an audience to the destination In the Audiences application, link the audience or segment to the Facebook 1P destination. The terms *audience* and *segment* are used interchangeably for a customer cohort — for example, customers over 18 who performed an `addToCart` event in the last 30 days. For the linking procedure, see [Link an Audience to the Destination](/articles/integrate-customer/link-an-audience-to-the-destination#h3_64671714). > [!NOTE] > > * Create segments directly in the client's Facebook account so they do not appear under Zeotap's Ad accounts (unlike a third-party setup). > * The Facebook Custom Audience limit of 500 applies per Ad Account that the client uses — it does not apply to Zeotap's account. > * Facebook compares the data Zeotap uploads against the segment using their encrypted user data; matched IDs are added to the Custom Audience and ads are delivered to those users. > * The audience SLA on Meta's side is documented in [Meta's Custom Audiences guide](https://developers.facebook.com/docs/marketing-api/audiences/guides/custom-audiences#external_identifiers). ## Verify the audience reached Facebook Allow up to 24 hours (one business day) after linking for a Zeotap CDP audience to sync to Facebook. To confirm: 1. Sign in to [Facebook Ads Manager](https://adsmanager.facebook.com/) and select the business portfolio that owns the ad account configured in the destination. 2. Open **Audiences** from the left navigation. 3. Confirm the Custom Audience appears in the Audience list with a non-zero size. The audience name matches the one configured in Zeotap CDP. If the audience appears but the size is `0` or `Below minimum`, the sync completed but matching produced fewer records than Facebook's minimum threshold — review the identifiers being sent (see [How Zeotap formats each attribute for Facebook](#how-zeotap-formats-each-attribute-for-facebook)) and confirm the source identifiers are populated for the audience members. This integration supports user disqualification. When a user no longer meets the audience criteria, the consent requirements, or other audience conditions, Zeotap CDP issues a user deletion request to Facebook on the next refresh cycle. Disqualified users are excluded from the audience on the configured refresh frequency. No manual action is required — the process runs automatically. ## Troubleshooting ### Common errors | Error string | What it means | Where to look | | - | - | - | | `{"message":"Facebook Error: Permission error","code":"400 BAD_REQUEST"}` | Ad Account or app permissions are not yet active on Facebook's side. Seen with new accounts before the Audiences ToS has been accepted or before Facebook permissions have propagated. | Confirm the [Audiences ToS](#accept-the-facebook-audiences-terms-of-service) is accepted; if accepted, allow time for Facebook permissions to take effect, then retry. | | `This business has reached the maximum number of system users. The maximum number of system users allowed is 1.` | The business has already created the allowed system users (one Admin and one Employee). | Reuse an existing system user and generate a fresh access token rather than creating a new user. | | Segment activation fails with an authentication error | The configured access token is invalid or expired. | Validate the token in Meta's [Access Token Debugger](https://developers.facebook.com/tools/accesstoken). Generate a new token and update the destination credentials. | ### If the 400 BAD_REQUEST error persists If the 400 error continues after the Audiences ToS has been accepted, allow time for the Facebook permissions to propagate before retrying. If the error still appears after several days, regenerate the access token, confirm it has the four required permissions (`ads_read`, `ads_management`, `pages_manage_ads`, `pages_show_list`), and update the destination credentials in Zeotap CDP. ## How External IDs flow between a brand and Facebook When you target Facebook users by a brand-side identifier (loyalty ID, internal user ID, cookie), the flow is: 1. The brand places the Facebook pixel on its website and configures the tag to pass the Facebook cookie (or any custom identifier) as `extern_id` to Facebook. See Meta's [Pixel implementation guide](https://developers.facebook.com/docs/meta-pixel/get-started). The pixel push pattern: ```js theme={null} fbq('init', '', { 'extern_id': '' }); ``` 2. Facebook builds an internal mapping between the `extern_id` and its own user ID. 3. The brand also passes the Facebook cookie to Zeotap as `id_mid_62`, using Google Tag Manager, JavaScript, or another tag implementation. 4. The brand builds an audience in the Audiences application using the Facebook cookies. 5. Zeotap uploads the Facebook cookie as an External ID to Facebook. Facebook uses its internal mapping to resolve the External ID to the corresponding user on its platform. > [!NOTE] > > Accepting the [Custom Audiences Terms of Service](https://business.facebook.com/ads/manage/customaudiences/tos/?act=) (mandatory since September 2021) is required for this flow. ## FAQ > [accordion] Which action should I pick — Send Identifiers or Send Multiple User Identifiers? > > Pick **Send Multiple User Identifiers to Facebook 1P** when you have more than one identifier per profile. All identifiers map to a single user record on Facebook's side, which raises the match rate. Pick **Send Identifiers to Facebook 1P** only when each identifier needs to be sent as its own user profile. > [accordion] Do I need to hash identifiers before ingesting them into Zeotap? > > For email, phone, name, gender, date of birth, address fields, and country code, Zeotap CDP performs the hashing and formatting Facebook requires — you ingest the source value into the matching Catalogue field. For Mobile Advertising IDs and External IDs, no hashing is required and Zeotap sends them as-is. See the [attribute table](#how-zeotap-formats-each-attribute-for-facebook) for the per-attribute Catalogue mapping. > [accordion] How long until my audience appears in Facebook Ads Manager? > > Allow up to 24 hours (one business day) after linking for a Zeotap CDP audience to fully sync with Facebook. If it has not appeared after that window, validate the access token in Meta's [Access Token Debugger](https://developers.facebook.com/tools/accesstoken) and confirm the audience link is active in Zeotap CDP. > [accordion] What happens if I update the system user's permissions? > > Generate a new access token whenever you change the access granted to the system user, then update the Access Token on the destination in Zeotap CDP. The previously issued token does not pick up the new permissions. ## Next steps * [Explore the Meta Custom Audience destination →](/articles/integrate-customer/meta-custom-audience) for the OAuth-authenticated variant of this destination, which replaces the access token with a Connect flow * [Explore Facebook Conversions API →](/articles/integrate-customer/facebook-conversions-api) * [Explore Facebook Enhanced Conversions API for offline data →](/articles/integrate-customer/facebook-enhanced-conversions-api-capi) * [Explore linking an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore Audience Insights to measure match rate and reach →](/articles/segment-customer/audience-insights) # Facebook Conversions API Source: https://docs.zeotap.com/articles/integrate-customer/facebook-conversions-api Send server-side conversion events from Zeotap CDP to Facebook (Meta) for ad optimization, attribution, and campaign measurement. ## What is the Facebook Conversions API Facebook Conversions API is a server-to-server integration that forwards conversion events — purchases, form submissions, page views, and other actions — from your systems to Facebook (Meta) through a single endpoint. Meta uses these events to optimize ad delivery, measure campaign effectiveness, and build audiences without relying solely on browser-side signals from the Facebook Pixel. Zeotap CDP implements the server-to-server side of this API; the Facebook Pixel is a separate browser-side integration that you install and maintain on your own web properties. When both run together, deduplication ensures the same conversion isn't counted twice. ![Diagram showing how the Conversions API works alongside the Facebook Pixel](https://mintcdn.com/zeotap/iO8h5JmzK8FO_MOm/articles/integrate-customer/Storage/integrate-customer/facebook-conversions-api/fbcapi_1.png?fit=max\&auto=format\&n=iO8h5JmzK8FO_MOm\&q=85\&s=e97e99c4b3c48e017fddfb836ea5545c) This page walks you through creating a Facebook Conversions API destination in Zeotap CDP, mapping event and user data, activating the destination in Journeys, and verifying that events reach Meta. > [!NOTE] > > Meta recommends running both the Facebook Pixel and the Conversions API so browser-side and server-side signals reinforce each other. Zeotap CDP provides the server-to-server Conversions API side of the integration. Installing and maintaining the Facebook Pixel on your web properties is your responsibility. ## Prerequisites Gather the following before you create the destination: * A [Facebook Business Manager](https://business.facebook.com/) account. For account setup, see Meta's [How to create a Business Manager](https://www.facebook.com/business/help/1710077379203657) article. * A **Pixel** (for website events) or a linked **App** (for app events) in Facebook Events Manager, and its **Dataset ID / Pixel ID**. * An **Access Token** generated from the Conversions API section of the Pixel's settings. Generating the token requires developer privileges on the business; the option is hidden from users without those privileges. * The events and parameters you want to send decided in advance (for example `Purchase`, `Lead`, `AddToCart`, and the fields that accompany each). * A deduplication strategy if you also run the Facebook Pixel — see [Choose a deduplication strategy](#choose-a-deduplication-strategy). ## Choose a deduplication strategy Sending the same conversion through both the Facebook Pixel and the Conversions API without deduplication double-counts events. Meta's guidance is to send the identical `Event Name` on both sides and to include either `Event Id`, or a combination of `External ID` and `FBP` (the browser ID), so Meta can collapse duplicates into a single count. For the full rule set, see Meta's [deduplication documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/deduplicate-pixel-and-server-events). Whichever parameters you choose, ingest the corresponding attributes into Zeotap CDP and map them in the destination so they are sent on every event. ## Retrieve your Pixel ID or Dataset ID The Pixel ID (also called Dataset ID) associates each event with the correct Meta ad account. * **Website events** — in Facebook Events Manager, under **Data Sources**, open the Pixel you created and copy its **Dataset ID**. ![Dataset ID shown for a Pixel under Data Sources in Facebook Events Manager](https://mintcdn.com/zeotap/iO8h5JmzK8FO_MOm/articles/integrate-customer/Storage/integrate-customer/facebook-conversions-api/fbcapi_brow_4.png?fit=max\&auto=format\&n=iO8h5JmzK8FO_MOm\&q=85\&s=d84c6ca0099ed62b16b085984d76464f) * **App events** — once your app is created in the Facebook Developer console, it appears in Events Manager under **Data Sources** (identifiable by the app name and a phone icon). Link the app to the Dataset ID from the app's setting in Events Manager. After linking, the dataset shows the connected app. ![App listed under Data Sources in Facebook Events Manager, identified by the app name and a phone icon](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/conversions-api-for-app-events/fbcapi_app_1.png?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=5ad2e7cf8f5eb873c6d3b80813699173) ![Dataset showing the connected app after linking](https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/conversions-api-for-app-events/fbcapi_app_2.jpeg?fit=max\&auto=format\&n=PbPkxJRQX6AvIPbW\&q=85\&s=9027a85baeab1b619c6e12a8c8eec336) ## Generate an Access Token The Access Token authenticates Zeotap CDP's requests to the Conversions API. In Facebook Events Manager, open the relevant Pixel, go to the **Settings** tab, find the Conversions API section, and use **Generate access token** under **Set up manually**. ![Generate access token option under Set up manually in the Conversions API section of the Pixel settings](https://mintcdn.com/zeotap/iO8h5JmzK8FO_MOm/articles/integrate-customer/Storage/integrate-customer/facebook-conversions-api/fbcapi_brow_5.png?fit=max\&auto=format\&n=iO8h5JmzK8FO_MOm\&q=85\&s=1414997b66f8219efb9023dde075376f) > [!WARNING] > > Treat the Access Token as a secret. Anyone with the token can post events on behalf of your Pixel. If the token is exposed, rotate it in Facebook Events Manager and update the destination in Zeotap CDP with the new value. ## Create the destination in Zeotap CDP Open the Zeotap CDP **Destinations** application and add a new destination for **Facebook Conversions API**. Provide: 1. A **name** for the destination. 2. The **Pixel ID** and **Access Token** you collected above. ![Create Destination form with the destination name, Pixel ID, and Access Token fields](https://mintcdn.com/zeotap/iO8h5JmzK8FO_MOm/articles/integrate-customer/Storage/integrate-customer/facebook-conversions-api/facebook-conversions-api-2024-08-07-1.png?fit=max\&auto=format\&n=iO8h5JmzK8FO_MOm\&q=85\&s=390d4c4863b3c6b02fd9bad604b39c0a) Proceed to the **Actions and Mapping** screen. Under **Choose your Action**, pick one of: * **Stream events to Facebook Conversions API** — for real-time event streaming from Journeys. * **Send offline data to FB Enhanced CAPI** — for offline conversion data. See [Facebook Enhanced Conversions API (CAPI)](/articles/integrate-customer/facebook-enhanced-conversions-api-capi) for that flow. Under **Map the Fields**, standard fields such as Email, Phone, First Name, and Last Name auto-populate. Map each Zeotap Catalogue field to the corresponding Conversions API field. To send attributes not in the auto-populated set, add custom data mappings — custom properties work with both standard and custom events. ![Actions and Mapping screen with auto-populated Conversions API field mappings](https://mintcdn.com/zeotap/iO8h5JmzK8FO_MOm/articles/integrate-customer/Storage/integrate-customer/facebook-conversions-api/facebook-conversions-api-2024-08-07-2.png?fit=max\&auto=format\&n=iO8h5JmzK8FO_MOm\&q=85\&s=02199306980ffa83a9ff6a05ca4f64a9) Only **Event Time** is mandatory to establish a working connection. `Event Source URL` (under **Event Attributes**) and `Client User Agent` (under **User data**) are optional — map them when you are sending website events, where Meta uses them for attribution. Save the mapping and click **Create Destination**. The destination is now available for activation in Journeys. ## Activate the destination in Journeys In a Journeys workflow, after you have applied filters and conditions, use the **Send to Destinations** node to attach the destination: 1. Add a **Send to Destinations** node to the workflow. ![Adding a Send to Destinations node to a Journeys workflow](https://mintcdn.com/zeotap/iO8h5JmzK8FO_MOm/articles/integrate-customer/Storage/integrate-customer/facebook-conversions-api/facebook-conversions-api-2024-08-07-3.png?fit=max\&auto=format\&n=iO8h5JmzK8FO_MOm\&q=85\&s=e31065799ea67fbbe3b2f056fdd256aa) 2. Select the destination you created from the list of available destinations. ![Selecting the Facebook Conversions API destination from the list of available destinations](https://mintcdn.com/zeotap/iO8h5JmzK8FO_MOm/articles/integrate-customer/Storage/integrate-customer/facebook-conversions-api/facebook-conversions-api-2024-08-07-4.png?fit=max\&auto=format\&n=iO8h5JmzK8FO_MOm\&q=85\&s=230a11b3e80ea231a32ba8fd33f17d1c) 3. On the **Destination Details** tab, the **Pixel ID** and **Access Token** carry over from the destination configuration. 4. Under **Action Source**, choose **website** or **app** depending on where the tracked events originate. 5. Under **Event Name**, choose the event to send. ![Destination Details tab with the Action Source and Event Name settings](https://mintcdn.com/zeotap/iO8h5JmzK8FO_MOm/articles/integrate-customer/Storage/integrate-customer/facebook-conversions-api/facebook-conversions-api-2024-08-07-5.png?fit=max\&auto=format\&n=iO8h5JmzK8FO_MOm\&q=85\&s=dc6e1e02ceae1e8ee4e564f738dd65b6) 6. On the **Destination Settings** tab, confirm the action and mapping. ![Destination Settings tab showing the selected action and field mapping](https://mintcdn.com/zeotap/iO8h5JmzK8FO_MOm/articles/integrate-customer/Storage/integrate-customer/facebook-conversions-api/facebook-conversions-api-2024-08-07-6.png?fit=max\&auto=format\&n=iO8h5JmzK8FO_MOm\&q=85\&s=021fe58ced5929b1863a27624d6f874d) 7. Save the destination on the node and publish the workflow. ![Destination attached to the Send to Destinations node in the workflow](https://mintcdn.com/zeotap/iO8h5JmzK8FO_MOm/articles/integrate-customer/Storage/integrate-customer/facebook-conversions-api/facebook-conversions-api-2024-08-07-7.png?fit=max\&auto=format\&n=iO8h5JmzK8FO_MOm\&q=85\&s=a6963f298a4580e3cdfa7a6ceea02890) ### Action Source: website vs. app * **App events** track actions in your mobile app or web app such as installs, sessions, and in-app purchases. Meta's SDK automatically logs some events (installs, sessions, in-app purchases); you also send Standard Events (predefined) and Custom Events (defined by you). See Meta's [ad performance measurement](https://developers.facebook.com/docs/marketing-api/insights) and [audiences API](https://developers.facebook.com/docs/marketing-api/audiences-api) documentation. * **Website events** track conversions that happen in a browser (purchases, sign-ups, and so on) after a user interacts with an ad or lands on a Meta-hosted page. ## Event and parameter reference ### Standard event names Use these predefined event names for actions Meta already understands. Include the listed object properties where they apply. | Event name | Description | Object properties | | - | - | - | | `AddPaymentInfo` | Payment information added in the checkout flow. | Content Category, Content Ids, Currency, Value (optional) | | `AddToCart` | Product added to the shopping cart. | Content Ids, Content Name, Currency, Value (optional) | | `AddToWishlist` | Product added to a wish list. | Content Name, Content Category, Content Ids, Currency, Value (optional) | | `CompleteRegistration` | Registration form completed. | Content Name, Currency, Status, Value (optional) | | `Contact` | A person initiated contact with your business (phone, SMS, email, chat). | — | | `CustomizeProduct` | A person customized a product. | — | | `Donate` | A person donated funds to your organization or cause. | — | | `FindLocation` | A person searched for the location of your store, intending to visit in person. | — | | `InitiateCheckout` | A person started the checkout flow. | Content Category, Content Ids, Currency, Num Items, Value (optional) | | `Lead` | A sign-up was completed. | Content Category, Content Name, Currency, Value (optional) | | `Purchase` | A purchase was made or the checkout flow completed. | Currency, Value (mandatory); Content Ids, Content Name, Num Items (optional) | | `Schedule` | A person booked an appointment to visit one of your locations. | — | | `Search` | A search was made. | Content Category, Content Ids, Currency, Search String, Value (optional) | | `StartTrial` | A person started a free trial of a product or service. | Currency, Predicted ltv, Value (optional) | | `SubmitApplication` | A person applied for a product, service, or program you offer. | — | | `Subscribe` | A person started a paid subscription for a product or service. | Currency, Predicted ltv, Value (optional) | | `ViewContent` | A person visited a page you care about (for example a product page or landing page). Indicates the visit but not what the person saw or did on the page. | Content Ids, Content Category, Content Name, Currency, Value (optional) | ### Customer information parameters Richer customer identifiers improve Event Match Quality — matched events feed both ads delivery optimization and attribution, while unmatched events feed only basic measurement. High-signal identifiers are email address, phone number, name, and IP address. | Parameter | Format / example | | - | - | | Email | `john@example.com` | | Phone Number | `15557893473` | | First Name | `john` | | Last Name | `paul` | | Date of Birth | `YYYYMMDD` — for example `19911112` for November 12, 1991. Ingest DOB in this format into Zeotap CDP. | | Gender | Initial — `f` for female, `m` for male | | City | Lowercase, no spaces or punctuation — for example `paris` | | State | US state abbreviation — for example `az` | | Zip Code | No spaces or dashes. US: first 5 digits only, `94035`. Australia: `1987`. France: `75018`. UK: area, district, sector — `m11ae`. | | Country | Two-letter country code — for example `us` | | External ID | Any unique advertiser ID (loyalty membership ID, user ID, external cookie ID). If also sent through the Pixel, use the same format. If hashed in the Pixel, ingest the hashed value into Zeotap CDP. | | Client IP Address | Valid IPv4 or IPv6, never hashed, no spaces. IPv6 is preferred for IPv6-enabled users. Provide the real IP for accurate event reporting. Example IPv4: `168.212.226.204`. Example IPv6: `2001:0db8:85a3:0000:0000:8a2e:0370:7334`. | | Client User Agent | The browser's user agent string. Required for website events. Example: `Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.141 Safari/537.36`. | | Click ID (`fbc`) | Value stored in the `_fbc` browser cookie under your domain. Format: `fb.${subdomain_index}.${creation_time}.${fbclid}`. Example: `fb.1.1554763741205.AbCdEfGhIjKlMnOpQrStUvWxYz1234567890`. Ingest into Zeotap CDP. | | Browser ID (`fbp`) | Value stored in the `_fbp` browser cookie under your domain. Format: `fb.${subdomain_index}.${creation_time}.${random_number}`. Example: `fb.1.1596403881668.1116446470`. Ingest into Zeotap CDP. | ### Server event parameters | Parameter | Type | Description | Required | | - | - | - | - | | `Event Time` | integer | Unix timestamp in seconds when the event actually occurred. | Mandatory | | `Event Source URL` | string | The browser URL where the event happened. Must begin with `http://` or `https://` and match the verified domain. Recommended for website events. | Optional | | `Opt Out` | boolean | Flag indicating the event must not be used for ads delivery optimization. | Optional | | `Event Id` | string | Unique string chosen by the advertiser. Together with `Event Name`, used to deduplicate events sent by both the Pixel and the Conversions API. Recommended for deduplication. | Optional | | `Action Source` | string | Zeotap CDP sends `website` as the action source, enabling tracking of conversions made on your website. | — | ### Custom data parameters | Parameter | Description | | - | - | | `Content Category` | Category of the content associated with the event. Example: `grocery`. | | `Content Ids` | Content IDs associated with the event, such as product SKUs in an `AddToCart` event. Example: `['ABC123']`. Zeotap CDP sends a single-object array to Facebook. | | `Content Name` | Name of the page or product associated with the event. Example: `lettuce`. | | `Currency` | Currency for the value. Must be a valid [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) three-digit code. Example: `USD`. Required for purchase events. | | `Num Items` | For `InitiateCheckout` only. Number of items the user tries to buy during checkout. Example: `4`. | | `Order Id` | Order ID for the transaction as a string. Example: `order1234`. | | `Predicted ltv` | Predicted lifetime value of a conversion event. Example: `432.12`. | | `Search String` | For `Search` only. The query the user made. Example: `lettuce`. | | `Status` | For `CompleteRegistration` only. Status of the registration as a string. Example: `registered`. | | `Value` | Numeric value associated with the event (monetary or another metric). Required for purchase events. Example: `142.54`. | ## Example request payload Zeotap CDP builds and sends the Conversions API request for you; the payload below shows what a `Purchase` event looks like once mapped. For the full request contract, see Meta's [Conversions API documentation](https://developers.facebook.com/docs/marketing-api/conversions-api). ```json theme={null} { "data": [ { "event_name": "Purchase", "event_time": 1633552688, "event_id": "event.id.123", "event_source_url": "http://example.com/product/123", "action_source": "website", "user_data": { "client_ip_address": "192.19.9.9", "client_user_agent": "Mozilla/5.0 ...", "em": ["309a0a5c3e211326ae75ca18196d301a9bdbd1a882a4d2569511033da23f0abd"], "ph": ["254aa248acb47dd654ca3ea53f48c2c26d641d23d7e2e93a1ec56258df7674c4"], "fbc": "fb.1.1554763741205.AbCdEfGhIjKlMnOpQrStUvWxYz1234567890", "fbp": "fb.1.1558571054389.1098115397" }, "custom_data": { "value": 100.2, "currency": "USD", "content_ids": ["product.id.123"], "content_type": "product" }, "opt_out": false } ] } ``` ## Verify the setup After publishing the Journeys workflow that feeds the destination, confirm the connection end to end: 1. In Zeotap CDP, confirm the destination is attached on the workflow's **Send to Destinations** node and the workflow is in a **Published** state. 2. In Facebook Events Manager, open the Pixel that matches the Pixel ID you configured and confirm events are arriving under that Pixel with the `Event Name` values you mapped. 3. Confirm the `Action Source` on incoming events is `website` (or `app`, if you selected app). 4. For deduplication with the Facebook Pixel: confirm the `Event Id` on server events matches the `Event Id` the Pixel sends for the same conversion. For Meta's full verification procedure, see the [Verifying your setup](https://developers.facebook.com/docs/marketing-api/conversions-api/verifying-setup) guide. ## Troubleshooting Common configuration issues you can resolve without support: | Condition | What it means | Where to check | | - | - | - | | Missing `Event Source URL` mapping | Not required to save the destination, but website events lose URL-level attribution without it. | The destination's field mapping | | Missing `Client User Agent` mapping | Not required to save the destination, but website events lose browser-level matching without it. | The destination's field mapping | | `Purchase` event missing `Currency` or `Value` | Both fields are mandatory on `Purchase` events; without them the event can't drive value-based optimization. | The destination's custom data mapping | ### The destination can't be saved Confirm that `Event Source URL` (server event) and `Client User Agent` (customer information) are both mapped. A working connection to the Conversions API requires both. ### Events don't appear in Facebook Events Manager * Confirm the **Pixel ID** on the destination matches the Pixel you are checking in Events Manager. * Confirm the **Access Token** is still valid. Tokens can be rotated or revoked from the Conversions API section of the Pixel's settings; if the token was rotated, generate a new one and update the destination. * Confirm the workflow feeding the destination is in **Published** status and that user cohorts satisfy the entry conditions. ### Conversions are double-counted Both the Facebook Pixel and the Conversions API are sending the same event and deduplication is not wired up. Confirm both sides use the identical `Event Name`, and that either `Event Id`, or a combination of `External ID` and `FBP`, is present on both events. See Meta's [deduplication documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/deduplicate-pixel-and-server-events). ### Purchase events aren't optimizing bids `Purchase` events require `Currency` and `Value` in custom data. Confirm both are mapped and that `Currency` is a valid [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) three-digit code such as `USD`. ## FAQ > [accordion] Do I still need the Facebook Pixel if I'm using the Conversions API through Zeotap? > > Meta recommends running both together so browser-side and server-side signals reinforce each other. Zeotap CDP provides the Conversions API side; installing and maintaining the Facebook Pixel on your web properties is your responsibility. When both are running, use a deduplication strategy so the same conversion isn't counted twice. > [accordion] Why can't I see the Generate access token option in Events Manager? > > The Generate access token option is visible only to users with developer privileges on the business. If you don't see it, request developer privileges from a business admin, then reload the Pixel's Settings tab. > [accordion] What's the difference between website events and app events? > > Website events track conversions that happen in a browser (purchases, sign-ups, page views) after a user interacts with an ad. App events track actions in your mobile or web app such as installs, sessions, and in-app purchases. Pick the source with the **Action Source** field on the destination — `website` or `app` — based on where your events originate. > [accordion] How do I send offline conversion data instead of real-time events? > > Choose the **Send offline data to FB Enhanced CAPI** action on the destination and follow the [Facebook Enhanced Conversions API (CAPI)](/articles/integrate-customer/facebook-enhanced-conversions-api-capi) setup, which covers offline attribution use cases such as in-store purchases and offline lead capture. ## Next steps * [Explore Facebook Enhanced CAPI for offline data →](/articles/integrate-customer/facebook-enhanced-conversions-api-capi) * [Explore the Google Enhanced Conversions API (CAPI) integration →](/articles/integrate-customer/google-enhanced-conversions-api-capi) * [Explore the Amazon Conversions API integration →](/articles/integrate-customer/amazon-conversions-api) * [Explore sending events using the API directly →](/articles/integrate-customer/send-events-using-the-api) # Facebook Enhanced Conversions API (Send Offline data) Source: https://docs.zeotap.com/articles/integrate-customer/facebook-enhanced-conversions-api-capi Send offline conversion events from a Zeotap CDP audience to Meta using the Facebook Conversions API destination and its Send offline data to FB Enhanced CAPI action. ## What this is Facebook Enhanced Conversions API (CAPI) is a Zeotap CDP destination that sends offline conversion data **out of Zeotap CDP to Meta (Facebook)**, so that offline events can be used for measurement, attribution and campaign optimisation in Meta Ads. It is filed under **Batch Integrations**: you build an audience in the Audiences application, link it to this destination, and Zeotap CDP delivers the mapped offline events against the Meta Pixel you configured. In the Zeotap CDP destination catalogue the connector is listed as **Facebook Conversions API**, and this page covers its **Send offline data to FB Enhanced CAPI** action. To stream website or app events to the same connector from a journey instead, see [Facebook Conversions API](/articles/integrate-customer/facebook-conversions-api), the real-time counterpart of this page. This integration helps you: * Improve campaign performance with accurate conversion tracking. * Optimise audience targeting and bidding strategies. * Maintain compliance while sharing first-party data with Meta. ### Sample use cases **Retail offline purchase attribution.** If you run physical store promotions via Facebook Ads, you may want to track in-store purchases attributed to those ads. Sending hashed customer identifiers and purchase details to Meta through Zeotap improves attribution accuracy and helps you optimise your ad spend. **Lead generation for services.** If you collect leads offline — at events or through call centres, for example — you can keep attribution accurate by sending hashed lead data to Meta via Enhanced CAPI, even when cookies are restricted. ## Supported identifiers and actions | Action | What it does | | - | - | | **Send offline data to FB Enhanced CAPI** | Sends offline event data to Meta for better attribution and optimisation in Meta Ads. | This integration supports the following identifiers for matching: * Hashed Email Address (SHA256) * Hashed Phone Number (SHA256) * Hashed First Name and Last Name (SHA256) * Mobile Advertiser ID (not hashed) * External User ID (not hashed) It also supports sending attributes such as date of birth, gender and city. ### Destination fields available in the mapping When you select the action, the **Map the Fields** screen populates the following destination fields under the **Offline Event** group. Map the Catalogue field that holds each value to the corresponding destination field. | Destination field | Type | Required | | - | - | - | | Event Time | Integer | Yes | | Email | List | — | | Phone Number | List | — | | First Name | String | — | | Last Name | String | — | | Madid | String | — | | External Id | String | — | | Gender | String | — | | Date of birth | String | — | | City | String | — | | State | String | — | | ZIP code | String | — | | Country | String | — | > [!WARNING] > > Mapping **Event Time** is mandatory. If it is left unmapped, the destination fails. ## Prerequisites Ensure you have the following in place before setting up Facebook Conversions API: * A Meta Business Manager account. * A Meta Pixel linked to your Business Manager. * A dataset configured to store conversion data. * A system user with the required permissions. * OAuth credentials or a system user access token. * App Review approval with Ads Management permissions. ## Gather the Meta-side components Before creating a destination in Zeotap CDP, ensure you have the following details: * **Meta Pixel ID** — required to associate conversion data with your Meta Ads account. * **Event Time** — Unix timestamp of when the event occurred. * **User Data** — at least one identifier (email, phone, name, madid, or external_id) is required for matching. * **Custom Data (for Journeys only)** — if sending purchase data, currency and value are mandatory. See [Custom Data Parameters](/articles/integrate-customer/facebook-conversions-api#custom-data-parameters). > [!NOTE] > > To learn how to obtain the **Pixel ID** and the **Access Token** from Facebook Events Manager, see [Components of the Conversions API](/articles/integrate-customer/facebook-conversions-api#components-of-the-conversions-api). ## Create the Facebook Conversions API destination **Step 1** Sign in to the Zeotap CDP app and open the **Destinations** application under **Integrate**. **Step 2** Click **+ Create Destination**. ![The Destinations list in Zeotap CDP, with the + Create Destination button highlighted at the top right of the destination table.](https://mintcdn.com/zeotap/OFEzw22E9lo2DHYT/articles/integrate-customer/Storage/integrate-customer/personyze/ADOBE_DMP_3_\(1\).png?fit=max\&auto=format\&n=OFEzw22E9lo2DHYT\&q=85\&s=816d7f247d590bc7bb09fff1e0b92a3d) **Step 3** Under the **All Destinations** section, search for **Facebook Conversions API**. ![The All Destinations catalogue, with the Search for a Destination box highlighted above the grid of destination tiles.](https://mintcdn.com/zeotap/OFEzw22E9lo2DHYT/articles/integrate-customer/Storage/integrate-customer/personyze/ADOBE_DMP_4_\(1\).png?fit=max\&auto=format\&n=OFEzw22E9lo2DHYT\&q=85\&s=9cca1024dea8e775f5b0ad6aa1d68a75) **Step 4** Click **Facebook Conversions API**. A screen appears with details about the destination on the left and the fields required for the integration on the right. Enter the following, then review the values and click **Next**: a. A **Destination Name** for easy identification. b. The **Pixel ID** and **Access Token** you obtained from Facebook Events Manager. ![The Enter Destination Details step for Facebook Conversions API, showing the Destination Name, Pixel ID and Access Token fields, the Destination Details and Mapping progress indicator, and the Next button.](https://mintcdn.com/zeotap/iO8h5JmzK8FO_MOm/articles/integrate-customer/Storage/integrate-customer/facebook-enhanced-conversions-api-capi/facebook-enhanced-conversions-api-capi-2025-03-28.png?fit=max\&auto=format\&n=iO8h5JmzK8FO_MOm\&q=85\&s=a959f6faaa8d0f2e99b62c812e93fa43) **Step 5** On the next screen, under **Choose your Action**, select **Send offline data to FB Enhanced CAPI** as the action for activating your audience (segment) in the Audiences application. This auto-populates Event Time, Email, Phone Number, First Name, Last Name and the other destination fields under **Map the Fields**. Map the required Catalogue fields to the corresponding destination fields. ![The Choose your Action step with Send offline data to FB Enhanced CAPI selected, above the Map the Fields table listing the Offline Event destination fields and their types.](https://mintcdn.com/zeotap/iO8h5JmzK8FO_MOm/articles/integrate-customer/Storage/integrate-customer/facebook-enhanced-conversions-api-capi/facebook-enhanced-conversions-api-capi-2025-03-28-1.png?fit=max\&auto=format\&n=iO8h5JmzK8FO_MOm\&q=85\&s=31d0af7ecb161eef4259a4fd3b77b56b) **Step 6** Click **Create Destination**. The created destination is listed in the **Audiences** application, where it can be linked to an audience or segment. ## Link an audience to the destination For how to link an audience or segment to the destination you created in the Audiences application, see [Activate in Audiences](/articles/integrate-customer/link-an-audience-to-the-destination#activate-in-audiences). > [!NOTE] > > The terms *audience* and *segment* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience or a segment could be a specific group of customers who are over 18 years of age and who have performed an `addToCart` event within the last 30 days. ## Verify the data reached Meta Ads Perform the following steps to view the Facebook Conversions API data sent from Zeotap CDP in Meta Ads: **Step 1** Log in to Facebook Events Manager. **Step 2** Select the Pixel ID associated with the integration. **Step 3** Navigate to **Data Sources** > **Offline Event Data**. **Step 4** Review the uploaded conversion events and analyse the performance insights. For Meta's own verification guidance, see the [Conversions API verifying setup guide](https://developers.facebook.com/docs/marketing-api/conversions-api/verifying-setup). ## Troubleshoot the destination | Symptom | What it means | What to do | | - | - | - | | The destination fails after activation | **Event Time** was left unmapped. It is mandatory for this action. | Open the destination's mapping, map a Catalogue field to **Event Time**, and save. | | Events arrive in Meta but are not usable for attribution or delivery optimisation | An event is considered invalid when its customer-information parameters are only a subset of certain combinations. | Send additional identifiers alongside the ones already mapped. See [Understanding Baseline Requirements for Matching](/articles/integrate-customer/facebook-conversions-api#understanding-baseline-requirements-for-matching). | | The audience–destination pair reports a delivery error | The failure is at the activation level rather than specific to this connector. | Check the error against the destination error table in [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail). | If the error does not match any row above, see [When to contact support](/articles/integrate-customer/destinations#when-to-contact-support) for what to gather, then write to [support@zeotap.com](mailto:support@zeotap.com) with the audience ID, the destination ID, the timestamp and exact text of the failing run, and a screenshot of the destination's activity view. For Meta-side behaviour, refer to Meta's [Conversions API documentation](https://developers.facebook.com/docs/marketing-api/conversions-api). ## FAQ > [accordion] What is the difference between this page and Facebook Conversions API? > > Both use the same **Facebook Conversions API** connector in the Zeotap CDP destination catalogue, but a different action. This page covers **Send offline data to FB Enhanced CAPI**, which sends offline events from an audience you link in the Audiences application. [Facebook Conversions API](/articles/integrate-customer/facebook-conversions-api) covers streaming website and app events from a journey. > [accordion] Which fields must I map before the destination will run? > > **Event Time**. It is marked as required on the **Map the Fields** screen, and the destination fails if it is left unmapped. At least one user identifier — email, phone, name, madid, or external_id — is also required for matching. > [accordion] Where do I get the Pixel ID and Access Token? > > Both come from Facebook Events Manager, not from Zeotap CDP. See [Components of the Conversions API](/articles/integrate-customer/facebook-conversions-api#components-of-the-conversions-api) for the steps to locate your Dataset ID/Pixel ID and to generate an access token. ## Next steps * [Explore Facebook Conversions API for real-time event streaming →](/articles/integrate-customer/facebook-conversions-api) * [Explore Facebook 1P (Meta) for Custom Audience targeting →](/articles/integrate-customer/facebook-1p) * [Explore Facebook Product Catalog →](/articles/integrate-customer/facebook-product-catalog) * [Explore linking an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore why destination deliveries fail →](/articles/integrate-customer/destinations#why-deliveries-fail) # Facebook Product Catalog Source: https://docs.zeotap.com/articles/integrate-customer/facebook-product-catalog Send product data from Zeotap CDP to a Facebook Product Catalog in Commerce Manager, so you can run dynamic ads across Facebook platforms. ## What this is Facebook Product Catalog is a Zeotap CDP destination that sends product data **out of Zeotap CDP to Facebook**, where it lands in a catalogue held in your Facebook Business Manager account. A Facebook Product Catalog is a container that holds information about the items you want to advertise or sell across Facebook platforms. Once your product data reaches it, you can create dynamic ads that automatically promote relevant products to people who have expressed interest on your website, app, or elsewhere on the internet. The destination is a batch integration: you configure it in the Destinations application, then link a product feed to it from the Audiences application. Other Facebook destinations send different data to the same platform: * To send offline conversion data to Meta, see [Facebook Enhanced Conversions API (Send Offline data)](/articles/integrate-customer/facebook-enhanced-conversions-api-capi). * To send audience segments to Meta as Custom Audiences, see [Facebook 1P (Meta)](/articles/integrate-customer/facebook-1p). ## Supported actions and fields On the mapping screen, **Choose your Action** sets what the destination does with your data. **Send Products to Facebook Catalogue** sends product records to the catalogue you identified by its Catalog ID. Under **Map the Fields**, the destination fields that the platform accepts are listed by default under **Product Attributes** — product ID, title, description, price, availability, brand and more. **ID** and **Title** are marked as required. You can edit, add or remove an attribute in that list; for how the mapping screen works, see [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). ## Prerequisites Have the following ready before you create the destination. * **Facebook Business Manager account** — an active account with a Product Catalog linked to it. * **Catalog ID** — the unique identifier for your Facebook Product Catalog. Found in Commerce Manager at **Assets** > **Catalogues**, where each catalogue's **Catalogue ID** is listed beneath its name. * **API key and permissions** — a valid Facebook API key with the `catalog_management` permission to create, edit and manage product catalogues, and the `ads_management` permission for running dynamic ads with the catalogue. You enter this value in the destination's **Access Token** field. * **Commerce Policies acceptance** — you must accept Facebook's Commerce Policies terms. This is a mandatory step. * **Product data attributes** — a product feed containing Product ID, Title, Description, Price, Availability, Image URLs, Brand, and other catalog-specific fields. ## Create the Facebook Product Catalog destination **Step 1** Sign in to the Zeotap CDP app and open **Integrate** > **Destinations**. **Step 2** Click **+ Create Destination**. ![The Destinations list in Zeotap CDP, with the + Create Destination button highlighted at the top right of the Private Destination tab.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-102.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=c06ad245b79a493103a38d2b628b5bcd) **Step 3** Under **All Destinations**, search for **Facebook Product Catalog**. ![The All Destinations catalogue in Zeotap CDP, with the search box highlighted above the grid of destination tiles.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-103.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=466eeeb7cdecd195a7eca01ca1ddf1d0) **Step 4** Click **Facebook Product Catalog**. A screen appears with details about the destination on the left. On the right-hand side is the list of fields required to establish the integration. **Step 5** In **Destination Name**, enter a name for the destination. **Step 6** In **Access Token**, enter your access token. **Step 7** In **Product Catalog ID**, enter the Catalog ID number. **Step 8** Review the values you entered, then click **Next**. ![The Enter Destination Details step for the Facebook Product Catalog destination, showing the Destination Name, Access Token and Product Catalog ID fields, with the vendor description and Related Links panel on the left and the Back and Next buttons at the foot of the page.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/facebook-product-catalog/Screenshot_2025-10-14_at_6-30-23_PM.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=d956a83a33608500cc84e29ee789bfb4) **Step 9** On the mapping screen, choose the action and the mapping: 1. Under **Choose your Action**, select **Send Products to Facebook Catalogue**, then pick the corresponding product attributes under **Map the Fields**. 2. Click **Create Destination**. The created destination is listed in the Target and Audiences applications, where it can be linked to a product feed. ![The Mapping step, with Choose your Action set to Send Products to Facebook Catalogue and a Map the Fields table pairing each Catalogue Field with a Product Attributes destination field such as ID and Title.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/facebook-product-catalog/facebook-product-catalog-2025-10-14-2.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=33a9ad582bf6c9a277e23d4b1499a905) ## Link a product feed to the destination For how to link a product feed to the created destination in the Audiences application, see [Activate your batch audiences](/articles/integrate-customer/link-an-audience-to-the-destination). ## Verify the products reached Facebook **Step 1** Log into the Facebook console with the appropriate credentials. **Step 2** Go to **All tools** and select **Commerce Manager**. ![The All tools menu in Meta Commerce Manager, with the Commerce Manager shortcut highlighted among the shortcut tiles.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/facebook-product-catalog/facebook-product-catalog-2025-10-15-3.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=0d4fc46e252bb185d56efad6d2d20b82) **Step 3** Select **Catalogues** and choose your catalogue. ![The Assets page in Meta Commerce Manager, with the Catalogues panel highlighted below the Commerce accounts panel.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/facebook-product-catalog/facebook-product-catalog-2025-10-15-2.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=af5d5fd7b1d531944be23a45a10d4a09) **Step 4** The list of products pushed appears. ![The Products view of a catalogue in Meta Commerce Manager, showing the product and variant counts, the product rows with their Content IDs, and the Filters panel on the right.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/facebook-product-catalog/facebook-product-catalog-2025-10-15-1.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=7cacc9735ea378639903d4c0abc0c11e) ## Troubleshoot the integration **The products are not in the catalogue yet.** Processing is not immediate — it can take up to several hours for product data to appear in the Facebook Product Catalog, depending on the volume of data sent and your sequence in the data pipeline. Check again after that window before investigating further. **Rows appear in Commerce Manager with Title missing or Availability missing.** Open the destination's mapping and confirm that the catalogue attributes mapped to **Title** and **Availability** under **Map the Fields** carry values for those products. **ID** and **Title** are required destination fields. ## Next steps * [Explore creating a destination →](/articles/integrate-customer/create-a-destination) * [Explore linking a feed or audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore the Facebook Enhanced Conversions API destination →](/articles/integrate-customer/facebook-enhanced-conversions-api-capi) * [Explore the other batch integrations →](/articles/integrate-customer/destination-batch-integrations) # FAQs for Snowflake Source: https://docs.zeotap.com/articles/integrate-customer/faqs-for-snowflake Answers to the questions asked most often about the Snowflake source in Zeotap CDP — sync frequency, delta fetches, warehouse and database setup, and what to check when no data arrives. These FAQs cover the **Snowflake source** — the integration that brings data from your Snowflake account **into** Zeotap CDP. If you want to send data the other way, from Zeotap CDP audiences **out** to Snowflake, see the [Snowflake destination](/articles/integrate-customer/snowflake-destination) instead. For the full setup walkthrough, see [Create a Snowflake Source and Load Data](/articles/integrate-customer/create-a-snowflake-source). ## Sync frequency > [accordion] When does the first sync run after I create the source? > > The first data sync takes place as soon as you create the source. Every sync after that follows the **Sync Frequency** you selected on the source. So if you set **Sync Frequency** to **Daily**, Zeotap CDP starts pulling data immediately after the source is created and saved, and fetches again every 24 hours. > [accordion] Which sync frequencies can I choose? > > You choose the **Sync Frequency** from a drop-down while creating the source. The supported frequencies are: > > * **Daily** > * **Weekly** > * **Monthly** > * **Hourly** > * **Thirty Minutes** > * **Fifteen Minutes** > > **Fifteen Minutes** is the shortest interval available. > [accordion] Can I pull data more than once a day? > > Yes. Select **Hourly**, **Thirty Minutes**, or **Fifteen Minutes** as the **Sync Frequency** when you create the source. > > This applies to production. The sandbox environment supports only a daily refresh, which occurs once every 24 hours — it does not support intraday refresh. ## Delta fetches > [accordion] Does every sync pull the whole table? > > That depends on the **Delta Queries Selection** you make on the source: > > * **true** — Zeotap CDP gathers only the incremental updates (deltas) in the table, at the sync frequency you configured. > * **false** — Zeotap CDP retrieves and transfers the entire dataset on every subsequent synchronisation, regardless of any changes made, so the full dataset is refreshed at each sync. > [accordion] What do I need to do in Snowflake before using delta queries? > > Enable change tracking on the table **before** you create the Snowflake source. In the Snowflake console, go to **Projects** > **Worksheets**, create a new SQL worksheet, choose the **Database** and **Schema** that hold the table, and run the following command, replacing `${TABLE_NAME}` with the actual table name: > > ```sql theme={null} > ALTER TABLE ${TABLE_NAME} SET CHANGE_TRACKING = TRUE; > ``` > > Once the statement completes, that table is configured to support delta fetches. The full procedure is on [Create a Snowflake Source and Load Data](/articles/integrate-customer/create-a-snowflake-source). > > Note that deltas are available in production but are not supported in the sandbox environment. ## Snowflake account setup > [accordion] Which authentication methods are supported for a Snowflake source? > > Zeotap CDP supports two methods: **Username + Password**, and **Username + Key Pair**. You choose between them using the **Authentication Type** field while creating the source. See [Create a Snowflake Source](/articles/integrate-customer/create-a-snowflake-source#key-pair). > [accordion] Do I need to provide a Private Key Passphrase? > > Only if your private key is encrypted. If you generated the key with the `-nocrypt` option, the key is unencrypted and you can leave **Private Key Passphrase** empty. > [accordion] What key format and size does Zeotap CDP accept? > > Snowflake requires a minimum of a 2048-bit RSA key pair in the Privacy Enhanced Mail (PEM) format, generated using the PKCS#8 standard. Upload the **private** key file under **Upload PEM file** in Zeotap CDP, and register the **public** key against your Snowflake user. > [accordion] Does the Snowflake warehouse have to be running? > > Yes. Ensure that the warehouse you use is in **Started** (Active) status when integrating with Zeotap CDP. You can resume a suspended (that is, inactive) warehouse by following the steps in the [Snowflake documentation](https://docs.snowflake.com/en/user-guide/warehouses-tasks#starting-or-resuming-a-warehouse). > [accordion] Can I point the source at a database I already use? > > You can, but a dedicated database is safer. Each source creates its own schemas and tables, so we recommend that you create a new database for this purpose to avoid name conflicts with existing data. To learn how to create one, see the [Snowflake documentation](https://docs.snowflake.com/en/sql-reference/sql/create-database). > [accordion] Which file formats can I load into the Snowflake table? > > When you load data into the table from Snowflake's **Load Data into Table** window, the supported formats are `CSV/TSV, JSON, ORC, AVRO, PARQUET, or XML`. ## When data does not arrive > [accordion] My source still shows the status CREATED — what does that mean? > > The status changes from **CREATED** to **INTEGRATED** once data starts flowing in. You can check what has arrived on the **Preview Data** tab of the source, which you reach from the [Source Listing](/articles/integrate-customer/components-of-the-source-listing-page) page. > [accordion] The Preview tab says no data has been received. > > If the **Preview** tab shows the message *"No data has been received. Ensure to implement the source correctly and check again later"*, reach out to our support team at [support@zeotap.com](mailto:support@zeotap.com). > [accordion] I see an error saying an IP address is not allowed to access Snowflake. > > This appears when an active Network Policy is applied to your Snowflake account or user and the source IP address in the error message is not included in the `Allowed IP Addresses` block. See [Error Handling and More](/articles/integrate-customer/snowflake-source-error-handling-and-more) for the resolution steps and the recommendations that help you avoid it. > [accordion] Loading data in Snowflake returns a privileges error. > > This is raised by Snowflake, not by Zeotap CDP. Review the [table privileges required by Snowflake](https://docs.snowflake.com/en/user-guide/security-access-control-privileges#label-table-privileges) and contact your Snowflake account administrator. ## Next steps * [Create a Snowflake source and load data →](/articles/integrate-customer/create-a-snowflake-source) * [Review the best practices for a Snowflake source →](/articles/integrate-customer/best-practices-for-snowflake-source) * [Handle Snowflake source errors →](/articles/integrate-customer/snowflake-source-error-handling-and-more) * [Send Zeotap CDP audiences out to Snowflake instead →](/articles/integrate-customer/snowflake-destination) * [Explore the other data warehouse sources →](/articles/integrate-customer/data-warehouse) # Google Customer Match consent update Source: https://docs.zeotap.com/articles/integrate-customer/faqs-related-to-google-consent-update How to align Zeotap Customer Match destinations with Google's EU user consent requirements for ad_user_data and ad_personalization. ## What this is Google's EU user consent policy — grounded in the Digital Markets Act (DMA) — requires that Customer Match uploads for users in the European Economic Area (EEA) carry two consent signals: `ad_user_data` and `ad_personalization`. Starting March 6th, 2024, Zeotap CDP transmits a **GRANTED** status for both signals on every Customer Match upload, on the assumption that you have already filtered your audience to consented users. This page explains what the update requires from you, how to configure Zeotap so only consented users reach Google, and how to verify the setup. The update applies to these Zeotap destinations: * Google Customer Match * Google Customer Match — Customer Contact Information * Google Customer Match — Mobile Identifiers ## Prerequisites > [!NOTE] > > Before you configure consent for Google Customer Match, confirm with your legal team and your Google account contact which consent signals your business captures, and how those map to `ad_user_data` and `ad_personalization`. Google's guidance is that the consent strategy is your responsibility; Zeotap enforces the rules you set. You need: * Access to a Zeotap CDP tenant with the **DESTINATIONS** and **Audiences** applications enabled. * One or more Google Customer Match destinations already created (see [Google Customer Match (Customer Contact Information)](/articles/integrate-customer/google-customer-match-customer-contact-information) or [Google Customer Match (Mobile Device IDs)](/articles/integrate-customer/google-customer-match-mobile-device-ids)). * A source of consent data — for example, the Zeotap SDK, an event stream, or a batch upload — that carries a per-user signal for ad-personalization consent. * Legal sign-off on which users qualify as "consented" under the DMA / EU user consent policy. ## Why this happens Google enforces the EU user consent policy against Customer Match uploads in the EEA. Unless an EEA user is uploaded with GRANTED consent for `ad_user_data` and `ad_personalization`, Google can withhold personalization for that user or reject the record. The table below summarises the customer-observable conditions tied to this update. | Condition | What it means | Where to look | | - | - | - | | `ad_user_data` not GRANTED | Consent to send user data to Google for advertising has not been captured for that user | Your consent capture surface (Zeotap SDK, event stream, batch file) | | `ad_personalization` not GRANTED | Consent for ad personalisation has not been captured for that user | Your consent capture surface | | EEA user reaches audience without consent | Consent Orchestration rules are not filtering the user out before the Customer Match refresh | Zeotap Consent Orchestration configuration | | Customer Match segment does not populate in Google Ads | Uploaded users failed consent enforcement on Google's side | Google Ads → Audience manager | Scope note: this enforcement covers EEA users. The EU user consent policy also applies to the UK, but the DMA does not — the UK is a non-EEA country. ## Configure consent for Google Customer Match Work through these steps once per tenant. Each Google Customer Match destination in that tenant then relies on the same consent pipeline. ### 1. Capture consent at the source Capture `ad_user_data` and `ad_personalization` consent from each user at the point of collection. The process for capturing consent through the Zeotap SDK is unchanged by this update — see the [Web SDK documentation](/articles/sdks/web-js/intro) for the collection API. For offline sources, agree the consent field with your data team so the same signal reaches Zeotap on every ingest. ### 2. Ingest consent signals into Zeotap Send the consent signals into Zeotap alongside the identifiers you already ingest for Customer Match. The two Google signals you need to represent are: ```json theme={null} { "ad_user_data": "GRANTED", "ad_personalization": "GRANTED" } ``` Represent an unconsented user by omitting the GRANTED status — do not send `GRANTED` for a user who has not consented. Your legal team decides how a missing or withdrawn consent is encoded. ### 3. Configure Consent Orchestration rules In your Zeotap tenant, define Consent Orchestration rules so that only users with GRANTED status on both `ad_user_data` and `ad_personalization` qualify for audiences that feed a Google Customer Match destination. The rules filter out users without GRANTED status so the audience feeding Google Customer Match contains consented users only. ### 4. Link consent-filtered audiences to your Google destination Link the consent-filtered audience to your Google Customer Match, Customer Match — Customer Contact Information, or Customer Match — Mobile Identifiers destination as you would for any audience. For the linking flow, see [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination). > [!WARNING] > > Do not link an audience to a Google Customer Match destination without confirming that Consent Orchestration is filtering unconsented users. Zeotap transmits `GRANTED` for `ad_user_data` and `ad_personalization` on every record it sends; if unconsented users reach the export, you are asserting consent you have not captured. ## Verify consent is applied To confirm the setup is working end-to-end: 1. Compare the audience count before and after the Consent Orchestration rule is applied. A drop in the count confirms the rule is filtering out users without GRANTED consent. 2. On the next refresh of the audience, review the Google Customer Match destination's activity in the Zeotap **Destinations** application and confirm the upload completed. 3. In your Google Ads or DV360 account, confirm the Customer Match segment is present under your Customer lists. ## Troubleshoot **The audience count did not change after the Consent Orchestration rule was added.** The rule is not filtering on the consent field you ingested. Recheck that the field name in the rule matches the field your source is sending, and that the ingested values are the ones the rule tests for. **A user you expect to see in the Google segment is missing.** The user does not have GRANTED status for both `ad_user_data` and `ad_personalization`, or the consent record did not reach Zeotap before the last refresh. Trace the user's consent record from your capture surface into Zeotap before contacting support. **You are unclear on what the update requires.** Contact your legal team and your Google account contact. As an interim measure, halt refreshes to your Google Customer Match destinations until the consent strategy is confirmed. ## FAQ > [accordion] What does the EU user consent policy involve? > > The EU user consent policy requires compliance with the Digital Markets Act (DMA). It requires that user consent is obtained before ad personalisation activities are performed on users in the European Economic Area. > [accordion] Which consent signals does Google require for Customer Match? > > Two signals: `ad_user_data`, which sets consent for sending user data to Google for advertising purposes, and `ad_personalization`, which sets consent for ad personalisation. Both apply to Customer Match uploads used in Google Ads and Google DV360. > [accordion] When did consent signal enforcement start? > > Consent signals must be sent to Google for EEA users starting March 6th, 2024. > [accordion] Does this update apply to the UK? > > The EU user consent policy applies to the UK. The Digital Markets Act does not, because the UK is a non-EEA country. > [accordion] What does Zeotap send on my behalf? > > Zeotap CDP transmits a **GRANTED** consent status for `ad_user_data` and `ad_personalization` on Customer Match uploads to Google Customer Match, Google Customer Match — Customer Contact Information, and Google Customer Match — Mobile Identifiers. This is on the assumption that you have filtered your audience to consented users before the export. > [accordion] What am I responsible for as a customer? > > Two things: ingest consent parameters into Zeotap that cover `ad_user_data` and `ad_personalization` and set Consent Orchestration rules that use them; and ensure only users who have consented to ad personalisation on Google products qualify for the audience. > [accordion] How do I onboard consent signals for online and offline users? > > Develop a consent strategy based on your business needs and consult your legal team on which signals to capture and how, as advised by Google. The Zeotap SDK collection API is unchanged by this update. > [accordion] What should I do if I am unclear on what the update requires? > > Contact your legal team and your Google account contact. As an interim measure, halt refreshes to your Google Customer Match destinations until the consent strategy is confirmed. ## Next steps * [Explore Google Customer Match — Customer Contact Information →](/articles/integrate-customer/google-customer-match-customer-contact-information) * [Explore Google Customer Match — Mobile Device IDs →](/articles/integrate-customer/google-customer-match-mobile-device-ids) * [Explore the Zeotap Web SDK for consent capture →](/articles/sdks/web-js/intro) * [Explore linking an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) ## Related * [Google Ad Manager](/articles/integrate-customer/google-ad-manager) * [Google's Customer Match policy](https://support.google.com/adspolicy/answer/6299717) * [Google's Consent Mode](https://support.google.com/google-ads/answer/10000067) * [Google's EU user consent policy](https://www.google.com/about/company/user-consent-policy/) * [Google's FAQs of EU user consent policy](https://support.google.com/google-ads/answer/14310715) # Flat Files (CE+NCE) Source: https://docs.zeotap.com/articles/integrate-customer/flat-files Batch-load customer and non-customer entity data into Zeotap CDP by uploading CSV or JSON files over Google Cloud Storage or SFTP. ## What this is Flat Files are batch data uploads — CSV or JSON files containing customer entity (CE) or non-customer entity (NCE) records — that you send to Zeotap CDP for ingestion. Each record must carry at least one identifier so Zeotap can attach it to a profile: your first-party user ID (identical to the one your Web JS or App SDKs emit), preferably paired with a digital identifier such as MAID. Zeotap supports two transfer channels for Flat Files — a managed Google Cloud Storage bucket and SFTP (a Zeotap-hosted push endpoint or a customer-hosted pull location). This page is the entry point: pick the channel that fits your infrastructure and follow the linked setup guide. ## Prerequisites > [!NOTE] > > Before you send your first file, confirm you have: > > * **At least one identifier per record** — your first-party user ID (identical to the one sent by your Web JS or App SDKs), preferably paired with a digital identifier such as MAID for match quality. > * **A country field on every record** — Zeotap requires country to build data collections. Alpha ISO 3 country codes are the recommended format; without a country field the value has to be hardcoded on the source later. > * **A consistent file format and delimiter** across every file in a source — the format is fixed at source creation, and every subsequent file uploaded to that source must match it. > * **A defined mapping to the Zeotap Catalogue** — CE data uses the CE catalogue mapping; NCE data uses the NCE catalogue mapping (both linked in Next steps). ## Choose a transfer channel Zeotap supports two Flat File transfer channels. Each is a distinct Source type in the CDP; register one source per channel per data feed. ### Zeotap Google Cloud Storage Zeotap provisions a Google Cloud Storage bucket for your tenant. You upload files to the bucket path assigned to your source using the GCloud Console, `gsutil`, or a third-party client such as Cyberduck. Zeotap picks up files from the configured path and ingests them. > [!WARNING] > > Uploads outside the Sources UI must land at the exact path assigned to the source. A file placed at the wrong path is not ingested, and the source's reporting and downstream segmentation will not reflect the data. Full setup: [Zeotap Google Cloud Storage](/articles/integrate-customer/zeotap-google-cloud-storage). ### SFTP (Secure File Transfer Protocol) SFTP comes in two variants: * **SFTP (Push)** — Zeotap hosts the SFTP endpoint; you push files to it. Setup: [SFTP (Push) Source](/articles/integrate-customer/creating-sftp-push-source). * **SFTP (Pull)** — you host the SFTP endpoint; Zeotap pulls files on a schedule. Setup: [SFTP (Pull) Source](/articles/integrate-customer/create-an-sftp-pull-source). Both routes are documented under [SFTP (Secure File Transfer Protocol)](/articles/integrate-customer/sftp-secure-file-transfer-protocol). ## Prepare the file layout A minimal CE file has a header row, at least one identifier column, a country column, and any additional attributes you want to ingest. Attribute names and their casing must stay identical across every file uploaded to the same source — a differing case is treated as a new attribute. CSV files must use a comma delimiter and must not wrap values in double quotes: ```csv theme={null} user_id,maid,email_sha256,country,event_timestamp u_10012,a1b2c3d4-e5f6-7890-abcd-1234567890ab,3f79bb7b435b05321651daefd374cdc681dc06faa65e374e38337b88ca046dea,USA,2024-01-15T10:30:00Z u_10013,,f0e9d8c7-b6a5-4321-9876-abcdef012345,DEU,2024-01-15T10:31:15Z ``` > [!TIP] > > Start with only the Catalogue fields relevant to this source. When you need to capture new data points, either add the fields and update the source's mapping, or create a new source for them. > [!WARNING] > > Upload files that belong to the correct region for the country of the records — for example, do not upload Spanish records to a US regional bucket. If a single feed spans multiple countries, split it by country before upload and route each split to the appropriate regional bucket. ## Verify the source is ingesting A Flat File source moves through the following statuses as it comes online: * **Created** — the source exists in the CDP but no data has arrived yet. * **Integrated** — data has started flowing into the source; Catalogue mapping is not applied yet. * **Mapped** — at least one data collection is built on top of the source, meaning Catalogue mapping is applied and the data is available for downstream use. You know the setup worked when the source reaches **Mapped** status and the record count on the source listing reflects the records from your uploaded files. ## Troubleshooting Ingestion issues with Flat Files fall into a small set of causes, each with a concrete fix. The table below maps the observable condition to what it means and where to check. | Error condition | What it means | Where to look | | - | - | - | | File format or delimiter differs from the source definition | Data corruption on ingest — the source parses using the format fixed at creation | Source's configured format; see the Best Practices link below | | A field in the file is not mapped to a Catalogue attribute | The unmapped field's data is not ingested | Source's mapping configuration | | Country field missing from records | Records cannot form a data collection until country is hardcoded on the source | Source's Catalogue mapping and enricher configuration | | Timestamp format differs from the format registered at mapping time | Ingestion fails — the source expects the format chosen at mapping time throughout its lifetime | Source's timestamp attribute mapping | | Attribute name or casing differs across files | The differing column is treated as a new attribute and is not merged with earlier data | Source's Catalogue mapping | ### Symptom — your file uploaded but records did not appear 1. Confirm the file matches the source's declared format and delimiter (CSV with a comma delimiter and no quoted-string wrappers, or the JSON structure you defined at creation). 2. Confirm every record carries at least one identifier — your first-party user ID or MAID. 3. Confirm the country field is present on every record and formatted as ISO 3. 4. Confirm every field in the file is mapped to a Catalogue attribute for this source; add mappings for any new fields. 5. Confirm the file was placed at the exact path assigned to the source (relevant when you upload outside the Sources UI). 6. If the checks above pass and records still do not appear, contact your Zeotap customer success representative and include the source name, the file name, the upload timestamp, and a sample of the file. ### Symptom — ingestion started failing after a working period 1. Compare the failing file's schema against the last successful file — attribute names with identical casing must appear in both. 2. Compare the failing file's timestamp format against the format registered at mapping time; if the format changed, restore the original format or create a new source for the new format. 3. Confirm the file was uploaded to the exact path the source expects. 4. If the schemas match and the path is correct, contact your Zeotap customer success representative with the source name, the file name, and the upload timestamp. ## Next steps * [Explore Zeotap Google Cloud Storage setup →](/articles/integrate-customer/zeotap-google-cloud-storage) * [Explore SFTP source setup →](/articles/integrate-customer/sftp-secure-file-transfer-protocol) * [Explore best practices for Flat File sources →](/articles/integrate-customer/best-practices-for-flat-file-source-2709422090) * [Explore Catalogue mapping for CE data →](/articles/unify-customer/map-the-catalogue-for-customer-data) * [Explore Catalogue mapping for NCE data →](/articles/unify-customer/map-the-catalogue-for-non-customer-entity-data) * [Explore adding an NCE category to the Catalogue →](/articles/unify-customer/adding-a-non-customer-entity-category) * [Explore configuring the Join Key Enricher →](/articles/unify-customer/configuring-the-join-key-enricher) # Getting Emarsys credentials Source: https://docs.zeotap.com/articles/integrate-customer/getting-emarsys-credentials Create the API credentials in Emarsys that let the Emarsys Source pull email engagement data into Zeotap CDP. ## What this is The Emarsys Source moves data **from** your Emarsys account **into** Zeotap CDP: it calls the Emarsys API to request the response data for an email campaign and then retrieve the contacts behind that data, so you can map it to your Catalogue. This page covers the Emarsys-side work only — creating the API credentials the Source authenticates with, and enabling the permissions it needs. Data travelling the other way, out of Zeotap CDP and into Emarsys, is a separate integration: see [Emarsys](/articles/integrate-customer/emarsys) for the batch destination and [Emarsys Real Time Integration](/articles/integrate-customer/emarsys-real-time-integration) for the real-time one. ## Prerequisites Before using this API, ensure the following conditions are met: * **Active Emarsys account** — you must have an active Emarsys account with administrative privileges, and be able to log in as an Account Owner. * **API user credentials** — you must have already created an API user within the Emarsys platform and have access to its username and secret (API key). * **Correct permissions** — the API user must be granted the appropriate permissions for all endpoints listed in this documentation. This is configured in the Emarsys UI under **Management > Security Settings > API Users**. * **Existing data** — the Emarsys account should have existing contacts, contact lists and configured external events, so that the API calls return meaningful data. ## Create the API credentials in Emarsys (OAuth 2.0) To interact with the Emarsys v3 API, your application must first authenticate itself and obtain a temporary access token. The credentials you create below are the permanent, long-term credentials for that application, and must be stored securely. **Step 1** Log in to the Emarsys application as an Account Owner. **Step 2** Navigate to **Management > Security Settings**. ![The Emarsys Management menu expanded, with Security Settings highlighted under Account Management.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-24.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=0b5217e3e3791d4d144b4f35ba0592da) **Step 3** Go to the **API Credentials** tab and click **Create API Credentials**. ![The Emarsys Security Settings page on the API Credentials tab, listing the existing credentials, with the Create API Credentials button highlighted.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-25.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=0fd7d68b450cf933893e6203d327dc9c) **Step 4** The system generates a **Client ID** and a **Client secret**. ![The Emarsys API Credentials detail view, showing the ID, Client ID, Client Secret, Token Endpoint and Metadata Endpoint fields, with the permissions list below them.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-26.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=b340abf889e7aae47c0c8aef07aaa1c5) > [!WARNING] > > **The Client secret is displayed only once, when the credential is created.** > > Copy it and save it to a secure location immediately. If you lose the secret you cannot retrieve it, and you will need to generate a new set of credentials. ## Enable the permissions for this Source Scroll down to **Permissions** on the credential you just created. Below you can find all the permissions that need to be enabled for this particular Source. ![Emarsys permission rows in the export category — export.responses, export.status and export.download — each toggled to Enabled.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-27.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=7130b4bd855961a51bc694949de42874) ![The Emarsys permission row for field.list in the field category, toggled to Enabled.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-28.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=17506c5686dd1482fb227df8d8823174) ## Next steps * [Creating an Emarsys Source](/articles/integrate-customer/creating-an-emarsys-source) — enter the Client ID, Client Secret and email campaign ID on the Source form in Zeotap CDP. * [Emarsys Source](/articles/integrate-customer/emarsys-source) — what the Source pulls and how the two-step API flow works. * [Emarsys](/articles/integrate-customer/emarsys) — the opposite direction: sending audiences and attributes from Zeotap CDP to Emarsys. # Google Ad Manager Source: https://docs.zeotap.com/articles/integrate-customer/google-ad-manager Send PPID audiences from Zeotap CDP to Google Ad Manager so publisher-defined identifiers can be matched at ad delivery time. ## What this is Google Ad Manager (GAM) is an ad management platform for large publishers with significant direct sales, used to manage the display of advertisements on websites, in video, and in mobile apps. It was formerly known as DoubleClick for Publishers (DFP) or DoubleClick AdX. This integration sends Publisher Provided Identifiers (PPIDs) — raw or encrypted — from a Zeotap CDP audience to a Google Ad Manager audience so those users can be targeted in your ad delivery. For sending MAIDs and Cookies, use the Google DMP integration instead; use Google Ad Manager only for PPIDs. ## Prerequisites > [!NOTE] > > **Before you configure the destination, confirm all of the following:** > > * Your Google Ad Manager account has Zeotap whitelisted as a linked Data Management Platform (**DMP: Zeotap**). Without this, Zeotap CDP cannot send PPID lists to Google Ad Manager. See [Google's linked-account instructions](https://support.google.com/admanager/answer/3289669?hl=en). > * You have your Google Ad Manager **Audience link ID** ready (a numeric value — it is not your Network code). > * For audiences that include users in the European Economic Area (EEA), you have supplied Zeotap CDP with the two consent parameters Google requires (`ad_user_data` and `ad_personalization`) and set up Consent Orchestration rules so only consented users are ingested. Starting March 6, 2024, Zeotap CDP transmits a `GRANTED` consent status for both signals. See the [Google consent update FAQ](/articles/integrate-customer/faqs-related-to-google-consent-update). > [!WARNING] > > If your audience contains EEA users and consent parameters are not supplied to Zeotap CDP, users transmitted to Google carry a `GRANTED` status without your consent-orchestration filter having applied. Configure Consent Orchestration before your first activation. ## Get your Audience link ID from Google Ad Manager The **Audience link ID** is the identifier Zeotap CDP uses to route PPID lists to the correct Google Ad Manager account. It is not the same as your Network code. **Step 1** Sign in to [Google Ad Manager](https://admanager.google.com/). **Step 2** Go to **Admin → Global settings → Network settings**. **Step 3** Copy the numeric value shown next to **Audience link ID**. > [!NOTE] > > Your Audience link ID and your Network code are different values. Confusing the two is a known cause of a Zeotap-created audience failing to appear inside Google Ad Manager. Paste this value into the destination configuration in the next section. ## Configure the Google Ad Manager destination in Zeotap CDP Open the **Destinations** application in Zeotap CDP and add a new Google Ad Manager destination. **Step 1** Log into the Zeotap CDP App and open the **DESTINATIONS** application. **Step 2** Click **+ Create Destination**. ![Destinations application with the Create Destination button](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-ad-manager/google-ad-manager-2024-07-28-1.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=50c2d77a3f0e7ad376d55f92a1aca827) **Step 3** Under **All Destinations**, search for **Google Ad Manager**. ![Searching for Google Ad Manager under All Destinations](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-ad-manager/google-ad-manager-2024-07-28-2.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=88ce496fc25279f205e49e483a471559) **Step 4** Click **Google Ad Manager**. On the right-hand side of the screen, enter the required fields: a. Enter a descriptive name for the destination. b. Enter the **Audience Link ID** you copied from Google Ad Manager. c. Click **Next** to proceed to Actions and Mapping. ![Google Ad Manager destination configuration fields including Audience Link ID](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-ad-manager/google-ad-manager-2024-07-28-3.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=b840a669a312853aefb0168570239496) **Step 5** Under **Choose your Action**, select **Send PPIDs to Google Ad Manager**. Under **Map the Fields**, map the identifier you want to send as the PPID. ![Choose your Action and Map the Fields screen for Send PPIDs to Google Ad Manager](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-ad-manager/google-ad-manager-2024-07-28-4.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=77d4c7b5b3a2bb8ecdb0f75ffa65fa58) **Step 6** Click **Create Destination**. The destination appears in the **Audiences** application, where you can link an audience to it. ### Supported identifiers and actions This integration accepts **PPIDs (raw and encrypted)** only. PPIDs are unique publisher-defined codes used to track users across platforms; encrypted PPIDs are long alphanumeric strings. Use Google DMP for MAIDs or Cookies. | Action Name | [ID EXTENSION](/articles/segment-customer/extend-your-audience#id-extension) | [DELETE](https://docs.zeotap.com/articles/#!integrate-customer/delta-upload-and-delete-functions) | [DELTA UPLOAD](https://docs.zeotap.com/articles/#!integrate-customer/delta-upload-and-delete-functions) | | :- | :-: | :-: | :-: | | Send PPIDs to Google Ad Manager | – | – | – | ### Consent signals sent for EEA audiences Starting March 6, 2024, Zeotap CDP transmits the following consent signals to Google Ad Manager for every user in the audience. Use Consent Orchestration to ensure only users who have granted these consents are ingested into the audience upstream: ```yaml theme={null} ad_user_data: GRANTED # consent to send user data for advertising to Google ad_personalization: GRANTED # consent for ad personalization ``` ## Link an audience to the destination To activate an audience through this destination, link it in the **Audiences** application. See [Link an Audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination) for the full procedure. > [!NOTE] > > The terms **Audiences** and **Segments** are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience or segment could be a group of customers who are over 18 years of age and who have performed an `addToCart` event within the last 30 days. ## Verify the destination is delivering PPIDs After you link an audience to the destination and the first refresh runs, confirm the audience shows up in Google Ad Manager: 1. In Zeotap CDP, open the **Audiences** application and confirm the audience is linked to the Google Ad Manager destination you created. 2. In Google Ad Manager, go to **Admin → Global settings → Network settings** and confirm the Audience link ID matches the one entered in the destination configuration. 3. In Google Ad Manager's audience segments view, confirm the audience name from Zeotap CDP is present and the member count is non-zero. If the audience does not appear after the next scheduled refresh, work through the failure modes below. ## Why activations fail Use this table to map what you see to what to check. | Error string / symptom | What it means | Where to look | | - | - | - | | Audience does not appear in Google Ad Manager | Zeotap is not whitelisted as a linked DMP on the Google Ad Manager account, so PPID lists cannot land as an audience | Google Ad Manager → **Admin → Linked accounts** — confirm **DMP: Zeotap** is present. See [Google's linked-account instructions](https://support.google.com/admanager/answer/3289669?hl=en) | | Destination configured with the wrong ID — audience never lands | The value entered in **Audience Link ID** is the Network code instead of the Audience link ID (they are two different numeric values) | Google Ad Manager → **Admin → Global settings → Network settings** — copy the value next to **Audience link ID**, not next to Network code | | Audience appears empty or with a lower count than expected in the EEA | EEA users are being filtered out because consent parameters (`ad_user_data`, `ad_personalization`) are not being supplied to Zeotap CDP or Consent Orchestration is not configured | Zeotap CDP consent configuration; see the [Google consent update FAQ](/articles/integrate-customer/faqs-related-to-google-consent-update) | | PPIDs sent but no users matched in ad delivery | The identifier mapped to PPID does not match the PPID format your Google Ad Manager setup expects (raw vs. encrypted) | Zeotap CDP destination → **Map the Fields** — confirm the mapped identifier matches the PPID format your GAM account uses | ## FAQ > [accordion] Can I send MAIDs or Cookies through the Google Ad Manager destination? > > No. This integration accepts **PPIDs (raw and encrypted)** only. To send MAIDs or Cookies, use the Google DMP integration instead. > [accordion] Is the Audience Link ID the same as the Network code? > > No. They are two different numeric values in Google Ad Manager. The **Audience link ID** is what you enter in the Zeotap CDP destination configuration; entering the Network code in its place prevents audiences from landing in Google Ad Manager. > [accordion] Why does the EEA portion of my audience look smaller than expected? > > Starting March 6, 2024, Zeotap CDP transmits a `GRANTED` status for `ad_user_data` and `ad_personalization` for every user sent to Google Ad Manager. To keep this consistent with each user's actual consent, supply the two consent parameters to Zeotap CDP and configure Consent Orchestration rules so only consented users are ingested into the audience upstream. > [accordion] What is a PPID? > > A Publisher Provided Identifier (PPID) is a unique code you assign to a user to track them across platforms. Encrypted PPIDs are long alphanumeric strings. PPIDs let you share user data with Google Ad Manager to serve more relevant ads. ## Next steps * [Explore Google Customer Match (Customer Contact Information) →](/articles/integrate-customer/google-customer-match-customer-contact-information) * [Explore Google Analytics 4 →](/articles/integrate-customer/google-analytics-4) * [Explore Google BigQuery →](/articles/integrate-customer/google-bigquery-destination) * [Explore the Google consent update FAQ →](/articles/integrate-customer/faqs-related-to-google-consent-update) * [Explore linking an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) # Google Analytics 4 Source: https://docs.zeotap.com/articles/integrate-customer/google-analytics-4 Send Zeotap audience membership to a Google Analytics 4 property as a custom event, then build GA4 audiences you can activate in Google Ads and Optimize 360. This page covers the **Google Analytics 4 (GA4) destination** — sending audience membership from Zeotap to a GA4 property using the Measurement Protocol. If you are configuring the Zeotap Collect Tag to capture the GA Client ID from a browser, see [Google Analytics configuration in GTM](/articles/sdks/gtm/setup-guide/configuration/google-analytics). If your account still runs Universal Analytics, see [Google Universal Analytics Integration](/articles/integrate-customer/google-universal-analytics-integration). For BigQuery-based data sharing with Google, see [Google Analytics Hub](/articles/integrate-customer/google-analytics-hub). ## What this is The Google Analytics 4 destination sends Zeotap audience membership into a GA4 property as a **custom event** named `zeotap_event`. Each event carries two parameters — `audience_name` (the Zeotap audience the profile belongs to) and `zeotap_event_type` (`add` when the profile joins the audience, `remove` when a later refresh drops it). Inside GA4 you build a **Custom Audience** on top of those events, and from there you link it into Google Ads or Optimize 360 for activation. The integration supports the **GA Client ID** identifier, the **ID Extension** feature, and **DELETE** actions; it does not support DELTA UPLOAD. ## Prerequisites > [!NOTE] > > Before you start, collect the following from your Google Analytics 4 account: > > * A **GA4 Property** with a **Web** Data Stream. This integration supports the web implementation of GA4 only. > * The Data Stream's **Measurement ID**. > * A **Measurement Protocol API Secret** generated against that Data Stream. > * Two **Custom Dimensions** on the property, both scoped to `Event`, with **Event Parameter** names `audience_name` and `zeotap_event_type` (see [Create the two required Custom Dimensions](#create-the-two-required-custom-dimensions)). > * The **GA Client ID** available on the profiles you plan to activate — this is the identifier the destination sends. > > Audience Name values sent from Zeotap must be **100 characters or fewer**, or GA4 will not ingest the event. ## Configure the GA4 property and Data Stream If you already have a GA4 Property with a Web Data Stream, skip to step 3. 1. In your Google Analytics 4 account, open **Admin** and select **Create Property**. Enter a **Property Name**, click **Next**, complete the **Business information** section as per your business requirement, then click **Create**. The GA4 property is created. ![Creating a property in Google Analytics 4](https://mintcdn.com/zeotap/5K-Zf-MYwWXwJWp5/articles/integrate-customer/Storage/integrate-customer/create_property.png?fit=max\&auto=format\&n=5K-Zf-MYwWXwJWp5\&q=85\&s=1a2e3b8f750ddf78436fa75acfd621d6) 2. Inside the new property, open **Data Streams**, choose **Web**, enter the **Website URL** you want to track and a **Stream Name**, then click **Create Stream**. 3. Open the Data Stream. A details panel opens on the right. Copy the **Measurement ID** — you paste it into Zeotap in a later step. ![Measurement ID in the GA4 Data Stream details panel](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/measurement_id.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=75e9fdba7fec7a1fc64d5d7ef06d3208) 4. In the same panel, scroll down and open **Measurement Protocol API secrets**. Click **Create**, then copy the resulting **API Secret**. ![Measurement Protocol API secrets panel in GA4](https://mintcdn.com/zeotap/0tFtKK3bg3ChrHL3/articles/integrate-customer/Storage/integrate-customer/api_secret.png?fit=max\&auto=format\&n=0tFtKK3bg3ChrHL3\&q=85\&s=3fb53c71a2ee395852cf962cb551bb55) ## Create the two required Custom Dimensions Without both Custom Dimensions in place, GA4 cannot resolve the parameters on the `zeotap_event` and any audience built on those parameters returns zero users. 1. In GA4, open **Configure → Custom Definitions → Create Custom Dimensions**. 2. Create the first Custom Dimension: * **Dimension Name**: `Audience Name` * **Scope**: `Event` * **Description**: as per your requirement * **Event Parameter**: `audience_name` 3. Create the second Custom Dimension: * **Dimension Name**: `Zeotap Event Type` * **Scope**: `Event` * **Description**: as per your requirement * **Event Parameter**: `zeotap_event_type` ![Creating the Custom Dimensions in GA4 Custom Definitions](https://mintcdn.com/zeotap/Yl1hDNuL3ftKLMn2/articles/integrate-customer/Storage/integrate-customer/custom_dimension.png?fit=max\&auto=format\&n=Yl1hDNuL3ftKLMn2\&q=85\&s=5acf925ad4ad47e7ab3d1ede78e6a365) > [!WARNING] > > The **Event Parameter** names are case-sensitive and must match exactly: `audience_name` and `zeotap_event_type`. A typo here silently breaks the integration — GA4 accepts the event but the audience filter returns zero matches. ## Create the GA4 destination in Zeotap 1. Log into the Zeotap CDP App and open the **Destinations** application. 2. Click **+ Create Destination**. ![Create Destination button in the Destinations application](https://mintcdn.com/zeotap/xGzkHY-dcQy5tLit/articles/integrate-customer/Storage/integrate-customer/ADOBE_DMP_3.png?fit=max\&auto=format\&n=xGzkHY-dcQy5tLit\&q=85\&s=102da1a60a97d389369069c7bad552ab) 3. Under **All Destinations**, search for **Google Analytics 4** and open it. The right pane shows the fields the integration needs. ![Searching for a destination under All Destinations](https://mintcdn.com/zeotap/xGzkHY-dcQy5tLit/articles/integrate-customer/Storage/integrate-customer/ADOBE_DMP_4.png?fit=max\&auto=format\&n=xGzkHY-dcQy5tLit\&q=85\&s=6a7ff3c41d25bca380ad1cdfe0d1f678) 4. Enter a **Destination Name**, paste the **Measurement ID** and **API Secret** you copied from GA4, review your entries, then click **Next**. ![Google Analytics 4 destination configuration fields](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-ad-manager/Google_Analytics_4_1.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=c2de68425bafeae3bcfa97d8935ccc09) 5. On the mapping screen, under **Choose your Action** select **Send identifiers to Google Analytics 4**. Under **Map the Fields**, map an [output identifier](https://docs.zeotap.com/articles/segment-customer/choose-the-output-identifiers) to **GA Client ID**. You can edit, add, or remove identifier rows using the mapping controls — see [Destinations — mapping](/articles/integrate-customer/destinations#mappingsanchor) for the full reference. ![Choose your Action and Map the Fields screen for the GA4 destination](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/google_analytics_4_2.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=876d14b85e05e857769c8441764061a8) 6. Click **Create Destination**. The destination now appears in the **Audiences** application, ready to attach to an audience. ## Link an audience to the destination Attach the newly-created destination to a Zeotap audience from the **Audiences** application. For the full walkthrough, see [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination). It can take up to **one business day** for the audience to become available in the GA4 seat after linking. > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category — for example, a group of customers who are over 18 years of age and performed an `addToCart` event within the last 30 days. ## What Zeotap sends to GA4 Zeotap emits a single custom event per profile per refresh, using the GA4 Measurement Protocol. The event and its two parameters look like this: ```json theme={null} { "client_id": "1220954604.1657797468", "events": [ { "name": "zeotap_event", "params": { "audience_name": "high_value_customers", "zeotap_event_type": "add" } } ] } ``` * If the profile is part of the audience in the current refresh, `zeotap_event_type` is `add`. * If the profile was in the audience in an earlier refresh and has dropped out in the current one, `zeotap_event_type` is `remove`. This drives the [user disqualification](#user-disqualification-from-audiences) flow described below. ## Verify the integration 1. In GA4, open the property's **Realtime** or **DebugView** report and confirm events named `zeotap_event` appear from your Data Stream. 2. Open one such event and confirm both parameters `audience_name` and `zeotap_event_type` are populated, with `audience_name` matching the Zeotap audience name you activated. 3. In GA4, open **Configure → Custom Definitions** and confirm both Custom Dimensions are listed with **Event Parameter** values `audience_name` and `zeotap_event_type`. 4. In GA4, open **Configure → Audiences**, build the audience described in [Build a GA4 audience from the zeotap_event](#build-a-ga4-audience-from-the-zeotap_event) below, and confirm the audience size grows as GA4 processes events. GA4 processing latency depends on your account tier — see [Google's data-processing documentation](https://support.google.com/analytics/answer/1070983?hl=en#zippy=%2Cin-this-article). If events do not appear within one business day of the first refresh, or the audience size stays at zero after 48 hours of GA4 processing, work through the errors in the next section. ## Troubleshoot common errors Almost every failed GA4 setup traces back to one of the conditions in this table. Work through it row-by-row before contacting support. | Error condition | What it means | Where to look | | - | - | - | | Audience Name longer than 100 characters | GA4 rejects the event; the profile is not counted into the GA4 audience | Zeotap: the audience name in the **Audiences** application — rename and re-activate | | Custom Dimension missing or mis-named | GA4 receives the event but cannot map `audience_name` or `zeotap_event_type`, so any audience built on those parameters returns zero users | GA4: **Configure → Custom Definitions**. Both dimensions must exist with Event Parameter names `audience_name` and `zeotap_event_type`, both scoped to `Event` | | Non-Web Data Stream selected | The integration is not supported — Zeotap sends only to the web implementation of GA4 | GA4: **Admin → Data Streams**. Confirm the **Measurement ID** came from a **Web** stream | | Identifier not mapped in Zeotap | No data reaches GA4 because no output identifier is bound to **GA Client ID** | Zeotap: the destination's **Map the Fields** screen — add a mapping row from an output identifier to **GA Client ID** | | Measurement ID or API Secret entered incorrectly | GA4 rejects the requests as unauthorised and no events reach the property | Zeotap: the destination's credentials screen — re-copy both values from the same GA4 Data Stream | ## Build a GA4 audience from the zeotap_event Once events flow into GA4, build a Custom Audience on top of `zeotap_event`. 1. In GA4, open **Configure → Audiences → New Audience → Create a Custom Audience**. 2. Under **Include users**, click **Add new condition** and configure: * Choose **Events → zeotap_event** from the drop-down. * Click **ADD PARAMETER** and under **Custom**, select **Audience Name → audience_name** and choose the relevant Zeotap audience name from the drop-down. * Add a second parameter: **Zeotap Event Type → zeotap_event_type** and choose **add**. 3. Under **ADD GROUP TO EXCLUDE**, click **Add new condition** to exclude users removed from the audience in a later refresh: * Choose **Events → zeotap_event**. * **Audience Name → audience_name** matches the same Zeotap audience name. * **Zeotap Event Type → zeotap_event_type** equals **remove**. 4. Click **Save**. ![Building a Custom Audience on the zeotap_event in GA4](https://mintcdn.com/zeotap/vhXLMoMLYK9r9Ts7/articles/integrate-customer/Storage/integrate-customer/build_audience.png?fit=max\&auto=format\&n=vhXLMoMLYK9r9Ts7\&q=85\&s=b929568693b5136cdb2ec024a0f79f74) To use this audience in Google Ads, link the GA4 property to Google Ads following [Google's GA4-to-Ads linking guide](https://support.google.com/analytics/answer/9379420#zippy=%2Cin-this-article). For the full GA4 audience-builder reference, see [Google's GA4 audiences documentation](https://support.google.com/analytics/answer/9267572?hl=en#zippy=%2Cin-this-article). ## User disqualification from audiences The GA4 destination supports user disqualification. * When a profile no longer qualifies for a Zeotap audience — because it fails the audience criteria, consent requirements, or another condition set on the audience — Zeotap issues a deletion request in the next refresh cycle for that audience-destination pair. * The disqualified profile is excluded from the audience based on the audience's configured refresh frequency. * Disqualification is programmatic. You do not configure anything to trigger it — Zeotap emits `zeotap_event_type: remove` for the profile, and the GA4 audience built with the `remove` exclusion condition drops the profile on the next GA4 audience evaluation. ## FAQ > [accordion] How long does it take for a Zeotap audience to appear in GA4? > > After you link a Zeotap audience to the GA4 destination, it can take up to one business day for the audience to become available at the GA4 seat. GA4-side processing of Measurement Protocol events adds additional latency on top of that — Google Analytics 360 accounts see lower latency than the free tier. See [Google's GA4 data-processing latency documentation](https://support.google.com/analytics/answer/1070983?hl=en#zippy=%2Cin-this-article). > [accordion] Do I need to do anything to remove a user who leaves the audience? > > No. When a profile stops qualifying for the audience, Zeotap emits `zeotap_event_type: remove` on the next refresh. Provided your GA4 Custom Audience uses the exclude-group described in [Build a GA4 audience from the zeotap_event](#build-a-ga4-audience-from-the-zeotap_event), the profile is dropped from the audience on the next GA4 evaluation. > [accordion] Which GA4 identifier does this integration send? > > The GA Client ID — the identifier stored in the GA `_ga` cookie on the browser. If you use the Zeotap Collect Tag through GTM, see [Google Analytics configuration in GTM](/articles/sdks/gtm/setup-guide/configuration/google-analytics) for how to capture the GA Client ID onto Zeotap profiles. > [accordion] Can I send Zeotap data to a mobile GA4 Data Stream? > > No. The integration supports the web implementation of GA4 only. The Data Stream you copy the Measurement ID from must be a Web stream. ## Next steps * [Explore the Google Universal Analytics integration →](/articles/integrate-customer/google-universal-analytics-integration) * [Explore Google Analytics Hub for BigQuery-based data sharing →](/articles/integrate-customer/google-analytics-hub) * [Explore GA4 configuration inside the Zeotap Collect Tag (GTM) →](/articles/sdks/gtm/setup-guide/configuration/google-analytics) * [Explore how to link an audience to any destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore identifier extension for destinations →](/articles/segment-customer/extend-your-audience#id-extension) # Google Analytics Hub Source: https://docs.zeotap.com/articles/integrate-customer/google-analytics-hub Read unified Zeotap profile, consent, ID and campaign data from your own Google Cloud project by subscribing to the BigQuery dataset Zeotap publishes privately on Google Analytics Hub. Google Analytics Hub is an **outbound** integration: Zeotap shares its unified customer data with your own Google Cloud project, where you subscribe to it as a linked dataset that you query in place, where you read it in BigQuery. It does not bring data into Zeotap CDP — to ingest data *from* BigQuery, use the [BigQuery source](/articles/integrate-customer/create-a-bigquery-source) instead. To have Zeotap write an audience into a BigQuery table you own, see the [Google BigQuery destination](/articles/integrate-customer/google-bigquery-destination). ## What this is Google Analytics Hub is a data exchange platform that lets you share data and insights at scale across organisations within a security and privacy framework. It acts as a marketplace for data, bringing together producers (Publishers) and consumers (Subscribers), and makes sharing efficient across organisational boundaries. Analytics Hub is built on BigQuery and uses the publish-and-subscribe model of BigQuery datasets. Because BigQuery separates compute from storage, a Publisher can share one dataset with as many Subscribers as it wants without making multiple copies of the data. Publishers are charged only for data storage; Subscribers pay only for the queries they run against the shared data. In this integration **Zeotap is the Publisher and you are the Subscriber**. Zeotap publishes the dataset privately on Analytics Hub, and your nominated users subscribe to it. The shared dataset is the Profile (Profile + ID) store hosted in Zeotap's Google BigQuery account, to which Zeotap grants you access. It gives you profile, consent, IDs and campaign-related data. Once the subscription is in place, you can leverage that data through any other data warehouse you use. ![Analytics Hub architecture: Zeotap's BigQuery project holding the Profile, Event and ID stores feeds a Publisher project, which lists the shared dataset on Analytics Hub; a Subscriber project consumes it as a linked dataset and queries it from BigQuery and BI tools](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/GAHub_int.jpg?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=98a683f5f12e14977dffdbf9cb1d2a58) The data you receive is already unified. Zeotap links identifiers from different data sources and devices into a single customer profile, based on the identifiers you send and the [ID strategy](/articles/unify-customer/configure-the-id-strategy) set on your account, in a way that is accurate, scalable and privacy compliant. Unlike the other integrations listed under [Destinations](/articles/integrate-customer/destinations), there is no self-service setup for Analytics Hub in the Zeotap CDP application. Access is granted by the Zeotap Support team on request, and every later step happens in your own Google Cloud project. ## Prerequisites > [!NOTE] > > Before you request access, confirm the following: > > * A **Google Cloud project** with BigQuery, in which your users will subscribe to the shared dataset. > * The users who will subscribe — individual or group — must have access to **Google Analytics Hub** on your GCP. > * The **email group address**, or the individual email addresses, of the users to be granted access. Zeotap recommends sending an email group; individual email addresses also work. ## Key concepts The Publisher-Subscriber model of Analytics Hub has four moving parts. Knowing them makes the setup steps below easier to follow. ### Shared dataset A shared dataset is a BigQuery dataset that is the unit of data sharing in Analytics Hub. In this integration, the shared dataset is the Profile (Profile + ID) store in Zeotap's BigQuery account. ### Data exchange A data exchange is a container that enables self-service data sharing. It contains listings that reference shared datasets. ### Listing A listing is a reference to a shared dataset that a Publisher lists in a data exchange. A listing can carry a dataset description, sample queries to run on the dataset, links to relevant documentation, and any additional information that helps Subscribers use the dataset. ### Linked dataset A linked dataset is a read-only BigQuery dataset that serves as a symbolic link to a shared dataset. Subscribing to a listing creates a linked dataset in your project rather than a copy of the dataset, so Subscribers can read the data but cannot add or update objects within it. For Google's own reference on all four concepts, see [Introduction to Analytics Hub](https://cloud.google.com/bigquery/docs/analytics-hub-introduction). ## Request access from Zeotap Support Enabling this integration is support-gated. You cannot turn it on yourself from the Zeotap CDP application. **Step 1** Raise a ticket with the Zeotap Support team at [support@zeotap.com](mailto:support@zeotap.com) to enable unified data sharing as per your requirement. **Step 2** Provide the email group address, or the individual email addresses, of the users who should be granted access to the shared dataset. An email group is recommended; individual addresses also work. **Step 3** Confirm that each of those users — individual or group — has access to Google Analytics Hub on your GCP. **Step 4** Wait for confirmation. The Zeotap Support team grants access to the email group address or the individual email addresses you shared with them. ## Subscribe to the shared dataset in BigQuery Once the Zeotap Support team has granted access, each nominated user completes the following in their own Google Cloud project. **Step 1** Log in to your Google BigQuery account and open **Analytics Hub**. ![The Analytics Hub page in the Google Cloud console, showing the Create Exchange and Search Listings actions](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/Zero.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=c663a815f5c4b95010d0ec64c57898fc) **Step 2** Click **Search Listings** and search through the datasets available to you. ![The Analytics Hub listings search, with the search box, the Filters panel and the results grid](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/One.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=0c2a84b57e2718f0e3b7bd0124420244) **Step 3** Navigate to the relevant listing and subscribe to it. Filtering **Listings** to **Private** narrows the results to the datasets shared privately with your project. ![Analytics Hub search results filtered to Private listings, showing the profile store listings shared with the subscriber](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/Two.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=b7782ba68ce5f43e8140be32aee66f10) **Step 4** Subscribing creates a linked dataset in your project and gives you access to the shared dataset. ## Verify the integration To check whether the integration is up and running, read the data from the linked dataset using the BigQuery SQL editor. Once you can query it, the dataset is ready to use for analytics and campaign creation. If the listing does not appear in **Search Listings**, or you cannot query the linked dataset, confirm with Zeotap Support that access was granted to the exact email group or individual address you are signed in with, and that the account has access to Google Analytics Hub on your GCP. ## Next steps * [Bring data from BigQuery into Zeotap with the BigQuery source →](/articles/integrate-customer/create-a-bigquery-source) * [Send an audience to a BigQuery table you own with the Google BigQuery destination →](/articles/integrate-customer/google-bigquery-destination) * [Explore the Google Analytics 4 destination →](/articles/integrate-customer/google-analytics-4) * [Explore how destinations work in Zeotap CDP →](/articles/integrate-customer/destinations) * [Explore how the ID strategy unifies your profiles →](/articles/unify-customer/configure-the-id-strategy) # Google BigQuery destination Source: https://docs.zeotap.com/articles/integrate-customer/google-bigquery-destination Send Zeotap CDP audience identifiers and attributes into a Google BigQuery table for warehousing and analytics. ## What this is The Google BigQuery destination writes audience data — identifiers and attributes — from Zeotap CDP into a table in your Google BigQuery dataset, where it can feed analytics, BI, and downstream personalisation workflows. Zeotap stages the exported records into a Google Cloud Storage bucket that you own and then loads them into the target BigQuery table, so the integration needs access to both a BigQuery dataset and a GCS bucket inside the same Google Cloud project. This page explains what to prepare in Google Cloud before configuring the destination, how to configure and verify it in Zeotap CDP, and the folder-path and column-type constraints the destination enforces. ## Prerequisites You need a Google Cloud project with BigQuery and Cloud Storage enabled, and the following information ready before you start. ### Project ID A unique string that differentiates your project from every other project on Google Cloud — for example, `my-sample-project-191923` for a project named **My Sample Project**. You can find or create it from the Google Cloud console [Dashboard page](https://console.cloud.google.com/projectselector2/home/dashboard). ### Dataset name The BigQuery dataset that will receive the data — for example, `GBQ_dataset`. Datasets are top-level containers that organise and control access to your tables and views. ### Table name The BigQuery table inside that dataset. Each table has a schema that describes its column names, data types, and other information. The Google BigQuery destination does not support tables whose schema contains a JSON-typed column. ### Bucket The name of the Google Cloud Storage bucket that Zeotap will stage exported files into before loading them into BigQuery. ### Folder The path inside the bucket where Zeotap writes the staged files. In Google Cloud Storage, a folder is a logical prefix on object names rather than a filesystem directory. Enter the folder path where Zeotap CDP can store your exported data — for example, `folder1/folder2/`. ### Service account and permissions A Google Cloud service account that Zeotap uses to stage files into your bucket and load them into your dataset. The service account needs the following permissions: * `bigquery.tables.create` * `bigquery.tables.get` * `bigquery.tables.update` * `bigquery.tables.updateData` * `bigquery.tables.delete` * `bigquery.jobs.create` * `storage.objects.get` * `storage.objects.list` * `storage.objects.create` * `storage.objects.update` * `storage.objects.delete` > [!NOTE] > > A **Service Account Owner** is the Google Cloud user account that holds owner privileges over the service account used for the integration — the account that can view, modify, and manage the credentials and permissions Zeotap CDP uses to reach your BigQuery data. If your setup uses a customer-supplied service account, generate a Service Account Key JSON in the Google Cloud console (Google's [Create and delete service account keys](https://cloud.google.com/iam/docs/keys-create-delete) guide walks through the exact steps) and store the downloaded key file securely. The key has the following shape, where `PRIVATE_KEY` is the private portion of the key pair: ```json theme={null} { "type": "service_account", "project_id": "PROJECT_ID", "private_key_id": "KEY_ID", "private_key": "-----BEGIN PRIVATE KEY-----\nPRIVATE_KEY\n-----END PRIVATE KEY-----\n", "client_email": "SERVICE_ACCOUNT_EMAIL", "client_id": "CLIENT_ID", "auth_uri": "https://accounts.google.com/o/oauth2/auth", "token_uri": "https://accounts.google.com/o/oauth2/token", "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs", "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/SERVICE_ACCOUNT_EMAIL" } ``` ## Supported identifiers, attributes, and actions You can send any identifier or attribute available in your Zeotap CDP audience to Google BigQuery through this destination. The destination exposes a single action — sending attributes and identifiers to Google BigQuery — and does not support the ID Extension, Delete, or Delta Upload features. ## Configure the Google BigQuery destination Create a new destination in Zeotap CDP and select Google BigQuery as the destination type. The configuration is provided in three parts: 1. **Identify the destination.** Give the destination a descriptive name and a destination instance name (an internal identifier that Zeotap uses for the destination). 2. **Provide the BigQuery target.** Enter the Project ID, dataset name, and table name you prepared above, along with the GCS bucket and folder path where Zeotap should stage export files. The folder path must satisfy the structure rules from the prerequisites. 3. **Confirm the service account.** In Step 1 **Destination Details**, the service account email that Zeotap CDP will use to reach your Google Cloud resources is displayed under **Account**. Confirm it holds every BigQuery and Cloud Storage permission listed in the prerequisites before continuing. ![Google BigQuery destination configuration form in Zeotap CDP](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-bigquery-destination/google-bigquery-destination-2025-03-20.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=70a8c2620023edad1331700044cd0474) > [!WARNING] > > The target BigQuery table's schema must not include any JSON-typed columns. Zeotap CDP does not support loading into tables that contain JSON columns. After the destination configuration is saved, map the identifiers and attributes you want to write into the BigQuery table's columns. Add as many mapping rows as you need to cover every column you want to populate. ![Mapping identifiers and attributes to Google BigQuery columns](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-bigquery-destination/google-bigquery-destination-2024-09-18-1.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=dc79bbdc9b1ccdfc1520b86f9c183265) ## Verify the destination works Link the destination to an audience and run a delivery. The destination is working when all three of the following are true: * The Google BigQuery destination is listed among your destinations in Zeotap CDP as available to link to audiences. * Files land in the configured GCS bucket under the folder path you specified after an audience is linked and activated. * Rows appear in the target BigQuery table for the mapped identifiers and attributes. > [!TIP] > > Bundle the eleven service-account permissions into a single custom IAM role in Google Cloud. A named role is easier to audit and re-apply than eleven individual grants, and it makes rotation across projects and environments predictable. ## Common configuration issues | Symptom | What it means | Where to look | | - | - | - | | Folder-path validation rejects the value | The folder path does not follow `folder_name/sub_folder_name/`, starts with `/`, or a segment does not end with `/` | The folder field in the destination configuration | | Target table contains a JSON column | The destination does not support tables whose schema includes a JSON-typed column | The target table's schema in the Google Cloud console | | Permission-denied errors when staging or loading | The service account is missing one of the required `bigquery.*` or `storage.*` permissions | The service account's IAM role bindings in Google Cloud | ## FAQ > [accordion] Does the target BigQuery table need to exist before I configure the destination? > > Provide a table name that matches the schema you want Zeotap to write into. The existing table's column names and data types determine which mappings will succeed. A table whose schema contains a JSON-typed column is not supported. > [accordion] Can I send data to a BigQuery table that has a JSON column? > > No. The destination does not support tables with JSON-typed columns. Store those fields in a supported scalar type (for example, `STRING`) in the target table's schema if you need to land them in BigQuery. > [accordion] Which identifiers and attributes can I send? > > Any identifier or attribute available in your Zeotap CDP audience can be mapped to a column in the target BigQuery table. > [accordion] What Google Cloud permissions does the service account need? > > The service account needs the eleven `bigquery.*` and `storage.*` permissions listed in the prerequisites — enough to create, update, and delete tables and to submit load jobs in BigQuery, and to read, list, create, update, and delete objects in the staging bucket. ## Next steps * [Explore how to link an audience to the destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore best practices for BigQuery →](/articles/integrate-customer/best-practices-for-bigquery) * [Explore how to create a BigQuery source →](/articles/integrate-customer/create-a-bigquery-source) * [Explore the Google Analytics Hub integration →](/articles/integrate-customer/google-analytics-hub) # Google Cloud Storage destination Source: https://docs.zeotap.com/articles/integrate-customer/google-cloud-storage Configure a Google Cloud Storage destination so Zeotap CDP delivers audiences to your bucket as CSV files. ## What this is Google Cloud Storage (GCS) is Google Cloud's object storage service. Connecting it as a Zeotap CDP destination lets you deliver an audience — its identifiers and any attributes you map — as CSV files into a folder inside a GCS bucket you own. Downstream, those files can drive campaign automation, personalisation, and optimisation in whatever system reads your bucket. This page walks through configuring the destination, choosing between the two send actions, understanding the file names Zeotap writes, verifying delivery, and resolving the configuration errors that block it. > [!NOTE] > > *Audiences* and *Segments* refer to the same thing throughout the Zeotap CDP UI — a group of customer profiles that match a set of criteria you define. ## Prerequisites Before you begin, gather the following: * A Google Cloud Storage account and a bucket you can write to. * The **bucket name** and the **folder path** inside that bucket where files should land. * Authentication: either the **Zeotap Service Account** (which you whitelist on your bucket) or a **client service account JSON** file you upload during configuration. * If you plan to encrypt files in transit, a PGP public key file. See [PGP encryption in destinations](/articles/integrate-customer/pgp-encryption-in-destinations). ### Supported identifiers This integration accepts MAIDs, hashed email addresses, hashed mobile numbers, and CRM IDs. You can send any number of identifiers and attributes per audience. ### Available actions and supported features | Action | [ID EXTENSION](/articles/segment-customer/extend-your-audience#id-extension) | [DELETE](https://docs.zeotap.com/articles/#!integrate-customer/delta-upload-and-delete-functions) | [DELTA UPLOAD](https://docs.zeotap.com/articles/#!integrate-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send identifiers to Google Cloud Storage(CSV) | ✅ | - | - | | Send CSV file to GCS | - | - | - | | Send CSV file to GCS (Soon to be deprecated) | - | - | - | | Send JSON file to GCS | - | - | - | ## Understand the destination components You configure three GCS-side details in Zeotap CDP: * **Bucket** — the name of your Google Cloud Storage bucket. You obtain it from your GCS console. ![Bucket name shown in the Google Cloud Storage console](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/gcs_bucket.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=27a98eddfc923035a9733033c5c0fc10) * **Folder** — a folder path inside the bucket. GCS does not have real folders; the folder concept is emulated by object key names containing `/` separators, which replicate a hierarchical arrangement. ![Folder path inside a bucket in the Google Cloud Storage console](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/gcs_folder.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=ee827f65a647fe9656d55c7b3a13717c) * **Account** — the identity Zeotap uses to write into your bucket. Choose either the Zeotap Service Account (which you then whitelist on your bucket) or upload a client service account JSON you manage. ## Configure the destination **1. Open the Destinations application** Log in to the Zeotap CDP App and open the **Destinations** application. **2. Start a new destination** Click **+ Create Destination**. ![Create Destination button in the Destinations application](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/ADOBE_DMP_3_\(1\).png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=562fa59a1a1e2b76442fa98f6e6f991e) **3. Select Google Cloud Storage** Under **All Destinations**, search for **Google Cloud Storage** and select it. ![Searching for Google Cloud Storage under All Destinations](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/ADOBE_DMP_4_\(1\).png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=653728565c7ed5863548171765d4086f) **4. Fill in the destination fields** On the right-hand side of the destination screen, provide the following values: a. A **name** for the destination. b. A value for **Destination Instance Name** — an internal field. c. The **Bucket** name of your Google Cloud Storage bucket. d. The **Folder** path inside that bucket where Zeotap CDP should write exported data. > [!NOTE] > > The folder path must: > > * Follow the structure `folder_name/sub_folder_name/`. > * Not start with a `/`. > * End with a `/` (both the folder name and any sub-folder name). e. A **Filename Prefix**. Enter a text value without spaces, underscores (`_`), or the symbols `# @ $ % & *`. The full file name follows the pattern shown in [Understand exported file names](#understand-exported-file-names) below. f. Under **Account**, choose either **Zeotap Service Account** or **Client Service Account Json** from the drop-down: ![Account drop-down with Zeotap Service Account and Client Service Account Json options](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/google-cloud-storage-2024-05-08.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=4035a760431f47f9e2282dd46a2e57d4) * **Zeotap Service Account** — the service account Zeotap will use auto-populates under **Service Account to be Whitelisted**. Whitelist it on your bucket in Google Cloud before saving so Zeotap CDP can push audiences to your bucket. ![Service Account to be Whitelisted auto-populated for the Zeotap Service Account](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/google-cloud-storage-2024-05-08-1.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=80b9f59a37bb2c7b8b83268ea131378a) * **Client Service Account Json** — use **+ Select File** to upload the JSON key for a service account you manage so that Zeotap CDP can push audiences to your bucket. ![Uploading a client service account JSON key using + Select File](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/google-cloud-storage-2024-05-08-2.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=a5bc85536732956d054503de1b2bc797) g. Under **Encryption Choice**, pick **Encrypt with PGP** or **Send without Encryption**. If you pick **Encrypt with PGP**, upload the public key under **Upload Public Key** using **+ Select File**. See [PGP encryption in destinations](/articles/integrate-customer/pgp-encryption-in-destinations). ![Encryption Choice set to Encrypt with PGP, with the Upload Public Key control below it](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/google-cloud-storage-2025-01-31.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=ee987cfe15afd49be9f5838c54d02e95) h. Review every value entered above, then click **Next** to proceed. ![Reviewing the destination values before clicking Next](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/google-cloud-storage-2025-01-31-1.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=b3b208c5f008d170813b8ef6bed8f209) **5. Choose the action and map fields** Under **Choose your Action**, pick one: * **Send identifiers to Google Cloud Storage(CSV)** — sends MAIDs and raw email addresses as a CSV file. ![The Choose your Action drop-down on the Google Cloud Storage destination](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/GCS_2.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=3ea2095f61ddb2135745ce8d77132fee) * **Send CSV file to GCS** — delivers the audience as a CSV file. * **Send JSON file to GCS** — delivers the audience as a JSON file. * **Send CSV file to GCS (Soon to be deprecated)** — an earlier CSV path. The label marks it for retirement, so do not choose it for a new destination. **6. Create the destination** Click **Create Destination**. The destination now appears in the **Audiences** application and can be linked to an audience. ## Verify the destination is working You know the destination is configured correctly when: 1. After you click **Create Destination**, it appears in the destination list inside the **Audiences** application. 2. After you link an audience to it (see [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination)) and the next audience refresh runs, CSV files land in your bucket under the folder path you configured. 3. The file names follow the naming pattern described below. ## Understand exported file names Zeotap CDP writes each activation as one or more CSV files. The name pattern is: ``` ${filenamePrefix}part-${sequence}_${destinationAudienceId}_${timestamp}.csv ``` The timestamp is the file generation time in epoch milliseconds (UTC), and `destinationAudienceId` is the ID Zeotap CDP assigns to the audience after it is linked to this destination. Example file name: ``` exportpart-0_894548842_1722931200000.csv ``` ![Channel ID on the audience matching the destinationAudienceId in the exported file name](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/integrate-customer/amazon-s3-destination/amazon-s3-destination-2025-08-06-1.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=9815ce4ace2add60e912e2a98028d8d4) The parts of the name are: | Variable | Description | | :- | :- | | `filenamePrefix` | The prefix you set on the **Filename Prefix** field, which indicates the context or purpose of the file (for example, the segment or export type). | | `part-${sequence}` | A sequential identifier for the part number when the export is split across multiple files. | | `${destinationAudienceId}` | The unique ID Zeotap CDP assigns to the audience after it is linked to a destination. | | `${timestamp}` | The time the file was generated, in epoch milliseconds (UTC) — for example, `1722931200000`. | | `.csv` | CSV (comma-separated values) file extension. | ### Multipart uploads When a file is uploaded in multiple parts, the name pattern is: ``` {partNumber}_{filenamePrefix}{fileNumber}_${channelId}_${timestamp}.csv ``` Where: * `partNumber` — the index of the part in the multipart upload. `Part0` is the first part. * `channelId` — the ID Zeotap CDP assigns to the audience after it is linked to this destination. * `${timestamp}` — the timestamp in epoch milliseconds. ![Channel ID displayed on the audience details in the Audiences application](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/google-cloud-storage-2024-05-08-3.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=ab92718b7e470b1333769c4f5a6b2eb6) Worked example — an audience named `PublicAbove18` with **Channel ID** `12345678`, **Filename Prefix** `testprefix`, and **file number** `98765`, uploaded as the first part of a multipart upload at epoch milliseconds `1625138600`: ``` Part0_testprefix98765_12345678_1625138600.csv ``` ## Why this happens When a Google Cloud Storage destination misbehaves, check the destination configuration and the bucket-side permissions. Match your symptom to a row below and inspect the location listed: | Symptom | What it means | Where to look | | :- | :- | :- | | Files do not arrive in your bucket after an audience refresh | The account selected under **Account** does not have write access to your bucket — either the Zeotap Service Account was never whitelisted on the bucket, or the client service account JSON you uploaded lacks write access. | Your bucket's IAM configuration in Google Cloud; the **Account** and **Service Account to be Whitelisted** values on the destination. | | The destination configuration is rejected on the folder path | The **Folder** value starts with `/`, or a folder or sub-folder segment does not end with `/`. | The **Folder** field on the destination configuration. | | The destination configuration is rejected on the filename prefix | The **Filename Prefix** contains a space or one of `# @ $ % & *`. | The **Filename Prefix** field on the destination configuration. | | Files arrive but cannot be decrypted on your side | **Encryption Choice** is set to **Encrypt with PGP** and the uploaded PGP public key does not match the private key you decrypt with. | The **Encryption Choice** field on the destination configuration; the private key on the system reading your bucket. | | Attributes are missing from delivered files | The action **Send identifiers to Google Cloud Storage(CSV)** was selected. That action delivers MAIDs and raw email addresses only — not attributes. | The **Choose your Action** selection on the destination. | ## When to contact support Contact Zeotap Support if: * You corrected the configuration above, whitelisted the Zeotap Service Account on the bucket, and files still do not arrive after the next audience refresh. * Files land in the bucket but their contents do not match the identifiers and attributes you mapped. * You see an error on the destination or on the linked audience that does not match any row in the table above. Include in your request: * The destination name and the `destinationAudienceId` visible on the audience in the **Audiences** application. * The bucket name and folder path you configured. * Whether you chose **Zeotap Service Account** or **Client Service Account Json** under **Account**. * The timestamp of the last audience refresh you expected files from. * A sample file name (if any files arrived) or a screenshot of the destination configuration. ## FAQ > [accordion] Which identifier types can I send to Google Cloud Storage? > > MAIDs, hashed email addresses, hashed mobile numbers, and CRM IDs. There is no cap on the number of identifiers or attributes you send per audience. > [accordion] Do I have to whitelist the Zeotap Service Account? > > Only if you pick **Zeotap Service Account** under **Account**. If you choose **Client Service Account Json** and upload your own service account key, that account's own bucket permissions apply instead. > [accordion] Can I encrypt the files Zeotap writes to my bucket? > > Yes. Set **Encryption Choice** to **Encrypt with PGP** during configuration and upload a PGP public key. See [PGP encryption in destinations](/articles/integrate-customer/pgp-encryption-in-destinations) for the full setup. > [accordion] What is the difference between `destinationAudienceId` and `channelId` in the file name? > > They refer to the same ID — the identifier Zeotap CDP assigns to the audience after you link it to this destination. `destinationAudienceId` appears in the single-file naming pattern, and `channelId` appears in the multipart naming pattern. ## Next steps * [Explore how to link an audience to this destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore PGP encryption for destinations →](/articles/integrate-customer/pgp-encryption-in-destinations) * [Explore the Google BigQuery destination →](/articles/integrate-customer/google-bigquery-destination) * [Explore using Google Cloud Storage as a source →](/articles/integrate-customer/zeotap-google-cloud-storage) # Google Customer Match (Customer Contact Information) Source: https://docs.zeotap.com/articles/integrate-customer/google-customer-match-customer-contact-information Send hashed email addresses and hashed phone numbers from Zeotap CDP to Google Ads or Display & Video 360 as Customer Match customer lists. ## What this is Google Customer Match (Customer Contact Information) is a **batch destination**: it sends hashed email addresses and hashed phone numbers **out of Zeotap CDP into your Google Ads or Google DV360 (Display & Video 360) account**, where they arrive as Customer Match customer lists you can target or suppress in campaigns. You build the audience in Zeotap CDP, link it to this destination, and Zeotap CDP uploads the identifiers on the audience's refresh schedule. Google Customer Match lets you use first-party data to share the unique insights you have about your customers beyond Google's understanding. That can deepen existing customer relationships — or build new ones — across Google's properties in a [privacy-safe way](https://blog.google/products/ads-commerce/a-more-privacy-first-web). This is becoming increasingly important as Google phases out cookie-based re-marketing due to privacy, browser and regulation changes. Related pages for the same vendor: * To send **mobile advertising IDs** instead of contact information, use [Google Customer Match (Mobile Device IDs)](/articles/integrate-customer/google-customer-match-mobile-device-ids). * To collect website events **into** Zeotap CDP using a Google tag container, see the [Google Tag Manager source](/articles/integrate-customer/google-tag-manager). > [!NOTE] > > **Important Notice:** > > To ensure compliance with the [EU user consent policy](https://www.google.com/about/company/user-consent-policy/) and continue accessing Customer Match within the European Economic Area (EEA), Google is enhancing its enforcement measures. Google requires its partners to update to the latest `Google Ads API v15` and begin transmitting consent signals for users in the EEA region. The following are the consent signals it covers: > > * `ad_user_data`: Indicates consent to send user data for advertising purposes to Google. > * `ad_personalization`: Indicates consent for ad personalisation. > > Note that commencing March 6th, 2024, Zeotap CDP will transmit a GRANTED consent status for the above mentioned consent signals. To ensure that only consented users meet the audience criteria, you are advised to perform the following actions: > > * Provide Zeotap CDP with the appropriate consent parameters covering the two consent signals requested by Google (`ad_user_data` and `ad_personalization`) > * Establish relevant Consent Orchestration rules to ensure that only users who have consented to perform ad personalisation on Google Products are ingested. > > **Note:** For the frequently asked questions about the consent update, refer to [FAQs related to Google Consent Update](/articles/integrate-customer/faqs-related-to-google-consent-update). ### Where the audience can be used Customer Match is a useful advertising tool for many business goals, from increasing brand awareness to driving conversions. Audiences sent through this destination can be used as follows: * On the **Search Network and the Shopping tab**, you can optimise your campaigns by adjusting your bid based on what you know about your customers' activities. * On **Gmail**, you can reach your customers or similar audiences using personalised ads at the top of their inbox tabs. * On **YouTube**, you can reach new audiences by targeting audiences similar to your most valuable customers. * On **Display**, you can reach your customers or similar audiences using personalised ads on the Google Display Network. ### Common uses * **Re-engage known customers.** Upload email addresses from your CRM into Zeotap CDP, build tailored audience segments, and send them to Google Customer Match for targeted campaigns across Search, the Shopping tab, Gmail, YouTube and Display. * **Suppress ads.** Create suppression segments in Zeotap CDP for existing customers, or for people who do not wish to be targeted, and send them to Google Customer Match so those audiences are excluded from ad campaigns. * **Reach similar prospects.** Identify high-value customer segments in Zeotap CDP and send them to Google Customer Match to build lookalike audiences, allocating higher budgets to those segments and lower cost limits to low-LTV audiences. ## Supported identifiers and actions This integration supports hashed phone numbers in E164 format and hashed email addresses (mostly Gmail). > [!NOTE] > > **Note:** > > *Follow these guidelines to ensure proper data handling and audience segmentation when using Customer Match:* > > * Ensure that the emails are hashed to `SHA256` and cellphone numbers are converted to `E164` format before hashing it to `SHA256`. For more information about how to convert it to `E164`, refer to our [hashing guidelines](/articles/unify-customer/hashing-guidelines). > * When you send multiple identifiers, such as email addresses, phone numbers, and MAIDs, to Customer Match, Zeotap CDP creates multiple audience segments within GCM (AdWords), each with a unique segment ID. The data is uploaded to the corresponding segments based on these IDs. The segment IDs are displayed separately on the UI. The segment name in AdWords for the identifiers appears in the following format: `{AudienceName}{DestinationName}_SegmentId` ### Available actions and supported features The following table lists the action types available for the integration and their supported features: | Action Name | [AUDIENCE BOOST](/articles/segment-customer/audience-boost) | [DELETE](/articles/segment-customer/delta-upload-and-delete-functions) | [DELTA UPLOAD](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send Multiple User Identifiers | ✅ | ✅ | - | | Send identifiers to Google Customer Match - Customer Contact Information | ✅ | ✅ | - | Delta and Delete functionality is released in phases and is activated per destination — see [Delta Upload and Delete Functions](/articles/segment-customer/delta-upload-and-delete-functions), which lists this integration under the Delete-enabled integrations and describes how activation is requested. ## Prerequisites Customer Match is not available for all advertisers. To use Customer Match, the account must have the following details: * A good history of policy compliance * A good payment history * At least 90 days history in Google Ads * More than 50,000 USD total lifetime spend. For advertisers whose accounts are managed in currencies other than USD, your spend amount will be converted to USD using the average monthly conversion rate for that currency. For complete information about the requirements for using Google Customer Match, refer to the [Google Help documentation](https://support.google.com/google-ads/answer/6299717). These guidelines apply to advertisers using Customer Match for campaigns on Search, Shopping, Display, YouTube or Gmail. Ensure that you have the below details available before creating a Google Customer Match destination in Zeotap CDP. ### Seat ID This is the unique ID assigned to your Advertiser account that you can locate next to your account name within the respective Google products. Note that you can add a Seat ID for Google Ads and Google DV360 through this integration. Depending on the product that your Seat ID is associated with, you have to choose the corresponding Product Type. ![The Google Ads top navigation bar. The account identifier that sits beside the account name in the header is outlined with a box and marked with an arrow, showing where in the interface to look for it.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/google-customer-match/google-customer-match-2024-12-10-1.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=7bebd7b52745c1ad574d096b9436af31) ### Product type Based on the platform you want to use and your role, choose the Google product that matches your requirement. You can either use **Google Ads (AdWords)** or **Google DV360 (Display & Video 360).** * If you are using **Google Ads**, then choose **ADWORDS** as your Product Type. This allows you to serve ad campaigns on Search, the Shopping tab, Gmail, YouTube and Display. * If you are using **Google DV360**, a demand-side platform (DSP) for managing and optimising digital ad campaigns across channels like display, video, and connected TV, then choose from the below options. * **INVITE_PARTNER —** Select this option if you are a **Bid Manager Partner**. A Partner manages multiple advertiser accounts under a single account, typically used by agencies or organisations handling campaigns for multiple clients. * **INVITE_ADVERTISER —** Select this option if you are a **Bid Manager Advertiser**. An Advertiser represents a single brand or organisation running its own campaigns in DV360. **Key differences between a Partner and an Advertiser in DV360** | **Aspect** | **Bid Manager Partner** | **Bid Manager Advertiser** | | :- | :- | :- | | **Role** | Manages and oversees multiple advertisers. | Represents a single advertiser's account. | | **Hierarchy** | Higher-level entity in the DV360 structure. | Sub-account within a partner. | | **Responsibilities** | Sets policies, manages billing, and organises advertisers. | Focuses on campaign creation and execution. | | **Use Case** | Agencies or organisations managing several clients or business units. | Individual brands or advertisers. | ## Whitelist Zeotap on your Google product To send audiences (segments) from Zeotap CDP to Google Ads or DV360, you must first whitelist Zeotap on the platform you wish to use. Whitelisting is required for successful audience/segment creation; without it, the segments will fail. Follow the instructions below for the platform you use: * [Whitelist Zeotap on Google Ads](#whitelist-zeotap-on-google-ads) * [Whitelist Zeotap on Google DV360](#whitelist-zeotap-on-google-dv360) ### Whitelist Zeotap on Google Ads To send audience segments from Zeotap CDP to Google Ads, ensure that you whitelist Zeotap CDP by performing the following steps: **Step 1** Log into your **Google Ads** account. **Step 2** In the left panel, navigate to **Tools** > **Data manager**. **Step 3** Under **Data manager**, open the **Connected products** tab, then click **+ Connect Product** as shown below. ![The Google Ads Data manager page on the Connected products tab, with annotations marking Data manager in the Tools menu and the + Connect Product button. The Connected products list shows YouTube and Zeotap entries.](https://mintcdn.com/zeotap/Hq-UxQPMElXbNbMd/articles/integrate-customer/Storage/integrate-customer/google-customer-match-customer-contact-information/google-customer-match-customer-contact-information-2025-01-17-3.png?fit=max\&auto=format\&n=Hq-UxQPMElXbNbMd\&q=85\&s=362a43dee27052c91eec817bc81aba0c) **Step 4** In the search box, search for and select Zeotap, then click **Authorise**. ![The Connect a product dialog in Google Ads. The Data source search box contains the text Zeotap and a matching Zeotap result appears in the dropdown, with an annotation reading 'Select Zeotap and click Authorise'. A grid of other available data sources sits below.](https://mintcdn.com/zeotap/Hq-UxQPMElXbNbMd/articles/integrate-customer/Storage/integrate-customer/google-customer-match-customer-contact-information/google-customer-match-customer-contact-information-2025-01-17-1.png?fit=max\&auto=format\&n=Hq-UxQPMElXbNbMd\&q=85\&s=0534bc496e3fa7f07630f280832de4c0) **Step 5** Once the data source is connected, the dialog shows **Data source connected** with **Audiences** selected as the use case. The **Conversions** use case is unavailable for this data source. Click **Done**. You can then use Zeotap CDP to create and send audiences to Google Ads as Customer Lists. ![The Connect a product dialog in Google Ads showing Zeotap as the data source with a green 'Data source connected' confirmation, the Audiences use case selected, an Audience Segments section explaining that segments created in Zeotap appear in Audience manager as customer lists, and a Done button.](https://mintcdn.com/zeotap/Hq-UxQPMElXbNbMd/articles/integrate-customer/Storage/integrate-customer/google-customer-match-customer-contact-information/google-customer-match-customer-contact-information-2025-01-17-2.png?fit=max\&auto=format\&n=Hq-UxQPMElXbNbMd\&q=85\&s=7c470a8c88d4fd38647e06fbdbc51bc8) ### Whitelist Zeotap on Google DV360 You must complete a one-time mapping of your DV360 Partner or Advertiser ID to Zeotap before Zeotap CDP can send any data into DV360. Also, make sure you know which DV360 entity object (Partner or Advertiser) you are associated with, so that the matching Product Type — INVITE_PARTNER or INVITE_ADVERTISER — is selected when you create the destination. Perform the following steps to link Zeotap to your DV360 account: **Step 1** Log into your DV360 account with the appropriate credentials. **Step 2** Navigate to **Partner Settings** and select **Linked Accounts**. **Step 3** Under **Linked Accounts**, click **LINK NEW ACCOUNT** and select External Data partner. ![The Display & Video 360 Linked Accounts page under Partner Settings, with Linked Accounts highlighted in the left menu and the LINK NEW ACCOUNT control outlined. The panel reads 'Data sharing settings for Audience tab and Ads Data Hub' and 'No linked accounts found'.](https://mintcdn.com/zeotap/Hq-UxQPMElXbNbMd/articles/integrate-customer/Storage/integrate-customer/google-customer-match-customer-contact-information/gcm_cci_6.png?fit=max\&auto=format\&n=Hq-UxQPMElXbNbMd\&q=85\&s=6665a1cef1e3cdbcf4ba2314d8afc060) **Step 4** Under **Account**, search for Zeotap. **Step 5** Select **CMU: Zeotap** (Customer Match Upload: Zeotap) as shown below and click **Link**. ![The Link External Data Partner dialog in Display & Video 360. The Account search box contains 'zeotap' and the results list shows two entries, DMP: Zeotap and CMU: Zeotap, with an arrow pointing at CMU: Zeotap.](https://mintcdn.com/zeotap/Hq-UxQPMElXbNbMd/articles/integrate-customer/Storage/integrate-customer/google-customer-match-customer-contact-information/gcm_cci_7.png?fit=max\&auto=format\&n=Hq-UxQPMElXbNbMd\&q=85\&s=8cdac6ba87c92d76127188acfd15d76f) Mapping of Zeotap CMU by Google on their interface **Step 6** Once you complete the linking process, the Zeotap account appears under the linked accounts. ## Create the Google Customer Match (Customer Contact Information) destination Once you have completed the prerequisites above, perform the following steps to create the destination in Zeotap CDP: **Step 1** Log into the Zeotap CDP App and go to **Integrate** > **Destinations**. **Step 2** Click **+ Create Destination.** ![The Zeotap CDP Destinations list under Integrate, on the Private Destination tab, with the + Create Destination button outlined. The table columns are ID, Destination Name, Created Date, Last Updated On and Created By.](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_1.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=92dfe8ecb29e59c9d7d57cb954e54618) **Step 3** Under **All Destinations**, search for **Google Customer Match (Customer Contact Information)**. ![The All Destinations catalogue in Zeotap CDP with the 'Search for a Destination' box outlined, above a grid of destination tiles such as Adform, Adobe DMP, Airship Static Lists and AmazonDSP.](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_2.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=6f5f0f5367788fb4e9e946f4b3cb5874) **Step 4** Click **Google Customer Match (Customer Contact Information)**. A screen appears displaying details about the particular destination towards the left. On the right-hand side of the screen you will find the fields required for the integration to be established. Enter the required details as mentioned in the following steps: a. Enter a name for the Destination under **Destination Name**. b. Enter the **Seat ID** of the account on which you want the segment. [Learn more](#seat-id) c. Select the appropriate **Product Type** that the Seat ID belongs to. [Learn more](#product-type) d. Click **Next** to proceed to mapping. ![The 'Enter Destination Details' step of the Google Customer Match - Customer Contact Information destination in Zeotap CDP, showing the Destination Name, Seat ID and Product Type fields with ADWORDS chosen as the Product Type, a note that segments can take up to three business days to appear at the seat, and Back and Next buttons.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/google-customer-match-customer-contact-information/google-customer-match-customer-contact-information-2023-11-08-1.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=b46a877b92a73b697dc6f5f487099320) **Step 5** In the new screen that appears, choose the appropriate action and mapping as explained below. a. Under **Choose your Action**, you can choose either **Send Identifiers to Google Customer Match - Customer Contact Information** or **Send Multiple User Identifiers** as the action, based on your use case. i. If you choose **Send Identifiers to Google Customer Match - Customer Contact Information**, then the output identifiers `email addresses` and `cellphone numbers` are populated. Note that in this action, each identifier is sent as an individual user profile. ![The Mapping step in Zeotap CDP with 'Send identifiers to Google Customer Match - Custom...' chosen under Choose your Action, and an Output Identifiers Mapping table pairing the Cellphone Number E164 catalogue field with the Mobile E164 destination field and the Email SHA256 catalogue field with the Email destination field.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/google-customer-match-customer-contact-information/google-customer-match-customer-contact-information-2023-11-08-2.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=a334375a4cab319d4ab693a4fed8b799) ii. If you choose **Send Multiple User Identifiers** as your action, then the output identifiers such as `Hashed email address`, `Hashed cellphone numbers`, `last name`, `first name`, `Country Code` and `Postal Code` are populated. Note that in this action, all the identifiers selected under the mapping screen are sent as a single user profile. > [!NOTE] > > **Note:** > > *To increase the match rate, we recommend that you use **Send Multiple User Identifiers** as the action.* ![The Mapping step in Zeotap CDP with Send Multiple User Identifiers chosen under Choose your Action, and a 'Map the Fields' table under Identifiers pairing catalogue fields with the Email, Mobile E164 and Country Code destination fields.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/google-customer-match-customer-contact-information/google-customer-match-customer-contact-information-2024-05-21.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=e1f5bb93c411e903465c686abe97a3f8) **Step 6** Click **Create Destination**. The created Destination gets listed in the **Audiences** application, where it can be linked to an Audience/segment. ## Link an audience to the destination For information about how to link an Audience or segment to the created Destination in the **Audiences** application, refer to [Activate Your Batch Audiences](/articles/integrate-customer/link-an-audience-to-the-destination). It can take up to three business days for the segment to be available at the Google Customer Match (Customer Contact Information) seat. Note that the segments created on GCM appear in the format: `{Audience Name}_{Audience Id}`. > [!NOTE] > > **Note:** > > The terms Audiences and Segments are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an Audience or a segment can be a specific group of customers who are over 18 years of age and have performed an `addToCart` event within the last 30 days. ### User disqualification from audiences This integration supports user disqualification from audiences. That is, a user can be disqualified from an audience (segment) for various reasons, such as not meeting audience criteria, consent requirements or other conditions set for a particular audience. * When a user disqualifies from an audience, Zeotap CDP initiates a user deletion request in the next refresh cycle. These requests are sent to the audiences linked to the specific destination. * The disqualified users are excluded from the audiences based on the configured refresh frequency for a particular audience. * User disqualification is a programmatic process that works automatically. You do not need to specify anything to trigger the disqualification and exclusion of users from audiences. > [!NOTE] > > **Note:** > > *For more information about this functionality, refer to [Delta Upload and Delete Functions](/articles/segment-customer/delta-upload-and-delete-functions).* ## Verify the segments reached Google Ads Perform the following steps to view the segments pushed to Google Ads: **Step 1** Log into your Google Ads account. **Step 2** In the left panel, navigate to **Tools.** **Step 3** Under **Shared library**, select **Audience manager**. **Step 4** Under **Your data segments**, you can view the list of all the segments pushed. You can find the 'Customer list' for any segment pushed through Google Ads along with the customer contact information tied to the particular segment under the **Customer Type** column. For example, Customer list (Mobile Device IDs) or Customer list (Customer contact information). ![The Google Ads Audience manager on the 'Your data segments' tab, reached from Shared library in the Tools menu. The table lists segments with Segment name, Customer Type, Segment Type, Membership status and per-network size columns.](https://mintcdn.com/zeotap/Hq-UxQPMElXbNbMd/articles/integrate-customer/Storage/integrate-customer/google-customer-match-customer-contact-information/google-customer-match-customer-contact-information-2024-12-17.png?fit=max\&auto=format\&n=Hq-UxQPMElXbNbMd\&q=85\&s=9f68d97986dbfd032ea5a26014142203) ## Troubleshoot Google Customer Match deliveries | Symptom | What to check | | :- | :- | | Segment or audience creation fails on the Google side | Confirm that Zeotap is whitelisted on the platform you are sending to. See [Whitelist Zeotap on your Google product](#whitelist-zeotap-on-your-google-product). | | The segment has not appeared at the seat yet | Allow up to three business days after linking the audience — see [Link an audience to the destination](#link-an-audience-to-the-destination). | | You cannot find the segment under its audience name | Segments are renamed on upload. Segments created on GCM appear as `{Audience Name}_{Audience Id}`; where multiple identifiers are sent, the note under [Supported identifiers and actions](#supported-identifiers-and-actions) documents the format `{AudienceName}{DestinationName}_SegmentId`. | | More segments appear in GCM than you expected | When you send multiple identifiers, Zeotap CDP creates multiple audience segments within GCM, each with its own segment ID, and uploads the data to the corresponding segment. The segment IDs are displayed separately on the UI. | | The match rate is lower than expected | Check that emails are hashed to `SHA256` and that cellphone numbers are converted to `E164` before hashing — see the [hashing guidelines](/articles/unify-customer/hashing-guidelines). Using **Send Multiple User Identifiers** as the action is recommended to increase the match rate. | | Users disappear from a segment without a change on your side | This is user disqualification working as designed: disqualified users are removed on the audience's configured refresh frequency. See [User disqualification from audiences](#user-disqualification-from-audiences). | | EEA users are not being matched | Check that you are providing consent parameters covering `ad_user_data` and `ad_personalization`, and that your Consent Orchestration rules admit only users who consented to ad personalisation on Google products. See [FAQs related to Google Consent Update](/articles/integrate-customer/faqs-related-to-google-consent-update). | | The delivery itself failed in Zeotap CDP | Open the audience–destination pair and read the recorded error. The common destination delivery errors and what they mean are listed in [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail), along with [when to contact support](/articles/integrate-customer/destinations#when-to-contact-support). | ## Next steps * [Send mobile advertising IDs to Google Customer Match →](/articles/integrate-customer/google-customer-match-mobile-device-ids) * [Read the FAQs on the Google consent update →](/articles/integrate-customer/faqs-related-to-google-consent-update) * [Review the hashing guidelines for emails and phone numbers →](/articles/unify-customer/hashing-guidelines) * [Understand delta uploads and deletes →](/articles/segment-customer/delta-upload-and-delete-functions) * [Boost match rates with Audience Boost →](/articles/segment-customer/audience-boost) * [Learn how destinations work in general →](/articles/integrate-customer/destinations) # Google Customer Match (Mobile Device IDs) Source: https://docs.zeotap.com/articles/integrate-customer/google-customer-match-mobile-device-ids Send audiences of mobile advertising IDs (MAIDs) from Zeotap CDP to Google Customer Match for Google Ads or DV360 campaigns. > [!NOTE] > > **Important — EU consent enforcement** > > To comply with the [EU user consent policy](https://www.google.com/about/company/user-consent-policy/) and continue accessing Customer Match within the European Economic Area (EEA), Google requires partners to use `Google Ads API v15` and transmit consent signals for EEA users: > > * `ad_user_data` — consent to send user data to Google for advertising purposes. > * `ad_personalization` — consent for ad personalisation. > > Since March 6th, 2024, Zeotap CDP transmits a `GRANTED` consent status for both signals. To ensure only consented users meet the audience criteria, you must: > > * Provide Zeotap CDP with consent parameters covering `ad_user_data` and `ad_personalization`. > * Configure Consent Orchestration rules so only users who consented to ad personalisation on Google products are ingested. > > For the frequently asked questions about this update, see the [Google consent update FAQs](/articles/integrate-customer/faqs-related-to-google-consent-update). ## What this is Google Customer Match lets you target your own first-party customer data in Google Ads and Display & Video 360 (DV360) campaigns across Search, the Shopping tab, Gmail, YouTube, and the Google Display Network. This integration sends **mobile advertising IDs (MAIDs)** — the IDFA on iOS and the AAID on Android — from a Zeotap CDP audience into Google Customer Match, where each audience becomes a Customer List you can attach to campaigns. Use this integration when your source data is app-level MAIDs; for email- or phone-based matching, use [Google Customer Match (Customer Contact Information)](/articles/integrate-customer/google-customer-match-customer-contact-information) instead. Because MAIDs are device-level identifiers, Zeotap does not extend MAID-based segments — MAID uploads are accepted only when they are first-party data that you onboarded. ## Prerequisites Gather the following before you create the destination. Each item is required — the destination will not save without them. > [!NOTE] > > **You need:** > > * A Google Customer Match–eligible advertiser account. Google's eligibility criteria: a good policy-compliance history, a good payment history, at least 90 days of history in Google Ads, and more than 50,000 USD in total lifetime spend (converted at the monthly average rate for non-USD accounts). See the [Google Help documentation](https://support.google.com/google-ads/answer/6299717?hl=en\&ref_topic=10551292) for the full policy. > * Your **Seat ID** — the numeric ID next to your account name in Google Ads or DV360. > * Your **App ID** — the identifier of the mobile app the MAIDs were collected from. Formats: > * **iOS**: the 9-digit ID at the end of the App Store URL. For `http://itunes.apple.com/us/app/flood-it!-2/id476943146`, the App ID is `476943146`. > * **Android**: the app package name. For `https://play.google.com/store/apps/details?id=com.labpixies.colordrips`, the App ID is `com.labpixies.colordrips`. > * Your **Product Type**, matching where the Seat ID lives: > * `ADWORDS` — for Google Ads (Search, Shopping, Gmail, YouTube, Display). > * `INVITE_PARTNER` — for a DV360 **Bid Manager Partner** (an agency or organisation managing several advertisers). > * `INVITE_ADVERTISER` — for a DV360 **Bid Manager Advertiser** (a single brand running its own campaigns). > * Zeotap whitelisted on your Google Ads or DV360 account (one-time — steps below). > * Consent parameters for `ad_user_data` and `ad_personalization` ingested into Zeotap CDP for EEA users, with matching Consent Orchestration rules. **Choosing between INVITE_PARTNER and INVITE_ADVERTISER (DV360 only)** | Aspect | Bid Manager Partner (`INVITE_PARTNER`) | Bid Manager Advertiser (`INVITE_ADVERTISER`) | | :- | :- | :- | | Role | Manages and oversees multiple advertisers. | Represents a single advertiser's account. | | Hierarchy | Higher-level entity in the DV360 structure. | Sub-account within a partner. | | Responsibilities | Sets policies, manages billing, organises advertisers. | Campaign creation and execution. | | Use case | Agencies or organisations managing several clients or business units. | Individual brands or advertisers. | ## Supported identifiers and actions This destination accepts **MAIDs only** (IDFA and AAID). Zeotap does not add identifier extensions to MAID-based segments — uploads must be first-party data that you onboarded. | Action | ID Extension | Delete | Delta Upload | | :- | :-: | :-: | :-: | | Send identifiers to Google Customer Match — Mobile Device IDs | ✅ | ✅ | — | For Delete behaviour, see [Delta Upload and Delete functions](/articles/integrate-customer/delta-upload-and-delete-functions). ## Whitelist Zeotap on Google Ads Zeotap must be an authorised data source on your Google Ads account before any audience push succeeds. Without this step, audience creation on the Google side fails. **Step 1** Sign in to your Google Ads account. **Step 2** In the left panel, open **Tools** > **Data Manager**. **Step 3** Under **Data Manager**, open the **Connected products** tab and click **+ Connect Product**. ![Connected products tab in Google Ads Data Manager with the + Connect Product button](https://mintcdn.com/zeotap/Hq-UxQPMElXbNbMd/articles/integrate-customer/Storage/integrate-customer/google-customer-match-customer-contact-information/google-customer-match-customer-contact-information-2025-01-17-3.png?fit=max\&auto=format\&n=Hq-UxQPMElXbNbMd\&q=85\&s=362a43dee27052c91eec817bc81aba0c) **Step 4** Search for **Zeotap**, select it, and click **Authorise**. ![Searching for Zeotap and authorising it as a connected product in Google Ads](https://mintcdn.com/zeotap/Hq-UxQPMElXbNbMd/articles/integrate-customer/Storage/integrate-customer/google-customer-match-customer-contact-information/google-customer-match-customer-contact-information-2025-01-17-1.png?fit=max\&auto=format\&n=Hq-UxQPMElXbNbMd\&q=85\&s=0534bc496e3fa7f07630f280832de4c0) **Step 5** Confirm the connection. Zeotap appears under **Connected products**, and you can send audiences from Zeotap CDP as Customer Lists. ![Zeotap listed under Connected products in Google Ads](https://mintcdn.com/zeotap/Hq-UxQPMElXbNbMd/articles/integrate-customer/Storage/integrate-customer/google-customer-match-customer-contact-information/google-customer-match-customer-contact-information-2025-01-17-2.png?fit=max\&auto=format\&n=Hq-UxQPMElXbNbMd\&q=85\&s=7c470a8c88d4fd38647e06fbdbc51bc8) ## Whitelist Zeotap on Google DV360 For DV360, perform a one-time mapping of your Advertiser or Partner ID to Zeotap. This mapping tells Google whether to route data to the `INVITE_PARTNER` or `INVITE_ADVERTISER` product in the API service. **Step 1** Sign in to DV360. **Step 2** Open **Partner Settings** and select **Linked Accounts**. **Step 3** Under **Linked Accounts**, click **LINK NEW ACCOUNT** and select **External Data partner**. ![Linking a new external data partner account under Linked Accounts in DV360](https://mintcdn.com/zeotap/Hq-UxQPMElXbNbMd/articles/integrate-customer/Storage/integrate-customer/google-customer-match-customer-contact-information/gcm_cci_6.png?fit=max\&auto=format\&n=Hq-UxQPMElXbNbMd\&q=85\&s=6665a1cef1e3cdbcf4ba2314d8afc060) **Step 4** Under **Account**, search for **Zeotap**. **Step 5** Select **CMU: Zeotap** (Customer Match Upload: Zeotap) and click **Link**. ![Selecting CMU: Zeotap (Customer Match Upload) in the DV360 account search](https://mintcdn.com/zeotap/Hq-UxQPMElXbNbMd/articles/integrate-customer/Storage/integrate-customer/google-customer-match-customer-contact-information/gcm_cci_7.png?fit=max\&auto=format\&n=Hq-UxQPMElXbNbMd\&q=85\&s=8cdac6ba87c92d76127188acfd15d76f) **Step 6** Confirm the link. Zeotap appears under your linked accounts and can push audiences into DV360. ## Create the destination in Zeotap CDP **Step 1** Sign in to the Zeotap CDP app and open the **DESTINATIONS** application. **Step 2** Click **+ Create Destination**. ![Create Destination button in the Zeotap CDP Destinations application](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_1.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=92dfe8ecb29e59c9d7d57cb954e54618) **Step 3** Under **All Destinations**, search for **Google Customer Match (Mobile Device IDs)** and open it. ![Searching the All Destinations list in Zeotap CDP](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_2.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=6f5f0f5367788fb4e9e946f4b3cb5874) **Step 4** Fill in the configuration panel on the right: a. Enter a **Name** for the destination. b. Enter the **Seat ID** on which the segment should be created. c. Enter the **App ID** in the format shown in Prerequisites. d. Select the **Product Type** — `ADWORDS`, `INVITE_PARTNER`, or `INVITE_ADVERTISER` — matching the Seat ID. e. Review the values and click **Next**. ![Google Customer Match (Mobile Device IDs) destination configuration panel with Name, Seat ID, App ID and Product Type fields](https://mintcdn.com/zeotap/Hq-UxQPMElXbNbMd/articles/integrate-customer/Storage/integrate-customer/google-customer-match-mobile-device-ids/google-customer-match-mobile-device-ids-2023-11-08.png?fit=max\&auto=format\&n=Hq-UxQPMElXbNbMd\&q=85\&s=5b8baef52740a696efd969e42f0ed53d) **Step 5** On the **Action and mapping** screen, under **Choose your Action**, select **Send identifiers to Google Customer Match - Mobile Device IDs**. Map the Catalogue field that holds the MAID to the destination MAID field. ![Action and mapping screen with the Send identifiers to Google Customer Match - Mobile Device IDs action selected](https://mintcdn.com/zeotap/Hq-UxQPMElXbNbMd/articles/integrate-customer/Storage/integrate-customer/google-customer-match-mobile-device-ids/google-customer-match-mobile-device-ids-2023-11-08-1.png?fit=max\&auto=format\&n=Hq-UxQPMElXbNbMd\&q=85\&s=502974ee743e74daf96fdef0da0aab4a) **Step 6** Click **Create Destination**. The destination is now available in the **Audiences** application. **App ID reference — what to paste into the field:** ```text theme={null} iOS example: 476943146 Android example: com.labpixies.colordrips ``` > [!NOTE] > > The App ID is required when creating a `CrmBasedUserList` for uploading mobile advertising IDs; without it, Google rejects the audience. ## Link an audience to the destination Once the destination exists, link an audience to it from the **Audiences** application — see [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination) for the walkthrough. Segments created by this integration appear at the Google seat named in the format: ```text theme={null} {Audience Name}_{Audience Id} ``` Segment delivery to the Google Customer Match seat can take **up to three business days** from the first refresh. > [!NOTE] > > The terms *Audience* and *Segment* are used interchangeably to mean a customer cohort defined by shared criteria — for example, customers over 18 who performed an `addToCart` event in the last 30 days. ## Verify the destination is working Confirm the audience arrived on the Google side through Audience manager in Google Ads. **Step 1** Sign in to the Google Ads account tied to the Seat ID you configured. **Step 2** In the left panel, open **Tools**. **Step 3** Under **Shared Library**, open **Audience manager**. **Step 4** Under **Your data segments**, find the segment named `{Audience Name}_{Audience Id}`. In the **Customer Type** column, it is listed as **Customer list (Mobile Device IDs)**. ![Your data segments list in Google Ads Audience manager showing Customer list entries in the Customer Type column](https://mintcdn.com/zeotap/Hq-UxQPMElXbNbMd/articles/integrate-customer/Storage/integrate-customer/google-customer-match-customer-contact-information/google-customer-match-customer-contact-information-2024-12-17.png?fit=max\&auto=format\&n=Hq-UxQPMElXbNbMd\&q=85\&s=9f68d97986dbfd032ea5a26014142203) **You know it worked when:** * The segment appears in Audience manager with **Customer Type = Customer list (Mobile Device IDs)**. * The segment name matches `{Audience Name}_{Audience Id}` from your Zeotap audience. * The list size populates on the Google side within three business days of the first refresh. ## User disqualification and deletes When a user no longer meets an audience's criteria — for example, because a consent parameter changed or the user no longer matches the segment definition — Zeotap CDP issues a delete request to Google for that user in the next refresh cycle. This runs automatically at the refresh frequency configured on the audience; you do not trigger it manually. For the full delete and delta-upload behaviour, see [Delta Upload and Delete functions](/articles/integrate-customer/delta-upload-and-delete-functions). ## Troubleshoot common issues | What you observe | What it means | Where to look | | :- | :- | :- | | Audience push to Google fails after the first refresh | Zeotap is not whitelisted on the target Google Ads or DV360 account | Google Ads → Tools → Data Manager → Connected products, or DV360 → Partner Settings → Linked Accounts | | Google rejects the audience with a `CrmBasedUserList` error | The App ID is missing, or does not match the app that produced the MAIDs | Zeotap CDP destination configuration — the App ID field | | Segment does not appear at the Google seat after three business days | The Seat ID or Product Type does not match the account tied to your Google login | Zeotap CDP destination configuration — Seat ID and Product Type fields | | EEA users are excluded from Customer Match matching | Consent signals `ad_user_data` and `ad_personalization` were not `GRANTED` for those users at ingestion | Zeotap CDP Consent Orchestration rules and the consent parameters sent by your source | | Attempted to add identifier extensions to a MAID-based segment | MAID-based segments do not accept identifier extensions — uploads must be first-party | Zeotap CDP audience configuration — remove the extension step | If none of the above matches your symptom, contact your Zeotap customer success representative. **Include in your request:** the destination name, the Seat ID, the Product Type, the App ID, the audience name and ID, the timestamp of the last refresh attempt, and any error string shown in the Zeotap CDP destination activity view. ## FAQ > [accordion] Can I send emails or phone numbers through this destination? > > No. This destination accepts MAIDs only. To send hashed emails or phone numbers, use [Google Customer Match (Customer Contact Information)](/articles/integrate-customer/google-customer-match-customer-contact-information). > [accordion] Why can't I extend a MAID-based audience? > > Identifier extension is not permitted on MAID-based segments — MAID uploads must be first-party data that you onboarded. This is a policy constraint on the integration. > [accordion] How long does it take for an audience to appear in Google Ads or DV360? > > Up to three business days from the first refresh. Before the segment appears, it is queued at the Google Customer Match seat. > [accordion] What happens to EEA users if I haven't set up consent orchestration? > > Zeotap sends `GRANTED` for `ad_user_data` and `ad_personalization` for every user in the audience. If you have not filtered the audience by consent, non-consented EEA users are sent to Google, which violates the EU user consent policy. Configure Consent Orchestration rules so only consented users qualify — see the [Google consent update FAQs](/articles/integrate-customer/faqs-related-to-google-consent-update). > [accordion] What Product Type do I choose if I use both Google Ads and DV360? > > Create one destination per product. A single destination binds to one Seat ID and one Product Type; to push to both Google Ads and DV360, create two destinations with the appropriate Product Type (`ADWORDS` for Google Ads, `INVITE_PARTNER` or `INVITE_ADVERTISER` for DV360). ## Next steps * [Explore Google Customer Match (Customer Contact Information) →](/articles/integrate-customer/google-customer-match-customer-contact-information) * [Explore the Google consent update FAQs →](/articles/integrate-customer/faqs-related-to-google-consent-update) * [Explore how to link an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore Delta Upload and Delete functions →](/articles/integrate-customer/delta-upload-and-delete-functions) * [Explore Google Ad Manager for PPID-based targeting →](/articles/integrate-customer/google-ad-manager) ## Related * [Google Customer Match (Customer Contact Information)](/articles/integrate-customer/google-customer-match-customer-contact-information) * [FAQs related to Google Consent Update](/articles/integrate-customer/faqs-related-to-google-consent-update) * [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination) * [Delta Upload and Delete functions](/articles/integrate-customer/delta-upload-and-delete-functions) * [Google Ad Manager](/articles/integrate-customer/google-ad-manager) # Google DDP Source: https://docs.zeotap.com/articles/integrate-customer/google-ddp Configure a Google Marketing Platform (DDP) destination to license audience segments to Google Ad Manager (DFP) or Display & Video 360 (DBM) seats. ## What this is Google DDP (Data Delivery Platform) is Google's channel for third-party data providers to license audience segments to clients running Google Ad Manager (formerly DoubleClick for Publishers, DFP) or Display & Video 360 (formerly DoubleClick Bid Manager, DBM). The Zeotap CDP integration sends mobile advertising IDs (MAIDs) and Google cookies to a Google DDP seat so publishers and advertisers can activate those audiences in their Google campaigns. In terms of data exposure, Google receives only the user IDs — never the profile attributes or events mapped to those IDs — and clients who consume the resulting lists at the seat cannot download them. This page covers what to gather in Google, how to configure the destination in Zeotap CDP, how to link an audience, and what to check when a delivery does not land at the seat. ## Prerequisites > [!NOTE] > > **EU user consent policy.** Under Google's [EU User Consent Policy](https://www.google.com/about/company/user-consent-policy/), this integration requires the `process_consent` flag. Zeotap CDP sends `process_consent=True` for every upload, so you are responsible for obtaining end-user consent before sharing first-party seed data with Zeotap CDP. See [Google's documentation on how `process_consent` is handled in bulk uploads](https://developers.google.com/authorized-buyers/rtb/bulk-uploader#process_consent_in_bulk_upload_request) and the [FAQs on the Google consent update](/articles/integrate-customer/faqs-related-to-google-consent-update). Before you configure the destination, gather the following from Google: * **Seat ID** — the ID of the Google account that will receive the segments. For an Advertiser account this is the ID next to your account name; for a Publisher account this is the Audience Link ID. * **Product Type** — which Google product the seat belongs to (see the table below). * **Currency** — the currency configured for the destination seat. * **A Zeotap CDP account** with permission to create destinations. ### Choose the correct Product Type Google DDP recognises four Product Type values. Use the one that matches your seat: ``` DFP_BY_GOOGLE # DoubleClick for Publishers INVITE_ADVERTISER # Bid Manager Advertiser INVITE_PARTNER # Bid Manager Partner GOOGLE_RESELLER # Google Reseller ``` For a Display & Video 360 seat, the field label on the seat identifies the Product Type: * If the field is labelled **Partner ID**, use `INVITE_PARTNER`. * If the field is labelled **Advertiser ID**, use `INVITE_ADVERTISER`. For a Google Ad Manager (DFP) seat, use the seat's **Audience Link ID** as the Seat ID. The Audience Link ID is a numeric value and is distinct from your Network Code — do not swap the two. If you cannot determine the Product Type or Currency for your seat, contact your Google account representative or your Zeotap customer success representative. ## Configure the Google DDP destination The destination is created inside the Destinations application of the Zeotap CDP App. You provide the Seat ID, Product Type, and Currency, then map source identifiers to the identifiers Google DDP accepts. 1. In the Zeotap CDP App, open the Destinations application and begin creating a new destination. ![Destinations application listing with the Create Destination button](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_1.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=92dfe8ecb29e59c9d7d57cb954e54618) 2. From the catalogue of available destinations, choose **Google Marketing Platform (DDP)**. ![Searching for Google Marketing Platform (DDP) under All Destinations](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_2.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=6f5f0f5367788fb4e9e946f4b3cb5874) 3. Enter the **Seat ID**, select the **Product Type**, and select the **Currency** you gathered above, then continue to actions and mapping. ![Google DDP destination configuration form with Seat ID, Product Type and Currency fields](https://mintcdn.com/zeotap/Hq-UxQPMElXbNbMd/articles/integrate-customer/Storage/integrate-customer/google-ddp/google-ddp-2023-11-08.png?fit=max\&auto=format\&n=Hq-UxQPMElXbNbMd\&q=85\&s=0179318b0ffc2f350316f9c4dac5d251) 4. Choose the action **Send identifiers to Google Marketing Platform (DDP)** and map your source identifiers to the accepted output identifiers. This integration accepts **MAIDs** and **Google cookies** — see [Choose the output identifiers](https://docs.zeotap.com/articles/segment-customer/choose-the-output-identifiers) for how to edit, add, or remove identifiers in the mapping. ![Choosing the action and mapping identifiers for the Google DDP destination](https://mintcdn.com/zeotap/Hq-UxQPMElXbNbMd/articles/integrate-customer/Storage/integrate-customer/google-ddp/google-ddp-2023-11-08-1.png?fit=max\&auto=format\&n=Hq-UxQPMElXbNbMd\&q=85\&s=678db81e1288a441743a229613809279) 5. Save the destination. > [!TIP] > > The action **Send identifiers to Google Marketing Platform (DDP)** supports both ID Extension and Delete. Delta Upload is not supported for this destination. Reference: [Available actions](/articles/segment-customer/extend-your-audience#id-extension). ## Verify the destination was created You know the destination is ready when it appears in the destinations list under **Integrate > Destinations**, under the name you gave it. Open the destination and confirm that the Seat ID, Product Type, and Currency shown match the values you entered — those three fields drive where every subsequent refresh is delivered, so a mistyped Seat ID here silently routes deliveries to the wrong (or a nonexistent) Google seat. ## Link an audience to the destination Once the destination exists, an audience (also called a segment — the terms are interchangeable in Zeotap CDP) can be linked to it from the **Audiences** or **Target** application. Follow the steps in [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination). After you link an audience, the audience is reflected almost instantly within the DDP platform. Google itself can take up to seven business days to make the segment available at the Google DDP seat for campaign use. > [!NOTE] > > Zeotap CDP enables the LAL (lookalike) extension for DV360 exclusively through the Google DDP destination. If you need lookalike expansion into DV360, this is the destination to use. ### How user disqualification works This integration supports user disqualification from audiences. When a user no longer meets an audience's criteria — because of rules, consent changes, or other conditions set on the audience — Zeotap CDP issues a user-deletion request to Google DDP on the next refresh cycle for that audience. Disqualification is programmatic: it runs automatically on the audience's configured refresh cadence, and disqualified users are excluded from the audiences linked to this destination on the following refresh. You do not need to trigger anything manually. ## Troubleshoot common issues A Google DDP destination saves successfully as long as the fields are filled — the Seat ID and Product Type are only validated by Google when the first refresh runs. Work through the table below when a linked audience does not deliver to the seat as expected. | Observed condition | What it means | Where to look | | - | - | - | | The linked audience does not appear at the Google DDP seat after the expected refresh | The Seat ID entered on the destination does not match a seat Google recognises for the chosen Product Type | Open the destination from the Destinations application and re-check the Seat ID against the value in the Google account (Advertiser account ID, or Publisher Audience Link ID) | | The audience is delivered but routed to the wrong Google product | The Product Type does not match the seat (for example, `INVITE_ADVERTISER` selected for a Partner seat) | Re-check the Product Type against the field label on the seat (Partner ID → `INVITE_PARTNER`, Advertiser ID → `INVITE_ADVERTISER`) | | Delivered audience counts are lower than the audience size in Zeotap CDP | Some source identifiers are neither MAIDs nor Google cookies — only those two identifier types are accepted by this destination | Open the destination's identifier mapping and confirm which source identifiers are mapped to the DDP output identifiers | | Segment is delivered to Google but not activatable in EEA campaigns | End-user consent was not captured before ingestion, so the `process_consent=True` flag Zeotap CDP sends is not backed by user consent in the EEA | Review your Consent Orchestration rules and confirm that ingested users have consented under the EU user consent policy | | The DDP seat is a Google Ad Manager (DFP) seat and no data lands | The Seat ID was entered as the Network Code rather than the Audience Link ID | Retrieve the Audience Link ID from the Ad Manager seat and re-enter it as the Seat ID | If none of the above matches your symptom and the audience still does not deliver after the next full refresh, contact your Zeotap customer success representative. Include: the destination name, the Seat ID and Product Type you entered, the linked audience name, and the timestamp of the refresh that did not deliver. ## FAQ > [accordion] Does Google get access to the underlying data mapped to the IDs I send? > > No. Google receives only the user IDs (MAIDs and Google cookies) — it does not receive the attributes or events those IDs map to. Google also prevents the clients who consume the resulting lists from downloading them, so the mapped data stays inside Zeotap CDP. > [accordion] Which identifiers does this destination accept? > > MAIDs and Google cookies. If you need to send PPIDs (Publisher Provided Identifiers, raw or encrypted) to a Google Ad Manager seat instead, use the [Google Ad Manager](/articles/integrate-customer/google-ad-manager) destination — Google Ad Manager is the recommended path for PPIDs, and Google DDP is the recommended path for MAIDs and cookies. > [accordion] How long until an audience is usable at the Google DDP seat? > > The audience is reflected almost instantly within the DDP platform after the refresh. Google itself can take up to seven business days to make the segment available at the seat for campaign use. > [accordion] Do I need to trigger disqualification manually when a user drops out of an audience? > > No. Disqualification is programmatic — when a user no longer qualifies for an audience, Zeotap CDP issues a deletion request to the linked destinations on the next refresh cycle for that audience. > [accordion] Can I use this destination for DV360 lookalike expansion? > > Yes. The LAL extension for DV360 is enabled in Zeotap CDP exclusively through the Google DDP destination. ## Next steps * [Explore how to link an audience to the destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore the Google Ad Manager destination for sending PPIDs →](/articles/integrate-customer/google-ad-manager) * [Explore the Google Analytics 4 destination for GA Client ID activation →](/articles/integrate-customer/google-analytics-4) * [Explore the FAQs on the Google consent update →](/articles/integrate-customer/faqs-related-to-google-consent-update) ## Related * [Google Ad Manager](/articles/integrate-customer/google-ad-manager) * [Google Analytics 4](/articles/integrate-customer/google-analytics-4) * [FAQs related to Google Consent Update](/articles/integrate-customer/faqs-related-to-google-consent-update) * [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination) # Google DMP Source: https://docs.zeotap.com/articles/integrate-customer/google-dmp Configure a Google DMP destination in Zeotap CDP to activate audiences into Google Ad Manager or Display & Video 360. ## What this is Google DMP is the Zeotap CDP destination that pushes audience segments into your Google advertising stack. A single Google DMP destination is configured for either **Google Ad Manager** (publisher-side ad management) or **Display & Video 360** (programmatic buying) — you choose which one by setting the **Client Product Type** on the destination. This page covers the prerequisites Google requires, the account details you gather up front, how to configure the destination, and how to confirm it is ready to link to an audience. > [!NOTE] > > Google's [EU User Consent Policy](https://www.google.com/about/company/user-consent-policy/) requires the `process_consent` flag on this integration. Zeotap CDP always sends `process_consent=True`, so before you share first-party seed data through this destination you must obtain end-user consent. Google describes how the flag is processed in the [Authorized Buyers bulk-uploader reference](https://developers.google.com/authorized-buyers/rtb/bulk-uploader#process_consent_in_bulk_upload_request). ## Google Ad Manager vs Display & Video 360 Use this comparison to decide which mode to configure: | Feature | Google Ad Manager | Display & Video 360 | | - | - | - | | Focus | Ad management platform for publishers to sell, schedule, and measure digital ad inventory across websites, apps, and video content. | Programmatic platform covering display, video, audio, and native advertising. | | Audience targeting | Precise segmentation based on demographics, interests, geography, and behavior. | Granular targeting based on interests, demographics, and behavior. | | Inventory | Publisher-owned ad space across websites, mobile apps, and video content, supporting direct sales and programmatic. | Access to a larger pool of inventory from ad exchanges and publishers. | | Ad formats | Display, video, and native ads. | Display, video, audio, programmatic native. | | Reporting | Real-time reporting on ad performance, audience engagement, and revenue, with third-party analytics integration. | Advanced reporting with third-party analytics integration. | ## Supported identifiers This integration supports **MAIDs** and **Google cookies**. If you need to send Publisher Provided Identifiers (PPIDs, raw or encrypted), use the dedicated [Google Ad Manager destination](/articles/integrate-customer/google-ad-manager) instead — it is purpose-built for PPIDs. ## Supported actions | Action | ID Extension | Delete | Delta Upload | | - | :-: | :-: | :-: | | Send identifiers to Google DMP | ✅ | ✅ | — | ## Prerequisites Complete every step below before you create the destination. Google will not accept segments from Zeotap until the account pairing is in place. > [!WARNING] > > If the pairing step is skipped, segment creation at Google fails even though the Zeotap destination configures successfully. Confirm the pairing is live with your Google Account Team before you link an audience. 1. **Sign the Zeotap Data Usage agreement.** Any client consuming Zeotap data through this integration must have this in place. 2. **Contact your Google Account Team.** Reach out to the account team that manages your DBM or DFP contract and tell them you want to activate audiences from Zeotap. 3. **Sign the Google legal agreement.** Google will send the legal document that authorises Zeotap DMP to access your DBM or DFP account for segment creation. Sign it before pairing. 4. **Have Google pair Zeotap with your account.** The Google Account Team performs the formal whitelisting (also called "pairing") of Zeotap DMP with your DBM or DFP account. Ask your Zeotap Customer Success representative for the Zeotap DMP identifier that Google will need for this pairing request. 5. **Gather the destination details** listed in the next section. You need all of them before you start the configuration flow. ## Details you need before configuring the destination ### Seat ID The Seat ID identifies the Google account that will receive your segments. * For an **Advertiser** account, the Seat ID is the numeric ID shown next to your account name in Google. * For a **Publisher** account, the Seat ID is the **Audience Link ID** from your Google Ad Manager network settings. The Audience Link ID is not the same value as your Network Code. ### Client Product Type The Client Product Type pins the destination to a single Google surface. Choose the value that matches your Google account: | Choose this value | When you want to | Account type | | - | - | - | | `DFP_BY_GOOGLE` | Set up a Google Ad Manager connection. | Publisher account. | | `INVITE_PARTNER` | Set up a Display & Video 360 connection using a Partner account. | DV 360 Partner. | | `INVITE_ADVERTISER` | Set up a Display & Video 360 connection using an Advertiser account. | DV 360 Advertiser. | In DV 360, the field label on your account's basic details tells you which value to choose: an **Advertiser ID** field means `INVITE_ADVERTISER`; a **Partner ID** field means `INVITE_PARTNER`. ## Configure the Google DMP destination Create a new destination of type **Google DMP** in Zeotap CDP and provide the values you gathered above: 1. **Give the destination a name** that identifies the target Google account and the mode, so an Ad Manager destination is easy to distinguish from a DV 360 destination in the destinations list. 2. **Enter the Seat ID** from the "Seat ID" section above. 3. **Set the Client Product Type** to `DFP_BY_GOOGLE`, `INVITE_PARTNER`, or `INVITE_ADVERTISER` — whichever matches your Google account. ![Google DMP destination configuration form with the destination name, Seat ID, and Client Product Type fields](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/google_dmp.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=30e391be022184d26ca23b6a01fc4928) 4. **Configure the action and identifier mapping.** Select **Send identifiers to Google DMP** as the action and map the audience's output identifiers to the identifiers Google accepts (MAIDs and Google cookies). You can add, remove, or edit identifiers in the mapping — see [Choose the output identifiers](/articles/segment-customer/choose-the-output-identifiers) for how mapping works. ![Action selection and identifier mapping screen for the Google DMP destination](https://mintcdn.com/zeotap/Hq-UxQPMElXbNbMd/articles/integrate-customer/Storage/integrate-customer/google-dmp/google-dmp-2023-11-08-1.png?fit=max\&auto=format\&n=Hq-UxQPMElXbNbMd\&q=85\&s=bb022dde4cd7b8892aea4babb5e3a902) 5. **Save the destination.** Once saved, it is available to link to an audience. The destination configuration Zeotap CDP sends to Google carries the consent flag as follows: ```json theme={null} { "seat_id": "", "client_product_type": "DFP_BY_GOOGLE", "process_consent": true } ``` `process_consent` is always `true` for this integration, which is why the consent prerequisites above are non-negotiable. ## Link an audience to the destination Once the destination exists, link the audience you want to activate — [Link an audience to a destination](/articles/integrate-customer/link-an-audience-to-the-destination) walks through the linking flow. The terms *audience* and *segment* are used interchangeably in Zeotap CDP. ## Verify the destination is ready You know the setup worked when: * The destination appears in your destinations list with the Seat ID and Client Product Type you entered. * You are able to select the destination when linking an audience. * After the audience is linked, the segment reaches your Google DMP seat. Segment availability at the seat is governed by Google's own propagation schedule — confirm the expected timing with your Google Account Team so you know when to expect the segment to be usable in campaigns. ## User disqualification from audiences This integration supports user disqualification. When a user no longer meets an audience's criteria (or their consent state changes), Zeotap CDP issues a deletion request for that user on the next refresh cycle for every audience linked to this destination. Disqualification is automatic — you do not need to configure it separately. The cadence follows the refresh frequency configured on each audience. ## Troubleshooting | Error string | What it means | Where to look | | - | - | - | | Segment creation fails after the destination is linked to an audience | Zeotap DMP is not paired with your DBM or DFP account at Google | Confirm the whitelisting with your Google Account Team | | Segment is accepted by Zeotap CDP but never appears at the Google seat | The Client Product Type does not match the Google account type (for example, `INVITE_ADVERTISER` picked for a Partner account) | Recheck the field label in your DV 360 account's basic details (Partner ID vs Advertiser ID) and edit the destination to match | ### Segment creation fails at Google This happens when the account pairing at Google is missing or incomplete. Confirm with your Google Account Team that Zeotap DMP has been whitelisted against your DBM or DFP account and that the legal agreement authorising Zeotap access is signed. Re-attempt segment creation once Google confirms the pairing is live. ### Wrong Client Product Type selected If you pick `INVITE_ADVERTISER` for a Partner account (or vice versa), Google rejects the segment even though the Zeotap destination saves successfully. Recheck the field label in your DV 360 account's basic details — Partner ID means `INVITE_PARTNER`, Advertiser ID means `INVITE_ADVERTISER` — and edit the destination to match. ### Users are not being removed from Google-side audiences Disqualification runs on the refresh cadence configured on each linked audience. If a user still appears in the audience at Google's end, first check when the audience was last refreshed in Zeotap CDP; a slow-cadence audience takes longer for removals to propagate. ## FAQ > [accordion] Can one destination push to both Google Ad Manager and Display & Video 360? > > No. The **Client Product Type** field pins the destination to a single Google surface — `DFP_BY_GOOGLE` for Google Ad Manager, or `INVITE_PARTNER` / `INVITE_ADVERTISER` for DV 360. Create one Zeotap destination per Google account you want to activate to. > [accordion] Do I need to send `process_consent` myself? > > No. Zeotap CDP always sends `process_consent=True` for this integration. Your responsibility is to make sure the seed data you send us was collected with valid end-user consent under Google's EU User Consent Policy. > [accordion] What identifiers can I send? > > MAIDs and Google cookies. If your use case needs Publisher Provided Identifiers (raw or encrypted), use the [Google Ad Manager destination](/articles/integrate-customer/google-ad-manager) instead. > [accordion] What is the difference between the Audience Link ID and the Network Code in Google Ad Manager? > > They are distinct values. The **Audience Link ID** is what Zeotap CDP needs in the Seat ID field for a Publisher account; the Network Code identifies the ad network and is not accepted here. ## Next steps * [Explore the Google Ad Manager destination →](/articles/integrate-customer/google-ad-manager) for sending PPIDs instead of MAIDs and cookies. * [Explore the Google Analytics 4 destination →](/articles/integrate-customer/google-analytics-4) to activate segments into GA4 audiences. * [Explore the Adform DMP destination →](/articles/integrate-customer/adform-dmp) for another DMP activation option supporting MAIDs and cookies. # Google Enhanced Conversions API (CAPI) Source: https://docs.zeotap.com/articles/integrate-customer/google-enhanced-conversions-api-capi Send conversion data from a published Zeotap CDP journey to your Google Ads account with the Google Enhanced Conversions API destination. ## What this is Google Enhanced Conversions API (CAPI) is a real-time destination: conversion data flows **out of Zeotap CDP to your Google Ads account**, sent from a published journey as users reach a **Send to Destinations** node. Nothing flows back into Zeotap CDP from this destination. Google Enhanced CAPI improves conversion tracking accuracy in Google Ads. It allows you to securely send hashed first-party customer data to Google, enhancing attribution while maintaining user privacy. By integrating it with Zeotap CDP, you can streamline data activation for Google Ads: Zeotap CDP ensures that conversion data is securely collected, transformed, and sent to Google in a privacy-compliant manner. This integration helps you: * Improve campaign performance with more accurate conversion tracking. * Optimise bidding strategies using better attribution data. * Maintain compliance with data privacy regulations while sharing first-party data with Google. Typical uses include e-commerce conversion optimisation — measuring how many online purchases originate from your Google Ads campaigns by sending hashed email addresses and transaction IDs — and lead generation, where accurate attribution is needed even when cookies are restricted, so that a user who submits a contact form has their hashed identifiers sent to Google through this destination. If you want to activate an **audience** to Google Ads rather than send conversions from a journey, use the batch Google destinations instead: [Google Customer Match (Customer Contact Information)](/articles/integrate-customer/google-customer-match-customer-contact-information) or [Google Customer Match (Mobile Device IDs)](/articles/integrate-customer/google-customer-match-mobile-device-ids). For analytics events, see [Google Analytics 4](/articles/integrate-customer/google-analytics-4). ## Supported identifiers and actions To match conversion data to Google users, at least one of the following must be provided: * Hashed Email Address (SHA256) * Hashed Phone Number (SHA256) * Hashed First Name & Last Name (SHA256) along with Country Code and Postal Code Along with the above, you **can send a custom identifier** as well. The destination exposes a single action: * **Upload Conversion Adjustments** ## Prerequisites Ensure that the following prerequisites are met before setting up Google Enhanced CAPI: * A Google **Ads account with conversion tracking enabled**. * **Enhanced Conversions for Web enabled** in Google Ads. * **Customer Data Terms accepted** in your Google Ads account. ## Gather your Google Ads details Ensure that you have details about the below components of Google Enhanced CAPI available before creating a destination in Zeotap CDP. * **Customer ID** – This is your Google Ads account ID, used for sending conversion data. It is a 10-digit code (remove the hyphens before entering it in Zeotap CDP) available when you click your profile icon in your Google Ads account. [Learn more](https://developers.google.com/google-ads/api/docs/get-started/select-account#identify_the_login_customer_id_and_customer_id) * **Conversion Action** – This represents the specific user action that is considered a conversion, such as completing a purchase, signing up for a newsletter, or submitting a form. * **Transaction ID** – This is a unique identifier assigned to each conversion event, helping to deduplicate and match enhanced conversions. * **API Credentials** – Set up OAuth 2.0 authorisation for Google Ads API access by creating an app in your Google Cloud Platform (GCP) project. Follow the steps in the [Google Ads API documentation](https://developers.google.com/google-ads/api/docs/get-started/introduction) to complete the setup. Retrieve the following credentials for authentication: * **Developer token** – Available in your Google Ads account. [Learn more](https://developers.google.com/google-ads/api/docs/get-started/dev-token) * **Client ID** – Available in the app you created. [Learn more](https://developers.google.com/google-ads/api/docs/oauth/playground#get_a_client_id_and_client_secret) * **Client secret** – Available in the app you created. [Learn more](https://developers.google.com/google-ads/api/docs/oauth/playground#get_a_client_id_and_client_secret) * **Refresh token** – Generated while setting up your app. [Learn more](https://developers.google.com/google-ads/api/docs/oauth/playground#generate_tokens) > [!NOTE] > > These credentials belong to the **Google Ads API**. You create and manage them in your own Google Ads account and Google Cloud Platform project. ## Create the Google Enhanced CAPI destination Once you have taken care of the prerequisites above, proceed to [creating a workflow in Journeys](/articles/orchestrate-customer/create-a-workflow). After you have applied filters or added conditions for your users in Journeys as described in [Create a Workflow](/articles/orchestrate-customer/create-a-workflow), you can activate them in **Google Enhanced CAPI** from the **Send to Destinations** node. ![Journey canvas with the Choose an action menu open below an event condition node and the Send to Destinations action highlighted](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=8ed8abd70040c3e575c94c98ad4e6956) A new window appears, where you can set up your destination. You can use an already existing destination from the list of available destinations or create a new one by clicking **+ Add New Destination**. > [!NOTE] > > **Note:** > > To use an existing destination for activation in Journeys, see [Add the destination to a journey](/articles/integrate-customer/google-enhanced-conversions-api-capi#add-the-destination-to-a-journey). Perform the following steps to add a new destination: **Step 1** Click **+ Add New Destination** as shown below. ![Send to Destinations panel with the + Add New Destination link highlighted above the destination search box and the cards for destinations that already exist](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26-1.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=45aec566d6937bbb28613e4b880207c4) **Step 2** Search for **Google Enhanced CAPI.** **Step 3** Click **Google Enhanced CAPI** and enter a name for the destination. **Step 4** In the **Destination Instance Name** field, enter a value of your choice. **Step 5** Enter the following [values you gathered from Google](/articles/integrate-customer/google-enhanced-conversions-api-capi#gather-your-google-ads-details): * **Customer ID** * **Client ID** * **Client secret** * **Refresh token** * **Developer token** **Step 6** Review the fields entered above and click **Next**. **Step 7** On the **Mapping** screen, under **Choose your Action**, select **Upload Conversion Adjustments** to send data from the workflow created in Journeys. Map the required identifiers and attributes based on your use case. Under **Map the Fields**, the **Mandatory Attributes** group lists the destination fields you must supply a Catalogue attribute for — **Order ID** and **Conversion Action**. Without both, you cannot proceed. Under **Custom Identifier**, select **+ Add Mapping Field** to add any custom identifier you want to send to Google Ads. ![Map the Fields screen showing the Mandatory Attributes group, with Order ID and Conversion Action listed as required destination fields each awaiting a Catalogue attribute](https://mintcdn.com/zeotap/Hq-UxQPMElXbNbMd/articles/integrate-customer/Storage/integrate-customer/google-enhanced-conversions-api-capi/google-enhanced-conversions-api-capi-2025-03-11.png?fit=max\&auto=format\&n=Hq-UxQPMElXbNbMd\&q=85\&s=6dccf6793d5ab22658f9a8fe1d416ef1) **Step 8** Once the mapping is complete, click **Create Destination**. The destination is created and made available for activation on Journeys as shown below. ![Send to Destinations panel showing the newly created Google Enhanced CAPI destination card selected alongside other configured destination cards](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/google-enhanced-conversions-api-capi/google-enhanced-conversions-api-capi-2025-03-11-1.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=7cdc574cba4180b3126e3b0ca8b8d547) ## Add the destination to a journey After creating a destination, you can link it in the **Send to Destination** node within the workflow, as explained below. **Step 1** Click the destination you created from the list of available destinations. ![Send to Destinations panel with the Google Enhanced CAPI destination card selected from the list of available destinations](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/google-enhanced-conversions-api-capi/google-enhanced-conversions-api-capi-2025-03-11-1.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=7cdc574cba4180b3126e3b0ca8b8d547) **Step 2** Under the **Destination Details** tab, the **Customer ID, Client ID, Client secret, Refresh token** and **Developer token** fields are automatically populated based on the values that you entered while creating the destination. **Step 3** Under the **Destination Settings** tab, choose the action and mapping as per your requirement. **Step 4** Click **Save Destination** and then click **Add Destinations**. You can also add multiple destinations at this step if needed. **Step 5** The linked destinations appear in the **Send to Destination** node within the workflow as shown below. You can then build and customise your workflow as needed by clicking **+**. Note that you must enter a name for your workflow in the provided text box to save it. ![Workflow canvas with a named workflow, an attribute condition node, an event condition node, and a Send to Destination node carrying the Google Ads icon, above the Cancel, Save Draft and Next: Define Re-entry Criteria buttons](https://mintcdn.com/zeotap/Hq-UxQPMElXbNbMd/articles/integrate-customer/Storage/integrate-customer/google-enhanced-conversions-api-capi/google-enhanced-conversions-api-capi-2025-03-11-2.png?fit=max\&auto=format\&n=Hq-UxQPMElXbNbMd\&q=85\&s=3509cdd8e23209bd15f0210f13ec360d) **Step 6** After adding conditions and filters for users, choose one of the following options: a. **Save Draft**: Enables you to revisit and edit the workflow before publishing. b. **Next: Define Re-entry Criteria**: Determines whether a user can re-enter the same workflow. **Step 7** After defining the re-entry criteria, click **Publish Workflow**. The workflow appears in the Workflow listing screen with a **Published** status. ![Journey re-entry conditions panel with Yes and No options for allowing a user to re-enter the journey, and the Cancel, Save Draft and Publish Workflow buttons](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26-8.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=634ab0c131fbe99396837bc9f7b8fc91) ## Verify the integration After publishing the workflow, confirm that conversion data is reaching Google Ads: 1. Check that the workflow appears on the Workflow listing screen with a **Published** status. 2. On the journey canvas, look at the **Send to Destination** node. Destination nodes with failures show red error count badges, while successful deliveries show green indicators. See [Journey Error Codes](/articles/orchestrate-customer/journey-error-codes). 3. Open the node's **View Executions** panel to read the **Total Events Entered**, **Successful Events** and **Failed Events** counts for the node. 4. For an individual profile, open the right-hand **Execution Details** sidebar on the failed node. It shows the failure status code, the timestamp, the destination name and the Request ID. See [Identify Journey Errors](/articles/orchestrate-customer/identify-journey-errors). ## Troubleshoot Google Enhanced CAPI deliveries | Symptom | What to check | | - | - | | You cannot move past the **Mapping** screen. | Under **Map the Fields**, the **Mandatory Attributes** group requires a Catalogue attribute for both **Order ID** and **Conversion Action**. Map both, then continue. | | `AUTHENTICATION_ERROR` on the destination node. | Refresh the OAuth token or update the Google Ads API credentials. Re-check the **Customer ID** has had its hyphens removed, and that the **Developer token**, **Client ID**, **Client secret** and **Refresh token** are the ones issued for your app. See [Journey Error Codes](/articles/orchestrate-customer/journey-error-codes). | | `BAD_REQUEST` or `EVENT_PARSING_FAILED`. | The root cause is almost always in the field mapping configuration. Open the destination node's settings in the journey canvas and inspect the mapping screen. See [Identify Journey Errors](/articles/orchestrate-customer/identify-journey-errors). | | `CONSENT_NOT_PROVIDED`. | The user or event was blocked because the required consent was missing or insufficient for the destination. Verify that affected users have consent attributes populated and that consent field mappings are correctly defined. See [Journey Error Codes](/articles/orchestrate-customer/journey-error-codes). | | `RATE_LIMIT`, `SERVER_ERROR` or `SERVICE_UNAVAILABLE`. | These are transient and retried automatically. See [Journey Error Codes](/articles/orchestrate-customer/journey-error-codes) for the retry behaviour of each. | | You are not sure how widespread the failure is. | Switch the toggle to **Total Users** in the journey analytics view. If 100% of users fail at the node, the cause is likely authentication or mapping; if only a small percentage fail, it is more likely consent or data quality. See [Identify Journey Errors](/articles/orchestrate-customer/identify-journey-errors). | After any configuration change, use the refresh icon in the execution view to pull the latest execution data before concluding whether the fix worked. ## Next steps * [Create a Workflow in Journeys →](/articles/orchestrate-customer/create-a-workflow) * [Explore Journey Error Codes →](/articles/orchestrate-customer/journey-error-codes) * [Identify Journey Errors →](/articles/orchestrate-customer/identify-journey-errors) * [Explore Journey Traces →](/articles/orchestrate-customer/journey-traces) * [Activate an audience to Google Ads with Google Customer Match →](/articles/integrate-customer/google-customer-match-customer-contact-information) * [Explore how Destinations work →](/articles/integrate-customer/destinations) # Google Pub/Sub Source: https://docs.zeotap.com/articles/integrate-customer/google-pub-sub Send data out of Zeotap CDP into a Google Cloud Pub/Sub topic in real time from a Journeys workflow. ## What this destination does Google Pub/Sub is a **destination**: it sends data *out* of Zeotap CDP into a Google Cloud Pub/Sub topic that you own, in real time, as users move through a Journeys workflow. Zeotap CDP is the publisher on that topic; your own systems consume the messages from it. Google Pub/Sub itself is an asynchronous and scalable messaging service that decouples the services producing messages from the services processing them. It is commonly used for streaming analytics and data integration pipelines that ingest and distribute data. Pub/Sub also exists in Zeotap CDP in the opposite direction, as a **source** that brings data *into* the platform. If that is what you need, use one of these instead: * [Pub/Sub Stream](/articles/integrate-customer/pub-sub-stream) — ingest messages into Zeotap CDP as they are published. * [Pub/Sub Batch](/articles/integrate-customer/pub-sub-batch) — ingest messages into Zeotap CDP in batches. The source and the destination are configured separately and share no settings. This page covers the destination only. ## Prerequisites > [!NOTE] > > Ensure that you have the following details available before starting the integration: > > * **Project ID** — the Google Cloud project that owns the topic. See [Project ID](#project-id). > * **Topic ID** — the Pub/Sub topic you want Zeotap CDP to publish to. See [Topic ID](#topic-id). > * **Authentication** — either a **Refresh Token** (Client ID, Client Secret, and Refresh Token) or a **Service Account**. See [Authentication](#authentication). > * A **Journeys workflow**, or the ability to create one — the destination is created and attached from inside a workflow. See [Create a Workflow](/articles/orchestrate-customer/create-a-workflow). ## Supported identifiers and actions | Action | What it does | | - | - | | Send identifiers to Google Cloud PubSub in realtime | Publishes the identifiers and attributes you map to the configured Pub/Sub topic as users flow through the Journeys workflow. | Use **+ Add Mapping Field** on the mapping screen to add any custom field you want to send to Google Pub/Sub. ## Gather your Google Cloud details ### Project ID A Project ID is a unique string that differentiates your project from all others on Google Cloud. You can use the [Google Cloud console](https://cloud.google.com/resource-manager/docs/creating-managing-projects) to generate a Project ID. You can find the Project ID in the Google Cloud console — [Dashboard page](https://console.cloud.google.com/home). In the example below, the Project name is **My Sample Project** and the Project ID is **my-sample-project-191923**. ![The Google Cloud console Dashboard showing the Project name and Project ID](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/google-pub-sub-2023-01-12.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=9720c2a32db4d02c38639535961ca989) ### Topic ID In the Google Cloud console, go to the [**Pub/Sub**](https://console.cloud.google.com/cloudpubsub/topicList) page → **Topics**. A list of all the topics created appears. Copy the relevant Topic ID and use it for the destination setup. ![The Topics list on the Pub/Sub page of the Google Cloud console](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/google-pub-sub-2023-01-12-3.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=9bd2ec034898217f0748ceeb6e63f9ce) ### Authentication The authentication method for the Pub/Sub destination can be **Refresh Token** or **Service Account**. Provide the required details based on the authentication method you choose. #### Refresh token authentication To authenticate using a Refresh Token, you need the following details: * Client ID * Client Secret * Refresh Token For this integration, if you decide to perform the authentication through the **Refresh Token**, then Zeotap CDP requires the **Client ID**, **Client Secret**, and **Refresh Token** to establish a connection with the Pub/Sub destination where you want to send data. In Google Cloud, these unique credentials can be used to authorise applications or services, such as Pub/Sub, through OAuth 2.0. For detailed steps to generate them, refer to [Google's OAuth playground documentation](https://developers.google.com/google-ads/api/docs/oauth/playground). In the [refresh token generation steps](https://developers.google.com/google-ads/api/docs/oauth/playground#generate_tokens), add the **Cloud Pub/Sub API v1** scope when specifying API scopes, as shown in the image below. ![Selecting the Cloud Pub/Sub API v1 scope while specifying API scopes](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/google-pub-sub/google-pub-sub-2025-03-20-5.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=1a698ddea354880eeeb33862ba3ede3c) #### Service account authentication To authenticate using a Service Account, you must assign the **Pub/Sub Publisher** role to the `pub-sub-publisher@dcr-orchestration-prod.iam.gserviceaccount.com` service account within Pub/Sub, as shown below. ![Assigning the Pub/Sub Publisher role to the Zeotap service account in Google Cloud](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/google-pub-sub/google-pub-sub-2025-03-20-6.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=b689d42a86c96e1fd626617842dce245) ## Create the destination This page covers creating the Google Pub/Sub destination from inside a Journeys workflow. Once you have taken care of the prerequisites above, create the workflow in [Journeys](/articles/orchestrate-customer/create-a-workflow) (Zeotap CDP). After you have applied filters or added conditions for your users in Journeys as described in [Create a Workflow](/articles/orchestrate-customer/create-a-workflow), you can activate them in Google Pub/Sub from the **Send to Destinations** node, as shown below. ![The Send to Destinations node in a Journeys workflow](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=8ed8abd70040c3e575c94c98ad4e6956) A new window appears, where you can set up your destination. You can use an already existing destination from the list of available Destinations, or create a new one by clicking **+ Add New Destination**. ![Choosing an existing destination or adding a new one in the Send to Destinations window](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/google-pub-sub/google-pub-sub-2024-11-06-4.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=5a47343c81ea1d50842d49e6e22efe88) > [!NOTE] > > To use an existing destination for activation in Journeys, go to [Link the destination in a Journeys workflow](#link-the-destination-in-a-journeys-workflow). Perform the following steps to add a new destination: **Step 1** Click **+ Add New Destination**. **Step 2** Search for **Google Pub/Sub**. **Step 3** Click **Google Pub/Sub** and enter a name for the Destination. **Step 4** Enter the **Instance**, which is an internal field for the Destination. **Step 5** Provide the **Project Id** and **Topic Id** obtained from your Google Cloud. See [Project ID](#project-id) and [Topic ID](#topic-id). ![Entering the Instance, Project Id, and Topic Id on the destination form](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/google-pub-sub/google-pub-sub-2025-03-20-2.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=5ab86385cfa67d7f56f5b33da518c8cc) **Step 6** Choose either **Refresh Token** or **Service Account** as your Authentication method, based on your requirement. a. If you choose **Refresh Token**, provide the **Client Id**, **Client Secret**, and **Refresh Token** details in the respective fields. See [Refresh token authentication](#refresh-token-authentication). ![Refresh Token authentication fields on the destination form](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/google-pub-sub/google-pub-sub-2025-03-20-4.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=cf1a0dbb2b491edbe5871a5b8e3aaa4d) b. If you choose **Service Account**, the following **Google Service Account** is displayed. Ensure that you grant the **Pub/Sub Publisher** role to this service account within Pub/Sub. See [Service account authentication](#service-account-authentication). **Service Account:** `pub-sub-publisher@dcr-orchestration-prod.iam.gserviceaccount.com` ![The Google Service Account displayed when Service Account authentication is selected](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/google-pub-sub/google-pub-sub-2025-03-20-3.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=df8e8ba797ec570ec2a481db28cc1512) **Step 7** In the mapping screen that appears, under **Choose your Action**, select **Send identifiers to Google Cloud PubSub in realtime** as the action for sending data from the workflow created in Journeys. Under **Map the Fields**, use **+ Add Mapping Field** to add any custom field that you wish to send to Google Pub/Sub. Ensure that you map at least one attribute. Otherwise, the data does not flow to the Pub/Sub destination. ![Choosing the action and mapping fields for the Pub/Sub destination](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/google-pub-sub/google-pub-sub-2024-08-07-2.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=67f896c5af865fc1afafab97d1d77b38) **Step 8** Once the mapping is complete, click **Create Destination**. The destination is created and made available for activation on Journeys, as shown below. ![The created Pub/Sub destination available for activation in Journeys](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/google-pub-sub/google-pub-sub-2024-11-06-5.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=cb019caa9c0ad11eb9f5e50a4829d2c3) ## Link the destination in a Journeys workflow After creating a destination, link it in the **Send to Destinations** node within the workflow, as explained below. **Step 1** In the workflow, click **+** and choose **Send to Destinations**. ![Adding a Send to Destinations node to a Journeys workflow](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/google-pub-sub/google-pub-sub-2024-08-07-3.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=fc32cb0fd7764a5193810c7b6c33f96f) **Step 2** Choose the destination from the list of available destinations by using the search feature. **Step 3** Under the **Destination Details** tab, based on the authentication type you have chosen, the **Instance**, **Project Id**, **Topic Id**, **Authentication (Refresh Token/Service Account)** and other fields shown in the image below populate automatically from the values you entered while creating the destination. However, you need to provide an **Audience Name** to save the Destination. ![The Destination Details tab with auto-populated fields and the Audience Name field](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/google-pub-sub/google-pub-sub-2025-03-20-7.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=59baa8fcf2857735a7cd5f9ef8253f4e) **Step 4** Under the **Destination Settings** tab, choose the action and mapping as per your requirement. ![The Destination Settings tab showing the action and field mapping](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/google-pub-sub/google-pub-sub-2024-08-07-4.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=a62ac36a3d6aea34cfb1c2633fd4178c) **Step 5** Click **Save Destination**. The destination is attached, as shown in the image below. ![The Pub/Sub destination attached to the workflow](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/google-pub-sub/google-pub-sub-2024-11-06-1.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=589230ec725b342f83e98fca0ed7839e) **Step 6** Click **Add Destinations** at the bottom right corner of the screen. You can also add multiple destinations at this step if needed. **Step 7** The linked Destinations appear in the **Send to Destinations** node within the workflow, as shown below. You can then build and customise your workflow as needed by clicking **+**. Note that you must enter a name for your workflow in the provided text box to save it. ![Linked destinations shown inside the Send to Destinations node](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/google-pub-sub/google-pub-sub-2024-11-06-6.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=7ecb8709ced7573b4b9074d1d7d1b795) **Step 8** After adding conditions and filters for users, choose one of the following options: * **Save Draft** — enables you to revisit and edit the workflow before publishing. * **Next: Re-entry Condition** — determines whether a user can re-enter the same workflow. **Step 9** After defining the re-entry criteria, click **Publish Workflow**. The workflow appears in the Workflow listing screen with a **Published** status. ![The journey re-entry conditions panel, with the Publish Workflow button](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26-8.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=634ab0c131fbe99396837bc9f7b8fc91) ## Verify the destination is delivering After publishing the workflow, confirm delivery end to end: 1. In the workflow, the Google Pub/Sub destination appears inside the **Send to Destinations** node. 2. On the Workflow listing screen, the workflow shows a **Published** status. A workflow left in draft does not deliver. 3. On the destination, at least one attribute is mapped under **Map the Fields**. With no mapped attribute, no data flows to the topic. 4. In the Google Cloud console, open **Pub/Sub → Topics** and select the topic named by your **Topic Id**. Confirm that messages are being published to it as users flow through the journey. ## Troubleshooting | Symptom | What it means | Where to look | | - | - | - | | The workflow is published but nothing reaches the topic | No attribute is mapped on the destination | Zeotap CDP → the destination's mapping screen → **Map the Fields**. Map at least one attribute. | | No data flows and the workflow never went live | The workflow was kept with **Save Draft** and never published | Journeys → Workflow listing screen. A live workflow shows a **Published** status. | | Messages do not reach the topic when using **Service Account** authentication | The **Pub/Sub Publisher** role has not been granted to the Google Service Account shown on the destination form | Google Cloud console → **Pub/Sub** → your topic → permissions. See [Service account authentication](#service-account-authentication). | | Messages do not reach the topic when using **Refresh Token** authentication | The refresh token was generated without the **Cloud Pub/Sub API v1** scope, or the Client Id, Client Secret, or Refresh Token was entered incorrectly | Regenerate the refresh token with the **Cloud Pub/Sub API v1** scope, then re-enter all three values on the destination. See [Refresh token authentication](#refresh-token-authentication). | | Messages land on the wrong topic, or on no topic at all | The **Project Id** or **Topic Id** on the destination does not match the values in the Google Cloud console | Google Cloud console → [Dashboard page](https://console.cloud.google.com/home) for the Project ID, and **Pub/Sub → Topics** for the Topic ID. | | The destination cannot be saved in the **Send to Destinations** node | **Audience Name** has not been provided | Journeys → **Send to Destinations** node → **Destination Details** tab. | ## FAQ > [accordion] Is Google Pub/Sub a source or a destination in Zeotap CDP? > > This page describes the **destination** — Zeotap CDP publishes data out to a Pub/Sub topic that you own, from a Journeys workflow. Pub/Sub also exists as a **source** that brings data into Zeotap CDP; see [Pub/Sub Stream](/articles/integrate-customer/pub-sub-stream) and [Pub/Sub Batch](/articles/integrate-customer/pub-sub-batch). The source and the destination are configured separately and do not share settings. > [accordion] Should I use Refresh Token or Service Account authentication? > > Both are supported; choose the one that fits your requirement. **Refresh Token** needs a Client ID, Client Secret, and Refresh Token generated with the **Cloud Pub/Sub API v1** scope. **Service Account** needs no credentials from you — instead, you grant the **Pub/Sub Publisher** role to the Google Service Account shown on the destination form. > [accordion] Do I have to map fields before the destination works? > > Yes. Map at least one attribute under **Map the Fields**. If no attribute is mapped, data does not flow to the Pub/Sub destination. Use **+ Add Mapping Field** to add custom fields. > [accordion] Can I send to more than one destination from the same node? > > Yes. In the **Send to Destinations** node, click **Add Destinations** to attach additional destinations to the same workflow. > [accordion] Can I reuse one Pub/Sub destination across several journeys? > > Yes. A destination is configured once and reused across audiences and journeys — see [Destinations](/articles/integrate-customer/destinations). Select it from the list of available destinations in the **Send to Destinations** node of any workflow, and provide an **Audience Name** for that workflow. ## Next steps * [Explore Pub/Sub Stream →](/articles/integrate-customer/pub-sub-stream) — bring streaming Pub/Sub messages *into* Zeotap CDP. * [Explore Pub/Sub Batch →](/articles/integrate-customer/pub-sub-batch) — bring batched Pub/Sub messages *into* Zeotap CDP. * [Explore Create a Workflow →](/articles/orchestrate-customer/create-a-workflow) — build the Journeys workflow this destination attaches to. * [Explore Real-Time Integrations →](/articles/integrate-customer/real-time-integrations) — the shared configuration pattern every real-time destination follows. * [Explore Destinations →](/articles/integrate-customer/destinations) — how destinations, actions, and mappings fit together. # Google Tag Manager Source: https://docs.zeotap.com/articles/integrate-customer/google-tag-manager Google Tag Manager is a Zeotap source: add the Zeotap tag template to your GTM container to bring website events and user identities into Zeotap. Google Tag Manager (GTM) is a **source**: it brings data **into** Zeotap. You add Zeotap's tag template to your GTM container, and the tag captures events and user information as customers navigate your website and sends them to Zeotap. Data moves in one direction — from your website into Zeotap. ## What this is The Zeotap GTM tag is a JavaScript tag that Zeotap publishes as a **custom template** inside Google Tag Manager. It is asynchronous, so it does not affect the loading of your website or the end-user experience. Because it is a GTM custom template, you configure it from a form in the GTM interface — the write key, the consent method, the events to track and the identity variables to capture — instead of changing your website's code every time that configuration changes. A Tag Manager source is created with the **Customer Data** entity, and you choose the region of upload when you create it. ## Prerequisites > [!NOTE] > > * A **Google Tag Manager account**, with the GTM container installed on your website. For accounts, containers and tag basics, refer to Google's [Setting up and installing Tag Manager](https://support.google.com/tagmanager/answer/6103696). > * A **data layer** on your website. See [What your data layer must provide](#what-your-data-layer-must-provide). > * Access to the **Sources** application under **Integrate** in the Zeotap CDP App. > * A **Tag Manager source** created in Zeotap. The source details give you the **Write Key**, which the tag needs in order to record events. ## What your data layer must provide The tag collects what it sends to Zeotap from your website's data layer, so the data layer is what makes the relevant information available for segment activation and event orchestration. The data layer object is flattened and used in the corresponding collection calls. Push the following into the data layer, according to what you want to capture: * **An event name** — stored under GTM's default `event` key, or under another key that you name in the tag's **Event Key** field. * **Event properties** — the properties you want recorded against each event. * **A login event** — the event fired when a user logs in, carrying the identities you want stored: email address, cellphone number with country code and login ID, either raw or already hashed. Those identities persist across the subsequent calls to Zeotap. * **A logout event** — used to unset the email address, phone number or login ID from the events that follow it. * **User attributes** — the data layer variables that hold user-related information. List any raw PII, and any other keys you do not want ingested, in the tag's **PII to be excluded** field. Some fields are excluded from ingestion regardless — `country` and `city`, for example, are derived from the visitor's IP address instead. For the full list, see [Blacklisted Fields for Data Ingestion](/articles/integrate-customer/blacklisted-fields-for-data-ingestion). ## Set up the Google Tag Manager source **1. Create the source in Zeotap** In the **Sources** application, create a source with **Tag Managers** as the Category and **Google Tag Manager** as the Data Source. See [Create a Tag Manager Source](/articles/integrate-customer/creating-tag-manager-source-2676490586). **2. Implement the tag in GTM** Add the Zeotap tag template to your GTM workspace, configure it with the write key and your tracking, identity and consent settings, set up the trigger, and validate the tag. See [Implement the Google Tag Manager Source](/articles/integrate-customer/implementing-google-tag-manager-source-2665775403). **3. Confirm that data is arriving** Once the source is live, open the **PREVIEW DATA** tab on the source to see incoming data. See [Components of the Preview Data Tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab). ## Next steps * [Create a Tag Manager Source](/articles/integrate-customer/creating-tag-manager-source-2676490586) — register the source in Zeotap. * [Implement the Google Tag Manager Source](/articles/integrate-customer/implementing-google-tag-manager-source-2665775403) — add, configure, trigger and validate the tag. * [Tag Configuration Overview](/articles/sdks/gtm/setup-guide/configuration/overview) — a field-by-field reference for every option on the tag. * [Adobe Experience Platform Tag Extension](/articles/integrate-customer/adobe-experience-platform-tag-extension) — the other tag manager integration, listed alongside GTM on [Tag Managers](/articles/integrate-customer/tag-managers). # Google Universal Analytics Integration Source: https://docs.zeotap.com/articles/integrate-customer/google-universal-analytics-integration Send audience membership events out of a Zeotap CDP journey to a Google Universal Analytics property in real time, using the Measurement Protocol. ## What this is Google Universal Analytics is a **real-time destination**: data flows out of Zeotap CDP to your Google Universal Analytics (GA) property, driven from a workflow in Journeys. Each time a user qualifies for — or drops out of — the workflow, Zeotap sends an event to GA against that user's GA Client ID, so the enhanced profile you hold in Zeotap is available for reporting and audience building inside Google. Google Universal Analytics itself covers event, page view, e-commerce, crash and exception reporting. Integrated with Zeotap CDP you can additionally: * Send data into GA custom dimensions and custom metrics, carrying enhanced user traits and profile attributes alongside the event. * Send offline data that you cannot send through a direct Google Analytics implementation. * Build audiences on the resulting GA data and activate them in other Google products. Zeotap uses the Google Measurement Protocol to deliver these events as server-to-server calls. No Zeotap API call is involved on your side — you configure the destination in the UI and Journeys does the sending. > [!NOTE] > > The opposite direction — getting the GA Client ID *into* Zeotap in the first place — is handled by the [Google Tag Manager source](/articles/integrate-customer/google-tag-manager), where the Zeotap Collect Tag can [pick up the GA Client ID from the `_ga` cookie](/articles/sdks/gtm/setup-guide/configuration/google-analytics). Without that, Zeotap has no GA Client ID to send back. > > For the Google Analytics 4 property type, use the separate [Google Analytics 4 destination](/articles/integrate-customer/google-analytics-4), which sits in the Batch Integrations lane and is linked to an audience rather than to a journey. ## Supported identifiers and actions | Item | Value | | :- | :- | | Lane | Real-time Integration (Journeys) | | Supported identifier | GA Client ID — mapped to the **Google Client ID** destination field | | Action | **Send events to Google Universal Analytics in realtime** | You can map additional Catalogue attributes to GA custom dimensions and custom metrics on the same mapping. ## Prerequisites Have all of the following ready before you create the destination: * A **Google Universal Analytics property**, and its **Tracking ID**. See [Set up the Google Analytics property](#set-up-the-google-analytics-property) below. * **Custom dimensions and custom metrics** created in Google Universal Analytics, so that Zeotap has somewhere to send the attributes to. See [Create custom dimensions and custom metrics](#create-custom-dimensions-and-custom-metrics) below. * The **GA Client ID flowing into Zeotap** through your Web or Google Tag Manager implementation. The GA Client ID is the user identifier for this integration, and Zeotap can only send it onward if it was collected first. * A **workflow in Journeys** to attach the destination to — see [Create a Workflow](/articles/orchestrate-customer/create-a-workflow). ## Set up the Google Analytics property Perform the following steps in Google Analytics to create a property and obtain the Tracking ID: **Step 1** Log in to the Google Analytics (GA) account. **Step 2** Go to **Admin** > **Create Property**. **Step 3** Enter a **Property Name** and then click **Show Advanced Options**. **Step 4** Select the toggle on **Create a Universal Analytics property** and enter the URL of the website that you want to track. Select the **Create a Universal Analytics property** **only** option. **Step 5** Enter your **Business Information** and then click **Create**. The **UA** property is created. **Step 6** Under the **Property** section, search for the **Property Name** you just created. **Step 7** Click **Property Settings**. A section appears on the right side with all the relevant information about the property. Search for the **Tracking ID** and copy the details. ![The Google Analytics property picker open over the property table, with the Create Property button above the list and the property count in the footer.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/Create_Property1.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=298fecd5b1d2393d2a486a2a79ae8d92) > [!NOTE] > > **Note:** > > The Tracking ID is required while creating a Google Universal Analytics destination under Journeys. ### Create custom dimensions and custom metrics Perform the following steps to set up a custom dimension and a custom metric in Google Analytics: **Step 1** Go to **Admin** > **Custom Definitions** under **Property**. **Step 2** Choose Custom Dimension or Custom Metric based on your requirement and click **+New Custom Dimension/Metric** based on the selection. **Step 3** Add name, scope and click the **Active** checkbox to activate a Custom Dimension. Similarly, for Custom Metric, add name, scope, formatting type, minimum and maximum value and click **Active** checkbox to activate a custom metric. **Step 4** For Custom Dimensions, four scopes are provided, namely, **Hit, Session, User** and **Product**. Mostly, you may have to use the **User** scope as you need to add users based on Custom Dimensions. Similarly, for Custom Metric, two scopes are provided, namely, **Hit** and **Product**. To know more about the scopes, refer [here](https://support.google.com/analytics/answer/2709828?hl=en#zippy=%2Cin-this-article). **Step 5** Ensure that the custom dimensions are mapped to the correct index in Zeotap, else attributes will be mapped to the wrong values. ![The Custom Dimensions list in Google Analytics, with the + NEW CUSTOM DIMENSION button above a table of dimension name, index, scope, last changed date and state.](https://mintcdn.com/zeotap/xGzkHY-dcQy5tLit/articles/integrate-customer/Storage/integrate-customer/Custom_Dimension1.png?fit=max\&auto=format\&n=xGzkHY-dcQy5tLit\&q=85\&s=52e8c0033ac6b6b7d4da2a5a5c1dad83) ## Create the Google Universal Analytics destination After you have applied filters or added conditions for your users in Journeys, you can activate them in Google Universal Analytics under **Send to Destinations**. A new window appears, where you can set up your destination. You can use an already existing destination from the list of available Destinations or create a new one by clicking **+ Add New Destination**. ![The Send to Destinations panel listing existing destination cards, with a search box and the + Add New Destination link above them.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/google-universal-analytics-integration/google-universal-analytics-integration-2024-08-07.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=42531204e7105549801e4fe0bfdb6a84) Perform the following steps to add a new destination: **Step 1** Click **+ Add New Destination**. **Step 2** Search for **Google Universal Analytics.** **Step 3** Click **Google Universal Analytics** and enter a name for the Destination. **Step 4** Add the **Destination Name** and **Tracking ID** (that you received above) and save the destination. ![Step 1 of the destination wizard, Enter Destination Details, with a Destination Name field and a Tracking ID field below the Destination Details to Mapping breadcrumb.](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/google-universal-analytics-integration/google-universal-analytics-integration-2024-08-07-1.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=84172286050f5a0251325a83fe0fbfc6) **Step 5** In the mapping screen that appears, under **Choose your Action**, select **Send events to Google Universal Analytics in realtime** as the action for sending data from the workflow created in Journeys. Under **Map the Fields**, you need to map an identifier to Google Client ID. You can also add more fields as required. ![Step 2 of the destination wizard, the Mapping screen, showing the Choose your Action dropdown set to Send events to Google Universal Analytics in realtime, and a Map the Fields table pairing Catalogue fields with the Google Client ID and Custom Dimension destination fields.](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/google-universal-analytics-integration/google-universal-analytics-integration-2024-08-07-2.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=809baa9acd9591cef06b805f9eea23dc) **Step 6** Once the mapping is complete, click **Create Destination**. The destination is created and made available for activation on Journeys. Ensure that you map at least one attribute. Otherwise, the data does not flow to the Destination. For background on how actions and mappings work across all destinations, see [Configure a destination](/articles/integrate-customer/destinations#configure-a-destination) and [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). ## Add the destination to a journey After creating a destination, next, you need to link it in the **Send to Destination** node within the workflow, as explained below. **Step 1** In the workflow, click **+** and choose **Send to Destinations**. ![The Choose an action menu on the journey canvas, with Send to Destinations highlighted below Add a Condition, Add a Delay, Create a Multi-branch Split and Create a True/False Split.](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/google-universal-analytics-integration/google-universal-analytics-integration-2024-08-07-3.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=f85500c1ca5e46be8906f9ae4bcc9f09) **Step 2** Choose the destination from the list of available destinations by using the search feature. ![The Send to Destinations panel with the search box highlighted above the grid of existing destination cards.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/google-universal-analytics-integration/google-universal-analytics-integration-2024-08-07-4.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=da77666febd254b11959dee6c83b4b62) **Step 3** Under the **Destination Details** tab, the **Tracking ID** is populated automatically from the value you entered while creating the destination. However, in the **Audience Name** field, enter a name to categorise your users. ![The Google Universal Analytics destination panel on the Destination Details tab, with read-only Destination Name and Tracking ID fields and an empty Audience Name field below them.](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/google-universal-analytics-integration/google-universal-analytics-integration-2024-08-07-5.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=4e1145ca734d14c1862cf2844ca47dd4) **Step 4** Under the **Destination Settings** tab, choose the Action and mapping as per your requirement. ![The Destination Settings tab, with Choose your Action and Mapping dropdowns above a Mapping section listing the mapped identifier and an Edit Mapping link.](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/google-universal-analytics-integration/google-universal-analytics-integration-2024-08-07-6.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=2ba8f1d686f02f162b4e2086bdf81657) **Step 5** Upon clicking **Save Destination**. The destination is attached as shown in the image below. ![The Send to Destinations node with the Google Universal Analytics destination attached as a card showing its mapping name and action, above the search box and the remaining destination cards.](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/google-universal-analytics-integration/google-universal-analytics-integration-2024-08-07-7.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=0817e5a97bfe485188ee443a50608aef) ## Verify the data reaching Google Analytics Zeotap sends each delivery to Google Analytics through the Measurement Protocol, as event parameters. Use the fields below to work out what to look for in your GA reports. A delivery carries the following parameters: ```text theme={null} tid=UA-XXXXX-Y&cid=1220954604.1657797468&t=event&ec=audience&ea=add&el=Active Subscribers&ni=1&cd1=Gold ``` | **Field Name** | **Field Details** | **Comments** | | :- | :- | :- | | tid | Tracking ID | This is the Tracking ID of the property where the user wants to send the data. | | cid | GA Client Id | GA client id is the user identifier. It needs to be sent to Zeotap through its Web/GTM implementation. | | t | Hit Type | All the requests are sent as event hit type. | | ec | Event Category | It is hard coded to audience | | ea | Event Action | This can be added/removed based on whether user needs to be added to the audience or removed. | | el | Event Label | This is the name of the Audience defined by the user as a node level input. | | ni | Non Interaction Event | This is set to true as the events do not indicate a user performing an action. Non-interaction events are not taken into account when GA calculates bounces and session duration. | | cd1 | Custom Dimension 1 | This is the user defined Custom Dimensions at GA.Ensure that these are correctly mapped in Zeotap. | In Google Analytics, the deliveries surface in the Top Events report: the Event Category holds the fixed `audience` value, the Event Action distinguishes users being added from users being removed, and the Event Label carries the Audience Name you entered on the node. ![Three Google Analytics Top Events panels, broken down by Event Category, Event Action and Event Label, each listing the received values with total event counts and percentages.](https://mintcdn.com/zeotap/xGzkHY-dcQy5tLit/articles/integrate-customer/Storage/integrate-customer/Data_flow_to_Google_Analytics.png?fit=max\&auto=format\&n=xGzkHY-dcQy5tLit\&q=85\&s=bb2809cd3f75a168bd15aecbf67312de) Allow for the Google Analytics processing delay described under [Limits](#limits) before concluding that nothing arrived. ## Set up an audience in Optimize 360 Perform the following steps to set up audience in Optimize 360 - **Step 1** Link Optimize 360 to Google Analytics by following the instructions mentioned [here](https://support.google.com/optimize/answer/7008374?hl=en). This is a one-time setup activity. **Step 2** Go to Google Analytics, select the **Admin** tab and navigate to the **PROPERTY** created as mentioned under [Set up the Google Analytics property](#set-up-the-google-analytics-property) above. **Step 3** Under the **Property** column select **Audience Definitions** -> **Audiences**. **Step 4** Select **Audience Source** -> **All Website Data** -> **Next Step** -> **Audience Definition** -> **Create New**. **Step 5** Navigate to **Advanced** -> **Sequences** -> **Filter: Include Users** -> **Select Dimension**. ![The Google Analytics Audience Builder on the Sequences tab, with a Filter set to Include Users and a Step 1 condition on Event Label contains, its value dropdown open on the available event label values.](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/Select_Dimension.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=c512990c3e86a6aec43446cf307d4eb4) **Step 6** Create filtering criteria using Event Category (audience), Event Action (add), Event Label (Audience Name) and custom dimensions. **Step 7** Provide an **Audience Name**-> **Next** -> **Audience Destinations**. Your Optimize 360 account appears here once Optimize 360 is linked to this Analytics property, as in step 1. **Step 8** Select **Destination** and click **Publish**. Instructions on how to use the audience within Optimize are available [here](https://support.google.com/optimize/answer/6283435) (Target an Audience on Optimize 360). ![The final step of the Google Analytics audience builder, showing the completed Audience definition summary with its name, membership duration and sequence condition, followed by the Audience destinations section, which lists no eligible destination in this capture, and the Publish and Cancel buttons.](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/Publish.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=790acbee17a006e07a2880cf757387db) ## Limits * It can take up to 24-48 hours by GA to process the data. The latency is variable and depends on the type of account (paid or free), amount of data etc. If you are a paid customer (Analytics 360), the data limits are increased and latency is reduced. Find more details [here](https://support.google.com/analytics/answer/1070983?hl=en#zippy=%2Cin-this-article). * There are 20 indices available for different custom dimensions and 20 indices for custom metrics in each property. 360 accounts have 200 indices available for custom dimensions and 200 for custom metrics. Currently, we support 20 custom dimensions and 20 custom metrics to be sent to GA. Find more details [here](https://support.google.com/analytics/answer/2709828?hl=en#zippy=%2Cin-this-article). * Audiences exported to Google Optimize are updated on a daily basis. Find more details [here](https://support.google.com/analytics/answer/2611404?hl=en#zippy=%2Cin-this-article). ## Troubleshoot the integration | Symptom | What to check | | :- | :- | | No data at all reaches the destination | At least one attribute must be mapped on the destination's mapping. If nothing is mapped, data does not flow. | | Attributes land against the wrong values in GA | The custom dimension index used in the Zeotap mapping must match the index of that custom dimension in Google Analytics. Compare the index column on the GA Custom Definitions screen against your mapping. | | Events are not visible in GA yet | Google Analytics can take 24-48 hours to process the data, and the latency varies with account type and data volume. See [Limits](#limits). | | Users are missing from the GA reports | The GA Client ID is the user identifier for this integration and must reach Zeotap through your Web or Google Tag Manager implementation. Profiles with no GA Client ID have nothing for Zeotap to key the event on. | | An audience published to Optimize looks stale | Audiences exported to Google Optimize are updated on a daily basis. | | The journey node itself reports failures | Use the node-level execution details in Journeys — see [Identify Journey Errors](/articles/orchestrate-customer/identify-journey-errors) and [Troubleshooting Workflows](/articles/orchestrate-customer/journey-troubleshooting). | ## Next steps * [Create a Workflow](/articles/orchestrate-customer/create-a-workflow) — build the journey this destination attaches to. * [Add Re-entry Criteria](/articles/orchestrate-customer/add-re-entry-criteria) — control when a user can re-enter the workflow. * [Google Tag Manager source](/articles/integrate-customer/google-tag-manager) — the opposite direction, bringing the GA Client ID into Zeotap. * [Google Analytics 4](/articles/integrate-customer/google-analytics-4) — the GA4 property type, as a batch destination linked to an audience. * [Google Enhanced Conversions API (CAPI)](/articles/integrate-customer/google-enhanced-conversions-api-capi) — the other Google real-time destination, for conversion data to Google Ads. * [Destinations](/articles/integrate-customer/destinations) — actions, mappings and how destinations work across the platform. # Hello Charles Source: https://docs.zeotap.com/articles/integrate-customer/hello-charles Send a Zeotap CDP audience out to Hello Charles as a batch destination — upserting contacts with tags and custom properties for conversational commerce and WhatsApp messaging. ## What this is Hello Charles is a **batch destination**: data flows **out of Zeotap CDP into Hello Charles**. You link a Zeotap audience to the destination, and Zeotap upserts those customers as contacts in Hello Charles in batches of up to 1,000, matching on the external reference ID you map. Tags and custom properties travel with the contact data, so you can rebuild the Zeotap audience as a segment inside Hello Charles. Because this is a batch destination, it attaches to an **audience**, not to a journey. For the general activation model, see [Destinations](/articles/integrate-customer/destinations). Hello Charles is a destination only — there is no Hello Charles source, so nothing flows back into Zeotap CDP. You can confirm the direction and the supported identifiers for every connector on the [Integrations master list](/articles/integrations-master-list-publication/integrations-master-list). Zeotap's role stops at the contact data. Hello Charles owns the WhatsApp connection, the message templates, the sending and the campaign logic — so the WhatsApp side must already be set up in Hello Charles before this destination is useful. If instead you want Zeotap to trigger WhatsApp messages directly against your own WhatsApp Business Account, use the [WhatsApp](/articles/integrate-customer/whatsapp) destination rather than this one. > [!NOTE] > > The Hello Charles Batched Contacts API is currently in **closed beta**. You will need approval from your Hello Charles success manager before this integration can be enabled. ## Supported identifiers and actions The destination exposes a single action, **Send Contacts to Hello Charles**, which creates contacts that do not yet exist and updates those that do. | Hello Charles destination field | Required? | Notes | | - | - | - | | **External Reference Id** | **Required** | The identifier Hello Charles matches on for the upsert — typically a phone number in international format. | | **First Name** | Optional | | | **Last Name** | Optional | | | **PhoneNumber** | Optional | Sent as the contact's **main phone number**; it does not populate the contact's other phone-number slots. Needed when creating new contacts; it can be omitted when you are only updating existing contacts or adding tags. | | **Email Address** | Optional | Sent as the contact's **main email address**. Needed when creating new contacts; it can be omitted when you are only updating existing contacts or adding tags. | | **Tags** | Optional | Each tag must already exist in Hello Charles before you send it. | | **Custom Properties** | Optional | A separate group in the mapping. Each key must match the custom property's **technical name** in Hello Charles exactly — not its display name. | **How the upsert behaves.** Contacts are matched on External Reference Id. A match is updated in place; no match creates a new contact. Sending a tag adds it to the contact's tag list, and sending a custom property sets or overwrites that property. > [!WARNING] > > **Phone number formatting is the most common cause of sync failures.** Phone numbers must follow international format: > > * Start with a plus sign (`+`). > * Include the **country code**. > * Follow with the local number, with **no spaces, dashes, parentheses, or other special characters**. > * Example: `+15551234567`. > > If a phone number is malformed, the upsert will fail for that contact. Email addresses are validated less strictly — Hello Charles is primarily a WhatsApp channel — so a malformed email is less likely to fail the contact outright. > [!NOTE] > > Because the API is in closed beta, behaviours such as rate limits, field semantics, or response shapes may still change. Confirm with your Hello Charles success manager if you see unexpected results. ## Prerequisites **In Hello Charles:** * An active Hello Charles account with **API access** enabled. * Approval from a **Hello Charles success manager** to access the closed-beta Batched Contacts API. * WhatsApp already connected to Hello Charles — the WhatsApp Business Account created, the phone number verified, and your message templates built in Hello Charles. This destination only feeds contacts; it does not set up or send anything on WhatsApp. * Your customer-specific **Base URL** (the subdomain segment of your Hello Charles workspace URL). * A valid **API Key**, created as described below. * Any **tags** you plan to send, already created in Hello Charles. * Any **custom properties** you plan to send, already created in Hello Charles, with their **technical names** noted. **In Zeotap CDP:** * A source connected and ingesting data, and the ingested fields mapped to the Catalogue — see [creating a source](/articles/integrate-customer/creating-a-source). * An audience ready to send to Hello Charles. * Permission to create destinations in the **Integrate** module. See [destination access rules](/articles/integrate-customer/destination-access-rules). * The Catalogue attribute you plan to send as the **External Reference Id** (usually a phone number), formatted as described in [Supported identifiers and actions](#supported-identifiers-and-actions). > [!WARNING] > > Treat the API Key like a password — anyone holding it can read and write contact data in your Hello Charles account. Never share it in client-side code, screenshots, or chat messages. ## Create an API key in Hello Charles **1. Open API Keys in Hello Charles** Log in to **Hello Charles** and go to **Settings → API Keys**. The screen lists the keys already created for your workspace, with their description and permissions. ![Hello Charles API Keys screen listing existing keys by name, description and permissions, with the Create API Key button at the top right.](https://mintcdn.com/zeotap/kA2PopUy8ANuP4CD/articles/integrate-customer/Storage/integrate-customer/hello-charles/hello-charles-create-api-key.png?fit=max\&auto=format\&n=kA2PopUy8ANuP4CD\&q=85\&s=5a818c345ef70afc35485ecf8fb0850b) API Keys in Hello Charles settings, with Create API Key at the top right. **2. Create a key for Zeotap** If you do not already have a key you can reuse, click **Create API Key**, then: * Enter a recognisable **name** (for example, `Zeotap CDP Integration`) and a short **description**. * Set the **permissions** — **admin permissions are recommended**, so the integration can both upsert contacts and write tags and custom properties. * Save the key. **3. Copy the key value** Reveal the key value and copy it. Store it somewhere secure — you will paste it into Zeotap shortly. ## Pre-create tags and custom properties in Hello Charles **Tags and custom properties must exist in Hello Charles before Zeotap sends them.** A tag Hello Charles does not recognise is not applied to the contact, even though the rest of the contact record updates normally — so this step is what makes the audience segmentation work later. **1. Create the tags** Go to **Settings → Manage tags**. Use **Add tag** to create each tag you plan to send from Zeotap, optionally assigning it to one of your custom groups, then save. For example, to mark everyone in a particular audience, create a tag whose value is exactly the audience identifier you will send. ![Hello Charles Manage tags screen with a Custom groups row, a Tags list with an Add tag button, and a dialog listing tag groups with a Select group picker.](https://mintcdn.com/zeotap/kA2PopUy8ANuP4CD/articles/integrate-customer/Storage/integrate-customer/hello-charles/hello-charles-tags-and-properties.png?fit=max\&auto=format\&n=kA2PopUy8ANuP4CD\&q=85\&s=269ae5f6e0b24e59c74514c1dc10ac68) Manage tags in Hello Charles settings, showing custom groups, the existing tags, and the group picker in the add-tag dialog. **2. Create the custom properties** In Hello Charles settings, create each custom property you want to send — for example, loyalty tier, last purchase date, or the Zeotap audience name — and **note its technical name**. The technical name, not the display name, is the exact string you use as the mapping key in Zeotap. > [!TIP] > > Use this step to mirror your Zeotap audience structure in Hello Charles. A custom property such as `zeotap_audience_name` lets every contact carry the audience it came from, which makes rebuilding the same cohort as a Hello Charles segment straightforward. ## Create the Hello Charles destination **1. Find Hello Charles in the destination catalogue** Log in to Zeotap CDP and go to **Integrate → Destinations → Create Destination**. Search **All Destinations** for `Hello`, then select the **Hello Charles** card. ![Zeotap Integrate All Destinations search with Hello typed into the search field and the Hello Charles card returned below it.](https://mintcdn.com/zeotap/kA2PopUy8ANuP4CD/articles/integrate-customer/Storage/integrate-customer/hello-charles/zeotap-catalogue.png?fit=max\&auto=format\&n=kA2PopUy8ANuP4CD\&q=85\&s=298ae1afaae5855a5ef4257880f4e8ef) The Zeotap destination catalogue filtered to the Hello Charles card. **2. Enter the destination details** On **Enter Destination Details**, fill in: * **Destination Name** — a label that identifies this destination for you later. * **Base URL** — the Base URL for your Hello Charles API endpoint (the subdomain segment of your Hello Charles workspace URL). * **API Key** — the key you created in Hello Charles. The field hides the value as you type, and a reveal control lets you check it. ![Zeotap destination details step for Hello Charles with Destination Name, Base URL and API Key fields and a Next button at the bottom right.](https://mintcdn.com/zeotap/kA2PopUy8ANuP4CD/articles/integrate-customer/Storage/integrate-customer/hello-charles/zeotap-destination-form.png?fit=max\&auto=format\&n=kA2PopUy8ANuP4CD\&q=85\&s=2218ccc899af797f471bc0385794de58) Enter Destination Details for Hello Charles: Destination Name, Base URL, and API Key. Click **Next** to move to the mapping step. **3. Map the fields** On the **Mapping** step, each row pairs one **Catalogue attribute** on the left with a Hello Charles destination field on the right. Use **Choose Catalogue Attribute** to pick the Zeotap attribute for each field you want to send, and **+ Add Mapping Field** to add rows. Only **External Reference Id** is mandatory. Map the contact fields first, then use the separate **Custom Properties** group below them for anything that is not a standard contact field — typing the Hello Charles technical name as the destination key and choosing its type. ![Zeotap mapping step showing rows for External Reference Id, First Name, Last Name, PhoneNumber, Email Address and Tags, with a Custom Properties group heading below and an Add Mapping Field link.](https://mintcdn.com/zeotap/kA2PopUy8ANuP4CD/articles/integrate-customer/Storage/integrate-customer/hello-charles/zeotap-mapping-screen.png?fit=max\&auto=format\&n=kA2PopUy8ANuP4CD\&q=85\&s=2164e41ae96c2038515483f25c310c5b) The mapping step, pairing Catalogue attributes with the Hello Charles destination fields. > [!TIP] > > To add tags to contacts that already exist in Hello Charles, map only **External Reference Id** and **Tags** — the name, phone and email fields are not required for that case. **4. Carry the audience identity into Hello Charles** Hello Charles has no way to take a ready-made segment from Zeotap, so the audience identity has to travel as contact data and be rebuilt on the Hello Charles side. Choose one of two approaches, or both: * **As a tag** — map the **Segment Membership** Catalogue attribute (a list) to **Tags**, so each contact carries the audiences it belongs to. * **As a custom property** — map the audience name to a custom property such as `zeotap_audience_name`, so the value is stored as a structured field on the contact. Whichever you choose, the tag value or property key must already exist in Hello Charles from the previous section. ![Zeotap mapping with Segment Membership mapped to Tags, and under the Custom Properties group an Audience Name attribute mapped to a key named zeotap_audience_name.](https://mintcdn.com/zeotap/kA2PopUy8ANuP4CD/articles/integrate-customer/Storage/integrate-customer/hello-charles/zeotap-audience-segmentation-mapping.png?fit=max\&auto=format\&n=kA2PopUy8ANuP4CD\&q=85\&s=1762309ac680a03e4c38876978efd1b5) Segment Membership mapped to Tags, and Audience Name mapped to the zeotap_audience_name custom property. > [!TIP] > > A custom property is usually more durable than a tag: it gives you a named field to build precise segment conditions against in Hello Charles later, rather than a value buried in a tag list. **5. Save the destination** Click **Create Destination** to save the destination and its mapping. ## Link an audience to the destination Activating the audience follows the standard batch flow described in [Activate your batch audiences](/articles/integrate-customer/link-an-audience-to-the-destination): open the audience, use **Link to Destination**, and drag the **Hello Charles** destination onto the canvas. In **Destination Settings**, the Hello Charles specifics are: 1. Under **Choose your Action and Mapping**, confirm the action is **Send Contacts to Hello Charles** and select the mapping you saved. 2. Check the **Mapping** summary — it lists the attributes that will be sent. Use **Edit Mapping** if an attribute is missing. 3. Under **Choose Refresh Frequency**, set how often the audience re-delivers. The audience activates when you link it, but refreshes only start from the date and time you configure here; **Do Not Refresh** sends the audience once. 4. Click **Save Destination**. ![Zeotap Destination Settings panel with Choose your Action and Mapping set to Send Contacts to Hello Charles, a Mapping section listing the attributes being sent, and Choose Refresh Frequency options below.](https://mintcdn.com/zeotap/kA2PopUy8ANuP4CD/articles/integrate-customer/Storage/integrate-customer/hello-charles/zeotap-audience-flow.png?fit=max\&auto=format\&n=kA2PopUy8ANuP4CD\&q=85\&s=d1514640f4c4ecdaa2a02b75c784c8be) Destination Settings for a linked audience, showing the Send Contacts to Hello Charles action, its mapping, and the refresh options. Zeotap then delivers the audience to Hello Charles in batches of up to 1,000 contacts per request, splitting larger audiences across sequential requests. ## Verify the sync Check both sides. A completed run in Zeotap confirms the batch was accepted, but not that every value landed the way you expect — so always confirm on a contact in Hello Charles. **1. Confirm the run in Zeotap** Open the audience–destination pair and confirm the latest run completed with a non-zero qualified count. If it did not, start from [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail). **2. Confirm a contact in Hello Charles** In Hello Charles, go to **Audiences → All contacts** and look up one of the customers from your Zeotap audience — by phone number, or by whatever you mapped to External Reference Id. Confirm that the name, phone and email you mapped are present, that the **tags** you sent are attached, and that the **custom properties** show the values you expect. **3. Rebuild the audience as a Hello Charles segment** Go to **Audiences → Segments & lists** and build a segment. Choose the channel the segment is scoped to, then add a condition on the tag or custom property you used to mark this audience — for example, **Contact's** *custom property* → your Zeotap audience-name property → **contains** → the audience value. The contact count in the **Audience** panel recalculates as you edit the conditions. Expect it to be in the same range as the audience size in Zeotap rather than an exact match. ![Hello Charles Edit Segment screen with a segment name, a channel selector set to WhatsApp, a contact condition on a custom property using the contains operator, and a contact count panel on the right.](https://mintcdn.com/zeotap/kA2PopUy8ANuP4CD/articles/integrate-customer/Storage/integrate-customer/hello-charles/hello-charles-segment.png?fit=max\&auto=format\&n=kA2PopUy8ANuP4CD\&q=85\&s=85c80d2e7234b6738ae7d7b80e1e7906) A Hello Charles segment filtering on the custom property that carries the Zeotap audience name. ## Troubleshoot the Hello Charles destination | What you see | Likely cause | What to do | | - | - | - | | Nothing reaches Hello Charles, and the Zeotap run reports no customers qualified | The audience returned zero qualifying records at the moment the refresh ran, so no payload was sent. | Check the audience definition and its activity history — see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail). | | Contacts update correctly, but the tags you sent are not on them | The tag did not exist in Hello Charles when the batch arrived, so it was not applied. Hello Charles accepts the batch either way, which is why the Zeotap run still looks healthy. | Create the tag under **Settings → Manage tags** with exactly the value Zeotap sends, then re-run the audience. If the tag already exists with the same value, raise it with your Hello Charles success manager. | | Tags stopped matching an existing Hello Charles segment | The Zeotap audience was renamed after the Hello Charles segment was built, so the tag value now being sent no longer matches the segment's condition. | Update the condition in the Hello Charles segment to the new value, or rename the audience back. | | Custom property values are missing on the contact | The mapping key is the property's display name rather than its **technical name**, or the property does not exist in Hello Charles. | Re-check the technical name in Hello Charles and correct the destination key in the mapping. | | Individual contacts are missing from an otherwise successful run | Those records carry a phone number that is not in international format. | Correct the phone formatting upstream — see the formatting rules in [Supported identifiers and actions](#supported-identifiers-and-actions). | | A Hello Charles segment returns 0 contacts although the contacts are there | Segments in Hello Charles are scoped to a channel, so a segment on one channel will not return contacts you expect to see on another. The condition's property or operator may also not match the value sent. | Check the channel selected on the segment, then confirm the condition uses the same property and value that the mapping sends. | If the contact data lands correctly in Hello Charles but the platform behaves unexpectedly afterwards — tags not displaying, segments not populating, messages not sending — that is on the Hello Charles side; contact your Hello Charles success manager with the contact's external reference ID and the time of the run. ## FAQ **Can Zeotap create the segment for me inside Hello Charles?** No. Hello Charles does not expose a way for Zeotap to create segments, so Zeotap sends the audience identity as a tag or a custom property on each contact and you build the matching segment once in Hello Charles. **Does Zeotap send the WhatsApp messages?** No. This destination only keeps contact data in sync. Template selection, sending and campaign logic all stay in Hello Charles. If you want Zeotap to trigger the messages instead, use the [WhatsApp](/articles/integrate-customer/whatsapp) destination. **Can I update existing contacts without re-sending their name, phone and email?** Yes. Map only **External Reference Id** plus whatever you want to change — tags, for instance. The contact is matched on External Reference Id and updated in place. ## Next steps * [Destinations](/articles/integrate-customer/destinations) — how destinations, actions and mappings fit together, including [configure a destination](/articles/integrate-customer/destinations#configure-a-destination) and [define the mapping](/articles/integrate-customer/destinations#define-the-mapping). * [Activate your batch audiences](/articles/integrate-customer/link-an-audience-to-the-destination) — the full audience activation flow. * [Destination access rules](/articles/integrate-customer/destination-access-rules) — who can create and edit destinations. * [WhatsApp](/articles/integrate-customer/whatsapp) — send WhatsApp messages directly from Zeotap instead of through Hello Charles. # HubSpot Source: https://docs.zeotap.com/articles/integrate-customer/hubspot Send Zeotap CDP audiences out to HubSpot as contacts and contact lists, by connecting and signing in to your HubSpot account. ## What this is The HubSpot destination sends audiences **out of Zeotap CDP to HubSpot**. Each audience you link is delivered into your HubSpot account as contacts, as a contact list, or both, ready to use in HubSpot campaigns. HubSpot is a CRM platform that helps you gather and use data to engage with your customers. Integrated with Zeotap CDP, it lets you manage and utilise your contact information efficiently. HubSpot appears in Zeotap CDP in both directions. Use this table to confirm you are on the right page: | Integration | Direction | Runs from | | :- | :- | :- | | **HubSpot** (this page) | Zeotap CDP to HubSpot | Destinations, linked from Audiences | | [HubSpot Source](/articles/integrate-customer/hubspot-source) | HubSpot to Zeotap CDP | Sources | Two HubSpot concepts decide what this destination can do: * **Contact** — in HubSpot, a contact is the information held about an individual person: the user profile, with attributes such as first name, last name, cell phone number and email address. * **Contact list** — in HubSpot, a contact list is a segment or cohort of customers. You build the cohort as an audience in the Zeotap CDP **Audiences** application and push it to HubSpot as a list. > [!NOTE] > > HubSpot only adds contacts (email addresses) that already exist in your HubSpot account to a contact list. Push the contacts (user profiles) from Zeotap CDP to HubSpot first, then add those contacts to the contact list. ## Supported identifiers and actions Zeotap CDP sends contact information to a contact list. Currently, only email addresses are sent as part of the contact list attributes. The following table lists the available action types for the integration and the delivery features supported for each: | Action | [ID Extension](/articles/segment-customer/extend-your-audience#id-extension) | [Delete](/articles/segment-customer/delta-upload-and-delete-functions) | [Delta Upload](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :-: | :-: | :-: | | Send Contact to Contact List | ✅ | ✅ | — | | Create Contact | — | — | — | | Update Contact | — | — | — | For **Send Contact to Contact List**, the raw email address of the contact is chosen by default as the [output identifier](/articles/segment-customer/choose-the-output-identifiers). For **Create Contact**, the mapping carries the general profile attributes HubSpot needs for a contact — for example Email, First Name, Last Name, Phone, City, Country and Company. You can add custom attributes to the mapping with **+ Add Mapping Field**. ## Prerequisites Have the following ready before you create the destination: * **A HubSpot account** — an active account on HubSpot. For how to create one, see [Set up your HubSpot account](https://knowledge.hubspot.com/get-started/set-up-your-account). * **Sign-in credentials for that account** — you sign in to HubSpot during destination creation, and the connection grants Zeotap permission to manage the `contacts` and `contact lists` in that account. * **The HubSpot account you want to send data to** — if you manage more than one, see [Manage multiple HubSpot accounts](https://knowledge.hubspot.com/account/manage-multiple-hubspot-accounts) before you connect. * **Contacts already present in HubSpot**, if your goal is to populate a contact list. See the note under [What this is](#what-this-is). * An audience in Zeotap CDP to link to the destination, and a role that grants destination edit rights on the organisation that owns the destination. See [Destinations: prerequisites](/articles/integrate-customer/destinations#prerequisites). ## Create the HubSpot destination Perform the following steps to create the destination in Zeotap CDP: **Step 1** Log in to the Zeotap CDP App and go to the **Destinations** application. ![Destinations listing in the Zeotap CDP App, with the + Create Destination button highlighted above the table of existing destinations](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_1.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=92dfe8ecb29e59c9d7d57cb954e54618) **Step 2** Under **All Destinations**, search for **HubSpot**. ![All Destinations catalogue in the Zeotap CDP App, with the destination search box highlighted above the destination cards](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_2.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=6f5f0f5367788fb4e9e946f4b3cb5874) **Step 3** Click **HubSpot**. A screen appears with details about the destination on the left, and on the right the fields required to establish the integration. Enter the required details: a. Enter a name for the destination. b. Enter the **Client name**, which indicates the placeholder for the destination. As a best practice, and for easy identification, provide a name you can recognise the destination by. c. Click **Connect HubSpot**. You are redirected to the HubSpot login page. ![Enter Destination Details screen for HubSpot in the Zeotap CDP App, showing the Destination Name and Client name fields above the Connect HubSpot button](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/hubspot/hubspot-2023-11-07.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=863fe2b11e0abb14bf88385c249bc314) d. In the new screen that appears, sign in to your HubSpot account with your existing credentials. ![HubSpot connection screen offering Create a new HubSpot account or Sign in to your HubSpot account, with the sign-in option highlighted](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/hubspot/hubspot_new_1.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=307b22150cb07d97db249d612478ac8a) e. Once connected, a screen appears where you choose the account you want to send data to. For more about handling several accounts, see [Manage multiple HubSpot accounts](https://knowledge.hubspot.com/account/manage-multiple-hubspot-accounts). ![HubSpot Choose an account screen, listing the HubSpot accounts available to connect with a search box and a Choose Account button](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/hubspot/hubspot_new_2.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=36f096014260b651e4e4a1592597bbe1) f. Once the connection between the Zeotap CDP App and your HubSpot account is established, you are redirected back to Zeotap CDP. The **Access Token** and **Refresh Token** are filled in for you, along with the expiry period for the access token. Through this connection, you grant Zeotap permission to manage the `contacts` and `contact lists` within the HubSpot account. ![Enter Destination Details screen after the HubSpot connection is established, highlighting the Access Token, Access Token Expires In (second) and Refresh Token fields that Zeotap CDP fills in](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/hubspot/hubspot-2023-11-07-1.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=db4e9388b0b2e59c826266025ec1b192) g. Click **Next** to proceed to mapping. **Step 4** In the new screen that appears, choose either **Create Contact** or **Send Contact to Contact List** as your action. For how mappings work, see [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). a. To create a contact in HubSpot: i. Under **Choose your Action**, choose **Create Contact** from the drop-down menu. ![Choose your Action drop-down in the Zeotap CDP App, with Create Contact highlighted above Send Contact to Contact List](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/hubspot/hubspot-2023-11-07-2.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=ffd8d80cce4de5188e39409627a4d086) ii. Under **Map the Fields**, the general attributes needed to create a contact (user profile) are displayed. You can include custom attributes for the contact using **+ Add Mapping Field** at the bottom left of the screen. ![Map the Fields screen for Create Contact, pairing Catalogue fields with HubSpot destination fields such as Email, First Name, Last Name, Phone, City and Country, with + Add Mapping Field highlighted](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/hubspot/hubspot-2023-11-07-3.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=802818262c12ea7b37657662f8716c95) iii. Review the fields and click **Create Destination**. The created destination gets listed in the **Audiences** application, where you can use it to send contacts (user profiles) from Zeotap CDP to HubSpot. ![Mapping screen in the Zeotap CDP App with Create Contact selected under Choose your Action and the first Catalogue-to-destination field pairs listed under Map the Fields](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/hubspot_1.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=1a84342653025ff00098825916da96db) b. To send a contact to a contact list in HubSpot: i. Under **Choose your Action**, choose **Send Contact to Contact List** from the drop-down menu. ![Choose your Action drop-down in the Zeotap CDP App, with Send Contact to Contact List highlighted below Create Contact](https://mintcdn.com/zeotap/FCzFgv-TEYPP6Zvb/articles/integrate-customer/Storage/integrate-customer/hubspot/hubspot-2023-11-07-5.png?fit=max\&auto=format\&n=FCzFgv-TEYPP6Zvb\&q=85\&s=28dd2a4c85e1dd65ba65f502fd8f7cbc) ii. Under **Map the Fields**, the raw email address of the contact is chosen by default as the [output identifier](/articles/segment-customer/choose-the-output-identifiers). Currently, only email addresses are sent as part of the contact list attributes. ![Mapping screen with Send Contact to Contact List selected under Choose your Action and Email Raw mapped as the identifier under Map the Fields](https://mintcdn.com/zeotap/WL_Z70xFFcSOCGW9/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/hubspot_2.png?fit=max\&auto=format\&n=WL_Z70xFFcSOCGW9\&q=85\&s=8b3fe6c2a74d094f7ecabfee2fee4522) iii. Review the fields and click **Create Destination**. The created destination gets listed in the **Audiences** application, where you can use it to send contacts to contact lists from Zeotap CDP to HubSpot. ## Link an audience to the destination For information about how to link an audience (segment) to the created destination in the **Audiences** application, see [Link an Audience to the Destination](/articles/integrate-customer/link-an-audience-to-the-destination). It can take up to **three business days** for segments to be available at the HubSpot seat. > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience or a segment could be a specific group of customers who are over 18 years of age and who have performed an `addToCart` event within the last 30 days. ## User disqualification from audiences This integration supports user disqualification from audiences. A user can be disqualified from an audience (segment) for various reasons, such as not meeting the audience criteria, consent requirements or other conditions set for that audience. * When a user is disqualified from an audience, Zeotap CDP initiates a user deletion request in the next refresh cycle. These requests are sent to the audiences linked to the specific destination. * Disqualified users are excluded from the audiences based on the refresh frequency configured for that audience. * User disqualification is a programmatic process that works automatically. You do not need to specify anything to trigger the disqualification and exclusion of users from audiences. ## Verify the audience reached HubSpot Check both sides of the delivery. **In Zeotap CDP** — open the destination and confirm the linked audience recorded a run with a completed status and a non-zero qualified count. See [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). **In HubSpot** — perform the following steps to view the contact lists (segments) pushed by Zeotap CDP: **Step 1** Log in to the HubSpot CRM platform and go to **Contacts > Lists**. This screen gives details of the segments, such as list name, list size and last updated date. ![Lists screen in HubSpot under Contacts, showing the list name, list size, type, object, last updated and creator columns](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/hubspot/hubspot_new_4.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=014416c8480ab6b15f7b8f89df1f1473) **Step 2** Under **Lists**, click the list you want to check. This displays the contacts included in that list. ![A static list open in HubSpot, showing its size in contacts and the contact rows with name, email, phone number and contact owner columns](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/hubspot/hubspot_new_5.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=3203d5d5b75318c816b73b63836c4a0c) The two counts will not match exactly. HubSpot adds to the list only those contacts that already exist in the account, so the list size is bounded by how many of the audience's email addresses HubSpot already holds. ## Troubleshoot the HubSpot destination | Symptom | What it means | What to do | | :- | :- | :- | | The list has not appeared under **Contacts > Lists** in HubSpot | Either no refresh has completed on the Zeotap CDP side yet, or the segment has not yet become available at the HubSpot seat | Confirm the audience–destination pair recorded a completed refresh — see [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). If it has, allow up to three business days. On the HubSpot **Lists** screen, clear any active search or filter before concluding the list is missing. | | The list arrives, but contacts you expected are missing from it | HubSpot only adds contacts (email addresses) that already exist in the HubSpot account to a contact list | Run the **Create Contact** action first so the user profiles exist in HubSpot, then send those contacts to the contact list. | | Contacts in the list carry only an email address, with no other attributes | Currently, only email addresses are sent as part of the contact list attributes | Use the **Create Contact** action to send the other profile attributes, mapping them under **Map the Fields**. | If the destination is configured correctly and the problem persists, read the error recorded on the audience–destination pair: [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail) lists the error strings that surface there, and [When to contact support](/articles/integrate-customer/destinations#when-to-contact-support) covers when to raise a ticket and what to include in it. ## Next steps * [Link an audience to the destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore audience scheduling →](/articles/segment-customer/audience-scheduling) * [Choose the output identifiers →](/articles/segment-customer/choose-the-output-identifiers) * [Bring HubSpot data into Zeotap CDP with the HubSpot Source →](/articles/integrate-customer/hubspot-source) * [Explore the integrations master list →](/articles/integrations-master-list-publication/integrations-master-list) # HubSpot Source Source: https://docs.zeotap.com/articles/integrate-customer/hubspot-source How the HubSpot Source brings contact and company records from your HubSpot account into Zeotap CDP. ## What this is The HubSpot Source brings customer records from your HubSpot account **into** Zeotap CDP. HubSpot is a CRM platform that helps you gather and use data to engage with your customers; connecting it as a Source means the customer information you already keep there is collected alongside the other data you send to Zeotap CDP, so you can understand your customers better, create appealing content and build strong connections. To send data the other way — out of Zeotap CDP and into HubSpot — see the [HubSpot destination](/articles/integrate-customer/hubspot), which covers pushing contacts and contact lists to your HubSpot account. The HubSpot Source sits in the **CRM Data** source category, alongside [Microsoft Dynamics CRM](/articles/integrate-customer/ms-dynamics-source) and [Salesforce CRM](/articles/integrate-customer/salesforce-crm). For the category as a whole, see [CRM Data](/articles/integrate-customer/crm-data). Each source you create reads one HubSpot standard object — either **Contacts** or **Companies** — and only the fields you select from that object. The first sync runs once the source is created; after that, Zeotap CDP re-reads HubSpot on the sync frequency you chose, fetching either the complete dataset each time or only the changes since the previous run. ## Next steps [Create a HubSpot Source](/articles/integrate-customer/create-a-hubspot-source) covers the two stages of setting the integration up. First, on the HubSpot side, you create a private app and copy the bearer token it issues. Then, in the Zeotap CDP App, you create the source under the **CRM Data** category, supply that token, choose the standard object, sync frequency and fetch mode, and select the fields to ingest. > [!NOTE] > > Choose the fields with care. Field selection cannot be edited after the source is created — changing it means creating a new source in Zeotap CDP. # Implement a Braze Currents source Source: https://docs.zeotap.com/articles/integrate-customer/implement-a-braze-currents-source Configure a Custom Currents Export in Braze so that the engagement events you select stream from Braze into your Zeotap CDP source. ## What this is The Braze Currents source carries data **into** Zeotap CDP. Braze Currents is a real-time stream of the engagement events exported out of the Braze platform; once the connection is established, Braze sends the events you select to the endpoint Zeotap CDP generated for your source, as batched JSON payloads. Setting the integration up takes two halves. Creating the source in Zeotap CDP is covered in [Create a Braze Currents Source](/articles/integrate-customer/create-a-braze-currents-source), and for what the integration is for, see [Braze Currents](/articles/integrate-customer/braze-currents). This page covers the other half — the Custom Currents Export you configure on the Braze side. To send data in the opposite direction, **out of Zeotap CDP to Braze**, use a Braze destination instead: * [Braze](/articles/integrate-customer/braze-1) pushes audiences built in Zeotap CDP to Braze for engagement and activation. * [Braze Integration](/articles/integrate-customer/braze-integration) covers the methods for sending user traits and real-time events to Braze. ## Supported identifiers and events Each record that reaches Zeotap CDP must carry at least one identifier — for example an email address, a phone number, a cookie ID or an advertising ID. See [Best Practices for Braze Currents](/articles/integrate-customer/best-practices-for-braze-currents) for the wider guidance on the data you send. Only the events you tick under **Data Configuration** in Braze are exported, so the event selection you make in step 5 below decides what Zeotap CDP receives. ## Prerequisites Before you start in Braze, make sure you have the following: * **A Braze Currents source created in Zeotap CDP.** See [Create a Braze Currents Source](/articles/integrate-customer/create-a-braze-currents-source). * **The API URL and the write key for that source.** Both are generated when the source is created and appear on the source's **IMPLEMENTATION DETAILS** tab under **Write key for your reference is**, each with a copy button. The API URL establishes the connection between Braze and Zeotap CDP; the write key authorises the data being ingested. You paste both into Braze below. * **Access to your Braze dashboard**, with **Partner Integrations > Data Export** available. ![The IMPLEMENTATION DETAILS tab of a newly created Braze Currents source in Zeotap CDP, with the source shown in the CREATED state above a summary row of Created By, Created Date, Region and Data Entity, followed by the API URL and Write Key fields, each with a copy button.](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-a-braze-currents-source/implement-a-braze-currents-source-2024-01-11-1.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=f1e4545cece9c9a1bc80a896386457ca) ## Configure data streaming in Braze These steps establish the streaming connection between Braze Currents and Zeotap CDP, and let you choose which events are streamed. **1. Open Data Export** Log into the Braze platform and go to **Partner Integrations > Data Export**. ![The Braze dashboard with Partner Integrations selected in the left navigation and its menu open, showing Technology Partners, the highlighted Data Export entry described as create and manage your Currents connections, Data Sharing and Solutions Partners.](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-a-braze-currents-source/implement-a-braze-currents-source-2023-10-26.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=bc2255c275928d738496e0b8badd3232) **2. Create a Custom Currents Export** Click **Create New Current** and choose **Custom Currents Export** from the list to send data to Zeotap CDP. ![The Braze Currents Integrations screen with the Create New Current button clicked and its drop-down list open, showing Custom Currents Export highlighted among the other export types.](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-a-braze-currents-source/implement-a-braze-currents-source-2023-10-26-6.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=7919c05ae093abcbbc301c01b287e85b) **3. Name the integration** In the window that appears, enter an **Integration Name** and a **Contact Email** address. ![The Integration Name and Contact Email fields at the top of the Braze Custom Currents Export form, with a sample integration name entered.](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-a-braze-currents-source/implement-a-braze-currents-source-2023-10-26-8.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=dc55d3657a90b5e0d9eff5517d3dc599) **4. Enter the Zeotap CDP credentials** Under **Credentials**, enter the **API URL** from your source's **IMPLEMENTATION DETAILS** tab as the **Endpoint**, and the write key from the same tab as the **Bearer Token**. ![The Credentials section of the Braze Custom Currents Export form, showing where the Endpoint and Bearer Token values are entered.](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-a-braze-currents-source/implement-a-braze-currents-source-2023-10-26-5.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=2bd3f73b41dcc54366809dea1c78cdb9) **5. Select the events to export** Under **Data Configuration**, select the events you want to send to Zeotap CDP. Braze groups them as Campaign Events, Canvas Events, Experiment Step Events, Subscriptions, Canvas Exit and Message Events. ![The General Settings tab of the Braze Data Configuration screen, listing the Message Engagement Events available for export as checkboxes grouped under Campaign Events, Canvas Events, Experiment Step Events, Subscriptions, Canvas Exit and Message Events, above a Select All option.](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-a-braze-currents-source-2023-03-06.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=ad7dcc4a8d3f7bd6f7b5de37a2110176) **6. Launch the current** Scroll to the bottom of the screen and click **Launch Current** to save the changes. With the streaming connection established, Braze Currents starts sending the selected events to Zeotap CDP. ## Verify the connection Once events start reaching Zeotap CDP, the status of the source changes from **Created** to **Integrated** on the Sources listing page. **Created** means the source exists but has not yet received any data; see [Components of the Source Listing Page](/articles/integrate-customer/components-of-the-source-listing-page) for the full set of statuses. * Open the source and check the **[PREVIEW DATA](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab)** tab to see the data flowing in. * Use the **[SOURCE REPORT](/articles/integrate-customer/source-report)** tab for the ingestion health and status of the source. ## Troubleshoot the connection **The source stays in the Created state and nothing appears under PREVIEW DATA.** Re-check the Braze current: * The **Endpoint** is the **API URL** from the **IMPLEMENTATION DETAILS** tab of this source, not of another source. * The **Bearer Token** is the write key from that same tab. * At least one event is selected under **Data Configuration** — only selected events are exported. * The current was saved with **Launch Current**. **Only some events arrive.** Only the events ticked under **Data Configuration** are exported. Reopen the current in Braze and confirm the selection. **The country and city columns are empty.** Records for the country and city columns are blacklisted for ingestion, because Zeotap CDP resolves the country and city from the user's IP address automatically. For the complete list, see [Blacklisted Fields for Data Ingestion](/articles/integrate-customer/blacklisted-fields-for-data-ingestion). **Records arrive but are rejected.** The Ingestion Log, under the **SOURCE REPORT** tab of the source, gives more information about the errors identified while ingesting a record. See [Understanding the Ingestion Log Error](/articles/integrate-customer/understanding-the-ingestion-log-error). ## Next steps * [Map the catalogue for Customer Data →](/articles/unify-customer/map-the-catalogue-for-customer-data) * [Best Practices for Braze Currents →](/articles/integrate-customer/best-practices-for-braze-currents) * [Explore the components of the Preview Data tab →](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) * [Explore source reports →](/articles/integrate-customer/exploring-source-reports) * [Send audiences out to Braze →](/articles/integrate-customer/braze-1) # Implement a Cleverpush real-time source Source: https://docs.zeotap.com/articles/integrate-customer/implement-a-cleverpush-real-time-source Point a Cleverpush webhook at your Zeotap CDP source so subscriber events stream from Cleverpush into Zeotap CDP as they happen. ## What this is The Cleverpush (Real-time) source carries data **into** Zeotap CDP. You configure a webhook inside Cleverpush that points at the API URL Zeotap CDP generated for your source, and Cleverpush pushes the events you select as they happen. To send data the other way — out of Zeotap CDP and into Cleverpush — use the [Cleverpush Real Time Integration](/articles/integrate-customer/cleverpush-real-time-integration) for Journeys, or the [Cleverpush destination](/articles/integrate-customer/cleverpush-destination) for audience activation. This page covers the Cleverpush side of the connection. Creating the source itself is covered in [Create a Cleverpush Real-Time Source](/articles/integrate-customer/create-a-cleverpush-real-time-source). ## Supported identifiers The integration fetches information about the subscribers of a Cleverpush channel, such as the subscription ID, channel ID, `created_at`, country, custom attributes and segments. For the integration overview, see [Cleverpush Real Time Source](/articles/integrate-customer/cleverpush-real-time-source). Not every field a webhook sends is ingested. See [Some fields are missing from the ingested data](#some-fields-are-missing-from-the-ingested-data). ## Prerequisites Before you configure the webhook, make sure you have the following: * **A Cleverpush channel.** If you have not created one yet, see [Create a New Channel in Cleverpush](/articles/integrate-customer/cleverpush_appendix#create-a-new-channel-in-cleverpush). * **At least one platform set up on that channel.** The webhook is configured per platform, and Zeotap CDP supports Web Push, App Push and Email Push. Setup steps for each platform are in the [Cleverpush appendix](/articles/integrate-customer/cleverpush_appendix). * **A Cleverpush (Real-time) source created in Zeotap CDP.** Creating the source generates an **API URL** and a **Write Key**, both shown on the source's **IMPLEMENTATION DETAILS** tab. Copy both before you start; you paste them into Cleverpush below. ![The IMPLEMENTATION DETAILS tab of a Cleverpush Real Time source in Zeotap CDP, showing the Access Details section, with a copy button beside each row.](https://mintcdn.com/zeotap/YsfMI6ywZtMAuMQe/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-real-time-source/Cleverpush_real_time_3.png?fit=max\&auto=format\&n=YsfMI6ywZtMAuMQe\&q=85\&s=a99153080a961b52cd3a7e1fc123f968) ## Set up the channel and its platforms in Cleverpush **1. Open Channels** Log into the Cleverpush platform and go to **Channels**. **2. Select your channel** Select the channel you created from the **Channels** drop-down menu. ![The Cleverpush dashboard with the Channels drop-down menu open, listing the most recent channels along with All channels and Add Channel.](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-real-time-source/Cleverpush_imple_0.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=2a2202317aeef807af5851332dc49cb0) **3. Set up the platforms** On that channel, set up the platforms you want notifications pushed to. Zeotap CDP supports Web Push, App Push and Email Push. ![The Cleverpush channel settings page, with the Platforms list showing Web Push, App Push and Email each offering a Setup now button.](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-real-time-source/Cleverpush_imple_1.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=ecc2f9a821b2a780d00381391987efd2) **4. Confirm the platforms are listed** The configured platforms appear under **PLATFORMS** in the left panel. ![The Cleverpush channel page with Web Push, App Push and Email listed under PLATFORMS in the left panel.](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-real-time-source/Cleverpush_imple_2.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=ddade94d6763fff0afb38e32fafd90b0) ## Configure the webhook in Cleverpush **1. Open Webhooks for the platform** Under **PLATFORMS**, select the platform you want to establish the real-time connection for, then go to **Webhooks**. **2. Name the webhook** Enter a **Webhook name** for your integration. **3. Set the type** Choose **Custom** as the **Type**. **4. Enter the webhook URL** In **Webhook URL**, paste the API URL from the **IMPLEMENTATION DETAILS** tab of your Cleverpush (Real-time) source. **5. Name the authorisation header** In **Authorization Header Name**, enter a name for the header. We recommend `Zeotap_write_key`. **6. Enter the write key** In **Authorization Header Value**, paste the Write Key from the **IMPLEMENTATION DETAILS** tab of your Cleverpush (Real-time) source. **7. Choose the events** Under **Webhook events**, select the events you want to send to Zeotap CDP. **8. Save** Click **Save**. The real-time connection is now established, and Cleverpush starts sending the selected events to Zeotap CDP. ![The Cleverpush Webhooks form with empty fields for Webhook name, Type, Webhook URL, JSON Payload, Authorization Header Name and Authorization Header Value, followed by the Webhook events list and the Save button.](https://mintcdn.com/zeotap/xcJBv790xp5wo6aA/articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-real-time-source/Cleverpush_imple_3.png?fit=max\&auto=format\&n=xcJBv790xp5wo6aA\&q=85\&s=8938ad8ea0dd893778b7ac9c6723f040) ## Verify the connection Open your Cleverpush (Real-time) source in **Sources** in Zeotap CDP and check the following: * **[PREVIEW DATA](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab)** — shows the records that have reached the system. Once data starts flowing in, the status of the source changes from **Created** to **Integrated**. * **[SOURCE REPORT](/articles/integrate-customer/source-report)** — shows the ingestion health and status of the source. ## Troubleshoot the connection ### The source is still in the Created state **Created** means the source exists but has not yet received any data; it becomes **Integrated** once records start arriving. If it has not changed, re-check the values you entered in Cleverpush: the **Webhook URL** against the API URL on the **IMPLEMENTATION DETAILS** tab, the **Authorization Header Value** against the Write Key on the same tab, and whether at least one event type is selected under **Webhook events**. ### Some fields are missing from the ingested data The records for the country and city columns are blacklisted for ingestion, because Zeotap CDP resolves the country and city from the user's IP address automatically. For the complete list, see [Blacklisted Fields for Data Ingestion](/articles/integrate-customer/blacklisted-fields-for-data-ingestion). ### Records arrive but are rejected The **Ingestion Log**, under the **SOURCE REPORT** tab of the source, gives more information about the errors identified while ingesting a record. See [Understanding the Ingestion Log Error](/articles/integrate-customer/understanding-the-ingestion-log-error). ## Next steps * [Map the catalogue for customer data](/articles/unify-customer/map-the-catalogue-for-customer-data) — map the ingested fields to the Zeotap Catalogue so the data can be used downstream. * [Components of the Preview Data Tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) — what each field on the PREVIEW DATA screen means. * [Cleverpush Real Time Integration](/articles/integrate-customer/cleverpush-real-time-integration) — send identifiers and attributes from Zeotap CDP back to Cleverpush. # Implement a Zeotap Google Cloud Storage Source Source: https://docs.zeotap.com/articles/integrate-customer/implement-a-zeotap-google-cloud-storage-source Find the access details, bucket path and PGP public key for a Zeotap Google Cloud Storage source, then upload your data files to it. ## What this is A Zeotap Google Cloud Storage source brings data **into** Zeotap CDP: Zeotap provisions a Google Cloud Storage bucket for you, you place your files in it, and Zeotap CDP ingests them. After you have [created the source](/articles/integrate-customer/create-a-zeotap-google-cloud-storage-source), everything you need to start sending files sits on the source's **Implementation Details** tab — the basic details the source was created with, the G Suite ID and project ID the upload tools ask for, the bucket path to send data to, the public PGP key for encrypted sources, and an option to upload files straight from your machine. This page walks through that tab and the upload it offers. To send data the other way — deliver an audience out of Zeotap CDP into a Google Cloud Storage bucket you own — see the [Google Cloud Storage destination](/articles/integrate-customer/google-cloud-storage) instead. ## Prerequisites > [!NOTE] > > Before you open the Implementation Details tab, confirm: > > * A **Zeotap Google Cloud Storage** source exists in your account. See [Create a Zeotap Google Cloud Storage Source](/articles/integrate-customer/create-a-zeotap-google-cloud-storage-source). > * To upload files, your account has the **Editor** role. A **Viewer** account cannot upload. > * If the source was created with **PGP Encrypted** set to **True**, you must encrypt each file locally with the source's public key before uploading. See [PGP encryption in sources](/articles/integrate-customer/pgp-encryption-in-sources). ## Open the Implementation Details tab Navigate to the **Sources** application under **Integrate** in the Zeotap CDP app, click the source you created, and open the **Implementation Details** tab. ![Implementation Details tab showing Created By, Created Date, File Format, File Delimiter, Region, Data Entity and PGP encrypted, the PGP public key download link, the Access Details section and the Path Details section.](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-a-zeotap-google-cloud-storage-source/implement-a-zeotap-google-cloud-storage-source-2025-01-15.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=66021f1a3dc4e2ccd07149a6315856f3) The Implementation Details tab of a Zeotap Google Cloud Storage source: the summary strip, the PGP public key download, Access Details and Path Details. ### The source summary The strip across the top of the tab records the choices made when the source was created: **Created By**, **Created Date**, **File Format**, **File Delimiter**, **Region**, **Data Entity** and **PGP encrypted**. Keep your uploads consistent with the **File Format** and **File Delimiter** shown here. A single source can carry files with multiple schemas, provided they logically belong to the same source and the file format and delimiter stay the same. ### The public PGP key If **PGP Encrypted** was set to **True** at creation, the tab offers a downloadable **PGP Public key (.asc file)**. Download it, encrypt each file with it on your side, and upload only `.pgp` files. [PGP encryption in sources](/articles/integrate-customer/pgp-encryption-in-sources) describes the full flow, including how Zeotap CDP decrypts what you send. ### Access Details The **Access Details** section holds the two values every upload method asks for: * **G Suite ID** — the G Suite ID in your organisation that can be used for file uploads and transfers. Authenticate with this account whenever you upload through the Google Cloud Console, `gsutil` or Cyberduck. * **Project ID** — your project ID for the source. ### Path Details The **Path Details** section holds: * The Google Cloud Storage path to which you can send the data, listed against the source's region (for example, **EU**). * The **+ ADD FILES** option, which uploads files directly from your local machine to that path. > [!NOTE] > > For [PGP-encrypted](/articles/integrate-customer/pgp-encryption-in-sources) sources, upload files only in the `.pgp` format. ## Upload files from the Implementation Details tab Click **+ ADD FILES** and select the files to send. They are uploaded to the path shown under **Path Details**, with no further configuration. Users with the **Editor** role only have access to this feature. If you have the **Viewer** role, ask your Zeotap administrator to grant you the **Editor** role, or ask an Editor to perform the upload for you. Keep every file uploaded through the Zeotap CDP interface to less than 100 MB. There is no size restriction on files uploaded directly to the bucket by any of the other methods below. ## Other ways to upload files The same bucket accepts files from outside Zeotap CDP. Use one of these when a file is too large for the interface upload, or when you want a scriptable or desktop workflow. Each method authenticates with the **G Suite ID** and **Project ID** from **Access Details** and writes to the path from **Path Details**. > [card] [GCloud Console](/articles/integrate-customer/upload-files-on-gcloud-console) > [card] [gsutil Tool](/articles/integrate-customer/upload-files-using-gsutil) > [card] [Cyberduck](/articles/integrate-customer/upload-files-using-cyberduck) ## Verify the upload Your implementation is working when all of the following hold: * The file is listed under the bucket path shown in **Path Details**. * The source's status on the source listing page moves from **Created** to **Integrated**, which happens once data begins flowing into the source. * The **Preview Data** tab returns a sample of the ingested records. See [Components of the Preview Data tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab). ## Troubleshooting | Symptom | What it means | What to do | | - | - | - | | **+ ADD FILES** does not let you upload | Your account has the **Viewer** role, which cannot upload | Ask your Zeotap administrator to grant the **Editor** role, or have an Editor upload for you | | The file you want to send is 100 MB or larger | Files uploaded through the Zeotap CDP interface must be less than 100 MB | Upload directly to the bucket through the Google Cloud Console, `gsutil` or Cyberduck, none of which impose a size restriction | | A PGP-encrypted source ingests nothing after an upload | The file was not encrypted with the source's public key, or does not carry the `.pgp` extension | Re-encrypt with the **PGP Public key** from this tab and upload only `.pgp` files | | The bucket path from **Path Details** is not visible to your upload tool | The tool is authenticated as an account other than the **G Suite ID** under **Access Details** | Sign in again with the G Suite account listed under **Access Details** | | The source status stays **Created** | No data has arrived at the source yet | Confirm the file landed under the path shown in **Path Details**, in the folder structure the upload method documents | ## Next steps * Explore [uploading through the Google Cloud Console →](/articles/integrate-customer/upload-files-on-gcloud-console) for a browser upload, including the dated folder structure Zeotap expects. * Explore [uploading with gsutil →](/articles/integrate-customer/upload-files-using-gsutil) for a scriptable command-line upload. * Explore [uploading with Cyberduck →](/articles/integrate-customer/upload-files-using-cyberduck) for a desktop client. * Explore [PGP encryption in sources →](/articles/integrate-customer/pgp-encryption-in-sources) if the source was created with **PGP Encrypted** set to **True**. * Explore [mapping the Catalogue for Customer Data →](/articles/unify-customer/map-the-catalogue-for-customer-data) to map the uploaded fields once data arrives. # Implement an Adobe Experience Platform Tag Extension Source Source: https://docs.zeotap.com/articles/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source Install and configure the Zeotap Collect extension in Adobe Experience Platform Tags so that web events, user identities, and consent signals flow into Zeotap CDP. ## What this is The Adobe Experience Platform Tag Extension source brings website data **into** Zeotap CDP. You deploy the Zeotap Collect extension through your Adobe Experience Platform Tags (Adobe Launch) property, and it captures events, user identities, and consent signals on your site and sends them to Zeotap CDP. Data flows one way — from your website into Zeotap CDP. Use this page once the source itself exists in Zeotap CDP: it covers installing and configuring the extension, building the Adobe Launch rules that fire the Zeotap actions, verifying the implementation, and the identifiers and request formats Zeotap accepts. > [!NOTE] > > The Zeotap Collect extension for Adobe Launch is documented in full in the [Adobe Launch integration guide](/articles/sdks/adobe-launch/intro), which is the current, field-by-field reference for installation, configuration, and rule actions. Where the two differ, follow the Adobe Launch guide. ## Prerequisites > [!NOTE] > > Before you begin, confirm the following: > > * You have created an **Adobe Experience Platform Tag Extension** source in the **Sources** application and copied its **write key**. See [Create an Adobe Experience Platform Tag Extension Source](/articles/integrate-customer/create-an-adobe-experience-platform-tag-extension-source). > * You have access to **Adobe Experience Platform Tags (Adobe Launch)** with edit permissions, and a published Launch property for your website. > * You are familiar with the Adobe Tags building blocks this integration uses — tags, extensions, rules, and data elements. See [Understanding Adobe Launch terminology](/articles/sdks/adobe-launch/intro#understanding-adobe-launch-terminology). > * If you resolve consent with a TCF 2.0 Consent Management Platform (CMP), that CMP is already implemented on your website — the extension queries its TCF API before recording events. ## How the Zeotap Collect extension works Four pieces make up the integration: * **The extension** — a package of code you install into your Adobe Launch property from the Adobe Tags extension catalogue. It carries the Zeotap SDK and the Zeotap action types. * **The extension configuration** — a single screen holding your write key, consent method, identity and hashing settings, and optional integrations. These settings apply to every rule that uses the extension. * **Rules** — Adobe Launch's `Event → Condition → Action` logic. A rule decides *when* a Zeotap action runs; the action decides *what* is sent. * **Data elements** — named variables that point at values on your page, such as data layer entries, JavaScript variables, cookies, or the `detail` object of a direct call. You map data elements into the Zeotap action fields so every call carries the right values. ![The Select Data Element picker in Adobe Launch, listing data elements such as cellno, email, and loginid that can be mapped into a Zeotap action](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source-2023-01-24.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=4c2f8a0afb3766c3ae15d08bba3081c2) ## Install the extension In your Adobe Launch property, open **Extensions**, select the **Catalog** tab, search for **Zeotap Collect**, and install it. See [Installing the Zeotap Collect Extension](/articles/sdks/adobe-launch/installation). ## Configure the extension Open **Zeotap Collect** from the **Installed Extensions** tab of your Launch property and set the following. For field-by-field detail on every option, see [Configuring the Zeotap Collect Extension](/articles/sdks/adobe-launch/configure). ![The Configure Extension screen for Zeotap Collect in Adobe Launch, showing the Write Key field, the primary consent resolution mechanism, and the PII Hashing Configuration options](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source/implement-an-adobe-experience-platform-tag-extension-source-2025-02-20-3.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=c158263b34fe81c2458e7f5c2a121723) * **Write Key** — the key generated when you created the source in the Sources application. This is a mandatory field for recording events. * **Consent Method** — how the extension resolves consent before it collects anything. Choose **Default Opt-in**, **TCF (GDPR)**, or **Custom Consent**: * With **TCF (GDPR)**, select the purposes required for tracking, and optionally check consent for Zeotap as a vendor (vendor ID `1469`) in the TC string. * With **Custom Consent**, you must also build a rule that uses the [Set Custom Consent](/articles/sdks/adobe-launch/actions/set-custom-consent) action, mapping the `track` and `cookieSync` values from your own consent flow. * **Brand Consent** key-value pairs can be sent under any consent method, using the same Set Custom Consent action. * **PII Hashing Configuration** — how Personally Identifiable Information (PII) such as email addresses and cell phone numbers is handled. Three options are available: PII is hashed by you before it reaches the extension, PII is sent raw and hashed by Zeotap, or PII is sent raw and consumed as is. The identifiers each option accepts are listed in [User identity reference](#user-identity-reference). * **Country Code** — the ISO Alpha-3 country code for the country you want to associate your users with. See [Configuring the Zeotap Collect Extension](/articles/sdks/adobe-launch/configure). * **ID5** — optional. See [Enable the ID5 integration](#enable-the-id5-integration). > [!NOTE] > > Cookie syncing is enabled by default for the Zeotap Collect extension. To restrict or disable it, contact your Zeotap representative or Zeotap Support. See [Zeotap's list of integrated partners](/articles/integrate-customer/understanding-cookies) for the platforms it syncs with. When the settings are complete, click **Save**, add the updated extension configuration to your active library in the **Publishing Flow**, then submit, approve, and publish the changes to your environment. ## Set up rules and actions With the extension installed and configured, build Adobe Launch rules that call the Zeotap action types: * **Track Event** — send page views, user properties, and custom events. See [Track Event](/articles/sdks/adobe-launch/actions/track-events). * **Sync User Identities** — send user PII and custom identifiers such as `crmID`, `ECID`, or `visitorID`. See [Sync User Identities](/articles/sdks/adobe-launch/actions/sync-user-identity). * **Set Custom Consent** — send primary consent (`track`, `cookieSync`) and brand consent signals. See [Set Custom Consent](/articles/sdks/adobe-launch/actions/set-custom-consent). > [!NOTE] > > The **Load Zeotap SDK** action is no longer required. The Launch tag loads the Zeotap SDK automatically. > [!NOTE] > > Country and city values sent in an event payload are not ingested — Zeotap resolves them from the user's IP address. For the complete list of fields excluded from ingestion, see [Blacklisted Fields for Data Ingestion](/articles/integrate-customer/blacklisted-fields-for-data-ingestion). ### Example: track an Add to Cart event This rule fires when your website makes a direct call named `addToCart` and sends the event to Zeotap CDP. **1. Open the Rules screen** Log in to Adobe Experience Platform and open your Launch property. In the left menu, under **AUTHORING**, click **Rules**. **2. Add a rule** Click **Add Rule**. ![The Rules screen in Adobe Launch with the Add Rule button](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source-2023-01-24-5.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=d7419a2b08d7695c6817d9b8ca846660) **3. Name the rule** Enter a name for the rule — for example, `addToCart`. You configure its events and actions in the steps that follow; the actions run when the configured event fires. ![Rule creation screen with the rule name entered and empty Events and Actions sections](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source-2023-01-24-6.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=876adb677c23cb5db214f5065fb2f0c2) **4. Add the event** Under **EVENTS**, click **Add**. ![Rule screen with the Add button highlighted under the EVENTS section](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source-2023-01-24-7.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=e1a2bad8a39902babf32aceafd526f39) **5. Configure the event** In the window that appears: * Select **Core** as the **Extension**. Each extension offers its own set of default event types. * Select **Direct Call** as the **Event Type**. In the **Identifier** field, enter the string your website passes to `_satellite.track()`, without quotation marks — here, `addToCart`. * The **Name** field is auto-populated from the selected extension and event type. Click **Keep Changes** to save the event configuration. ![Event configuration panel with Core selected as the Extension, Direct Call as the Event Type, and addToCart entered as the Identifier](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source-2023-01-24-8.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=b1660c77be8655392bf69065708eba7b) **6. Trigger the event from your website** Invoke the direct call from your site: ```javascript theme={null} _satellite.track('addToCart', { /* ... event params */ }); ``` **7. Add conditions (optional)** Add **Conditions** if you need to scope the rule — for example, to particular pages or environments. **8. Add the first action** Under **ACTIONS**, click **Add**. ![Rule screen with the Add button highlighted under the ACTIONS section](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source-2023-01-24-21.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=a11f394587216b98380058ad6b7c61f7) **9. Select the Custom Code action** Select **Core** as the **Extension** and **Custom Code** as the **Action Type**. In the right-hand panel, select **JavaScript** under **Language**. ![Custom Code action configuration with JavaScript selected as the Language](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source-2023-01-24-10.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=7eff16b05c790fbea92e358958c92abf) **10. Add the custom code** Click `` **Open Editor**, paste the following, and save the changes: ```javascript theme={null} console.log('event logged', event.detail); _satellite.setVar('productID', event.detail.productID); _satellite.setVar('color', event.detail.color); ``` **11. Add the Zeotap action** Add a second action that sends the event to Zeotap CDP, configured with these attributes: * **Extension:** Zeotap Collect * **Action Type:** Track Event * **Event Type:** Custom Event — set the key-value pairs you want to capture with the event. ![Zeotap Collect action configured with Track Event as the Action Type and Custom Event as the Event Type](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source-2023-01-24-11.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=42579d656ca19eabf7b4301c9a099eb9) **12. Save and build** Save the configuration and build the changes into your library. ![The completed addToCart rule in Adobe Launch, with Core - Direct Call under EVENTS and Core - Custom Code followed by ZeoCollect - Track Event under ACTIONS](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source-2023-01-24-12.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=d4c17b6cf05cabb63396528c6e7acd9d) > [!NOTE] > > When the rule is triggered, the key-value pairs in the action configuration are sent to Zeotap CDP along with the event attributes passed as the second argument to `_satellite.track()`. ### Example: sync user identities on login Use the same rule structure to send user PII or custom identifiers to Zeotap CDP so that unique user profiles can be built — for example, when a user logs in. Only the direct-call identifier, the custom code, and the Zeotap action differ from the previous example. **1. Add a rule** Under **AUTHORING**, click **Rules**, then click **Add Rule**. ![The Rules screen in Adobe Launch with the Add Rule button](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source-2023-01-24-13.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=eeb20e7c2ca49083f9aeff57f05bd05d) **2. Name the rule** Enter a name for the rule — for example, `syncUserIdentities`. ![Rule creation screen with the identity-sync rule name entered](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source-2023-01-24-14.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=96830dbf2f36fd8e8d90d1b4b3048f72) **3. Add the event** Under **EVENTS**, click **Add**. ![Rule screen with the Add button highlighted under the EVENTS section](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source-2023-01-24-15.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=ed1a9a1f461aa3c862efc3500e2f7377) **4. Configure the event** Select **Core** as the **Extension** and **Direct Call** as the **Event Type**. In the **Identifier** field, enter the string your website passes to `_satellite.track()`, without quotation marks — here, `syncUserIdentities`. The **Name** field is auto-populated; click **Keep Changes**. ![Event configuration panel with Direct Call selected and syncUserIdentities entered as the Identifier](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source-2023-01-24-16.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=c85e3933d0923376cbe9848876cf0fa6) **5. Trigger the event from your website** Invoke the direct call from your site: ```javascript theme={null} _satellite.track('syncUserIdentities', { /* ... event params */ }); ``` **6. Add conditions and the first action** Add **Conditions** if required, then click **Add** under **ACTIONS**. ![Rule screen with the Add button highlighted under the ACTIONS section](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source-2023-01-24-22.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=1117fdbf6559e136d5c2afe5f3b9dde5) **7. Select the Custom Code action** Select **Core** as the **Extension** and **Custom Code** as the **Action Type**, then select **JavaScript** under **Language**. ![Custom Code action configuration with JavaScript selected as the Language](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source-2023-01-24-18.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=e5c928228afd1ccd8735a4eeccb36773) **8. Add the custom code** Click `` **Open Editor**, paste the following, and save the changes: ```javascript theme={null} console.log('sync user', event.detail); _satellite.setVar('userName', event.detail.userName); _satellite.setVar('userEmail', event.detail.userEmail); _satellite.setVar('userCell', event.detail.userCell); ``` **9. Add the Zeotap action** Add a second action that sends the user PII or custom identifiers to Zeotap CDP, configured with these attributes: * **Extension:** Zeotap Collect * **Action Type:** Sync User Identities * In the right-hand panel, set the key-value pairs for the identifiers you want to capture. ![Zeotap Collect action configured to sync user identities, with identifier key-value pairs mapped to data elements](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source-2023-01-24-19.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=24e239149aea52e0c645744bf25fbd06) **10. Save and build** Save the configuration and build the changes into your library. ![The completed identity-sync rule in Adobe Launch, showing its configured EVENTS and ACTIONS](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source-2023-01-24-20.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=b19da18d0f557636b7e550d1c91c2dea) ## Enable the ID5 integration The Zeotap SDK offers an optional integration with ID5. You need the **Partner ID** that ID5 provides. ### Step 1: Add the ID5 JavaScript library Load the ID5 JavaScript library in the script section of your website, after the CMP JavaScript and before the Zeotap Collect SDK: ```html theme={null} ``` ### Step 2: Configure ID5 in the Zeotap extension 1. On the extension configuration screen, select the option that enables ID5. 2. Enter your ID5 **Partner ID**. 3. To share the `sha256`-hashed email address and cell phone number with ID5, select the option that sends custom identifiers to ID5. ![ID5 settings on the Zeotap Collect extension configuration screen, with the Partner ID field](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source/Adobe_ID5.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=50b07d9d28337c8f9c4c132525b6431a) ### Step 3: Confirm the ID5 ID reaches Zeotap Zeotap calls ID5 and attempts to retrieve the ID5 ID. When an ID is returned, it is transmitted in the `user` node of every subsequent event payload and recorded in Zeotap CDP. ## Verify the implementation Work through these checks in your browser's developer tools, on a page where the extension is live. 1. **The SDK loads.** On the **Network** tab, confirm that the request for the Zeotap SDK script (`zeotap.min.js`) returns status `200`. ![Network tab showing the zeotap.min.js request returning status code 200](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source-2023-01-24-2.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=9c533a0b15fafc2a73f36e39d1adce9d) 2. **The SDK initialises.** On the **Console** tab, enter `zeotap`. The expected response is `e {_q: Array(0), _qcmp: Array(0)}`. > [!NOTE] > > If the response is `undefined`, initialisation has not succeeded. Both `_q` and `_qcmp` must be empty arrays; if they are not, events are being queued because consent is still unresolved. 3. **Cookie syncing fires.** On the **Network** tab, filter on **Fetch/XHR** and confirm the GET call that performs cookie syncing with Zeotap's partner platforms. ![Browser network tab showing the cookie-sync GET call](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source-2023-01-24-3.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=b0c24b6141cfe779009b9960bc19b01f) 4. **Events reach Zeotap.** After a Track Event action runs, confirm that the POST call on the **Network** tab returns status `204`. ![Network tab showing the event POST call returning status code 204](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source-2023-01-24-4.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=0cbb7ce8927e0ff354ae8e8184255b8d) > [!NOTE] > > If the response is not `204` or `200`, check that the write key configured in the extension matches the write key of the source. ## Troubleshoot the implementation ### A Zeotap action throws "Cannot read properties of undefined" **Symptom** — a rule that runs **Track Event** or **Sync User Identities** throws one of the following: * `Uncaught (in promise) TypeError: Cannot read properties of undefined (reading 'setPageProperties')` * `Uncaught (in promise) TypeError: Cannot read properties of undefined (reading 'setUserIdentities')` **Cause** — the Zeotap action scripts have run into a race condition. The SDK load and the Track Event or Sync User Identities action occurred at the same time, so the SDK methods were called before the Zeotap JavaScript finished initialising on the page. **Resolution** — fire the rule from a custom code event that waits until the SDK is available. For example: ```javascript theme={null} // Checks every second whether Zeotap is initialised. Once it is, the event is // triggered and the interval is cleared. const interval = setInterval(() => { if (window.zeotap) { // Zeotap script initialised trigger(); clearInterval(interval); } }, 1000); ``` ## User identity reference User information reaches Zeotap as identifiers, in three categories: raw user PII, hashed user PII, and custom identities. ### Raw user PII Send these fields when you capture identifiers in raw form, whether or not you want Zeotap to hash them. | **Raw user PII** | **Description** | | - | - | | `fpuid` | The first-party ID for a given user, such as a `crmID` or `DBID`. | | `email` | The user's raw email address. | | `cellno` | The user's raw cell phone number. | | `loginid` | The user's login ID. | | `cellno_cc` | The user's raw cell phone number with the country code. | ### Hashed user PII Send these fields when you hash PII yourself, using `SHA-256`, `SHA1`, or `MD5`, before it reaches the extension. | **Hashed user PII** | **Description** | | - | - | | `fpuid` | The first-party ID for a given user, such as a `crmID` or `DBID`. | | `email_sha256_lowercase` | The user's email address hashed to `sha256` after converting it to lowercase. | | `email_sha256_uppercase` | The user's email address hashed to `sha256` after converting it to uppercase. | | `email_md5_lowercase` | The user's email address hashed to `md5` after converting it to lowercase. | | `email_md5_uppercase` | The user's email address hashed to `md5` after converting it to uppercase. | | `email_sha1_lowercase` | The user's email address hashed to `sha1` after converting it to lowercase. | | `email_sha1_uppercase` | The user's email address hashed to `sha1` after converting it to uppercase. | | `cellno_without_country_code_sha256` | The user's cell phone number without the country code, hashed to `sha256`. | | `cellno_without_country_code_md5` | The user's cell phone number without the country code, hashed to `md5`. | | `cellno_without_country_code_sha1` | The user's cell phone number without the country code, hashed to `sha1`. | | `cellno_with_country_code_sha256` | The user's cell phone number with the country code, hashed to `sha256`. | | `cellno_with_country_code_md5` | The user's cell phone number with the country code, hashed to `md5`. | | `cellno_with_country_code_sha1` | The user's cell phone number with the country code, hashed to `sha1`. | | `cellno_e164_sha256` | The user's cell phone number in E.164 format, hashed to `sha256`. | | `cellno_e164_sha1` | The user's cell phone number in E.164 format, hashed to `sha1`. | | `cellno_e164_md5` | The user's cell phone number in E.164 format, hashed to `md5`. | | `loginid_sha256_lowercase` | The user's login ID, hashed to `sha256` after converting it to lowercase. | | `loginid_sha256_uppercase` | The user's login ID, hashed to `sha256` after converting it to uppercase. | | `loginid_md5_lowercase` | The user's login ID, hashed to `md5` after converting it to lowercase. | | `loginid_md5_uppercase` | The user's login ID, hashed to `md5` after converting it to uppercase. | | `loginid_sha1_lowercase` | The user's login ID, hashed to `sha1` after converting it to lowercase. | | `loginid_sha1_uppercase` | The user's login ID, hashed to `sha1` after converting it to uppercase. | ### Custom identities Custom identities are first-party identifiers you choose to send, such as `crmID`, `ECID`, or `visitorID`. Hashing configurations do not apply to custom identities. > [!NOTE] > > For the hashing guidelines that apply to email addresses and cell phone numbers, see [Hashing Guidelines](/articles/unify-customer/hashing-guidelines). ## Request reference Once the extension is live, it makes two kinds of call. Knowing their shape helps when you inspect traffic on the **Network** tab. ### Cookie-sync call **Request** — a GET call. Line breaks are shown for readability; the live request is a single URL, and the placeholders below stand in for your own values. ```text theme={null} https://spl.zeotap.com/fp ?cmp=1 &cookieSync=true &gdpr=1 &gdpr_consent= &identify=true &optin=yes &payload= &track=true &w_k= ``` **Consent flags** | **Query parameter** | **Description** | | - | - | | `optin` | Whether the SDK has consent for any of the actions. | | `track` | Whether the SDK has consent to track event or user data. | | `identify` | Whether the SDK has consent to identify the user, using the Zeotap ID+ first-party cookie. | | `cookieSync` | Whether the SDK has consent to cookie sync with the organisation's partner platforms. | | `cmp` | Whether consent is resolved through the TCF API present on the page: `1` for true, `0` for false. | | `gdpr_consent` | The TCF v2 consent string, when the consent resolution mechanism selected is TCF. | **General** | **Query parameter** | **Description** | | - | - | | `w_k` | The encoded write key of the source. | | `payload` | The encoded identities passed to the Zeotap JavaScript on the website. These can be user PII or custom identities, along with the default first-party cookies the JavaScript sets after initialisation. | **Response** — a list of image pixel tags carrying the URLs to cookie sync: ```html theme={null} ``` ### Event capture call **Request URL** ```text theme={null} https://spl.zeotap.com/fp?cookieSync=true&identify=true&optin=yes&track=true ``` **Request method** — `POST` **Request payload** — the body carries an `event` node for the event properties, a `user` node for the identities (hashed or raw, according to your hashing configuration), and a `page` node for page information such as URL, referrer, and page category. ```json theme={null} { "event": { "name": "addToCart", "pid": "p12345", "colour": "white", "size": "large", "timestamp": "1356739200" }, "page": { "name": "Product", "title": "View electronic toothbrush at low prices", "referrer": "https://www.example.com/discountbin", "url": "https://www.example.com/products/sanitary/toothbrush/?pid=p12345", "path": "/products/sanitary/toothbrush/?pid=p12345" }, "user": { "loginid": "user.0001", "email": "user@example.com", "cellno": "9000000000" }, "meta": { "colours": ["blue", "pink", "white"], "sizes": ["small", "regular", "large"] } } ``` ## FAQ > [accordion] Where does the write key come from? > > Zeotap generates it when you create the Adobe Experience Platform Tag Extension source in the **Sources** application. Copy it from the source and enter it in the **Write Key** field of the Zeotap Collect extension configuration. It is mandatory for recording events. > [accordion] Do I still need a Load Zeotap SDK rule? > > No. The Load Zeotap SDK action is no longer required — the Launch tag loads the Zeotap SDK automatically. > [accordion] Can I send brand consent when I am not using Custom Consent? > > Yes. Brand Consent key-value pairs can be sent under any consent method, using the [Set Custom Consent](/articles/sdks/adobe-launch/actions/set-custom-consent) action. The primary `track` and `cookieSync` values depend on the consent method you selected. > [accordion] Is cookie syncing on by default? > > Yes, cookie syncing is enabled by default for the Zeotap Collect extension. To restrict or disable it, contact your Zeotap representative or Zeotap Support. > [accordion] Why are country and city missing from my ingested events? > > Country and city are not ingested from the event payload — Zeotap resolves them from the user's IP address. See [Blacklisted Fields for Data Ingestion](/articles/integrate-customer/blacklisted-fields-for-data-ingestion) for the full list of excluded fields. > [accordion] The console shows values inside \_q or \_qcmp. What does that mean? > > Those arrays should be empty once the SDK is initialised and consent is resolved. Entries in them mean events are being queued while consent is still unresolved. If the console returns `undefined` instead of the object, initialisation has not succeeded at all. ## Next steps * [Explore the Adobe Launch integration guide →](/articles/sdks/adobe-launch/intro) * [Create an Adobe Experience Platform Tag Extension source →](/articles/integrate-customer/create-an-adobe-experience-platform-tag-extension-source) * [Explore the PREVIEW tab fields →](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) * [Compare the Tag Manager sources →](/articles/integrate-customer/tag-managers) # Implement an Airship Real-Time Data Streaming Source Source: https://docs.zeotap.com/articles/integrate-customer/implement-an-airship-real-time-data-streaming-source Configure a webhook in Airship so that Real-Time Data Streaming events flow into your Zeotap CDP source. ## What this is The Airship Real-Time Data Streaming source brings event data **from Airship into Zeotap CDP**: you create the source in Zeotap CDP, then configure a webhook on the Airship side that streams the selected events to the endpoint Zeotap generates for that source. This page covers the Airship-side webhook configuration, which is the second half of that setup. To send data in the opposite direction — **out of Zeotap CDP to Airship** — use one of the Airship destinations instead: * [Airship Static Lists](/articles/integrate-customer/airship) sends Named Users from a Zeotap CDP audience to Airship. * [Airship Real Time Integration](/articles/integrate-customer/airship-real-time-destination-integration) sends data to Airship from a workflow in Journeys. Airship data can also be ingested on a batch schedule rather than in real time. For that route, see [Airship (Batch) Source](/articles/integrate-customer/airship-batch-source). ## Supported identifiers In addition to Named Users, you can match the Airship channel ID to a Zeotap attribute to enrich customer profiles in Zeotap CDP. The retrieval snippet and the identity configuration are covered under the prerequisites on [Create an Airship Real-Time Data Streaming Source](/articles/integrate-customer/create-an-airship-real-time-data-streaming-source). ## Prerequisites Before you configure anything in Airship, make sure you have the following: * **An Airship Real-Time Data Streaming source created in Zeotap CDP.** See [Create an Airship Real-Time Data Streaming Source](/articles/integrate-customer/create-an-airship-real-time-data-streaming-source). * **The API URL and the write key for that source.** Both are generated when the source is created and appear on the source's **IMPLEMENTATION DETAILS** tab. Keep them to hand — you paste the API URL into the Airship webhook endpoint and the write key into the webhook's authorisation header. * **Access to the Airship project you want to stream from**, with **Settings** and **Project configuration** available on that project. ![The IMPLEMENTATION DETAILS tab of a created Airship Real Time Data Streaming source in the Zeotap CDP App, showing the source status, created-by and region details, and the highlighted panel that holds the API URL and write key fields.](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-an-airship-real-time-data-streaming-source/implement-an-airship-real-time-data-streaming-source-2024-01-17-1.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=e27515480f986267d0465df89175a6e9) ## Configure real-time data streaming in Airship These steps establish a streaming connection between Airship and Zeotap CDP over an Airship webhook integration, and let you choose which events are streamed. **Step 1** Log into the Airship platform and go to the projects list screen. **Step 2** Under **All Projects**, click the project you want to stream from, then click **Settings**. ![The Airship All Projects screen listing the available projects as cards.](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-a-airship-real-time-source/implement-a-airship-real-time-source-2024-01-10.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=53748dd2689821f9a69628ceb0a86eb8) **Step 3** Under **Project configuration**, click **Manage** under **Real-Time Data Streaming**. ![The Airship project Settings screen with the Real-Time Data Streaming tile highlighted under Project configuration, alongside the Team Access, Events, Tokens and Named Users tiles.](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-a-airship-real-time-source/implement-a-airship-real-time-source-2024-01-10-3.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=47cdf2bf3e4791f937baa1e5a83fdc6c) **Step 4** Click **webhooks** in the list of real-time integrations. ![The Airship list of real-time integrations, with the Webhook tile highlighted among the other available integration tiles.](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-a-airship-real-time-source/implement-a-airship-real-time-source-2024-01-10-7.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=c3f1faaab4a48b772ec627b7db6fb3a9) **Step 5** On the **Create a new Webhook integration** screen, configure the integration: a. Under **Pick a name and description**, enter a descriptive **Name** and **Description** for the integration — for example, a description such as `Used to send events data from Airship to Zeotap.` b. Under **Webhook Setup**, enter the **API URL** copied from the **IMPLEMENTATION DETAILS** tab of your Zeotap CDP source as the **Webhook Endpoint URL**. Airship notes on this screen that the endpoint must be an HTTPS endpoint, and that you can include query parameters in it. c. Under **Custom Headers**, add the key-value pair that Airship sends alongside each request to the endpoint. In the **Key** field, enter `Authorization`. In the **Value** field, enter `Bearer` — the word `Bearer`, a single space, then the write key from the **IMPLEMENTATION DETAILS** tab. d. Under **Event Type Configuration**, select the event types you want to send to the webhook integration, then click **Activate**. Only the event types you select are streamed. ![The Airship Create a new Webhook integration screen, showing the four numbered configuration steps: the name and description fields, the webhook endpoint URL field, the custom header key and value fields, and the Event Type Configuration checkbox list above the Activate button.](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-a-airship-real-time-source/implement-a-airship-real-time-source-2024-01-10-11.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=62975e7104c6050b29ade861a934cacc) > [!NOTE] > > Airship states on the webhook screen that clicking **Activate** instructs Airship to transmit the data you have specified from your Airship account to the third-party platform, and confirms that you have the necessary lawful basis for that transmission. With the streaming connection established, Airship starts sending the selected events to Zeotap CDP. ## Verify the connection Once events start reaching Zeotap CDP, the status of the source changes from **Created** to **Integrated** on the Sources listing page. * Open the source and check the **[PREVIEW DATA](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab)** tab to see the data flowing in. * Use the **[SOURCE REPORT](/articles/integrate-customer/source-report)** tab for the ingestion health and status of the source. ## Troubleshoot the streaming connection **The source status stays Created and no data appears under PREVIEW DATA.** A source in the **Created** state has been created but has not yet received any data. Re-check the Airship webhook integration: * The **Webhook Endpoint URL** is the **API URL** from the **IMPLEMENTATION DETAILS** tab of this source, not of another source. * The custom header key is `Authorization` and its value is `Bearer` — the prefix, a single space, then the write key from the same tab. * The integration was saved with **Activate**. **Only some event types arrive.** Only the event types selected under **Event Type Configuration** are streamed. Reopen the webhook integration in Airship and confirm the selection. **The `country` and `city` columns are empty.** Records for these columns are blacklisted for ingestion, because Zeotap resolves the country and city automatically from the user's IP address. For the complete list, see [Blacklisted Fields for Data Ingestion](/articles/integrate-customer/blacklisted-fields-for-data-ingestion). ## Next steps * [Map the catalogue for Customer Data →](/articles/unify-customer/map-the-catalogue-for-customer-data) * [Map the catalogue for Non-Customer Entity data →](/articles/unify-customer/map-the-catalogue-for-non-customer-entity-data) * [Explore the components of the Preview Data tab →](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) * [Explore source reports →](/articles/integrate-customer/exploring-source-reports) * [Ingest Airship data on a batch schedule →](/articles/integrate-customer/airship-batch-source) * [Send audiences out to Airship Static Lists →](/articles/integrate-customer/airship) # Implement an Insider Source Source: https://docs.zeotap.com/articles/integrate-customer/implement-an-insider-source Configure a webhook in Insider so that the events you select are streamed into your Zeotap CDP source. ## What this is The Insider Webhook source brings event data **from Insider into Zeotap CDP**: you create the source in Zeotap CDP, then build a webhook integration in Insider that posts the events you select to the endpoint Zeotap generates for that source. This page covers the Insider-side configuration — the second half of the setup. The first half, creating the source itself, is on [Create an Insider Source](/articles/integrate-customer/create-an-insider-source). To send data in the opposite direction — **out of Zeotap CDP to Insider** — use the [Insider destination](/articles/integrate-customer/insider) instead. That integration sends the attributes and identifiers of a Zeotap CDP audience, and events from Journeys workflows, to Insider. > [!NOTE] > > When you build the webhook in Insider you set the **Integration Type** to **Destination**. That describes the direction from Insider's point of view — Zeotap is the destination Insider posts to — and is what makes this integration a *source* in Zeotap CDP. For an overview of the integration, see [Insider Webhook](/articles/integrate-customer/insider-webhook). For the other platforms you can ingest engagement data from, see [Customer Engagement Channels](/articles/integrate-customer/customer-engagement-channels). ## Supported events You choose which of Insider's events trigger the webhook. Its **default** events are grouped as follows; the **Rules** screen also offers a **Custom Events** trigger. The default events are grouped as follows: | Event group | Default events | | :- | :- | | Pageview events | Homepage View, Listing Page View, Product Detail Page View, Cart Page View, Purchase (Confirmation Page View), Other Pageview | | User events | Cart Cleared, Item Added to Cart, Item Removed from Cart, Signup Completed, Lead Collected | | Mobile app events | In-App Seen, Push Delivered, Mobile Social Proof Seen, App Push Opened (push_session), Mobile App Opened (session_start), Survey Result (survey_result) | | Email events | Email Delivered, Email Open, Email Click, Email Bounce, Email Block, Email Spam Report, Email Group Unsubscribe, Email Group Resubscribe, Email Unsubscribe, Email Resubscribe | | Architect events | Journey Enter, Journey Exit, Journey Product Action | | Web push events | Web Push View, Web Push Click | | WhatsApp events | WhatsApp Click, WhatsApp Delivered, WhatsApp Reply, WhatsApp Reply – First Button, WhatsApp Reply – Second Button, WhatsApp Reply – Third Button, WhatsApp Reply – Other Reply, WhatsApp Unsubscribe, WhatsApp Read | | SMS events | SMS Click, SMS Delivered, SMS Unsubscribe, SMS Subscribe, SMS Undelivered, SMS Reply, SMS Drop (SMS Campaigns) | Alongside the events themselves you can send event parameters and additional attributes, and you can narrow the users whose events are sent with a segment filter. All three are configured in the **Rules** step below. ## Prerequisites * **An Insider source created in Zeotap CDP.** See [Create an Insider Source](/articles/integrate-customer/create-an-insider-source). * **The API URL and Write Key for that source.** Both are generated when the source is created and appear under **IMPLEMENTATION DETAILS**. Note them down before you start: 1. The **API URL** is used to establish a connection between Insider and Zeotap. 2. The **Write Key** is used to securely ingest data from Insider to Zeotap. * **Access to your Insider account**, with **External Integrations** available under **Integrations** in the left panel and permission to create and launch a webhook integration. ## Configure the webhook in Insider Perform the following steps to configure the webhook within Insider: **Step 1** Log into your Insider account. **Step 2** In the left panel, under **Integrations**, click **External Integrations.** **Step 3** In the new screen that appears, search and find **Webhook** as shown in the image below. ![The Insider left panel with Integrations expanded and External Integrations highlighted, beside the External Integrations screen where a search for webhook returns the Webhook platform tile tagged Destination.](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-an-insider-source/implement-an-insider-source-2025-04-01.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=80f2a7a7584de4a63527c26f749d5f63) **Step 4** Click **Webhook** and provide a **Name** for your integration for easy identification. **Step 5** Under **Integration Type**, select **Destination** and click **Save**. ![The Insider Webhook Integration dialog showing the Webhook Name field and the two Integration Type options, with Destination — integrate as a Destination to send customer data from Insider — selected.](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-an-insider-source/implement-an-insider-source-2025-04-01-1.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=f0cad2ebed6678300d2ad8a137832668) **Step 6** In the **Rules** screen that appears, use the **Events** and **Attributes** tabs to choose the event type you wish to send from Insider to Zeotap CDP. The triggers are grouped by channel. For better understanding, let's say you choose **User Events**. ![The Webhook Integration Rules screen with the Events and Attributes tabs, showing the webhook trigger tiles for Architect, Mobile App, Web Push, Page View Events, User Events and Custom Events, and the webhook name field on the right.](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-an-insider-source/implement-an-insider-source-2025-04-01-6.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=b00e75e38ca16298fd5e7d8a9d3611dd) **Step 7** Based on the event type you choose, make additional selections under that event type. For example, if you choose **User Events**, the corresponding events are listed as shown below. Use the checkboxes to select the desired events. ![The Event Triggers panel with User Events chosen in the drop-down and the Cart Clearance, Add to Cart and Remove from Cart checkboxes ticked, above the Add Event Trigger button.](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-an-insider-source/implement-an-insider-source-2025-04-01-3.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=e5df75b56a1eaac89c333044a630679a) **Step 8** In addition, you can add event parameters for the selected events by clicking **+ Add Condition.** A new set of fields is displayed where you can add the details of the event as shown below. ![The Event Triggers panel with a condition row added beneath the selected events — Event, Event Parameter, Operator and Value set to an Add to Cart event where Unit Price is 100 — and callouts pointing at Add Condition and Add Event Trigger.](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-an-insider-source/implement-an-insider-source-2025-04-01-4.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=4220d41f1e81dfcf91b9f1643dba5269) **Step 9** In the same screen, you can include more event types by clicking **Add Event Trigger**. **Step 10** You can also add additional attributes to send to Zeotap CDP using the drop-down menu, as shown below. For example, when sending an **email opened** event, add the **email address** as an additional attribute. This configuration helps identify which email address opened a specific email campaign. ![The Additional Attributes to Send panel with Include Additional Attributes ticked and Age selected in the Attributes drop-down.](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-an-insider-source/implement-an-insider-source-2025-04-01-5.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=20b88ee1d59738af21714959616908d1) **Step 11** In the **Segmentation** step, filter users in specific segments in Insider before sending the data to Zeotap CDP. The data is sent only if users perform the selected event and meet the optional segment filter criteria. For example, use this section to send data for users who perform an **Add to Cart** event and have purchased 2 products in the last 1 day. ![The Segmentation panel with a Purchase segment condition targeting users who purchased 2 products in the last 1 day, above the Add Event Parameter and Add Segment buttons.](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-an-insider-source/implement-an-insider-source-2025-04-01-7.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=8ef8dec0f0e86111bbf4b88767e4beb7) **Step 12** After configuring the events, attributes and segments in the appropriate sections, click **Save and Continue** to move to the **Configuration** screen. **Step 13** In the new screen that appears, perform the following steps: a. Under **Endpoint**, provide the **API URL** that you generated during source creation in the Zeotap CDP App (**IMPLEMENTATION DETAILS** tab). Ensure that the API call method is POST. b. Under **Headers**, click **Add Header**. c. In the new key-value field, enter the following: * **Key**: Authorization. * **Value**: Paste the write key generated during source creation in Zeotap CDP. Ensure that you add the prefix Bearer as shown below. `Bearerwrite_key` ![The Insider webhook Configuration screen: the Endpoint section with Method set to POST and a URL field, the Headers section listing a content-type row and an Authorization row, and a callout pointing at the Enable body checkbox in the Body section.](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-an-insider-source/implement-an-insider-source-2025-04-01-8.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=28d76fec8ed1c0176cd238cb3d678489) d. Select the **Enable body** checkbox to configure the payload. e. Transform the data into the required structure: * Add dynamic values, including event parameters and attribute values. * Copy and paste the API payload. * Replace values with dynamic content to match Zeotap CDP's API requirements. **Step 14** After configuring the endpoint, headers and body for the webhook, click **Save and Continue** to proceed to the **Launch** step and complete the integration. **Step 15** Select a launch option: **Draft**, **Active** or **Paused**. The **Draft** option is selected by default. Optionally, enter additional information in the **Notes** field. Once the integration is launched in the **Active** state, Insider webhooks are integrated with the endpoint and data transfer from Insider to Zeotap CDP begins. ## Verify the integration Check both sides of the integration. **In Insider**, before sending webhooks, test the webhook using the **Test Webhook** button. * Automatically generate random values for dynamic fields and select **Test** to send the data. * View the response status and request details in the side panel to verify whether the request was sent successfully. ![The Test Webhook side panel listing each dynamic content field with a Value box, alongside the Use Random Value button and the Test button, over the Launch Webhook screen.](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-an-insider-source/implement-an-insider-source-2025-04-01-9.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=137aac1ddda3b728c0d98ce8ab1b7736) * If the status shows a successful HTTP response, activate the integration and start sending data to the endpoint. ![The Webhook Integration Launch screen with the Activation Status options Active, Draft and Paused, the Notes field, and a Before You Launch panel confirming the integration is ready to run and which events trigger it.](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-an-insider-source/implement-an-insider-source-2025-04-01-10.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=7f3e2547424a492f880815846cd6d1c4) **In Zeotap CDP**, open the source from the **SOURCES** listing page and check its status: * **Created** — the source exists but has not received any data yet. * **Integrated** — data has started flowing in. You can now preview the incoming records on the source's **PREVIEW DATA** tab. For what each status means, see [Components of the Source Listing Page](/articles/integrate-customer/components-of-the-source-listing-page). For how to read the sample, see [Components of the Preview Data Tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab). ## Troubleshoot the integration **The source status stays Created and no data appears under PREVIEW DATA.** A source in the **Created** state has been created but has not yet received any data. Re-check the Insider webhook integration: * The **Endpoint** is the **API URL** from the **IMPLEMENTATION DETAILS** tab of this source, not of another source, and the method is POST. * The header key is `Authorization` and its value is `Bearerwrite_key` — the prefix, a single space, then the write key from the same tab. * The integration was launched in the **Active** state. **Draft** is selected by default at the **Launch** step, and an integration left in **Draft** or **Paused** sends nothing. **The test request does not return a successful HTTP response.** The response status and the request details appear in the side panel of **Test Webhook** — use them to check the endpoint and the Authorization header before activating the integration. **Only some events arrive.** Only the events you ticked under the chosen event types are sent. Any condition added with **+ Add Condition**, and any segment filter added in the **Segmentation** step, narrows this further: data is sent only for users who perform the selected event *and* meet the filter criteria. Reopen the **Rules** screen in Insider and confirm the selection. **An expected column is missing from the preview.** A set of fields is excluded from ingestion across sources. Check the field against [Blacklisted Fields for Data Ingestion](/articles/integrate-customer/blacklisted-fields-for-data-ingestion). ## Next steps * [Map the catalogue for Customer Data →](/articles/unify-customer/map-the-catalogue-for-customer-data) * [Map the catalogue for Non-Customer Entity data →](/articles/unify-customer/map-the-catalogue-for-non-customer-entity-data) * [Explore the components of the Preview Data tab →](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) * [Explore source reports →](/articles/integrate-customer/exploring-source-reports) * [Send audiences and Journeys events out to Insider →](/articles/integrate-customer/insider) # Implement the iOS SDK Source Source: https://docs.zeotap.com/articles/integrate-customer/implement-the-ios-sdk-source ### Latest Version 1.3.8 ## Integrate the iOS SDK You can integrate the iOS SDK into your project in the following ways: * By an automated process using **Swift Package Manager** or **CocoaPods** * By a manual process, which involves adding the dependencies yourself ## Integration Using Swift Package Manager To integrate the `ZeotapCollect` iOS SDK using Swift Package Manager, perform the following steps: > [!NOTE] > > **Note:** > > The SDK version mentioned in the following steps is for reference purposes only. Ensure that you use the most recent version during the setup process. **Step 1** Open your Xcode project in the Swift Package Manager and go to **File** > **Add Packages**. ![](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-the-ios-sdk-source-2023-05-02.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=7b77fa6df28f5490404caa94f6632e63) **Step 2** Search for [https://github.com/zeotap/ZeotapCollect](https://github.com/zeotap/ZeotapCollect) in the search bar. **Step 3** Choose **Exact Version** as the **Dependency Rule**. The latest version of the SDK auto-populates. In the below image, the version is 0.0.5. **Step 4** Click **Add Package**. ![](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-the-ios-sdk-source-2023-05-02-1.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=2419f0e2f7dfc31d5e30c9ba39953d02) **Step 5** Once the dependencies are successfully identified and installed by the Swift Package Manager, **`ZeotapCollect`** appears under **Package Dependencies**. ![](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-the-ios-sdk-source-2023-05-02-2.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=5dcf2bf5a298dfa89e93ede9c20e9e0b) **Step 6** Under **Product**, click **Clean Build Folder** > **Build**. ![](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-the-ios-sdk-source-2023-05-02-3.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=6707ed78235f7d6ff92dff3bcec4c91e) **Step 7** Once the `ZeotapCollect` iOS SDK is available in your project, you can import it in the required files to use. ![](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-the-ios-sdk-source-2023-05-02-4.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=92bb590f1b29dd7a7fa3909b51846018) ## Integration Using CocoaPods To ensure whether CocoaPods is installed in your system or not, follow the instructions below. * To check if CocoaPods is installed, run the command `pod --version`. If CocoaPods is installed, you can see the version number displayed, as shown in the image below. * If CocoaPods is not installed, then you can add it to your project by following the instructions at [https://guides.cocoapods.org/using/using-cocoapods.html](https://guides.cocoapods.org/using/using-cocoapods.html). > [!NOTE] > > **Note:** > > We recommend that you use `.xcworkspace` instead of `.xcodeproj` when working with CocoaPods. Once CocoaPods is installed in your system, perform the following steps to integrate `ZeotapCollect` iOS SDK: **Step 1** Open the `Podfile` and add the command with the exact version to the target of your project. ```bash theme={null} pod 'ZeotapCollect', '~> ' ``` ![](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-the-ios-sdk-source-2023-05-02-6.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=f91ffc7ebd5d972c776a02e6c7eedf46) **Step 2** Save the `Podfile` and run `pod install`. This identifies and installs the dependencies. > [!NOTE] > > **Note:** > > There can be multiple reasons for unresolved dependencies. However, you can attempt to resolve the issue by following the methods listed below: > > * Execute the following commands in the given order: > * pod cache clean --all > * pod update > * pod install > * In case you encounter any source-related problems, include the source "[https://github.com/CocoaPods/Specs.git](https://github.com/CocoaPods/Specs.git)" in your Podfile. **Step 3** Once the dependencies are resolved, close the project and reopen it using the `.xcworkspace` file. **Step 4** Under **Product**, click **Clean Build Folder** > **Build**. ![](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-the-ios-sdk-source-2023-05-02-7.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=9d4075a4313fb65ce449f905c7c2cfe4) **Step 5** When `ZeotapCollect` iOS SDK is available in your project, you can import it in the required files to use. ![](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-the-ios-sdk-source-2023-05-02-8.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=da8f2fcfb5f74c91838c49436a4d725b) ## Integration by Manual Process > [!NOTE] > > **Note:** > > To download the iOS SDK for manual installation, click [here](https://content.zeotap.com/ios-sdk/ios-collect-sdk.zip). Once you have downloaded the SDK, you are required to add the SDK to your application. Perform the following steps to integrate the SDK inside the application: **Step 1** To launch the project settings, click the project in the navigation bar and select as follows: **PROJECT → TARGET → General →** scroll and find **Frameworks, Libraries and Embedded Content**. ![](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-the-ios-sdk-source-2023-05-02-11.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=f5ac831dace82606cfa7a84f121a5dbb) **Step 2** Under **Frameworks, Libraries and Embedded Content**, click +. In the pop-up that appears, click the **Add Others…** drop-down menu and then click **Add Files…** ![](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-the-ios-sdk-source-2023-05-02-12.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=c7d274358b2fa7b300ee0994da46b5a7) **Step 3** A folder appears where you can add **`xcframework`** to the project. a. Select the **`ZeotapCollect.xcframework`** from downloads to integrate the Zeotap SDK. b. As you click to open, **`xcframework`** gets added to the project under **Frameworks, Libraries and Embedded Content**. ![](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-the-ios-sdk-source-2023-05-02-13.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=12b4c4cd0f7c2864d3d61b8cb80a72e8) ![](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-the-ios-sdk-source-2023-05-02-14.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=5201fc61de31f17d311efb4ccf6483a4) **Step 4** In the menubar, go to **Product** and then click **Clean build folder**. ![](https://mintcdn.com/zeotap/jefybC-lvH-uRq2b/articles/integrate-customer/Storage/integrate-customer/implement-the-ios-sdk-source-2023-05-02-15.png?fit=max\&auto=format\&n=jefybC-lvH-uRq2b\&q=85\&s=11dccf65c679cd1fc3a1206be05ff02b) **Step 5** After cleaning is complete, go to Product in the menubar and then Click Build. Product is ready to sync with the Zeotap SDK. ## Initialise SDK Upon starting your app, you are required to initialise the Collect SDK. To initialise, perform the following steps: **Step 1** Import the `ZeotapCollect` `module` to `AppDelegate` **Step 2** Add the SDK initialisation and configuration code inside `didFinishLaunchingWithOptions`. **Step 3** Set up the SDK option by configuring `CollectOptions` and passing it to the `Collect` object using the `initialize` command as shown below. The `initialize` function also accepts an optional callback function to check the response of the function. ```js Code theme={null} import ZeotapCollect ... func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool { ... var collectOptions = CollectOption().writeKey(value: "test_key") .logging(value: false) .optout(value: false) .build() Collect.initialize(option: collectOptions) // initialize with callback // Collect.initialize(option: collectOptions, {data in // print("\(data)") // }) } ``` ## Add SDK methods inside the application Upon initializing the SDK, you can add the SDK methods inside the application as mentioned below. **Step 1** To send `events` to the SDK, add the below code. ```js Code theme={null} import ZeotapCollect ... Collect.getInstance()?.setEventProperties("view_product") ``` **Step 2** To send `events` to the SDK along with some data, add the below code. ```js Code theme={null} import ZeotapCollect ... var event = [ "name": "test watch", "product": "watch", "price": "899", ] Collect.getInstance()?.setEventProperties("view_product", event) ``` **Step 3** To send `pageProperties` to the SDK, add the below code. ```js Code theme={null} import ZeotapCollect ... var page_property = [ "page": "cart" ] Collect.getInstance()?.setPageProperties(page_property) ``` **Step 4** To send `userProperties` to the SDK, add the below code. ```js Code theme={null} import ZeotapCollect ... var user_property = [ "display_name": "xyz", "age": 43 ] Collect.getInstance()?.setUserProperties(user_property) ``` **Step 5** To send `userIdentitities` to SDK, add the below code. ```js Code theme={null} import ZeotapCollect ... var user_ids = [ "email": "xyz@gmail.com", "cellno": 9876543210 ] Collect.getInstance()?.setUserIdentities(user_property) ``` **Step 6** If you do not want the SDK to read some `events` after integrating, then use pauseCollection() and resume the `events` firing with `resumeCollection()` as mentioned below. ```js Code theme={null} import ZeotapCollect ... # pause collection- after this call sdk won't sent any calls to spl Collect.getInstance()?.pauseCollection() ... # resume collection - after this call sdk will resume and send events to spl Collect.getInstance()?.resumeCollection() ``` ## Options to Configure the SDK Once the SDK is integrated, perform the following steps to configure the SDK: **Step 1** Import **ZeotapCollect** `module` which will have CollectOption `class` to pass the configurations to the SDK **Step 2** To configure the options, create a CollectOption object (It is recommended that you initialize the SDK in **AppDelegate**). This object has some functions that help you to set up the SDK options like write key, consent and so on. **Step 3** Call **build()** to create the **Option** object. **Example** `Option options = CollectOption().writeKey(value):` | **MODIFIER AND TYPE** | **INPUT TYPE** | **METHODS** | **DESCRIPTION** | | - | - | - | - | | `CollectOption` | String | `writeKey(value: String)` | This is the write key that you have provided to the SDK. | | ​`CollectOption` | Boolean | `logging(value: Bool)` | If set to true, then it displays the info, debug, warning and error log severity levels. Else, it only displays the warning and error log severity levels. | | ​`CollectOption` | Boolean | `optOut(value: Bool)` | If set to true,then no `events` are posted to the SPL. The default value is false. This option acts as a fallback when consent is not used. | | ​`CollectOption` | Integer | `batchSize(value: Int)` | The maximum number of `events` allowed to remain in the unsent queue when scheduling an event. If the event exceeds this threshold, then the next batch is dispatched immediately. The default value is 30. | | ​`CollectOption` | Integer | `maxCacheSize(value: Int)` | This is the maximum number of `events` allowed to be stored in the local memory in case of network issue or delayed consent. The default value is 100, and the maximum value can be 200. | | ​`CollectOption` | Integer | `eventUploadInterval(value: Int)` | If the size of the queue is less than the threshold, then the request to post `eventsscheduled` after `eventUploadInterval(value:).`The default value is 90s. | | `CollectOption` | Boolean | `useConsent(value: Bool)` | If set to true, then the SDK waits to receive a consent signal and uses that consent to manage actions. | | `CollectOption` | Boolean | `checkForCMP(value: Bool)` | If both useConsent and checkForCMP are set to true, then the SDK looks for CMP data that is stored by other CMPs. Based on the CMP data, you can then manage the consents. | | `CollectOption` | Boolean | `checkZeotapVendorConsent(value: Bool)` | For CMP case, if set to true, then the SDK checks for Zeotap Vendor consent, while resolving GDPR consent to send the data.If set to false, then the SDK ignores Zeotap Vendor consent. | | `CollectOption` | \[Int] | `purposesForTracking(value: [Int])` | This option is used to pass a list of purpose IDs, based on which you can manage the consent for tracking \[!NOTE] **NOTE**: To know more about the purposes for tracking and the associated IDs, refer to the “Appendix A: Purposes and Features Definitions” section of this [topic](https://iabeurope.eu/iab-europe-transparency-consent-framework-policies/). | | `CollectOption` | \[Int] | `purposesForIdentifying(value: [Int])` | This option is used to pass a list of purpose IDs, based on which you can manage the consent for identification. \[!NOTE] **NOTE**: To know more about the purposes for identification and the associated IDs, refer to the “Appendix A: Purposes and Features Definitions” section of this [topic](https://iabeurope.eu/iab-europe-transparency-consent-framework-policies/). | | `CollectOption` | String | `userCountry(code: String)` | This option must be set in alpha-iso3 codes, which can then be sent with every request as `user.user_country`. The API defaults the IP to determine the country if the user country is missing. This determines the region where the data is stored. | | `CollectOption` | Boolean | `areIdentitiesHashed(value: Bool)` | This option indicates whether the identities shared in setUserIdentities are hashed or not. By default, isHashed is set to false. \[!NOTE] **NOTE**: This option is applicable only for PIIs and not for Custom Identities. | | `CollectOption` | Boolean | `hashIdentities(value: Bool)` | This option indicates whether or not hashing of the raw identities is required. By default, the hashing is set to false. \[!NOTE] **NOTE**: This option is applicable only for PIIs and not for Custom Identities. | | Option | - | `build()` | This function builds the Option object that is required to initialise the Collect SDK with the configuration passed to the `CollectOption` object. | ## Methods Available in Zeotap CDP Instance The following methods are available in the Zeotap CDP instance: | **METHODS** | **DESCRIPTION** | | - | - | | `static func initialize(option: Option) -> Void` | **`Collect.initialize(option: )`** This method initializes the SDK with the context, write key and additional configuration. | | `static func getInstance() -> Collect?` | **`Collect.getInstance()`** This method returns the Collect object that contains the SDK functions. | | `func setEventProperties(String, [String: Any]?, ResponseCallback?) -> Void` | **`Collect.getInstance()?.setInstantEventProperties`** **(eventName,** **eventProperties, `{data in}`)** This method sends an event with the specified event name.It can be called with event properties, callback options, or both. | | `func setInstantEventProperties(String, [String: Any]?, ResponseCallback?) -> Void` | **`Collect.getInstance()?.setInstantEventProperties`** **(eventName,** **eventProperties, `{data in}`)** This method sends an event with the given event name immediately, bypassing the queue for batch sending. It can be called with event properties and a callback to attach event properties and handle the response, respectively. | | `func setUserProperties([String: Any], ResponseCallback?) -> Void` | **`Collect.getInstance()?.setUserProperties(userProperties, {data in }`)** This method sends an event with the given user properties, along with default user properties. Use setUserProperties to override existing user properties. It can be called with callback functions to handle the response in the application. | | `func setPageProperties([String: Any], ResponseCallback?) -> Void` | \*\*`Collect.getInstance()?.setPageProperties(pageProperties, {data in}`) \*\* This method sends an event with the given page properties. All subsequent `events` will include a page node with these properties. Use setPageProperties to override the existing page properties. | | `func setUserIdentities([String: String], ResponseCallback?) -> Void` | **`Collect.getInstance()?.setUserIdentities(userIdentities, {data in}`)** This method sends an event with the given user identities. All subsequent `events` will include these user identities. | | `func unSetUserIdentities() -> Void` | **`Collect.getInstance()?.unSetUserIdentities()`** This method is used to remove user identities that are set by the setUserIdentities method. | | `func pauseCollection() -> Void` | **`Collect.getInstance()?.pauseCollection()`** This method is used to pass the SDK from the Collect `events` for the user’s actions. | | `func resumeCollection() -> Void` | **`Collect.getInstance()?.resumeCollection()`** This method resumes the SDK to collect the `events` if the SDK was paused to collect by the **pauseCollection**() method. | | `func setConsent(consent: [String: Any], ResponseCallback?) -> Void` | **`Collect.getInstance()?.setConsent(consent: consentData, {data in}`)** This method sets consent in the non-TCF consent management system included in the SDK. It also accepts brand consent, which is stored along with the user's primary consent to ensure consistency across `events`. | | `func listenToAskForConsent(action: Action) -> Void` | **`Collect.getInstance()?.listenToAskForConsent(action: actionCallback)`** This method listens to the `ask_consent` event that is triggered when the SDK wants you to ask the user for consent. | | `func setAdvertisingIdByATTStatus(status: ATTrackingManager.AuthorizationStatus) -> Void` | **`Collect.getInstance()?.setAdvertisingIdByATTStatus(status: ATTrackingManager.AuthorizationStatus)`** This method is used to send ATT status to the event payload along with the Advertising ID if authorization status was authorized. | | `func setATTStatusAndAdvertisingId(status: ATTrackingManager.AuthorizationStatus, advertisingId: String?) -> Void` | **`Collect.getInstance()?.setATTStatusAndAdvertisingId(status: ATTrackingManager.AuthorizationStatus, advertisingId: String?)`** This method is used to send ATT status and Advertising ID to the event payload in case ATT status needs to be verified and shared to SDK. | ## Verify the Connection Upon successful integration, send some `events` through your app to verify the connection. Once the connection is established and tested, log in to the Zeotap CDP App and navigate to the particular iOS source to view the data in the **PREVIEW** tab. ## iOS 14 or later The iOS SDK collects the Identifier for Advertisers (IDFA) id automatically from the user device if the iOS version is 13 or below and then sends it in the event payload as *advertising_id* . However, in the case of iOS 14 or later, the iOS SDK does not collect the IDFA id automatically due to Apple’s latest privacy focused guideline. You can refer to [https://developer.apple.com/app-store/user-privacy-and-data-use/](https://developer.apple.com/app-store/user-privacy-and-data-use/). ### Collect the IDFA If you want the iOS SDK to pass the IDFA in the event payload, then using the Apple’s App Tracking Transparency (ATT) framework, you can display a pop-up to get the permission from the user to read the IDFA. On passing the ATT Authorisation Status to the iOS SDK, it adds `att_authorization_status` and `advertising_id` to the payload. To know about the Tracking Transparency (ATT) framework, refer to the Apple documentation [here](https://developer.apple.com/documentation/apptrackingtransparency). `att_authorization_status` can have four different values as mentioned below. For more information on them, refer to the Apple guide [here](https://developer.apple.com/documentation/apptrackingtransparency/attrackingmanagerauthorizationstatus). * `authorized` * `denied` * `not_determined` * `restricted` The `advertising_id` can be passed along with the event payload, only if the `att_authorization_status` was authorised. The following are the two options where you can pass the ATT Authorization Status: * **setAdvertisingIdByATTStatus** - By passing `att_authorization_status` to this function, the iOS SDK functions get the IDFA from the device and send the id and status with payload. ```js Code theme={null} ATTrackingManager.requestTrackingAuthorization { status in Collect.getInstance()?.setAdvertisingIdByATTStatus(status: status) } ``` * **setATTStatusAndAdvertisingId** - This function expects the ATT Authorisation Status and IDFA string based on the permission. If the permission was not authorised, then passing the ATT Authorisation Status to SDK alone is enough in case of future usage. ```js expandable theme={null} ATTrackingManager.requestTrackingAuthorization { status in switch status { case .authorized: Collect.getInstance()?.setATTStatusAndAdvertisingId( status: status, advertisingId: ASIdentifierManager.shared().advertisingIdentifier.uuidString ) case .denied: Collect.getInstance()?.setATTStatusAndAdvertisingId( status: status ) case .notDetermined: Collect.getInstance()?.setATTStatusAndAdvertisingId( status: status ) case .restricted: Collect.getInstance()?.setATTStatusAndAdvertisingId( status: status ) @unknown default: print("Unknown") } } ``` ## Track Page Views After integrating the **`SDK`**, you can log the users' page view `events` by calling **`setPageProperties([String: Any]`**) and sending all page related information as **`key=value`** properties on the page load event. All further user `events` on the same page are then attached with these page properties. | **Parameter** | **Type** | **Description** | | - | - | - | | **`properties`** | \[String: Any] | This indicates the page specific properties. | Below is an example showing how to capture user viewing a **`Product`** page: ```js Code theme={null} var pageProperties = [ "name": "Product" ] Collect.getInstance()?.setPageProperties(pageProperties) ``` > [!NOTE] > > **Note:** > > If page properties are not defined, then by default, no page property is available on an event payload. ## Track User Actions After tracking the page views, you can start tracking the `events`. Use the **`setEventProperties`** method to track different user actions on the Application (for example, the **`selectVariant`** event with **`colour`** as a property) and properties relating to the event (for example, a **`ViewProduct`** event with **`productName`**, **`color`** as a property. | **Parameter** | **Type** | **Description** | | - | - | - | | **`eventName`** | String | This is the name of the event. | | **`eventProperties`** | \[String: Any] | This is the object containing any properties for a particular event. | The following are the two types of `events` that you can capture using iOS SDK: * System Events * Custom Events **System Events** - System `events` refer to predefined actions that the system tracks based on specific user interactions. These `events` capture essential activities related to user consent and identities. These `events` ensure consistent tracking and tagging of key actions, which aids in debugging and understanding user behaviour. You can use these `events` to enrich the user profiles with the information captured. The following table lists the system `events` that are triggered in specific scenarios: > [!NOTE] > > **Note:** > > *This granular level of tracking has been enabled since May 14, 2024. Any system event tracked before this date is tagged with the common name SystemEnrichmentEvent which could have been triggered by any of the scenarios listed below.* | **Event Name (Tags)** | **Scenarios** | | - | - | | Set consent | Triggers the first time a user lands on the app and sets consent | | Update consent | Triggers when a user changes their consent | | Set identities | Triggers when a user logs in | | Update identities | Triggers when a user changes already set identities | **Custom Events** - Custom `events` refer to user-defined actions specific to your application that are not covered by predefined system `events`. These `events` can be used to track additional behaviours, capture specific data points and provide deeper insights into user activities. The following table lists some examples of custom `events`: | **Event Name (Tags)** | **Scenarios** | | - | - | | Add to cart | Triggers when a user adds an item to their shopping cart | | Remove from cart | Triggers when a user removes an item from their shopping cart | | Complete purchase | Triggers when a user completes a transaction | Below is an example showing how to track a product being viewed, which can be triggered on the **ViewProduct** event. ```js Code theme={null} var eventProperties = [ "productName": "test product", "color": "white", "price": "100" ] Collect.getInstance()?.setEventProperties("ViewProduct", eventProperties); ``` This example creates the following payload: ```js Code theme={null} { "events": [ { "eventUUID": "4b22525c-de33-4c5f-8934-e04e682e9f6e", "event": { "eventName": "ViewProduct", "productName": "test product", "color": "white", "price": "100", "eventTimestamp": "2022-01-11 07:25:23 UTC" }, "user": { "app_name": "TestApp", "advertising_id": "8626081E-56FB-4EB8-968D-56BB6156BB26" "att_authorization_status": "authorized" "os_type": "iOS" "os_version": "15.5", "country": "GBR" "app_version": "1.0", "device_model_identifier": "iPhone13,2", "network_type": "wi-fi", "carrier": "Jio 4G", "zi": "3B2F4C6D-2455-4BFD-8A1C-04FB5FEE4017" }, "version": "1.0.0" } ] } ``` ### Identify Default Users The SDK creates an ID called **`zi`** for user identification. This ID is attached to all the event calls from the SDK, such as page views and user `events`. This ID is unique per the application. **`UserDefaults`** is utilised for storing these IDs with an encrypted key that is derived from the **``**. The **`zi`** ID is unique to each instance of the SDK that is write key based. The table below explains certain features available in the SDK regarding the **zi** ID. | **Feature** | **Description** | | - | - | | **`Collect.getInstance()?.getZI() -> String`** | This is the method to get the **`zi`** value. | | **`Collect.getInstance()?.resetZI() -> Void`** | This is the method to reset the **`zi`** value for a user. You can use this method in case you want to differentiate users based on user login and so on. | | **`Collect.getInstance()?.setZI(zi: String) -> Void`** | This is the method to set a custom **`zi`** value that overrides the value generated by the SDK. You can use hashed \*\*`userid`\*\*or **`loginid`** for this purpose if required. | #### Capture Users Properties You can use the **`setUserProperties`** method to attach user information for a known user who is using the Application. The user information is as follows: * DB ID for the user (recommended) * Any additional information about the user that you want to identify as a user attribute Call **`Collect.getInstance()?.setUserProperties(properties)`** where properties is an object containing user identifiers and attributes that are sent as **`key=value`** properties to SDK `events`. Below is an example showing how to add user attributes of the user visiting the app. ```js Code theme={null} var userProperties = [ "property": "value" ] Collect.getInstance()?.setUserProperties(userProperties); ``` If the user is unknown, you can skip this. By default, we automatically assign pseudonymous-ids to keep track of users as they navigate around your Application. #### Capture User Identities The **`setUserIdentities`** method identifies the object that can be set by the user and saved in user storage. The following are the keys that are accepted in user Identities: | **Name** | **Type** | **Description** | | - | - | - | | **`[email]`** | String | This is the email address of the user. | | **`[loginid]`** | String | This is the login id of the user. | | **`[cellno]`** | String | This is the cell phone number of the user. Ensure that you provide the cell phone number in the following format: `[country_code][space][cell_number]`. For example, `49 1234567890`. We recommend that you always send cell phone number in this format. \[!NOTE] **Note:** Do not include ‘+’ while sending the cell phone numbers.\\ | | **`[cellno_cc]`** | String | This is the cell phone number of the user with the country code. \[!NOTE] **Note:** We recommend that you do not provide cell phone numbers with country code.\\ | Below is an example showing how to pass the user identities. ```js Code theme={null} var userIdentities = [ "email": "test@gmail.com", "loginid": "testUser123", "cellno": "49 1234567890", "cellno_cc", "91-1234890987" ] Collect.getInstance()?.setUserIdentities(userIdentities); ``` #### Raw User Identities While capturing user identities in the raw form, you may or may not want Zeotap to hash them. Refer to the table below to understand the scenarios, the SDK options that are involved and a sample to invoke the **`setUserIdentities`** method. | **Scenario** | **SDK Options** | **setuseridentities** | | - | - | - | | You send raw user identities, but do not want Zeotap to hash them | The following SDK options are involved in this scenario:
  • **areIdentitiesHashed(false)**
  • **hashIdentities(false)**
| **var userIdentities = \[** **"email": "[test@gmail.com](mailto:test@gmail.com)",** **"cellno": "49 1234567890"** **]** **Collect.getInstance()?.setUserIdentities(userIdentities);** | | You send raw user identities and want Zeotap to hash them | The following SDK options are involved in this scenario:
  • **areIdentitiesHashed(false)**
  • **hashIdentities(true)**
| **var userIdentities = \[** **"email": "[test@gmail.com](mailto:test@gmail.com)",** **"cellno": "49 1234567890"** **]** **Collect.getInstance()?.setUserIdentities(userIdentities);** | Upon capturing the raw user identities, the **`setUserIdentities`** method considers the properties as mentioned in the table below. | **Parameter** | **Type** | **Description** | | - | - | - | | **`userIdentities`** | \[String: Any] | This is the Object containing the user identities. | | **`[userIdentities.email]`** | String | This is the user's raw email address. The SDK either captures as is or converts to **`sha256`, `sha1`, `md5`** lowercase and uppercase hashed values, based on the SDK configurations. | | **`[userIdentities.cellno]`** | String | This is the user's raw cell phone number. The SDK either captures as is or converts to **`sha256`, `sha1`, `md5`** based on the SDK configurations. | | **`[userIdentities.loginid]`** | String | This is the user’s login ID that is hashed and logged. | | **`[userIdentities.cellno_cc]`** | String | This is the user's raw cell phone number. The SDK either captures as is or converts to **`sha256`, `sha1`, `md5`** with the country code, based on the SDK configurations. | > [!NOTE] > > **Note**: > > For the following selections, by default, we hash the raw identities to **`sha-256`, `sha-1`** and **`md-5`**: * When **`areIdentitiesHashed: false`** * When **`CollectOption.optOut(value: Bool)`** is set to **`false`** #### Hashed User Identities You may only send in user identities that are hashed using algorithms like **`SHA-256`**, **`SHA1`** and **`MD5`**. In this scenario, refer to the table below to understand the scenario, the SDK options that are involved and a sample for the **`setUserIdentities`** property. | **Scenario** | **SDK Options** | **setUserIdentities** | | - | - | - | | You send hashed user identities only | The SDK option involved in this scenario is **`areIdentitiesHashed(value: true)`** | `var userIdentities = [` `"email_sha256_lowercase": "b0492275843c15593bba8a749` `c3379e3b5067aab173e91fcb37d840ca8b1738d` `",` `"cellno_with_country_code_sha256":"91-1234567890"` `]` `Collect.getInstance()?.setUserIdentities(userIdentities);` | After you have captured the raw email and phone number of the users and hashed, the **`setUserIdentities`** property is configured with properties, as mentioned in the table below. | **Parameter** | **Type** | **Description** | | - | - | - | | **\`userIdentities** | \[String: Any] | This is the Object containing the user identities. | | **`[userIdentities.email_sha256_lowercase]`** | String | This is the user's email address hashed to **`sha256`** after converting it to lowercase. | | **`[userIdentities.email_sha256_uppercase]`** | String | This is the user's email address hashed to **`sha256`** after converting it to uppercase. | | **`[userIdentities.email_md5_lowercase]`** | String | This is the user's email address hashed to **`md5`** after converting it to lowercase. | | **`[userIdentities.email_md5_uppercase]`** | String | This is the user's email address hashed to **`md5`** after converting to uppercase. | | **`[userIdentities.email_sha1_lowercase]`** | String | This is the user's email address hashed to **`sha1`** after converting to lowercase. | | **`[userIdentities.email_sha1_uppercase]`** | String | This is the user's email address hashed to **`sha1`** after converting to uppercase. | | **`[userIdentities.cellno_without_country_code_sha256]`** | String | This is the user's cell phone number without the country code and hashed to **`sha256`**. | | **`[userIdentities.cellno_without_country_code_md5]`** | String | This is the user's cell phone number without the country code and hashed to **`md5`**. | | **`[userIdentities.cellno_without_country_code_sha1]`** | String | This is the user's cell phone number without the country code and hashed to **`sha1`**. | | **`[userIdentities.cellno_with_country_code_sha256]`** | String | This is the user's cell phone number with the country code and hashed to **`sha256`**. | | **`[userIdentities.cellno_with_country_code_md5]`** | String | This is the user's cell phone number with the country code and hashed to **`md5`**. | | **`[userIdentities.cellno_with_country_code_sha1]`** | String | This is the user's cell phone number with the country code and hashed to **`sha1`**. | | **`[userIdentities.cellno_e164_sha256]`** | String | This is the user's cell phone number in e164 format hashed to **`sha256`**. | | **`[userIdentities.cellno_e164_md5]`** | String | This is the user's cell phone number in e164 format hashed to . | | **`[userIdentities.cellno_e164_sha1]`** | String | This is the user's cell phone number in e164 format hashed to **`sha1`**. | | **`[userIdentities.loginid_sha256_lowercase]`** | String | This is the user’s login ID that is logged. We hash the login ID to **`sha256`** after converting to lowercase. | | **`[userIdentities.loginid_sha256_uppercase]`** | String | This is the user’s login ID that is logged. We hash the login ID to **`sha256`** after converting to uppercase. | | **`[userIdentities.loginid_md5_lowercase]`** | String | This is the user’s login ID that is logged. We hash the login ID to **`md5`** after converting to lowercase. | | **`[userIdentities.loginid_md5_uppercase]`** | String | This is the user’s login ID that is logged. We hash the login ID to **`md5`** after converting to uppercase. | | **`[userIdentities.loginid_sha1_lowercase]`** | String | This is the user’s login ID that is logged. We hash the login ID to **`sha1`** after converting to lowercase. | | **`[userIdentities.loginid_sha1_uppercase]`** | String | This is the user’s login ID that is logged. We hash the login ID to **`sha1`** after converting to uppercase. | > [!NOTE] > > **Note:** > > To know about the hashing guidelines for email and cell phone numbers, refer [here](https://docs.zeotap.com/smart/project-unify/hashing-guidelines). ### Set Events With Callback Function You can also set `events` with Callback function as shown below. The `data` parameter is an object that contains `status` and `message`. ```js Code theme={null} Collect.getInstance().setEventProperties("Add_to_cart", {data in // Implement function to handle response }) ``` > [!NOTE] > > **Note:** > > For more information about the `Callback` function status codes and errors, refer [here](/articles/integrate-customer/sdk-reference). ### Log Out Communication If you no longer wish to attach these identities to the `events` (for example, when the user logs out) you can communicate this by using **`unsetUserIdentities`** and then remove identities. Call the following method: **`Collect.getInstance()?.unsetUserIdentities()`** ## Send User Profile Information If you have any other information you want to send about the user on the app, you can send the same using **`setUserProperties`**. This is sent to the API with the default user **zi** ID, along with any other identities set using **`setUserIdentities`**. Below is an example showing how to pass the user profile information. ``` var userProperties = [ "profileInfo": "xyz"] Collect.getInstance()?.setUserProperties(userProperties); ``` This example creates the following payload: ```json expandable Code theme={null} { "events": [ { "eventUUID": "4b22525c-de33-4c5f-8934-e04e682e9f6e", "event": { "eventName": "set_user_properties", "eventTimestamp": "2022-01-11 07:25:23 UTC" }, "user": { "profileInfo": "xyz", "app_name": "TestApp", "advertising_id": "8626081E-56FB-4EB8-968D-56BB6156BB26", "att_authorization_status": "authorized", "os_type": "iOS", "os_version": "15.5", "country": "GBR", "app_version": "1.0", "device_model_identifier": "iPhone13,2", "network_type": "wi-fi", "carrier": "Jio 4G", "zi": "3B2F4C6D-2455-4BFD-8A1C-04FB5FEE4017", "email": { "sha256_uppercase": "1646f5abd0f70d957a1023d3f590112c5414870a645f70e886190cb7bb21b7c8", "md5_uppercase": "e307f5ddc2a641dc63ace209e17b4f80", "sha256_lowercase": "87924606b4131a8aceeeae8868531fbb9712aaa07a5d3a756b26ce0f5d6ca674", "md5_lowercase": "1aedb8d9dc4751e229a335e371db8058", "sha1_uppercase": "3bc0530dc30b220971f51e8d9366404459a41b3f", "sha1_lowercase": "ea97b75619f5cb2b9df9d184c4541aafe3b87484" }, "loginid": { "sha256_uppercase": "ae92131ba35250a06293a5559c1ba6ac76dd3ddb9739296e98346b3e85e78082", "md5_uppercase": "b56863686f58f6c4db3fbf4ecec528d0", "sha256_lowercase": "d79aeec77b3b6e6ec5f45ae5e040173380262e1ea51b38747195c3cf09a02f16", "md5_lowercase": "e4b4efd20ada72c6f7708b0c1cc78469", "sha1_uppercase": "53bdce88eeb1dcfb7fc5bed5e184bb731e0a1626", "sha1_lowercase": "7f58658e453b43196b35d75720b8c35fd2f85bba" }, "cellphone_number_withoutcode": { "sha1": "01b307acba4f54f55aafc33bb06bbbf6ca803e9a", "sha256": "c775e7b757ede630cd0aa1113bd102661ab38829ca52a6422ab782862f268646", "md5": "e807f1fcf82d132f9bb018ca6738a19f" }, "cellphone_number_withcode": { "sha1": "8484de05645d4f91ac601302eb86243c92cb658c", "sha256": "b0492275843c15593bba8a749c3379e3b5067aab173e91fcb37d840ca8b1738d", "md5": "39483edd3a189837aedd9916e4ff32fc" }, "cellphone_number_e164": { "sha1": "9bd6ad2d480f48e483d87fb7bf456c2ad0dc3744", "sha256": "e8bd567e917e41a827e93d920c096d24306dd9378394540df7fd94a611e96439", "md5": "99e1e1b0616b4c007a81b7872ce76606" } }, "version": "0.0.1" } ] } ``` ## Track User Consent The consent that you provide is used for the following two primary purposes: * User identification * Tracking user data The iOS SDK has two different ways to determine user consent that enable the collection, documentation and management of your user's privacy choices in order to ensure legal compliance. Zeotap stores the consent information in the customer profile against their unique Customer ID. For more information on how Zeotap stores and processes consent, you can refer to the [Consent Management](https://docs.zeotap.com/smart/project-unify/adding-a-consent-category) feature of Zeotap. ### Default Opt-in In this scenario, you directly provide consent to Zeotap by setting the **`optOut`** flag to **`true`** or **`false`**. For all these three purposes, if the **`optOut`** flag is set to **`true`**, then it indicates that you have not granted access to Zeotap. Here, iOS SDK is not allowed to perform user identification or tracking user data. However, if the **`optOut`** flag is set to **`false`**, then the SDK is allowed to perform all the above actions. | **Function** | **Type** | **Value** | **Description** | | - | - | - | - | | **`CollectOption:: optOut`** | Boolean | **`false`** | This is an explicit consent signal that you set. When enabled, the SDK can perform user identification, cookie syncing and event capturing. | ### GDPR TCF CMP If you already have a [TCF 2.0 Consent Management Platform (CMP)](https://iabeurope.eu/tcf-2-0/) implemented on your app, then the SDK automatically checks for the same. To do this, both the **`useConsent`** and **`checkForCMP`** flags are set to **`true`**. The SDK also queries the TCF consent string to fetch the Publisher’s consent before recording the `events`. The below table describes the keys/parameters that need to be configured while using the GDPR consent module. | **Function** | **Type** | **Value** | **Description** | | - | - | - | - | | **`CollectOption:: useConsent`** | Boolean | **`true`** | If this option is set to **`true`**, then the SDK waits to receive a consent signal and uses that consent to manage actions. This consent signal is determined by **`CollectOption:: checkForCMP.`** | | **`CollectOption:: checkForCMP`** | Boolean | **`true`** | If this option is set to **`true`**, then we check for the presence of the **`TCF 2.0`** variables in the **`UserDefaults`**. If the **`TCF 2.0`** variables are present, then we query the CMP API and check for the publisher’s consent.If this option is set to **`false`**, then we use the set consent signal using the **`setConsent`** method. | | **`CollectOptions.Builder::checkZeotapvendorConsent`** | Boolean | **`true`** or **`false`** | For CMP case, if set to true, then the SDK checks for Zeotap Vendor consent, while resolving GDPR consent to send the data.If set to false, then the SDK ignores Zeotap Vendor consent. Note that the default value is false. | | **`CollectOption:: purposesForTracking`** | \[Int] | **\[1, 3, 4]** | This option is used to pass a list of purpose IDs, based on which you can manage the consent for tracking. \[!NOTE] **Note**: To know more about the purposes for tracking and the associated IDs, refer to the “Appendix A: Purposes and Features Definitions” section of this [topic](https://iabeurope.eu/iab-europe-transparency-consent-framework-policies/). | | **`CollectOption:: purposesForIdentifying`** | \[Int] | **\[1, 9]** | This option is used to pass a list of purpose IDs, based on which you can manage the consent for identification. \[!NOTE] **Note**: To know more about the purposes for identification and the associated IDs, refer to the “Appendix A: Purposes and Features Definitions” section of this [topic](https://iabeurope.eu/iab-europe-transparency-consent-framework-policies/). | ### Custom Consent You may not want to explicitly give consent or even use the TCF API. Instead, they may want to have a custom consent flow. The following three points summarize this scenario: * The **`useConsent`** flag is set to **`true`** * The **`checkForCMP`** option is set to **`false`** * The **`setConsent`** method is used to resolve the user consent The user consent is then stored in **`UserDefaults`** and used as the user's consent status for the subsequent event log until a new status is set using the same. The following are the keys that are accepted in user consent: | **Name** | **Type** | **Description** | | - | - | - | | **`track`** | boolean | **True** if we want to track any user data | | **`identify`** | boolean | **True** if it is allowed to identify you and a user. | In custom consent, you provide access to a specific consent signal based on their requirement. The consent is passed as a Dictionary object. Granular Consent has the following consent signals: * **`track`** – This consent signal is used to track and record user activities. Any consent cookie created to store consents can use this permission, as it precedes all other data collection. * **`identify`** – This consent signal is used for user matching and third-party enrichment(for example, **`zcookie`** and ID+ permissions). In granular consent, you can provide access to one or more consent signals. For example, of all the consent signals you may provide access to **`Tracking`** but not for **`Identification`**. The consent is passed in the form of a Dictionary with the particular signal marked as **`true`** or **`false`**. Going by the above example, the Object would be set to **`true`** for **`Tracking`** and **`false`** for **`Identification`**. #### Call the setConsent Method Call the setConsent method as mentioned below. ```javascript JavaScript theme={null} Collect.getInstance()?.setConsent(consent: value); ``` | **Parameter** | **Type** | **Required** | **Description** | | - | - | - | - | | **value** | \[String: Any] | Yes | \[String: Any]– Granular consent allows passing **`value`** as a Dictionary. | #### Invoke Custom Consent Below is an example showing how you can set the user's consent status. ```javascript JavaScript theme={null} // if user opts in var consentData = [ "track": true, "identify": true ] Collect.getInstance()?.setConsent(consent: consentData); // to signal consent // and var consentData = [ "track": false, "identify": false ] Collect.getInstance()?.setConsent(consent: consentData); // to signal opt out ``` The SDK waits for a consent call if it is unable to find the saved consent. To know when to ask for consent in case a consent signal is not available, add a **`callback`** listener as mentioned below. ```javascript JavaScript theme={null} Collect.getInstance()?.listenToAskForConsent (action: { _ in // trigger UI to appear }); ``` ### Track Brand Consent Use the `setConsent` method to store brand-specific consent, such as `zeotapVendorConsent` or `xyzVendorConsent`, and ensure it persists across all `events`. #### Example ```javascript JavaScript theme={null} var brandConsentData = [ "zeotapVendorConsent": true, "xyzVendorConsent": false ] Collect.getInstance()?.setConsent(consent: brandConsentData); ``` This method works with all consent configuration settings to pass brand consent when consent is resolved. > [!NOTE] > > **Note:** > > *For consent types other than **custom consent**, the `track` and `identify` flags are ignored because the consent configuration differs.* ## Users User information is available in the form of identifiers such as CRM IDs, person IDs or user attributes such as age, gender or customer classification. However, app event data is not considered user information. All this information helps tie the online behaviour of the user with the logged-in user ID and previously known user information. This user information is especially useful when you have users who visit the app from multiple devices, or who use your app. The CRM ID helps us to identify the user as the same user across the devices or app. The following are some of the user methods: * If you want to tie post-login behaviour to the actual logged-in user, then use **`setUserIdentities`** or **`setUserProperties`** depending on your use case. * If you want to merge unknown and known user identities into one, then use **`setUserProperties`** to update the information against the single user. * If you want to differentiate the two users, then use **`setUserIdentities`** to attach the logged-in identities of the users to specific actions till it is unset. You can call the above-mentioned user methods in the following situations: * On user registration * On user login * On user profile update * On user visit to post-login specific pages (like a wishList or a member-only Offers page) ### List of Accepted Identifiers The following are the list of accepted identifiers that are used only as intended and sent as **`key=value`** pairs: * **email** – This is the registered email address of the user. The email address is hashed to **`sha256, sha1`** and **`md5`** after the SDK converts them to lower and upper cases before they reach the Zeotap servers. * **cellno** – This is the registered cellular phone number of the user. The phone number is hashed to **`sha256, sha1`** and **`md5`** by the SDK before it reaches the Zeotap servers. * **cellno_cc** – The dialing country code (such as 33 for France, 44 for the UK, 1 for the USA, 34 for Spain and so on) can be sent here. The dialing country code is attached to the cellular phone number to create hashes with country codes before it reaches the Zeotap servers. * **loginid** – This is the app-specific login ID. The login id is hashed to **`sha256, sha1`** and **`md5`** by the SDK before they reach the Zeotap servers. * **Custom Identities** – Custom identities are the identities that the client chooses to input and can be any of their first-party identifiers. Note that the hashing configurations are not applicable for custom identities. Some examples of custom identities are crmID, ECID and visitorID. The following is the format, in which you can pass the custom identities: `Collect.getInstance().setUserIdentities(["crmId":"123"])` > [!NOTE] > > **Note**: > > * To send any other identifiers apart from the identifiers mentioned above, reach out to your TAM with details for the same. Zeotap updates the catalogue and sends you the correct key that is required to start sending the data. > * Only the main cellular phone number must be sent, without any country codes, prepended numbers (like 0), or symbols such as +, (, ) and so on. ## Events Events are actions performed by a user on your app. These could range from searching for a product, viewing an offer, subscribing to a newsletter and so on. Event properties are details describing the event, and could refer to user action specific to the event (such as **`event: applyDiscount`** having **`property: discountCodeSelected`**) or property of the event itself (such as **`event: applyDiscount`** having **`property: newPrice`**). Tracking this helps understand user journey and behaviour on the app. The Zeotap library supports custom `events` and properties for the automotive and ecommerce verticals. To track any new `events` you can add the event name and its property in the object and pass it to **`setEventProperties`** of Collect instance. Defining some sample `events` and the properties for it below. **Method**: **`Collect.getInstance()?.setEventProperties(eventName,eventProperties)`** | **event** | **eventProperties (sent as key=value)** | | - | - | | **`viewHome`** | | | **`viewCategories`** | categoryLevel1 (string), categoryLevel2 (string), categoryLevel3 (string) | | **`viewProductDetails`** | productID (string), productName (string) | | **`setConfigurations`** | productID (string),colour (string),model (string),subModel (string),engine (string),fuelType (string),transmission (string),trim (string),brand (string),ecolabel (string),vehicletype (string),emissionstandard (string),power (string),torque (string),fuelcapacity (double),seatingcapacity (string),luggagecapacity (string),tiresize (string),maxspeed (double),acceleration (double),fuelconsumption (string),weight (string) | | **`calculateFinance`** | productID (string),price (string),currency (string) | | **`makeAppointment`** | productID (string) | | **`requestTest`** | productID (string) | | **`login`** | | You can also set the above event names as **`eventType`** property and add your own custom names for each step, in order to group all `events` under a single type. For example, **`setConfigurations`** as **`eventType`** and **`selectColour, selectModel`** and so on as the actual **`eventNames`**. ```js Code theme={null} var eventProperties = [ "eventType": "setConfigurations", "colour": "black" ] Collect.getInstance()?.setEventProperties('selectColour', eventProperties); ``` ## Pages Setting the page properties is useful in tracking all `events` that occur within a page to a single page view. Therefore, ensure to set this first before calling the event method. Below is the list of page names that can be set against the property **‘name’**. ```js Code theme={null} var pageProperties = [ "name": "Home" ] Collect.getInstance()?.setPageProperties(pageProperties); ``` ## Contextual Information Zeotap records additional information relating to an event triggered or a page being loaded and then supplements details to the data point being captured. The following are the contextual information that Zeotap captured: * device Id/iOS id * telco carrier, network type, os version * DeviceManufacturer * DeviceModel * DeviceVersion * ClientAppName and ClientAppVersion # Implement the React Native Package Source: https://docs.zeotap.com/articles/integrate-customer/implement-the-react-native-package > [!NOTE] > > **Looking for the developer reference?** The [Zeotap React Native SDK developer documentation](/articles/sdks/react-native/intro) covers installation, configuration options, the full API reference, consent management, and release notes. This page explains how to implement the React Native package within the Zeotap CDP. > [!NOTE] > > **Important Notice:** > > *If the new architecture is enabled in a React Native application, use SDK version 1.3.0 or higher with the required new architecture configurations. If you experience issues with a higher version, contact our support team at [support@zeotap.com](mailto:support@zeotap.com).* ### Latest Version 1.3.3 ## Overview React Native is a popular JavaScript framework for building mobile applications. It allows developers to write code once and deploy it on multiple platforms, such as iOS and Android. This section addresses the integration of the zeo-collect package into your React Native project, the setup of Android and iOS SDKs and the configuration of the package to receive events. ## Get Started To start with, you have to create [Android](https://docs.zeotap.com/smart/project-collect-customer/creating-android-sdk-source) and [iOS](https://docs.zeotap.com/smart/project-collect-customer/create-an-ios-sdk-source) sources in the Collect application within Zeotap and obtain the `write_keys` for the same. Once done, you can then integrate the zeo-collect package into your React Native project as follows: 1. [Integrate the `zeo-collect` Package](/articles/integrate-customer/implement-the-react-native-package#step-1-integrate-zeo-collect-package) 2. [Set up Zeotap Android SDK](/articles/integrate-customer/implement-the-react-native-package#step-2-set-up-zeotap-android-sdk) 3. [Set up Zeotap iOS SDK](/articles/integrate-customer/implement-the-react-native-package#step-3-set-up-ios-sdk) 4. [Configure the React Native Package](/articles/integrate-customer/implement-the-react-native-package#step-4-configure-the-react-native-package) 5. [Send Events to Zeotap](/articles/integrate-customer/implement-the-react-native-package#step-5-send-events-to-zeotap) ### Step 1 - Integrate `zeo-collect` Package Perform the following steps to integrate the `zeo-collect` package into your React Native project: **Step 1** Run the following command from the primary directory of the project: `npm install zeo-collect` **Step 2** Check for the `package.json` file in your project's package and verify that the `zeo-collect` package is included within the dependencies section. ### Step 2 - Set up Zeotap Android SDK Next, you have to set up the `ZeotapCollect` Android SDK using the Dependency Manager. To do so, perform the following steps: > [!NOTE] > > **Note:** > > The **Android SDK** version and the **`Gradle`** tool version mentioned in the integration steps are for reference purposes only. Ensure to use the latest version during the setup process. **Step 1** At the project level of the `build.gradle` file or `settings.gradle file ` (**Project root > `build.gradle` or Project root > `settings.gradle`**), add the Maven URL given below in the repositories block: ```js Code theme={null} repositories { google() maven { url 'https://sdk.zeotap.com/android-sdk' } } ``` **Step 2** In the app level `build.gradle` file (**Project root** > **app** > **`build.gradle`**), add the following in the ​dependencies ​​block: ```js Code theme={null} dependencies { implementation "com.zeotap:zeo-collect:2.1.1" . . . } ``` **Step 3** Add the following compile options to ​the android​ block at the app level `build.gradle` file. ```js Code theme={null} android { ... compileOptions { sourceCompatibility JavaVersion.VERSION_1_8 targetCompatibility JavaVersion.VERSION_1_8 } } ``` **Step 4** If you have obtained the `AdID` yourself, then you can use the `setAdID` method to apply it. However, if you prefer the SDK to retrieve the `AdID`, then perform the following steps: a. For applications targeting Android version 13 or higher, include the following dependency in the app-level dependency block: ```js theme={null} dependencies { implementation "com.google.android.gms:play-services-ads:20.4.0" } ``` b. For applications targeting Android versions lower than 13, the SDK automatically retrieves the `AdID` on its own. **Step 5** Ensure that you add following dependency in app level dependency block, if you are not using json dependency in your project. ```js theme={null} dependencies { implementation "com.google.code.gson:gson:2.10.1" } ``` **Step 6** Do clean from **Build > Clean Project**. **Step 7** Sync the project with the **`gradle`** files and rebuild from **Build > Rebuild Project.** ### Step 3 - Set up iOS SDK Next, perform the following steps to set up the `ZeotapCollect` iOS SDK using Cocoa Pods: > [!NOTE] > > **Note:** > > To ensure whether CocoaPods is installed in your system or not, follow the instructions below: > > * To check if CocoaPods is installed, run the command `pod --version`. With CocoaPods installed, you can see the version number displayed, as shown in the image below. > * If CocoaPods is not installed, then you can add it to your project by following the instructions at [https://guides.cocoapods.org/using/using-cocoapods.html](https://guides.cocoapods.org/using/using-cocoapods.html). Once CocoaPods is installed in your system, perform the following steps to integrate `ZeotapCollect` iOS SDK: **Step 1** Navigate to the iOS directory within your project and execute the command `cd ios` to access the iOS folder from the project root: **Step 2** Run the command `pod install`. This identifies and installs the dependencies. ![](https://mintcdn.com/zeotap/PPCc1iCw6zeHLKUm/articles/integrate-customer/Storage/integrate-customer/implement-a-react-native-package/react_native_8.png?fit=max\&auto=format\&n=PPCc1iCw6zeHLKUm\&q=85\&s=3da5cdcba8c181535163087251eeb9e4) **Step 3** Once installed, open the `yourApplication.xcworkspace` file in Xcode. Note that you can find this file at `yourApplication/ios/yourApplication.xcworkspace`. > [!NOTE] > > **Note:** > > Ensure to close any other Xcode applications related to this project, such as the `xcodeproj` app. ### Step 4 - Configure the React Native Package Once you have successfully set up Zeotap Android and iOS SDKs, you can configure the React Native package by performing the following steps: * Initialise the `Zeo-collect` package by passing the options object in the initialiseZeoCollect function. Note that the options object must include the required package options (settings) as key-value pairs. The function also accepts an optional callback parameter, which receives a data object containing `{status, message}` and executes the implementation. * Invoke the `initialiseZeoCollect` function from your app's entry point, within the `useEffect` hook in the `App.js` file as shown in the example below. ```js Code theme={null} import {initialiseZeoCollect} from 'zeo-collect'; const App: () => React$Node = () => { const {persistor, store} = storePre; useEffect(() => { const options = {"android_write_key":"1b19b1c2-dcfc-497e-8d86-8d38cd183c5b", "ios_write_key":"1b19b1c2-dcfc-497e-8d86-8d38cd183c5b", "batch_size": 17, "opt_out":false, "service_interval": 50, "use_consent": false, "check_for_cmp":false, "user_country": "ind" } initialiseZeoCollect(options); // initialiseZeoCollect with callback // initialiseZeoCollect(options, (data) -> {console.log("Initialisation status", data);}); ... }, []); return ( // ... ); }; ``` > [!NOTE] > > **Note:** > > Ensure that the key names are used exactly as provided in the table below. Note that the `write_keys` are of the data type `String` only. The following table provides information about the Key names, data types and descriptions of the options involved in configuring the `zeo-collect` package: | **Key Name** | **Value Data Type** | **Description** | | - | - | - | | `android_write_key` | String | This is the Android write key generated after you create an Android source. | | `ios_write_key` | String | This is the iOS write key generated after you create an iOS source. | | `batch_size` | Integer | This is the maximum number of events allowed to remain in the unsent queue when scheduling an event. If the event exceeds this threshold, then the next batch is dispatched immediately. The default value is **30**. \[!NOTE] The minimum value for the batch size is **10** and the maximum value can be **50**. | | `service_interval` | Integer | This is the time interval for scheduling events. If the size of the queue is less than the threshold, then the request to post events is scheduled after the service interval. The default value is **90** seconds. | | `max_cache_size` | Integer | This is the maximum number of events allowed to be stored in the local memory in case of network issue or delayed consent. The default value is **100** and the maximum value can be **200**. | | `opt_out` | Boolean | This option acts as a fallback when consent is not used. If set to true, then no events are posted to Zeotap. The default value is `false`. | | `use_consent` | Boolean | This option manages actions based on the based on received consent. | | `check_for_cmp` | Boolean | This option manages consents based on the CMP data. If `check_for_cmp` is set to true along with `use_consent`, then you can look for CMP data stored by other CMPs. Subsequently, you can manage consents based on this CMP data. | | `are_identities_hashed` | Boolean | This option indicates whether the identities shared in `setUserIdentities` are hashed or not. The default value is `false`. | | `hash_identities` | Boolean | This option indicates whether or not the hashing of the raw identities is required. The default value is `false`. | | `check_zeotap_vendor_consent` | Boolean | If this option is set to true, then the package checks for Zeotap Vendor consent, while resolving GDPR consent to send the data. If set to `false`, then the package ignores the Zeotap Vendor consent. The default value is `false`. | | `logging` | Boolean | If set to `true`, then it displays the info, debug, warning and error log severity levels. Otherwise, it only displays the warning and error log severity levels. | | `purposes_for_tracking` | List/Array of Integers | This option is used to pass a list of purpose IDs, based on which you can manage the consent for tracking. \[!NOTE] To know more about the purposes for tracking and the associated IDs, refer to the “Appendix A: Purposes and Features Definitions” section of this [topic](https://iabeurope.eu/iab-europe-transparency-consent-framework-policies/). | | `purposes_for_identify` | List/Array of Integers | This option is used to pass a list of purpose IDs, based on which you can manage the consent for identification.\[!NOTE] To know more about the purposes for identification and the associated IDs, refer to the “Appendix A: Purposes and Features Definitions” section of this [topic](https://iabeurope.eu/iab-europe-transparency-consent-framework-policies/). | | `user_country` | String | This option determines the region where the data is stored. Note that you have to set this in alpha-iso3 codes.\[!NOTE] The API defaults the IP to determine the country if the user country is missing. | ### Step 5 - Send Events to Zeotap Perform the following steps to send events to Zeotap using the `zeo-collect` package: **Step 1** Import the necessary functions from the `zeo-collect package` into the relevant files. **Step 2** Invoke the appropriate function with the required arguments where you want the event data to be collected as mentioned in the examples below. > [!NOTE] > > **Note:** > > Ensure to replace the placeholders such as name, description, price and more with actual variables containing the relevant data you wish to send with the events. The functions of the `zeo-collect` package allow you to capture and transmit event-specific information to Zeotap for analysis and tracking. **Examples** * Using the `setEventNameProperties` function: ```js Code theme={null} import { setEventNameProperties } from 'zeo-collect'; // ... // Inside your component return ( ``` This triggers the `setEventProperties` function of the SDK with eventName as ‘addToCart' with properties as product: 'handbag'. At this point, you can start tracking activities such as page views and other user actions as outlined below. #### AMP Page Tracking You can log the users' page view events by calling `setPageProperties` and sending all page related information as key=value properties on the page load event. All further user events on the same page are then attached with these page properties. | **Parameter** | **Type** | **Description** | | - | - | - | | `properties` | Object | This indicates the page specific properties. | Below is an example showing how to capture user viewing a Product page: ```js Code theme={null} zeotap.setPageProperties({name: 'Product'}) ``` This example creates the following payload: ```json Code theme={null} { "event": { "eventName": "pageView", "eventTimestamp": 1584350000 }, "page": { "name": "Product Page", "url": "https://www.xyz.com/products", "path": "/products" }, "User": { "zi": "user_123", "zs": "session_123" } } ``` #### AMP Event Tracking Use the `setEventProperties` method to track different user actions on the website (for example, the selectVariant event with colour as a property) and properties relating to the event (for example, a viewCart event with cartVal as a property). | **Parameter** | **Type** | **Description** | | - | - | - | | `eventName` | String | This is the name of the event. | | `eventProperties` | Object | This is the object containing any properties for a particular event. | Below is an example showing how to track a product being viewed, which can be triggered on the view product event. ```js Code theme={null} zeotap.setEventProperties('view product', {productID: '1234'}); ``` This example creates the following payload: ```js Code theme={null} { "event":{ "eventName":"viewProduct", "productID":"prod_123", "eventTimestamp":1584350000 }, "page":{ "url":"https://www.xyz.com/products/?pid=prod_123", "path":"/products/?pid=prod_123" }, "User":{ "zi":"user_123", "zs":"session_123" } } ``` #### AMP Consent Tracking For information on consent tracking capabilities within AMP, refer [here](/articles/integrate-customer/implementing-web-js-source-2744942595#h3_2122337531). ## Best Practices This section describes the best practices and recommendations that must be considered when using Web JS Source. ### Appropriate Consent Configurations ### TCF Consent If your website has a TCF API on the page, then the consent resolution mechanism must be TCF and not the default `Optin`. This helps the Zeotap SDK to also capture the `gdpr_consent` string. In some cases, you may set up a default consent resolution mechanism and invoke the Zeotap JavaScript only if the user performs any action on the CMP. However, note that we do not recommend this step. Even when you invoke the SDK with the TCF Consent Configurations, the JS communicates with the TCF API on the page and only then the JS collects/captures the events. Otherwise, the JS just sits idle. We recommend the following SDK configurations for the above scenario: ```js Code theme={null} { useConsent: true, checkForCMP: true } ``` ### Custom Consent If you are setting up a Custom Consent collection on your website, ensure that you also choose the same in the SDK configurations. This is required in order to collect granular consent from the website. The SDK primarily performs the following three main tasks: * Capture user events * Identify user * CookieSync With the custom consent resolution mechanism, you can provide granular consent instead of a blanket boolean `(yes/no)` for all SDK purposes. We recommend the following SDK configurations for the above scenario: ```js Code theme={null} { useConsent: true, checkForCMP: false } ``` After you have set up the SDK configurations, you can invoke the setConsent method as mentioned below. ```js theme={null} window.zeotap.setConsent({ track: true, cookieSync: true }) ``` ### Capturing User Identities With Collect SDK, you can collect User Identities (PIIs like email and cellphone number along with Custom Identities). The identities collected are then persisted across all the upcoming event-capturing calls. To persist user identities across the event payloads, invoke the `setUserIdentities` method and not the `setUserProperties` method. In order to persist user identities, you can use the `setUserIdentities` method as follows: #### Case 1: Incoming identities are raw and can be sent to Zeotap CDP as is SDK Configurations: ```js Code theme={null} { areIdentitiesHashed: false, hashIdentities: false } setUserIdentities method: window.zeotap.setUserIdentities({ email: 'xyz@gmail.com', // User PII crmID: '12345' // Custom Identity }) ``` #### Case 2: Incoming identities are raw and need be sent to Zeotap CDP after hashing SDK Configurations: ```js Code theme={null} { areIdentitiesHashed: false, hashIdentities: true } setUserIdentities method: window.zeotap.setUserIdentities({ email: 'xyz@gmail.com', // User PII, will be hashed crmID: '12345' // Custom Identity, consumed as is }) ``` #### Case 3: Incoming identities are hashed SDK Configurations: ```js Code theme={null} { areIdentitiesHashed: true } setUserIdentities method: window.zeotap.setUserIdentities({ email_sha256_lowercase: '32e19a491662fd86de7d3806b1199b76f0ee44e928d3475f05b0c8a59912c097', crmID: '12345' // Custom Identity, consumed as is }) ``` ### Google Analytics Settings With the Collect SDK, you can provision optional capturing of the GA client Id and user Id cookies for retargeting purposes on platforms like Optimize 360. To allow the SDK to capture the GA cookies, add the following configurations to the `window.zeotap.init(WRITE_KEY, { .... })` call: ```js Code theme={null} { //If set to false , Google Analytics ClientId will not be forwarded in POST calls allowGAClientId: true, // cookie prefix for Google Analytics Client ID, if set with , GA Client Id cookie fetch with name as '_ga' gaClientIdCookiePrefix: 'client', // cookie name for Google Analytics User ID, if set with , GA User Id cookie fetch with name as 'value' gaUserIdCookieName: 'user_ga' } ``` ### Contextual Information Zeotap records additional information relating to an event triggered or a page being loaded and then supplements details to the data point being captured. The following are the contextual information that Zeotap captured: * IPAddress-derived – IPCountry, WiFi/Cellular, Operator/Carrier * UserAgent-derived – deviceOS, device model, device manufacturer, device type, browser type * pageURL-derived – URL, domain, path # InfoSum Audience Source: https://docs.zeotap.com/articles/integrate-customer/infosum-audience Send audiences from Zeotap CDP to InfoSum as CSV files delivered to your Google Cloud Storage bucket. ## What this is The InfoSum - Audience destination sends data **out of Zeotap CDP to InfoSum**: Zeotap CDP writes your audience to your own Google Cloud Storage bucket as a CSV file, and InfoSum reads that bucket through its Google Cloud Storage connector. InfoSum is listed in the [integrations master list](/articles/integrations-master-list-publication/integrations-master-list) as a destination only, so there is no opposite-direction InfoSum source page to pair with this one. InfoSum is a data collaboration platform that allows companies to gain insights from their combined customer data without ever sharing or moving it. Each company uploads its data to a private, secure "data bunker" where it remains under their control. The platform then uses privacy-enhancing techniques to match identifiers between these bunkers. This provides aggregated statistical insights, like audience overlap, while ensuring that the underlying raw customer data is never exposed to other parties. Because delivery happens through Google Cloud Storage, this destination is configured with the same bucket, folder and account details as the [Google Cloud Storage destination](/articles/integrate-customer/google-cloud-storage). ## Supported identifiers and actions This integration supports email addresses (raw and SHA-256), phone numbers (raw E.164 format), mobile IDs (AAID/IDFA), postal codes (Zip5/Zip9), cookie IDs, and IP addresses (IPv4/IPv6). One action is available: **Send CSV File to Infosum**. ## Prerequisites Before you create an InfoSum destination in Zeotap CDP, you must have the following: 1. A Google Cloud Storage account. 2. A PGP encryption public key from InfoSum, used to encrypt your files. For more information, refer to [PGP encryption in InfoSum](https://support.infosum.com/hc/en-us/articles/21619934375186-Importing-Files-with-GPG-Encryption#h_01J8QBVJTVVQVWK9JYQ1771TVJ). ## Set up the Google Cloud Storage connector in InfoSum Configure Google Cloud Storage in InfoSum with the following details: 1. Bucket name 2. File name 3. Service account key You must also provide read access to InfoSum. For more information, refer to the [InfoSum support documentation](https://support.infosum.com/hc/en-us/articles/9871008162577-Defining-a-Google-Cloud-Storage-ICC-connector). ## Google Cloud Storage details you need Collect the details about the following components of your Google Cloud Storage account before you create the destination. ### Bucket This is the name of your Google Cloud Storage bucket. You can obtain this information from your Google Cloud Storage account as shown in the image below. ![Google Cloud Storage bucket details page, with the bucket name highlighted at the top of the page.](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/gcs_bucket.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=27a98eddfc923035a9733033c5c0fc10) ### Folder In Google Cloud Storage, a folder serves as a logical container for organising stored objects within a bucket. In reality, there are no actual folders in Google Cloud Storage. Instead, the folder concept is emulated by employing object key names containing slashes ("/") to replicate a hierarchical arrangement. You can obtain this information from your Google Cloud Storage account as shown in the image below. ![Google Cloud Storage bucket details page, with a folder name highlighted in the object browser breadcrumb.](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/gcs_folder.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=ee827f65a647fe9656d55c7b3a13717c) ### Account This is the Zeotap service account that is used to access the Google Cloud Storage account. Ensure that you whitelist the Zeotap service account to successfully push audiences (segments) from Zeotap CDP to Google Cloud Storage. ## Create the InfoSum - Audience destination Perform the following steps to create a destination for InfoSum Audience: **Step 1** Log into the Zeotap CDP App and go to the **DESTINATIONS** application. **Step 2** Click **+ Create Destination**. ![The Destinations listing in Zeotap CDP, with the Create Destination button highlighted in the top right.](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/ADOBE_DMP_3_\(1\).png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=562fa59a1a1e2b76442fa98f6e6f991e) **Step 3** Under the **All Destinations** section, search for **Infosum - Audience**. ![The All Destinations catalogue, with the destination search box highlighted above the grid of destination tiles.](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/ADOBE_DMP_4_\(1\).png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=653728565c7ed5863548171765d4086f) **Step 4** Click **Infosum - Audience**. A screen appears displaying details about the particular destination towards the left. On the right-hand side of the screen find a list of fields that are required for the integration to be established. Provide the required details as mentioned in the following steps: a. Enter a name for the destination. b. In the **Destination Instance Name** field, provide a desired value. c. In the **Bucket** field, provide the name of the Google Cloud Storage bucket. d. In the **Folder** field, provide the folder path in your storage location where Zeotap CDP can store your exported data. > [!NOTE] > > **Note:** > > Ensure to follow the below points while providing the folder path: > > * The folder path should follow the below structure: > * folder_name/sub_folder_name/ > * The folder name should not start with a / > * The folder name and sub-folder name should end with a / e. Under **Filename Prefix**, enter a text value without special characters, such as underscores (\_), spaces, or symbols (`#, @, $, %, &, \*`). Note that the file name follows the format: `${filenamePrefix}part-${sequence}_${destinationAudienceId}_${timestamp}.csv`, where the timestamp is the file generation time in epoch milliseconds (UTC) and destinationAudienceId is the ID associated with your audience (segment) in Zeotap CDP, which is generated by the Zeotap CDP after the audience (segment) is linked to a destination. ![A destination's summary row, with the Channel ID value highlighted beside the Last Upload and ID fields.](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/integrate-customer/amazon-s3-destination/amazon-s3-destination-2025-08-06-1.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=9815ce4ace2add60e912e2a98028d8d4) | Variable | Description | | - | - | | `filenamePrefix` | The prefix for the file name, typically indicating the context or purpose of the file (e.g., the segment or export type). | | `part-${sequence}` | A sequential number or identifier indicating the part or chunk number if the data is split across multiple files. | | `${destinationAudienceId}` | The unique ID assigned by Zeotap CDP to the audience (segment) after it is linked to a destination. | | `${timestamp}` | The time the file was generated, in epoch milliseconds (UTC) — for example, `1722931200000`. | | `.csv` | The file extension, indicating that the file is in CSV (Comma-Separated Values) format. | **Example file name:** `exportpart-0_894548842_1722931200000.csv` f. Under **Account**, choose either **Zeotap Service Account** or **Client Service Account Json** using the drop-down menu based on the type of authentication you need. ![The Account drop-down open, showing the Zeotap Service Account and Client Service Account Json options.](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/google-cloud-storage-2024-05-08.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=4035a760431f47f9e2282dd46a2e57d4) i. If you choose **Zeotap Service Account** as the account, then ensure that you whitelist the service account provided by Zeotap CDP to push the audiences (segments) from Zeotap CDP to Google Cloud Storage. This service account information auto-populates under **Service Account to be Whitelisted** as shown in the image below. ![The Account field set to Zeotap Service Account, with the read-only Service Account to be Whitelisted field displayed beneath it.](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/google-cloud-storage-2024-05-08-1.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=80b9f59a37bb2c7b8b83268ea131378a) ii. If you choose **Client Service Account Json** as the account, then you need to upload the JSON file with the required authentication information using the **+ Select File** option so that Zeotap CDP can push the audiences to Google Cloud Storage. ![The Account field set to Client Service Account Json, with the Upload Service Account file picker and its Select File button beneath it.](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/google-cloud-storage-2024-05-08-2.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=a5bc85536732956d054503de1b2bc797) g. Under **Send Encrypted Data**, choose whether you want to encrypt your data using the PGP ([Pretty Good Privacy](https://en.wikipedia.org/wiki/Pretty_Good_Privacy)) data transfer mechanism. If you choose **Yes**, then ensure that you upload the public key. For more information about PGP encryption, refer to [PGP encryption in destinations](/articles/integrate-customer/pgp-encryption-in-destinations). ![Send Encrypted Data set to Yes, with the Upload Public Key file picker and its Select File button beneath it.](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/google-cloud-storage-2025-01-31.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=ee987cfe15afd49be9f5838c54d02e95) h. Review all the values entered above and then click **Next** to proceed. ![The completed Enter Destination Details form, showing the Destination Name, Destination Instance Name, Bucket, Folder, Filename Prefix, Account and Send Encrypted Data fields filled in.](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/google-cloud-storage-2025-01-31-1.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=b3b208c5f008d170813b8ef6bed8f209) **Step 5** In the new screen that appears, choose the appropriate action and mapping as explained below. Under **Choose your Action**, select **Send CSV File to Infosum** as the action for activating your audience in Audiences. **Step 6** Click **+ Add Mapping Field** to select identifiers for InfoSum and map attributes from the **Catalogue**. ![The Mapping step of destination creation, with Send CSV File to Infosum chosen under Choose your Action and one Catalogue field mapped to a destination field under Map the Fields.](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/infosum-audience/infosum-audience-2025-09-12.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=f844138627d484a2de15270e070b7787) **Step 7** After finalising the attributes and identifiers to send, click **Create Destination**. The created destination gets listed in the Audiences application, where it can be linked to an audience. ## Link an audience to the destination For information about how to link an audience or segment to the created destination in the Audiences application, refer to [Activate your batch audiences](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > **Note:** > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience or a segment could be a specific group of customers who are over 18 years of age and who have performed an addToCart event within the last 30 days. ## Verify the delivery Confirm the delivery from both sides: 1. **In Zeotap CDP** — open the audience–destination pair and check that the latest run completed with a non-zero count. See [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). 2. **In your Google Cloud Storage bucket** — open the folder you configured on the destination and confirm that a CSV file has been written for the run, using the naming convention below. ### Identify the segment files in the bucket After an audience is linked to a destination, Zeotap CDP generates segment files in CSV format with the following naming convention: `{filenamePrefix}{fileNumber}_${channelId}_${timestamp}`.csv, where the timestamp is in epoch format. In case of multipart upload, the format is `{partNumber}_{filenamePrefix}{fileNumber}_${channelId}_${timestamp}`.csv where, * partNumber refers to the parts or segments of a multipart upload in Google Cloud Storage. Multipart uploads allow you to upload large files in multiple parts or chunks rather than uploading the entire file in one go. In the above naming convention, Part 0 refers to the first part of the multipart upload. * channelId is the ID associated with your audience (segment) in Zeotap CDP. This is generated by the Zeotap CDP after the audience (segment) is linked to a destination. You can obtain this information as shown in the image below. ![An audience's activation panel, with the Channel ID of the linked destination highlighted beside the Last Upload and ID fields.](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/google-cloud-storage-2024-05-08-3.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=ab92718b7e470b1333769c4f5a6b2eb6) * epochmilliTimestamp is the timestamp in epoch format. Let's understand this with an example. Suppose you create an audience segment called **PublicAbove18** with **Channel ID** `12345678`, a **filename prefix** `testprefix`, and a **file number** `98765`. The timestamp information in **epoch milliseconds** is `1625138600`. When this file is uploaded to Google Cloud Storage as the first part of the multipart upload, the file is named as follows: `Part0_testprefix98765_12345678_1625138600.csv` ## Troubleshoot the delivery Delivery errors that surface on the audience–destination pair, and what each one means, are documented in [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail). If no file reaches the bucket, re-check the settings that are specific to this integration: * **Folder path** — it must follow the `folder_name/sub_folder_name/` structure, must not start with a `/`, and both the folder and sub-folder names must end with a `/`. * **Filename prefix** — it must not contain special characters such as underscores (\_), spaces, or symbols (`#, @, $, %, &, \*`). * **Account** — if you selected **Zeotap Service Account**, the account shown in **Service Account to be Whitelisted** must be whitelisted on your bucket. If you selected **Client Service Account Json**, the uploaded JSON must be the service account key that Zeotap CDP uses to push files to that bucket. * **Encryption** — if **Send Encrypted Data** is set to **Yes**, a public key must be uploaded. See [PGP encryption in destinations](/articles/integrate-customer/pgp-encryption-in-destinations). * **InfoSum-side read access** — InfoSum's Google Cloud Storage connector must point at the same bucket and file, and must have read access to them. ## Next steps * [Explore the Google Cloud Storage destination →](/articles/integrate-customer/google-cloud-storage) * [Explore PGP encryption in destinations →](/articles/integrate-customer/pgp-encryption-in-destinations) * [Explore how destinations are configured and mapped →](/articles/integrate-customer/destinations#configure-a-destination) * [Explore the full integrations list →](/articles/integrations-master-list-publication/integrations-master-list) # Insider Source: https://docs.zeotap.com/articles/integrate-customer/insider Send audience attributes, identifiers and Journeys events out of Zeotap CDP to Insider, using an Insider API key and partner name. ## What this is The Insider destination sends data **out of Zeotap CDP to Insider**: the attributes and identifiers of a linked audience, and the events produced by workflows you build in Journeys. To bring data in the opposite direction, from Insider into Zeotap CDP, use the [Insider Webhook source](/articles/integrate-customer/insider-webhook). Insider is a customer experience (CX) platform that enables businesses to deliver personalised and data-driven interactions across multiple channels. The platform helps companies analyse customer behaviour, segment audiences, and automate marketing efforts to enhance engagement and conversions. With this destination you can: * Share audience data from Zeotap CDP to Insider for activation and targeting. * Forward events from Zeotap CDP to Insider. * Trigger automation using custom events sent from Zeotap CDP Journeys to Insider. * Send event properties and user attributes from workflows created in Zeotap CDP to Insider. Insider appears twice in Zeotap CDP, once in each direction. Use this table to confirm you are on the right page: | Integration | Direction | Runs from | | :- | :- | :- | | **Insider** (this page) | Zeotap CDP to Insider | Audiences and Journeys | | [Insider Webhook source](/articles/integrate-customer/insider-webhook) | Insider to Zeotap CDP | Sources | ## Supported identifiers and actions You can use this integration to send any identifiers such as Email, Phone number (E.164 format), UUID, Custom identifiers and other attributes of your choice. The destination offers two activation routes. Which one you use decides which action is available on the mapping screen: | Route | Runs from | Action | | :- | :- | :- | | Batched data activation | Audiences | Send Attributes and Identifiers | | Real-time activation | Journeys | One of the eight event actions listed below | The Journeys actions are: * Add to Cart Event * Cart Page View Event * Custom Event * Item Removed from Cart Event * Purchase Event * Send Homepage View Event * Send Listing View Event * Send Product Detail Page View Event ## Prerequisites Obtain the following from your InOne (Insider) account before you create the destination in Zeotap CDP: * **API key** — generated in InOne. See [Generate an Insider API key](#generate-an-insider-api-key) below. * **Partner name** — the partner name of your Insider platform. On the Zeotap CDP side you also need an audience to link (for the batch route) or a workflow in Journeys (for the real-time route), and a role that grants destination edit rights on the organisation that owns the destination. See [Destinations: prerequisites](/articles/integrate-customer/destinations#prerequisites). > [!WARNING] > > Insider shows the key once. Copy it before you close the dialog and store it in your own secrets manager — Insider does not let you re-access it afterwards, and a key you cannot retrieve has to be replaced with a new one. ## Generate an Insider API key Insider uses Basic Authentication, which requires a *username* and an *API key*. After setting up your InOne (Insider) account, generate a Unified Customer Database (UCD) API key to push data using the Insider Upsert API. Perform the following steps in Insider to generate the API key: **Step 1** Log in to InOne. **Step 2** Navigate to **Username** > **Settings** > **InOne Settings** > **Integration Settings** as shown below. ![Insider Settings screen, with the account menu opened to Settings and Inone Settings, and the Integration Settings tab selected on the Settings page](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/insider/insider-2025-03-04-6.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=0c501dc0962c28a42fee800ab68959ec) **Step 3** Scroll to the **API Keys** section and click **Generate API Key**. If you have existing API keys, they appear in this section. ![The API KEYS section of Insider Integration Settings, with the Generate API Key button highlighted](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/insider/insider-2025-03-04-1.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=2ae90a02fc39743b96fcfd023dc02a06) **Step 4** Select the API type to generate the key and click **Next** to create the key. ![Insider Create API Key dialog, listing the available API key types with Cancel and Next buttons](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/insider/insider-2025-03-04-2.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=991ab94df92c7d59b7b4d6ed4487d67a) **Step 5** Click **Copy** to save the key before closing the prompt. **You cannot access the key after closing the window, so copy and store it securely.** ![Insider API Key Created dialog, with a copy control and a warning that the key cannot be re-accessed on the Insider platform once the dialog is closed](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/insider/insider-2025-03-04-3.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=25a23df40428e022559cd313b33c7685) ### Delete an Insider API key To delete an existing API key, click **Delete** next to the key in the **API Keys** section. ## Create the Insider destination Perform the following steps to create the destination in Zeotap CDP: **Step 1** Log into the Zeotap CDP App and go to the **DESTINATIONS** application. **Step 2** Click **+ Create Destination**. **Step 3** Under **All Destinations**, search for **Insider**. **Step 4** Click **Insider**. A screen appears displaying details about the destination on the left and the required integration fields on the right. Enter the following details: * **Destination Name**: Enter a name for the destination. * **Destination Instance Name**: Provide a desired value for this internal field. * **API Key**: Enter the API key generated in Insider. * **Partner Name**: Enter your Insider partner name obtained from your Insider account. ![Enter Destination Details screen for Insider in the Zeotap CDP App, showing the Destination Name, Destination Instance Name, API Key and Partner Name fields, with the API key value masked](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/insider/insider-2025-03-04-4.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=24b5a358fd09f3fd961e9edbe88a7469) > [!NOTE] > > To open the help documentation for this integration from inside the app, click **Integration Guide** under **Related Links**. **Step 5** Click **Next** to proceed to mapping. ## Choose the action and map the fields On the **Actions and Mapping** screen, choose the action depending on whether you want to use **Audiences (batched data activation)** or **Journeys (real-time activation)**, depending on your use case. For how mappings work in general, see [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). ### Audiences (batched data) Supported action: **Send Attributes and Identifiers** Under **Map the Fields**, map Catalogue fields and Destination fields for audience attributes and identifiers. Required fields: * **User Identifiers**: Email, Phone number, UUID * **User Attributes**: Name, Age, Gender, Language, City, Country, Custom attributes ### Journeys (real-time activation) Supported actions: the eight event actions listed under [Supported identifiers and actions](#supported-identifiers-and-actions). Under **Map the Fields**, for each Journey action, the system populates a list of identifiers and attributes. Ensure to map Catalogue fields and Destination fields appropriately. Required fields: * You must mandatorily map the **Event Name** and **Timestamp** fields for all events. * Map additional event parameters based on the event type you wish to target. ![Event Property mapping rows on the Actions and Mapping screen, each pairing a Choose Catalogue Attribute drop-down with a mandatory destination field — Event Name and Timestamp](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/insider/insider-2025-03-04-5.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=9b78d44613cab75e5419e9d177e35035) When the mapping is complete, click **Create Destination**. The destination is then listed in the **Audiences** application and can be linked to an audience. ## Link an audience to the destination For the batch route, link an audience to the created destination in the **Audiences** application. See [Link an Audience to the Destination](/articles/integrate-customer/link-an-audience-to-the-destination). For the real-time route, attach the destination to a workflow in Journeys by adding a **Send to Destinations** node at the point in the workflow where the event should be sent. See [Add or Delete a Node](/articles/orchestrate-customer/add-or-delete-a-node). ## Verify the activation worked Check both sides of the delivery. **In Zeotap CDP** — confirm the audience–destination pair recorded a completed run with a non-zero qualified count, or, for the real-time route, that the workflow reached the **Send to Destinations** node. See [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). **In Insider** — the destination writes through the Insider Upsert API into the Unified Customer Database (UCD), so confirm the records and attributes you sent are present there. ## Troubleshoot the Insider destination | Symptom | What to check | | :- | :- | | You no longer have the API key value | Insider does not allow a key to be re-accessed after its dialog is closed. Generate a new key and enter it on the destination. | | A Journeys delivery is rejected for a missing mandatory field | That **Event Name** and **Timestamp** are mapped for the action — both are mandatory for every event. | ### You no longer have the API key value 1. In InOne, go to **Username** > **Settings** > **InOne Settings** > **Integration Settings** and generate a new API key, following [Generate an Insider API key](#generate-an-insider-api-key). 2. Copy the new key before you close the dialog. 3. Enter the new key in the **API Key** field of the Insider destination in the Zeotap CDP App. 4. Delete the key you can no longer use, using the **Delete** control next to it in the **API Keys** section. ### A Journeys delivery is rejected for a missing mandatory field 1. Open the destination's mapping for the action the workflow uses. 2. Confirm a Catalogue attribute is mapped to **Event Name** and to **Timestamp**. Both are mandatory for every event action, and a delivery that omits a field the platform requires is rejected — see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail). 3. Map any additional event parameters the event type needs, then re-run the activation. ### When to escalate If the symptom is not covered above, or the delivery records an error in Zeotap CDP, see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail) and [When to contact support](/articles/integrate-customer/destinations#when-to-contact-support) for the error strings that surface on an audience–destination pair and the details to include in a support request. ## Next steps > [card] [Link an Audience to the Destination](/articles/integrate-customer/link-an-audience-to-the-destination) > > Activate a batch audience against the destination you just created. > [card] [Add or Delete a Node](/articles/orchestrate-customer/add-or-delete-a-node) > > Add a Send to Destinations node so a Journeys workflow can deliver events. > [card] [Insider Webhook source](/articles/integrate-customer/insider-webhook) > > Bring Insider events into Zeotap CDP in the opposite direction. > [card] [Destinations](/articles/integrate-customer/destinations) > > How destinations, actions and mappings work across every platform. # Insider Webhook Source Source: https://docs.zeotap.com/articles/integrate-customer/insider-webhook Stream the Insider events you select into Zeotap CDP over a webhook, in real time. The Insider Webhook source brings data **into Zeotap CDP**: Insider posts the events you select — pageviews, user actions, email, push, WhatsApp and SMS events — to Zeotap over a webhook as they happen. To send data in the opposite direction, out of Zeotap CDP to Insider, use the [Insider destination](/articles/integrate-customer/insider). ## What this is Insider is a customer experience (CX) platform that enables businesses to deliver personalised, data-driven interactions across multiple channels. It helps companies analyse customer behaviour, segment audiences and automate marketing efforts to improve engagement and conversions. This source captures the behaviour Insider already observes — what a user viewed, added to a cart, opened or clicked — and streams it into Zeotap CDP, where it joins the rest of your first-party data. In the Zeotap CDP App it sits under the **Customer Engagement Channels** source category, alongside the other engagement platforms listed on [Customer Engagement Channels](/articles/integrate-customer/customer-engagement-channels), and it is a real-time integration: events arrive as Insider sends them rather than in a scheduled batch. Insider and Zeotap CDP each use the word *destination* for their own outbound side, so the direction is easy to misread. Use this table to confirm you are on the right page: | Page | Direction | What it does | | :- | :- | :- | | Insider Webhook source (this page) | Insider → Zeotap CDP | Posts the Insider events you select to Zeotap over a webhook as they occur | | [Insider destination](/articles/integrate-customer/insider) | Zeotap CDP → Insider | Sends the attributes and identifiers of a linked audience, and events from Journeys workflows, to Insider | > [!NOTE] > > When you build the webhook in Insider, you select **Destination** as the **Integration Type**. That setting describes the direction from Insider's point of view — Zeotap is the destination Insider posts to — and is what makes this a *source* in Zeotap CDP. ## Supported events and attributes Insider sends its default events. You choose which of them to forward when you configure the webhook, using the **Events** and **Attributes** tabs in Insider. The default events are grouped as: * **Pageview events** — homepage, listing page, product detail page, cart page, purchase and other pageviews. * **User events** — cart cleared, item added to cart, item removed from cart, signup completed and lead collected. * **Mobile app events** — in-app seen, push delivered, mobile social proof seen, app push opened, mobile app opened and survey result. * **Email events** — delivered, open, click, bounce, block, spam report, unsubscribe and resubscribe, including the group variants. * **Architect events** — journey enter, journey exit and journey product action. * **Web push events** — view and click. * **WhatsApp events** — click, delivered, read, unsubscribe and the reply variants. * **SMS events** — click, delivered, subscribe, unsubscribe, undelivered, reply and drop. For the full list of events in each group, see [Implement an Insider Source](/articles/integrate-customer/implement-an-insider-source). Alongside the events themselves you can attach: * **Event parameters**, added per event with **+ Add Condition**, so only events matching those conditions are sent. * **Additional attributes**, chosen from a drop-down. For example, sending the email address with an *email opened* event lets you tell which address opened a given campaign. * **A segment filter**, applied in the **Segmentation** step, so data is sent only for users who both perform the selected event and fall inside the segment you pick in Insider. Which fields actually reach Zeotap CDP therefore depends on the events, parameters and attributes you select in Insider. Once data is flowing, confirm what arrived on the source's **PREVIEW DATA** tab before you map it. ## Prerequisites * Access to the **Sources** application under **Integrate** in the Zeotap CDP App, with permission to create a source. * An Insider account with access to **External Integrations** under **Integrations** in the left panel, and permission to create and launch a webhook integration there. * The **API URL** and **Write Key** that Zeotap CDP generates when the source is created. The API URL establishes the connection between Insider and Zeotap; the write key authenticates the data Insider sends. Both appear on the source's **IMPLEMENTATION DETAILS** tab. The authentication for this source runs from Insider to Zeotap, not the other way round: Insider authenticates with the write key Zeotap issues, so you do not need an Insider API key or partner name here. Those are asked for by the [Insider destination](/articles/integrate-customer/insider). Treat the write key as a secret — copy it straight from the **IMPLEMENTATION DETAILS** tab into the Insider webhook rather than pasting it into a ticket, an email or a shared document. ## Create the Insider Webhook source Setting this source up takes two stages, one on each side of the integration. Each stage has its own page. **1. Create the source in Zeotap CDP** Create the source under **Sources**, choosing **Customer Engagement Channels** as the category and **Insider Webhook** as the data source, then enter a name and select a **Region**. On successful creation, an **API URL** and a **write_key** are generated and appear under the source's **IMPLEMENTATION DETAILS** tab. Both are needed for the next stage. See [Create an Insider Source](/articles/integrate-customer/create-an-insider-source). **2. Configure the webhook in Insider** In Insider, go to **Integrations** > **External Integrations**, find **Webhook**, name the integration and set **Integration Type** to **Destination**. Choose the events, event parameters, additional attributes and any segment filter you want to send. On the **Configuration** screen, enter the API URL as the **Endpoint** with the method set to POST, add an **Authorization** header carrying the write key with the `Bearer` prefix, enable the body and transform the payload into the structure Zeotap CDP expects. Then launch the integration. See [Implement an Insider Source](/articles/integrate-customer/implement-an-insider-source). ## Verify the source is receiving data Check both sides of the integration. **In Insider**, before going live, use **Test Webhook**. Insider generates random values for the dynamic fields and sends a test request; the response status and the request details appear in the side panel. Activate the integration once the test returns a successful HTTP response. A webhook left in **Draft** or **Paused** at the **Launch** step sends nothing. **In Zeotap CDP**, open the source from the **SOURCES** listing page and check its status: * **Created** — the source exists but has not received any data yet. If it stays here, confirm that the Insider webhook is launched in the **Active** state, and that its endpoint and Authorization header match the API URL and write key on the **IMPLEMENTATION DETAILS** tab. * **Integrated** — data has started arriving. You can now preview the incoming records on the source's **PREVIEW DATA** tab. For what each status means, see [Components of the Source Listing Page](/articles/integrate-customer/components-of-the-source-listing-page); for how to read the sample, see [Components of the Preview Data Tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab). ## Next steps > [card] [Create an Insider Source](/articles/integrate-customer/create-an-insider-source) > > Create the source in Zeotap CDP and collect the API URL and write key. > [card] [Implement an Insider Source](/articles/integrate-customer/implement-an-insider-source) > > Configure the webhook in Insider, choose the events and test it before launch. > [card] [Insider destination](/articles/integrate-customer/insider) > > Send an audience or Journeys events from Zeotap CDP out to Insider. > [card] [Customer Engagement Channels](/articles/integrate-customer/customer-engagement-channels) > > The other engagement platforms you can bring data into Zeotap CDP from. # Integrate Source: https://docs.zeotap.com/articles/integrate-customer/integrate Integrate brings customer data from every source into Zeotap CDP and forwards enriched, unified audiences to your marketing, advertising, and analytics destinations. ## What Integrate is Integrate is the Zeotap CDP module that connects your customer data end to end. It has two sub-modules: [Sources](/articles/integrate-customer/sources), which brings data in from your websites, apps, files, warehouses, CRMs, and engagement platforms, and [Destinations](/articles/integrate-customer/destinations), which forwards audiences and profile updates to external platforms such as DSPs, DMPs, ad networks, and messaging tools. Everything else in the CDP — unification, calculated attributes, audience building, and activation — builds on the pipeline you set up here. Treat Integrate as a seven-stage pipeline: create a source, implement it, confirm data arrival, map fields to the catalogue, derive calculated attributes, build audiences, and activate them on destinations. Skipping a stage breaks the stages that follow. ## Prerequisites > [!NOTE] > > Before you configure Integrate, complete the steps in the [Get Started Guide](/articles/get-started-guide/getting-started) [Before you Begin](/articles/get-started-guide/prerequisites) section, and confirm that your role includes permission to view and create Sources and Destinations. See [User Roles and Access](/articles/admin-customer/user-roles-and-access) for the built-in roles that carry these permissions. Have the following ready before you begin: * A prioritised list of use cases, sources, and destinations for your rollout — see [Discovery](/articles/get-started-guide/discovery). * Your data model: the exact fields you plan to send from each source. * Credentials for each destination platform (client IDs, API keys, service accounts, or SFTP details, depending on the destination). * An identifier strategy — the identifiers you send (email, phone, mobile advertising ID, customer ID) determine what you can activate downstream, and drive the match rate you get on advertising destinations. * A delta-load plan — send only new or changed records per run rather than full-file resends, to keep ingestion costs and duplicate-update noise down. ## Set up your data flow Work through the seven stages in order for each new source. Each stage produces an artefact the next stage consumes. ### 1. Create the source Open the Sources module and create a new source, choosing the source category and source type that match how the data arrives. Zeotap CDP supports website events, app events (Android and iOS SDKs), flat files (Google Cloud Storage, SFTP), server-to-server (HTTP API), tag managers (Adobe Experience Platform, Google Tag Manager), CRM data (Salesforce), data warehouses (Snowflake, BigQuery, Amazon S3), customer engagement channels (Braze Currents, Batch, Dotdigital, HubSpot, Airship, Cleverpush), and message queues (Pub/Sub Stream and Batch). See [Creating a Source](/articles/integrate-customer/creating-a-source) for the full list and per-type setup. ### 2. Implement the source Each source type ships with a per-type implementation guide describing exactly how to send data — a JavaScript snippet for websites, an SDK for mobile apps, a file layout for flat files, credentials and a query for data warehouses. Download this guide from the source's detail page and follow it end to end. The source remains in its initial pre-ingestion state until it begins receiving records. ![Implementation Details tab on the source detail page, where the implementation guide is downloaded](https://mintcdn.com/zeotap/49y1_9uVgJhUhPeD/articles/integrate-customer/Storage/integrate-customer/integrate/integrate-2023-10-05-7.png?fit=max\&auto=format\&n=49y1_9uVgJhUhPeD\&q=85\&s=756671a157b7b80358a3909cbcb85a09) ### 3. Confirm data is arriving Return to the source's detail page and open the incoming-data view. Verify the record volume, sample records, and field names match what you sent. Once records begin flowing, the source advances past its initial state and becomes eligible for catalogue mapping. ![Preview Data tab showing records received by the source](https://mintcdn.com/zeotap/49y1_9uVgJhUhPeD/articles/integrate-customer/Storage/integrate-customer/integrate/integrate-2023-10-05-5.png?fit=max\&auto=format\&n=49y1_9uVgJhUhPeD\&q=85\&s=176ef2f739e508dcd3ae13b4fc61ffea) ### 4. Map fields to the catalogue Standardise incoming field names against the Zeotap catalogue so identifiers, traits, consent flags, and events resolve into unified profiles. Open the source's mapping tool and align each ingested field with its catalogue counterpart — see [Map the Catalogue](/articles/unify-customer/map-the-catalogue) for the mapping mechanics and the supported field types. A source that has not been mapped will not resolve into profiles and cannot be used in an audience. ![Catalogue mapping view with the Map to Catalogue action](https://mintcdn.com/zeotap/49y1_9uVgJhUhPeD/articles/integrate-customer/Storage/integrate-customer/integrate/integrate-2023-10-05-4.png?fit=max\&auto=format\&n=49y1_9uVgJhUhPeD\&q=85\&s=0bb3d08cb081e68beab90be949885638) ### 5. Build calculated attributes (optional) Derive user-level insights by aggregating events over a defined window — for example, a running 90-day revenue total, a 7-day page-view count, or units purchased in a category. Use these as segmentation criteria: a marketer can define `High Spenders` as users with `90_day_revenue > 500` or `Low Engagement Users` as users with `1_week_page_views < 5`. See [Calculated Attributes](/articles/unify-customer/calculated-attributes) for the aggregation options and refresh cadence. ![Calculated attribute configuration in the Unify module](https://mintcdn.com/zeotap/wwl-XxoFg7U2kGQg/articles/integrate-customer/Storage/integrate-customer/project-unify/unify/unify-5.png?fit=max\&auto=format\&n=wwl-XxoFg7U2kGQg\&q=85\&s=ad78b0f8d910040528f1adbf8ba4116e) ### 6. Create an audience Combine catalogue fields, calculated attributes, and consent flags to define a customer cohort. See [Create your Audience](/articles/get-started-guide/create-your-audience) for the criteria types available and how to combine them. ### 7. Activate on a destination Link the audience to a destination in the Destinations module and configure the mapping between catalogue identifiers and the destination's expected payload fields. See [Activate your Audience](/articles/segment-customer/activate-your-audience) for the activation flow. ![Activating an audience on a destination](https://mintcdn.com/zeotap/49y1_9uVgJhUhPeD/articles/integrate-customer/Storage/integrate-customer/integrate/integrate-2023-10-05-3.png?fit=max\&auto=format\&n=49y1_9uVgJhUhPeD\&q=85\&s=746104e35f184002b47798ce6c5c0fc8) > [!WARNING] > > Destination mapping errors are where Integrate activations break. Field-name mismatches between your mapping output and the destination's expected payload cause the destination platform to reject records with a validation error — even when the upload from Zeotap side completes successfully. Validate the outbound payload against the destination's schema before activating at scale. Destinations that expect nested fields (for example `data.event_id`, `data.custom_data.value`) require the mapping output field name to match the flattened internal path the connector reads, not the visible alias in the UI. A sample outbound payload for an offline-conversion destination: ```json theme={null} { "data": [ { "event_name": "checkout", "event_id": "", "event_time": 1771545600, "action_source": "offline", "user_data": { "em": [""] }, "custom_data": { "currency": "EUR", "value": "189.94" } } ] } ``` If the destination rejects the payload with a `required property` error, the mapping is producing a field name the connector cannot find at the expected path. ## Verify the pipeline works Confirm each stage before moving to the next: * **Source ingestion:** the source detail page shows a non-zero record count and the source status has advanced from its initial state. * **Catalogue mapping:** mapped fields resolve to their catalogue counterparts, and the source becomes selectable when you build an audience. * **Audience qualification:** the audience estimate returns a non-zero user count that aligns with your expectations for the criteria you defined. * **Destination activation:** the destination's activity view shows the upload completed, and the destination platform reports receipt of the expected event or record volume. To verify end-to-end delivery: create a small test audience (for example, users carrying a single test identifier), activate it to the destination, and confirm the destination platform receives the records within its documented delivery window. ## Troubleshoot common integration issues Integrate issues surface in one of three places: the source is not receiving data, the destination rejects the outbound payload, or the destination accepts the upload but the customer sees fewer records than expected. Identify which stage is failing, then match the observed error to the table below. | Error string | What it means | Where to look | | - | - | - | | `Invalid request: event_id is a required property, event_time is a required property` | The outbound destination payload is missing a mandatory field. The mapping output field names do not match the flattened internal path the destination connector reads. | The destination's mapping configuration and a sample outbound payload from the destination activity view | | `unresolvable property or identifier` | The mapping expression references a field or channel that is no longer available — for example, a deprecated destination channel that has been superseded by a newer variant. | The destination's mapping expression and the destination channel's current status | | `HTTP 429` (rate limit exceeded) | The destination platform is throttling requests. Reduce batch cadence, adjust batch size, or request a higher rate limit from the destination platform. | The destination platform's API usage dashboard | | Upload triggered but no completion status recorded | The upload was queued but the worker has not written a `Started`, `Completed`, or `Failed` status. | The audience's destination activity view; if no status appears within the destination's documented processing window, contact support | | Upload completes on Zeotap side but the customer's downstream system does not receive the expected file | The destination configuration produces a file format, delivery path, or identifier type the customer's downstream flow does not consume. Common when a customer switches an audience from an ID-type action to an attribute-type action and expects the same custom backfile behaviour. | The destination configuration (file format, delivery path, action type) and the destination platform's ingestion logs | If the observed symptom does not match a row above, or if the fix in the "Where to look" column does not resolve the issue, contact your Zeotap customer success representative. Include the source ID or destination ID, the affected audience ID, the timestamp of the last successful run, and the exact error text from the destination activity log. ## FAQ > [accordion] Can I map fields for a source that has not received any data yet? > > No. Catalogue mapping requires the source to have moved past its initial state, which happens once records begin flowing. Confirm data arrival in the source's incoming-data view before opening the mapping tool. > [accordion] Do I need to send full data files every run, or only new records? > > Send only delta updates. Full-file resends waste ingestion capacity and produce duplicate profile updates. This applies to flat files, database configurations, and every batch source — see [Discovery](/articles/get-started-guide/discovery) for the source-onboarding checklist. > [accordion] Which identifiers should I send to get the best match rate on ad-platform destinations? > > Match rate depends on the identifier types the destination accepts and the identifiers you have collected. For advertising destinations, sending multiple identifier types together (for example, hashed email plus hashed phone plus mobile advertising ID) increases the share of users the destination can resolve. See the individual destination pages under [Destinations](/articles/integrate-customer/destinations) for each platform's supported identifiers. > [accordion] How do I control which teams can use a given source or destination? > > Use [Access Rules](/articles/admin-customer/access-rules) to restrict sources, attributes, or destinations at the folder level. Rules work on a blocklist basis — every source and destination remains available across all folders until an admin explicitly blocks it for a folder. Rules on a parent folder propagate to all subfolders. ## Next steps * [Explore Sources →](/articles/integrate-customer/sources) * [Explore Destinations →](/articles/integrate-customer/destinations) * [Explore Creating a Source →](/articles/integrate-customer/creating-a-source) * [Explore Access Rules →](/articles/admin-customer/access-rules) * [Explore Discovery →](/articles/get-started-guide/discovery) # Inxmail Source: https://docs.zeotap.com/articles/integrate-customer/inxmail Send journey events, recipient subscriptions, unsubscribes and recipient-attribute updates from Zeotap CDP to Inxmail in real time. ## What this is The Inxmail destination sends data **out of Zeotap CDP and into Inxmail** in real time, from a journey — Zeotap calls the Inxmail API on your behalf each time a customer reaches the destination node. Nothing flows back from Inxmail into Zeotap CDP. Two Inxmail APIs sit behind this destination: * The **Inxmail Commerce API** carries transactional, journey-based emails triggered by **events** (for example, a new order). * The **Inxmail Professional API** acts as a database of customer-level information. Recipient subscriptions to a list are sent through this API. In the destination catalogue this connector appears as **Inxmail API**. > [!NOTE] > > Zeotap also offers a separate batch connector for sending a whole audience to Inxmail. If you want Zeotap to create a mailing list and import recipients into it from an audience rather than from a journey, see [Inxmail Audience](/articles/integrate-customer/inxmail-audience). ## Supported identifiers and actions The [integrations master list](/articles/integrations-master-list-publication/integrations-master-list) records this destination as accepting any identifiers and attributes. The destination fields available to you depend on which action you choose — see [Choose an action and map the fields](#choose-an-action-and-map-the-fields). | Action | What it sends | | - | - | | **Trigger Events in Inxmail Commerce** | A mailing to one or more specified recipients, triggered by an event. | | **Add recipients to a list in Inxmail Professional** | Recipient subscriptions to an Inxmail list. | | **Unsubscribe recipients in Inxmail Professional** | An unsubscribe for the recipients you supply. | | **Update recipient attributes** | A change to a recipient's email address and to their recipient attributes. | ## Prerequisites Before you create the destination, have the following ready: * **Customer Name / Space ID** — retrieved from the Console and used in requests. For the Inxmail Professional REST API, enter the customer name as the space name. * **Key ID and Client Secret** — the authentication key pair, supplied as a username and password in the form `keyid:secret`. * **The event** — for the events trigger, the event must already exist in Inxmail before it can be passed in the request body. ## Get your Inxmail credentials Inxmail's REST APIs use [HTTP Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication). The key consists of a `keyid` and a `secret`, which are supplied as username and password; for the Inxmail Professional REST API the same pair is described as a client id and a secret, `clientid:secret`. Zeotap uses the values you enter on the destination to authenticate every call it makes to Inxmail — you do not build these requests yourself. The sibling [Inxmail Audience](/articles/integrate-customer/inxmail-audience) page documents this pair as being generated in the **OAuth-Clients** section of your Inxmail account, and notes that the secret is shown only once at creation. If you are unable to see your changes in the Inxmail dashboard, contact your Inxmail representative for the correct space name and credentials to use here. > [!NOTE] > > **[Preemptive Authentication](https://hc.apache.org/httpclient-3.x/authentication.html#Preemptive_Authentication) is required to use the Inxmail Commerce Administration API.** This is an Inxmail requirement for that API. The two APIs behind this destination are the Inxmail Commerce API and the Inxmail Professional API, and Zeotap authenticates those calls for you. ## Create the Inxmail destination **Step 1** Log in to the Zeotap CDP app and open **Integrate → Destinations**. **Step 2** Click **+ Create Destination**. ![The Integrate Destinations listing with the Private Destination tab selected and the Create Destination button in the top right](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-93.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=ece26a0844099d61f405027a8a2d6067) **Step 3** Under **All Destinations**, search for Inxmail. ![The All Destinations catalogue with the Search for a Destination box highlighted above the destination cards](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-94.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=008e27b872dd09faf615c4ec251634ec) ![The destination catalogue search filtered to Inxmail, showing the Inxmail API card](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-95.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=090879eb3d792dc3eb080eeedff5faae) **Step 4** Select the **Inxmail API** card. A screen appears with details about the destination on the left, and on the right the fields required to establish the integration. Fill them in: a. Enter a name for the destination. ![The Destination Details tab of the Inxmail destination, with the Destination Name, Key ID, Client Secret and Customer Name / Space ID fields](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-96.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=a600c865d4e005624044b5df2c887127) b. Enter the **Key ID**, **Client Secret** and **Customer Name / Space ID** of your Inxmail instance. c. Review the values you entered, then click **Next** to proceed. ## Choose an action and map the fields On the **Mapping** tab, under **Choose your Action**, pick the action you want this destination to perform, then map a catalogue attribute to each destination field. A red asterisk on a destination field marks it as required. For the full explanation of how mapping works across every destination, see [Configure a destination](/articles/integrate-customer/destinations#configure-a-destination) and [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). ### Trigger Events in Inxmail Commerce ![The Attributes group of the mapping screen, listing Transaction Id, Customer ID, Customer Email, Order ID and Order Date destination fields](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-97.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=635ad66c6f96524c024022c468e7a639) ![The Order Attributes group of the mapping screen, with an Items list of objects containing Sku, Name, Price and Currency](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-98.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=353a93a1f37ef440be7b21a2fb5925cf) | Group | Destination field | Type | Required | | - | - | - | - | | Attributes | Transaction Id | String | | | Attributes | Customer ID | String | | | Attributes | Customer Email | String | Yes | | Attributes | Order ID | Integer | | | Attributes | Order Date | String | | | Order Attributes | Items | List Of Object | | | Order Attributes | Items → Sku | String | | | Order Attributes | Items → Name | String | | | Order Attributes | Items → Price | Integer | | | Order Attributes | Items → Currency | String | | ### Add recipients to a list in Inxmail Professional ![The Map the Fields screen for sending recipients, with Email, Tracking Permission and Supplied Remote Address destination fields](https://mintcdn.com/zeotap/49y1_9uVgJhUhPeD/articles/integrate-customer/Storage/integrate-customer/integrate-customer/inxmail/inxmail-2025-11-20.png?fit=max\&auto=format\&n=49y1_9uVgJhUhPeD\&q=85\&s=107d343fb0440458c30d8c53d7711d67) | Destination field | Type | Required | | - | - | - | | Email | String | Yes | | Tracking Permission | String | | | Supplied Remote Address | String | | ### Unsubscribe recipients in Inxmail Professional ![The action selector reading Unsubscribe recipients in Inxmail Professional, above a Map the Fields screen with Email and Supplied Remote Address destination fields](https://mintcdn.com/zeotap/49y1_9uVgJhUhPeD/articles/integrate-customer/Storage/integrate-customer/integrate-customer/inxmail/inxmail-2025-11-20-1.png?fit=max\&auto=format\&n=49y1_9uVgJhUhPeD\&q=85\&s=f450299fcfdc3ceaccefa39c87472067) | Destination field | Type | Required | | - | - | - | | Email | String | Yes | | Supplied Remote Address | String | | ### Update recipient attributes ![The mapping screen for updating recipients, with an Identifiers group containing Current Recipient Email and New Recipient Email, and an empty Recipient Attributes group with an Add Mapping Field link](https://mintcdn.com/zeotap/49y1_9uVgJhUhPeD/articles/integrate-customer/Storage/integrate-customer/integrate-customer/inxmail/inxmail-2025-11-20-2.png?fit=max\&auto=format\&n=49y1_9uVgJhUhPeD\&q=85\&s=643bc11d9588362b512a2c9f635edd82) | Group | Destination field | Type | Required | | - | - | - | - | | Identifiers | Current Recipient Email | String | Yes | | Identifiers | New Recipient Email | String | | | Recipient Attributes | Add the recipient attributes you want to update with **+ Add Mapping Field** | | | When the mapping is complete, click **Create Destination**. The destination is then available in **Orchestrate**, ready to be linked to a journey. ## Link the destination to a journey The destination does nothing on its own — it runs when a customer reaches a **Send to Destinations** node in a journey. **Step 1** In the workflow, click **+** and choose **Send to Destinations**. ![The journey canvas action menu, with Send to Destinations highlighted below Add a Condition, Add a Delay, Create a Multi-branch Split and Create a True/False Split](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-99.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=2bb8dc4a9e4bddd579ee26beb6b18985) **Step 2** Find your Inxmail destination in the list of available destinations, using the search box. ![The Send to Destinations panel with the search box highlighted above the cards for existing destinations](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/image-100.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=3461db468e97479e820c28af404e83a3) **Step 3** The **Key ID**, **Client Secret** and **Customer Name / Space ID** fields are populated automatically from the values you entered when you created the destination. ![The Inxmail API node panel on the Destination Details tab, listing Destination Name, Key ID, Client Secret, Customer Name / Space ID, Event and Is New Customer ?](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-101.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=4a7046a8819fbce2f9086f82f565dbe6) **Step 4** Set the journey-level inputs your action requires — the event, the list id and the new-customer flag. > [!NOTE] > > Some journey-level inputs are not used by every action. For example, when you send an event to Inxmail Commerce the list id is not used; the reverse is true for an Inxmail Professional action. **Step 5** Click **Save Destination** to attach the node to the journey. ## Verify the events reached Inxmail Check both sides after the journey runs. **In Zeotap CDP** 1. Open the journey and check the execution counts on the Inxmail node — total events entered, successful events and failed events. See [Journey error codes](/articles/orchestrate-customer/journey-error-codes). 2. For a single customer, use [Journey Traces](/articles/orchestrate-customer/journey-traces) to inspect the input event that triggered the journey and the output event that was sent to the Inxmail node, and to confirm the customer qualified for the node at all. 3. If a node reports failures, open the **Execution Details** sidebar on that node for the failure status code, timestamp, destination name and request id. See [Identify journey errors](/articles/orchestrate-customer/identify-journey-errors). **In Inxmail** Open the mailing, list or recipient the action targeted and confirm the change is present. Counts on the two sides will not always match exactly, but both should be non-zero and of the same order of magnitude. ## Troubleshoot the Inxmail destination Before working through individual error codes, check whether the failure is global or isolated: if every customer fails at the node the cause is more likely authentication or mapping, whereas a small percentage points at consent or data quality. See [Troubleshooting workflows](/articles/orchestrate-customer/journey-troubleshooting). | What you see | Likely cause | What to do | | - | - | - | | The destination saves, but your changes do not appear in the Inxmail dashboard | The customer name entered is not the right space name | For the Inxmail Professional REST API the customer name must be the space name. Contact your Inxmail representative for the correct space name and credentials, then update the destination. | | `AUTHENTICATION_ERROR` on the Inxmail node | The Key ID or Client Secret on the destination is wrong or has been rotated in Inxmail | Update the credentials on the destination, then re-run. | | `BAD_REQUEST` or `EVENT_PARSING_FAILED` on the Inxmail node | A required destination field was left unmapped, or the mapped attribute does not match the expected type | Re-open the mapping and confirm every field marked with a red asterisk is mapped, and that the catalogue attribute matches the destination field's type. | | The events trigger fails for every customer | The event has not been created in Inxmail | The event must exist in Inxmail before it can be passed in the request body. Create it, then re-run. | | `CONSENT_NOT_PROVIDED` on the Inxmail node | The customers reaching the node do not carry the consent the destination requires | Check the consent attributes on the customers entering the journey, and the consent handling on the destination. | Every code in the table above is defined, with its severity and its full resolution steps, in [Journey error codes](/articles/orchestrate-customer/journey-error-codes). ## FAQ **What is the difference between this destination and Inxmail Audience?** This destination is a real-time integration that fires from a **Send to Destinations** node inside a journey. [Inxmail Audience](/articles/integrate-customer/inxmail-audience) is a batch integration that attaches to an audience, and it can create the mailing list in Inxmail for you. They appear as different cards in the destination catalogue: **Inxmail API** and **Inxmail Destinations**. **Can I apply a Gateway policy to this destination?** Yes. [Gateway](/articles/orchestrate-customer/gateway) lists **Inxmail API** among the destinations that trigger a message send, for the action *Trigger Events in Inxmail Commerce*, in the Email message category. ## Next steps * [Link the destination into a journey workflow →](/articles/orchestrate-customer/create-a-workflow) * [Debug a single customer's journey with Journey Traces →](/articles/orchestrate-customer/journey-traces) * [Look up a journey error code →](/articles/orchestrate-customer/journey-error-codes) * [Send a whole audience to Inxmail instead →](/articles/integrate-customer/inxmail-audience) * [Browse all supported sources and destinations →](/articles/integrations-master-list-publication/integrations-master-list) # Inxmail Audience Source: https://docs.zeotap.com/articles/integrate-customer/inxmail-audience Send a Zeotap CDP audience to Inxmail as mailing-list recipients, either into a list Zeotap creates for you or into a list that already exists in Inxmail. The Inxmail Audience destination sends data **out of Zeotap CDP and into Inxmail**: it loads the members of an audience into an Inxmail mailing list as recipients. It is a **batch** destination, so you link it to an **audience** rather than attaching it to a journey. To send event-triggered transactional emails from a journey instead, use the [Inxmail](/articles/integrate-customer/inxmail) destination. ## What this is Inxmail is an email marketing platform. This destination replaces the manual loop of exporting an audience and importing it into a mailing list by hand: you configure the connection once, map the recipient attributes you want Inxmail to hold, and link the destination to an audience. From then on, every activation of that audience loads its members into Inxmail as recipients. The destination covers two situations. Either Inxmail does not have a list yet, in which case Zeotap creates the mailing list and loads recipients into it, or the list already exists and Zeotap loads recipients into the list you point it at. ## Supported identifiers and actions Inxmail identifies each recipient by **email address**, so every audience member you send must resolve to one. Email is the only required field in the mapping. Everything else you map is a recipient attribute carried alongside it. | Action | When to use | What you provide | | - | - | - | | Create a list and Upload Recipients | No list exists in Inxmail yet. Zeotap creates the mailing list and loads the audience into it. | The list name, the sender and reply-to action inputs, plus the recipient attribute mapping. | | Upload Recipients to a List | The target list already exists in Inxmail. Zeotap loads the audience into that list. | The Inxmail list ID, plus the recipient attribute mapping. | > [!NOTE] > > The first activation of an audience sends the full qualifying set. Later activations send only the changes since the previous run. Editing the mapping resets this and triggers a full send again. ## Prerequisites **In Inxmail** * An active Inxmail account with API access enabled. * An OAuth client created in the **OAuth-Clients** section of your Inxmail account. Creating it gives you the two values Zeotap needs to authenticate: a client ID (Zeotap's form labels this the **Key ID**) and a client secret. * Your customer name, also referred to as the space ID. This is your Inxmail account identifier, visible in your Inxmail account settings. * A valid sender email address for the mailing list. * Any custom recipient attributes you intend to map, already created in Inxmail. Attribute names must match on both sides. * For **Upload Recipients to a List**: the target list, and its list ID. **In Zeotap CDP** * Access to the **Integrate** module with permission to create destinations. See [Destination access rules](/articles/integrate-customer/destination-access-rules). * An audience ready to activate. * A clear idea of which recipient attributes you want Inxmail to hold. ## Generate Inxmail API credentials **Step 1** Sign in to your **Inxmail** account. **Step 2** In the administration area, open the **OAuth-Clients** section. **Step 3** Create a new OAuth client. Give it a name that identifies it as the Zeotap connection so your team knows what it is used for. **Step 4** Inxmail displays the client ID and the client secret once the client is created. Copy both. > [!WARNING] > > The client secret is shown only once, at creation. Store it somewhere secure before you close the dialogue. If you lose it, create a new OAuth client and re-enter the new values in Zeotap. **Step 5** Note your customer name (space ID) from your Inxmail account settings. You should now have three values: the client ID, the client secret and the customer name. ## Create the Inxmail destination **Step 1** Sign in to the Zeotap CDP app and go to **Integrate > Destinations**. Click **+ Create Destination**. ![The Destinations listing in Zeotap CDP, with the Active Destinations and Archived Destinations tabs and the Create Destination button above the table of existing destinations.](https://mintcdn.com/zeotap/kl8L6sBUYwhq5T7t/articles/integrate-customer/Storage/integrate-customer/inxmail-audience/inxmail-audience-2026-03-31-1.jpeg?fit=max\&auto=format\&n=kl8L6sBUYwhq5T7t\&q=85\&s=64b7182ae939bb3e816f761ef172dccd) **Step 2** Under **All Destinations**, search for **Inxmail** and select the Inxmail card. ![The All Destinations catalogue with Inxm typed into the search box, returning a single connector card labelled Inxmail API.](https://mintcdn.com/zeotap/eqpJpcnyReLBRSSq/articles/integrate-customer/Storage/integrate-customer/inxmail-audience/inxmail-audience-2026-03-31-2.png?fit=max\&auto=format\&n=eqpJpcnyReLBRSSq\&q=85\&s=ea742b8076390de287b21a0db0904f39) > [!NOTE] > > The catalogue card is labelled **Inxmail API**. The same card is the entry point for the audience flow described on this page. **Step 3** On the **Enter Destination Details** step, fill in the four fields on the right: * **Destination Name** — a name that identifies this connection in Zeotap. * **Key ID** — the client ID you copied from Inxmail. * **Client Secret** — the client secret you copied from Inxmail. * **Customer Name / Space ID** — your Inxmail customer name. ![The Enter Destination Details step, with empty Destination Name, Key ID, Client Secret and Customer Name / Space ID fields, and the two-step Destination Details to Mapping progress indicator above.](https://mintcdn.com/zeotap/eqpJpcnyReLBRSSq/articles/integrate-customer/Storage/integrate-customer/inxmail-audience/inxmail-audience-2026-03-31-3.jpeg?fit=max\&auto=format\&n=eqpJpcnyReLBRSSq\&q=85\&s=67016e4b887f0b4cf567d1190268213a) Click **Next** to continue to the mapping. **Step 4** Choose the action — **Create a list and Upload Recipients** or **Upload Recipients to a List** — and define the mapping for it. If you chose **Upload Recipients to a List**, supply the list ID of the existing Inxmail list here. Under **Map the Fields**, pair each Zeotap catalogue attribute with the Inxmail destination field it should populate: * **Email** — required. Map the catalogue attribute that holds the recipient's email address. * **Tracking Permission** — optional. Inxmail reads the value `GRANTED` (case-insensitive) as permission to track the recipient. Any other value, including an empty one, is read as no permission. * Any custom recipient attributes you want Inxmail to hold. ![The Mapping step, showing the catalogue attribute picker open beside the Email and Tracking Permission destination fields in the recipient attributes group.](https://mintcdn.com/zeotap/eqpJpcnyReLBRSSq/articles/integrate-customer/Storage/integrate-customer/inxmail-audience/inxmail-audience-2026-03-31-4.jpeg?fit=max\&auto=format\&n=eqpJpcnyReLBRSSq\&q=85\&s=134e630458a12911b95869bb6f2a382a) > [!NOTE] > > Every custom attribute you map must already exist as a recipient attribute in Inxmail, under the same name. Inxmail will not create one on the fly, and data mapped to an attribute that does not exist is not imported. > > Inxmail holds each recipient attribute as a single value of a fixed type — text, date, date and time, time, integer, decimal or true/false. Map flat attributes to it. For how Zeotap CDP handles objects, lists of objects and non-customer entities in destination uploads generally, see [Object, List of Objects and NCE Support in Destination Upload](/articles/segment-customer/object-list-of-objects-and-nce-support-in-destination-upload). **Step 5** Click **Create Destination**. The destination is now available to link to an audience. For the general shape of this flow across all destinations, see [Configure a destination](/articles/integrate-customer/destinations#configure-a-destination) and [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). ## Link an audience to the destination **Step 1** Go to **Segment > Audiences** and open the audience you want to send to Inxmail. **Step 2** In the **Select Destination** panel, search for the Inxmail destination you created and add it. It appears on the audience canvas with its action shown on the card. ![An audience open in the Segment module with an Inxmail destination card placed on the canvas, and the Select Destination search panel listing available destinations on the right.](https://mintcdn.com/zeotap/kl8L6sBUYwhq5T7t/articles/integrate-customer/Storage/integrate-customer/inxmail-audience/inxmail-audience-2026-03-31-5.png?fit=max\&auto=format\&n=kl8L6sBUYwhq5T7t\&q=85\&s=cb93f77df11668f10cf0f33a52f8ce3f) **Step 3** Open the **Destination Settings** tab and complete the **Action Inputs**. The sender and reply-to inputs describe the mailing list Zeotap creates, so they belong to the **Create a list and Upload Recipients** action: | Field | Required | What it does | | - | - | - | | **List Name** | Yes (Create a list and Upload Recipients) | The name of the mailing list Zeotap creates in Inxmail. 1 to 255 characters. | | **Sender Address** | Yes (Create a list and Upload Recipients) | The email address of the sender of the new list. Must be a valid, deliverable address. | | **Sender Name** | Yes (Create a list and Upload Recipients) | The name of the sender of the new list. | | **Reply to Address** | Yes (Create a list and Upload Recipients) | The email address that appears in the reply-to header of every mailing sent from this list. | | **Reply to Name** | Yes (Create a list and Upload Recipients) | The display name associated with the reply-to address. | | **Tracking Permission Conflict Mode** | No | How an import treats the tracking permission of a recipient who already exists in Inxmail. The default is `OVERWRITE FULL`; `KEEP EXISTING` is also available. | | **Import Conflict Mode** | No | How an import treats the attribute values of a recipient who already exists in Inxmail. The default is `OVERWRITE FULL`; `KEEP EXISTING` is also available. | ![The Destination Settings tab of a linked Inxmail destination, showing the Sender Address, Sender Name, Reply to Address, Reply to Name, Tracking Permission Conflict Mode and Import Conflict Mode action inputs.](https://mintcdn.com/zeotap/kl8L6sBUYwhq5T7t/articles/integrate-customer/Storage/integrate-customer/inxmail-audience/inxmail-audience-2026-03-31-6.jpeg?fit=max\&auto=format\&n=kl8L6sBUYwhq5T7t\&q=85\&s=ed64600614a4bfa1afe57ebc4f98df77) > [!WARNING] > > Choose the conflict modes deliberately. Inxmail stores recipients once per account rather than once per list, so an import updates that recipient everywhere they are a member. Under `OVERWRITE FULL`, an attribute you send with an empty value overwrites whatever Inxmail held before, including in lists this audience has nothing to do with. Use `KEEP EXISTING` if the audience should add recipients to a list without changing attribute values that Inxmail already holds. **Step 4** Click **Save Destination**, then save the audience. The audience and the destination are now linked, and activating the audience loads its members into Inxmail. For the general audience-linking flow and scheduling options, see [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > Before you activate, confirm that everyone in the audience has opted in to receive the communications you intend to send them, as required by the regulations that apply to you. ## Verify the recipients reached Inxmail Confirm delivery on both sides: 1. **In Zeotap CDP** — open the audience and check its activation status for this destination. See [Audience status and activation status](/articles/segment-customer/audience-status-and-activation-status) and [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). 2. **In Inxmail** — open the target mailing list and confirm the recipient count is non-zero and in the same order of magnitude as the audience count. Open one or two recipients and check that the attributes you mapped carry the values you expect. A successful activation status in Zeotap records that Zeotap completed its side of the delivery. Always confirm the list in Inxmail as well before you schedule a mailing against it. ## Troubleshoot the Inxmail destination **The activation succeeded but the recipients are not in the Inxmail list.** Check the type of every attribute you mapped. Inxmail rejects an import whose value does not match the type the attribute is defined with. A date-only value such as `2026-10-02` sent to an attribute Inxmail defines as *date and time* is the most common cause, because that type expects a full timestamp. Fix the mismatch on either side — change the format of the Zeotap attribute, or change the attribute's type in Inxmail — and activate the audience again. **Some mapped data is missing in Inxmail, but the email addresses arrived.** The attribute does not exist in Inxmail, or its name does not match the one in the mapping. Create the recipient attribute in Inxmail under exactly the mapped name, then activate the audience again. **Attribute values that were correct in Inxmail are now empty.** The import conflict mode was `OVERWRITE FULL` and the audience sent an empty value for that attribute. Either populate the attribute in the audience, remove it from the mapping, or set the import conflict mode to `KEEP EXISTING`. **Recipients reached Inxmail but are not tracked.** Tracking permission is only granted by the value `GRANTED`. Check that the mapped attribute produces that value, and check the tracking permission conflict mode if the recipients already existed in Inxmail. **Nothing is delivered and the list is never created.** All four sender and reply-to action inputs must be filled in, and both address fields must be valid email addresses. A blank or malformed value stops the list being created. **Nothing is delivered when using Upload Recipients to a List.** The list ID must match a list that already exists in your Inxmail account. If it is missing, mistyped, or points at nothing, the delivery fails. Confirm the ID in Inxmail, correct it in the mapping, and activate the audience again. **The destination is missing from the audience's destination list.** Confirm the destination was created successfully and that you have access to it. See [Destination access rules](/articles/integrate-customer/destination-access-rules). If the activation still fails after these checks, see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail), then raise a support request with the audience name, the destination name, the action you configured, the date and time of the failed activation, and the recipient count you expected. ## Next steps * [Inxmail](/articles/integrate-customer/inxmail) — the real-time Inxmail destination, for event-triggered emails sent from a journey. * [Destinations](/articles/integrate-customer/destinations) — concepts, mapping and delivery troubleshooting that apply to every destination. * [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination) — activation and scheduling. * [Audience status and activation status](/articles/segment-customer/audience-status-and-activation-status) — how to read the statuses you see after an activation. # iOS SDK Source: https://docs.zeotap.com/articles/integrate-customer/ios-sdk The iOS SDK source sends app events and user data from your iOS app into Zeotap CDP. Start here for what it collects, how the setup splits in two, and how to check data is arriving. The iOS SDK is a **source**: it sends events and user data **from your iOS app into Zeotap CDP**, where that data can be used to build segments, view insights and target users on your preferred platforms. It is one of the two native app SDKs under [App Events](/articles/integrate-customer/app-events); the other is the [Android SDK](/articles/integrate-customer/android-sdk). > [!NOTE] > > **Looking for the developer reference?** The [Zeotap iOS SDK developer documentation](/articles/sdks/ios/intro) covers installation, configuration options, the full API reference, consent management, and release notes. This page explains how to create and use the iOS SDK source within the Zeotap CDP. ## What this is The iOS SDK supports all iOS devices and tablets. The SDK simplifies the process of sending the data from your iOS app to Zeotap. The SDK tracks events, page visit information, user logins and any other information related to the product or services offered on the app. This data can then be made actionable by creating user segments, viewing insights and targeting them on your preferred platforms. The SDK supports iOS **v13, v14 and v15**. In the [list of supported source integrations](/articles/integrate-customer/creating-a-source), the iOS SDK sits in the **App Events** category and carries customer data (CE) only. ## Supported identifiers and data The following table lists what the SDK can send, and where each one is covered in the developer reference. | What you can send | Developer reference | | - | - | | Standard identifiers (email address, phone number and login ID), sent either raw or already hashed, plus your own custom identifiers such as a CRM ID or a loyalty ID | [Track user identities](/articles/sdks/ios/api-reference/set-user-identities) | | App events and the properties you attach to them | [Track user events](/articles/sdks/ios/api-reference/track) | | Page view events and page properties | [Track page view events](/articles/sdks/ios/api-reference/set-page-properties) | | User attributes that change rarely, such as subscription status | [Setting user properties](/articles/sdks/ios/api-reference/set-user-properties) | | The Advertising Identifier (IDFA) and the App Tracking Transparency status | [Collect advertising ID (IDFA)](/articles/sdks/ios/api-reference/collect-advertising-id) | | Consent captured by your consent management platform | [Choosing a consent strategy](/articles/sdks/ios/consent/consent-strategy) | ## How the setup splits Setting up the iOS SDK takes two steps, documented in two places. **1. Create the source in the Zeotap CDP** Create an **iOS Native SDK** source under the **App Events** category, then take the write key from the source's **IMPLEMENTATION DETAILS** tab. See [Create an iOS SDK Source](/articles/integrate-customer/create-an-ios-sdk-source). **2. Implement the SDK in your app** Add the SDK to your Xcode project, initialise it with that write key, and start sending identities and events. See the [iOS SDK quick start guide](/articles/sdks/ios/quick-start). The write key is what ties the two halves together: it tells Zeotap which source the incoming data belongs to. For more information, refer to [Write Key](/articles/sdks/ios/configurations/write-key). ## Understand the iOS SDK source with a use case For example, a use case for a social media app leveraging the iOS SDK and Zeotap could involve analysing user behaviour and interests to enhance content personalisation and targeted advertising. By integrating the iOS SDK, the social media app can track various events such as post engagements, user logins, and page visits. This data can then be sent to Zeotap CDP, where user segments can be created based on demographics, preferences, and engagement patterns. With these insights, the social media app can deliver personalised content, recommend relevant accounts or posts, and serve targeted ads, leading to improved user engagement, retention, and monetisation opportunities. ## Verify data is arriving Once the SDK is live in your app, open the source and check the **PREVIEW DATA** tab, which shows a sample of the data received. When data starts flowing into the system, the status of the source changes to *Integrated*. For more information, refer to [Components of the Preview Data Tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) and [Components of the Source Listing Page](/articles/integrate-customer/components-of-the-source-listing-page). ## Troubleshoot the iOS SDK source * **Nothing appears under Preview Data.** Check that the write key in your app is the one shown on the **IMPLEMENTATION DETAILS** tab of this iOS source, and that it was copied with no extra spaces or characters. The key must be the one for this iOS source — a key from another source sends your events to that source instead, so check its Preview Data too. * **You changed the write key, but the app still sends to the old source.** The write key is supplied when the SDK initialises. Pointing an app at a different source, such as moving from a test source to your production one, therefore means releasing a new build of the app. * **Events stopped arriving after the source was archived.** Archiving a source pauses all future ingestion for it, although the data already ingested is kept. Check the **ARCHIVED** tab on the Source listing page and unarchive the source if ingestion should continue. If the source was archived deliberately, remove the SDK calls from your app. For more information, refer to [Archived Source](/articles/integrate-customer/archived-source). ## Next steps > [card] [Create an iOS SDK source](/articles/integrate-customer/create-an-ios-sdk-source) > [card] [iOS SDK developer docs](/articles/sdks/ios/intro) > [card] [SDK reference](/articles/integrate-customer/sdk-reference) > [card] [Android SDK source](/articles/integrate-customer/android-sdk) # Iterable: Campaign Trigger real-time integration Source: https://docs.zeotap.com/articles/integrate-customer/iterable-campaign-trigger Send customer data out of Zeotap CDP to Iterable from a Journeys workflow, to trigger an API-triggered campaign or update a subscriber list. ## What this is The **Iterable: Campaign Trigger** destination sends customer data **out of Zeotap CDP to Iterable** in real time, as each customer reaches the **Send to Destinations** node of a Journeys workflow. Data does not flow back from Iterable into Zeotap CDP. In this model Zeotap CDP owns the segmentation and the workflow logic — it decides when a campaign should fire and which one. Iterable owns the creation, management and execution of the campaign itself, and acts when Zeotap CDP calls it. Zeotap CDP makes that call to Iterable as soon as a customer meets the condition you built into the journey, so the campaign is activated for that user immediately. Zeotap CDP has one **Iterable: Campaign Trigger** destination in the catalogue, documented once for each of the two ways it is driven. Both send data outbound: * **Real-time integration (Journeys)** — this page. The destination is linked from the **Send to Destinations** node of a workflow. * **[Batch integration (Audiences)](/articles/integrate-customer/iterable-campaign-trigger-audience)** — the same destination, linked to an audience. The [Integrations Master List](/articles/integrations-master-list-publication/integrations-master-list) records Iterable only as a destination, so there is no page for the opposite direction — Zeotap CDP does not read data from Iterable. ## Supported identifiers and actions Your Iterable project's primary user identifier must be **email**, and the email address is what this integration matches customers on. Alongside it you can map any other catalogue attribute your campaign needs. | Action | What it does | Message categories | | :- | :- | :- | | **Trigger Campaign** | Activates an existing API-triggered Iterable campaign for the customer. | Email, SMS, In-App Push, Web Push | | **Update Subscriber List** | Adds or updates the customer on an Iterable subscriber list. | — | The message categories come from the [Gateway supported destinations table](/articles/orchestrate-customer/gateway#supported-destinations), which is also where you cap how often these sends reach a customer. ## Prerequisites **In Iterable** * Administrative or equivalent permission in your Iterable project to create and manage API keys. * Everything Iterable itself requires before a campaign can send. * The campaigns you want to fire already created and configured as **API-Triggered Campaigns**. Each one has a unique campaign ID, which the integration needs. * Those API-triggered campaigns activated and set to **Running**. ![The Iterable campaigns list, with each campaign's channel and ID shown beneath its name, a Status column reading Running and Draft, Delivery and Engagement counts, and a Launch date column reading API-Triggered.](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/iterable-campaign-trigger/iterable-campaign-trigger-2025-07-22-2.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=1bf3be71da519260f6e093166166c885) * If you are going to use **Update Subscriber List**, the ID of the list you want to write to. You can read it from the **ID** column on Iterable's **Lists** screen. > [!NOTE] > > **Note:** > > The list is appended to every time you add a new user. If an identifier already exists on the list, the other fields on that record are updated instead. ![The Iterable Lists screen, with the ID column holding each list's numeric ID alongside Name, Type, Created, Created by, Updated and Contacts columns.](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/iterable-campaign-trigger/iterable-campaign-trigger-2025-07-22.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=bb9ed4618606c5abd63ccd13648f4b47) **In Zeotap CDP** * The customer's email address, available in Zeotap CDP at the moment the trigger fires, and matching the user profiles in Iterable. * A Journeys workflow to attach the destination to. See [Create a Workflow](/articles/orchestrate-customer/create-a-workflow). ## Create an Iterable API key The destination authenticates to Iterable with an API key, which you generate in Iterable. **Step 1** Sign in to your Iterable project as an [org admin](https://support.iterable.com/hc/articles/205480335#org-administrators), or as a member holding the [Manage Integrations](https://support.iterable.com/hc/articles/205480335#project) project permission. **Step 2** Go to **Integrations > API Keys**. The screen lists the project's existing API keys, but does not display the full key values. **Step 3** Click **New API Key**. **Step 4** In the **Create API Key** window, enter a name for the key and select the [type of API key](https://support.iterable.com/hc/en-us/articles/360043464871-API-Keys#iterable-api-keys) you want to generate. Give the key a descriptive name so you can tell later what it is used for — useful if you need to find and update it, or to disable or delete it for security reasons. **Step 5** If you selected a client-side key type, two further settings appear: a. **Event creation** — either block the creation of new event definitions, or allow them for up to 14 days into the future. See Iterable's notes on [event creation](https://support.iterable.com/hc/en-us/articles/360043464871-API-Keys#event-creation). b. **JWT authentication** — selected by default, and recommended by Iterable. See Iterable's notes on [JWT authentication](https://support.iterable.com/hc/en-us/articles/360043464871-API-Keys#jwt-authentication). **Step 6** Click **Create**. ![The Create API Key window in Iterable, with Name and Type fields and an Additional client-side API key settings panel holding the Event creation radio buttons and the JWT authentication checkbox.](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-64.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=63426c2c995a3de77f4c855c0e2c0d7a) **Step 7** In the **Copy your new API key** window, copy the API key. ![The Copy your new API key window in Iterable, with the API key field, a Copy button beside it, and a Close button.](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-65.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=b9418b17d456b81fe361e52a1ddf7a53) If the key requires JWT authentication, copy the **JWT Secret** as well — that is what your server uses when it generates per-user JSON Web Tokens. ![The Copy your new API key and JWT secret window in Iterable, with separate API key and JWT Secret fields, each with its own Copy button.](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-66.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=e4268f18ae0046e83ca46ba7fa51454d) > [!WARNING] > > Store these values somewhere secure before you close the window. Once it is closed, Iterable shows only the last 8 characters of the API key, and cannot show the JWT secret again. If you lose either one, create a new API key. ## Create the Iterable: Campaign Trigger destination **Step 1** Log into Zeotap CDP and go to **Integrate > Destinations**. **Step 2** Click **+ Create Destination**. ![The Destinations screen in Zeotap CDP, with the + Create Destination button highlighted above the table of existing destinations.](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-67.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=f06de93e5d469c2105d26e973f4190e6) **Step 3** Under **All Destinations**, search for Iterable. The catalogue returns two tiles — **Iterable** and **Iterable: Campaign Trigger**. Select **Iterable: Campaign Trigger**. ![The All Destinations catalogue, with the Search for a Destination box highlighted above a grid of destination tiles.](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-68.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=5e877a89b05667d67caf982ca68e5f0b) ![The All Destinations catalogue filtered by a search for iterable, returning the Iterable and Iterable: Campaign Trigger tiles.](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-69.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=5225eeaccc7bd97a1865f9c244a51944) **Step 4** Click **Iterable: Campaign Trigger**. The destination screen appears, describing the integration on the left and listing the fields it needs on the right. On the **Destination Details** tab, enter: a. **Destination Name** — a name for the destination, for easy identification. b. **API key** — the Iterable API key you created above. c. **Data Center** — the data centre of your Iterable instance: `com` for the US, `eu` for Europe. Review the values, then click **Next**. ![The Destination Details tab of the destination creation screen, showing the Destination Name, API key and Data Center fields filled in, with a Mapping tab beside it.](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-70.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=172d5eba48611512a4d46d0754c118ad) **Step 5** On the **Mapping** tab, choose the action and define the field mapping. a. Under **Choose your Action**, select **Trigger Campaign** or **Update Subscriber List**. b. Under **Map the Fields**, pair each catalogue field with the Iterable destination field it feeds. For **Update Subscriber List**, Iterable's **Email** destination field is required, so map the catalogue field that carries the email address — for example **Email Raw** — to it. c. Add any further attributes your campaign needs with **+ Add Mapping**. ![The Choose your Action step with Trigger Campaign selected, above a Map the Fields table whose Data Fields group pairs the Email Raw and First Name catalogue fields with Iterable's email and firstName destination fields.](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-71.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=7de6d3d286cdaaf251c001f38369a4d2) ![The Choose your Action step with Update Subscriber List selected, above a Map the Fields table whose Subscribers Data group pairs the Email Raw catalogue field with Iterable's required Email destination field and Event Name 01 with eventName.](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-72.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=93d132c00e2811c3f4254b91ad9a067a) **Step 6** Click **Create Destination**. The destination is created and becomes available to link from a Journeys workflow. For the general rules on actions and mappings that apply to every destination, see [Configure a destination](/articles/integrate-customer/destinations#configure-a-destination) and [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). ## Activate the destination in a journey Once the destination exists, link it in the **Send to Destinations** node of your workflow. **Step 1** In the workflow, click **+** and choose **Send to Destinations**. ![The Choose an action menu on a Journeys workflow node, with Send to Destinations highlighted and its tooltip explaining that it forwards customer data to channels that send emails, show ads or run analytics.](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-73.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=4eac5aa36575969109e1b425e1c07fe5) **Step 2** Find your destination in the list of available destinations using the search box. ![The Send to Destinations panel, with the search box highlighted above a grid of cards for the destinations already configured in the workspace.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/image-74.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=bcc1d6e858671644fade938d0e311977) **Step 3** On the **Destination Details** tab, the **API key** and **Data Center** fields are populated automatically from the values you entered when you created the destination. Below them, set the settings this journey needs: a. **List Ids** — the field's helper text describes a non-empty array of Iterable list IDs to send to. b. **Campaign ID** — the API-triggered campaign to fire. > [!NOTE] > > **Note:** > > While attaching a destination, Campaign ID might be a required field even if you are just trying to update a subscriber list. You can add any value to it. It will not be used. ![The Iterable: Campaign Trigger panel opened from the journey node, on the Destination Details tab, with the List Ids and Campaign ID fields highlighted below the Destination Name, API key and Data Center fields.](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-75.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=0351b6cb5eca9fc33849e3817f5e9684) The **Destination Settings** tab carries an **allow repeat marketing sends** setting, which you set to true or false as your use case requires. **Step 4** Click **Save Destination**. The destination is attached to the node, showing its name, its ID and the action it will perform. ![The Destinations node with an Iterable: Campaign Trigger destination attached, showing the destination card with its name and ID lines and the action name Trigger Campaign beneath them.](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-76.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=21d5bdb366c91dc6cd93e0f45ce31079) ## Verify the integration works Check both sides. **In Zeotap CDP** * On the journey canvas, look at the destination node. Failures show red indicators and successful deliveries green ones. Open the node to see the **Execution Details** panel, which gives the failure status code, the timestamp, the destination name and the Request ID. See [Identify Journey Errors](/articles/orchestrate-customer/identify-journey-errors). * To see exactly what was sent for one customer, use [Journey Traces](/articles/orchestrate-customer/journey-traces). It shows the raw input event that triggered the journey and the transformed output event sent to each destination node. **In Iterable** * For **Trigger Campaign**, open the campaigns list. The campaign you targeted should be **Running**, and its **Delivery** column should show triggered and delivered counts climbing. * For **Update Subscriber List**, open the **Lists** screen and check the **Contacts** count on the list you wrote to. The two sides will not match exactly — each platform applies its own filtering to the records it receives — but both should be non-zero. ## Troubleshoot this integration Start with the Journey Trace for a failing execution: it carries the destination's own response, which usually says more than the error code alone. Then check the scope — if every customer fails at the node, the cause is normally authentication or mapping; if only a small share fail, it is normally consent or data quality. See [Troubleshooting Workflows](/articles/orchestrate-customer/journey-troubleshooting). | Error code | Likely cause on this integration | First action | | :- | :- | :- | | `AUTHENTICATION_ERROR` | The Iterable API key is wrong, or it was rotated in Iterable without being updated on the destination. | Open the destination and enter the current API key. | | `ENDPOINT_NOT_FOUND` | The **Data Center** on the destination does not match your Iterable instance. | Check the Data Center value — `com` for the US, `eu` for Europe. | | `BAD_REQUEST` / `EVENT_PARSING_FAILED` | A required field is missing from the payload — most often the customer's email address was not mapped, or it resolved to null. | Reopen the mapping and confirm the email field is mapped and populated. | | `CONSENT_NOT_PROVIDED` | The customer does not carry the consent the journey requires. | Check the customer's consent attributes and the destination mapping. | | `RATE_LIMIT` / `SERVER_ERROR` / `SERVICE_UNAVAILABLE` | Transient. These retry automatically. | Wait and monitor; check Iterable's status for outages. | For the full definitions, root causes and resolution steps, see [Journey Error Codes](/articles/orchestrate-customer/journey-error-codes). If the journey reports success but nothing sends from Iterable, re-check the prerequisites: the campaign must exist as an **API-Triggered Campaign**, and it must be activated and set to **Running**. ## Next steps * [Set up the batch Iterable destination →](/articles/integrate-customer/iterable-campaign-trigger-audience) * [Create a workflow in Journeys →](/articles/orchestrate-customer/create-a-workflow) * [Activate your real-time audiences →](/articles/integrate-customer/activate-your-real-time-audiences) * [Cap how often a customer is messaged with Gateway →](/articles/orchestrate-customer/gateway) * [Look up a journey error code →](/articles/orchestrate-customer/journey-error-codes) # Iterable: Campaign Trigger Source: https://docs.zeotap.com/articles/integrate-customer/iterable-campaign-trigger-audience Send a batch audience out of Zeotap CDP to Iterable to fire an API-triggered campaign or update a subscriber list. ## What this is The **Iterable: Campaign Trigger** destination sends audience data **out of Zeotap CDP to Iterable**, where a pre-defined campaign is fired or a subscriber list is updated for each qualifying customer. Nothing flows back from Iterable into Zeotap CDP. In this model Zeotap CDP owns the segmentation and the decision about when a campaign should be sent; Iterable owns the creation, management and execution of the campaign itself. When a customer qualifies, Zeotap CDP activates the designated campaign in Iterable for that customer. Zeotap CDP performs that step as part of the delivery once the destination is configured and linked — you never call the Iterable API yourself. This page covers the **batch** lane, in which you link an **audience** to the destination — it is filed under **Batch Integrations** in this documentation. For the real-time lane, in which the same destination is attached to a journey, see [Iterable: Campaign Trigger real-time integration](/articles/integrate-customer/iterable-campaign-trigger). ## Supported identifiers and actions This integration accepts any identifiers and attributes of your choice from the Catalogue. Your Iterable project's primary user identifier must be email. | Action | What it does | | - | - | | **Trigger Campaign** | Activates a designated API-triggered campaign in Iterable for each qualifying customer. | | **Update Subscriber List** | Adds customers to an existing Iterable subscriber list, or updates them if they are already on it. | You map Catalogue fields to Iterable destination fields per action: * For **Update Subscriber List**, Iterable's `Email` destination field is required, so map the Catalogue field that carries the email address — for example **Email Raw** — to it. * For either action, map any further field you need with **+ Add Mapping**. ## Prerequisites ### In Iterable * Administrative or otherwise sufficient permissions in your Iterable project to create and manage API keys. * Everything Iterable itself requires before a campaign can be sent. * The campaigns you want to fire already exist in Iterable and are configured as **API-Triggered** campaigns. Each one carries its own campaign ID, shown beneath the campaign name in the campaigns list, which the integration needs to identify the campaign. * Those API-triggered campaigns are activated and set to **Running**. ![The Iterable campaigns list showing two API-triggered campaigns, one with status Running and one Draft, with each campaign's channel and ID beneath its name.](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/iterable-campaign-trigger/iterable-campaign-trigger-2025-07-22-2.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=1bf3be71da519260f6e093166166c885) * For **Update Subscriber List**, the subscriber list already exists and you have its list ID. > [!NOTE] > > **Note:** > > The list is appended to every time a new user is added. Where an identifier already exists on the list, the other fields on that record are updated instead. ![The Iterable Lists screen, with each list's ID in the ID column alongside its type, creation date and current contact count.](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/iterable-campaign-trigger/iterable-campaign-trigger-2025-07-22.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=bb9ed4618606c5abd63ccd13648f4b47) * The Iterable project's primary user identifier is email. ### In Zeotap CDP * Your role grants destination edit rights on the organisation that owns the destination. For the role-to-permission matrix, see [User Roles and Access](/articles/admin-customer/user-roles-and-access). * An [audience](/articles/segment-customer/create-an-audience) is defined with the criteria for the cohort you want to activate. * A consistent user identifier is available in Zeotap CDP at the time of the trigger and corresponds to the user profiles in Iterable. ## Create an API key in Iterable Interaction with Iterable requires an API key, which you create in Iterable and then paste into the Zeotap CDP destination. **Step 1** Sign in to an Iterable project as an [org admin](https://support.iterable.com/hc/articles/205480335#org-administrators) or as a member that has the [Manage Integrations](https://support.iterable.com/hc/articles/205480335#project) project permission. **Step 2** Navigate to **Integrations › API Keys**. This screen lists information about each of the API keys that have been created for the project, but it does not display the full API keys. **Step 3** Click **New API Key**. **Step 4** In the **Create API Key** window, enter a name for the key and select the [type of API key](https://support.iterable.com/hc/en-us/articles/360043464871-API-Keys#iterable-api-keys) you want to generate. Give the key a descriptive name so you know what it is used for later — useful if you need to find and update it, or have a security reason to disable or delete it. **Step 5** (Client-side keys only) If you selected a client-side key type, you will see additional settings: a. **Event creation** — block creation of new event definitions, or allow them for up to 14 days in the future. See [Event creation](https://support.iterable.com/hc/en-us/articles/360043464871-API-Keys#event-creation) in Iterable's API Keys documentation. b. **JWT Authentication** — selected by default and highly recommended. See [JWT authentication](https://support.iterable.com/hc/en-us/articles/360043464871-API-Keys#jwt-authentication) in Iterable's API Keys documentation. **Step 6** When you have finished, click **Create**. ![The Iterable Create API Key window, with fields for the key name and type and, for client-side key types, the Event creation and JWT authentication settings.](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-83.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=36300f66685650b4550a3f33e2f47dd1) **Step 7** In the **Copy your new API key** window, copy the API key. ![The Iterable Copy your new API key window, with the API key field and its Copy button.](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-84.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=b59575ba0df8e0d06de30b83669d98e7) If your API key requires JWT authentication, also copy the JWT secret your server should use when generating per-user JSON Web Tokens. ![The Iterable Copy your new API key and JWT secret window, with an API key field and a JWT Secret field, each with its own Copy button.](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-85.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=747e685e6f490ddbdcbdda034679c488) Store the values shown on this screen in a secure location. Once you close the window Iterable cannot display them again, and you will have to create a new API key. ## Create the Iterable: Campaign Trigger destination **Step 1** Log in to the Zeotap CDP app and go to the **Destinations** application. **Step 2** Click **+ Create Destination**. ![The Zeotap CDP Destinations application on the Private Destination tab, with the + Create Destination button highlighted above the list of existing destinations.](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-86.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=f38cc4d58832fc5443504058bf989b24) **Step 3** Under **All Destinations**, search for `iterable`. The **Iterable: Campaign Trigger** tile is returned. ![The All Destinations catalogue in Zeotap CDP, with the Search for a Destination box highlighted above the destination tiles.](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-87.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=b5a51b5b96759db0a96db68624204c58) ![The All Destinations search filtered on iterable, returning a single Iterable: Campaign Trigger destination tile.](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/iterable-campaign-trigger/iterable-campaign-trigger-2025-07-22-4.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=6fcfe0baa4659f8fce7e3fd1f476e5eb) **Step 4** Click the **Iterable: Campaign Trigger** tile. Details about the destination appear on the left of the screen; on the right are the fields required to establish the integration. On the **Destination Details** tab, enter: a. **Destination Name** — a name that identifies this destination easily. b. **API Key** — the key you copied in [Create an API key in Iterable](#create-an-api-key-in-iterable). c. **Data Center** — the data centre of your Iterable instance: `com` for the US, `eu` for Europe. ![The Destination Details tab of an Iterable: Campaign Trigger destination, showing the Destination Name, API key and Data Center fields, with Data Center set to com.](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-88.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=4c65bbf5433bfcb893ca6b47664dcc0a) d. Review all the values entered above, then click **Next** to proceed. **Step 5** On the screen that appears, choose the [action](/articles/integrate-customer/destinations#configure-a-destination) and its [mapping](/articles/integrate-customer/destinations#define-the-mapping). Under **Choose your Action**, choose **Trigger Campaign** or **Update Subscriber List**. ![The action and mapping screen with Trigger Campaign selected under Choose your Action and, under Map the Fields, the Catalogue fields Email Raw and First Name mapped to the email and firstName destination fields in the Data Fields group.](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-89.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=363395d12c615e3e43dec501c5a93805) Under **Map the Fields**, map the Catalogue fields to the Iterable destination fields. For **Update Subscriber List**, Iterable's `Email` destination field is required, so map the Catalogue field that carries the email address — for example **Email Raw** — to it; add any other field with **+ Add Mapping**. ![The action and mapping screen with Update Subscriber List selected under Choose your Action and, under Map the Fields, the Catalogue fields Email Raw and Event Name 01 mapped to the Email and eventName destination fields in the Subscribers Data group, Email being required.](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/iterable-campaign-trigger/iterable-campaign-trigger-2025-07-22-3.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=e7eefbf84476ceadae77ef9d791b399a) **Step 6** Click **Create Destination**. The destination is created and is then available to link to an audience, as described below. ## Link an audience to the destination After creating the destination, link it to the audience you want to activate. **Step 1** In the **Audiences** application, find the audience, click the **Audience Activation** icon at the right-hand end of its row and then click **Link to Destination**. ![The Audiences application listing on the Batch tab, with the per-row action icons at the right-hand end of each audience row.](https://mintcdn.com/zeotap/kl8L6sBUYwhq5T7t/articles/integrate-customer/Storage/integrate-customer/image-90.png?fit=max\&auto=format\&n=kl8L6sBUYwhq5T7t\&q=85\&s=831b45d0bfac6eecdf210dd053e87711) **Step 2** In the screen that appears, find the destination with the search box and drag and drop it into the canvas. ![The Select Destination panel with its search box highlighted, beside the canvas area where destinations are dragged and dropped.](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-91.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=0e36f51a6cce048bc2efb44fa669a31c) **Step 3** Under the **Destination Details** tab, the API key and Data Center fields are populated automatically from the values you entered when you created the destination. **Step 4** Click **Save**. The destination is attached to the audience. ![The audience's destination canvas with the linked destination card placed on it, above the Cancel and Save buttons.](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-92.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=33229e4d5f5500cc75d2b23f287dc948) ## Verify the delivery Confirm the delivery from both sides, as for [any destination](/articles/integrate-customer/destinations#verify-the-activation-worked): * **In Zeotap CDP** — open the destination and review its activity. A successful delivery records a run with a non-zero qualified count and a completed status. A failed run records an error message you can use to diagnose the cause. * **In Iterable, for Trigger Campaign** — open the campaigns list and check the campaign's **Delivery** column, which reports how many sends were triggered and what share was delivered. * **In Iterable, for Update Subscriber List** — open **Lists** and check the **Contacts** count against the list you targeted. The two counts will not match exactly — the receiving platform applies its own match-rate filtering on the identifiers it receives — but both should be non-zero. ## Troubleshoot the delivery * **The campaign never fires.** Confirm the campaign is configured as an **API-Triggered** campaign and that its status is **Running** — a campaign left in **Draft** does not fire. * **The subscriber list does not grow.** **Update Subscriber List** writes to a list that must already exist, and you must have its list ID. Where an identifier on the audience already exists on the list, the record is updated rather than added, so the contact count can stay flat even on a successful run. * **Customers are not matched in Iterable.** The Iterable project's primary user identifier is email, so the email you map must be the same address held on the Iterable profile. * **Campaign and list setup.** Both actions depend on objects you create in Iterable, not in Zeotap CDP: the API-triggered campaign for **Trigger Campaign**, and the subscriber list for **Update Subscriber List**. Check both exist before investigating the delivery itself. * **`Invalid permissions! Access denied.`** Your account does not hold the required role on the organisation that owns the destination. Check your role assignments in [User Roles and Access](/articles/admin-customer/user-roles-and-access). * **`No customers qualified`** The audience definition returned zero qualifying records at the moment the refresh ran, even if the audience estimator showed a non-zero count. For the full list of delivery errors and what to include when raising a ticket, see [why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail) and [when to contact support](/articles/integrate-customer/destinations#when-to-contact-support). ## Next steps * [Send to Iterable in real time from a journey →](/articles/integrate-customer/iterable-campaign-trigger) * [Activate your batch audiences →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore how destinations work →](/articles/integrate-customer/destinations) * [Create a destination from the Destinations module →](/articles/integrate-customer/create-a-destination) # Kafka Message Queue Source Source: https://docs.zeotap.com/articles/integrate-customer/kafka_message_queue Bring events into Zeotap CDP from an Apache Kafka topic by creating a Kafka Message Queue source. ## What this is The Kafka Message Queue source brings data **into** Zeotap CDP: you point Zeotap at a topic in your own Apache Kafka deployment, and Zeotap reads the messages published to that topic and ingests them — so real-time customer behaviour already flowing through your streaming platform lands in Zeotap CDP without a file drop or an SDK in between. This page covers the inbound direction only. To send data the other way — from Zeotap CDP out to a Kafka topic — use the [Apache Kafka destination](/articles/integrate-customer/apache-kafka-destination) instead. The two are separate integrations, set up in different places — the source in the **Sources** application under **Integrate**, the destination in a Journeys workflow. ## Prerequisites > [!NOTE] > > Before you create the source, confirm: > > * You have access to the **Sources** application in the Zeotap CDP App, with permission to create a source. > * The topic you want to ingest from already exists in your Kafka deployment and messages are being published to it. > * You have collected the connection details listed below, either from the administrator who manages your Kafka cluster or from your cloud provider's Kafka management interface (for example, Confluent Cloud or AWS MSK). > * You know which **Data Entity** the incoming data represents — **Customer Data** or **Non Customer Data**. See [Supported Data Entities](/articles/unify-customer/supported-data-entities). > * You know which data format your producers write to the topic — **AVRO** or **JSON**. **AVRO** requires three additional schema registry values. ### Details to collect from your Kafka deployment | Detail | What it is and where to find it | Needed for | | - | - | - | | **Topic name** | The name of the topic in Kafka from which the data needs to be ingested into Zeotap. | All Kafka sources | | **Kafka Broker Host** | The broker's hostname or IP address. Check the Kafka broker configuration in the Kafka installation directory, typically in the **server.properties** file, and look for the **listeners** property. Alternatively, ask the administrator managing the Kafka cluster. | All Kafka sources | | **Broker API Key** and **Broker API Secret** | The credentials used when the Kafka broker requires authentication. They are usually provided by the administrator or through the Kafka management interface of the cloud provider (for example, Confluent Cloud or AWS MSK). For Confluent Cloud, you can find these in the **API Keys** section under the **Cluster Settings** tab. | All Kafka sources, where the broker requires authentication | | **Consumer Group ID** | The identifier for a group of consumers that work together to consume messages from a Kafka topic. | All Kafka sources | | **Data format** | The format of the data that is ingested. Currently, **AVRO** and **JSON** formats are supported. | All Kafka sources | | **Schema Registry URL** | The URL of the schema registry serving the topic's schema. If you use a schema registry, the URL is provided during the setup or can be found in the configuration settings of the Kafka deployment. For Confluent Schema Registry, the URL is typically listed in the **Schema Registry** section of the Confluent Cloud dashboard. | **AVRO** only | | **Schema Registry Key** and **Schema Registry Secret** | The credentials for the schema registry. Like the broker credentials, these are provided by the administrator or through the schema registry's management interface. In Confluent Cloud, navigate to **Schema Registry**, then open the **API Keys** section to generate or view the credentials. | **AVRO** only | ## How the Kafka source works Apache Kafka is an open-source distributed event streaming platform used by thousands of companies for high-performance data pipelines, streaming analytics, data integration, and mission-critical applications. When you create a Kafka Message Queue source, Zeotap CDP connects to the broker host you supply, authenticates with the broker API key and secret where the broker requires authentication, and reads messages from the topic you name, identifying itself with the consumer group ID you provide. Messages are read as either **AVRO** or **JSON**. For **AVRO**, Zeotap CDP also connects to your schema registry with the registry URL and credentials so that the schema behind each message can be resolved. Once the connection between Zeotap and Kafka is established, the records read from the topic become visible on the source's **PREVIEW DATA** tab and flow on into ingestion. ## Create the Kafka Message Queue source Perform the following steps in the Zeotap CDP App. ### 1. Open the Sources application Log into the **Zeotap CDP App** and navigate to the **Sources** application under **Integrate**, then click **CREATE SOURCE**. ### 2. Choose the category and the data source Choose **Message Queue** as the Category. ![Source creation screen with Message Queue selected as the Category](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-139.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=14d2e1ca0f5c751a65c3a802778b6277) Then click **Kafka Message Queue** as the Data Source. ![Data Source list for the Message Queue category, with Kafka Message Queue selected](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-140.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=9866e10725d217d9e53493733ef56e54) ### 3. Name the source and set the region and data entity 1. Enter a short and descriptive name for the source. 2. By default, the region is chosen as **Europe (EU)**. See [Region of Storage](/articles/integrate-customer/region-of-storage) for how Zeotap resolves the storage region. 3. Under **Data Entity**, depending on the type of data that you want to ingest, choose either **Customer Data** or **Non Customer Data** and proceed with the source creation. To know more about Customer Data and Non Customer Data, see [Supported Data Entities](/articles/unify-customer/supported-data-entities). ### 4. Enter the Kafka connection details Enter the **Topic name**, **Kafka Broker Host**, **Broker API Key**, **Broker API Secret** and **Consumer group ID** obtained from your Kafka account, as listed in [Prerequisites](#prerequisites). ### 5. Select the data format Select the format of data that will be sent from Kafka. The supported formats are **AVRO** and **JSON**. ![Data format field on the Kafka source creation form, offering AVRO and JSON](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-141.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=b1fef50a2b727403f6085ef3b7e02587) If **AVRO** is selected, also enter the **Schema Registry URL**, **Schema Registry Key** and **Schema Registry Secret** from your Kafka account. If **JSON** is selected, the schema registry fields do not apply. ### 6. Create the source and review the implementation details Click **CREATE SOURCE**. Upon successful creation, all the fields that were entered while creating the source are displayed under the **IMPLEMENTATION DETAILS** tab, along with all the important information related to the integration, as shown below. ![IMPLEMENTATION DETAILS tab of a created Kafka source, listing the connection fields entered during creation](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-142.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=083dfddfa8e1d8d01ab4837c89d1747e) ## Verify the source is receiving data The source is wired up correctly when all of the following hold: * The values on the **IMPLEMENTATION DETAILS** tab match the topic name, broker host and consumer group ID you intended to connect to. * The source status on the source listing moves from **Created** to **Integrated** once data begins flowing into it. While the status is still **Created**, no data has arrived yet. * Messages read from your Kafka topic appear as records under the **[PREVIEW DATA](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab)** tab of the source. If nothing appears after your producers have written to the topic, work through the table below. ## Troubleshoot the Kafka source | Condition | What it usually means | Where to look | | - | - | - | | The source status stays **Created** and the **PREVIEW DATA** tab is empty | The connection between Zeotap and Kafka is not yet established, or no messages have been published to the topic | The **IMPLEMENTATION DETAILS** tab for the topic name and broker host, and your Kafka deployment for whether producers are writing to that topic | | Producers are writing to the topic, but the **PREVIEW DATA** tab stays empty | One of the connection values does not match the cluster — the broker host, the topic name, or, where the broker requires authentication, the broker API key and secret | The **listeners** property in **server.properties**, or your cloud provider's Kafka management interface — in Confluent Cloud, the **API Keys** section under the **Cluster Settings** tab | | **AVRO** was selected and no records appear | The schema registry values do not resolve the schema for the topic's messages | The **Schema Registry** section of the Confluent Cloud dashboard, or the configuration settings of your Kafka deployment — re-check the Schema Registry URL, key and secret | | Records arrive, but individual records are rejected | A field value does not match the type or format expected at ingestion | The ingestion log in the source report — see [Understanding the Ingestion Log Error](/articles/integrate-customer/understanding-the-ingestion-log-error) | > [!TIP] > > To be told by email when a source stops receiving data or when ingestion starts failing, subscribe to [Source Alerts](/articles/integrate-customer/source-alerts). Alerts are opt-in, so a source failure will not reach your inbox until an address is subscribed for your organisation. ## FAQ > [accordion] Is Kafka a source or a destination in Zeotap CDP? > > It is both, as two separate integrations. The Kafka Message Queue **source** on this page reads messages from your topic into Zeotap CDP. The [Apache Kafka destination](/articles/integrate-customer/apache-kafka-destination) does the opposite — it sends event information from Zeotap CDP out to a topic in Kafka, through the Journeys module. Creating one does not create the other. > [accordion] Which data formats can the Kafka source read? > > **AVRO** and **JSON**. If you select **AVRO**, you must also supply the Schema Registry URL, Schema Registry Key and Schema Registry Secret so that the schema behind each message can be resolved. ## Next steps * Explore the [Preview Data tab →](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) to read the records your Kafka topic has delivered. * Explore the [Apache Kafka destination →](/articles/integrate-customer/apache-kafka-destination) to send data from Zeotap CDP out to a Kafka topic. * Explore [Message Queue →](/articles/integrate-customer/message-queue) for the other message queue sources Zeotap CDP supports. * Explore [Source Alerts →](/articles/integrate-customer/source-alerts) to be notified when a source stops receiving data. # Components of the Preview Data Tab Source: https://docs.zeotap.com/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab Read a sample of the records ingested from a source under the Preview Data tab, so you can confirm what arrived before mapping it in the Catalogue. ## What this is The **Preview Data** tab shows a sample of the records the Zeotap CDP has ingested from a source, so you can confirm the shape of what arrived before you map the fields in the Catalogue. The sample is drawn from the last five ingested files, and internal fields added by the platform are rendered in grey so you can distinguish them from the external fields you supplied. Once data begins flowing into a source, the source status changes to **Integrated** and the Preview Data tab is populated. ## Prerequisites > [!NOTE] > > Before Preview Data returns a sample: > > * The source must be created and its implementation completed for the source type (for example, credentials configured, files uploaded, or the streaming endpoint wired up). > * The source must have received at least one file or event. If the source status on the Source Listing page is still **Created**, no data has arrived yet. ## Read the Preview Data table The Preview Data screen displays a tabular sample of ingested records. Each column corresponds to a field in the ingested file; internal fields added by the platform are shown in grey to separate them from your external fields. ![Preview Data tab showing a tabular sample of ingested records with column headers](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/knowing-the-fields-on-the-preview-data-tab/knowing-the-fields-on-the-preview-data-tab-2024-03-19-1.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=702d668860f1bf22314738e51be7c3f3) A well-formed input file with clear, unique headers renders cleanly in the preview. For example, a CSV with the following shape produces four preview columns: ```csv theme={null} customer_id,email,first_name,purchase_date 1001,alice@example.com,Alice,2024-11-15 1002,bob@example.com,Bob,2024-11-16 ``` If any header cell is empty or the file format is invalid, the affected rows are excluded from the sample and raised as entries in **View Error Log** instead. ## Use the Preview Data controls The Preview Data screen exposes three controls. The table below describes each option and its function. | Sl No. | Option | Description | | - | - | - | | 1 | **View Error Log** | Opens the list of errors detected in the ingested file before Catalogue mapping. Examples include missing column names and file-format issues. For the full list of error scenarios you can encounter on the Preview Data tab, see the [Preview Errors reference](https://docs.zeotap.com/resources/Storage/integrate-customer/Preview%20Errors.xlsx). | | 2 | **Refresh** | Redraws the preview using the latest records from the last five ingested files, and displays the last refreshed date and time for reference. | | 3 | **Column Filters** | Filters the preview to specific columns. Options include selecting all fields, selecting all internal fields, and clearing the current selection. | ![Column Filters options on the Preview Data tab](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/knowing-the-fields-on-the-preview-data-tab/knowing-the-fields-on-the-preview-data-tab-2024-03-19-2.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=0f30e8f40dca37521d4319e7d2d83257) ## Verify the preview is working Preview Data is functioning correctly when all of the following are true: * The source status on the Source Listing page is **Integrated** (not **Created**). * The Preview Data tab shows a tabular sample of records with visible column headers. * Both external columns and internal (grey) columns are present in the sample. * The last-refreshed timestamp updates after you use **Refresh**. ## Why this happens If the Preview Data tab shows no records, or displays an error message in place of a sample, one of the following causes is at work. The error text below is what the tab surfaces to you; **Where to look** points to the place in the app that confirms it. | Error string | What it means | Where to look | | - | - | - | | `No data has been received. Ensure to implement the source correctly and check again later` | The source is created but has not yet received any records | Source Listing page — the source status is **Created**, not **Integrated** | | Missing column names | The ingested file has empty or duplicate header cells | **View Error Log** on the Preview Data tab | | File-format issue | The uploaded file is not in a supported format | **View Error Log** on the Preview Data tab | To resolve an empty or errored preview: 1. Verify that the source implementation is complete for your source type. If the source status remains **Created** on the Source Listing page, the platform has not received data yet — finish the implementation for that source type and wait for the next ingestion. 2. Use the **View Error Log** option on the Preview Data tab to read the specific errors reported for the ingested file. 3. Correct the source file in your own system — for example, fix missing or duplicate header cells and confirm the file format matches what the source type supports — and re-ingest. 4. Use **Refresh** on the Preview Data tab to redraw the sample from the latest ingested files. If preview remains empty after you re-ingest a corrected file, contact Zeotap support at [support@zeotap.com](mailto:support@zeotap.com). Include your source ID, the timestamp of the last ingestion attempt, and the error text shown in **View Error Log**. ## FAQ > [accordion] Why are some columns in the preview shown in grey? > > Grey columns are internal fields added by the platform (for example, ingestion metadata). Columns in the standard colour are the external fields from your ingested file. The grey styling exists so you can distinguish the two at a glance. > [accordion] Why does the preview change every time I refresh it? > > The Preview Data tab shows a sample drawn from the last five ingested files. Each **Refresh** redraws that sample, so the specific rows you see change even though they are all recent records from your source. > [accordion] Where can I see the full list of preview errors? > > The Preview Data tab surfaces the most common errors inline via **View Error Log**. For the complete catalogue of error scenarios and their meanings, download the [Preview Errors reference](https://docs.zeotap.com/resources/Storage/integrate-customer/Preview%20Errors.xlsx) linked from the controls table above. ## Next steps | **Sl No.** | **Option** | **Description** | | - | - | - | | 1 | **View Error Log** | This option enables you to review a list of errors in the data of the dropped file before mapping in the Catalogue. Examples include missing column names, issues with file format and more. For a comprehensive list of error scenarios that you may encounter while working with the *Preview Data* tab, see the [Preview Error Scenarios](#preview-error-scenarios) table below. | | 2 | **Refresh** | This option enables you to refresh the sample data displayed under the Preview Tab. Upon refreshing, it presents a different set of the latest sample data from the last five ingested files. It also provides the last refreshed date and time for your reference. | | 3 | **Column Filters** | This option allows you to conveniently filter and view specific columns in the given preview. Use appropriate options to select All fields, select all the internal fields, clear the selections and more as per your requirement. ![](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/knowing-the-fields-on-the-preview-data-tab/knowing-the-fields-on-the-preview-data-tab-2024-03-19-2.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=0f30e8f40dca37521d4319e7d2d83257) | ## Preview Error Scenarios The following table lists the error scenarios that you may encounter while working with the **Preview Data** tab, along with a description of each: | **Preview Error Scenarios** | **Description** | | :- | :- | | An error occurs if an object contains objects as properties. | This error message is displayed when an object contains another object as one of its properties. The user is prompted to fix the issue to enable mapping. | | An error arises when an object or array is not defined in the correct syntax or format. | This error message is displayed when the data within an object or array is not defined in the correct syntax or format. The user is notified about unsupported syntax or format errors in the specified source field and prompted to rectify the issue to enable mapping. | | If an object or array of objects contains more properties or keys than the supported number for mapping, an error occurs. | This warning message is triggered when an object or array of objects contains more properties or keys than the supported limit for mapping. Users are informed that the specified source field exceeds the limit of 15 properties per object for mapping, and they are advised to reach out to their Customer Success Manager for an upgrade. | | The system encounters an error when a column name is missing in the ingested file. | This error message is displayed when the ingested file lacks a column name. Users are instructed to reupload the file with complete details to resolve the issue. | | If the ingested file is in an unsupported file type, an error is triggered. | This error message appears when the ingested file is of an unsupported file format. Users are informed about the unsupported file format and advised to replace it with a supported format. | | Duplicate column names in the ingested file lead to an error. | This error message is displayed when the ingested file contains duplicate column names. Users are instructed to reupload the corrected file without duplicate column names to resolve the issue. | | An error arises if there is a mismatch in file type between the type mentioned in the source setup and the ingested file. | This error message appears when there is a mismatch between the file type mentioned in the source setup and the ingested file. Users are informed about the mismatch and instructed to correct it to proceed. | | If there is a delimiter mismatch between the mentioned delimiter in the source setup and the ingested file, an error occurs. | This error message is displayed when there is a mismatch between the delimiter mentioned in the source setup and the one used in the ingested file. Users are informed about the mismatch and prompted to rectify either the file type or delimiter issue. | | The system encounters an error when there is a syntax error or a corrupt record issue. | This message is displayed when the ingested file contains unsupported syntax or format errors. Users are prompted to fix the issue in the file to enable mapping. | # LaunchDarkly Source: https://docs.zeotap.com/articles/integrate-customer/launchdarkly Send Zeotap CDP audiences out to LaunchDarkly as segments, so a feature flag can serve a variation to the customers who qualified. ## What this is The LaunchDarkly destination sends audiences **out of** Zeotap CDP and into LaunchDarkly, where each audience arrives as a segment that a feature flag can target. Nothing flows back the other way: the [Integrations Master List](/articles/integrations-master-list-publication/integrations-master-list) records LaunchDarkly as a Destination only, so there is no LaunchDarkly source page to read alongside this one. LaunchDarkly is a feature management platform that lets development teams deliver, control and measure their software through feature flags, and run experiments on any flag. A feature flag — also called a feature toggle or feature switch — turns a feature of an application on or off at runtime, so a team can control who sees a feature without deploying new code. Once a Zeotap CDP audience has arrived as a segment, you can add a targeting rule on a flag that serves a particular variation to everyone in that segment. Zeotap CDP ships two separate LaunchDarkly destinations: * **LaunchDarkly** — this page. A batch destination, linked to an audience in the **Audiences** application, that sends the audience as a segment. * **[LaunchDarkly Real Time Integration](/articles/integrate-customer/launchdarkly-real-time-integration)** — a real-time destination, attached to a **Send to Destinations** node in a journey, that sends identifiers as customers flow through. Both send data in the same direction — out of Zeotap CDP to LaunchDarkly. Choose the one that matches where you are activating from, Audiences or Journeys. > [!NOTE] > > The destination catalogue in Zeotap CDP lists this integration as **Launch Darkly**, as two words. Search for it that way when you create the destination. ## Supported identifiers and actions This integration supports Custom IDs — any ID that is activated within LaunchDarkly, such as User IDs, CRM IDs or any other ID you hold for the same person on both sides. | Action | [ID extension](/articles/segment-customer/extend-your-audience#id-extension) | [Delete](/articles/segment-customer/delta-upload-and-delete-functions) | [Delta upload](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | **Send Identifiers to Launch Darkly** | Not supported | Not supported | Not supported | The destination exposes a single action. Because delta upload and delete are not supported, each refresh sends the audience membership as it stands when the refresh runs. ## Prerequisites In Zeotap CDP: * An account with permission to create and edit destinations. For the wider destination model — platforms, actions and mappings — see [Destinations](/articles/integrate-customer/destinations#prerequisites). * An [audience](/articles/segment-customer/create-an-audience) holding the customers you want to target. In LaunchDarkly: * A LaunchDarkly account. * Access to **Settings → Authorization**, so you can create the access token described below. * Access to **Settings → All projects**, so you can read the Client-side ID of the environment you want to send to. * A feature flag to hang the targeting rule on, in the project and environment you are sending to. Gather both LaunchDarkly values — the [access token](#access-token) and the [Client-side ID](#client-side-id) — before you start creating the destination, because the destination form asks for both. ## Get the LaunchDarkly details you need ### Access token An access token in LaunchDarkly authenticates calls and controls what they may do. Create one for this integration as follows. **Step 1** Log into the LaunchDarkly console and navigate to **Settings → Authorization**. **Step 2** Under **Access tokens**, click **Create token**. ![The LaunchDarkly Authorization page, showing an empty Authorized applications panel above an Access tokens panel that lists two existing service tokens with the Writer role, with Authorization highlighted in the left navigation and the Create token button highlighted on the right](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/launchdarkly/Dark_access_token_1.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=e03f830172d42ddd2e51980c69260db1) The Authorization page of LaunchDarkly Settings, with Create token highlighted **Step 3** In the **Create access token** window that appears, provide the following details: a. Enter a **Name** for your access token. b. Choose **Writer** as the **Role** for the token from the drop-down menu. c. Choose the **API version** for the token from the drop-down menu. By default, API requests you send using this token use this API version. For how API versioning works in LaunchDarkly, see LaunchDarkly's own [Versioning documentation](https://apidocs.launchdarkly.com/#section/Overview/Versioning). d. If you are an Enterprise customer, select the **This is a service token** checkbox if you want to create a service token. ![LaunchDarkly Create access token dialog showing a Name field containing the placeholder entry test, a Role drop-down set to Writer, an API version drop-down, a This is a service token checkbox with explanatory text, and a Save token button](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/launchdarkly/dark_access_token_2.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=41a2fd425960c4d57a591ebc34ff68f3) The Create access token dialog, with the Name, Role and API version fields and the service token checkbox **Step 4** Review the details and click **Save token**. The new token is listed on the **Authorization** page. Copy the token and store it somewhere safe now — LaunchDarkly hides the value once you leave the page, and you enter it in the **Access Token** field when you create the destination in Zeotap CDP. If you lose it, create a replacement token rather than trying to read the old one back. ![LaunchDarkly Access tokens list showing three service token rows, each carrying the Writer role and a Created by you creator, with the newest row highlighted and a Copy and save this token callout below it warning that the token is hidden after you leave the page](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/launchdarkly/dark_launchly_access_token_3_\(1\).png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=e643cfaed57d2abe61630b51e6049653) The Access tokens list after saving, with the new token's Copy and save this token callout ### Client-side ID The Client-side ID identifies one environment of one LaunchDarkly project, so the value you copy decides which environment your audiences land in. Obtain it as follows. **Step 1** Log into your LaunchDarkly account and navigate to **Settings → All projects**. **Step 2** Select the project you want to link to Zeotap CDP. It opens on **All environments**. ![The LaunchDarkly project list, showing a projects table with Name, Tags and Environments columns and one project row](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/launchdarkly/launch_darkly_client_side_id_1.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=77bbc95dca3c2a47bd49875b5a9cfee5) The LaunchDarkly project list, reached from Settings **Step 3** Click the **…** menu next to the environment you want to link with Zeotap CDP, select **View SDK keys**, and copy the value under **Client-side IDs**. You enter it in the **Client Side ID** field when you create the destination. ![The LaunchDarkly SDK keys page for the Production environment, reached from Settings, showing a Client-side IDs section above the SDK keys and Mobile keys sections, with the client-side ID value redacted](https://mintcdn.com/zeotap/uk9W2o5jwT8Od0S5/articles/integrate-customer/Storage/integrate-customer/launchdarkly/launchdarkly-sdk-keys-2026-10-30.png?fit=max\&auto=format\&n=uk9W2o5jwT8Od0S5\&q=85\&s=e47a68e84bc734890bbb92b43e2040c3) The SDK keys page of a LaunchDarkly environment, with the Client-side IDs section at the top > [!NOTE] > > A project can hold several environments, and each one has its own Client-side ID. Copy the ID of the environment whose feature flags you intend to target — a production audience sent with a test environment's ID will only ever appear in that test environment. ## Create the LaunchDarkly destination **Step 1** Log in to the Zeotap CDP app and go to **Integrate → Destinations**. **Step 2** Click **+ Create Destination**. ![Zeotap CDP Integrate Destinations screen listing existing destinations in a table, with the Create Destination button highlighted at the top right](https://mintcdn.com/zeotap/sBMx_EDYCwiX_b1v/articles/integrate-customer/Storage/integrate-customer/rtb-house/RTB_H1.png?fit=max\&auto=format\&n=sBMx_EDYCwiX_b1v\&q=85\&s=989bf48b86088d10e9d6c3b3b8bc0448) The Zeotap CDP Destinations listing, with Create Destination highlighted **Step 3** Under **All Destinations**, search for **Launch Darkly**. ![Zeotap CDP All Destinations catalogue with the Search for a Destination box highlighted above a grid of destination tiles](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/rtb-house/RTB_H2.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=4c1d1c71f84cc22f0a9975e76200c682) The All Destinations catalogue, with the Search for a Destination box highlighted **Step 4** Click the **Launch Darkly** tile. A panel describing the destination appears on the left, and the fields the integration needs appear on the right. Enter: a. A **Destination Name**. Choose a name that identifies the LaunchDarkly account and environment it connects to, so the destination is easy to pick out when you link an audience. b. The **Access Token** you created in the **Authorization** tab of your LaunchDarkly account — see [Access token](#access-token). c. The **Client Side ID** of the LaunchDarkly environment you want to send to — see [Client-side ID](#client-side-id). d. Review the values you entered, then click **Next**. ![Zeotap CDP Enter Destination Details screen for Launch Darkly, showing Destination Name, Access Token and Client Side ID fields holding placeholder entries, a description panel for the destination on the left, a Destination Details and Mapping progress indicator, and a Next button](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/launchdarkly/Launchdarkly_11.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=9299a76cfde8d3487326c218be438f09) The Enter Destination Details step for Launch Darkly, with the Destination Name, Access Token and Client Side ID fields **Step 5** On the **Mapping** screen, choose the action and the field mapping: a. Under **Choose your Action**, select **Send Identifiers to Launch Darkly**. b. Under **Map the Fields**, map the Catalogue field that carries the ID to the matching LaunchDarkly destination field — in the capture below, the Catalogue field **User Id** is mapped to the destination field **User ID** under **Identifiers**. The [output identifiers](/articles/segment-customer/choose-the-output-identifiers) the platform accepts are shown by default, and you can edit, add or remove an identifier from the list; for the rules that govern actions and mappings across every destination, see [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). ![Zeotap CDP Mapping screen with Send Identifiers to Launch Darkly selected under Choose your Action, and a Map the Fields table under an Identifiers heading pairing the Catalogue field User Id with the destination field User ID, above a Create Destination button](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/launchdarkly/Lauchdarkly_12.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=c67aae6775fb81c8bb8d0320e82d96db) The Mapping step, with Send Identifiers to Launch Darkly chosen and a Catalogue field mapped to a LaunchDarkly destination field **Step 6** Click **Create Destination**. The destination is then listed in the **Audiences** application, ready to be linked to an audience. For the two entry points into destination configuration and what each part of the configuration does, see [Configure a destination](/articles/integrate-customer/destinations#configure-a-destination). ## Link an audience to the destination Once the destination is created, link it to the audience you want to activate from the **Audiences** application — see [Activate in Audiences](/articles/integrate-customer/link-an-audience-to-the-destination#activate-in-audiences) for the end-to-end workflow, including refresh frequency and the output identifier mapping. > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience or a segment can be a specific group of customers who are over 18 years of age and have performed an `addToCart` event within the last 30 days. > [!NOTE] > > The destination form notes that segments can take up to two business days to become available on the LaunchDarkly side. Allow for that before treating a missing segment as a failure. ## Target the segment on a feature flag Once an audience has been linked to the destination and the segment has arrived, add a targeting rule in LaunchDarkly so a flag serves a variation to the people in it. **Step 1** Log into LaunchDarkly and navigate to **Feature flags**. **Step 2** Choose the feature flag you want to target from the list. ![LaunchDarkly Feature flags list showing one flag row with its key, creation date, serving variation, targeting-modified date and an on-off toggle, with Feature flags highlighted in the left navigation](https://mintcdn.com/zeotap/sBMx_EDYCwiX_b1v/articles/integrate-customer/Storage/integrate-customer/rtb-house/view_seg_in_LD_1.png?fit=max\&auto=format\&n=sBMx_EDYCwiX_b1v\&q=85\&s=a11753649450aa13fb82b1e7613d39ae) The LaunchDarkly Feature flags list **Step 3** On the flag's **Targeting** tab, click the **Add rule** drop-down and choose **Target segments**. This creates a new rule section. ![LaunchDarkly flag Targeting tab with the Add rule drop-down open, listing Target segments, Target individuals, Target mobile, Build a custom rule and Set prerequisites, with Target segments highlighted above an existing rule and the Default rule section](https://mintcdn.com/zeotap/sBMx_EDYCwiX_b1v/articles/integrate-customer/Storage/integrate-customer/rtb-house/view_seg_in_LD_2.png?fit=max\&auto=format\&n=sBMx_EDYCwiX_b1v\&q=85\&s=ecb13a11fe0125febef268bc2a125926) The Add rule drop-down on a flag's Targeting tab, with Target segments highlighted **Step 4** In the new rule, open the **Segments** drop-down to see the audiences pushed from Zeotap CDP. > [!NOTE] > > A Zeotap CDP audience only appears in this list once the LaunchDarkly destination has been created and linked to at least one audience. **Step 5** Choose the audience you want the flag to apply to, set the variation the rule serves, and save the flag. ![LaunchDarkly flag targeting rule with a Context is in Segment condition above a second rule whose Segments drop-down is open, showing a Most targeted segments group and a Recently updated segments group listing several named segments with their last-modified dates](https://mintcdn.com/zeotap/sBMx_EDYCwiX_b1v/articles/integrate-customer/Storage/integrate-customer/rtb-house/view_seg_in_LD_3.png?fit=max\&auto=format\&n=sBMx_EDYCwiX_b1v\&q=85\&s=bc9f2c9980d87bef0280db26f27b7c5f) The Segments drop-down on a targeting rule, listing the segments available to the flag ## Verify the audience reached LaunchDarkly Check both sides after the first refresh has run. 1. **In Zeotap CDP** — open the audience–destination pair in the **Audiences** application and confirm the run has completed with a non-zero qualified count. For what the statuses mean across destinations, see [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). 2. **In LaunchDarkly** — open a feature flag in the target environment, add or edit a rule that targets segments, and confirm the audience is listed in the **Segments** drop-down. The list groups the most targeted segments above the recently updated ones, with the date each was last modified, so you can tell a fresh delivery from a stale one. Allow up to two business days between a successful Zeotap CDP run and the segment appearing in LaunchDarkly. ## Troubleshoot the LaunchDarkly destination | Symptom | What it means | What to do | | - | - | - | | The audience does not appear in the **Segments** drop-down | The destination has not been linked to an audience yet, or the delivery has not surfaced on the LaunchDarkly side | Confirm the destination is linked to at least one audience in the **Audiences** application and that the run completed, then allow up to two business days before treating it as a failure | | The segment appears in a different LaunchDarkly environment from the one you are looking at | The **Client Side ID** on the destination belongs to another environment of the project — each environment has its own | Re-read the **Client-side ID** under **View SDK keys** for the environment you intend to target, and correct it on the destination | | The destination fails to authenticate | The access token recorded on the destination is no longer valid — it may have been deleted or replaced in **Settings → Authorization** | Create a new token with the **Writer** role, copy it at creation time, and update the **Access Token** on the destination. LaunchDarkly hides a token's value after creation, so an old token cannot be read back | | The run completes but far fewer people are matched than the audience holds | The Custom ID mapped on the destination is not the ID LaunchDarkly knows those users by | Review the destination's mapping and confirm the mapped Catalogue field carries the same ID that is activated within LaunchDarkly | | A change to the audience is not reflected in LaunchDarkly | Delta upload is not supported on this integration, so changes arrive with the next full refresh rather than immediately | Wait for the next scheduled refresh, or check [what influences upload time to destinations](/articles/segment-customer/factors-influencing-the-data-upload-time-to-destinations) | For delivery errors that are not specific to LaunchDarkly — no customers qualified, a terminated refresh, a rejected payload — see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail) and [When to contact support](/articles/integrate-customer/destinations#when-to-contact-support). ## FAQ > [accordion] Why are there two LaunchDarkly entries in the destination catalogue? > > They are two integrations for the same vendor, distinguished by where you activate from. **LaunchDarkly** — this page — is a batch destination linked to an audience in the **Audiences** application. **[LaunchDarkly Real Time Integration](/articles/integrate-customer/launchdarkly-real-time-integration)** is a real-time destination attached to a **Send to Destinations** node in a journey. Both send data out of Zeotap CDP to LaunchDarkly. > [accordion] Which LaunchDarkly environment do my audiences land in? > > The one whose **Client-side ID** you entered on the destination. A LaunchDarkly project can hold several environments and each has its own Client-side ID, so the value on the destination decides where the segments appear. To send to more than one environment, create a separate destination for each. > [accordion] Do I have to create the segment in LaunchDarkly before linking an audience? > > No. Link the audience to the destination and the segment becomes available to target on the LaunchDarkly side; you then add the targeting rule on the flag that should use it. > [accordion] Does this destination support ID extension, delta upload or delete? > > No. None of the three is supported on this integration, so each refresh sends the audience as it stands at that moment. See [Delta upload and delete functions](/articles/segment-customer/delta-upload-and-delete-functions) for the destinations where delta upload and delete are available. > [accordion] Can one destination serve several audiences? > > Yes. The destination stores the LaunchDarkly credential, the environment and the mapping, so it can be linked to as many audiences as you need. Each audience arrives as its own segment and can be targeted by a different flag. ## Next steps * [Set up the real-time LaunchDarkly destination →](/articles/integrate-customer/launchdarkly-real-time-integration) * [Link the audience to the destination →](/articles/integrate-customer/link-an-audience-to-the-destination#activate-in-audiences) * [Review how destinations, actions and mappings fit together →](/articles/integrate-customer/destinations) * [Build the audience that feeds this destination →](/articles/segment-customer/create-an-audience) * [Check what influences upload time to destinations →](/articles/segment-customer/factors-influencing-the-data-upload-time-to-destinations) # LaunchDarkly real-time integration Source: https://docs.zeotap.com/articles/integrate-customer/launchdarkly-real-time-integration Send identifiers from a Zeotap CDP journey to LaunchDarkly so feature flags can target a segment built in Zeotap CDP. ## What this is This is an outbound destination: data flows out of Zeotap CDP to LaunchDarkly. From a journey in Orchestrate, Zeotap CDP sends identifiers to LaunchDarkly as a segment, so that segment can be used to target a feature flag. Nothing flows back from LaunchDarkly into Zeotap CDP. LaunchDarkly is a feature management platform that lets development teams deliver, control and measure their software through feature flags, and run experiments on any flag. With this destination, the customers you have filtered or split into a branch in a journey become a segment that a LaunchDarkly flag can target. LaunchDarkly also has a batch destination, which sends an audience from the **Audiences** application rather than from a journey. If you want a scheduled audience delivery instead of a journey-triggered one, see [LaunchDarkly](/articles/integrate-customer/launchdarkly). Both lanes are configured with the same two LaunchDarkly credentials. ## Supported identifiers and actions This destination supports **Custom IDs** — any ID that is activated within LaunchDarkly, such as a user ID or a CRM ID. It exposes a single action, **Send Identifiers to Launch Darkly**. In the mapping for that action you map one Catalogue identifier field to the destination field **User ID**. ## Prerequisites Before you start, make sure you have: * A LaunchDarkly account, and the LaunchDarkly project and environment you want to link to Zeotap CDP. * An access token created in LaunchDarkly. See [Create an access token](#create-an-access-token). * The Client-side ID of that LaunchDarkly environment. See [Find the Client-side ID](#find-the-client-side-id). * A journey in Zeotap CDP with the filters or conditions that select the customers you want to send. ## Get the LaunchDarkly credentials ### Create an access token An access token in LaunchDarkly authenticates and controls access to your feature flags and experiments. To create one: **Step 1** Log into the LaunchDarkly console and go to **Settings** **>** **Authorization**. **Step 2** Under **Access tokens**, click **Create token**. ![The LaunchDarkly Authorization page, with the Access tokens section and the Create token button.](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/launchdarkly/Dark_access_token_1.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=e03f830172d42ddd2e51980c69260db1) **Step 3** In the **Create access token** window, provide the following details: a. Enter a **Name** for your access token. b. Choose the **Role** as **Writer** from the drop-down menu. c. Choose the **API version** for your token from the drop-down menu. By default, API requests you send using this token use this API version. For more information about how API versioning works in LaunchDarkly, refer [here](https://apidocs.launchdarkly.com/#section/Overview/Versioning). d. If you are an Enterprise customer, select the **This is a service token** checkbox if you want to create a service token. ![The Create access token dialog, with Name, Role, API version and the This is a service token checkbox.](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/launchdarkly/dark_access_token_2.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=41a2fd425960c4d57a591ebc34ff68f3) **Step 4** Review the details and click **Save Token**. The new access token is listed on the **Authorization** page. ![The Access tokens list on the Authorization page after a token is saved, with LaunchDarkly's warning to copy and save the token before leaving the page.](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/launchdarkly/dark_launchly_access_token_3_\(1\).png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=e643cfaed57d2abe61630b51e6049653) > [!WARNING] > > Copy the token and store it securely now. LaunchDarkly hides the value once you leave the page, and you cannot retrieve it again — if you lose it, create a new token. ### Find the Client-side ID The Client-side ID belongs to a single environment inside a LaunchDarkly project, so copy the one for the environment you want to link. To find it: **Step 1** Log into LaunchDarkly and go to **Settings > All projects**. **Step 2** Select the project you want to link to Zeotap CDP. It opens on **All environments**. ![The LaunchDarkly project list, showing a project and its environment count.](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/launchdarkly/launch_darkly_client_side_id_1.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=77bbc95dca3c2a47bd49875b5a9cfee5) **Step 3** Click the **…** menu next to the environment you want to link with Zeotap CDP, select **View SDK keys**, and copy the value under **Client-side IDs**. You use it when you create the destination. ![The LaunchDarkly SDK keys page for the Production environment, reached from Settings, showing a Client-side IDs section above the SDK keys and Mobile keys sections, with the client-side ID value redacted](https://mintcdn.com/zeotap/uk9W2o5jwT8Od0S5/articles/integrate-customer/Storage/integrate-customer/launchdarkly/launchdarkly-sdk-keys-2026-10-30.png?fit=max\&auto=format\&n=uk9W2o5jwT8Od0S5\&q=85\&s=e47a68e84bc734890bbb92b43e2040c3) ## Create the LaunchDarkly destination Once you have applied filters or added conditions for your users in Journeys, you activate them from the **Send to Destinations** node in the journey. The node opens a panel where you can pick an existing destination or create a new one with **+ Add New Destination**. ![The Send to Destinations panel in a journey, showing destination cards and the + Add New Destination link.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/launchdarkly-real-time-integration/launchdarkly-real-time-integration-2024-08-07.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=91250672a4c22a911b600959ccf16779) To create the destination: **Step 1** Click **+ Add New Destination**. **Step 2** Search for **Launch Darkly**. **Step 3** Click **Launch Darkly** and enter a name for the destination. **Step 4** Enter the **Access Token** and **Client Side ID** from your LaunchDarkly account, then click **Next**. ![The Enter Destination Details step, with the Destination Name, Access Token and Client Side ID fields.](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/launchdarkly-real-time-integration/launchdarkly-real-time-integration-2024-08-07-1.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=7ace7b0e8530dd02a746374e6fdf07a4) **Step 5** On the mapping screen, under **Choose your Action**, select **Send Identifiers to Launch Darkly**. Under **Map the Fields**, map the Catalogue field you want to send to the destination field **User ID**. ![The Mapping step with the action Send Identifiers to Launch Darkly selected and a Catalogue identifier mapped to the User ID destination field.](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/launchdarkly-real-time-integration/launchdarkly-real-time-integration-2024-08-07-2.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=93a85ae8fd4210707183e99984b8725f) **Step 6** Click **Create Destination**. The destination is created and becomes available for activation in Journeys. > [!NOTE] > > The destination form states that it can take up to two business days for segments to be available at the Launch Darkly channel seat, so a newly created destination may not deliver a visible segment immediately. For the general behaviour of actions and mappings across destinations, see [Configure a destination](/articles/integrate-customer/destinations#configure-a-destination) and [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). ## Add the destination to your journey After creating the destination, link it in the **Send to Destinations** node of the workflow. **Step 1** In the workflow, click **+** and choose **Send to Destinations**. ![The Choose an action menu on a journey node, with Send to Destinations highlighted.](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/launchdarkly-real-time-integration/launchdarkly-real-time-integration-2024-08-07-3.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=9984676da5699bd2585c5dcacc481ea5) **Step 2** Find your destination in the list of available destinations using the search box. ![The Send to Destinations panel with the search box highlighted above the available destination cards.](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/launchdarkly-real-time-integration/launchdarkly-real-time-integration-2024-08-07-4.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=74c091bcce232ad84e7b373e333ed957) **Step 3** On the **Destination Details** tab, the **Access Token** and **Client Side ID** fields are already filled in from the values you entered when you created the destination. In **Segment Name** and **Segment Id**, enter a name and an ID to categorise your users. ![The Destination Details tab of the Launch Darkly node, showing the Destination Name, Access Token, Client Side ID, Segment Name and Segment Id fields.](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/launchdarkly-real-time-integration/launchdarkly-real-time-integration-2024-08-07-5.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=a5009ffa0827927f860d700d2e36cfde) **Step 4** On the **Destination Settings** tab, choose the action and mapping you need. The mapping's identifiers are listed below it, and **Edit Mapping** lets you change them. ![The Destination Settings tab, showing the selected action and mapping and the identifiers included in that mapping.](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/launchdarkly-real-time-integration/launchdarkly-real-time-integration-2024-08-07-6.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=fe8eb9da7b1c6683b64c9c85f590c5a3) **Step 5** Click **Save Destination**. The destination is attached to the node. ![The Send to Destinations node with the Launch Darkly destination attached, above the remaining available destinations.](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/launchdarkly-real-time-integration/launchdarkly-real-time-integration-2024-08-07-7.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=4e139cac76c3a01e3e3da4dca9d665c9) > [!NOTE] > > The terms Audiences and Segments are used interchangeably to refer to customer cohorts belonging to a specific category. ## Verify the segment reaches LaunchDarkly In LaunchDarkly, segments pushed from Zeotap CDP appear when you target segments on a feature flag: open **Feature flags**, choose a flag, add a **Target Segments** rule, then expand **Select Segments**. The batch LaunchDarkly page walks through that screen in [View Segments on LaunchDarkly](/articles/integrate-customer/launchdarkly). Two things to keep in mind while checking: * The destination form warns that segments can take up to two business days to be available at the Launch Darkly channel seat, so an empty **Select Segments** list immediately after setup is not necessarily a failure. * On the Zeotap CDP side, use [Journey traces](/articles/orchestrate-customer/journey-traces) to see whether customers reached the **Send to Destinations** node. ## Troubleshoot the integration > [accordion] The destination does not appear in the Send to Destinations node > > The destination has to exist before you can attach it. Create it first with **+ Add New Destination** in the node's panel, as described in [Create the LaunchDarkly destination](#create-the-launchdarkly-destination), then search for it again. > [accordion] The segment is not in the Select Segments list in LaunchDarkly > > Check that the destination is attached to the journey node and that the journey has run. Then allow for the delivery window the destination form describes — up to two business days for segments to be available at the Launch Darkly channel seat. > [accordion] The segment shows up against the wrong LaunchDarkly environment > > The Client-side ID identifies a single environment inside a LaunchDarkly project. Reopen the environment via **View SDK keys**, copy the Client-side ID of the environment you intended, and compare it with the **Client Side ID** on the destination. > [accordion] You did not save the access token > > LaunchDarkly hides a token's value after you leave the page, and it cannot be recovered. Create a new access token under **Settings** **>** **Authorization** and update the destination with it. > [accordion] Customers are not reaching the node at all > > This is a journey problem rather than a destination one. See [Journey troubleshooting](/articles/orchestrate-customer/journey-troubleshooting) and [Journey error codes](/articles/orchestrate-customer/journey-error-codes). ## Next steps > [card] [LaunchDarkly (batch)](/articles/integrate-customer/launchdarkly) > > Send an audience to LaunchDarkly from the Audiences application instead of from a journey. > [card] [Destinations](/articles/integrate-customer/destinations) > > How actions, mappings and destinations work across Zeotap CDP. > [card] [Add or delete a node](/articles/orchestrate-customer/add-or-delete-a-node) > > Work with the Send to Destinations node and the rest of the journey canvas. > [card] [Journey traces](/articles/orchestrate-customer/journey-traces) > > Trace individual customers through a journey to confirm a delivery happened. # Activate Your Batch Audiences Source: https://docs.zeotap.com/articles/integrate-customer/link-an-audience-to-the-destination Link a saved audience to a destination so Zeotap CDP delivers the matching profiles to that platform on the schedule you choose. ## What this is Activating a batch audience means linking a saved audience to a destination so Zeotap CDP delivers the matching profiles to that platform on the schedule you choose. Zeotap CDP separates three concerns: the audience (who), the destination (where the data goes), and the mapping (which catalogue fields translate to which destination fields). > [!NOTE] > > The terms **Audiences** and **Segments** refer interchangeably to customer cohorts belonging to a specific category — for example, customers over 18 years of age who performed an `addToCart` event within the last 30 days. ## Prerequisites Before you start, confirm the following: * An audience created in the **Audiences** module. See [Create an Audience](https://docs.zeotap.com/articles/segment-customer/create-an-audience). * Access to the Zeotap CDP App with permission to activate audiences. * A destination already available in the **Select Destination** panel. If the one you need does not exist, create it first from the **Destinations** module. See [Create a Destination](/articles/integrate-customer/create-a-destination). * A mapping between catalogue fields and destination fields. If no mapping exists, add one during activation using **+ Add New Mapping**. * To share third-party data with the destination, contact your Zeotap point of contact — availability depends on the destination's data acceptance policy. ## Activate an audience from the Audiences module Once you have created an audience with the desired criteria, link it to a destination as follows. **1. Open the audience's activation menu** Log in to the Zeotap CDP App and go to **Segment > Audiences**. Search for the audience you want to activate, click the **Audience Activation** icon, then click **View Activation**. ![Audience Activation icon and the activation option on an audience row in the Audiences module](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/link-an-audience-to-the-destination/link-an-audience-to-the-destination-2023-11-22.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=ae4267faa9a5311d3ca1d10d95917f5f) **2. Choose the destination** Drag and drop the destination onto which you want to link the audience from the **Select Destination** panel. If the destination is not available, create it first from the **Destinations** module. See [Create a Destination](/articles/integrate-customer/create-a-destination). ![Drag and drop a destination to link it to the audience](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/link-an-audience-to-the-destination/link-an-audience-to-the-destination-2023-11-07-4.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=ae686fa65488e97f99c33dcb2f2b5f14) **3. Open the Destination Settings window** The **Destination Settings** window opens for the destination you selected. Every remaining step on this page is completed in this window. ![Destination Settings window opened for the selected destination](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/link-an-audience-to-the-destination/link-an-audience-to-the-destination-2023-11-07-5.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=15e406caf16b146a2ad3766cb707a3e6) **4. Choose the action and mapping** In the **Destination Settings** window, under **Choose your Action and Mapping**, pick the use case from the left dropdown and the corresponding mapping from the right dropdown. If the mapping you need does not exist, click **+ Add New Mapping**. ![Choose your Action and Mapping dropdowns in the Destination Settings window](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/link-an-audience-to-the-destination/link-an-audience-to-the-destination-2023-11-07-6.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=b336ba357637dc85fb38088310f8f4b3) **5. Confirm the output identifiers** The [output identifiers](/articles/segment-customer/choose-the-output-identifiers) attached to that mapping appear under **Mapping**, listed as **Attributes**. Only the fields shown here are sent to the destination; you can edit the mapping if you need a different set. ![The mapping section of the Destination Settings window, listing the attributes sent to the destination](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/link-an-audience-to-the-destination/link-an-audience-to-the-destination-2023-11-07-7.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=3f4fe1880913f399b4db805e72557f44) **6. Enable Audience Boost** Where the destination supports enrichment, an **Enable Audience Boost** section appears. Under it, select **3P lookalike extension** if you want to enrich the uploaded audience through a third-party graph lookup. It runs independently of audience boost. > [!NOTE] > > **3P lookalike extension is being deprecated.** For long-term enrichment, use [Audience Boost](/articles/segment-customer/audience-boost) instead. To include third-party data, contact your Zeotap point of contact — availability depends on the destination's data acceptance policy. **7. Check the channel consent rule** If a consent rule is configured for the selected mapping, or for its parent channel or destination, it is applied automatically on top of your audience definition before activation. Where none is configured, the section reports that no channel consent rule is present. **8. Set the refresh frequency** Under **Refresh Frequency**, pick an interval in days, weeks, or months, and provide a start date for the refresh cycle. > [!TIP] > > To send the audience once with no repeating refresh, select the **One-time push** option. ![Refresh Frequency settings with the interval and date options](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/link-an-audience-to-the-destination/link-an-audience-to-the-destination-2023-11-07-9.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=6b99653c6590834eec532e645e4739a5) **9. Save the destination** Click **Save Destination**. The destination transitions to `In Progress` while Zeotap CDP uploads the IDs to the platform. Once all IDs are uploaded, the status changes to `Success`. ![Destination status transitioning from In Progress to Success](https://mintcdn.com/zeotap/N2x6le2iGwMeelJt/articles/integrate-customer/Storage/integrate-customer/link-an-audience-to-the-destination/link-an-audience-to-the-destination-2023-11-07-10.png?fit=max\&auto=format\&n=N2x6le2iGwMeelJt\&q=85\&s=8bf295008c3f96a14bf6a31c19c6849b) > [!NOTE] > > You can also create the destination from the **Destinations** module first, then link it to the audience here. See [Create a Destination](/articles/integrate-customer/create-a-destination). ## Verify that activation succeeded For an audience linked from the **Audiences** module, open the audience and check the destination status: * `In Progress` — Zeotap CDP is uploading matched IDs to the destination. * `Success` — All matched IDs have been uploaded. The destination is now delivering the audience on the refresh cadence you configured. ## Troubleshooting If the destination status does not progress to `Success`, use the reference below to identify the current state and pick the next action. | Status / State | What it means | Where to look | | - | - | - | | `In Progress` | Zeotap CDP is uploading matched IDs to the destination. Wait for the upload to complete before taking further action. | Audiences module → destination status | | `Success` | All matched IDs have been uploaded to the destination. Delivery continues on the refresh cadence you configured. | Audiences module → destination status | If the destination configuration will not save, confirm that **Refresh Frequency** has a start date, or that **One-time push** is selected. If the destination you need is not available in the destination picker, add it from the **Destinations** module and return to activation. See [Create a Destination](/articles/integrate-customer/create-a-destination). For file-based destinations, Zeotap CDP writes the audience as CSV files into your configured cloud storage. The file name follows a predictable pattern — for example: ```text theme={null} Adobe-Campaign-Test_Part1_20231117092450237.csv ``` If files are not appearing in your storage location, confirm the destination credentials and the storage path in the destination configuration. ## FAQ > [accordion] Can I link one audience to more than one destination? > > Yes. Repeat the activation flow for the same audience against each destination you want to deliver to. Each linked destination carries its own mapping and its own refresh frequency. > [accordion] What happens if I do not set a start date for the refresh cycle? > > The start date sets when the refresh cycle begins. Either set a start date under **Refresh Frequency**, or select **One-time push** to send the audience a single time. > [accordion] Which identifiers get sent to the destination? > > Only the fields displayed under **Mapping** in the destination settings are sent. Edit the mapping if you need a different set. > [accordion] How do I include a lookalike extension? > > In the destination settings, under **Enable Audience Boost**, select **3P lookalike extension**. It is being deprecated — for long-term enrichment use [Audience Boost](/articles/segment-customer/audience-boost) instead. ## Next steps * [Explore how to configure the Batch CEP destination →](/articles/integrate-customer/batch-audience-management) * [Explore how to configure the Adobe Campaign destination →](/articles/integrate-customer/adobe-campaign) * [Explore how to configure the Batch destination →](/articles/integrate-customer/batch) * [Explore how to configure the Iterable Campaign Trigger destination →](/articles/integrate-customer/iterable-campaign-trigger-audience) # LinkedIn destination Source: https://docs.zeotap.com/articles/integrate-customer/linkedin Activate Zeotap audiences as Matched Audiences in your LinkedIn Campaign Manager Ad Account using SHA256 emails or MAIDs. ## What this is The LinkedIn destination activates Zeotap audiences as Matched Audiences inside your LinkedIn Campaign Manager Ad Account. You authorise Zeotap against a LinkedIn user with Ad Account access, map your output identifiers (SHA256-hashed emails or MAIDs / Google AID), and link audiences to push contact-targeting lists into LinkedIn ads. This page covers destination creation, audience linking, verification in Campaign Manager, campaign attachment, and ongoing token maintenance. ## Prerequisites > [!NOTE] > > Before you start, confirm you have: > > * Access to the **Destinations** application in your Zeotap CDP workspace. > * A LinkedIn login with access to the LinkedIn Campaign Manager Ad Account where audiences will be activated. If your Customer Success Manager (CSM) administers the Ad Account on your behalf, the CSM can complete the OAuth step as the destination owner. > * Source identifiers that resolve to one of the supported identifier types below. ### Supported identifiers and actions This integration supports **SHA256-hashed emails** and **MAIDs (Google AID)**. | Action | [ID Extension](/articles/segment-customer/extend-your-audience#id-extension) | [Delete](/articles/segment-customer/delta-upload-and-delete-functions) | [Delta Upload](/articles/segment-customer/delta-upload-and-delete-functions) | | - | - | - | - | | Send identifiers to LinkedIn | ✅ | ✅ | — | If your source data carries raw email addresses, hash them with SHA256 over the lowercased, trimmed value so they align with LinkedIn member matching: ```python theme={null} import hashlib def sha256_email(email: str) -> str: return hashlib.sha256(email.strip().lower().encode("utf-8")).hexdigest() sha256_email("Alice@Example.com") # returns a 64-character lowercase hex SHA256 digest ``` ## Create the LinkedIn destination 1. Sign in to the Zeotap CDP App and open the **Destinations** application. ![](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_1.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=92dfe8ecb29e59c9d7d57cb954e54618) 2. Click **+ Create Destination**, then under **All Channels** search for **LinkedIn** and select it. ![](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_2.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=6f5f0f5367788fb4e9e946f4b3cb5874) 3. Configure the destination details: * Enter a **name** for the destination. * Enter the **Client name** — a placeholder label your team will recognise when listing destinations. * Click **Connect LinkedIn**. ![](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/linkedin/linkedin-2023-11-08.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=4ff2f1adb8c58b4fc9f431713905f4b6) 4. > [!NOTE] > > You are redirected to LinkedIn. Sign in with the account that has access to the target Ad Account and accept the requested permissions. ![](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/linkedin/linkedin-2023-11-08-1.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=864595f0970342392a4b75bc7aa8c360) 5. Choose the **Ad Account** to bind this destination to. The **Access Token** and **Refresh Token** populate automatically along with each token's expiry date. ![](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/linkedin/linkedin-2023-11-08-2.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=d06363a01796f46870be2d88cf319388) > [!WARNING] > > If a working LinkedIn destination already exists for this Ad Account, do **not** create a second one with the same details. Reuse the existing destination instead. 6. Click **Next** to proceed to mapping. 7. Under **Choose your Action**, select **Send identifiers to LinkedIn**. Under **Map the Fields**, select the identifiers to send (SHA256 emails, MAIDs, or both). The default list shows the [output identifiers](/articles/segment-customer/choose-the-output-identifiers) accepted by the platform; edit, add, or remove entries as needed. See [Destinations → Mappings](/articles/integrate-customer/destinations#mappings) for mapping rules. ![](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/linkedin/linkedin-2023-11-08-3.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=5134836cb4e2304c083dfae8e2575659) 8. Click **Create Destination**. The new destination is listed in the **Audiences** application, ready to be linked to an audience or segment. ## Link an audience to the destination Follow [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination) to attach a Zeotap audience to your LinkedIn destination. Once linked, the audience's refresh schedule controls when records are pushed. > [!NOTE] > > A few things to know about pushing segments to LinkedIn: > > * Segments take up to **two days** to appear at the LinkedIn seat after activation. > * **Audiences** and **Segments** describe the same object — a customer cohort matching a defined criterion (for example, customers over 18 who triggered `addToCart` in the last 30 days). > * Apply the Zeotap Graph extension to derive activatable online identifiers from your first-party offline identifiers (email, phone, cookies, device IDs), increasing the addressable LinkedIn reach. ## Verify the audience reached LinkedIn The destination is working when your Zeotap audience appears in LinkedIn Campaign Manager with a non-zero Match rate. 1. > [!NOTE] > > Sign in to LinkedIn Campaign Manager and open **Audiences**. ![](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/linkedin-2023-05-12-4.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=911c7f4e10373abb4aabe16a506bfff3) 2. Locate the audience by the name you gave it in Zeotap and check three fields: * **Match rate** — the percentage of your uploaded list that matched LinkedIn members for contact targeting. See LinkedIn's [Match rate documentation](https://www.linkedin.com/help/lms/answer/a420595). * **Status** — indicates whether the audience is ready to be used or needs attention. An audience must reach the ready-to-use state before you can attach it to a campaign. * **Last modified** — timestamp of the last update from Zeotap. A value within your audience refresh window confirms the latest sync landed. If the audience does not appear after two days, jump to [Troubleshoot connection and token issues](#troubleshoot-connection-and-token-issues). For more on Matched Audience definitions, see [LinkedIn's Matched Audiences help](https://www.linkedin.com/help/lms/answer/a795242). ## Attach the audience to a campaign 1. > [!NOTE] > > In LinkedIn Campaign Manager, open **Advertise → Campaigns**. 2. Under the **Campaigns** tab, click **Create → Campaign**. ![](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-63.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=ba70c42ff547417315826d43474c35a4) 3. Confirm the pre-filled Campaign Group settings and click **Next**. ![](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/linkedin-2023-05-12-6.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=783efd3afe8299408fa79568ce729d0e) 4. Under **Who is your target audience?**, click **Audiences → Third party → Third Party Contact**. ![](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/linkedin-2023-05-12-7.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=4bab88d1e53d7e50979016a07d6c7eb0) 5. Select the Zeotap segment and continue with the rest of the campaign setup. ![](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/linkedin-2023-05-12-8.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=0c93e481ffc4fbe60bf7d4c7a0e6743f) ## Maintain access and refresh tokens LinkedIn issues two OAuth tokens when you connect the destination: * **Access Token** — valid for **60 days**. Zeotap renews it automatically using the Refresh Token. * **Refresh Token** — valid for **1 year**. When the Refresh Token expires, the destination owner must reauthorise the destination. Both tokens can be revoked at any time for technical or policy reasons. If either token expires or is revoked, Zeotap cannot push audiences to this destination — recreate the destination by repeating the OAuth flow above on receipt of the expiry or revocation notification. ## How user disqualification works When a user no longer matches an audience's criteria (criteria change, consent withdrawal, or other audience conditions), Zeotap CDP issues a user-deletion request to LinkedIn in the next refresh cycle. Disqualified users are excluded from the LinkedIn audience on the refresh frequency configured for that audience. This runs automatically — no manual trigger is required. ## Troubleshoot connection and token issues ### Why this happens Audience activation to LinkedIn fails for one of a small set of reasons — almost always token expiry, token revocation, lost Ad Account access, or an identifier-format mismatch on LinkedIn's side. | Error condition | What it means | Where to look | | - | - | - | | Access Token expired | The 60-day Access Token expired and was not renewed by the Refresh Token | Destinations → LinkedIn destination → token expiry date | | Refresh Token expired | The 1-year Refresh Token expired; full reauthorisation required | Destinations → LinkedIn destination → token expiry date | | Token revoked | A LinkedIn admin or policy event revoked the token | LinkedIn account security settings; destination status in Zeotap | | Ad Account access removed | The LinkedIn user who authorised the destination lost access to the Ad Account | LinkedIn Campaign Manager → user roles on the Ad Account | | Match rate is 0 or very low | Identifiers are not in a form LinkedIn can match (unhashed, wrong case, wrong identifier type) | LinkedIn Campaign Manager → Audiences → **Match rate** column | ### Resolve token expiry or revocation 1. In Zeotap, open the **Destinations** application and select the affected LinkedIn destination. 2. Recreate the destination by running the OAuth flow from [Create the LinkedIn destination](#create-the-linkedin-destination) again. The new token pair replaces the expired or revoked pair. 3. Reattach the destination to the affected audiences if the original destination was removed. To verify the fix worked: the destination's token expiry date moves forward, and the next audience refresh delivers records to LinkedIn within two days. ### Resolve a low or zero match rate 1. Confirm your source identifiers are SHA256-hashed emails or MAIDs (Google AID). LinkedIn rejects unhashed email values for this integration. 2. Re-hash emails over the lowercased, trimmed value (see the snippet in [Prerequisites](#prerequisites)). 3. Trigger an audience refresh and recheck the **Match rate** in LinkedIn Campaign Manager 48 hours later. ## When to contact support Open a support ticket when: * You completed the OAuth flow but the destination remains in an error state after one full refresh cycle. * The audience appears in LinkedIn Campaign Manager but the Match rate stays at 0% after a second refresh with correctly-hashed identifiers. * You see a destination behaviour not described on this page. **Include in your request:** * The destination name and the LinkedIn Ad Account ID. * The audience name and ID. * Timestamp of the last successful refresh (from the Audiences listing). * The current token expiry date shown in the destination configuration. * A screenshot of the Match rate, Status, and Last modified columns from LinkedIn Campaign Manager → Audiences. ## FAQ > [accordion] How long after activation does the audience appear in LinkedIn? > > Segments take up to two days to appear at the LinkedIn seat after the first activation. Subsequent refreshes push delta records on the audience's configured refresh frequency. > [accordion] Do I need to hash emails before sending them to Zeotap? > > The LinkedIn integration requires SHA256-hashed emails. Hash over the lowercased, trimmed value — see the snippet in Prerequisites. MAIDs (Google AID) are sent unhashed. > [accordion] What happens when a user no longer qualifies for the audience? > > Zeotap issues a user-deletion request to LinkedIn in the next refresh cycle. Disqualified users are excluded from the LinkedIn Matched Audience automatically; no manual action is required. > [accordion] Can I reuse one OAuth connection for multiple destinations against the same Ad Account? > > No. Create one destination per Ad Account, and do not duplicate destinations for the same Ad Account. If a working destination already exists, link your audience to it rather than creating a second one. ## Next steps * [Explore audience linking → Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore identifier coverage → Extend your audience with ID Extension](/articles/segment-customer/extend-your-audience#id-extension) * [Explore output identifier choices → Choose the output identifiers](/articles/segment-customer/choose-the-output-identifiers) * [Explore delta and delete behaviour → Delta upload and delete functions](/articles/segment-customer/delta-upload-and-delete-functions) * [Explore the full destination catalog → Integrations master list](/articles/integrations-master-list-publication/integrations-master-list) # Looker Source: https://docs.zeotap.com/articles/integrate-customer/looker Send Zeotap CDP audiences out as CSV files into a Google Cloud Storage bucket, then connect those files to Looker Studio as a data source. ## What this destination does This is a **destination**: it sends data out of Zeotap CDP. The Looker destination delivers an audience — the identifiers and attributes you map — as CSV files into a Google Cloud Storage (GCS) bucket you own, and you then connect those files to Looker Studio as a data source. Delivery runs in two hops: Zeotap CDP writes the CSV files to your bucket, and Looker Studio reads them from that bucket through its Google Cloud Storage connector. This page covers both hops: gathering the bucket details, creating the destination in Zeotap CDP, linking an audience to it, recognising the files that land in your bucket, and connecting one of those files to Looker Studio. Looker Studio (formerly Google Data Studio) is Google's free business intelligence tool that builds interactive dashboards and reports from data sources such as Google Analytics, spreadsheets, and databases. It offers a drag-and-drop interface for customisable charts and visualisations that can be shared and worked on collaboratively in real time, which makes it a common choice for turning exported audience data into visual reports. To bring data the other way — into Zeotap CDP — use the [Zeotap Google Cloud Storage source](/articles/integrate-customer/zeotap-google-cloud-storage) instead. > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an Audience or a segment could be a specific group of customers who are over 18 years of age and who have performed an `addToCart` event within the last 30 days. ## Prerequisites > [!NOTE] > > Before you create the destination, make sure you have: > > * An account with **Looker Studio**. > * An account with **Google Cloud Storage**, and a bucket you can write to. > * The **bucket name** and the **folder path** inside that bucket where the exported files should land. > * The authentication you intend to use: either the **Zeotap Service Account**, which you whitelist on your bucket, or a **client service account JSON** file you upload during configuration. ## Supported identifiers and actions This is a batch integration that activates an audience. You can send any identifiers and attributes you have mapped in the Catalogue. | Action | What Zeotap CDP sends | | :- | :- | | **Send CSV to Looker** | The identifiers and attributes you map, written as CSV files into the bucket and folder you configure. | ## Gather your Google Cloud Storage details Collect the following three details from your Google Cloud Storage account before you start; you enter all of them on the destination configuration screen. ### Bucket The name of your Google Cloud Storage bucket. You obtain it from your Google Cloud Storage account, as shown below. ![Bucket name shown in the Google Cloud Storage console](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/gcs_bucket.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=27a98eddfc923035a9733033c5c0fc10) ### Folder A folder serves as a logical container for organising stored objects within a bucket. In reality there are no actual folders in Google Cloud Storage — the folder concept is emulated by object key names containing slashes (`/`) to replicate a hierarchical arrangement. You obtain the folder path from your Google Cloud Storage account, as shown below. ![Folder path inside a bucket in the Google Cloud Storage console](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/gcs_folder.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=ee827f65a647fe9656d55c7b3a13717c) ### Account The account Zeotap CDP uses to write into your bucket. If you choose the Zeotap Service Account, whitelist that service account on your bucket so audiences (segments) can be pushed from Zeotap CDP to Google Cloud Storage. ## Create the Looker destination in Zeotap CDP **1. Open the Destinations application** Log into the Zeotap CDP App and go to the **DESTINATIONS** application. **2. Start a new destination** Click **+ Create Destination**. ![Create Destination button in the Destinations application](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/ADOBE_DMP_3_\(1\).png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=562fa59a1a1e2b76442fa98f6e6f991e) **3. Select the Looker destination** Under the **All Destinations** section, search for **Looker Audience** and select it. ![Searching for a destination under the All Destinations section](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/ADOBE_DMP_4_\(1\).png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=653728565c7ed5863548171765d4086f) **4. Enter the destination details** A screen appears showing details about the destination on the left, and on the right the fields required to establish the integration. Provide the following: a. Enter a name for the destination. b. In the **Destination Instance Name** field, provide a desired value for this internal field. c. In the **Bucket** field, provide the name of the Google Cloud Storage bucket. d. In the **Folder** field, provide the folder path in your storage location where Zeotap CDP can store your exported data. > [!NOTE] > > Provide the folder path using the structure `folder_name/sub_folder_name/`. e. Under **Account**, choose either **Zeotap Service Account** or **Client Service Account Json** from the drop-down menu, based on the type of authentication you need. ![Account drop-down with the Zeotap Service Account and Client Service Account Json options](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/google-cloud-storage-2024-05-08.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=4035a760431f47f9e2282dd46a2e57d4) * **Zeotap Service Account** — the service account provided by Zeotap CDP auto-populates under **Service Account to be Whitelisted**. Whitelist it on your bucket so that audiences (segments) can be pushed from Zeotap CDP to the Google Cloud Storage platform. ![Service Account to be Whitelisted auto-populated for the Zeotap Service Account](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/google-cloud-storage-2024-05-08-1.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=80b9f59a37bb2c7b8b83268ea131378a) * **Client Service Account Json** — upload the JSON file holding the required authentication information using the **+ Select File** option, so that Zeotap CDP can push audiences to the Google Cloud Storage platform. ![Uploading a client service account JSON file using the Select File option](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/google-cloud-storage-2024-05-08-2.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=a5bc85536732956d054503de1b2bc797) f. Review all the values entered above and then click **Next** to proceed. ![Completed Enter Destination Details form for a Looker destination before clicking Next](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/looker/looker-2025-09-03.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=ad10ea788c69e1580c5a437f3348047a) **5. Choose the action and map the fields** On the mapping screen, under **Choose your Action**, select **Send CSV to Looker** as the action for activating your audience in Audiences. Under **Map the Fields**, map each Catalogue field you want to send to its destination field, adding rows with **+ Add Mapping Field**. ![Mapping screen with Send CSV to Looker selected and a Catalogue field mapped to a destination field](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/looker/looker-2025-09-03-1.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=f0557ea517d32a5c6b94f84611f28709) **6. Create the destination** After finalising the attributes and identifiers to send, click **Create Destination**. The created destination gets listed in the **Audiences** application, where it can be linked to an audience. ## Link an audience to the destination For information about how to link an audience (segment) to the created destination in the Audiences application, see [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination). ## Understand the exported file names After an audience is linked to the destination, Zeotap CDP generates segment files in CSV format in your bucket. Two naming patterns are documented for this destination. The destination configuration describes the file name as: ``` ${filenamePrefix}part-${sequence}_${destinationAudienceId}_${timestamp}.csv ``` Here the timestamp is the file generation time in epoch milliseconds (UTC), and `destinationAudienceId` is the ID associated with your audience (segment) in Zeotap CDP, generated after the audience is linked to a destination. An example file name is: ``` exportpart-0_894548842_1722931200000.csv ``` ![Channel ID 894548842 highlighted on a linked audience, matching the ID in the example file name](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/integrate-customer/amazon-s3-destination/amazon-s3-destination-2025-08-06-1.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=9815ce4ace2add60e912e2a98028d8d4) The files identified in the Google Cloud Storage bucket are described as: ``` {filenamePrefix}{fileNumber}_${channelId}_${timestamp}.csv ``` Here the timestamp is in epoch format. For a multipart upload, the format is: ``` {partNumber}_{filenamePrefix}{fileNumber}_${channelId}_${timestamp}.csv ``` The parts of the names are: | Variable | Description | | :- | :- | | `filenamePrefix` | The prefix on the file name, typically indicating the context or purpose of the file (for example, the segment or export type). | | `part-${sequence}` | A sequential number indicating the part or chunk number when the data is split across multiple files. | | `{fileNumber}` | Appears in the bucket-side naming pattern above. This page does not define it. | | `{partNumber}` | The part of a multipart upload in Google Cloud Storage. Multipart uploads let you upload large files in several parts or chunks rather than uploading the entire file in one go. `Part0` refers to the first part of the multipart upload. | | `${destinationAudienceId}` / `${channelId}` | The ID associated with your audience (segment) in Zeotap CDP, generated after the audience (segment) is linked to a destination. | | `${timestamp}` | The time the file was generated, in epoch milliseconds (UTC) — for example, `1722931200000`. Both patterns use the same format. | | `.csv` | The file extension, indicating that the file is in CSV (comma-separated values) format. | You can obtain the **Channel ID** from the audience details in the Audiences application, as shown below. ![Channel ID highlighted on the audience details drawer in the Audiences application, shown here for a Google Cloud Storage destination](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/google-cloud-storage-2024-05-08-3.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=ab92718b7e470b1333769c4f5a6b2eb6) Worked example: an audience named **PublicAbove18** with **Channel ID** `12345678`, a **filename prefix** `testprefix`, and a **file number** `98765`, uploaded to Google Cloud Storage as the first part of a multipart upload with the epoch timestamp `1625138600`, is named: ``` Part0_testprefix98765_12345678_1625138600.csv ``` ## Connect the CSV file to Looker Studio To add a CSV file from your Google Cloud Storage bucket as a data source in Looker Studio, follow these steps. **1. Navigate to Looker Studio** Open your Looker Studio dashboard. **2. Create a new data source** In the top-left corner, click **+ Create** and then select **Data Source**. ![Create button in the top-left corner of the Looker Studio home page](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/looker/looker-2025-09-03-2.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=d4c62eded529132868e0d3dd09fc7562) **3. Select the Google Cloud Storage connector** From the list of Google Connectors, choose **Google Cloud Storage**. **4. Authorise access** If you are connecting to Google Cloud Storage for the first time, you are prompted to authorise Looker Studio to access your Google Cloud Storage data. Click **AUTHORIZE**. **5. Specify the file path** In the **Select a data source** panel, provide the full path to your CSV file in the bucket, in the format `gs://your-bucket-name/your-file-name.csv`. You can also navigate to the file by selecting your project and then browsing through your buckets and folders. **6. Configure data source options (optional)** Configure additional options such as the character encoding of your CSV file. **7. Connect** Click **CONNECT** in the top-right corner. **8. Configure the fields** Looker Studio displays the fields from your CSV file. Adjust the data type, aggregation, and other properties for each field. **9. Create a report or explore** Once you are satisfied with the field configurations, click **CREATE REPORT** or **EXPLORE** to start building your visualisations. ## Verify the destination is working Work through these checks in order: 1. After you click **Create Destination**, the destination appears in the destination list inside the **Audiences** application. 2. After you link an audience to it and the next activation run completes, CSV files appear in your bucket under the folder path you configured. 3. The file names carry the filename prefix and the Channel ID of the linked audience, matching one of the patterns above. 4. In Looker Studio, after you point the Google Cloud Storage connector at one of those files and click **CONNECT**, the fields you mapped are listed on the field configuration screen. ## Troubleshooting | Symptom | What it means | Where to look | | :- | :- | :- | | No files arrive in the bucket after an activation run | The account selected under **Account** cannot write to your bucket — either the Zeotap Service Account was never whitelisted on the bucket, or the client service account JSON you uploaded cannot write to it | Your bucket's permissions in Google Cloud Storage; the **Account** and **Service Account to be Whitelisted** values on the destination | | Files land in the bucket but the expected attributes are missing | The mapping does not include those Catalogue fields | Zeotap CDP → your destination → **Map the Fields** | | Looker Studio cannot open the file | The path entered in the **Select a data source** panel does not match the bucket, folder, and file name, or Looker Studio has not been authorised against the Google Cloud Storage account that owns the bucket | The `gs://your-bucket-name/your-file-name.csv` path in Looker Studio; the authorisation prompt for the Google Cloud Storage connector | ## FAQ > [accordion] Which Google product does this destination work with? > > Looker Studio, formerly Google Data Studio. In the Zeotap CDP destination list it appears as **Looker Audience**, and its action is **Send CSV to Looker**. > [accordion] Why do I need a Google Cloud Storage account as well as Looker Studio? > > Zeotap CDP does not write into Looker Studio directly. It writes the audience as CSV files into a Google Cloud Storage bucket you own, and Looker Studio reads those files from the bucket through its Google Cloud Storage connector. > [accordion] Do I have to whitelist the Zeotap Service Account? > > Only if you choose **Zeotap Service Account** under **Account**. If you choose **Client Service Account Json** and upload your own service account JSON file, Zeotap CDP authenticates with that account instead. > [accordion] Which identifiers and attributes can I send? > > Any identifiers and attributes available in your Catalogue. You choose them on the mapping screen with **+ Add Mapping Field**. ## Next steps * [Explore linking an audience to this destination →](/articles/integrate-customer/link-an-audience-to-the-destination) — activate an audience against the destination you just created * [Explore the Google Cloud Storage destination →](/articles/integrate-customer/google-cloud-storage) — deliver audiences to a bucket without the Looker Studio step * [Explore Google Cloud Storage as a source →](/articles/integrate-customer/zeotap-google-cloud-storage) — bring data from a bucket into Zeotap CDP * [Explore how destinations work →](/articles/integrate-customer/destinations) — actions, mappings, and the activation layer of Zeotap CDP # Message Queue Source: https://docs.zeotap.com/articles/integrate-customer/message-queue Message Queue sources bring data into Zeotap CDP from a queue your own systems publish to — Google Pub/Sub Stream and Google Pub/Sub Batch. ## What this is **Message Queue** is a Zeotap CDP source category: it brings data **into** Zeotap CDP from a queue that your own systems already publish to. You keep publishing messages the way you do today, and Zeotap CDP subscribes to the topic as one more consumer, so the system that produces the data never has to connect to Zeotap CDP directly. A message is a piece of information that another system processes. It can be an actual payload, such as a file, or metadata that triggers processing in another sub-system. A queue receives those messages in a specific order and forwards them to the subscribing application in the same order. Because the queue sits between the two sides, the sender and the recipient stay decoupled: each operates at its own pace, and consumers retrieve messages when they are ready to process them, which makes the processing asynchronous. Message Queue sources carry both Customer Data (CE) and Non-Customer Entity (NCE) data. **Message Queue** is also the **Category** you select in the Sources module when you create either of the Pub/Sub integrations below. ## Prerequisites > [!NOTE] > > Before you create a Message Queue source, confirm: > > * The topic already exists in your own Google Cloud Pub/Sub or Apache Kafka account, and you can obtain its connection details. ## How pub/sub messaging works In conventional messaging, a message is sent directly from a sender to one specific receiver, and the sender must know the receiver's address to deliver it. That creates tight coupling between the sender and the receiver, which makes it harder to scale the application or add new recipients. In pub/sub messaging, publishers do not need to know the identity or location of the receivers. Publishers send messages to a topic or channel, subscribers interested in that topic register themselves, and the pub/sub system delivers each message to every interested subscriber. In every Message Queue source you point Zeotap CDP at one of your topics, and Zeotap CDP consumes from it. ## Supported Message Queue sources > [card] [Pub/Sub Stream](/articles/integrate-customer/pub-sub-stream) > > Consume Google Pub/Sub messages in real time, as soon as they are published to the topic. > [card] [Pub/Sub Batch](/articles/integrate-customer/pub-sub-batch) > > Send many messages to a Google Pub/Sub topic in a single request, for large numbers of messages processed together. > [card] [Kafka](/articles/integrate-customer/kafka_message_queue) > > Ingest from an Apache Kafka topic using a consumer group. AVRO and JSON payloads are supported. Kafka may not appear in your Message Queue catalogue — check with your Zeotap contact before you plan the integration. > [!NOTE] > > Apache Kafka also exists as a Zeotap CDP **destination**, which moves data the other way — out of Zeotap CDP and into your Kafka topic. See [Apache Kafka](/articles/integrate-customer/apache-kafka-destination). Google Pub/Sub also exists as a Zeotap CDP **destination**, which sends data out of Zeotap CDP into your Pub/Sub topic through Journeys. See [Google Pub/Sub](/articles/integrate-customer/google-pub-sub). ## Next steps * [Create a Pub/Sub Stream source](/articles/integrate-customer/create-a-pub-sub-streaming-source) * [Create a Pub/Sub Batch source](/articles/integrate-customer/create-a-pub-sub-batch-source) * [Kafka](/articles/integrate-customer/kafka_message_queue) — prerequisites and creation steps for the Kafka source * [Sources](/articles/integrate-customer/sources) — all nine source categories and how to choose one # Meta Custom Audience Source: https://docs.zeotap.com/articles/integrate-customer/meta-custom-audience Create a Meta Custom Audience destination in Zeotap CDP using the OAuth Connect flow, and activate audiences to a Facebook Ad Account without generating an access token. ## What this is Meta Custom Audience pushes a Zeotap CDP audience into a Facebook Ad Account as a Custom Audience, so you can target or suppress those users in Meta campaigns. It delivers the same audiences as the [Facebook 1P](/articles/integrate-customer/facebook-1p) destination. The difference is how the destination is authorised: Meta Custom Audience uses an OAuth **Connect** flow, so you sign in to Facebook once and Zeotap holds the connection, rather than generating an access token in the Facebook Developers portal and pasting it in. Both destinations are supported — pick whichever authorisation model suits your team. ## Supported actions, identifiers, and features | Action | Supported identifiers/attributes | Supported features | | - | - | - | | Send identifiers to Meta | MAIDs; Email address (SHA256); Phone number (SHA256); [Facebook External ID](#facebook-external-id) | Audience Boost and Delete | | Send identifiers to Meta (hashed External ID) | As above, with the Facebook External ID supplied already hashed | Audience Boost and Delete | | Send Multiple User Identifiers to Facebook 1P | MAIDs; Email address (SHA256); Phone number (SHA256); Gender; Date of birth; First Name and Last Name; State; City; ZIP Code; Country Code; [Facebook External ID](#facebook-external-id) | Audience Boost and Delete | > [!TIP] > > To raise the match rate, use **Send Multiple User Identifiers to Facebook 1P** so every identifier on a profile is sent as a single user record. ### Facebook External ID A Facebook External ID is a unique string that represents a user on an advertiser's system — for example, a loyalty membership ID, internal user ID, or external cookie ID. For a given event, Facebook uses the `external_id` to match a record to a user on its platform. Before sending an External ID to Facebook, [add the identifier in your Zeotap Catalogue](/articles/unify-customer/add-a-catalogue-field), then map it when you create the destination. For background, see Meta's [Custom Audiences External Identifiers guide](https://developers.facebook.com/docs/marketing-api/audiences/guides/custom-audiences/#external_identifiers). See [How External IDs flow between a brand and Facebook](#how-external-ids-flow-between-a-brand-and-facebook) for the end-to-end capture flow. ## Prerequisites Complete the following before you create the destination in Zeotap CDP: * **Full Access to a Facebook Ad Account** — the 16-digit Facebook Ad Account ID linked to your Facebook Business Manager, with **People with full control** access for the user who will authorise the connection. * **Accepted Facebook Audiences Terms of Service** — the ad account has accepted the Custom Audiences ToS at [business.facebook.com/ads/manage/customaudiences/tos/](https://business.facebook.com/ads/manage/customaudiences/tos/?act=). This has been mandatory since September 2021. * **Your Facebook Graph API version** — for example, `23.0`. Enter only the numerical part when configuring the destination; do not include the `v` prefix. You do **not** need to create an app in the Facebook Developers portal or generate an access token — the OAuth flow authorises Zeotap directly. > [!NOTE] > > The destination screen still lists **Access Token** among its components, and the **API Version** hint still refers to finding the version "along with the Access Token". Both are carried over from the token-based destination and do not apply here — there is no Access Token field on this form. ### Grant Full Access to the Ad Account Confirm your Facebook user has full control of the Ad Account that will receive audience data. From Facebook Business Manager at [business.facebook.com](https://business.facebook.com/), select the business portfolio in the top-right corner, open **Settings → Accounts → Ad Accounts**, select the ad account, and open **Ad Account Access**. Under **People with full control**, your account must appear. To grant Full Access to another user, click **Manage** next to their name, then **Assign People**, and select them from the people with access to your Meta Business portfolio. ### Accept the Facebook Audiences Terms of Service Sign in to your Facebook Ad Account at [adsmanager.facebook.com](https://adsmanager.facebook.com/), confirm the correct ad account is selected in the ad account selector at the top of the page, and open **Audiences** from the left navigation. If the ToS has not been accepted, you are prompted to accept it. If it has already been accepted, you see options to create new audiences. ## Create the destination in Zeotap CDP **1. Open the Destinations application** Sign in to the Zeotap CDP app and go to **Integrate → Destinations**. **2. Select the Meta Custom Audience destination** Click **+ Create Destination**. Under **All Destinations**, search for `Meta` and select **Meta Custom Audience**. ![All Destinations search filtered to Meta, showing the Meta Custom Audience tile](https://mintcdn.com/zeotap/8Ms-Np9nC3i8iT8V/articles/integrate-customer/Storage/integrate-customer/meta-custom-audience/meta-custom-audience-2026-09-22-1.png?fit=max\&auto=format\&n=8Ms-Np9nC3i8iT8V\&q=85\&s=a412266dd0d2d8a691b3e01fdc8da4b4) **3. Enter the destination details** On the **Enter Destination Details** screen: 1. In **Destination Name**, enter a name that identifies this destination in your Destinations list. 2. In **Ad Account ID**, enter the 16-digit Facebook Ad Account ID linked to your Business Manager. 3. In **API Version**, enter the Facebook Graph API version this destination should target — the numerical part only, for example `23.0`. If you are unsure which version to use, check with your Zeotap representative. ![Enter Destination Details screen with Destination Name, Ad Account ID and API Version fields and the Connect Meta Custom Audience button](https://mintcdn.com/zeotap/8Ms-Np9nC3i8iT8V/articles/integrate-customer/Storage/integrate-customer/meta-custom-audience/meta-custom-audience-2026-09-22-2.png?fit=max\&auto=format\&n=8Ms-Np9nC3i8iT8V\&q=85\&s=51c1c2462dc6235a6f7670d771c54d36) **4. Connect to Facebook** Click **Connect Meta Custom Audience**. You are redirected to Facebook — sign in with the user that has full control of the ad account, and grant the requested permissions. > [!NOTE] > > Authorise with the Facebook user identified in [Prerequisites](#prerequisites). The connection inherits that user's access, so an account without full control of the ad account cannot activate audiences to it. **5. Confirm the connection** Once connected, the form records who established the connection and when, and shows the date on which the refresh token expires. ![Connection details on the destination form: the date the connection was updated, and a note giving the date the refresh token expires. The authorising user's email address is redacted.](https://mintcdn.com/zeotap/8Ms-Np9nC3i8iT8V/articles/integrate-customer/Storage/integrate-customer/meta-custom-audience/meta-custom-audience-2026-09-22-3.png?fit=max\&auto=format\&n=8Ms-Np9nC3i8iT8V\&q=85\&s=e89797b8c0841728c843b6b4176c809f) Note the expiry date — see [Maintain the connection](#maintain-the-connection). Click **Next** to go to the Mapping screen. **6. Choose the action and map identifiers** Name the mapping, select an action under **Choose your Action**, then map your Catalogue fields to the destination fields under **Map the Fields**. ![Mapping screen with Send identifiers to Meta selected and Catalogue fields mapped to MAID, Email, Mobile and Facebook External ID](https://mintcdn.com/zeotap/8Ms-Np9nC3i8iT8V/articles/integrate-customer/Storage/integrate-customer/meta-custom-audience/meta-custom-audience-2026-09-22-4.png?fit=max\&auto=format\&n=8Ms-Np9nC3i8iT8V\&q=85\&s=19c1dd752752fd45486f4be6a0cf6895) See [How Zeotap formats each attribute for Facebook](#how-zeotap-formats-each-attribute-for-facebook) for the Catalogue attribute to map to each field. Note that the destination field named **Mobile** takes the phone number; the Mobile Advertising ID maps to **MAID**. **7. Create the destination** Click **Create Destination**. The destination appears in the Audiences application, ready to be linked. ## How Zeotap formats each attribute for Facebook Facebook requires specific formatting and hashing for each attribute. Zeotap CDP performs the transformations listed below, so you only need to ingest the source attribute into your Zeotap Catalogue. | Attribute | Facebook requirement | Zeotap CDP transformation | | - | - | - | | External ID | Hashing **not** required | Sent as-is | | Email address | Hashing required; trim leading/trailing whitespace; lowercase all characters | Map from `Email SHA256 Lowercase` in the Zeotap Catalogue. Consult your Zeotap representative on ingesting this identifier. | | Phone number | Hashing required; remove symbols, letters, and leading zeroes | Map from `Cellphone Number Withcode Sha256` in the Zeotap Catalogue. Consult your Zeotap representative on ingesting this identifier. | | Gender | Hashing required; `m` for male, `f` for female | Zeotap extracts the first letter of the Gender value, lowercases it, hashes it, and sends it | | Date of birth | Hashing required; send `YYYY`, `MM`, `DD` separately | Ingest Date of Birth as a timestamp field; Zeotap performs the split and hash | | First Name, Last Name | Hashing required; a–z only, lowercase, no punctuation; special characters in UTF-8 | Zeotap performs the transformation | | State | Hashing required; 2-character ANSI code, lowercase; non-US states normalised lowercase with no punctuation, special characters, or whitespace | Zeotap hashes the ingested State value and sends it | | City | Hashing required; a–z only, lowercase, no punctuation, special characters, or whitespace | Zeotap hashes the ingested City value and sends it | | ZIP Code | Hashing required; lowercase, no whitespace; US — first 5 digits; UK — Area/District/Sector | Zeotap removes whitespace, hashes the result, and sends it. Example: UK ZIP `SW1A 2AA` is sent as the SHA256 of `SW1A2AA`. | | Country Code | Hashing required; lowercase 2-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) | Map from `Country` in the Zeotap Catalogue. If you map another attribute, ingest a 3-letter country code; Zeotap converts it to the 2-letter code. | | Mobile Advertising ID (MAID) | Hashing **not** required; lowercase, keep hyphens | Sent as-is | ## Maintain the connection The OAuth connection is held by a refresh token with a fixed expiry. The destination form shows the expiry date once connected, and records the user who authorised it. When the refresh token expires, Zeotap can no longer push audiences to this destination and activations fail with an authentication error. The connection has to be re-authorised before that date to avoid an interruption — if you are unsure how to re-authorise an existing destination, contact Zeotap support. > [!WARNING] > > Check the refresh token expiry date when you create the destination and set a reminder ahead of it. Nothing prompts you as the date approaches — the first symptom is usually a failed activation. The connection inherits the access of the user who authorised it. If that user loses full control of the ad account, the destination has to be re-authorised by a user who has it. ## Link an audience to the destination In the Audiences application, link the audience or segment to the Meta Custom Audience destination. The terms *audience* and *segment* are used interchangeably for a customer cohort — for example, customers over 18 who performed an `addToCart` event in the last 30 days. For the linking procedure, see [Link an Audience to the Destination](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > * Segments are created directly in your Facebook account, so they do not appear under Zeotap's Ad accounts. > * The Facebook Custom Audience limit of 500 applies per Ad Account that you use — it does not apply to Zeotap's account. > * Facebook compares the data Zeotap uploads against the segment using their encrypted user data; matched IDs are added to the Custom Audience and ads are delivered to those users. > * Meta documents Custom Audience behaviour in its [Custom Audiences guide](https://developers.facebook.com/docs/marketing-api/audiences/guides/custom-audiences). ## Verify the audience reached Facebook Allow up to 24 hours (one business day) after linking for a Zeotap CDP audience to sync to Facebook. The destination form additionally notes that segments can take up to **3 business days** to become available at the Facebook 1P seat, so allow for that longer window before investigating. To confirm: 1. Sign in to [Facebook Ads Manager](https://adsmanager.facebook.com/) and select the ad account configured in the destination, using the ad account selector at the top of the page. 2. Open **Audiences** from the left navigation. 3. Confirm the Custom Audience appears in the Audience list with a populated **Estimated audience size**. The audience name matches the one configured in Zeotap CDP. If the audience appears but **Estimated audience size** reads **Below 1,000** with **Small after matching** beneath it, the sync completed but matching produced fewer records than Facebook's minimum threshold — review the identifiers being sent (see [How Zeotap formats each attribute for Facebook](#how-zeotap-formats-each-attribute-for-facebook)) and confirm the source identifiers are populated for the audience members. This integration supports user disqualification. When a user no longer meets the audience criteria, the consent requirements, or other audience conditions, Zeotap CDP issues a user deletion request to Facebook on the next refresh cycle. Disqualified users are excluded from the audience on the configured refresh frequency. No manual action is required — the process runs automatically. ## Troubleshooting ### Common errors | Error string | What it means | Where to look | | - | - | - | | `{"message":"Facebook Error: Permission error","code":"400 BAD_REQUEST"}` | Ad Account or app permissions are not yet active on Facebook's side. Seen with new accounts before the Audiences ToS has been accepted or before Facebook permissions have propagated. | Confirm the [Audiences ToS](#accept-the-facebook-audiences-terms-of-service) is accepted; if accepted, allow time for Facebook permissions to take effect, then retry. | | Segment activation fails with an authentication error | The refresh token has expired or the authorisation was revoked on Facebook's side. | The refresh token expiry date on the destination. The connection has to be re-authorised — see [Maintain the connection](#maintain-the-connection). | | Activation fails after the authorising user's access changed | The connection inherits the access of the user who authorised it. If that user loses full control of the ad account, activations stop. | **Ad Account Access** in Business Manager; the destination has to be re-authorised by a user who has full control. | ### If the 400 BAD_REQUEST error persists If the 400 error continues after the Audiences ToS has been accepted, allow time for the Facebook permissions to propagate before retrying. If the error still appears after several days, confirm the authorising user still has **People with full control** access to the ad account. ## How External IDs flow between a brand and Facebook When you target Facebook users by a brand-side identifier (loyalty ID, internal user ID, cookie), the flow is: 1. The brand places the Facebook pixel on its website and configures the tag to pass the Facebook cookie (or any custom identifier) as `extern_id` to Facebook. See Meta's [Pixel implementation guide](https://developers.facebook.com/docs/meta-pixel/get-started). The pixel push pattern: ```js theme={null} fbq('init', '', { 'extern_id': '' }); ``` 2. Facebook builds an internal mapping between the `extern_id` and its own user ID. 3. The brand also passes the Facebook cookie to Zeotap as `id_mid_62`, using Google Tag Manager, JavaScript, or another tag implementation. 4. The brand builds an audience in the Audiences application using the Facebook cookies. 5. Zeotap uploads the Facebook cookie as an External ID to Facebook. Facebook uses its internal mapping to resolve the External ID to the corresponding user on its platform. > [!NOTE] > > Accepting the [Custom Audiences Terms of Service](https://business.facebook.com/ads/manage/customaudiences/tos/?act=) (mandatory since September 2021) is required for this flow. ## FAQ > [accordion] How is Meta Custom Audience different from the Facebook 1P destination? > > Both push audiences into a Facebook Ad Account as a Custom Audience, and both send the same identifiers. They differ only in authorisation. **Meta Custom Audience** collects a Destination Name, Ad Account ID and API Version, then authorises through the **Connect Meta Custom Audience** OAuth flow — no access token, and no app in the Facebook Developers portal. [Facebook 1P](/articles/integrate-customer/facebook-1p) collects the same three values plus an **Access Token** you generate yourself. Both are supported; choose the one that fits how your team manages credentials. > [accordion] Which action should I pick — Send identifiers or Send Multiple User Identifiers? > > Pick **Send Multiple User Identifiers to Facebook 1P** when you have more than one identifier per profile. All identifiers map to a single user record on Facebook's side, which raises the match rate. Pick **Send identifiers to Meta** only when each identifier needs to be sent as its own user profile. > [accordion] Do I need to hash identifiers before ingesting them into Zeotap? > > For email, phone, name, gender, date of birth, address fields, and country code, Zeotap CDP performs the hashing and formatting Facebook requires — you ingest the source value into the matching Catalogue field. For Mobile Advertising IDs and External IDs, no hashing is required and Zeotap sends them as-is. See the [attribute table](#how-zeotap-formats-each-attribute-for-facebook) for the per-attribute Catalogue mapping. > [accordion] How long until my audience appears in Facebook Ads Manager? > > Allow up to 24 hours (one business day) after linking for a Zeotap CDP audience to fully sync with Facebook, and up to 3 business days for it to become available at the Facebook 1P seat — the destination form states the longer figure. If it has not appeared after that window, confirm the audience link is active in Zeotap CDP and that the destination's refresh token has not expired. > [accordion] What happens when the refresh token expires? > > Activations to the destination fail with an authentication error. The connection has to be re-authorised — see [Maintain the connection](#maintain-the-connection). The expiry date is shown on the destination once it is connected. ## Next steps * [Explore the Facebook 1P destination →](/articles/integrate-customer/facebook-1p) for the access-token-authenticated variant of this destination * [Explore linking an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore Audience Insights to measure match rate and reach →](/articles/segment-customer/audience-insights) # Microsoft Ads Customer Match Source: https://docs.zeotap.com/articles/integrate-customer/microsoft-ads-customer-match Send hashed email audiences from Zeotap CDP to Microsoft Advertising for use in Search and Audience Network campaigns. ## What this is Microsoft Ads Customer Match is a Microsoft Advertising feature that re-engages known customers across the Microsoft Search Network and Audience Network using hashed email addresses collected with consent. The Zeotap CDP destination for Microsoft Ads Customer Match forwards audiences (segments) from Zeotap CDP into your Microsoft Advertising account as customer match lists, which you then attach to campaigns for targeting or exclusion. This page walks through the credentials the integration requires, how to create the destination in Zeotap CDP, how to authenticate through Microsoft's OAuth flow, how to verify segments on the Microsoft Advertising side, and how to resolve the failure modes that surface at each step. ## Supported identifiers and actions This integration supports **hashed email addresses only** (SHA-256). The following table lists the action types available for this destination and the features each supports: | Action name | [ID EXTENSION](/articles/segment-customer/extend-your-audience#id-extension) | [DELETE](/articles/integrate-customer/delta-upload-and-delete-functions) | [DELTA UPLOAD](/articles/integrate-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send identifiers to Microsoft Ads Customer Match | ✅ | ✅ | - | ## Prerequisites > [!NOTE] > > Before you create the destination in Zeotap CDP, collect the following from your Microsoft Advertising account: > > * **Account ID** and **Customer ID** — see [Locate your Account ID and Customer ID](#locate-your-account-id-and-customer-id). > * **Developer Token** — issued by Microsoft Advertising with valid Super Admin credentials. Follow Microsoft's [Get a Developer token](https://learn.microsoft.com/en-us/advertising/guides/get-started?view=bingads-13#get-developer-token) guide. > * **Super Admin** permission on the Microsoft Advertising account you will authenticate with. The OAuth step in Zeotap CDP will fail without this permission level. > * **Accepted Customer Match terms** on the Microsoft Advertising side. To accept them, create one customer match segment in Microsoft Advertising (a blank file is acceptable) under **Tools → Audiences → Create → Customer Match**. If the terms are not accepted, the OAuth authentication in Zeotap CDP will fail. ### Locate your Account ID and Customer ID Sign in to the [Microsoft Advertising web application](https://ui.ads.microsoft.com/) and open the **Campaigns** tab. The page URL contains two query-string parameters: `cid`, which identifies your Customer ID, and `aid`, which identifies your Account ID. Copy both values from your own URL. For a broader reference on identifiers in Microsoft Advertising, see Microsoft's [Get started guide](https://learn.microsoft.com/en-us/advertising/guides/get-started?view=bingads-13#get-ids). ## Create the destination in Zeotap CDP **Step 1** Open the **Destinations** application in Zeotap CDP and start a new destination with **+ Create Destination**. ![Destinations application with the Create Destination button highlighted](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_1.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=92dfe8ecb29e59c9d7d57cb954e54618) **Step 2** Under **All Destinations**, search for **Microsoft Ads Customer Match** and select it. ![All Destinations catalog with the destination search field highlighted](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_2.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=6f5f0f5367788fb4e9e946f4b3cb5874) **Step 3** On the right-hand configuration panel, enter: a. A name for the destination. b. The **Account ID** you copied above. c. The **Customer ID** you copied above. d. The **Developer Token** issued by Microsoft Advertising. ![Microsoft Ads Customer Match destination details form with fields for name, Customer ID, Account ID and Developer Token](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/microsoft-ads-customer-match/microsoft-ads-customer-match-2023-11-08.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=7174255ed0d70e1e7033a1ad34af8f65) **Step 4** Click **Connect Microsoft Ads Customer Match** and complete the Microsoft OAuth flow in the pop-up. Sign in with the Microsoft account that has **Super Admin** access to the Microsoft Advertising instance where you want to activate segments, and grant the requested permissions. > [!WARNING] > > The account you authenticate with must be **Super Admin** in the target Microsoft Advertising instance, and the Customer Match terms must already be accepted (see Prerequisites). If either condition is not met, the OAuth flow fails and the destination cannot be created. **Step 5** On success, Zeotap CDP populates the **Access Token**, **Refresh Token**, and their expiry periods on the destination screen. The short-lived Access Token is regenerated automatically from the Refresh Token (valid up to 90 days). If the Refresh Token expires or is revoked, Microsoft returns an `invalid_grant` error and you must create a new destination to re-authenticate. **Step 6** Click **Next** to proceed to mapping. **Step 7** Under **Choose your Action**, select **Send identifiers to Microsoft Ads Customer Match**, then map the catalog fields to the destination fields under **Map the Fields**. Default output identifiers are pre-populated; edit, add, or remove identifiers as needed. See [Choose the output identifiers](/articles/segment-customer/choose-the-output-identifiers) for details. ![Mapping screen with the Send identifiers to Microsoft Ads Customer Match action and the output identifiers mapping](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/microsoft-ads-customer-match/microsoft-ads-customer-match-2023-11-08-4.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=d78e8724adbdc9b2d59795263e47cc2b) **Step 8** Click **Create Destination**. The destination is listed in the **Audiences** application and can be linked to an audience or segment. > [!NOTE] > > One active destination per Microsoft Advertising account is sufficient — do not create duplicates with the same credentials. Because destination creation requires signing into the client's Microsoft Advertising account, the client should create the destination themselves; a Zeotap TAM or CSM can do so only when the client has explicitly provided access to their Microsoft Advertising credentials. ## Link an audience to the destination For step-by-step instructions on linking an audience or segment to the destination in the **Audiences** application, see [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination). Segments take up to **three business days** to appear at the Microsoft Ads Customer Match seat after linking. > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience can be a group of customers who are over 18 and have performed an `addToCart` event within the last 30 days. ## Verify the segment reached Microsoft Advertising To confirm segments pushed by Zeotap CDP are landing correctly on the Microsoft Advertising side: **Step 1** Sign in to Microsoft Advertising. **Step 2** Open **Tools → Audiences**. Your Zeotap-pushed segments appear in the list; search by the audience name to locate a specific segment. ![Microsoft Advertising Tools menu with Audiences selected and the audience list shown below](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/microsoft-ads-customer-match-2022-12-15-3.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=f78bf50d93018921d9006bb0fd0ba332) If a linked audience does not appear after three business days, use the troubleshooting section below. ## Attach a segment to a Microsoft Ads campaign Once a segment is visible under **Audiences** in Microsoft Advertising, attach it to a campaign: **Step 1** Select the campaign you want to edit, then click **Edit → Associate with audiences**. ![Microsoft Advertising campaign Edit menu with Associate with audiences highlighted](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/microsoft-ads-customer-match-2022-12-15-4.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=e26a261176d37a45479ca02145fe2d28) **Step 2** Under **Campaign targeting** or **Campaign exclusion** (depending on whether you want to include or exclude the audience), select **Customer match lists** from the drop-down. **Step 3** Search for and select the audience list you want to include or exclude. **Step 4** Click **Save**. ## Troubleshooting The table below lists the errors and failure modes that surface for this destination, what each one means, and where to look to resolve it. | Error string / symptom | What it means | Where to look | | - | - | - | | `AADSTS650052: The app is trying to access a service ... that your organization ... lacks a service principal for.` | The Microsoft Entra (Azure AD) tenant used for OAuth has no service principal enabled for the Microsoft Advertising API, so consent cannot be granted. | Add at least one Admin user from your Azure AD tenant as an enabled [work account](https://help.ads.microsoft.com/#apex/3/en/60043/-1) in [ads.microsoft.com](https://ads.microsoft.com/), then re-run **Connect Microsoft Ads Customer Match**. | | `invalid_grant` on token refresh | The Microsoft OAuth Refresh Token has expired (past its 90-day validity) or has been revoked. Zeotap CDP can no longer regenerate an Access Token. | Delete the affected destination in Zeotap CDP and create a new one to re-run the OAuth flow. | | OAuth flow fails immediately after clicking **Connect Microsoft Ads Customer Match** | Either the authenticating user is not a Super Admin in the target Microsoft Advertising instance, or the Customer Match terms have not been accepted on the Microsoft side. | Verify the signing-in user's role in Microsoft Advertising; if the role is correct, create a placeholder Customer Match segment under **Tools → Audiences → Create → Customer Match** to accept the terms, then retry. | | Segment not visible in Microsoft Advertising after three business days | Delivery to the Microsoft Ads Customer Match seat is delayed or blocked, or the audience's refresh cycle has not completed in Zeotap CDP. | Confirm the audience is linked to the correct destination and that its refresh has completed in Zeotap CDP; if it has, escalate with the details listed in the next section. | | Mapping error at destination creation | The catalog field selected under **Map the Fields** is not a hashed email address (the only identifier this integration accepts). | Re-open the mapping step and confirm the mapped field is a SHA-256 hashed email. See [Choose the output identifiers](/articles/segment-customer/choose-the-output-identifiers). | For the broader Microsoft Advertising error catalog, see Microsoft's [Handle service errors and exceptions](https://learn.microsoft.com/en-us/advertising/guides/handle-service-errors-exceptions?view=bingads-13) guide. ### When to contact support Escalate to [Zeotap support](https://support.zeotap.com) when: * The `AADSTS650052` error persists after your Azure AD Admin has been enabled as a work account in Microsoft Advertising. * A newly created destination completes OAuth without error, but no segment appears at the Microsoft Ads Customer Match seat five business days after the audience refresh has run. * You see an error string not listed in the table above. **Include in your request:** * Destination name and creation date. * Audience ID and the timestamp of its last refresh in Zeotap CDP. * The full error string from Zeotap CDP or from Microsoft Advertising, including any **Trace ID** and **Correlation ID**. * The Microsoft Advertising **Account ID** (`aid`) and **Customer ID** (`cid`). ## User disqualification from audiences This integration supports user disqualification from audiences. A user can be disqualified from an audience (segment) for reasons such as no longer meeting audience criteria, consent withdrawal, or other conditions set on that audience. * When a user is disqualified, Zeotap CDP initiates a user-deletion request in the next refresh cycle. Requests are sent to the audiences linked to this destination. * Disqualified users are excluded from the audience based on the configured refresh frequency. * Disqualification runs automatically — no manual action is required. For more detail, see [Delta upload and delete functions](/articles/integrate-customer/delta-upload-and-delete-functions). ## FAQ > [accordion] How long after linking an audience does it appear in Microsoft Advertising? > > Segments take up to three business days to appear at the Microsoft Ads Customer Match seat after the audience is linked to the destination and its refresh cycle has run in Zeotap CDP. > [accordion] What identifiers can I send to Microsoft Ads Customer Match? > > Hashed email addresses only (SHA-256). Other identifier types are not accepted by this integration. > [accordion] Why did my Refresh Token stop working? > > Microsoft Refresh Tokens are valid for up to 90 days and are invalidated when revoked. Once the token expires or is revoked, Microsoft returns an `invalid_grant` error and Zeotap CDP can no longer regenerate an Access Token — delete the destination and create a new one to re-authenticate. > [accordion] Can a Zeotap TAM or CSM create the destination on my behalf? > > Because destination creation requires signing into your Microsoft Advertising account, you should create the destination yourself. A Zeotap TAM or CSM can do so only when you have explicitly provided credentials with Super Admin access to your Microsoft Advertising instance. ## Next steps * [Explore Google Customer Match (Customer Contact Information) →](/articles/integrate-customer/google-customer-match-customer-contact-information) * [Explore Google Customer Match (Mobile Device IDs) →](/articles/integrate-customer/google-customer-match-mobile-device-ids) * [Explore Microsoft CAPI for server-to-server conversions →](/articles/integrate-customer/microsoft-capi) * [Explore the Microsoft Dynamics CRM source →](/articles/integrate-customer/create-a-ms-dynamics-crm-source) # Microsoft CAPI Source: https://docs.zeotap.com/articles/integrate-customer/microsoft-capi Send conversion and event data from Zeotap CDP to Microsoft Advertising over a server-to-server connection, using a real-time destination attached to a journey. ## What this is Microsoft CAPI sends conversion and event data **out of Zeotap CDP to Microsoft Advertising** over a server-to-server connection, so the events reach Universal Event Tracking (UET) without relying on browser-side tags. The result is better measurement, attribution and campaign optimisation from your first-party data. It is a **real-time destination**. You do not link it to an audience: you create it, then attach it to a **Send to Destinations** node inside a Journeys workflow, and events flow as users pass through that node. To send audience identifiers to Microsoft Advertising rather than conversion events, use [Microsoft Ads Customer Match](/articles/integrate-customer/microsoft-ads-customer-match) instead. That is a batch destination and is linked to an audience. ## Supported identifiers and actions This integration offers one action, **Send Events to Microsoft**, which sends your conversion events to Microsoft Advertising through Journeys. The action exposes three groups of destination fields on the mapping screen: | Mapping section | Fields | | - | - | | **Attributes** | **Event Time** (required, EPOCH seconds), **Event Source URL for Page Load**, **Event Name** | | **User Data** | **External Id**, **Anonymous Id**, **Email SHA256 Hashed**, **Phone Number SHA256 Hashed**, **Client Ip Address**, **Microsoft Last Click ID**, **Client User Agent** | | **Custom Data** | Any additional attributes you add with **+ Add Mapping Field** | > [!NOTE] > > **Note:** > > Ensure that the **Email** and **Phone Number** values you map are SHA-256 hashed before they are sent to Microsoft. ## Prerequisites Before you create a Microsoft CAPI destination in Zeotap CDP, make sure you have: * A Microsoft Advertising account. * A **UET tag** created in Microsoft Advertising. * A **Conversions API token** generated for that UET tag. * Conversion goals configured in Microsoft Advertising for the events you want to track. ## Get the UET tag ID and Conversions API token Both values come from Microsoft Advertising, and you enter both when you create the destination. ### UET tag ID The unique identifier for your Microsoft UET tag. Find or provision a UET tag in your Microsoft Advertising account. You enter this value in the **Tag ID** field. ### Conversions API token The authorisation token used to send events to the Conversions API. In Microsoft Advertising, open the UET tag's **Set up tagging** step and select **Use Conversions API** to generate the token, then copy it. Allow up to 15 minutes for a newly generated token to activate. You enter this value in the **API Token** field. For details on the UET Conversion API, including how to configure and send **custom attributes**, refer to Microsoft's [Conversions API (CAPI) guide](https://learn.microsoft.com/en-us/advertising/guides/uet-conversion-api-integration?view=bingads-13). ## Create the Microsoft CAPI destination **Step 1** Log into the Zeotap CDP App and go to **Destinations** under **Integrate**. **Step 2** Click **+ Create Destination**. **Step 3** Under the **All Destinations** section, search for Microsoft CAPI and click **Microsoft CAPI**. **Step 4** The **Enter Destination Details** screen appears, with details about the destination on the left. On the right-hand side, provide the required details: a. In the **Destination Name** field, enter a name for the destination. b. In the **API Token** field, enter the Conversions API token generated in Microsoft Advertising. c. In the **Tag ID** field, enter the unique identifier for your Microsoft UET tag. ![The Enter Destination Details step for a Microsoft CAPI destination, showing the Destination Name, API Token and Tag ID fields on the right and the component list on the left.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/microsoft-capi/microsoft-capi-2026-06-22-1.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=8b8f414c881ca8d58620fb2e98beec5c) **Step 5** Click **Next** to proceed to the **Mapping** screen. **Step 6** On the **Mapping** screen, provide a name for your mapping, then configure the action and the field mapping: a. Under **Choose your Action**, select **Send Events to Microsoft**. This action sends your conversion events to Microsoft Advertising through Journeys. ![The Mapping step with Send Events to Microsoft selected under Choose your Action, and the Map the Fields table showing the Attributes rows beneath it.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/microsoft-capi/microsoft-capi-2026-06-22-2.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=03b7a9fff9665ad871b68012c64870b9) b. Under **Map the Fields**, map your Catalogue fields to the destination fields: i. **Attributes** — map **Event Time**, the only mandatory field in this group (the value must be in **EPOCH seconds** format), and **Event Source URL for Page Load**. Also map **Event Name**, but only when the **Event Type** under **Additional Settings** (sub-step c) is set to **Custom**. ii. **User Data** — map the identity fields you want to send: External Id, Anonymous Id, Email SHA256 Hashed, Phone Number SHA256 Hashed, Client Ip Address, Microsoft Last Click ID, and Client User Agent. iii. **Custom Data** — use **+ Add Mapping Field** to send any additional attributes. ![The User Data rows of the Map the Fields table — Anonymous Id, External Id, Email SHA256 Hashed, Phone Number SHA256 Hashed, Client Ip Address and Microsoft Last Click ID — above the Custom Data section and the consent notice.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/microsoft-capi/microsoft-capi-2026-06-22-3.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=22803014811742b4bc7a1ab9225f74b8) > [!NOTE] > > Zeotap CDP transmits consent signals to Microsoft CAPI only for users who have provided the required advertising and data processing consent, ensuring compliance with Microsoft's policies. Ensure that only consented users enter your journey criteria. > [!NOTE] > > **Note:** > > For the full list of custom parameters you can send and how to format them, refer to Microsoft's [Conversions API (CAPI) guide](https://learn.microsoft.com/en-us/advertising/guides/uet-conversion-api-integration?view=bingads-13). c. Under **Additional Settings**, set the **Event Type** — select **Page Load** or **Custom** depending on the event you are sending. ![The Additional Settings section with the Event Type list open, showing the Page Load and Custom options.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/microsoft-capi/microsoft-capi-2026-06-22-4.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=be41f3e5e69b59ed5d216e27f0c82219) d. Before you create the destination, use [Payload Preview](/articles/integrate-customer/payload-preview-for-destination-mappings) to generate a sample payload and confirm the field values, structure and format are what you expect, rather than waiting for live traffic to surface a mapping mistake. **Step 7** Click **Create Destination**. The destination is then available for selection in the **Send to Destinations** node when you build a journey. ## Add the destination to a journey The **Send Events to Microsoft** action runs in Journeys. After creating the destination, attach it using the **Send to Destinations** node within your workflow. For the full walkthrough of attaching a real-time destination to a workflow, see [Activate your real-time audiences](/articles/integrate-customer/activate-your-real-time-audiences). ## Verify conversion events in Microsoft Advertising Once the destination is activated and events begin flowing, you can verify them in Microsoft Advertising: **Step 1** In Microsoft Advertising, open the UET tag linked to this destination. **Step 2** Open the **Insights** view for the tag. Events sent through the Conversions API appear in the events table, one row per event name, with the **Event Type** (Page Load or Custom), **Total Events**, **Parameters Received**, **Last Received** and **Consent Signal** for each. ![The UET tag events table in Microsoft Advertising, with a trend chart above it and columns for Events, Event Type, Total Events, Parameters Received, Last Received and Consent Signal.](https://mintcdn.com/zeotap/XeiUSixmH-W9Ej2A/articles/integrate-customer/Storage/integrate-customer/microsoft-capi/microsoft-capi-2026-06-22-5.png?fit=max\&auto=format\&n=XeiUSixmH-W9Ej2A\&q=85\&s=46e10b244dcdd4e8b9ab1a56c9e58dd8) It may take up to 24 hours to verify your UET tag status. Until events are received, the view shows no activity; allow time for the first events to be processed before treating an empty view as an error. ## Troubleshoot the Microsoft CAPI destination | What you see | What to check | | - | - | | The events view in Microsoft Advertising stays empty after the destination goes live. | It can take up to 24 hours to verify your UET tag status, and the view shows no activity until the first events arrive. Confirm the journey is published and that users are reaching the **Send to Destinations** node before treating the empty view as a failure. | | Events are not accepted immediately after you generate a new Conversions API token. | Allow up to 15 minutes for a newly generated token to activate, then retry. | | Microsoft does not accept the event time you are sending. | **Event Time** is mandatory and must be in **EPOCH seconds** format. Check the Catalogue field you mapped to it. | | The event name does not reach Microsoft. | **Event Name** applies only when **Event Type** under **Additional Settings** is set to **Custom**. If the **Event Type** is **Page Load**, the event name is not used. | | Email or phone identifiers do not match users in Microsoft Advertising. | Map Catalogue fields that are already SHA-256 hashed to **Email SHA256 Hashed** and **Phone Number SHA256 Hashed**. Unhashed values are not accepted by Microsoft. | | Microsoft receives fewer events than you expect. | Consent signals are transmitted only for users who have provided the required advertising and data processing consent, so unconsented users entering the journey do not produce events. Check the **Consent Signal** column in Microsoft's events table, and tighten the journey criteria so that only consented users enter the node. | When the journey reports a delivery error at the **Send to Destinations** node, look up the code on [Journey error codes](/articles/orchestrate-customer/journey-error-codes) and see [Journey troubleshooting](/articles/orchestrate-customer/journey-troubleshooting) for the resolution steps; [journey traces](/articles/orchestrate-customer/journey-traces) show, per user, which destination nodes were reached. For failures common to every destination, see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail). ## Next steps * [Activate your real-time audiences →](/articles/integrate-customer/activate-your-real-time-audiences) * [Preview the payload for a destination mapping →](/articles/integrate-customer/payload-preview-for-destination-mappings) * [Send audience identifiers to Microsoft Ads Customer Match →](/articles/integrate-customer/microsoft-ads-customer-match) * [Create a destination →](/articles/integrate-customer/create-a-destination) * [Control which destinations a folder can use →](/articles/integrate-customer/destination-access-rules) # Microsoft Fabric Source: https://docs.zeotap.com/articles/integrate-customer/microsoft-fabric Bring data into Zeotap CDP from a table or view in your Microsoft Fabric warehouse, using an Azure service principal and the warehouse SQL connection endpoint. ## What this is The Microsoft Fabric source brings data **into** Zeotap CDP: you point it at one table or view in your Microsoft Fabric warehouse, and Zeotap CDP connects over the warehouse SQL connection endpoint and pulls records on the refresh frequency you choose. To send Zeotap audiences **out** to Microsoft Fabric instead, see the [Microsoft Fabric destination](/articles/integrate-customer/microsoft-fabric-audience). Microsoft Fabric is an all-in-one analytics platform that unifies data engineering, data integration, data warehousing, data science, real-time analytics, and business intelligence under a single SaaS offering. It combines technologies like Power BI, Azure Synapse, and Data Factory into a seamless experience powered by **OneLake**, a centralised data lake for the entire organisation. Designed for both technical and business users, it streamlines the entire data lifecycle from ingestion to visualisation. > [!NOTE] > > **Two Microsoft Fabric integrations exist.** This page is the Fabric **source**, created under **Data Warehouse** in the Sources application. The Fabric **destination**, which writes a Zeotap audience into a Fabric Lakehouse table, is a separate integration — see [Microsoft Fabric destination](/articles/integrate-customer/microsoft-fabric-audience). ## Prerequisites > [!NOTE] > > Gather the following before you create a Microsoft Fabric source in Zeotap CDP. You set up the Microsoft Entra and Fabric prerequisites once; the source reuses them on every sync. > > * **Service principal** — an application registered in Microsoft Entra. See [Create the service principal in Microsoft Entra](#create-the-service-principal-in-microsoft-entra). > * **Host** — the hostname or IP address of your Microsoft Fabric instance. If you use the hostname, insert only the hostname and not the full URL (remove the leading `http://` and the final `/`). > * **Port** — the port number of your Microsoft Fabric instance. The default is 1433. > * **Database** — the name of the database in Microsoft Fabric. > * **Table** — the name of the table in Microsoft Fabric from which you want to fetch data. It follows the format `warehouseName.schemaName.TableName`; see [Table name](#table-name). You may also use views by replacing `TableName` with `ViewName`. > * **Tenant ID (or Directory ID)** — the Tenant ID of the service principal. > * **Client ID (or Application ID)** — the Client ID of the service principal. > * **Client Secret** — the Client Secret associated with the service principal. ## Create the service principal in Microsoft Entra Zeotap CDP uses a Microsoft Entra service principal as the credential for reading your Microsoft Fabric resources. Create it first. **Step 1** Sign in to the [Microsoft Entra admin center](https://entra.microsoft.com/). **Step 2** On the sidebar, select **Identity** > **Applications** > **App registrations**. **Step 3** Select **New registration**. **Step 4** Pick a name for your application and select **Accounts in this organizational directory only** as the supported account type. **Step 5** Click **Register**. **Step 6** Note your newly created **Application (client) ID** and **Directory (tenant) ID**. **Step 7** Click **Add a certificate or secret**. ## Create a client secret **Step 1** Select the **Client secrets** tab. **Step 2** Click **New client secret**. **Step 3** Name your client secret and select its expiration date. To maintain access to Fabric, make sure to refresh your client secret prior to its expiration. **Step 4** Note your client secret **Value** now, as it cannot be retrieved later. It is the value you enter when you connect Zeotap CDP to Microsoft Fabric. For more detailed instructions on service principal creation, see [Microsoft's documentation](https://learn.microsoft.com/en-us/entra/identity-platform/howto-create-service-principal-portal). ## Enable service principal access in Microsoft Fabric By default, Microsoft Fabric may not be accessible via service principal. To connect, take the following steps. **Step 1** Log in to [Microsoft Fabric](https://app.fabric.microsoft.com/). **Step 2** Click **Synapse Data Engineering**. **Step 3** In the top right of the window, select **Settings** > **Governance and insights** > **Admin portal**. **Step 4** On the sidebar, select **Tenant settings**. **Step 5** Scroll down to **Developer settings** and select **Service principals can use Fabric APIs**. Make sure the toggle is set to **Enabled**. **Step 6** Next go to **OneLake settings** and select **Users can access data stored in OneLake with apps external to Fabric**. This toggle should be **Enabled** as well. ## Attach the service principal to your Fabric warehouse **Step 1** Log in to [Microsoft Fabric](https://app.fabric.microsoft.com/). **Step 2** Select the **workspace** that contains your warehouse. **Step 3** Hover over your **warehouse** and select the three dots menu (⋯). ![The three-dot menu open on a warehouse in a Microsoft Fabric workspace, with Manage permissions in the list](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/microsoft-fabric/microsoft-fabric-2025-06-13.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=9cea8fdcdeb2a9492c6fdb2eec41e927) **Step 4** Choose **Manage permissions** from the menu. **Step 5** On the next page, select **Add user**. **Step 6** Type the client ID's **display name** from Azure AD (the App registration name). **Step 7** It appears as a **Service Principal**. Select the check box for **Read all data using SQL** (ReadData). ![The warehouse Manage permissions page with Add user, and the Grant people access panel showing Read all data using SQL (ReadData) ticked for a service principal](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/microsoft-fabric/microsoft-fabric-2025-06-13-2.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=1f85788903f1f8a865766b9c6858162a) **Step 8** Select **Grant**. ## Find the connection details in Microsoft Fabric Zeotap CDP reaches the warehouse over its SQL connection endpoint. Collect the Host, Port, Database and Table values from Fabric before you create the source. ### Copy the SQL connection string From your workspace: **Step 1** Navigate to your **workspace** and select the **Warehouse**. **Step 2** Select the **Copy** button in the **SQL connection string** box to copy the connection string to your clipboard. Or, in the **OneLake** catalog: **Step 1** Select the **Warehouse**, and select the `...` ellipses for More options. **Step 2** Select **Copy SQL connection string** to copy the connection string to your clipboard. ![The OneLake catalog item list in Microsoft Fabric with the More options menu open on a warehouse and Copy SQL connection string highlighted](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/microsoft-fabric/microsoft-fabric-2025-06-13-3.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=2787dfbe0fad425d4022b109a0c3be67) Use the copied connection string for the **Microsoft Fabric Host** field, entering only the hostname — remove the leading `http://` and the final `/`. ### Port number The port number for SQL Warehouse connections is always **1433**. ### Database name The warehouse name is the Database name. In the example below, it is `testWarehouse`. ![A Microsoft Fabric workspace showing an item named testWarehouse of type Warehouse](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/microsoft-fabric/microsoft-fabric-2025-06-13-4.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=78a5535d7acd8176ef90b16068ee4019) ### Table name The Table value follows the format `warehouseName.schemaName.TableName`. In the example below, it is `[testWarehouse].[dbo].[Date]`. You may also use views by replacing `TableName` with `ViewName`. ![The warehouse object tree expanded to Schemas, dbo, and a table named Date, with a tooltip reading testWarehouse dot dbo dot Date](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/microsoft-fabric/microsoft-fabric-2025-06-13-5.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=e467c12a3c2d75bab7f953bbb3d562fa) ## Create the Microsoft Fabric source in Zeotap CDP Once you have obtained the above details from your Microsoft Fabric account, perform the following steps to create a Microsoft Fabric source in the Zeotap CDP App: **Step 1** Navigate to the **Sources** application under **Integrate**, in the Zeotap CDP App. **Step 2** Click **CREATE SOURCE**. **Step 3** Choose **Data Warehouse** as the Category. ![The CREATE SOURCE dialog listing the source categories, with Data Warehouse selected](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-amazon-s3-source/sf_1_\(1\).png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=146e94f6110f76970d52baf2ab1e964b) **Step 4** Click **Microsoft Fabric** as the Data Source. ![The SELECT DATA SOURCE step of the CREATE SOURCE dialog with Microsoft Fabric selected](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-and-implement-a-databricks-source/MS-fabric-1.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=860d81a3a88614a3204b688d76a51ec5) **Step 5** Enter a short and descriptive name for the source. **Step 6** Under **Select your Region**, choose the region of upload. For the country-to-region mapping, see [Region of storage](/articles/integrate-customer/region-of-storage). **Step 7** Set **Connection Type** to **JDBC**. The **Microsoft Fabric Host** and **Port Number** fields appear once you do. **Step 8** Enter the Microsoft Fabric host name in the **Microsoft Fabric Host** field. **Step 9** Enter the **Port Number**. The default value is 1433. ![The Source Details step showing the Source Name, Select your Region, Microsoft Fabric Host and Port Number fields](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-and-implement-a-databricks-source/MS-fabric-2.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=dce67c396294b72e774433a55077213f) **Step 10** Provide the **Database**, **Table**, **Tenant ID**, **Client ID** and **Client Secret** obtained in the [Prerequisites](#prerequisites). ![The Source Details step showing the Database, Table, Tenant ID, Client ID and Client Secret fields](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-and-implement-a-databricks-source/MS-fabric-3.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=3816469c37ba0e14937159c97c2bc9d1) **Step 11** Choose the **Sync frequency** from the drop-down menu. The first data sync takes place once you create the source; subsequent syncs take place based on the sync frequency that you select. The supported frequencies are: * Daily * Weekly * Monthly **Step 12** Under **Data Entity**, depending on the type of data you want to ingest, choose either **Customer Data** or **Non Customer Data**, and proceed with the source creation. To know more about Customer Data and Non Customer Data, see [Supported data entities](/articles/unify-customer/supported-data-entities). **Step 13** Click **CREATE SOURCE**. Upon successfully creating the source, you can view all the relevant information about the created source under the **IMPLEMENTATION DETAILS** tab. ![The IMPLEMENTATION DETAILS tab of a created Data Warehouse source — this capture is from a Databricks source, not from Microsoft Fabric](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-and-implement-a-databricks-source/create-and-implement-a-databricks-source-2024-10-21-8.png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=c46d108cec47e0fca57503d3d1dcdfac) ## Verify the source is working After you create the source, confirm the integration end to end: 1. The new source appears on the Sources listing in the Zeotap CDP App. 2. The **IMPLEMENTATION DETAILS** tab on the source shows the connection parameters you entered — the region, the refresh frequency, the data entity, and the Fabric connection fields. 3. The first data sync starts once the source is created. Subsequent syncs follow the Sync frequency you selected. 4. Open the **PREVIEW DATA** tab and confirm records from your Fabric table are landing, with the attribute names and values you expect. The initial data transfer from a Microsoft Fabric source to Zeotap CDP may take time, depending on the data volume — a large table takes longer than a small one to complete its first sync. ## Troubleshooting | Symptom | What to re-check | Where to look | | - | - | - | | The source does not connect to Fabric after creation | The Host, Port, Database and Table values entered on the source. The Host must carry only the hostname, with no leading `http://` and no trailing `/` | Zeotap CDP → Sources → your source → **IMPLEMENTATION DETAILS**. Re-copy the connection string from Fabric as described in [Copy the SQL connection string](#copy-the-sql-connection-string) | | Authentication to Fabric fails | The client secret has passed its expiration date, or the Tenant ID, Client ID or Client Secret were entered incorrectly | Microsoft Entra → **App registrations** → your app → **Client secrets**. Generate a new secret and update the source | | The service principal cannot reach Fabric at all | The two tenant settings are switched off | Fabric → **Settings** → **Governance and insights** → **Admin portal** → **Tenant settings** → **Developer settings** and **OneLake settings**, as described in [Enable service principal access in Microsoft Fabric](#enable-service-principal-access-in-microsoft-fabric) | | The connection is made but no data is read from the warehouse | The service principal was not granted **Read all data using SQL** (ReadData) on the warehouse, or the Table value does not match a table in that warehouse | Fabric → your workspace → your warehouse → **Manage permissions**. Check the table identifier as described in [Table name](#table-name) | For assistance with Microsoft Fabric source setup or other questions, reach out to the Zeotap support team at [support@zeotap.com](mailto:support@zeotap.com). Include the source name, the Region selected, and the time of the failed sync. ## FAQ > [accordion] Can I read a view instead of a table? > > Yes. Supply the view in the **Table** field using the same three-part format, replacing `TableName` with `ViewName` — for example, `warehouseName.schemaName.ViewName`. > [accordion] What format does the Table field take? > > `warehouseName.schemaName.TableName`. See [Table name](#table-name) for a worked example. > [accordion] Which port does the connection use? > > Port **1433**. It is the default value on the source form, and it is the port used for SQL Warehouse connections in Microsoft Fabric. > [accordion] How often does Zeotap CDP pull data from Fabric? > > The first sync runs as soon as you create the source. After that, syncs follow the Sync frequency you chose — Daily, Weekly, or Monthly. > [accordion] What happens when the client secret expires? > > Zeotap CDP can no longer authenticate to Fabric once the secret passes its expiration date. Generate a new client secret in Microsoft Entra before the expiry date, then update the **Client Secret** on the source in Zeotap CDP. > [accordion] Does this source also send audiences to Microsoft Fabric? > > No. This page covers the source only — data flowing from Fabric into Zeotap CDP. To write a Zeotap audience into a Fabric Lakehouse table, set up the [Microsoft Fabric destination](/articles/integrate-customer/microsoft-fabric-audience). ## Next steps * [Explore the Microsoft Fabric destination →](/articles/integrate-customer/microsoft-fabric-audience) — send Zeotap audiences out to a Fabric Lakehouse table * [Explore the other Data Warehouse sources →](/articles/integrate-customer/data-warehouse) — Snowflake, BigQuery, Amazon S3, and Databricks * [Explore the Sources overview →](/articles/integrate-customer/sources) — source categories, write keys, and how sources map to origins * [Explore supported data entities →](/articles/unify-customer/supported-data-entities) — how Customer Data and Non Customer Data differ * [Explore the fields on the Preview Data tab →](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) — read the records a source has ingested # Microsoft Fabric [Audience] Source: https://docs.zeotap.com/articles/integrate-customer/microsoft-fabric-audience Send Zeotap audiences as JSON into a Microsoft Fabric Lakehouse table, staged through a Google Cloud Storage bucket and authenticated with an Azure service principal. ## What this destination does Microsoft Fabric is Microsoft's unified analytics platform, backed by **OneLake**, that combines data engineering, data warehousing, real-time analytics, and Power BI in one SaaS surface. The Microsoft Fabric destination in Zeotap CDP activates an audience by writing its identifiers and attributes as JSON into a Fabric **Lakehouse** table. Delivery runs in two hops: Zeotap CDP writes the audience file to a Google Cloud Storage (GCS) bucket, and a Fabric Spark job reads from GCS and appends the records into the target Lakehouse table. Authentication uses an Azure **service principal** registered in Microsoft Entra. This page walks the full setup end to end: registering the service principal, enabling it inside Fabric, staging the GCS credentials in the Lakehouse, and creating the destination in Zeotap CDP. ## Supported identifiers and actions Send any identifiers and attributes to your Fabric Lakehouse. Zeotap CDP writes the payload as JSON. | Action | [ID EXTENSION](/articles/segment-customer/extend-your-audience#id-extension) | [DELETE](/articles/integrate-customer/delta-upload-and-delete-functions) | [DELTA UPLOAD](/articles/integrate-customer/delta-upload-and-delete-functions) | | :- | :-: | :-: | :-: | | Send JSON file to MS Fabric | — | — | — | ## Prerequisites Gather the following before you begin. You configure the Microsoft Entra and Fabric prerequisites once; the Zeotap CDP destination reuses them for every audience you activate. * **Service principal** — an application registered in Microsoft Entra with a valid client secret. You obtain the **Tenant ID (Directory ID)**, **Client ID (Application ID)**, and **Client Secret** from this registration. * **Fabric workspace** — the workspace that contains the target Lakehouse. You need its **Workspace ID** (the GUID in the workspace URL). * **Target Lakehouse** — the Lakehouse acts as the destination **Database**. You supply its name and the **Table Name** where Zeotap CDP writes. * **GCP service account** — either a client-owned service account with a JSON key, or the Zeotap CDP-managed service account whitelisted on your bucket. Required bucket-level permissions are listed under [Stage the GCS service account key](#stage-the-gcs-service-account-key-in-the-lakehouse). * **GCS bucket** — a Google Cloud Storage bucket dedicated to staging the audience files before Fabric ingests them. > [!WARNING] > > Client secrets in Microsoft Entra expire on the date you set. Rotate the secret before its expiry and update the destination in Zeotap CDP, or audience deliveries fail with an authentication error. ## Register the service principal in Microsoft Entra **Step 1** Sign in to the [Microsoft Entra admin center](https://entra.microsoft.com/). **Step 2** In the sidebar, select **Identity → Applications → App registrations**. **Step 3** Click **New registration**, or reuse an existing app. **Step 4** Enter a clear **Name** (for example `FabricAPIAccessApp`) and select **Accounts in this organizational directory only** as the supported account type. **Step 5** Click **Register**. **Step 6** Copy the **Application (client) ID**, **Display Name**, and **Directory (tenant) ID** from the app overview. You paste these into the Zeotap CDP destination later. ## Create a client secret **Step 1** On the registered app's page, select **Certificates & secrets** in the left panel. **Step 2** Under **Client secrets**, click **+ New client secret**. **Step 3** Enter a **Description** (for example `Fabric API Secret`) and pick an **Expires** period. A shorter expiry is more secure; rotate before expiry to keep the destination working. **Step 4** Click **Add**. **Step 5** Copy the secret **Value** immediately — Entra does not show it again. This is the **Client Secret** you enter in Zeotap CDP. For more detail on service principal creation, see [Microsoft's documentation](https://learn.microsoft.com/en-us/entra/identity-platform/howto-create-service-principal-portal). ## Assign API permissions The service principal needs one **Microsoft Graph** scope and one **Power BI Service** scope (Power BI Service covers Microsoft Fabric APIs). **Step 1** From the same app, go to **API permissions → + Add a permission**. ![Add a permission button on the API permissions page in Microsoft Entra](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/microsoft-fabric-audience/microsoft-fabric-audience-2025-08-21.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=dd7934d1b81615d2a3b16ec861ab098f) **Step 2** Select **APIs my organization uses**, search for **Microsoft Graph**, click **Delegated permissions**, and add: * **User.Read** — Sign in the user and get an access token ![Selecting the User.Read delegated permission for Microsoft Graph](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/microsoft-fabric-audience/microsoft-fabric-audience-2025-08-21-1.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=593ef87e3a794297061f23d5b4afc8a8) **Step 3** Click **Add permissions**. **Step 4** Add another permission. Search for **Power BI Service**, click **Application permissions**, and add: * **Tenant.ReadWrite.All** — Read tenant-level metadata ![Selecting the Tenant.ReadWrite.All application permission for Power BI Service](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/microsoft-fabric-audience/microsoft-fabric-audience-2025-08-21-2.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=81a8ea96e96e9bc011b538bc3d738998) **Step 5** Click **Add permissions**. **Step 6** Click **Grant admin consent** and confirm. ![Granting admin consent on the API permissions page](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/microsoft-fabric-audience/microsoft-fabric-audience-2025-08-21-3.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=75a0ea0694710eb67f26cf2dd8f1a56a) ## Enable the service principal in Microsoft Fabric Microsoft Fabric blocks service-principal access by default. Turn on both tenant toggles before you assign workspace access. **Step 1** Log in to [Microsoft Fabric](https://app.fabric.microsoft.com/). **Step 2** Click **Synapse Data Engineering**. **Step 3** In the top right, select **Settings → Governance and insights → Admin portal**. **Step 4** In the sidebar, select **Tenant settings**. **Step 5** Scroll to **Developer settings** and enable **Service principals can call Fabric Public APIs**. Confirm the toggle reads **Enabled**. **Step 6** Scroll to **OneLake settings** and enable **Users can access data stored in OneLake with apps external to Fabric**. Confirm the toggle reads **Enabled**. ## Grant the service principal workspace access Tenant-level enablement is not enough. The service principal also needs the **Admin** role on the workspace that contains the target Lakehouse. **Step 1** Open the workspace that contains the target Lakehouse. **Step 2** Click **Manage access** in the top right. ![Manage access button in a Microsoft Fabric workspace](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/microsoft-fabric-audience/microsoft-fabric-audience-2025-08-21-4.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=154690d5049488f486866ede8a75b33a) **Step 3** Click **Add people or groups**. ![Add people or groups panel in workspace access settings](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/microsoft-fabric-audience/microsoft-fabric-audience-2025-08-21-5.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=abadc41a61b132418fa27d885e7afaf0) **Step 4** Type the client ID's **Display Name** from Azure AD (the App registration name). **Step 5** Assign the **Admin** role and click **Add**. ![Assigning the Admin role to the service principal](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/microsoft-fabric-audience/microsoft-fabric-audience-2025-08-21-6.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=5508896f336c1f2bd698c5bea24526ff) ## Stage the GCS service account key in the Lakehouse Zeotap CDP writes the audience file to a GCS staging bucket first; a Fabric Spark job then reads from GCS and loads the records into the Lakehouse table. That Spark job authenticates to GCS using a JSON key file uploaded into the Lakehouse's **Files** area. ### Prepare the GCP service account Create a dedicated GCP service account for this integration and scope it to the staging bucket only. Grant these bucket-level IAM permissions, either through the predefined **Storage Object Admin** role or as a custom role: * `storage.objects.get` — Read objects from the bucket * `storage.objects.list` — List objects in the bucket * `storage.buckets.get` — View bucket metadata * `storage.buckets.update` — Update bucket metadata Generate a JSON key file for the service account and download it. The file is used by the Fabric Spark job and by the destination configuration in Zeotap CDP. ### Upload the key to the Lakehouse > [!WARNING] > > The key file must be renamed to exactly **`gcs_key`** (no extension in the reference name) before you upload it. The Fabric Spark job reads the credentials from a file with that name; any other filename breaks the load. **Step 1** Open the target Lakehouse in Microsoft Fabric. **Step 2** On your local machine, rename the downloaded service account JSON to `gcs_key`. **Step 3** In the Lakehouse, click **Files → Upload → Upload files**. ![Upload files option under Files in the Fabric Lakehouse](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/microsoft-fabric-audience/microsoft-fabric-audience-2025-08-21-8.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=f7ed4ef9af07cd95a98f79fce89fe184) **Step 4** Upload the renamed `gcs_key` file into the Lakehouse. ![Uploading the renamed gcs_key file to the Lakehouse Files area](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/microsoft-fabric-audience/microsoft-fabric-audience-2025-08-21-9.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=d063618e19fe3e1acd426aba9b60ec32) ## Find the Workspace ID, Database, and Table You need three Fabric values when you build the destination in Zeotap CDP. ### Workspace ID Open your workspace in Microsoft Fabric (or Power BI Service) and read the GUID between `/groups/` and `/home` (or `/list`) in the browser URL: ``` https://app.fabric.microsoft.com/groups/12345678-abcd-1234-abcd-9876543210abcdef/home https://app.powerbi.com/groups/12345678-abcd-1234-abcd-9876543210abcdef/list ``` In both examples, the Workspace ID is `12345678-abcd-1234-abcd-9876543210abcdef`. ### Database The Lakehouse (or Warehouse) name is the **Database** value. For a Lakehouse named `New_Lakehouse`, enter `New_Lakehouse` in the **Database Name** field. ![Lakehouse named New_Lakehouse shown in Microsoft Fabric](https://mintcdn.com/zeotap/vUbSUkv-YgM0J3q4/articles/integrate-customer/Storage/integrate-customer/microsoft-fabric-audience/microsoft-fabric-audience-2025-08-21-10.png?fit=max\&auto=format\&n=vUbSUkv-YgM0J3q4\&q=85\&s=b3333a4398c2ba987060c65e851ebbec) ### Table name Pick a table name. If this is the first load to that Lakehouse and no table with that name exists, Zeotap CDP creates it. Read [Table naming and schema rules](#table-naming-and-schema-rules) before you choose — a bad name choice forces you to recreate the destination later. ## Table naming and schema rules 1. **Table name conflicts.** Do not reuse the name of an unrelated existing table in the target Lakehouse. A name collision breaks ingestion. Use a fresh name unless you intend to append to the existing table. 2. **Schema mismatch fails the upload.** If the incoming audience schema differs from the schema of the existing table (from a prior activation run), the data upload fails. Create a new destination with a new table name to handle a schema change. 3. **Schema merge behaviour.** When the table does not exist, Zeotap CDP creates it. When the table exists and the schema matches, Zeotap CDP appends the new records. When the table exists and the schema differs, the upload fails. 4. **GCS staging folder.** The process creates a folder in your GCS bucket named `.` and stages files there before Fabric ingests them: ``` gs:///./ ``` ## Create the destination in Zeotap CDP **Step 1** Log into the Zeotap CDP App and open the **DESTINATIONS** application. **Step 2** Click **+ Create Destination**. ![Create Destination button in the Destinations application](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/integrate-customer/amazon-s3-destination/ADOBE_DMP_3_\(1\).png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=8af304a0fb2280e517f24a4a2ad84e21) **Step 3** Under **All Destinations**, search for **Microsoft Fabric** and click it. ![Searching for a destination under All Destinations](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/integrate-customer/amazon-s3-destination/ADOBE_DMP_4_\(1\).png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=f6ada97715a2a4a0469fef53698ac3b9) **Step 4** A screen appears with details of the destination on the left and the configuration form on the right. Fill in the form: a. Enter a **name** for the destination. b. In **Azure Tenant ID**, paste the Directory (tenant) ID from Entra. c. In **Client ID** and **Client Secret**, paste the values from the service principal. d. Enter the **Fabric Workspace ID**, **Database Name** (Lakehouse name), and **Table Name**. e. Select the **Upload Type**. Only upload to GCS is supported today. f. Under **Account**, choose one of: ![Account type drop-down on the destination configuration form](https://mintcdn.com/zeotap/49y1_9uVgJhUhPeD/articles/integrate-customer/Storage/integrate-customer/integrate-customer/google-cloud-storage/google-cloud-storage-2024-05-08.png?fit=max\&auto=format\&n=49y1_9uVgJhUhPeD\&q=85\&s=3d522f75b35bc74590ce3b286fe91d2a) * **Zeotap Service Account** — the service account shown under **Service Account to be Whitelisted** auto-populates. Whitelist that service account on your GCS bucket so Zeotap CDP can push audiences to it. ![Zeotap service account auto-populated under Service Account to be Whitelisted](https://mintcdn.com/zeotap/49y1_9uVgJhUhPeD/articles/integrate-customer/Storage/integrate-customer/integrate-customer/google-cloud-storage/google-cloud-storage-2024-05-08-1.png?fit=max\&auto=format\&n=49y1_9uVgJhUhPeD\&q=85\&s=7391a41911ecdaeefb608e54a3772f13) * **Client Service Account Json** — click **+ Select File** and upload your own GCP service account JSON with the bucket permissions listed above. ![Uploading a client service account JSON using the Select File option](https://mintcdn.com/zeotap/49y1_9uVgJhUhPeD/articles/integrate-customer/Storage/integrate-customer/integrate-customer/google-cloud-storage/google-cloud-storage-2024-05-08-2.png?fit=max\&auto=format\&n=49y1_9uVgJhUhPeD\&q=85\&s=06b8cf377a03e9a8fad730be96e2344c) g. Enter the GCS bucket name in the **Bucket** field. h. Review the values and click **Next**. ![Completed destination configuration form before clicking Next](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/integrate-customer/amazon-s3-destination/Screenshot_2025-08-08_at_3.58.33_PM.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=06662691218c28d2f3bad99fc11f2a52) **Step 5** On the mapping screen, under **Choose your Action**, select **Send Json File to MS Fabric**. Click **+ Add mapping field** and add each identifier or attribute you want to send. The value on the right of each mapping row becomes the column name in your Fabric table. ![Mapping screen with the Add mapping field option](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/integrate-customer/amazon-s3-destination/Screenshot_2025-08-08_at_3.59.50_PM.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=294addf86db3f1dd6b19773a08a300e7) **Step 6** Click **Create Destination**. The destination now appears in the **Audiences** application and is ready to link to an audience. For linking an audience to the destination, see [Link an Audience to the Destination](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts that share a defined criterion — for example, customers over 18 who performed an `addToCart` event in the last 30 days. ## Verify the destination worked After linking an audience and triggering an activation, confirm end-to-end delivery in four checks: 1. In the GCS bucket, confirm a folder named `.` exists and contains the staged JSON file(s) from the activation run. 2. In the target Fabric Lakehouse, open the **Tables** view and confirm the table exists with the columns you mapped. 3. Query the table from a Fabric notebook or the SQL endpoint and confirm the row count aligns with the audience size for that run. 4. In Zeotap CDP, open the audience's activation history and confirm the run status is successful. If the GCS folder is populated but the Fabric table is empty, the Spark job has not ingested yet — check the Spark job status inside Fabric. If neither the GCS folder nor the Fabric table has data, work through the troubleshooting table below. ## Troubleshooting | Symptom | What it means | Where to look | | - | - | - | | Upload fails after a successful previous run | The incoming audience schema differs from the schema of the existing table | Fabric Lakehouse → target table → schema. Compare with the mapping in Zeotap CDP → Destinations → *your destination* → mapping | | Ingestion fails on first run with a name conflict | An unrelated table with the same name already exists in the Lakehouse | Fabric Lakehouse → **Tables**. Rename the table in the Zeotap destination or drop the conflicting Fabric table | | Fabric Spark job cannot read the GCS key | The uploaded key is not named exactly `gcs_key`, or the file is missing from the Lakehouse **Files** area | Fabric Lakehouse → **Files**. Confirm `gcs_key` is present | | Authentication fails from Zeotap CDP to Fabric | The client secret has expired, admin consent was not granted, or the service principal lacks the Admin role on the workspace | Entra → App registrations → *your app* → **Certificates & secrets** and **API permissions**. Fabric workspace → **Manage access** | | Audience file never lands in the GCS bucket | The Zeotap or client service account is not whitelisted on the bucket, or the bucket name is misspelt on the destination | GCP → target bucket → **Permissions**. Zeotap CDP → destination configuration | | Service-principal calls to Fabric return unauthorised | The tenant setting **Service principals can call Fabric Public APIs** is disabled, or **Users can access data stored in OneLake with apps external to Fabric** is disabled | Fabric → **Admin portal** → **Tenant settings** → **Developer settings** and **OneLake settings** | ## FAQ > [accordion] What identifiers can I send to Microsoft Fabric? > > Send any identifiers and attributes you have in the audience. The payload is written as JSON, and the resulting Fabric table columns match whatever you configure on the mapping step. Hash values upstream in your audience if you require hashed identifiers in Fabric. > [accordion] What happens when my client secret expires? > > Audience deliveries fail as soon as the secret expires, because Zeotap CDP can no longer authenticate to Fabric. Generate a new client secret in Microsoft Entra before the expiry date, then update the **Client Secret** field on the destination in Zeotap CDP. > [accordion] Can I change the Table name on an existing destination? > > To send an audience to a different table, create a new destination with the new table name. If the schema of the audience changes, also create a new destination — changing the schema of the target table on an existing destination causes the next upload to fail. > [accordion] Do I need my own GCS bucket, or does Zeotap provide one? > > You provide the GCS bucket. Choose whether Zeotap authenticates with its managed service account (which you whitelist on your bucket) or with a client-supplied service account JSON that you upload during destination creation. ## Next steps * [Explore the Microsoft Fabric source →](/articles/integrate-customer/microsoft-fabric) — pull data from Fabric into Zeotap CDP * [Explore linking an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) — activate an audience against the destination you just created * [Explore ID extension for audiences →](/articles/segment-customer/extend-your-audience#id-extension) — expand your audience across identifier types before sending to Fabric # MoEngage Source: https://docs.zeotap.com/articles/integrate-customer/moengage Send user profiles and user events out of Zeotap CDP to MoEngage in real time from a Send to Destinations node in a Journeys workflow. ## What this is The MoEngage real-time integration sends user profiles and user events **out of Zeotap CDP to MoEngage**, as users reach a **Send to Destinations** node in a Journeys workflow. Each delivery either creates a new user profile in MoEngage or updates an existing one, identified by a unique `customer_id`, and can carry standard and custom attributes. The same destination can also send user events, so you can track a user in MoEngage as well and use that activity in personalised campaigns. MoEngage appears three times in Zeotap CDP, in both directions. Use this table to confirm you are on the right page: | Integration | Direction | Runs from | | :- | :- | :- | | **MoEngage** (this page) | Zeotap CDP to MoEngage, real time | Journeys | | [Moengage Audience](/articles/integrate-customer/moengage-audience) | Zeotap CDP to MoEngage, batch | Audiences | | [Moengage Source](/articles/integrate-customer/moengage-source) | MoEngage to Zeotap CDP | Sources | ## Supported identifiers and actions Each user is identified in MoEngage by a unique `customer_id`. On the mapping screen the destination exposes a mandatory identifier field, **Email/Customer ID**, plus attributes: | What you map | Destination fields | | :- | :- | | Identifier (mandatory) | **Email/Customer ID** | | Attributes | **Name**, **First Name**, and any other custom field you add with **+ Add Mapping** | | Event fields (events action only) | **Action**/Event Name, and the Action Attributes or Event Attributes that belong to the event | ## Prerequisites Have the following ready before you create the destination: * **An active MoEngage account.** * **Your Workspace ID** (formerly DATA API ID) and a **Data API Key**. See [Find your MoEngage credentials](#find-your-moengage-credentials). * **Your Data Center number** — `01`, `02`, `03` and so on. See [Find your MoEngage credentials](#find-your-moengage-credentials). * **A workflow in Journeys** containing the filters or conditions that select the users you want to send. See [Create a Workflow](/articles/orchestrate-customer/create-a-workflow). * **A Catalogue field holding the value you want MoEngage to identify each user by**, so you can map it to the mandatory **Email/Customer ID** destination field. * **A role that grants destination edit rights** on the organisation that owns the destination. See [Destinations: prerequisites](/articles/integrate-customer/destinations#prerequisites) and [User Roles and Access](/articles/admin-customer/user-roles-and-access). ## Find your MoEngage credentials The Workspace ID and Data API Key are the credentials MoEngage uses to authenticate its Data APIs, and they are the values you enter on the Zeotap CDP destination. Generate them from your MoEngage Dashboard under **Settings > Account > APIs > Data API Settings**. You also need the data center your MoEngage account runs in. MoEngage's API endpoint follows the pattern `https://api-0X.moengage.com`, where `0X` is your data center number — for example `01`, `02` or `03`. Enter that number on its own in the **Data Center** field. > [!WARNING] > > Treat the Data API Key as a secret. Do not paste it into tickets, screenshots or shared documents. ## Create the MoEngage destination Perform the following steps to create the destination in Zeotap CDP: **Step 1** Log in to the Zeotap CDP App and go to the **DESTINATIONS** application. **Step 2** Click **+ Create Destination**. ![Destinations listing in the Zeotap CDP App, Private Destination tab, with the + Create Destination button highlighted above the list of existing destinations](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-55.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=658e48ccffd76625b94c07aac6ded1ef) **Step 3** Under the **All Destinations** section, search for **MoEngage**. ![All Destinations catalogue in the Zeotap CDP App with the Search for a Destination box highlighted above the destination cards](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-56.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=4d2b0de02268e7ee2b8409fb57104faf) ![All Destinations search box with a partial search term typed in it, showing the single matching MoEngage card described as Track users in MoEngage using the User API](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-57.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=a71b8b641db95eb20e83bbfe64f68278) **Step 4** Click **MoEngage**. A screen appears with details about the destination on the left, and on the right the fields required to establish the integration. Enter the required details: a. Enter a name for the destination. b. Enter the **API Key**, **Workspace ID** and **Data Center** number of your MoEngage instance. See [Find your MoEngage credentials](#find-your-moengage-credentials). c. Review all the values entered above, then click **Next** to proceed. ![Destination Details tab for a MoEngage destination showing the Destination Name, API Key, Workspace ID and Data Center fields with their in-product hints; the API Key and Workspace ID values are masked](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-58.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=a290615ab00f77e1e6889e6b2ed63f8c) **Step 5** On the mapping screen that appears, choose the action and the mapping. For how actions and mappings work, see [Key concepts](/articles/integrate-customer/destinations#key-concepts) and [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). a. Under **Choose your Action**, choose the action you need — **Sync User** to create or update user profiles, or **Send events to moengage** to send user events. b. Under **Map the Fields**, map the Catalogue fields you want to send: * **Email/Customer ID** — mandatory. * **Name**, **First Name**, and any other custom field, using **+ Add Mapping**. * The **Action**/Event Name and the Action Attributes or Event Attributes that belong to the event. These apply to the events action only. ![Mapping screen with Create User listed under Choose your Action, above the Map the Fields table beginning with the Identifiers group](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-59.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=068ccaf1904103e0b5d5e1157d98ed81) ![Map the Fields table with a raw email Catalogue field mapped to the mandatory Email/Customer ID destination field under Identifiers, and two Catalogue attributes mapped to Name and First Name under Attributes](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-60.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=d89d0e36f2b85067571619aa4d36df1e) ![Mapping screen with Send events to moengage selected as the action and the Map the Fields table showing the mandatory Action destination field and Platform, with the Catalogue field names redacted, above the Save Mapping button](https://mintcdn.com/zeotap/HiVWRBJTTMXloYnt/articles/integrate-customer/Storage/integrate-customer/moengage/moengage-2025-10-08-2.png?fit=max\&auto=format\&n=HiVWRBJTTMXloYnt\&q=85\&s=1f9a2b6aa29d908cd40b9108df890bdb) **Step 6** Click **Create Destination**. The created destination gets listed in the Journeys application, where it can be linked to any journey. ## Activate the destination in a Journeys workflow After the destination exists, link it in the **Send to Destination** node within the workflow. **Step 1** In the workflow, click **+** and choose **Send to Destinations**. ![Journeys canvas node menu, Choose an action, with Send to Destinations highlighted and its tooltip explaining that it forwards customer data to channels that send emails, show ads and run analytics](https://mintcdn.com/zeotap/yn2o-zYGriWZb6QH/articles/integrate-customer/Storage/integrate-customer/image-61.png?fit=max\&auto=format\&n=yn2o-zYGriWZb6QH\&q=85\&s=aa94f6912209e6006514133bb87ba796) **Step 2** Choose the destination from the list of available destinations, using the search box if needed. ![Send to Destinations panel with the search box highlighted, the + Add New Destination link above it and a grid of existing destination cards below](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/image-62.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=eb0e1346efa31512b77d0b8df0bdfc30) **Step 3** On the **Destination Details** tab, the API key and data center fields are populated automatically from the values you entered when you created the destination. **Step 4** Click **Save Destination**. The destination is added to the node's selection, as shown below. ![Send to Destinations panel with a MoEngage destination attached to the node, its card showing a destination ID and the Create User action, above the grid of remaining destinations and the Add Destinations button](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/moengage/moengage-2025-08-28.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=b3305a5fa46e3dd269ffc7a096fd1cf6) ## Verify the integration is working Check the following, in order: 1. **The destination is attached.** In the **Send to Destinations** node, the MoEngage card appears at the top of the panel and shows the destination and the action it will run. 2. **The credentials came through.** Open the **Destination Details** tab on the node and confirm the credential fields are populated from the destination you created. 3. **The mapping is the one you intended.** Confirm the mandatory **Email/Customer ID** field is mapped, along with every attribute and event field you expect to send. 4. **A real user's payload reached the node.** Use [Journey Traces](/articles/orchestrate-customer/journey-traces) to search for a user who qualified for the workflow, then inspect the output event for the MoEngage destination node. This shows exactly which fields were sent for that user. 5. **No node-level failures.** Open the **Execution Details** panel on the destination node in the Journey Canvas. See [Identify Journey Errors](/articles/orchestrate-customer/identify-journey-errors). 6. **The records arrived on the MoEngage side.** For a user you found in step 4, open that user's profile in MoEngage and confirm the attributes the trace shows Zeotap sent are present. For what to compare and why the two counts rarely match exactly, see [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). ## Troubleshoot the MoEngage destination | Symptom | Most likely cause | What to do | | :- | :- | :- | | The destination node reports failures in the Journey Canvas | A configuration, credential or payload problem at the node | Open the **Execution Details** panel for the failure status code and the Request ID, then look the code up in [Journey Error Codes](/articles/orchestrate-customer/journey-error-codes). See also [Journey Troubleshooting](/articles/orchestrate-customer/journey-troubleshooting) | | The node records `AUTHENTICATION_ERROR` | The API key, Workspace ID or Data Center number on the destination is wrong or no longer valid | Re-check the values in MoEngage under **Settings > Account > APIs > Data API Settings**, then update them on the destination. See [Find your MoEngage credentials](#find-your-moengage-credentials) | | The node records `BAD_REQUEST` | A mandatory field is missing or a parameter is invalid | Confirm **Email/Customer ID** is mapped, and that the event action's mandatory **Action** field is mapped too | | The node records `EVENT_PARSING_FAILED` | The payload could not be built from the mapping | Review the mapping for the action and the transformation on each mapped Catalogue field | | User profiles arrive in MoEngage but the attributes you expected are missing | Those attributes are not in the mapping, or the node is running a different action | Open the node's mapping and add the attributes with **+ Add Mapping**; confirm the selected action is the one you configured | | The API key or data center on the node is not what you expect | These fields are populated from the destination definition, not set per node | Correct them on the destination itself, or create a new destination with the right values and select it on the node | ### When to escalate If the node still fails after the checks above, open a support ticket — see [Getting help](/articles/orchestrate-customer/journey-troubleshooting#getting-help). Include the workflow name, the destination name, the failure status code and the **Request ID** from the **Execution Details** panel, and the timestamp of a failed execution. ## Next steps * [Create a workflow in Journeys →](/articles/orchestrate-customer/create-a-workflow) * [Debug a single user's path with Journey Traces →](/articles/orchestrate-customer/journey-traces) * [Send audiences to MoEngage in batch instead →](/articles/integrate-customer/moengage-audience) * [Bring MoEngage engagement events into Zeotap CDP →](/articles/integrate-customer/moengage-source) * [Explore the integrations master list →](/articles/integrations-master-list-publication/integrations-master-list) # MoEngage Audience Source: https://docs.zeotap.com/articles/integrate-customer/moengage-audience Send a Zeotap CDP audience out to MoEngage as a MoEngage segment, matching users that already exist in your MoEngage workspace. The MoEngage Audience destination sends audience data **out of Zeotap CDP to MoEngage**, where the matched users become a segment you can target in MoEngage campaigns. For the opposite direction — streaming MoEngage engagement events **into** Zeotap CDP — see [MoEngage Source](/articles/integrate-customer/moengage-source). For the MoEngage destination that is linked from a Journeys workflow instead of from an audience, see [MoEngage](/articles/integrate-customer/moengage). ## What this is MoEngage's Cohort Sync API supports direct server-to-server sync of cohort and audience data into MoEngage. This destination uses that API so you can: * Create custom segments (audiences) in MoEngage for campaigns. * Add users to those segments in real time. * Keep the segments updated, so campaign targeting stays fresh. > [!NOTE] > > Two limits apply to this integration: > > * **No new users are created.** The sync only matches users who already exist in MoEngage, using their `uid`. Audience members with no matching MoEngage user are not added. > * **User dissociation is not supported as of now.** Removing a user from the Zeotap CDP audience does not remove them from the MoEngage segment. ## Supported identifiers The destination maps one identifier: **User ID**. On the mapping screen you pick the Zeotap CDP catalogue attribute that carries the user's MoEngage `uid` and map it to the **User ID** destination field, which is a required string. ## Prerequisites Before you create the destination, gather the following: * **MoEngage account** — an active MoEngage account. * **API keys** — your **Workspace ID** (formerly DATA API ID) and a **Data API Key**. Both are generated from the MoEngage dashboard under **Settings → Account → APIs → Data API Settings**. * **Data centre number** — the `0X` in your account's MoEngage API endpoint `https://api-0X.moengage.com`, replaced with your own data centre number (for example `01`, `02` or `03`). ## How the credentials are used MoEngage's API uses **HTTP Basic authentication**, with your **Workspace ID** as the username and your **Data API Key** as the password. You supply both values once when you create the destination; you do not construct the API request yourself. ## Create the MoEngage destination **Step 1** Log in to the Zeotap CDP App and go to the **Destinations** application under **Integrate**. **Step 2** Click **+ Create Destination**. ![The Destinations listing in the Zeotap CDP App, with the + Create Destination button highlighted in the top right above the table of existing destinations.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-47.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=ef9870f327f0ed5f40542e5978feebac) **Step 3** Under the **All Destinations** section, search for MoEngage. ![The All Destinations catalogue with the Search for a Destination box highlighted above a grid of destination tiles.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-48.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=88f2a300e613ac565a16cb1b3d58e0b2) ![The All Destinations search box filtered to MoEngage, returning the single MoEngage tile described as tracking users in MoEngage using the User API.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-49.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=063a40c9df633101e960a9d3982286ff) **Step 4** Click **MoEngage**. The left of the screen describes the destination; the right lists the fields the integration needs. Provide them as follows: a. Enter a name for the destination. b. Enter the **API Key**, **Workspace ID** and **Data Center** (01, 02, 03 and so on) for your MoEngage instance. See [Prerequisites](#prerequisites) for where these values come from in MoEngage. ![The Destination Details tab of a saved MoEngage destination, showing the Destination Name field, API Key and Workspace ID fields each with a reveal control, and a Data Center field containing a two-digit number.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-50.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=51ecb525969d0f8f493f23ce3446fe35) c. Review all the values you entered and click **Next** to proceed. **Step 5** On the screen that appears, choose the appropriate [action](/articles/integrate-customer/destinations#define-the-mapping) and mapping. Under **Choose your Action**, choose **Sync User/Send Events** as the action. Under **Map the Fields**, map the catalogue attribute holding the user's MoEngage `uid` to the **User ID** destination field. ![The action and mapping screen, with a Choose your Action selector at the top and a Map the Fields row underneath pairing a Choose Catalogue Attribute dropdown with the required User ID destination field of type String. The action shown selected is Add Audience to segment.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-51.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=aecde9348ae7e71049a8cbbe282e0baa) **Step 6** Click **Create Destination**. The destination is then listed in the **Audiences** application and can be linked to any audience. ## Link an audience to the destination **Step 1** In the **Audiences** application, find the audience you want to send, click its **Audience Activation** icon and choose **Link to Destination**. ![The Audiences listing page with audience names obscured, showing the ID, status and last-updated columns and the per-row action icons, including the Audience Activation icon.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-52.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=4e7358e2c44acd9b99bab72e1b9f57f2) **Step 2** In the **Select Destination** panel, search for the MoEngage destination you created and drag it onto the canvas. ![The audience activation canvas with an empty drag-and-drop area on the left and the Select Destination panel on the right, its search box highlighted above a scrollable list of destination cards.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-53.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=4f86b23b6ba4b6877a164e5f5f547d0a) **Step 3** On the **Destination Details** tab, the **Workspace ID**, **API Key** and **Data Center** fields are populated automatically from the values you entered when you created the destination. **Step 4** Click **Save Destination**. The MoEngage destination is attached to the audience. ![The attached MoEngage destination card on the audience canvas, showing the MoEngage logo, the destination name, a destination ID with a copy control, and the configured action Add Audience to segment.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-54.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=19c6864674183f93f5ea405ab0cf6e1d) For the end-to-end linking workflow, including scheduling and the other options on the **Destination Settings** window, see [Activate your batch audiences](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > **Note:** > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an Audience or a segment could be a specific group of customers who are over 18 years of age and who have performed an `addToCart` event within the last 30 days. ## Verify the destination is set up correctly After you save the destination, confirm the following: * The MoEngage destination appears in the **Audiences** application and is selectable when you link an audience. * Once linked, the MoEngage card is shown attached to the audience, carrying the destination name and the action you configured. * The **Workspace ID**, **API Key** and **Data Center** shown on the **Destination Details** tab of the linked destination match the MoEngage instance you intended to send to. Bear in mind when you compare counts that the sync matches only users who already exist in MoEngage, so audience members without a matching MoEngage user will not appear in the MoEngage segment. ## Troubleshoot the MoEngage sync | Symptom | What it means | What to do | | :- | :- | :- | | Users in the Zeotap CDP audience are missing from the MoEngage segment | The sync matches existing MoEngage users by `uid` and does not create new users | Confirm those users already exist in MoEngage, and that the catalogue attribute mapped to **User ID** carries the same value as the MoEngage `uid` | | Users who no longer qualify for the audience are still in the MoEngage segment | User dissociation is not supported by this integration as of now | Manage the removal in MoEngage — Zeotap CDP does not propagate it for this destination | For delivery problems that are not specific to MoEngage, see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail). ## Next steps * [Explore how to activate your batch audiences →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore the MoEngage real-time destination →](/articles/integrate-customer/moengage) * [Explore the MoEngage source →](/articles/integrate-customer/moengage-source) * [Explore how destinations work →](/articles/integrate-customer/destinations) # MoEngage source Source: https://docs.zeotap.com/articles/integrate-customer/moengage-source Bring engagement event data from MoEngage into Zeotap CDP with a Customer Engagement Channels source. ## What this is The MoEngage source carries engagement event data **from MoEngage into Zeotap CDP**, so that what MoEngage records about your customers is unified with the rest of your customer data. For the opposite direction — sending profiles and audiences **out of Zeotap CDP to MoEngage** — see [MoEngage](/articles/integrate-customer/moengage) for real-time journeys and [MoEngage Audience](/articles/integrate-customer/moengage-audience) for audience sync. On the MoEngage side, the feature that exports these events is **MoEngage Streams** (shown in some MoEngage screens as **Events Stream**); it streams event data continuously rather than on a schedule. MoEngage sits in the **Customer Engagement Channels** source category, alongside the other engagement platforms listed under [Customer Engagement Channels](/articles/integrate-customer/customer-engagement-channels). The integration has two halves: 1. **In Zeotap CDP**, you create the MoEngage source. On creation, Zeotap generates an **API URL** and a `write_key` for that source, both shown on its **IMPLEMENTATION DETAILS** tab. 2. **In MoEngage**, that API URL and write key are used to send events to the source you just created. > [!NOTE] > > This page and its child page cover the Zeotap CDP half only. The MoEngage-side configuration — where in MoEngage you enter the API URL and the write key — is not yet documented here. If you need those steps, write to [support@zeotap.com](mailto:support@zeotap.com). ## Prerequisites * An active MoEngage account. * Access to the **Sources** application under **Integrate** in Zeotap CDP. ## Create the MoEngage source Create the source from the **Sources** application: choose **Customer Engagement Channels** as the category and **Moengage** as the data source, give the source a name, and select a **Region**. Zeotap then issues the API URL and `write_key` that the MoEngage side of the integration needs. For the full walkthrough with screenshots, see [Creating a MoEngage stream](/articles/integrate-customer/creating-a-moengage-stream). ## Verify the source is receiving data Find the source on the [source listing page](/articles/integrate-customer/components-of-the-source-listing-page). A newly created source stays at status **Created** until it receives anything; once data starts flowing it moves to **Integrated**, and you can inspect the incoming records on the source's **PREVIEW DATA** tab. ## Next steps * [Creating a MoEngage stream](/articles/integrate-customer/creating-a-moengage-stream) — create the source in Zeotap CDP, step by step. * [Components of the source listing page](/articles/integrate-customer/components-of-the-source-listing-page) — source statuses, ingestion counts and the source report. * [Customer Engagement Channels](/articles/integrate-customer/customer-engagement-channels) — the other engagement platforms you can bring data in from. * [MoEngage](/articles/integrate-customer/moengage) and [MoEngage Audience](/articles/integrate-customer/moengage-audience) — sending data the other way, out of Zeotap CDP to MoEngage. # Moloco Source: https://docs.zeotap.com/articles/integrate-customer/moloco Send audiences from Zeotap CDP out to Moloco DSP as a user list, matched on mobile advertising IDs (MAIDs). ## What this is Moloco is a destination: data flows out of Zeotap CDP to Moloco, and nothing flows back. Moloco DSP is a demand-side platform for programmatic advertising. This integration delivers a Zeotap audience into your Moloco ad account as a **user list**, which you can then target or exclude in your Moloco campaigns. The Moloco UI shows these under **Assets → User Lists**; Moloco's API calls the same object a *customer set*. Moloco is a **batch integration**: you create the destination once, then link an audience (segment) to it from the **Audiences** application, and each audience refresh delivers the matched identifiers to Moloco. It is not driven from a journey. The [integrations master list](/articles/integrations-master-list-publication/integrations-master-list) lists Moloco only as a destination, so there is no Moloco source page to send data the other way. ## Supported identifiers and actions This integration supports MAIDs. The following table lists the available action types for the integration and the supported features for each action type: | Action Name | [ID EXTENSION](/articles/segment-customer/extend-your-audience#id-extension) | [DELETE](/articles/segment-customer/delta-upload-and-delete-functions) | [DELTA UPLOAD](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send identifiers to Moloco DSP | ✅ | - | - | ## Prerequisites Before you create the destination: * Complete the upstream Zeotap CDP setup — a connected source, fields mapped to the Catalogue, and a defined audience. See [Prerequisites](/articles/integrate-customer/destinations#prerequisites) on the Destinations page. * Have a Moloco Ads account with access to the workplace that owns the ad account you want to deliver to. A key authenticates only within the workplace that issued it, so the key and the ad account must belong to the same workplace. * Gather the **API Key** and the **Ad Account ID** described below. Both are required to create the destination. ## Gather the Moloco details Ensure that you have details about the below components of Moloco available before creating a Destination. ### API Key This is the key used to authenticate API calls to Moloco. A Moloco API key is **40 characters long and begins with `ca_`**. A value in any other format — a 36-character UUID, for example — is not a Moloco API key and causes the Destination to fail authentication. To create one, sign in to Moloco Ads Manager and go to **User settings → API Access → Create API Key**. For Moloco's own guidance on creating and managing keys, refer [here](https://help.moloco.com/hc/en-us/articles/22420665601559-Create-and-manage-API-key). Three things to know when you create the key: * **Keys are issued per workplace, not per ad account.** A single key authenticates for every ad account within its workplace, so if you are creating several Destinations for ad accounts in the same Moloco workplace, you can reuse the same key. A key issued for a different workplace will not authenticate. * **An expiry date is mandatory**, up to a maximum of one year. The Destination stops delivering on that date unless the key is renewed, so record the expiry alongside the key. * **The key is masked once saved.** Once the Destination is saved, the API Key cannot be read back in full, so store it securely at the point you create it. > [!WARNING] > > Do not select **Create as read-only API key**. Zeotap updates the user list on every audience refresh, which a read-only key cannot perform. > > A read-only key authenticates successfully, so it does not produce an authentication error — the Destination fails later, at delivery, and no data reaches Moloco. ### Ad Account ID This is the Ad Account ID associated with the Moloco DSP account. It identifies the ad account that Zeotap delivers the user list to. The Ad Account ID is a **16-character alphanumeric string** — for example, `a1b2c3d4e5f6g7h8`. To obtain this information, log into Moloco Ads and click **Ad account settings** below your profile. Under the **Ad Account Info** tab, you can find your Ad Account ID as shown in the image below. ![The Moloco Ad account settings page with the Ad Account Info tab open, showing the ad account title, description, timezone, currency and created date, and a callout box around the Ad Account ID field.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/moloco/moloco-2024-08-05.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=cf956f5ecf5d513db798515670941d47) ## Create the Moloco destination Perform the following steps to create a Destination for Moloco: **Step 1** Log in to the Zeotap CDP App and go to the **Destinations** application. **Step 2** Click **+ Create Destination**. ![The Destinations listing in Zeotap CDP on the Private Destination tab, with the + Create Destination button highlighted above the table of existing destinations.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/moloco/moloco-2024-08-05-1.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=77b2deb2b09b14fa2ff081a51e126fcb) **Step 3** Under the **All Destinations** section, search for **Moloco**. ![The All Destinations catalogue in Zeotap CDP, with the Search for a Destination box highlighted above the alphabetical grid of destination tiles.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/moloco/moloco-2024-08-05-2.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=9bece8582f48a3181466bddf6dcbf88d) **Step 4** Click **Moloco**. A screen appears displaying details about the particular destination towards the left. On the right-hand side of the screen find a list of fields that are required for the integration to be established. Enter the required details as mentioned in the following steps: a. In **Destination Name**, enter a descriptive name for the Destination. b. Enter the **API Key** associated with your Moloco account. c. Enter the **Ad Account ID** obtained from your Moloco account. d. Review all the values entered above and then click **Next** to proceed. ![The Enter Destination Details step for the Moloco destination in Zeotap CDP, showing the Destination Name, API Key and Ad Account ID fields, with the components the integration needs listed in the left-hand panel.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/moloco/moloco-2024-08-05-3.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=8d51cd55436f3785203793da5a6f2d93) **Step 5** In the new screen that appears, under **Choose your Action**, select **Send Identifiers to Moloco DSP** as the action for activating your audience (segment) on the *Audiences* module. Under **Map the Fields**, you can map the desired [output identifier](/articles/segment-customer/choose-the-output-identifiers) to MAID. ![The Mapping step for the Moloco destination in Zeotap CDP, with Send Identifiers to Moloco DSP selected under Choose your Action and a Catalogue field mapped to the MAID destination field under Map the Fields.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/moloco/moloco-2024-08-05-4.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=58d11ef66e2706ade5f07c659735a1aa) **Step 6** Click **Create Destination**. The created Destination gets listed in the **Audiences** application, which can be linked to an audience/segment. ## Link an audience to the destination For information about how to link an audience or segment to the created Destination in the **Audiences** application, refer to [Activate in Audiences](/articles/integrate-customer/link-an-audience-to-the-destination#activate-in-audiences). > [!NOTE] > > **Note:** > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an Audience or a segment could be a specific group of customers who are over 18 years of age and who have performed an *addToCart* event within the last 30 days. ## Verify the delivery Confirm the delivery from both sides, as described in [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked): 1. **In Zeotap CDP** — open the Moloco Destination and review its activity. A successful delivery records a run with a non-zero qualified count and a completed status. A run that fails records an error message you can use to diagnose the cause. 2. **In Moloco** — open the user list and confirm the expected records are present, as described below. The two counts will not match exactly, because every platform applies its own match-rate filtering on the identifiers it receives, but both should be non-zero. To view the Audiences (segments) sent from Zeotap CDP to Moloco, perform the following steps: **Step 1** Log into your Moloco account. **Step 2** Select the Ad Account that you used while creating the Destination in Zeotap CDP, using the drop-down menu. **Step 3** In the left panel, click **Assets** and click **User Lists**. Under the User `List-Zeotap_audience_id-Zeotap_audience_name`, you can find all the audiences sent from Zeotap CDP. ## Troubleshoot the Moloco destination ### The Destination fails with an authentication error (HTTP 401) Moloco returns `HTTP 401` when the API key cannot be validated. Work through these causes in order: | Cause | How to confirm | Fix | | :- | :- | :- | | The value entered is not a Moloco API key | Check its length and prefix — a Moloco API key is 40 characters and begins with `ca_`. Moloco's own platform IDs — workplace, ad account, advertiser, campaign and user list — are all 16-character alphanumeric strings, so a 36-character UUID is never a valid API Key. The saved key is masked on the Destination, so check the copy you stored or the key in Moloco Ads Manager rather than the masked field. | Create a key in Moloco Ads Manager under **User settings → API Access**, then update the **API Key** on the Destination. | | The key has expired | Every Moloco key carries an expiry date, up to a maximum of one year. Check the key's expiry under **User settings → API Access**. | Renew or recreate the key, then update the **API Key** on the Destination. | | The key has been deactivated | A workplace owner or staff-level user can deactivate a key. Check its status under **User settings → API Access**. | Reactivate the key, or create a replacement and update the Destination. | | The key belongs to a different Moloco workplace | A key authenticates only within the workplace that issued it. Confirm the key's workplace is the one that owns the **Ad Account ID** configured on the Destination. | Use a key issued by the same workplace as the ad account. | ### Update the API Key on an existing Destination Each fix above ends with updating the key on the Destination. You do not need to recreate the Destination to do this — recreating it would mean linking your audiences again. Open the Destination in the **Destinations** application, edit the **API Key** field on the **Destination Details** tab, and save. The new key takes effect on the Destination's next scheduled refresh. > [!NOTE] > > A **read-only** key is not a cause of `HTTP 401` — it authenticates successfully. If the Destination authenticates but no data arrives in Moloco, check whether the key was created as read-only. If the error persists after working through the table, contact Zeotap support with the Destination name, the linked audience name, the **Ad Account ID**, confirmation that the key is 40 characters and begins with `ca_` (do not send the key itself), and the timestamp of the last failed run. ## Next steps * [Explore how destinations work → Destinations](/articles/integrate-customer/destinations) * [Explore why deliveries fail → Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail) * [Explore output identifier choices → Choose the output identifiers](/articles/segment-customer/choose-the-output-identifiers) * [Explore the full destination catalogue → Integrations master list](/articles/integrations-master-list-publication/integrations-master-list) # Microsoft Dynamics CRM source Source: https://docs.zeotap.com/articles/integrate-customer/ms-dynamics-source Import data from your Microsoft Dynamics 365 CRM instance into Zeotap CDP, where it can be unified and segmented. The Microsoft Dynamics CRM source brings data **into** Zeotap CDP: Zeotap reads the entities you choose from your Dynamics 365 CRM instance and imports them for unification and segmentation. The flow runs one way only — Microsoft Dynamics CRM appears in the [integrations master list](/articles/integrations-master-list-publication/integrations-master-list) as a source and not as a destination, so there is no opposite-direction Dynamics page for pushing audiences back out. ## What this is Microsoft Dynamics CRM, now called Dynamics 365 CRM, is a Customer Relationship Management solution that helps businesses manage interactions and relationships with customers, prospects, stakeholders and other key contacts. It stores customer interactions in a shared, high-performance SQL database, covers sales, marketing, customer service and support, and integrates with Outlook and Microsoft Office 365. On the Zeotap side this is a batch integration, recorded in the integrations master list as supporting any identifiers and attributes. It synchronises key standard objects such as Contacts and Accounts, and can also fetch data from custom objects. You pick what to bring across when you create the source: you name the Dynamics entity you want (account, campaign and incident/case are typical choices) and declare whether it carries customer data or non-customer entity data. For example, a financial services company can sync customer interactions, service requests and opportunity data from Dynamics CRM into Zeotap CDP, centralise it for analysis and segmentation, and use the result to design targeted marketing strategies and track customer journeys. With configurable sync frequencies, the company keeps that data up to date. ## Set up the source Setup runs in two places. On the Microsoft side you register an app for the integration in your Dynamics 365 tenant and collect the values it issues, then add that app as an application user in the Power Platform environment holding your Dynamics data and note that environment's URL. In Zeotap CDP you then create a source under the **CRM Data** category, enter the values you collected, name the entity to ingest and choose its data entity type. [Create a Microsoft Dynamics CRM source](/articles/integrate-customer/create-a-ms-dynamics-crm-source) covers both stages, including which field on the Microsoft side maps to which field in Zeotap CDP. ## Next steps * [Create a Microsoft Dynamics CRM source →](/articles/integrate-customer/create-a-ms-dynamics-crm-source) * [Compare the other CRM data sources →](/articles/integrate-customer/crm-data) * [Understand customer data and non-customer entity data →](/articles/unify-customer/supported-data-entities) * [Map the catalogue for customer data →](/articles/unify-customer/map-the-catalogue-for-customer-data) * [Map the catalogue for non-customer entity data →](/articles/unify-customer/map-the-catalogue-for-non-customer-entity-data) # Neodata Source: https://docs.zeotap.com/articles/integrate-customer/neodata Send Zeotap CDP audience identifiers out to Neodata, delivered as files to the Azure storage your SAS URL points to. This page covers the Neodata destination, which sends audience identifiers **out of Zeotap CDP** to Neodata — the audience is delivered as files written to the Azure storage that the SAS URL on the destination points to. Data moves in one direction only: Zeotap CDP does not read data back from Neodata. Neodata appears in the [integrations master list](/articles/integrations-master-list-publication/integrations-master-list) as a destination only, so there is no Neodata source page to link to. ## What this is Neodata is a data intelligence platform that provides deeper insights into customer behaviour for more effective targeting and personalised marketing campaigns. It offers services around data analysis, audience segmentation, targeting and optimisation. Integrated with Zeotap CDP, it lets you take an audience you have built from unified customer data and hand it to Neodata for activation. The Neodata destination is a batch integration for audiences: you configure it once against a Neodata client name and an Azure storage SAS URL, then reuse it for every audience you link to it. ## Supported identifiers The Neodata destination accepts: * Mobile advertising IDs (MAIDs) * Neodata cookies On the mapping screen these appear under **Output Identifiers Mapping** — for example, the Catalogue field **Maid** mapped to the Neodata destination field **MAID**. ## Available actions | Action | ID Extension | Delete | Delta Upload | | - | - | - | - | | Send identifiers to Neodata | ✅ | — | — | The destination exposes a single action, **Send identifiers to Neodata**. It supports [ID Extension](/articles/segment-customer/extend-your-audience#id-extension) for expanding an audience before delivery. Neodata is not listed among the integrations where [Delete and Delta Upload](/articles/segment-customer/delta-upload-and-delete-functions) are enabled. ## Prerequisites > [!NOTE] > > Before you create the destination, gather: > > * **A Neodata account.** Both configuration values below are components of that account. > * **Your Neodata client name** — see [Neodata details you need](#neodata-details-you-need). > * **The SAS URL of the relevant Azure storage** — see [Neodata details you need](#neodata-details-you-need). > * An audience to activate, and the destination rights described in the [Destinations prerequisites](/articles/integrate-customer/destinations#prerequisites). ## Neodata details you need The destination asks for two details from your Neodata account. Have both to hand before you start. ### Client name The client name for your Neodata account. You can find it by navigating to the Neodata Console. ### SAS URL The SAS URL of the relevant Azure storage. It is used for authentication, so that Zeotap CDP can upload the audience files to that storage. ## Create the Neodata destination **Step 1** Log in to the Zeotap CDP app and go to **Integrate > Destinations**. **Step 2** Click **+ Create Destination**. ![The Destinations listing in Zeotap CDP with the Create Destination button highlighted](https://mintcdn.com/zeotap/sBMx_EDYCwiX_b1v/articles/integrate-customer/Storage/integrate-customer/rtb-house/RTB_H1.png?fit=max\&auto=format\&n=sBMx_EDYCwiX_b1v\&q=85\&s=989bf48b86088d10e9d6c3b3b8bc0448) **Step 3** Under **All Destinations**, search for **Neodata**. ![The All Destinations catalogue with the Search for a Destination box highlighted](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/rtb-house/RTB_H2.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=4c1d1c71f84cc22f0a9975e76200c682) **Step 4** Click **Neodata**. Details about the destination appear on the left of the screen; the fields the integration needs appear on the right. Enter: a. A name for the destination. Choose a name that identifies the Neodata account it connects to, so the destination is easy to find when you link an audience. b. The **Client Name** of your Neodata account. c. The **Sas Url** — the SAS URL of the relevant Azure storage. d. Review the values you entered, then click **Next**. ![The Enter Destination Details step for Neodata, showing the Destination Name, Client Name and Sas Url fields](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/neodata/neodatab1.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=4be4f36cdaf9d6d5d8a78c4cfbc74259) **Step 5** On the mapping screen, choose the action and the identifiers to send: a. Under **Choose your Action**, select **Send identifiers to Neodata**, then choose the corresponding identifiers under **Map the Fields**. The [output identifiers](/articles/segment-customer/choose-the-output-identifiers) the platform accepts — MAIDs, cookies and more — are shown by default. You can edit, add or remove an identifier from the list; see [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). b. Click **Create Destination**. The created destination is then listed in the **Audience** and **Target** applications, ready to be linked to an audience or segment. ![The Mapping step with Send identifiers to Neodata selected and the Maid catalogue field mapped to the MAID destination field](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/neodata/neodata_2.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=e6e41cdfaff4e1de50678fffc8d88d8a) For the two entry points into destination configuration and what each part of the configuration does, see [Configure a destination](/articles/integrate-customer/destinations#configure-a-destination). ## Link an audience to the destination Once the destination is created, link it to the audience you want to activate from the **Audiences** or **Target** application — see [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination) for the end-to-end workflow. > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience or a segment can be a specific group of customers who are over 18 years of age and have performed an `addToCart` event within the last 30 days. ## Verify the audience reached Neodata Confirm delivery from both sides: 1. **In Zeotap CDP** — open the destination and review its activity. A successful delivery records a run with a non-zero qualified count and a completed status; a failed run records an error message you can use to diagnose the cause. See [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). 2. **In the Azure storage** — the destination uploads the audience as files to the Azure storage the SAS URL points to, so check that the expected files have arrived there for the run you are verifying. ## Troubleshoot the Neodata destination | Symptom | What it means | What to do | | - | - | - | | The run fails and the error points at the upload rather than at the audience | The SAS URL is what authenticates the upload, so Zeotap CDP cannot write the audience files to the Azure storage | Re-check the **Sas Url** recorded on the destination against the SAS URL for the relevant Azure storage, and correct it on the destination | | Zeotap CDP reports a completed run, but no files appear where you expect them | The destination is pointing at a different Azure storage from the one you are checking | Compare the **Sas Url** on the destination with the storage you are inspecting | | The files arrive, but Neodata does not associate them with your account | The **Client Name** on the destination does not match your Neodata account | Re-read the client name in the Neodata Console and correct it on the destination | | The delivery completes but far fewer users are matched than the audience holds | The identifiers mapped on the destination are not identifiers Neodata holds for those users | Review the destination's mapping and confirm the mapped identifiers (MAIDs, Neodata cookies) are actually present on the audience | For delivery errors that are not specific to Neodata — no customers qualified, a terminated refresh, a rejected payload — see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail) and [When to contact support](/articles/integrate-customer/destinations#when-to-contact-support). ## Next steps * [Explore how to link an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore how destinations work across platforms →](/articles/integrate-customer/destinations) * [Explore ID Extension for expanding an audience →](/articles/segment-customer/extend-your-audience#id-extension) * [Explore how to choose the output identifiers →](/articles/segment-customer/choose-the-output-identifiers) # Onboard Raw PII data into Zeotap Source: https://docs.zeotap.com/articles/integrate-customer/onboard-raw-pii-data-into-zeotap How Zeotap ingests, encrypts, masks, and activates raw personally identifiable information (PII) — and the setup steps your organisation owns. ## What this is Zeotap accepts personally identifiable information (PII) — such as email addresses and cell phone numbers — as either pre-hashed values or in raw form. Raw PII onboarding unlocks activation on channels that require unhashed identifiers and strengthens identity resolution compared with one-way hashed values. Zeotap encrypts raw PII at rest, masks it in the UI for every role, and decrypts it only at the point of delivery to destinations that are flagged to receive raw values. This page walks through the onboarding path — catalogue classification, source configuration, storage, and activation — and the controls that keep raw PII protected end-to-end. ## Prerequisites > [!NOTE] > > Before you onboard raw PII, confirm the following: > > * A Zeotap CDP account with a defined organisation catalogue. > * A **Client Admin** or **Editor** role in Collect for the users who will classify catalogue fields and access underlying storage. > * Agreement inside your organisation on which fields carry PII — classification is your organisation's responsibility and drives the encryption and masking behaviour described below. > * For streaming sources (Web JS, Google Tag Manager, pixel tags, mobile SDKs), the corresponding SDK or tag container is already installed on your properties. ## Classify raw PII fields in your catalogue Every field that holds raw PII must be flagged as such in your organisation's catalogue. Classification is the trigger for Zeotap's encryption-at-rest and UI-masking behaviour — an unflagged PII field is stored and displayed as ordinary data. Work through each catalogue field that carries an identifier — email, cell phone number, login ID, or any other direct identifier your organisation recognises — and mark it as raw PII. Repeat for every source that contributes such a field. Flagging the raw PII fields in your organisation's catalogue is the responsibility of your organisation. ## Configure the source to send raw PII The onboarding path depends on the source type. ### Flat-file sources For flat-file uploads (for example, Zeotap Google Cloud Storage), map the raw PII columns to catalogue fields that are flagged as PII. Header rules apply: the first row of a CSV must contain the column names using only alphanumeric characters, spaces, and underscores; other special characters cause ingestion to fail. See [Create a Zeotap Google Cloud Storage Source](/articles/integrate-customer/create-a-zeotap-google-cloud-storage-source) for the full flat-file setup. ### Streaming sources (Web JS, GTM, pixel tags, mobile SDKs) Streaming sources need source-level configuration to declare whether the values you pass are raw or already hashed. The Android SDK, for example, exposes two options — `areIdentitiesHashed` and `hashIdentities` — that together select the behaviour. To send raw identifiers and let Zeotap treat them as raw: ```java theme={null} CollectOptions options = CollectOptions.builder(this) .credential("YOUR_WRITE_KEY") .areIdentitiesHashed(false) // values are raw .hashIdentities(false) // send raw to Zeotap .build(); Collect.init(options); Map identities = new HashMap<>(); identities.put("email", "user@example.com"); identities.put("cellno", "1234567890"); Collect.getInstance().setUserIdentities(identities); ``` Setting both `areIdentitiesHashed(true)` and `hashIdentities(true)` is an invalid combination — the SDK would hash values that are already declared as hashed, producing double-hashed data. Equivalent controls exist for the other SDKs and tag containers: > [card] [Web JS Implementation Guide for Raw PII](/articles/sdks/web-js/api-reference#raw-pii) > [card] [GTM Implementation Guide for Raw PII](/articles/integrate-customer/implementing-google-tag-manager-source-2665775403) > [card] [Adobe Launch — hashing configuration](/articles/sdks/adobe-launch/configure) > [card] [Android SDK — PII hashing configuration](/articles/sdks/android/configurations/hashing) ## How raw PII is stored and processed ### Encryption at rest Any field marked as raw PII in your catalogue is encrypted before it is ingested into Zeotap's graph or underlying BigQuery storage. Zeotap uses the RSA encryption algorithm. The encrypted value is available only to downstream systems that need it for activation. ### Masking in the UI Once a field is classified as raw PII in the catalogue, the value is masked in the Zeotap UI for every role. Users see a masked representation rather than the raw identifier when browsing profiles, previews, or reports. ### Decryption at delivery When you activate an audience to a destination that requires raw identifiers, Zeotap decrypts the field values at the delivery step and pushes them in raw form. No key is exchanged with the destination, because the destination consumes the raw identifier directly. > [!NOTE] > > Destinations that accept raw PII are marked with the `Accepts Raw PII` flag both in the destination configuration and in the destination selection screen. Use that flag to identify eligible channels before you build the activation. ### Access to underlying storage Direct access to the BigQuery datasets or Google Cloud Storage buckets that back your Zeotap account is restricted to users with the **Client Admin** or **Editor** role in Collect. A Zeotap representative can request time-boxed access for debugging or product support; that access is granted only after the account **Admin** approves the request. ## Why this happens Common conditions that block raw PII from being onboarded, encrypted, or activated end-to-end: | Condition | What it means | Where to look | | - | - | - | | Destination is missing the `Accepts Raw PII` flag | The channel does not support raw PII delivery, so decryption at the delivery step will not occur for that destination | Destination selection screen and destination configuration | | Raw PII field is not flagged in the organisation catalogue | The value is stored without the encryption-and-masking treatment and remains visible in the UI as ordinary data | Your organisation's catalogue | | Ingestion failure on a flat-file source | The header row uses characters other than alphanumerics, spaces, or underscores, or a required header is missing | Source Preview and ingestion status for the flat-file source | | SDK configured with both `areIdentitiesHashed(true)` and `hashIdentities(true)` | Invalid combination — the SDK would double-hash the values | SDK initialization code | | `Insufficient Privileges` returned by Salesforce Marketing Cloud when writing to a Data Extension | The SFMC installed package is missing Read/Write permission on Data Extensions | Salesforce Marketing Cloud installed package settings | ## Verify raw PII is protected end-to-end Use these checks to confirm the setup is working. 1. Open the Preview or profile view for a source that contributes the raw PII field. The value appears masked to every role, regardless of permissions — this confirms the catalogue classification has taken effect. 2. Open the destination you plan to activate to and confirm the `Accepts Raw PII` flag is present. If it is absent, the destination will not receive decrypted values. 3. After the first activation run, confirm on the destination side that the identifiers arrived in the raw form expected by that channel — for example, raw email addresses landed in a Salesforce Marketing Cloud Data Extension column of the correct length. ## Troubleshooting > [!WARNING] > > If a raw PII field is not masked in the Zeotap UI for at least one role, stop and re-check the catalogue classification for that field. An unmasked raw PII field is stored and transmitted without the encryption controls described on this page. * **Values arrive at the destination still hashed when raw was expected.** Re-check the SDK or tag-container configuration — a source declaring `areIdentitiesHashed(true)` sends the value through unchanged. Switch to raw declaration and let Zeotap perform any hashing that the destination requires. * **A destination that should accept raw identifiers does not show the `Accepts Raw PII` flag.** Contact your Zeotap customer success representative — flag availability depends on the destination's integration configuration. * **Flat-file ingestion fails on a source that carries raw PII.** Check the header row of the file against the supported schema rules — only alphanumerics, spaces, and underscores are permitted in header names, and every header must be present. * **BigQuery or GCS access is denied to a user who needs to inspect underlying storage.** Confirm that user holds the **Client Admin** or **Editor** role in Collect; other roles cannot reach the underlying storage. ## When to contact support Contact your Zeotap customer success representative when: * A destination you need does not carry the `Accepts Raw PII` flag and you require raw-identifier activation on that channel. * Raw PII values remain visible in the UI after catalogue classification and a repeat ingestion. * A Zeotap representative has requested time-boxed access to your BigQuery or GCS storage and you need to review or approve the request. Include in your request: * The source name and, for flat-file sources, a sample header row. * The catalogue field name(s) that carry the raw PII. * The destination name and the action you are trying to activate. * For SDK sources, the values of `areIdentitiesHashed` and `hashIdentities` (or their equivalents in your SDK). ## FAQ > [accordion] Which encryption algorithm does Zeotap use for raw PII at rest? > > Zeotap uses the RSA encryption algorithm to encrypt fields classified as raw PII in your organisation's catalogue before storing them in the graph or underlying BigQuery storage. > [accordion] Who can access the underlying BigQuery or GCS storage for my account? > > Users with the **Client Admin** or **Editor** role in Collect can access the BigQuery datasets and Google Cloud Storage buckets provisioned for your account. A Zeotap representative can request time-boxed access for debugging or product support, granted only after your Admin approves the request. > [accordion] Do destinations that receive raw PII need an encryption key from Zeotap? > > No. When Zeotap delivers to a destination flagged as `Accepts Raw PII`, values are decrypted at the delivery step and sent to the destination in raw form. No key exchange is required because the destination consumes the raw identifier directly. > [accordion] Whose responsibility is it to flag raw PII fields in the catalogue? > > Flagging raw PII fields in your organisation's catalogue is the responsibility of your organisation. The classification is the trigger for encryption at rest, UI masking, and decryption-at-delivery behaviour on Zeotap's side. ## Next steps * [Explore Zeotap Google Cloud Storage source setup →](/articles/integrate-customer/create-a-zeotap-google-cloud-storage-source) * [Explore Android SDK PII hashing configuration →](/articles/sdks/android/configurations/hashing) * [Explore Adobe Launch consent and hashing configuration →](/articles/sdks/adobe-launch/configure) * [Explore the Zeotap Pvt Channel destination →](/articles/integrate-customer/zeotap-pvt-channel) * [Explore the Salesforce Marketing Cloud Data Extension destination →](/articles/integrate-customer/salesforce-marketing-cloud-data-extension) # Ongage Source: https://docs.zeotap.com/articles/integrate-customer/ongage Send audiences from Zeotap CDP out to Ongage as contacts in an Ongage list, using your own Amazon S3 bucket as the transfer location. ## What this is Ongage is a destination: data flows out of Zeotap CDP to Ongage, and nothing flows back. Ongage is an email marketing platform that helps your business personalise engagements and drive conversions through data. Integrated with Zeotap, it facilitates you to seamlessly transfer audiences (segments) from Zeotap CDP to Ongage, so that you can use those audiences for targeted and personalised campaigns within the Ongage platform. The transfer runs through storage you own: you give the destination an Amazon S3 bucket, region and folder, and Zeotap CDP stores your exported data there. ## Supported identifiers and actions This integration supports Email addresses, Phone numbers, Country, First Name, Last Name, Address, Gender, IP and any custom attribute that you have created in Ongage. The following table lists the available action types for the integration and the supported features for each action type: | Action Name | [ID EXTENSION](/articles/segment-customer/extend-your-audience#id-extension) | [DELETE](/articles/segment-customer/delta-upload-and-delete-functions) | [DELTA UPLOAD](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send attributes and identifiers to Ongage | — | — | — | ## Prerequisites Ensure that you have the licence to use API with reasonable RPS (requests per second) limits. To do so, perform the following steps: **Step 1** Log into the Ongage platform from your Admin account. **Step 2** Navigate to the [Account Profile](https://connect.ongage.net/account/settings) page. **Step 3** Locate the line item labelled **# of API Calls**. * If the account does not have API access, the "Current limit" column will display "Disabled". * If the account has API access, the "Current limit" column will display the number of API calls per minute allowed. ## Gather the Ongage and Amazon S3 details Ensure that you have the details about the below components of the Ongage before creating a Destination. * Username, Password and Account Code * List ID * S3 Bucket * S3 Region * Folder * Access Token and Secret Access Token ### Username, Password and Account Code In order to connect to your Ongage account via the API, you need the following credentials: * **Username** — The Ongage User's username. * **Password** — The Ongage User's password. * **Account Code** — You can find the **Account Code** in Ongage by performing the following steps: **Step 1** Go to your Ongage dashboard. **Step 2** Click your account name in the top right corner. **Step 3** Select **Profile** from the drop-down menu. **Step 4** The Account Code appears below **Company & Contact Information**. Your email will also be listed there. ### List ID The List ID is a unique identifier assigned to your database on Ongage where you can send data from Zeotap CDP. You can obtain the List ID from your Ongage account by performing the following steps: **Step 1** Go to your Ongage dashboard. **Step 2** In the left navigation panel, click the name of the **List** that you have created. For example, *Test List*. ![The Ongage list picker, with the All Lists panel open and each list name followed by its List ID in brackets.](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/ongage/ongage-2024-05-29.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=db535e7aef0d40894ea9af6f8a75a6b6) **Step 3** In the window that appears, find the List ID beside the List name. For example, in the screenshot above, the List ID for the "Test List" is 225009. ### Bucket This is the name of your S3 bucket. You can obtain this information on your Amazon S3 account by navigating to **Buckets**. In the example shown below, **test-adobe-s3-bucket** is the bucket name. ![The Amazon S3 console showing a bucket opened from Buckets in the left navigation, with the bucket name shown in the breadcrumb and page heading.](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/ongage/ongage-2024-05-29-1.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=05367018e398b1dac3f11b10431a102f) ### S3 Bucket Region This is the geographical location where the Amazon S3 storage is available. You can obtain this information by navigating to the **Properties** tab under the Amazon S3 bucket as shown in the image below. ![The Properties tab of an Amazon S3 bucket, with the AWS Region shown under Bucket overview.](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/ongage/ongage-2024-05-29-2.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=114c622c11dba5b9a9a6958fefbabd42) ### Folder In Amazon S3, a folder serves as a logical container for organising stored objects within a bucket. In reality, there are no actual folders in Amazon S3. Instead, the folder concept is emulated by employing object key names containing slashes ("/") to replicate a hierarchical arrangement. You can obtain this information from your Amazon S3 account by navigating to the **Objects** tab under the Amazon S3 bucket as shown in the image below. Ensure that you follow the folder structure shown below. `folder_name/sub_folder_name/` ![The Objects tab of an Amazon S3 bucket, opened on a folder prefix and listing the objects it contains.](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/ongage/ongage-2024-05-29-3.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=aef9998c6c14afa667f761f05f9a3844) ### Access Token and Secret Access Token These are the security tokens that provide secure access to your Amazon S3 resources. You can obtain the Access Token and Secret Access Token by navigating to the **AWS IAM Credentials** tab under **Security credentials** in your Amazon S3 account. ### Restrict bucket access by IP address If you have to allowlist specific IPs due to your security policy, then use the `aws:SourceIp` condition and allowlist the addresses below. They are the values published on Ongage's `outboundips-space-cidr.ongage.net` record. > [!WARNING] > > This list is a static copy of Ongage's published record. It is not re-checked when this page is updated, and Ongage can change the record at any time. Check `outboundips-space-cidr.ongage.net` yourself before you build a bucket policy from these addresses, and re-check it if records stop arriving in your Ongage list. ``` 107.170.213.132/32 107.170.213.133/32 107.170.213.134/32 107.170.213.135/32 107.170.213.136/32 107.170.213.137/32 107.170.213.138/32 107.170.213.139/32 107.170.213.140/32 107.21.59.147/32 107.23.10.125/32 107.23.12.93/32 107.23.14.88/32 107.23.177.90/32 107.23.178.47/32 108.161.135.135/32 108.161.135.37/32 178.128.139.133/32 18.200.73.114/32 18.200.73.64/26 192.241.212.130/32 198.199.88.38/32 206.189.241.97/32 207.244.103.131/32 207.244.103.201/32 207.244.103.202/32 207.244.104.119/32 207.244.104.120/32 207.244.104.121/32 207.244.104.122/32 207.244.104.201/32 207.244.104.202/32 207.244.68.218/32 209.208.109.152/32 209.208.111.38/32 209.208.26.69/32 209.208.78.150/32 23.20.201.102/32 23.21.219.19/32 23.23.212.1/32 3.238.207.64/26 3.251.95.192/26 34.224.117.198/32 34.225.42.120/32 34.226.5.95/32 34.227.41.239/32 34.231.210.31/32 34.231.44.192/26 34.232.157.165/32 34.245.82.192/26 34.245.82.199/32 34.245.82.204/32 34.245.82.233/32 34.245.82.234/32 34.245.82.236/32 34.245.82.237/32 34.245.82.244/32 34.245.82.246/32 34.245.82.247/32 34.245.82.248/32 35.153.84.250/32 50.19.198.209/32 50.56.240.150/32 5.79.106.181/32 69.28.92.114/32 69.28.92.155/32 52.0.251.22/32 52.0.56.158/32 52.1.57.9/32 52.1.99.254/32 52.201.178.193/32 52.204.236.101/32 52.208.21.200/32 52.21.252.120/32 52.2.154.228/32 52.21.93.98/32 52.5.100.202/32 52.7.119.14/32 52.86.21.217/32 54.158.206.24/32 54.165.140.21/32 54.173.254.154/32 54.175.238.172/32 54.205.215.51/32 54.208.127.76/32 54.208.164.47/32 54.208.99.126/32 54.209.202.108/32 54.209.204.31/32 54.209.205.54/32 54.209.208.240/32 54.209.210.149/32 54.209.213.207/32 54.209.232.207/32 54.209.238.30/32 54.209.247.123/32 54.209.247.137/32 54.209.252.68/32 54.209.253.24/32 54.209.253.50/32 54.236.65.189/32 54.236.73.137/32 54.236.83.142/32 54.86.137.29/32 54.88.127.35/32 69.28.93.182/32 69.28.94.223/32 69.28.95.55/32 69.28.95.62/32 81.171.19.60/32 95.85.17.120/32 ``` ## Create the Ongage destination Perform the following steps to create a Destination for Ongage: **Step 1** Log in to the Zeotap CDP App and go to the **Destinations** application. **Step 2** Click **+ Create Destination**. ![The Destinations listing in Zeotap CDP, with the + Create Destination button highlighted above the table of existing destinations.](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/ongage/ongage-2024-05-29-4.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=03ef5145703badd3390c42d1395674fc) **Step 3** Under the **All Destinations** section, search for **Ongage**. ![The All Destinations catalogue in Zeotap CDP, with the Search for a Destination box highlighted above the destination tiles.](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/ongage/ongage-2024-05-29-5.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=28729940f01f456b9fe66f736da98d13) **Step 4** Click **Ongage**. A screen appears displaying details about the particular destination towards the left. On the right-hand side of the screen find a list of fields that are required for the integration to be established. Enter the required details as mentioned in the following steps: a. In **Destination Name**, enter a name for the Destination. b. Enter the **Destination Instance Name**. c. Enter the **Username**, **Password**, **Account Code** and **List ID** that you obtained from your Ongage account. d. In the **Bucket** field, provide the name of the Amazon S3 Bucket. e. In the **S3 Bucket Region** field, provide the geographical region where your Amazon S3 bucket is available. f. In the **Folder** field, provide the folder path in your storage location where Zeotap CDP can store your exported data. g. Enter **Access Token** and **Secret Access Token** that you obtained from your Amazon S3 account. h. Review all the values entered above and then click **Next** to proceed. ![The Enter Destination Details step for the Ongage destination in Zeotap CDP, showing the Destination Name, Destination Instance Name, Username, Password and Account Code fields, with the list of components the integration needs on the left.](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/ongage/ongage-2024-05-29-6.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=51a49d21bf0184ca3f34198126821416) **Step 5** In the new screen that appears, under **Choose your Action**, choose **Send Attributes and Identifiers to Ongage** as your action. This populates the [Output Identifiers](/articles/segment-customer/choose-the-output-identifiers) and attributes that are accepted by the platform such as Email addresses, Phone numbers, Country, First Name, Last Name, Address, Gender and IP, under **Map the Fields**. You can edit or remove the mapping as per your requirement. **Step 6** Click **Create Destination**. The created Destination gets listed in the **Audiences** application, which can be linked to an audience (segment). ## Link an audience to the destination For information about how to link an Audience or segment to the created Destination in the **Audiences** application, refer to [Activate in Audiences](/articles/integrate-customer/link-an-audience-to-the-destination#activate-in-audiences). > [!NOTE] > > **Note:** > > *The terms Audiences and Segments are used interchangeably to refer to customer cohorts > belonging to a specific category. For example, an Audience or a segment could be a specific > group of customers who are over 18 years of age and who have performed an `addToCart` > event within the last 30 days.* ## Verify the delivery Confirm the delivery from both sides, as described in [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked): 1. **In Zeotap CDP** — open the Ongage destination and review its activity. A successful delivery records a run with a non-zero qualified count and a completed status. A run that fails records an error message you can use to diagnose the cause. 2. **In Ongage** — open the list whose List ID you configured on the destination and confirm the expected records are present. The two counts will not match exactly, because every platform applies its own match-rate filtering on the identifiers it receives, but both should be non-zero. ## Next steps * [Explore how destinations work → Destinations](/articles/integrate-customer/destinations) * [Explore why deliveries fail → Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail) * [Explore output identifier choices → Choose the output identifiers](/articles/segment-customer/choose-the-output-identifiers) * [Explore the full destination catalogue → Integrations master list](/articles/integrations-master-list-publication/integrations-master-list) # Optimizely (Real Time) Source: https://docs.zeotap.com/articles/integrate-customer/optimizely Configure the Optimizely real-time destination in Zeotap CDP to send users qualified in a Journeys workflow to Optimizely for web personalisation. ## What this is Optimizely is a web personalisation platform that can run personalised web campaigns on your website. Integrated with Zeotap it enhances Optimizely's offering, allowing businesses to deliver highly personalised and engaging experiences to their website visitors, driving improved conversion rates and customer satisfaction. This page covers the **real-time** Optimizely integration. Users who qualify a Journeys workflow are sent as they qualify to the Optimizely Data Platform (ODP), where Zeotap leverages ODP's capabilities to generate dynamic, real-time segments. Those segments are then used by Optimizely Web and Optimizely Full Stack implementations for personalisation. > [!NOTE] > > Zeotap CDP offers two separate Optimizely destination integrations, configured independently: > > * **This page — Optimizely (Real Time).** Attached to the **Send to Destinations** node of a Journeys workflow, so users are sent as they qualify. > * **[Optimizely (Audience)](/articles/integrate-customer/optimizely-connect-integration).** Created in the **Destinations** application and linked to an Audience or segment in the **Audiences** application. > > Choose the real-time integration when activation should follow a workflow; choose the Audience integration when you are sending a completed audience. ## What this integration sends This integration sends **Optimizely IDs** using the **Send identifiers to Optimizely** action. The Optimizely ID is mapped from your Zeotap CDP Catalogue during destination setup, and users are sent as they qualify the Journeys workflow that the destination is attached to. ## Prerequisites Before you begin, confirm you have: * **An Optimizely Access Token**, obtained from your Optimizely point of contact — see [Access token](#access-token). Zeotap cannot generate this token on your behalf. * **A Catalogue identifier holding your Optimizely IDs** — see [Optimizely ID](#optimizely-id). * **A Journeys workflow** with the user filters or conditions already applied. See [Create a Workflow](/articles/orchestrate-customer/create-a-workflow). * **Permission** to create destinations and publish workflows in your Zeotap CDP workspace. ## Concepts used in this integration Ensure you understand the following concepts before starting this integration. ### Access token An Access Token is a unique identifier that grants Zeotap authorised access to your Optimizely account, through which the data communication is established between Zeotap and Optimizely. Reach out to your Optimizely point of contact to obtain this information. ### Optimizely ID The Optimizely ID is a cookie that Optimizely places on the user's browser and stores in the browser's local storage. Ensure that you capture this ID in Zeotap by using Zeotap's JavaScript or Google Tag Manager (GTM) implementation, so that it is available in your Catalogue to map during destination setup. ### Optimizely Data Platform Optimizely Data Platform (ODP) is a platform that allows businesses to gain a real-time understanding of their customers' behaviours. When customers qualify the Journeys workflow, they are sent to ODP, where Zeotap leverages the capabilities of ODP to generate dynamic and real-time segments. These segments are subsequently utilised by Optimizely Web and Optimizely Full Stack implementations for better personalisation. To learn more about how to get started with ODP, refer [here](https://docs.developers.optimizely.com/optimizely-data-platform/docs). ### Subscription type Based on the Journeys workflow that the customer qualifies for, you can choose the Subscription Type as either **subscribe** or **unsubscribe**. To understand these concepts with respect to the Optimizely platform, consider a customer who visits your website and adds a specific product to their shopping cart: * Under a workflow configured with the Subscription Type as **subscribe**, if the customer's lifetime value (LTV) exceeds \$5000 and they perform the `addToCart` event, they qualify the criteria for subscribing to a campaign that promotes a similar product with enhanced features. * Once the customer goes through the **unsubscribe** workflow, which involves completing the purchase, they transition into the unsubscribe scenario. As a result, they are no longer included in the campaign. ### Audience An Audience is a cohort or segment of customers, which can be identified using identifiers such as phone numbers, email addresses, device IDs, cookies and CRM IDs. An example of an Audience for an e-commerce company is its customers who have added items to their shopping carts but have not completed the purchase. ## Create the Optimizely destination After you have applied filters or added conditions for your users in Journeys, you can activate them in Optimizely under **Send to Destinations**. A new window appears, where you set up your destination. You can use an already existing destination from the list of available destinations, or create a new one by clicking **+ Add New Destination**. ![Destination setup window showing the list of available destinations and the Add New Destination option](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/optimizely/optimizely-2024-08-07.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=691af26831107382e12140b44883d373) To add a new destination: 1. Click **+ Add New Destination**. 2. Search for **Optimizely**. 3. Click **Optimizely** and enter a name for the destination. 4. Enter the **Access Token** that you obtained from Optimizely. ![Optimizely destination setup form with the destination name and Access Token fields](https://mintcdn.com/zeotap/OFEzw22E9lo2DHYT/articles/integrate-customer/Storage/integrate-customer/optimizely/optimizely-2024-08-07-1.png?fit=max\&auto=format\&n=OFEzw22E9lo2DHYT\&q=85\&s=7475592a82bbc1f0161340bac321ed04) 5. Click **Next** to proceed to Actions and Mapping. 6. Under **Choose your Action**, select **Send identifiers to Optimizely** as the action for sending data from the workflow created in Journeys. Under **Map the Fields**, map the appropriate identifier from your Zeotap CDP Catalogue to the Optimizely ID to send data to this destination. ![Actions and Mapping screen with Send identifiers to Optimizely selected under Choose your Action and a Catalogue identifier mapped to the Optimizely ID](https://mintcdn.com/zeotap/OFEzw22E9lo2DHYT/articles/integrate-customer/Storage/integrate-customer/optimizely/optimizely-2024-08-07-2.png?fit=max\&auto=format\&n=OFEzw22E9lo2DHYT\&q=85\&s=0ed6c18f12769e356bf5138fe14d486e) 7. Once the mapping is complete, click **Create Destination**. The destination is created and made available for activation on Journeys. ## Activate the destination on Journeys After creating a destination, link it in the **Send to Destinations** node within the workflow, as explained below. 1. In the workflow, click **+** and choose **Send to Destinations**. ![Journeys workflow canvas with the plus control expanded and Send to Destinations available as the node to add](https://mintcdn.com/zeotap/OFEzw22E9lo2DHYT/articles/integrate-customer/Storage/integrate-customer/optimizely/optimizely-2024-08-07-3.png?fit=max\&auto=format\&n=OFEzw22E9lo2DHYT\&q=85\&s=d9b83927d531d0a8097a8144793c7673) 2. Choose the destination from the list of available destinations by using the search feature. ![Destination panel with the search feature used to find the Optimizely destination among the available destinations](https://mintcdn.com/zeotap/OFEzw22E9lo2DHYT/articles/integrate-customer/Storage/integrate-customer/optimizely/optimizely-2024-08-07-4.png?fit=max\&auto=format\&n=OFEzw22E9lo2DHYT\&q=85\&s=6088bba29178d7381153485acf335489) 3. Under the **Destination Details** tab, the **Access Token** field is automatically populated based on the value you entered while creating the destination. * Under **Subscription Type**, choose either **subscribe** or **unsubscribe** based on your requirement. [Learn more](#subscription-type) * Under **Audience**, select an option from the drop-down. [Learn more](#audience) ![Destination Details tab showing the pre-populated Access Token field, the Subscription Type choice, and the Audience name and description fields](https://mintcdn.com/zeotap/OFEzw22E9lo2DHYT/articles/integrate-customer/Storage/integrate-customer/optimizely/optimizely-2024-08-07-5.png?fit=max\&auto=format\&n=OFEzw22E9lo2DHYT\&q=85\&s=0cd9e202efd53bd1f2105e8a066d756a) 4. Under the **Destination Settings** tab, choose the action and mapping as per your requirement. ![Destination Settings tab where the action and field mapping are chosen for the attached Optimizely destination](https://mintcdn.com/zeotap/OFEzw22E9lo2DHYT/articles/integrate-customer/Storage/integrate-customer/optimizely/optimizely-2024-08-07-6.png?fit=max\&auto=format\&n=OFEzw22E9lo2DHYT\&q=85\&s=4bd4e22e2fba97d84ca60428d80f2e3b) 5. Click **Save Destination**. ## View audiences on Optimizely In the Optimizely console, you can view the real-time segments (Audiences) that are pushed by Zeotap under **CUSTOMERS** > **REAL-TIME SEGMENTS**. ![Optimizely console showing the real-time segments pushed by Zeotap under CUSTOMERS, REAL-TIME SEGMENTS](https://mintcdn.com/zeotap/OFEzw22E9lo2DHYT/articles/integrate-customer/Storage/integrate-customer/optimizely/op_4.png?fit=max\&auto=format\&n=OFEzw22E9lo2DHYT\&q=85\&s=af6916369e23c7392bf4907df40fe7b2) Under the **LISTS** tab, you can view detailed information about each Audience. This includes information such as the total number of subscribers, the unsubscribe rate and more. ![LISTS tab in the Optimizely console showing per-Audience detail including the total number of subscribers and the unsubscribe rate](https://mintcdn.com/zeotap/OFEzw22E9lo2DHYT/articles/integrate-customer/Storage/integrate-customer/optimizely/op_5.png?fit=max\&auto=format\&n=OFEzw22E9lo2DHYT\&q=85\&s=45a4e6aa35cf7e0b0d41d6a919ce9097) ## Verify the destination is live To confirm the integration is working end to end: 1. In the workflow listing screen, confirm the workflow shows **Published** status. A workflow that is not published does not send users to any attached destination. 2. Open the **Send to Destinations** node and confirm the Optimizely destination shows the **Access Token** populated on the **Destination Details** tab and an action selected on the **Destination Settings** tab. 3. In the Optimizely console, open **CUSTOMERS** > **REAL-TIME SEGMENTS** and confirm the real-time segment appears, then open the **LISTS** tab to confirm subscribers are accumulating. If the destination is saved in Zeotap but no segment surfaces in the Optimizely console, work through the Troubleshooting section below. ## Troubleshooting ### The segment does not appear in the Optimizely console Work through the following checks in order: 1. **The workflow is published.** Confirm the workflow shows **Published** status in the workflow listing screen — users only qualify, and are only sent, once the workflow is live. 2. **The mapped Catalogue identifier holds Optimizely IDs.** The Optimizely ID reaches Zeotap only if your Zeotap JavaScript or GTM implementation captures the Optimizely cookie. If the mapped Catalogue field is empty, there is no identifier to send. 3. **The Access Token is current.** The token authorises the data communication between Zeotap and Optimizely — ask your Optimizely point of contact to confirm it has not been rotated or revoked. 4. **The Subscription Type matches your intent.** A node configured as **unsubscribe** removes qualifying users from the campaign rather than adding them to it. Check the **Subscription Type** on the **Destination Details** tab. ### The Create Destination button stays disabled One or more mandatory identifier or attribute fields on the mapping screen have no source field selected. Check every field flagged mandatory under **Map the Fields**. For the configuration errors common to all real-time destinations, see [Activate your real-time audiences](/articles/integrate-customer/activate-your-real-time-audiences#troubleshooting). ### If the checks above do not resolve the issue Contact your Zeotap customer success representative. Include in your request: * The destination name and the name of the Journeys workflow it is attached to * The Audience and Subscription Type configured on the **Destination Details** tab * The time window in which you expected users to qualify the workflow * Confirmation from your Optimizely point of contact that the Access Token is active ## FAQ > [accordion] Where do I get the Access Token from? > > The Access Token is issued by Optimizely, not by Zeotap. Reach out to your Optimizely point of contact and request the token that establishes data communication between Zeotap and Optimizely. > [accordion] Which identifier does this integration send? > > It sends the Optimizely ID — the cookie Optimizely places on the user's browser and stores in the browser's local storage. Capture that cookie in Zeotap through Zeotap's JavaScript or Google Tag Manager implementation, then map the Catalogue identifier holding it to the Optimizely ID during destination setup. > [accordion] What is the difference between the subscribe and unsubscribe Subscription Types? > > **subscribe** adds customers who qualify the workflow to the campaign — for example, customers whose lifetime value exceeds \$5000 and who perform an `addToCart` event. **unsubscribe** applies to the workflow that takes them out again, such as completing the purchase, after which they are no longer included in the campaign. > [accordion] How is this different from the other Optimizely integrations in Zeotap CDP? > > This page covers the real-time integration, which is attached to the **Send to Destinations** node of a Journeys workflow. The [Optimizely (Audience)](/articles/integrate-customer/optimizely-connect-integration) integration is created in the **Destinations** application and linked to an Audience or segment in the **Audiences** application instead. [Optimizely Campaigns (Real Time)](/articles/integrate-customer/optimizely-campaigns) is a separate integration for triggering Optimizely Campaign email sends. > [accordion] Where do the segments show up in Optimizely? > > In the Optimizely console under **CUSTOMERS** > **REAL-TIME SEGMENTS**. The **LISTS** tab shows detail for each Audience, including the total number of subscribers and the unsubscribe rate. ## Next steps * [Explore real-time integrations in Zeotap CDP →](/articles/integrate-customer/real-time-integrations) * [Explore how to activate your real-time audiences →](/articles/integrate-customer/activate-your-real-time-audiences) * [Explore how to create a Journeys workflow →](/articles/orchestrate-customer/create-a-workflow) * [Explore the Optimizely (Audience) destination for activating a completed audience →](/articles/integrate-customer/optimizely-connect-integration) * [Explore the Optimizely Campaigns (Real Time) integration for email activation →](/articles/integrate-customer/optimizely-campaigns) * [Explore the destinations reference for available actions and mapping concepts →](/articles/integrate-customer/destinations) * [Explore the full integrations master list →](/articles/integrations-master-list-publication/integrations-master-list) # Optimizely Campaigns (Real Time) Source: https://docs.zeotap.com/articles/integrate-customer/optimizely-campaigns Send users who qualify for a Journeys workflow from Zeotap CDP out to Optimizely Campaign, and trigger a transactional email there. ## What this is Optimizely Campaigns is a destination: data flows **out of Zeotap CDP to Optimizely Campaign**, so that users who qualify for a Journeys workflow are sent to Optimizely Campaign and trigger an email campaign there. Nothing flows back the other way — the [integrations master list](/articles/integrations-master-list-publication/integrations-master-list) records Optimizely Campaign as a destination only, and this documentation has no inbound Optimizely Campaign page to link as the opposite direction. Optimizely Campaign is an omni channel marketing platform that allows businesses to create, manage, and analyse personalised marketing campaigns across channels such as email, SMS, print, and push notifications. The platform includes features like marketing automation, A/B testing, send-time optimisation, and advanced analytics to help marketers deliver targeted messages and improve customer engagement. ### Which Optimizely destination you need Searching the Zeotap CDP destination catalogue for *Optimizely* returns two cards, and they are not interchangeable: * **Optimizely Campaigns** — Marketing automation Platform. This is the destination this page documents. It sends a raw email address as the **Recipient ID**, plus attributes of your choice. * **Optimizely** — Digital Experience Software (Experimentation, Personalisation). It sends Optimizely IDs. Two pages cover it: [activating it from a Journeys workflow](/articles/integrate-customer/optimizely), and [configuring it in the Destinations application and linking it to an audience](/articles/integrate-customer/optimizely-connect-integration). Both send data outwards. ## Supported identifiers and attributes This integration allows you to send raw email address as **Recipient ID** and any attributes of your choice. **Recipient ID** is the mandatory identifier; the **Mapping** screen marks it as required. Every attribute you send must already exist as a column on the Optimizely Campaign recipient list you are sending to; see [Check the recipient list columns](#check-the-recipient-list-columns). ## Prerequisites Obtain the following before you start: | What you need | Where it comes from | | :- | :- | | **API Username** and **API Password** | Credentials required to create an Optimizely Campaigns destination in Zeotap CDP and send data to Optimizely Campaign. Obtain them from the Optimizely Campaign Support Team. | | **Client ID** | The unique ID created by Optimizely Campaign that enables you to send data. Ask the Optimizely Campaign Support Team to set up an API client for you, then [find the Client ID](#find-the-client-id). | | **Transactional Mail ID** | The ID of the transactional email that Zeotap CDP triggers. See [Create a transactional mail](#create-a-transactional-mail) and [Find the Transactional Mail ID](#find-the-transactional-mail-id). | | **Recipient List ID** | The ID of the recipient list the data is written to. See [Find the Recipient List ID](#find-the-recipient-list-id). | | A recipient list with the right columns | Every field you intend to map must already exist on the recipient list. See [Check the recipient list columns](#check-the-recipient-list-columns). | | A Journeys workflow | The workflow whose qualified users you want to send. See [Create a workflow](/articles/orchestrate-customer/create-a-workflow). | ## Set up Optimizely Campaign Complete these steps in Optimizely Campaign before you create the destination in Zeotap CDP. ### Create a transactional mail **Step 1** Log into your Optimizely Campaign account. **Step 2** In the left navigation panel, click **Campaigns** > **Transactional Mails**. ![The Optimizely Campaign left navigation with Campaigns expanded, showing the Transactional Mails entry alongside Smart Campaigns, Marketing Automation, Opt-in Processes, Message Templates, Landing Pages, and Images and Attachments.](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/optimizely-campaigns/optimizely-campaigns-2025-01-28-4.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=e90305c0043696e8f29770311aefdc7b) **Step 3** Click **Create** and follow the instructions in the [Optimizely Campaign help documentation](https://support.optimizely.com/hc/en-us/articles/4413200600973-Creating-and-editing-campaigns) to set up your email campaign. ### Find the Client ID **Step 1** Log into your Optimizely Campaign account. **Step 2** In the left navigation panel, click **Administration** > **API Overview**. **Step 3** On the **REST API** tab, locate the **Client ID**. ![The Optimizely Campaign API Overview screen on the REST API tab, with the Client ID field highlighted below the tab row of REST API, SOAP API, HTTP API and Post-Click Tracking.](https://mintcdn.com/zeotap/kl8L6sBUYwhq5T7t/articles/integrate-customer/Storage/integrate-customer/optimizely-campaigns/optimizely-campaigns-2025-02-06.png?fit=max\&auto=format\&n=kl8L6sBUYwhq5T7t\&q=85\&s=026f926cf012c54348ff74838925e249) ### Find the Transactional Mail ID **Step 1** Log into your Optimizely Campaign account. **Step 2** In the left navigation panel, click **Campaigns** > **Transactional Mails**. **Step 3** Click the relevant transactional email from the list. **Step 4** Read the **ID** column for the selected email. ![The Optimizely Campaign Transactional Mails screen, with the campaign folder tree on the left and the mail list on the right, and the ID column highlighted beside the Name column.](https://mintcdn.com/zeotap/kl8L6sBUYwhq5T7t/articles/integrate-customer/Storage/integrate-customer/optimizely-campaigns/optimizely-campaigns-2025-02-06-3.png?fit=max\&auto=format\&n=kl8L6sBUYwhq5T7t\&q=85\&s=8542ec0d8e9c3eacf10f845875728c77) > [!NOTE] > > If the **ID** column is not visible, open the column drop-down at the right of the table header and select the **ID** checkbox. > > ![The Transactional Mails table header with the column chooser drop-down open, showing the ID checkbox selected above Name, Description, Status and Link Validation.](https://mintcdn.com/zeotap/kl8L6sBUYwhq5T7t/articles/integrate-customer/Storage/integrate-customer/optimizely-campaigns/optimizely-campaigns-2025-02-06-5.png?fit=max\&auto=format\&n=kl8L6sBUYwhq5T7t\&q=85\&s=119d52e52146f68d2ed87bba3388da82) ### Find the Recipient List ID **Step 1** Log into your Optimizely Campaign account. **Step 2** In the left navigation panel, click **Administration** > **API Overview**. **Step 3** Go to the **Recipient Lists** tab and click the desired recipient list. **Step 4** Read the **ID** column for the selected recipient list. ![The Optimizely Campaign API Overview screen on the Recipient Lists tab, with the ID column highlighted beside the Name and Description columns.](https://mintcdn.com/zeotap/kl8L6sBUYwhq5T7t/articles/integrate-customer/Storage/integrate-customer/optimizely-campaigns/optimizely-campaigns-2025-02-06-2.png?fit=max\&auto=format\&n=kl8L6sBUYwhq5T7t\&q=85\&s=bde09fb2b9446d4dc5319f04e994fda0) ### Check the recipient list columns Every field you map in Zeotap CDP must already exist as a column on the recipient list, so check the list before you build the mapping. **Step 1** In the left navigation panel of Optimizely Campaign, click **Recipients** > **Recipient Lists**. **Step 2** Select your recipient list and read the **Recipient List Details** table. It shows each column's **Display Name**, **Internal Name** and whether it is **Mandatory**. ![The Optimizely Campaign Recipient Lists screen. The Recipient List Details table below it lists the list's columns with Display Name, Internal Name, Mandatory, Type, Shown Data and Occurrence, and an annotation reads: Ensure that the Mandatory fields are correctly mapped in Zeotap CDP.](https://mintcdn.com/zeotap/OFEzw22E9lo2DHYT/articles/integrate-customer/Storage/integrate-customer/optimizely-campaigns/optimizely-campaigns-2025-03-24-1.png?fit=max\&auto=format\&n=OFEzw22E9lo2DHYT\&q=85\&s=a73a56850a35b3dc177e709fb2385e83) ## Create the Optimizely Campaigns destination Once you have applied filters or added conditions for your users in Journeys, you send them onwards from the **Send to Destinations** node in the workflow. Use an existing destination from the list, or create a new one by clicking **+ Add New Destination**. ![The Send to Destinations panel in Journeys, with the + Add New Destination link above a search box and a grid of existing destination cards.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/optimizely-campaigns/optimizely-campaigns-2024-12-03-1.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=ec840711a659ac071d8415905897ca98) **Step 1** Click **+ Add New Destination**. **Step 2** Search for **Optimizely Campaigns**. The search returns two cards — **Optimizely** (Digital Experience Software) and **Optimizely Campaigns** (Marketing automation Platform). They are not interchangeable; this integration uses **Optimizely Campaigns**. ![The All Destinations catalogue with Optimizely typed into the search box, returning two cards: Optimizely, described as Digital Experience Software (Experimentation, Personalisation), and Optimizely Campaigns, described as Marketing automation Platform, which is highlighted.](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/optimizely-campaigns/optimizely-campaigns-2024-12-03-2.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=b9bcd508d8e9be8299857db82c758c19) **Step 3** Click **Optimizely Campaigns** and enter a name for the destination. **Step 4** Enter the **API Username**, **API Password** and **Client ID** that you obtained from Optimizely Campaign, as described in [Prerequisites](#prerequisites). ![The Enter Destination Details screen for an Optimizely Campaigns destination, with fields for Destination Name, API Username, API Password and Client ID.](https://mintcdn.com/zeotap/OFEzw22E9lo2DHYT/articles/integrate-customer/Storage/integrate-customer/optimizely-campaigns/optimizely-campaigns-2025-02-05-2.png?fit=max\&auto=format\&n=OFEzw22E9lo2DHYT\&q=85\&s=c1ab08776ebb987bce759be01e422b60) **Step 5** Click **Next** to proceed to the **Mapping** step. **Step 6** Under **Choose your Action**, select **Send attributes and identifiers to Optimizely Campaigns** as the action to send data from the workflow created in Journeys. Under **Map the Fields**, map the Catalogue fields to the Destination fields as explained below. a. Under **Identifiers**, map the **Recipient ID** — it is mandatory, and the **Mapping** screen marks it as required. Map your raw email address column to it; see [Supported identifiers and attributes](#supported-identifiers-and-attributes). b. After mapping the Recipient ID, ensure that all other column names in the recipient list in the Optimizely Campaign interface match exactly with the Destination Fields in Zeotap CDP. See [Check the recipient list columns](#check-the-recipient-list-columns). c. Map the required columns to the Destination Field on the right-hand side of the **Mapping** screen. ![The Mapping step of destination creation. Choose your Action is set to Send attributes and identifiers to Optimizely Campaigns, and Map the Fields shows an Identifiers row mapping Email Raw to the required Recipient ID destination field, with two attribute rows below it.](https://mintcdn.com/zeotap/OFEzw22E9lo2DHYT/articles/integrate-customer/Storage/integrate-customer/optimizely-campaigns/optimizely-campaigns-2025-02-05-4.png?fit=max\&auto=format\&n=OFEzw22E9lo2DHYT\&q=85\&s=a734bdf87f2eee65f476795931106fff) **Step 7** Once the mapping is complete, click **Create Destination**. The destination is created and made available for activation on Journeys. ![The Send to Destinations panel with the newly created Optimizely Campaigns destination card highlighted among the other destination cards.](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/optimizely-campaigns/optimizely-campaigns-2024-12-03-5.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=225ab4a09b58c03f04be3a77da7859f5) > [!WARNING] > > You need to add all required fields to the desired recipient list in Optimizely Campaigns before mapping them in Zeotap CDP. In addition, ensure that you map the mandatory fields in Zeotap CDP. Skipping this step can result in Destination failure. [Learn more](https://support.optimizely.com/hc/en-us/articles/4413192289805-Introduction-to-recipient-lists) ## Link the destination to a workflow After creating a destination, link it in the **Send to Destinations** node within the workflow. **Step 1** In the workflow, click **+** and choose **Send to Destinations**. ![The Choose an action menu on a Journeys workflow canvas, with Send to Destinations highlighted below Add a Condition, Add a Delay, Create a Multi-branch Split and Create a True/False Split.](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/optimizely-campaigns/optimizely-campaigns-2024-12-03-6.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=71427ee3eee4ef58fa4e4a9047691a86) **Step 2** Choose the destination from the list of available destinations by using the search feature. ![The Send to Destinations panel with the search box above the destination cards and the Optimizely Campaigns card highlighted.](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/optimizely-campaigns/optimizely-campaigns-2024-12-03-5.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=225ab4a09b58c03f04be3a77da7859f5) **Step 3** Under the **Destination Details** tab, the **API Username**, **API Password** and **Client ID** fields are automatically populated from the values you entered while creating the destination. You must additionally enter the **Recipient List ID** and the **Transactional Mail ID** that you obtained from your Optimizely Campaign account — see [Find the Recipient List ID](#find-the-recipient-list-id) and [Find the Transactional Mail ID](#find-the-transactional-mail-id). ![The Destination Details tab for an Optimizely Campaigns destination, showing the Destination Name, API Username, API Password, Client ID, Recipient List ID and Transactional Mail ID fields, with the last two highlighted above the Save Destination button.](https://mintcdn.com/zeotap/OFEzw22E9lo2DHYT/articles/integrate-customer/Storage/integrate-customer/optimizely-campaigns/optimizely-campaigns-2025-02-05-7.png?fit=max\&auto=format\&n=OFEzw22E9lo2DHYT\&q=85\&s=95c07eab4f5aa8133fa34bfb7cce3e7e) **Step 4** Go to the **Destination Settings** tab and choose the correct mapping using the drop-down option. Under **Mapping**, you can confirm the identifier and attributes you are sending to the Optimizely Campaigns platform. ![The Destination Settings tab showing Choose your Action and Mapping with two drop-downs, and a Mapping panel listing the identifiers that will be sent, with an Edit Mapping link.](https://mintcdn.com/zeotap/OFEzw22E9lo2DHYT/articles/integrate-customer/Storage/integrate-customer/optimizely-campaigns/optimizely-campaigns-2025-02-05-6.png?fit=max\&auto=format\&n=OFEzw22E9lo2DHYT\&q=85\&s=0962fdb09bd06481946436dc3e902544) **Step 5** Click **Save Destination** and then click **Add Destination**. **Step 6** The linked destinations appear in the **Send to Destinations** node within the workflow. You can then build and customise your workflow as needed by clicking **+**. You must enter a name for your workflow in the provided text box to save it. ![A Journeys workflow canvas with a workflow name box at the top, an entry condition node, an event node and a Send to Destination node carrying the Optimizely Campaigns icon, above the Cancel, Save Draft and Next: Define Re-entry Criteria buttons.](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/optimizely-campaigns/optimizely-campaigns-2024-12-03-10.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=2fdda006af3050647467549bf9181fd5) **Step 7** After adding conditions and filters for users, choose one of the following options: * **Save Draft** — revisit and edit the workflow before publishing. * **Next: Define Re-entry Criteria** — determine whether a user can re-enter the same workflow. See [Add re-entry criteria](/articles/orchestrate-customer/add-re-entry-criteria). **Step 8** After defining the re-entry criteria, click **Publish Workflow**. The workflow appears in the Workflow listing screen with a **Published** status. ![The re-entry conditions panel asking whether to allow a user to re-enter the journey, with Yes and No options above the Cancel, Save Draft and Publish Workflow buttons.](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26-8.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=634ab0c131fbe99396837bc9f7b8fc91) ## Verify the delivery in Optimizely Campaign To view the recipient lists sent from Journeys (Zeotap CDP) to Optimizely Campaigns, perform the following steps: **Step 1** Log into your Optimizely Campaign account. **Step 2** In the left panel, click **Recipients** > **Overview**. ![The Optimizely Campaign left navigation with Recipients expanded, showing Overview highlighted above Target Groups, Recipient History, Click Profiles, Import, Test Import, Cleanup, Export and Recipient Lists.](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/optimizely-campaigns/optimizely-campaigns-2025-01-28.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=1a4a4c912a1546e5b3f19716dbe3a614) **Step 3** Under **Recipient List**, select the desired list from the left panel and on the right-hand side of the screen. ![The Recipient Overview screen with the Recipient List drop-down open. A list is selected in the tree on the left, and the table on the right shows each list's Name, Description, Recipients count, ID Field, Media Type, Test List, Transaction and Created columns.](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/optimizely-campaigns/optimizely-campaigns-2025-01-28-1.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=53bac06d4bd154a3561e5bb7a33df6fe) **Step 4** In the new screen that appears, you can find all the recipients within the selected recipient list. The **Recipients** table shows a row per recipient with the columns defined on that list, and the footer shows how many items the list holds. ![The Recipient Overview screen with a recipient list selected, showing the Recipients table with one row per recipient and the list's own columns, an item count in the footer, and the Create Recipient, Edit Recipient, Delete Recipient, Block Recipient and Recipient History buttons.](https://mintcdn.com/zeotap/q8FDQtEtJo0G9HKB/articles/integrate-customer/Storage/integrate-customer/optimizely-campaigns/optimizely-campaigns-2025-01-28-2.png?fit=max\&auto=format\&n=q8FDQtEtJo0G9HKB\&q=85\&s=852df3d4c015a5f81029015e6a76178b) ## Troubleshoot the integration ### The destination fails See the warning under [Create the Optimizely Campaigns destination](#create-the-optimizely-campaigns-destination): every field you map must already exist on the recipient list, and **Recipient ID** must be mapped. ### Column names do not agree After mapping the Recipient ID, every other column name in the recipient list in the Optimizely Campaign interface must match exactly with the Destination Fields in Zeotap CDP. [Check the recipient list columns](#check-the-recipient-list-columns) against your mapping and make the two agree before you publish. ### The ID column is not visible in Optimizely Campaign See the note under [Find the Transactional Mail ID](#find-the-transactional-mail-id), which shows the column chooser on the **Transactional Mails** screen. ## Next steps * [Optimizely (Real Time)](/articles/integrate-customer/optimizely) — the other Optimizely destination activated from a Journeys workflow. It sends Optimizely IDs rather than a Recipient ID. * [Optimizely](/articles/integrate-customer/optimizely-connect-integration) — the same Optimizely destination configured in the Destinations application and linked to an audience, listed as the batch integration on the master list. * [Destinations](/articles/integrate-customer/destinations) — how destinations, actions and mappings fit together, including [configuring a destination](/articles/integrate-customer/destinations#configure-a-destination) and [defining the mapping](/articles/integrate-customer/destinations#define-the-mapping). * [Create a workflow](/articles/orchestrate-customer/create-a-workflow) — build the Journeys workflow that feeds this destination. * [Integrations master list](/articles/integrations-master-list-publication/integrations-master-list) — every source and destination Zeotap CDP supports, with its integration type and supported identifiers. # Optimizely Source: https://docs.zeotap.com/articles/integrate-customer/optimizely-connect-integration Send Optimizely IDs from a Zeotap CDP batch audience out to Optimizely, where they arrive as segments for web personalisation. ## What this is This is an outbound batch destination: Zeotap CDP sends Optimizely IDs **out of** your audiences to Optimizely, where they become segments at your Optimizely seat. Nothing flows back into Zeotap CDP from this integration. Optimizely is a web personalisation platform that runs personalised web campaigns. Sending it a Zeotap audience lets you personalise the on-site experience for a cohort you have already built in the CDP, rather than rebuilding that cohort in Optimizely. Zeotap documents three Optimizely pages, served by two destinations in the catalogue: **Optimizely** — this batch page and the real-time page are two lanes of the same destination — and **Optimizely Campaigns**. All three send data outwards; the [integrations master list](/articles/integrations-master-list-publication/integrations-master-list) records every Optimizely integration as a destination, so there is no opposite-direction page to link to. | Page | Activated from | What it sends | | :- | :- | :- | | This page | An audience in the **Audiences** application, on that audience's refresh cycle | Optimizely IDs | | [Optimizely (Real Time)](/articles/integrate-customer/optimizely) | A workflow in **Journeys** | Optimizely IDs | | [Optimizely Campaigns (Real Time)](/articles/integrate-customer/optimizely-campaigns) | A workflow in **Journeys** | A raw email address as Recipient ID, plus attributes of your choice | ## Supported identifiers and actions This integration supports Optimizely IDs. An Optimizely ID is a cookie that Optimizely places in the visitor's browser and stores in the browser's local storage. Capture it into Zeotap CDP through your Zeotap JavaScript or Google Tag Manager (GTM) implementation so that it is available in your Catalogue to map here. See [Optimizely (Real Time)](/articles/integrate-customer/optimizely) for more on the identifier. The following table lists the available action types for the integration and the supported features for each action type: | Action Name | [ID EXTENSION](/articles/segment-customer/extend-your-audience#id-extension) | [DELETE](/articles/segment-customer/delta-upload-and-delete-functions) | [DELTA UPLOAD](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send identifiers to Optimizely | ✅ | ✅ | - | ## Prerequisites Before you create the destination, have the following ready. **From Optimizely — an Access Token.** An Access Token is a unique identifier that grants authorised access to the Optimizely REST APIs, through which data communication is established between Zeotap and Optimizely. Obtain it from your Optimizely point of contact. **In Zeotap CDP.** The Optimizely ID must be present in your Catalogue so you can map it, and the general destination prerequisites apply — a connected source, Catalogue mapping, a defined audience, and a role that grants destination edit rights on the organisation that owns the destination. See [Prerequisites](/articles/integrate-customer/destinations#prerequisites) on the Destinations page. ## Create the Optimizely destination **Step 1** Log in to the Zeotap CDP App and go to the **DESTINATIONS** application. **Step 2** Click **+ Create Destination**. ![The Destinations application's Private Destination list, with the Create Destination button highlighted at the top right of the screen.](https://mintcdn.com/zeotap/V-MPu7vdxSd0lhbu/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/ADOBE_DMP_3.png?fit=max\&auto=format\&n=V-MPu7vdxSd0lhbu\&q=85\&s=1c8e5a4790810b51f24215c455600214) **Step 3** Under the **All Destinations** section, search for **Optimizely**. Two cards match: **Optimizely** (Digital Experience Software) and **Optimizely Campaigns** (Marketing automation Platform). They are not interchangeable — this page uses **Optimizely**. For **Optimizely Campaigns**, see [Optimizely Campaigns (Real Time)](/articles/integrate-customer/optimizely-campaigns). ![The All Destinations catalogue, with the destination search box highlighted above the grid of platform tiles.](https://mintcdn.com/zeotap/V-MPu7vdxSd0lhbu/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/ADOBE_DMP_4.png?fit=max\&auto=format\&n=V-MPu7vdxSd0lhbu\&q=85\&s=bcd32ad55bf14a4fc38b22468297f1d9) **Step 4** Click **Optimizely** (Digital Experience Software). A screen appears with details about the destination on the left and the fields required for the integration on the right. Enter the details as follows: a. Enter a name for the destination. b. Enter the **Access Token** that you obtained from Optimizely. c. Review the values you entered, then click **Next** to proceed. ![The Enter Destination Details step for Optimizely, showing the Destination Name and Access Token fields.](https://mintcdn.com/zeotap/V-MPu7vdxSd0lhbu/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/Optimizely_1.png?fit=max\&auto=format\&n=V-MPu7vdxSd0lhbu\&q=85\&s=b9d05b9501231fbce114a7488a4adaa5) **Step 5** On the next screen, choose the action and the mapping: a. Under **Choose your Action**, select **Send identifiers to Optimizely**. Under **Map the Fields**, map the **Optimizely ID** field from your Catalogue to the **Optimizely ID** destination field. For background on actions and mappings, see [Configure a destination](/articles/integrate-customer/destinations#configure-a-destination) and [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). b. Review the fields you mapped and click **Create Destination**. The destination is then listed in the **Audiences** application, ready to be linked to an audience. ![The mapping step, with the action set to Send identifiers to Optimizely and an Optimizely ID Catalogue field mapped to the Optimizely ID destination field.](https://mintcdn.com/zeotap/V-MPu7vdxSd0lhbu/articles/integrate-customer/Storage/integrate-customer/adobe-target-bulk-update/Optimizely_2.png?fit=max\&auto=format\&n=V-MPu7vdxSd0lhbu\&q=85\&s=9bb8eb01090506a0d30a6b534eb0ddfe) ## Link an audience to the destination For how to link an audience or segment to the created destination in the **Audiences** application, see [Activate your batch audiences](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > **Note:** > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an Audience or a segment could be a specific group of customers who are over 18 years of age and who have performed an *`addToCart`* event within the last 30 days. ## User disqualification from audiences This integration supports user disqualification from audiences. That is, a user can be disqualified from an audience (segment) for various reasons, such as not meeting audience criteria, consent requirements or other conditions set for a particular audience. * When a user disqualifies from an audience, Zeotap CDP initiates a user deletion request in the next refresh cycle. These requests are sent to the audiences linked to the specific destination. * The disqualified users are excluded from the audiences based on the configured refresh frequency for a particular audience. * User disqualification is a programmatic process that works automatically. You do not need to specify anything to trigger the disqualification and exclusion of users from audiences. ## Verify the delivery Confirm the delivery from both sides: 1. **In Zeotap CDP** — open the destination and review its activity. A successful delivery records a run with a non-zero qualified count and a completed status; a failed run records an error message you can use to diagnose the cause. 2. **In Optimizely** — check that the segment has appeared at your Optimizely seat. Allow up to three business days after the audience is linked before treating a missing segment as a failure. The two counts will not match exactly, because the destination platform applies its own matching on the identifiers it receives, but both should be non-zero. For the errors that surface on an audience–destination pair and what to do about each, see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail). ## Next steps * [Activate your batch audiences →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Understand Delta Upload and Delete functions →](/articles/segment-customer/delta-upload-and-delete-functions) * [Extend an audience with ID Extension →](/articles/segment-customer/extend-your-audience#id-extension) * [Send Optimizely IDs from a Journeys workflow instead →](/articles/integrate-customer/optimizely) * [Trigger Optimizely Campaigns emails from a Journeys workflow →](/articles/integrate-customer/optimizely-campaigns) # Payload Preview for Destination Mappings Source: https://docs.zeotap.com/articles/integrate-customer/payload-preview-for-destination-mappings Generate a sample payload from the destination mapping screen to see exactly what Zeotap will send, and verify field values, structure and format before the mapping goes live. **Payload Preview** lets you see exactly what data Zeotap will send to a destination before your mapping goes live. Instead of activating the destination and waiting to find out whether the data arrived correctly, you generate a sample payload while you are still on the mapping screen and check the field values, structure and format upfront. It is available on the mapping screen for both **audience (batch)** and **real-time** destinations. > [!NOTE] > > This is not the same as the **Preview Data** tab on a source, which shows the data Zeotap has *ingested*. Payload Preview shows the payload Zeotap would *send out* to a destination. For the source-side view, see [Knowing the Fields on the Preview Data Tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab). ## Generate a preview **1. Open the mapping** Go to **Integrate → Destinations** and open the destination you want to check. On the **Mapping** tab, open an existing mapping or create a new one. **2. Complete the field mapping** Pick the action under **Choose your Action**, then map your Catalogue fields to the destination fields under **Map the Fields**. **3. Click Generate Preview** **Generate Preview** sits at the bottom of the mapping screen, next to **Save Mapping**. ![Destination mapping screen with the Choose your Action and Map the Fields steps completed, and the Generate Preview button at the bottom next to Save Mapping.](https://mintcdn.com/zeotap/ad6k4u_CQsYw95mu/articles/integrate-customer/Storage/integrate-customer/payload-preview-for-destination-mappings/generate-preview-button.png?fit=max\&auto=format\&n=ad6k4u_CQsYw95mu\&q=85\&s=7b56f4f6bb3b952ec2cd648b9fbad10b) > [!NOTE] > > **Generate Preview** stays disabled until at least one field is mapped. **4. Wait for the payload to build** The **Payload Preview** panel opens on the right and reports its status while Zeotap pulls a sample record from your Catalogue to populate the fields. Generating the payload takes around a minute. ![Payload Preview panel open on the right of the mapping screen, showing the "Generating preview…" status line while the payload is built.](https://mintcdn.com/zeotap/ad6k4u_CQsYw95mu/articles/integrate-customer/Storage/integrate-customer/payload-preview-for-destination-mappings/payload-preview-generating.png?fit=max\&auto=format\&n=ad6k4u_CQsYw95mu\&q=85\&s=ab2aaa541212a3713e094e96ba3bb6a7) ## Read the preview Once generation finishes, the panel shows the sample payload structured exactly as it would be sent to the destination. Click **Cancel** to close the panel and return to the mapping. ![Payload Preview panel showing the generated Destination Payload Preview as formatted JSON, including identifiers, profile attributes and a nested list of objects.](https://mintcdn.com/zeotap/ad6k4u_CQsYw95mu/articles/integrate-customer/Storage/integrate-customer/payload-preview-for-destination-mappings/payload-preview-payload.png?fit=max\&auto=format\&n=ad6k4u_CQsYw95mu\&q=85\&s=1f96140eb8da0a3a1f45851f94149891) The payload includes: * **Mapped identifier fields** — such as `external_id` and `email`. * **Profile attributes** — such as `first_name` and `last_name`. * **Mapped lists, objects, and nested custom attributes** — a mapped list of objects appears as a nested array in the payload. * **Timestamps added by any [enrichers](/articles/segment-customer/enrichers-in-destination-mapping)** applied to the mapping. * **Destination-specific attributes** — for example, for Braze destinations the audience-name key is set to `true` automatically. A Braze payload built from a mapping that includes a list of objects and a timestamp enricher looks like this: ```json theme={null} { "attributes": [ { "external_id": "user_12345", "email": "jane.doe@example.com", "first_name": "Jane", "last_name": "Doe", "lobj": [ { "child": "The Hitchhiker's Guide to the Galaxy", "timestamp": "2023-01-15T10:30:00Z" }, { "child": "Pride and Prejudice", "timestamp": "2023-02-20T14:00:00Z" } ], "{audience_name}": true } ], "partner": "Zeotap" } ``` ## What to check in the preview **Values appear as expected.** Confirm that each destination field is populated with the correct Catalogue field value. If a field is empty or shows an unexpected value, go back to **Map the Fields** and review the mapping for that field. **Type mismatches.** If a Catalogue field has a different data type than the destination field expects — for example a value mapped as a string where the destination requires an integer — the field may come through empty in the preview. That is a signal to either correct the field type in your Catalogue or adjust the mapping. **All required fields are present.** Mandatory fields left unmapped do not appear in the payload at all. Review the mapping and make sure every required destination field is covered before you activate. ## Things to note > [!NOTE] > > The preview uses **sample data only**. No real customer records are sent to the destination while the preview is generated. > [!NOTE] > > The preview reflects the mapping **at the time it was generated**. If you change the mapping afterwards, generate a new preview to see the updated payload. > [!WARNING] > > Payload Preview is available for **server-side destinations** only. ## Next steps * [Learn how mappings are defined →](/articles/integrate-customer/destinations#define-the-mapping) * [Create a Destination →](/articles/integrate-customer/create-a-destination) * [Customise fields with Enrichers in Destination Mapping →](/articles/segment-customer/enrichers-in-destination-mapping) * [Activate your batch audiences →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Activate your real-time audiences →](/articles/integrate-customer/activate-your-real-time-audiences) # Permutive Source: https://docs.zeotap.com/articles/integrate-customer/permutive Send audience identifiers out of Zeotap CDP to your Permutive seat by configuring Permutive as a batch destination. ## What this is Permutive is a batch **destination**: data flows out of Zeotap CDP to Permutive, where the audiences you build in Zeotap arrive as segments on your Permutive seat. There is no inbound Permutive integration — Zeotap does not read data back from Permutive. Permutive is a data management platform (DMP) that allows publishers and marketers to collect, store and activate their first-party data in real-time. Integrated with Zeotap, it allows marketers to coordinate and utilise your fragmented buckets of disconnected data. > [!NOTE] > > **Note:** > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an Audience or a segment can be a specific group of customers who are over 18 years of age and have performed an `addToCart` event within the last 30 days. ## Supported identifiers and actions This channel supports AppNexus Cookie, MAIDs and Hashed email addresses. The following table lists the available action types for the integration and the supported features for each action type: | Action name | [ID extension](/articles/segment-customer/extend-your-audience#id-extension) | [Delete](/articles/segment-customer/delta-upload-and-delete-functions) | [Delta upload](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send identifiers to Permutive | ✅ | – | – | ## Prerequisites Before you create the destination, have the following ready: * **Organisation ID** — the Seat ID of the client who is requesting the segment. Permutive calls this the **Organization ID** and publishes it under **Settings** in the Permutive Dashboard; take care not to confuse it with your Permutive Workspace ID. See [Permutive: Imports](https://docs.permutive.com/products/connectivity/imports). This is an optional field and must be filled only if you want to push the segment to a particular Seat ID. * **Currency** — the currency value to apply to the destination, chosen from the drop-down menu. ## Create the Permutive destination Perform the following steps to create a destination for Permutive: **Step 1** Log into the Zeotap CDP App and go to the **Destinations** application. **Step 2** Click **+ Create Destination**. ![The Destinations list in the Zeotap CDP App, with the Create Destination button highlighted above the list of existing destinations.](https://mintcdn.com/zeotap/wwl-XxoFg7U2kGQg/articles/integrate-customer/Storage/integrate-customer/pubmatic/ADOBE_DMP_3.png?fit=max\&auto=format\&n=wwl-XxoFg7U2kGQg\&q=85\&s=bbc9384154e2f29441289e0b62fcf27c) **Step 3** Under **All Destinations**, search for Permutive. ![The All Destinations catalogue, with the search box highlighted above a grid of destination platform cards.](https://mintcdn.com/zeotap/wwl-XxoFg7U2kGQg/articles/integrate-customer/Storage/integrate-customer/pubmatic/ADOBE_DMP_4.png?fit=max\&auto=format\&n=wwl-XxoFg7U2kGQg\&q=85\&s=7418bc2d2797ca5695fe5bf9dce05d28) **Step 4** Click **Permutive**. A screen appears displaying details about the particular destination towards the left. On the right-hand side of the screen find a list of fields that are required for the integration to be established. Enter the required details as mentioned in the following steps: a. Enter a name for the destination. b. Enter the publisher's Permutive **Organisation ID**. c. Select the appropriate **Currency** value from the drop-down menu. d. Review all the values entered above and then click **Next** to proceed. ![Step 1 of the Permutive destination wizard, Enter Destination Details, showing the Destination Name, Organisation ID and Currency fields alongside the Permutive description panel.](https://mintcdn.com/zeotap/OFEzw22E9lo2DHYT/articles/integrate-customer/Storage/integrate-customer/permutive_1.png?fit=max\&auto=format\&n=OFEzw22E9lo2DHYT\&q=85\&s=b3aca4eefc690c25c230bcfb1ee49d7a) **Step 5** In the new screen that appears, choose the appropriate action and mapping as explained below. a. Choose the desired [action](/articles/integrate-customer/destinations#configure-a-destination) under **Choose your Action** and then choose the corresponding identifiers under **Map the Fields**. By default, the [output identifiers](/articles/segment-customer/choose-the-output-identifiers) that are accepted by the platform such as MAIDs, cookies, email IDs and more are displayed. However, you can edit, add or remove an identifier from the list. To do so, refer to [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). b. Click **Create Destination**. The created destination gets listed in the **Target** and **Audiences** applications, which can be linked to an Audience or segment. ![Step 2 of the Permutive destination wizard, Mapping, with Send identifiers to Permutive selected as the action and the identifier mapping rows below it.](https://mintcdn.com/zeotap/OFEzw22E9lo2DHYT/articles/integrate-customer/Storage/integrate-customer/permutive_2.png?fit=max\&auto=format\&n=OFEzw22E9lo2DHYT\&q=85\&s=3c812c3697ae88f3dc51570a45174f6e) ## Link an audience to the destination For information about how to link an Audience or segment to the created destination in the **Audiences** and **Target** applications, refer to [Activate your batch audiences](/articles/integrate-customer/link-an-audience-to-the-destination). Note that it can take up to three business days for the segment to be available at the Permutive seat. Once the segment is created, reach out to your Zeotap POC to see that the segment gets activated within the platform and goes live. ## Verify the delivery Allow the full three business days before treating a missing segment as a failure, and remember that the segment is not live on the Permutive side until it has been activated. On the Permutive side, open **Connectivity > Imports** and find the import that backs this destination. Permutive shows a **Status** for each import and a **Last Sync** — the time data was last successfully imported. Permutive also requires a taxonomy mapping segment IDs to names before imported segments can be used; once that is in place the segments become available in the **Cohort Builder** under the **Audience Imports** condition type. See [Permutive: Imports](https://docs.permutive.com/products/connectivity/imports). To check the Zeotap side of the delivery, open the destination and review its activity — a successful delivery records a run with a non-zero qualified count and a completed status, and a failed run records an error message. For the full check on both sides and the errors that surface on an audience–destination pair, see [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked) and [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail). ## Next steps * [Activate your batch audiences →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Choose the output identifiers →](/articles/segment-customer/choose-the-output-identifiers) * [Extend your audience with ID extension →](/articles/segment-customer/extend-your-audience#id-extension) * [Understand delta upload and delete functions →](/articles/segment-customer/delta-upload-and-delete-functions) * [Explore how destinations work →](/articles/integrate-customer/destinations) # Personyze Source: https://docs.zeotap.com/articles/integrate-customer/personyze Send Zeotap CDP audiences and profile attributes out to Personyze, so a Personyze campaign can target the visitors who qualified. ## What this is The Personyze destination sends audiences and profile attributes **out of** Zeotap CDP and into Personyze, where they become a visitor attribute you can target a Personyze campaign on. Nothing flows back the other way: the [Integrations Master List](/articles/integrations-master-list-publication/integrations-master-list) records Personyze as a Destination only, so there is no Personyze source page to read alongside this one. Personyze is a personalisation solution that uses machine learning and behavioural targeting to deliver cross-channel experiences. Once a Zeotap CDP audience has been delivered, Personyze can use it in its own Targeting and Personalisation rules. Zeotap CDP ships two separate Personyze destinations: * **Personyze** — this page. A batch destination, attached to an audience in the **Audiences** application, that sends the audience and its mapped attributes. * **[Personyze Real Time Integration](/articles/integrate-customer/personyze-real-time-integration)** — a real-time destination, attached to a **Send to Destinations** node in a journey, that sends events and user profiles as customers flow through. Both send data in the same direction — out of Zeotap CDP to Personyze. Choose the one that matches where you are activating from, Audiences or Journeys. ## Supported identifiers and actions This integration supports raw email addresses, Custom IDs, First Name, Last Name, Phone and Industry. | Action | [ID extension](/articles/segment-customer/extend-your-audience#id-extension) | [Delete](/articles/segment-customer/delta-upload-and-delete-functions) | [Delta upload](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | **Send Attributes to Personyze** | – | – | – | Because delta upload and delete are not supported, each refresh sends the audience membership as it stands at the time the refresh runs. ## Prerequisites In Zeotap CDP: * An account with permission to create and edit destinations. For the wider destination model — platforms, actions and mappings — see [Destinations](/articles/integrate-customer/destinations). * An [audience](/articles/segment-customer/create-an-audience) defined with the criteria for the cohort you want to send, since the audience name has to be reproduced exactly on the Personyze side. In Personyze: * An active Personyze account. * Permission to view the **Settings → Integrations** screen, so you can obtain the Private API Key. * Permission to add visitor attributes and to edit campaign targeting rules. ## Get your Personyze Private API Key The Private API Key is the encryption key that authenticates API calls in Personyze. Obtain it before you create the destination in Zeotap CDP. **Step 1** Log into the Personyze console and navigate to **Settings → Integrations**. ![Personyze console showing the Campaigns screen, with Settings and Integrations highlighted in the left navigation below Content Placement, Conversion Tracking, Visitor Attributes and Recommendations](https://mintcdn.com/zeotap/puXmsvA7x0OblYvo/articles/integrate-customer/Storage/integrate-customer/personyze/sendinblue_integration_1.png?fit=max\&auto=format\&n=puXmsvA7x0OblYvo\&q=85\&s=1fbbe1ccc329aecc0652ae697cb29373) The Personyze console with Settings expanded in the left navigation and Integrations selected **Step 2** On the **Integrations** screen, click **Get keys** on the **Full-featured API** tile. ![Personyze Integrations screen listing third-party application tiles including Segment, Full-featured API, Google analytics and HubSpot, with the Full-featured API tile's Get keys control opened to a popover containing a key field, a Revoke link and a Generate another key button](https://mintcdn.com/zeotap/OFEzw22E9lo2DHYT/articles/integrate-customer/Storage/integrate-customer/personyze/integration_sendinblu_2.png?fit=max\&auto=format\&n=OFEzw22E9lo2DHYT\&q=85\&s=7902427c5e37673fd45eb474fb01c619) The Personyze Integrations screen, with Get keys clicked on the Full-featured API tile **Step 3** Copy the key and store it somewhere safe. You enter it in the **Private API Key** field when you create the destination in Zeotap CDP. The same popover carries **Revoke** and **Generate another key** controls. If you revoke or regenerate this key later, update the Zeotap CDP destination with the replacement, or deliveries stop authenticating. ## Create the Personyze destination **Step 1** Log into the Zeotap CDP App and go to the **DESTINATIONS** application. **Step 2** Click **+ Create Destination**. ![Zeotap CDP Integrate Destinations screen on the Private Destination tab, showing a table of existing destinations with ID, destination name, created date and last updated columns, and the Create Destination button highlighted top right](https://mintcdn.com/zeotap/OFEzw22E9lo2DHYT/articles/integrate-customer/Storage/integrate-customer/personyze/ADOBE_DMP_3_\(1\).png?fit=max\&auto=format\&n=OFEzw22E9lo2DHYT\&q=85\&s=816d7f247d590bc7bb09fff1e0b92a3d) The Zeotap CDP Destinations listing, with Create Destination highlighted **Step 3** Under **All Destinations**, search for **Personyze**. ![Zeotap CDP All Destinations catalogue with the Search for a Destination box highlighted above a grid of destination tiles](https://mintcdn.com/zeotap/OFEzw22E9lo2DHYT/articles/integrate-customer/Storage/integrate-customer/personyze/ADOBE_DMP_4_\(1\).png?fit=max\&auto=format\&n=OFEzw22E9lo2DHYT\&q=85\&s=9cca1024dea8e775f5b0ad6aa1d68a75) The All Destinations catalogue, with the search box highlighted **Step 4** Click the **Personyze** tile. A panel describing the destination appears on the left, and the fields required to establish the integration appear on the right. Enter: * **Destination Name** — a name that identifies this destination later, when you link an audience to it. * **Private API Key** — the key you obtained from your Personyze account above. Review the values and click **Next**. ![Zeotap CDP Enter Destination Details screen for Personyze, showing a Destination Name field and a Private API Key field with placeholder entries, a Destination Details and Mapping progress indicator, and a Next button](https://mintcdn.com/zeotap/puXmsvA7x0OblYvo/articles/integrate-customer/Storage/integrate-customer/personyze/personyze_11.png?fit=max\&auto=format\&n=puXmsvA7x0OblYvo\&q=85\&s=a1338b211255da4f9259a711e4f40f50) The Enter Destination Details step for Personyze, with the Destination Name and Private API Key fields **Step 5** Under **Choose your Action**, select **Send Attributes to Personyze**. This auto-populates Internal ID, Email, First Name, Last Name, Phone and Industry under **Map the Fields**. You can edit or remove any field from the mapping except the mandatory ones, which are marked with an asterisk. ![Zeotap CDP Mapping screen with Send Attributes to Personyze selected under Choose your Action, and a Map the Fields table pairing Catalogue fields such as Contact Id and First Name with destination fields including Internal ID and Email, both marked as required](https://mintcdn.com/zeotap/OFEzw22E9lo2DHYT/articles/integrate-customer/Storage/integrate-customer/personyze/personyse_mapping_1.png?fit=max\&auto=format\&n=OFEzw22E9lo2DHYT\&q=85\&s=933a0f2dd8d489d8341626c57367c36f) The Mapping step, with Send Attributes to Personyze chosen and Catalogue fields mapped to Personyze destination fields For the rules that govern actions and mappings across every destination, see [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). **Step 6** Click **Create Destination**. The destination is then listed in the **Audiences** application, ready to be linked to an audience. ## Create a matching visitor attribute in Personyze Before you link an audience to the Personyze destination, create a visitor attribute in Personyze whose name is the audience name. Personyze matches on this attribute, so the names have to agree exactly. **Step 1** Log into Personyze. **Step 2** In the left navigation panel, under **Settings**, click **Visitor Attributes**. **Step 3** Under **User cross-session attributes**, click **+ Add new attribute**. ![Personyze Visitor Attributes screen showing the User session-limited attributes and User cross-session attributes rows, with Add new attribute opened to a small form containing Inner name, Display name and Data type fields above a table of existing attributes](https://mintcdn.com/zeotap/OFEzw22E9lo2DHYT/articles/integrate-customer/Storage/integrate-customer/personyze/personyze-2024-05-07-3.png?fit=max\&auto=format\&n=OFEzw22E9lo2DHYT\&q=85\&s=d1c4ecc6a4a69d8209a2fcbe9819496c) The Personyze Visitor Attributes screen, with Add new attribute opened on the User cross-session attributes row **Step 4** In the pop-up window, enter the **Display name** of the attribute. It must match the name of the audience created in Zeotap CDP exactly — if the audience is named `GCS Test Audience`, the Display name must also be `GCS Test Audience`. **Step 5** For **Inner name**, give the same name in lower case, with spaces replaced by underscores — for example, `gcs_test_audience`. **Step 6** Click **Add**. ## Link an audience to the destination With the destination created and the Personyze attribute in place, link the audience to the destination in the **Audiences** application. The steps are the same for every batch destination — see [Activate in Audiences](/articles/integrate-customer/link-an-audience-to-the-destination#activate-in-audiences), which also covers the refresh frequency and the output identifier mapping. Saving the destination on the audience moves it to **In Progress** while the IDs upload, and to **Success** once the upload completes. > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category — for example, customers over 18 years of age who performed an `addToCart` event in the last 30 days. ## Add the targeting rule in Personyze After you link an audience to the Personyze destination, add a targeting rule in Personyze for the user profiles that qualified for the audience to be pushed to Personyze. **Step 1** Log into Personyze and navigate to **Campaigns → Targeting and Personalisation**. **Step 2** Click **Add** beside **User CRM/ABM/Profile data**. ![Personyze Visitor Targeting screen inside a campaign, listing the rule categories Pages Visited, Countries/Cities, User CRM/ABM/Profile data and Device and System, with User CRM/ABM/Profile data and its Add control highlighted](https://mintcdn.com/zeotap/OFEzw22E9lo2DHYT/articles/integrate-customer/Storage/integrate-customer/personyze/personyze-2024-05-07-4.png?fit=max\&auto=format\&n=OFEzw22E9lo2DHYT\&q=85\&s=1090cbe9b9bf6232a2554d87eb6a1e88) The Visitor Targeting screen, with the User CRM/ABM/Profile data rule category highlighted **Step 3** In the pop-up window, set the condition: `Visitor matches if <= equal> ` **Step 4** Choose the attribute you created from the drop-down list, then click **Add**. ![Personyze User CRM/ABM/Profile data rule row reading Visitor matches if Include, Any of, a named user attribute, equal, true, with Cancel and Add buttons](https://mintcdn.com/zeotap/OFEzw22E9lo2DHYT/articles/integrate-customer/Storage/integrate-customer/personyze/personyze-2024-05-07-5.png?fit=max\&auto=format\&n=OFEzw22E9lo2DHYT\&q=85\&s=4c1ab0409f3f625a2080b70acabf5c9b) The completed User CRM/ABM/Profile data condition, matching the visitor attribute against true ## Verify the audience reached Personyze Check both sides after the first refresh has run. 1. **In Zeotap CDP** — open the audience–destination pair in the **Audiences** application and confirm the status has moved past **In Progress** to **Success**, with a non-zero qualified count. For what the statuses mean across destinations, see [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). 2. **In Personyze** — go to **Settings → Visitor Attributes** and confirm the attribute you created for this audience is listed under **User cross-session attributes**. Then open the campaign and confirm the targeting rule resolves to that attribute. The two sides will not agree exactly. Personyze can only connect an uploaded profile to a visitor when the identifier it was uploaded with is also observable on your site, so a share of delivered profiles never matches a live visitor. ## Troubleshoot the Personyze destination Work through these before raising a ticket. * **The audience does not appear as an attribute in Personyze.** The attribute is not created by the delivery — you create it yourself, before linking. Confirm it exists under **User cross-session attributes**, that its **Display name** matches the Zeotap CDP audience name character for character, and that its **Inner name** is the same string in lower case with underscores instead of spaces. * **The destination fails to authenticate.** The Private API Key on the destination is the credential for every call. If the key has been revoked or regenerated in **Settings → Integrations**, the destination still holds the old value — edit the destination and paste the current key. * **A mandatory field is empty.** The mapping marks some destination fields as required. If a Catalogue field mapped to one of them is null for part of the audience, those records are the ones to look at first. * **The pair stays In Progress, or the run reports an error.** These are destination-level failures rather than Personyze-specific ones. See [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail) for the errors that surface on an audience–destination pair and what each one means. * **The campaign does not fire for visitors you expect.** Personyze's own guidance on the Visitor Attributes screen is that imported customer data has to carry an identifier key — such as email or a CRM ID — that is also present on your site, as a site cookie, URL parameter, JavaScript variable or page element. Without that, Personyze cannot connect an uploaded profile to the visitor in front of it. Confirm the identifier you mapped in the destination is one Personyze can observe on site. If none of the above applies, see [When to contact support](/articles/integrate-customer/destinations#when-to-contact-support) for what to include in the request. ## FAQ > [accordion] Why are there two Personyze entries in the destination catalogue? > > They are two integrations for the same vendor, distinguished by where you activate from. **Personyze** — this page — is a batch destination attached to an audience in the **Audiences** application. **[Personyze Real Time Integration](/articles/integrate-customer/personyze-real-time-integration)** is a real-time destination attached to a **Send to Destinations** node in a journey, and it sends events and user profiles rather than an audience. Both send data out of Zeotap CDP to Personyze. > [accordion] Why does the Personyze attribute name have to match the audience name? > > Personyze has no knowledge of the Zeotap CDP audience as an object — it only sees a visitor attribute. The audience name is what arrives, so the attribute has to be waiting under that exact name for the value to land on it. That is also why the attribute is created before the audience is linked, not after. > [accordion] Does this destination support delta upload or delete? > > No. Neither delta upload nor delete is supported on this integration, and neither is ID extension. See [Delta upload and delete functions](/articles/segment-customer/delta-upload-and-delete-functions) for the destinations where they are available. > [accordion] Can one Personyze destination serve several audiences? > > Yes. The destination stores the Personyze account credential and the mapping, so it can be linked to as many audiences as you need. Each audience needs its own matching visitor attribute in Personyze, and its own targeting rule in the campaign that uses it. ## Next steps * [Set up the real-time Personyze destination →](/articles/integrate-customer/personyze-real-time-integration) * [Link the audience to the destination →](/articles/integrate-customer/link-an-audience-to-the-destination#activate-in-audiences) * [Review how destinations, actions and mappings fit together →](/articles/integrate-customer/destinations) * [Build the audience that feeds this destination →](/articles/segment-customer/create-an-audience) * [Check what influences upload time to destinations →](/articles/segment-customer/factors-influencing-the-data-upload-time-to-destinations) # Personyze real-time integration Source: https://docs.zeotap.com/articles/integrate-customer/personyze-real-time-integration Send events and user profiles out of Zeotap CDP to Personyze from a Journeys workflow, as they happen. ## What this is The Personyze real-time integration sends data **out of** Zeotap CDP to Personyze: as a customer moves through a Journeys workflow, Zeotap CDP sends that customer's event data — or their profile fields — to your Personyze account as it happens. Personyze is a personalisation platform that tailors the experience each visitor gets on a website or app. It tracks behaviour such as clicks, page views and purchases in real time to work out individual interest and intent, combines that live signal with other information such as CRM profiles, and uses the result to decide which content, product recommendations and offers to show. Sending events and profiles from Zeotap CDP as they happen means Personyze can act on them while the customer is still in the moment. > [!NOTE] > > **Sending audiences instead?** > > To push audiences (segments) to Personyze from the **Audiences** application, so they can be used in Targeting and Personalisation on the Personyze side, see the [Personyze destination](/articles/integrate-customer/personyze). Both pages move data out of Zeotap CDP to Personyze — they differ in what is sent and when. ## Supported identifiers and actions **User Identifier Key** sets the type of identifier Personyze matches on. You can choose **User ID**, **Email** or **Internal ID**, and you map the corresponding value to the **User Identifier Value** destination field in the mapping table. By default the output identifiers the platform accepts — user ID (CUID), email and internal ID — are shown under **Map the Fields**. You can edit, add or remove an identifier in that list. Under **Choose your Action** on the destination form you can pick: | Action | What it sends | | :- | :- | | Send Events to Personyze | Event data from the workflow. You map an **Event Attribute** and the **User Identifier Value** that identifies the customer. | | Send User Profile to Personyze | Customer profile fields, one per mapping row under **User Values**. The supported user profile values are `first_name`, `last_name` and `email`. | ## Prerequisites Before you configure anything in Zeotap CDP, you need: * **An active Personyze account.** * **Your Personyze Private API Key.** This is the secret that authorises Zeotap CDP to send data to your Personyze account. Generate it in your Personyze dashboard under **Settings > Integrations**, from the **Full-featured API** tile. For the step-by-step, see the [Personyze destination](/articles/integrate-customer/personyze) page. * **A populated Personyze Product Catalog.** * **A workflow in Journeys** to send the data from. See [Create a workflow](/articles/orchestrate-customer/create-a-workflow). ## Create the Personyze destination **Step 1** Log into the Zeotap CDP App and go to the **DESTINATIONS** application. **Step 2** Click **+ Create Destination**. **Step 3** Under **All Destinations**, search for **Personyze** and click it. A screen appears with details about the destination on the left and, on the right, the fields required to establish the integration. **Step 4** On the **Enter Destination Details** step, fill in: * **Destination Name** — a name for the destination. * **Private API Key** — the key from your Personyze account. ![The Enter Destination Details step of the Personyze destination form, with an empty Destination Name field and an empty Private API Key field above the Back and Next buttons.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-39.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=70cb68c3be8d2a507c54959c45240205) **Step 5** On the **Mapping** step, choose one action under **Choose your Action** and map the fields beneath it. **Send Events to Personyze** Under **Map the Fields**, pair each Catalogue attribute on the left with the destination field on the right. **Event Attribute** and **User Identifier Value** are the mandatory fields for this action. ![The mapping screen with Send Events to Personyze chosen under Choose your Action, and a Map the Fields table pairing Catalogue attributes with the Event Attribute and User Identifier Value destination fields.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-40.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=ea966e5613159d17c743f12a44e610cd) Then, under **Additional Settings**, choose the **User Identifier Key** — the type of user identifier, either User ID, Email or Internal ID. Map the value that corresponds to it to **User Identifier Value** in the table above. ![The Mapping step of the Personyze destination form, with the Map the Fields table above an Additional Settings section containing the User Identifier Key dropdown.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-41.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=1676360cdba82d5e882706be8ae46d87) **Send User Profile to Personyze** Under **Map the Fields**, the **User Identifier Value** field appears in the mapping table by default. To add a profile field, click **+ Add Mapping Field** in the **User Values** section. This creates a mapping row where the destination field holds the user profile field name and the Catalogue field on the other side is your source data. ![The Mapping step with Send User Profile to Personyze chosen, an Attributes section mapping User Identifier Value, and a User Values section with a first_name destination field and the Add Mapping Field control.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-42.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=b8fa67c97520ed80879731ec6ee8f5cd) Then, under **Additional Settings**: * **User Identifier Key** — the type of user identifier, either User ID, Email or Internal ID. * **Event Attribute** — the user profile value you want to send, in snake_case. The supported values are `first_name`, `last_name` and `email`. Whatever you enter in **Event Attribute** must also be added as the field name on the mapping row you created in the **User Values** section, so the two match exactly. ![The Additional Settings section for Send User Profile to Personyze, with the User Identifier Key dropdown and an Event Attribute field containing first_name, above a User Values mapping row carrying the same field name.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-43.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=b9a17aa9f406c6d3b87d2f8d15271f82) **User Identifiers** are the mandatory fields for this action. **Step 6** Click **Save Mapping**, then **Create Destination**. The destination is created and becomes available for activation in Journeys. ## Link the destination to a workflow Once the destination exists, attach it to the **Send to Destinations** node in your workflow. **Step 1** In the workflow, click **+** and choose **Send to Destinations**. ![The node action menu in a Journeys workflow, with Send to Destinations highlighted among the other node actions.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-44.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=ea235cbf96ebb0134d9d40c83fae3de6) **Step 2** Find your destination in the list of available destinations using the search box. ![The Send to Destinations panel with the search box highlighted above a grid of existing destination cards. The cards in this capture belong to other integrations.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/image-45.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=2fcc5117d3d46a675bc63807753f9750) **Step 3** On the **Destination Details** tab, the **Private API Key** field is already filled in from the value you entered when you created the destination. **Step 4** On the **Destination Settings** tab, choose the action and mapping you want this node to use. **Step 5** Click **Save Destination**. The destination is attached to the node. ![The Send to Destinations panel with a Personyze destination card attached, showing the destination name and the Send User Profile to Personyze action, above the search box and the other available destination cards.](https://mintcdn.com/zeotap/ZsC2IoNHiHM6BFS2/articles/integrate-customer/Storage/integrate-customer/image-46.png?fit=max\&auto=format\&n=ZsC2IoNHiHM6BFS2\&q=85\&s=a931cfcd221e0b7d21afd29c7081f43e) ## Verify the integration * **Check the node metrics.** Metrics are available for every published workflow and show how many users passed through each node over the last 7 days, so you can confirm traffic is reaching the **Send to Destinations** node. See [Understand metrics](/articles/orchestrate-customer/understand-metrics). For the total number of users the workflow sent out, use the **ACTIVATED USERS** column on the listing screen. * **Trace a single customer.** Journey Traces shows the output event sent to each destination node for an individual user, which is the quickest way to confirm what Personyze received. See [Journey traces](/articles/orchestrate-customer/journey-traces). ## Troubleshoot the integration * **A profile value never appears in Personyze.** The value you type in **Event Attribute** under **Additional Settings** must match the field name on the **User Values** mapping row exactly, and both must be in snake_case — for example `first_name` in both places. * **A profile field is not accepted.** The supported user profile values are `first_name`, `last_name` and `email`. * **Nothing is matched on the Personyze side.** The identifier type you choose under **User Identifier Key** must be the one whose value you map to **User Identifier Value**. Pick User ID, Email or Internal ID, then map the matching Catalogue attribute. * **The Private API Key is blank on the workflow node.** The node inherits the key from the destination you created — check the key on the destination itself. * **The workflow reports execution errors.** Start from the failed node — see [Identify journey errors](/articles/orchestrate-customer/identify-journey-errors), [Journey error codes](/articles/orchestrate-customer/journey-error-codes) and [Troubleshooting workflows](/articles/orchestrate-customer/journey-troubleshooting). ## Next steps > [card] [Personyze destination (audiences)](/articles/integrate-customer/personyze) > [card] [Create a workflow](/articles/orchestrate-customer/create-a-workflow) > [card] [Journey traces](/articles/orchestrate-customer/journey-traces) > [card] [Destinations overview](/articles/integrate-customer/destinations) # PGP encryption for file-based destinations Source: https://docs.zeotap.com/articles/integrate-customer/pgp-encryption-in-destinations Set up PGP encryption on a GCS or SFTP destination so Zeotap encrypts each outbound file with your public key before delivery. If you need Zeotap to *receive* PGP-encrypted files from your side, see [PGP encryption in sources](/articles/integrate-customer/pgp-encryption-in-sources) instead — this page covers the outbound (destination) direction. ## What this is PGP encryption on a Zeotap destination secures batch file delivery to your systems. You generate an asymmetric key pair on your side, upload the public half to Zeotap, and Zeotap encrypts each outbound file with that public key before writing it to your storage. Your side decrypts the file with the private key that never leaves your systems. The encryption setting is scoped per destination — you can turn PGP on where it is required and leave other destinations unencrypted. ## Prerequisites > [!NOTE] > > Before you configure PGP delivery, confirm the following: > > * The destination is a **GCS** or **SFTP** destination — file-level PGP is available for these two destination types. > * You have generated an asymmetric key pair (public + private) on your side. Zeotap recommends the **RSA** algorithm. > * You have exported the **public key** as an ASCII-armored file with the **`.asc`** extension. This is the file you will upload to Zeotap. Keep the private key on your side; never share it with Zeotap. > * Your side has a PGP client that implements [RFC 4880 (OpenPGP Message Format)](https://datatracker.ietf.org/doc/html/rfc4880). For compatibility references, see [Phil Zimmermann's PGP directory](https://philzimmermann.com/EN/findpgp/findpgp.html); for Java implementations, see the [Bouncy Castle interoperability documentation](https://www.bouncycastle.org/documentation/specification_interoperability/). A valid ASCII-armored public key looks like this — the file you upload must begin with `-----BEGIN PGP PUBLIC KEY BLOCK-----` and end with `-----END PGP PUBLIC KEY BLOCK-----`: ```text theme={null} -----BEGIN PGP PUBLIC KEY BLOCK----- Version: BCPG v1.79 mQENBGeHkmIBCACV/Tz6UR1CXbbKqX1rZiF1lfZ0OcK7oiToBwsqLQmwqy3vIk4Y wKQ/S8XW49vKDRxB7VDkaaYmen7FfDJGBRKvh9z14RucqVdWjoYl6DmH85MSAehR 657paEuXibZEEV6B0/QLoj5t8xBsbiS3KSdeCUlQgSxN9kpOkqtvngZ5P+GBD8S+ ++Y2I80a2yj8p7MZ50zabz5wfM/TextOUJC1GKgVnzTSceLXWQg3kN9auI1c93YE Ys47BGx44UK2lpvidyXZScmJOkC8dsdl/KzZ0hpVt2oINLmp73P6ZDOsdCtLQFTa cUBF2sP1UyMrKbaM1Kx1cmYi/vkTK8W7S8GNABEBAAG0EHNhbXBsZUBoZWxsbyxj b22JARwEEAEIAAYFgmeHkmIACgkQikOPEtKLHq9QkQf6A2FhXRsR0LhztQgjqBfP IuDY7od5eydR7FAQjRV7SX46/OvLNQ9X4FNo8quoAcpkO3d4V5yprjgSmKeTtdJN d31mTDBd8oxIID+8wQthVDiBheC3H+Dm2NaEgS1a5Qg4wrBME3dE4a2oqmbWitV8 6bqImzXzOipxPXFQW/JNqEC7dfPi5Wl8LK8OAJbGW2/qedplHB27L/k1jyA6QGcQ T3Hh+xKPMzeQUZtN668Wmv8VGkpg7elWqDJ4aR+PN9LV+Rl9Lzw1c0aPDN+fklBn rZHV+zHt3fbVKtSXxBqX1n+A005ZLLuNvOr5jGIrRMJ1EZRd6wAcXG3EZQ1MiVSc wg== =EIaB -----END PGP PUBLIC KEY BLOCK----- ``` ## Configure PGP encryption on a GCS or SFTP destination Enabling PGP is an in-form step of the standard destination-creation flow — you opt in to encrypted delivery and attach your public key as part of configuring the destination. > [!WARNING] > > The public key you upload determines which private key decrypts the outbound files. If you replace the uploaded public key later, files delivered afterwards can only be decrypted with the new matching private key — coordinate any rotation with the team that holds the private key so decryption does not break. 1. Open the destination configuration form for a new or existing GCS or SFTP destination. 2. Opt in to encrypted delivery for this destination. When the option is enabled, an additional field appears for uploading the public key. 3. Upload your public key file. The file must be ASCII-armored and carry the `.asc` extension. The upload is scoped to this destination — other destinations remain unencrypted unless you enable PGP on them individually. 4. Save the destination. From the next delivery onward, Zeotap encrypts every outbound file for this destination using the key you uploaded, before writing it to your GCS bucket or SFTP location. ## Verify the encrypted delivery After the next scheduled delivery to this destination, confirm on your side: * The file that lands in your GCS bucket or SFTP location is a PGP message — the header line reads `-----BEGIN PGP MESSAGE-----`, not readable CSV content. * Your PGP client decrypts the file with the matching private key and reproduces the original CSV without errors. If both are true, the destination is delivering under PGP as configured. ## Troubleshooting Use this table to map an observed symptom to the check that resolves it. | Symptom | What it means | Where to look | | - | - | - | | Public key upload is rejected on the destination form | The file is not a valid ASCII-armored key, or the extension is not `.asc` | The public-key upload field on the destination form; re-export the key with the `.asc` extension | | Delivered file is readable CSV, not a PGP message | The encryption option was not enabled when the destination was saved | Re-open the destination configuration and confirm encrypted delivery is on | | Your PGP client fails to decrypt the delivered file | The public key held by Zeotap does not pair with the private key your side is using | Compare the key fingerprint on your side against the public key you uploaded; re-upload if they diverge | | Client library rejects the payload with an OpenPGP format error | The client does not implement RFC 4880, or targets only the newer RFC 9580 | Cross-check your client against [Bouncy Castle's interoperability notes](https://www.bouncycastle.org/documentation/specification_interoperability/) or the [Phil Zimmermann PGP directory](https://philzimmermann.com/EN/findpgp/findpgp.html) | ## FAQ > [accordion] Which destinations support file-level PGP encryption? > > File-level PGP is available on **GCS** and **SFTP** destinations. Other destination types are out of scope for this mechanism. > [accordion] Which OpenPGP version does Zeotap implement? > > Zeotap implements [RFC 4880 (OpenPGP Message Format)](https://datatracker.ietf.org/doc/html/rfc4880). RFC 9580, released in July 2024, has limited adoption across PGP clients and libraries — Zeotap has stayed on RFC 4880 for interoperability. Zeotap recommends both sides align on RFC 4880. > [accordion] Does Zeotap generate the key pair for me? > > No — for the destination direction, you generate the key pair on your side, upload the public key to Zeotap, and keep the private key. Zeotap never sees the private key. For the inbound (source) direction the model is different: Zeotap CDP generates the key pair. See [PGP encryption in sources](/articles/integrate-customer/pgp-encryption-in-sources). > [accordion] Can I encrypt only some files going to a destination? > > The encryption setting is per destination, not per file. To send some flows encrypted and others in cleartext, configure two destinations pointing at different storage locations and enable PGP on one of them. ## Next steps * [Explore Google Cloud Storage destination setup →](/articles/integrate-customer/google-cloud-storage) * [Explore PGP encryption in sources →](/articles/integrate-customer/pgp-encryption-in-sources) * [Explore destination access rules →](/articles/integrate-customer/destination-access-rules) # PGP Encryption in Sources Source: https://docs.zeotap.com/articles/integrate-customer/pgp-encryption-in-sources Encrypt batch source files with PGP before delivering them to Zeotap CDP, using the public key generated for your account. ## What this is PGP ([Pretty Good Privacy](https://en.wikipedia.org/wiki/Pretty_Good_Privacy)) encryption is an option available when you create a batch file-based Zeotap CDP source — flat file sources such as Zeotap Google Cloud Storage and SFTP (Push). When enabled, Zeotap CDP generates a public/private key pair for your account: you encrypt files locally with the public key, upload them to the source's storage location, and Zeotap CDP decrypts them with the matching private key before queuing them for ingestion. This page explains how the flow works, how to turn it on for a source, and how to confirm that encrypted uploads are being decrypted and ingested. ## Prerequisites > [!NOTE] > > Before turning on PGP encryption for a source, confirm: > > * You have permission in Zeotap CDP to create or edit a Source. > * The source you are creating is a batch file-based type that exposes the **PGP Encrypted** option at creation (for example, Zeotap Google Cloud Storage or SFTP Push). > * Your PGP client follows the OpenPGP standard (RFC 4880), with session keys enabled. > * For SFTP (Push) sources, your Zeotap Admin has whitelisted the IP you will upload from. ## How PGP encryption works in Zeotap CDP Zeotap CDP follows RFC 4880 (OpenPGP Message Format) for PGP encryption. Both Zeotap CDP and your systems must adhere to this standard for the integration to work. RFC 9580 is not supported, because adoption across PGP clients is limited. Zeotap CDP's control plane generates an asymmetric public/private key pair per account. The public key is exposed to you through the source's **Implementation Details** tab (and through the admin portal) so you can encrypt files locally. The private key is retained by Zeotap CDP and is used server-side to decrypt files at ingestion time. When an encrypted file lands in the source's storage location (for example, a GCS bucket or SFTP folder), a cloud function decrypts it with the private key and moves the plaintext data to the raw data bucket for ingestion. For pull-based sources such as BigQuery or SFTP (pull), Zeotap CDP places the file in the appropriate bucket for you. The PGP public key you download looks like this: ```text theme={null} -----BEGIN PGP PUBLIC KEY BLOCK----- Version: BCPG v1.68 mQENBGeHotcBCACEJH6HIkFUx1VbNEOD0uPdAwiFvRh15NfR2pOcl2zxFCtN4Zx4 avSi/632iyOs9ka1zuQ2LtqEoL+x+Me088rjjkgUDxvIzsf7Dsg8Hq4L/bZ0v3rY vdhlOJJkXDFbKTsODWu5wqwIvIcu/g9OY4ilv/EtxVxy06T87ADtf5PMiHteNjU5 SnvxMY3GIR7AR0vfCubw7EMmawP1Cilnm1iPyYq+CWBzNBukqG7LdZKHXLO4YYSb VJ8g4Ahih3I2VM9NIdi3kjWLVdwx2mrwUfrSYm6ZrlVICtFH9At0ociWLGI0ibQW zCLgMCK87U3y7rxcc7uDhDLFd0w7KGYQ/PPXABEBAAG0EHNhbXBsZUBoZWxsbyxj b22JARwEEAEIAAYFAmeHotcACgkQsjgFDNcK62/MWgf8Dd7POi564D6evjZDDMuU ui3NdM4EY2NREuGji8fzz9zFsTxehVelAnKIgndU3d7fzW8HZZVYWMk5Se5idgX8 ERGMTjBHN4O2VnGMHdvZgIk/p9zjvJ5WxH46xrrwXRO+A7+VfqZdCAl9jYe9fom9 z8RkbGTA1qV9SwTQwPCoCOPcK0apjgDdcH1vofm+YKixgyZ3EA61cj/3Xx2nnHhR cJCyO7YhQJEXa4wehLMUNy0x15ipxztI3yl6kewLVE/+JAbOKdqW1PRmEPKoulRh DHGT2Su9Xa98bhwl+hq0mbk1UsRv2/TR+kd6vo4Ltysy6mVwAtq4JGjSsR6zyRQ4 Lg== =2iES -----END PGP PUBLIC KEY BLOCK----- ``` ## Enable PGP encryption on a source Turn on PGP at source creation, then download the account's public key from the source's own detail page. 1. Create the source from the **Sources** application under **Integrate**, choosing a batch file-based type (for example, Zeotap Google Cloud Storage or SFTP Push). In the creation form, set the **PGP Encrypted** field to **True**. 2. Complete the remaining source fields (name, file format, delimiter, region, data entity), then create the source. 3. Open the newly created source and download the PGP public key from the **Implementation Details** tab. The account-level public key is also available in the admin portal. ## Encrypt and upload your files Encryption happens on your side, using the downloaded public key. Zeotap CDP never sees the plaintext file until after decryption inside its own infrastructure. 1. Encrypt each source file with the downloaded public key, using an RFC 4880-compliant PGP client with session keys enabled. Encrypted files must carry the `.pgp` extension. 2. Upload each encrypted `.pgp` file to the source's storage location. For SFTP (Push), place the file under the encrypted-folder structure `pgpencrypted/sourceid/raw/yyyy/mm/dd` (for example, `pgpencrypted/5121/raw/2025/01/15`). For Zeotap Google Cloud Storage, upload to the bucket provisioned for your source. 3. Zeotap CDP decrypts the file with the private key and moves the plaintext content into the ingestion queue automatically. No further action is required from you for the decryption step itself. > [!WARNING] > > For PGP-encrypted SFTP (Push) sources, upload only `.pgp` files and only under the `pgpencrypted/` folder path. A file placed under the non-encrypted path (`/sourceid/raw/yyyy/mm/dd`) or without the `.pgp` extension will not be decrypted. ## Verify the encryption flow You have configured PGP correctly when all of the following hold: * The source's **Implementation Details** tab lists the PGP public key as available for download. * After you upload an encrypted file, an SFTP (Push) source's status advances from **Created** to **Integrated**. * Decrypted records appear in the source's **Preview** tab. If a file is uploaded but nothing appears in **Preview**, work through the troubleshooting table below. ## Troubleshoot PGP-encrypted uploads Common conditions when a PGP-encrypted file does not reach ingestion, and where to check: | Condition | What it means | Where to look | | - | - | - | | Uploaded file is not picked up | The file was placed outside the `pgpencrypted/` folder path or does not carry the `.pgp` extension | Your storage folder path and the uploaded file name | | File is not decrypted after upload | The file was encrypted with a key that does not match the source's Zeotap-issued public key | The source's **Implementation Details** tab — re-download the public key and re-encrypt the file | | Decrypted file fails ingestion | File headers or schema do not match the source's expected mapping | The source's **Preview** tab and your file's first-row column headers | | SFTP upload connection is refused | Your upload IP is not whitelisted on the Zeotap side | Confirm with your Zeotap Admin that your IP has been whitelisted for the SFTP source | > [!TIP] > > Zeotap CDP holds the private key for decryption; you are responsible for safeguarding the public key you download and for the encryption workflow that runs before upload. Establish a key rotation and access-control process on your side that fits your organisation's key-management policy. ## FAQ > [accordion] Which OpenPGP version does Zeotap CDP support? > > Zeotap CDP implements RFC 4880 (OpenPGP Message Format). RFC 9580 is not supported, because adoption across PGP clients is limited. > [accordion] Where do I download the public key for my source? > > After you create a source with **PGP Encrypted** set to **True**, open the source and go to the **Implementation Details** tab — the PGP public key is available for download there. The account-level public key is also exposed in the admin portal. > [accordion] Does Zeotap CDP ever hand out the private key? > > No. Zeotap CDP generates the key pair inside its control plane and retains the private key for server-side decryption at ingestion time. You interact only with the public key. > [accordion] Which source types support PGP encryption? > > PGP is available on batch file-based sources — for example, Zeotap Google Cloud Storage and SFTP (Push). Event-stream sources such as Web Pixel, IFrame, and App Pixel do not use file-based PGP encryption. ## Next steps * [Explore Zeotap Google Cloud Storage source setup →](/articles/integrate-customer/create-a-zeotap-google-cloud-storage-source) * [Explore SFTP (Push) source creation →](/articles/integrate-customer/creating-sftp-push-source) * [Explore SFTP (Push) source implementation →](/articles/integrate-customer/implementing-sftp-push-source) # Pinterest Customer Lists destination Source: https://docs.zeotap.com/articles/integrate-customer/pinterest Send Zeotap audiences to Pinterest as Customer Lists so you can target them in Pinterest ad campaigns. ## What this is The Pinterest Customer Lists destination sends Zeotap audiences to your Pinterest Business Manager so you can target them in Pinterest ad campaigns. Pinterest accepts SHA-256 hashed emails and mobile advertising IDs (MAIDs); Zeotap delivers matched users as a **Customer List** that appears under **Ads → Audiences** in the Pinterest console. Pinterest is a private channel in Zeotap, so an audience can be linked to only one Pinterest destination at a time. For server-side event forwarding (conversions, page visits, sign-ups) rather than audience activation, use the [Pinterest CAPI destination](/articles/integrate-customer/pinterest-capi) instead. ## Supported actions and features | Action | [ID Extension](/articles/segment-customer/extend-your-audience#id-extension) | [Delete](/articles/segment-customer/delta-upload-and-delete-functions) | [Delta upload](/articles/segment-customer/delta-upload-and-delete-functions) | | - | :-: | :-: | :-: | | Send identifiers to Pinterest Customer Lists | ✅ | ✅ | — | Each audience refresh sends the full qualifying set to Pinterest; Zeotap does not send incremental deltas for this destination. Deletions of disqualified users are supported and run on the audience's next refresh cycle. ## Prerequisites > [!NOTE] > > Before you start, confirm you have: > > * Access to your Pinterest Business Manager account and the **Advertiser ID** for the ad account you want to activate. > * A Pinterest user with permission to authorise third-party apps on that ad account (needed for the OAuth **Give access** step). > * A Zeotap CDP user with access to the **Destinations** and **Audiences** applications. > * An audience whose output identifiers include SHA-256 hashed emails or MAIDs. ## Find your Pinterest Advertiser ID Open your Pinterest Business Manager account and copy the **Advertiser ID** for the ad account you want to activate. You will paste this into the Zeotap destination configuration in the next section. ![Advertiser ID location in the Pinterest Business Manager account](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/pinterest_advertiserid.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=b9a6e6ef5857c725474f9b5b4517ff0a) ## Create the Pinterest Customer Lists destination **1. Open the Destinations application** Log into the Zeotap CDP App and go to the **DESTINATIONS** application. ![Destinations application with the + Create Destination button](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_1.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=92dfe8ecb29e59c9d7d57cb954e54618) **2. Start a new destination** Click **+ Create Destination**, then under **All Destinations** search for **Pinterest Customer Lists**. ![Searching for a destination under All Destinations](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_2.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=6f5f0f5367788fb4e9e946f4b3cb5874) **3. Enter the destination details** Select **Pinterest Customer Lists**. On the configuration screen, enter: * A **Name** for the destination. * The **Advertiser ID** you copied from Pinterest Business Manager. * The **Client name**. ![Pinterest Customer Lists destination configuration screen](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/pinterest_destination.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=d0a3800294e74c1cf6315aa5f571bec5) **4. Authorise Zeotap on Pinterest** Click **CONNECT PINTEREST CUSTOMER LISTS**. A Pinterest OAuth screen opens; sign in with a Pinterest user who has access to your Business Manager, then click **Give access** to authorise the app. ![Pinterest OAuth screen with the Give access button](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/pinterest_provideaccess.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=1f1ce91e8eb53e9088a8a5e4d03faad2) On success, the **Access Token** and its expiry period populate on the destination screen. Click **Next** to proceed to mapping. **5. Map your identifiers** Under **Choose your Action**, select **Send identifiers to Pinterest Customer Lists**. Under **Map the Fields**, map your source fields to the [output identifiers](/articles/segment-customer/choose-the-output-identifiers) that Pinterest accepts — SHA-256 hashed emails and MAIDs. Edit, add, or remove identifiers from the default list as needed; see the [mapping reference](/articles/integrate-customer/destinations#define-the-mapping). Click **Create Destination**. The destination now appears in the **Audiences** application and can be linked to an audience. ![Choose your Action and Map the Fields screen for Pinterest Customer Lists](https://mintcdn.com/zeotap/puXmsvA7x0OblYvo/articles/integrate-customer/Storage/integrate-customer/pinterest/pinterest-2023-11-09.png?fit=max\&auto=format\&n=puXmsvA7x0OblYvo\&q=85\&s=c3676585094a18c858516a5002f2b88a) ### Hashing requirements for email Pinterest rejects raw email addresses. Normalise each address before hashing — trim surrounding whitespace and convert it to lowercase — then hash it with SHA-256 and map the hexadecimal digest. If your source already stores hashed emails, confirm they were produced from normalised input, because a digest built from an untrimmed or mixed-case address will not match. ## Link an audience to the destination Open the **Audiences** application, select the audience you want to activate, and attach the Pinterest Customer Lists destination you created. Full instructions are in [Link an audience to a destination](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > The terms **Audiences** and **Segments** refer to the same thing — a group of users matching a defined set of criteria (for example, users over 18 who performed an `addToCart` event in the last 30 days). ## Verify the audience reached Pinterest Two checks confirm the delivery worked: 1. **In Zeotap** — the Pinterest destination is listed against the audience and shows the audience as activated. 2. **In Pinterest** — open **Ads → Audiences** in the Pinterest console. Your audience appears as a **Customer List** with status **Ready**. Allow up to **two business days** from linking the audience for it to reach the Pinterest seat, and a further **two to three days** for the Customer List to become visible under **Ads → Audiences**. Match rates on Pinterest are lower than on larger platforms because the Pinterest account universe is smaller than platforms such as Facebook and Twitter — a segment that matches strongly elsewhere can show a much smaller matched size on Pinterest for the same source list. ![Customer Lists shown under Ads and Audiences in the Pinterest console](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/pinterest_console.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=34c460bac66c156694897784085f9ac9) ## Use the Customer List in a Pinterest campaign Once the Customer List status is **Ready**, you can attach it to a Pinterest ad. **1. Create an ad** In Pinterest Ads Manager, go to **Create → Create ad** and fill in the ad details. ![Create ad option in Pinterest Ads Manager](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/pinterest_campaign.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=bb76c20780f3d642255afae52ae330a6) **2. Attach an existing audience list** In the **Audience lists** section, click **Use existing list**. ![Use existing list option in the Audience lists section](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/pinterest_audience_list.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=d7ae2aa2aeeef860805d1500f5505317) **3. Select the Zeotap-delivered list** Tick the **Customer lists** checkbox to filter to Customer Lists, then select the list Zeotap delivered and click **Select**. ![Selecting a ready Customer List](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/pinterest_ready_list.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=8196cad091bc0114341a9aff9057cb3b) **4. Add the list to the ad** Click **Add selected lists** to attach the Customer List to your ad campaign. ![Add selected lists button attaching the Customer List to the ad](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/pinterest_readylist_add.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=a313aad5955fcf1d2644abc3aea6ad6e) ## Why this happens — conditions to check Use this table to map what you see (in Zeotap or in Pinterest) to what it means and where to investigate. | Condition | What it means | Where to look | | - | - | - | | Customer List size shown as `<100` | The segment matched fewer than 100 users on Pinterest, so Pinterest treats it as not ready. Wait for the audience to grow or expand your criteria. | Pinterest console → **Ads → Audiences** | | Match rate much lower than on Facebook or Twitter for the same source list | The Pinterest account universe is smaller than large social platforms, so fewer of your users have a Pinterest account. | Pinterest console → **Ads → Audiences** (Customer List size vs. source audience size) | | Customer List has not appeared after linking | Delivery to the Pinterest seat takes up to two business days, and the list surfaces under **Ads → Audiences** two to three days after that. | Zeotap → **Audiences** (linked destinations) and Pinterest → **Ads → Audiences** | | **Access Token** field is empty or expired | The OAuth token issued at **Give access** has reached the expiry period shown on the destination screen. Re-authorise from the destination configuration. | Zeotap → **Destinations → Pinterest Customer Lists** (Access Token field) | ## How user disqualification works When a user no longer meets an audience's criteria — whether the criteria are behavioural, demographic, or consent-based — Zeotap CDP raises a user deletion request against Pinterest on that audience's next refresh cycle. The exclusion runs automatically at the configured refresh frequency; you do not need to trigger it. See [Delta upload and delete functions](/articles/segment-customer/delta-upload-and-delete-functions) for the list of destinations that support Delete. ## When to contact support Open a support ticket if: * The **Access Token** cannot be generated after clicking **Give access** and retrying the authorisation. * The Customer List has not appeared on the Pinterest console more than three business days after you linked the audience. * The Customer List appears but stays at size `<100` even though your source audience is significantly larger and includes SHA-256 emails or MAIDs. **Include in your request:** the destination name and ID from Zeotap, the Pinterest Advertiser ID, the audience ID, the date and time you linked the audience, and any error text shown on the destination configuration screen. ## FAQ > [accordion] Which identifiers does Pinterest Customer Lists accept? > > SHA-256 hashed emails and mobile advertising IDs (MAIDs). Raw email addresses are not accepted — hash them (lowercase, trimmed, SHA-256) before mapping. > [accordion] Can I link more than one Pinterest destination to a single audience? > > No. Pinterest is a private channel in Zeotap and allows one Pinterest destination per audience. > [accordion] Why is my match rate lower on Pinterest than on other platforms? > > The Pinterest account universe is smaller than platforms such as Facebook and Twitter, so fewer of your source users have a matching Pinterest account. A segment with a strong match on a larger platform can show a much smaller matched size on Pinterest for the same source list. > [accordion] How long before my audience is usable in a Pinterest ad? > > Delivery to the Pinterest seat takes up to two business days after you link the audience. The Customer List then surfaces under **Ads → Audiences** two to three days later, at which point its status becomes **Ready** and you can attach it to an ad. > [accordion] Are incremental (delta) uploads supported for Pinterest? > > No. Each refresh sends the full qualifying set to Pinterest. Deletions of disqualified users are supported and run on the audience's next refresh cycle. ## Next steps * [Explore Pinterest CAPI for server-side conversion events →](/articles/integrate-customer/pinterest-capi) * [Explore how to link an audience to any destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore how delta uploads and deletions work across destinations →](/articles/segment-customer/delta-upload-and-delete-functions) * [Explore the full destinations catalogue →](/articles/integrations-master-list-publication/integrations-master-list) # Pinterest CAPI Source: https://docs.zeotap.com/articles/integrate-customer/pinterest-capi Send conversion events from a Zeotap CDP journey to your Pinterest ad account in real time using the Pinterest Conversions API. ## What this is Pinterest CAPI is a real-time destination: data flows **out of Zeotap CDP to Pinterest**, sending conversion events from a journey to your Pinterest ad account through the Pinterest Conversions API. The Conversions API is a server-to-server connection, so events reach Pinterest without depending on the browser. Use it to measure campaign impact on the events your customers actually complete, and to improve targeting on the back of that measurement. This is the real-time, journey-driven Pinterest destination. If you want to send an **audience** to Pinterest as a Customer List instead, use the batch [Pinterest](/articles/integrate-customer/pinterest) destination — that page covers audience linking and where the lists appear in Pinterest. ## Supported identifiers and actions This integration supports SHA-256 email, SHA-256 MAIDs and SHA-256 phone numbers. Hash sensitive user data before it is sent. The action you choose on the mapping screen is **Send Conversions to Pinterest**. ## Prerequisites Complete these before you create the destination: * A [Pinterest business account](https://www.pinterest.com/business/create/) with access to the ad account you want to send conversions to. * A Pinterest **conversion access token** and the **ad account ID** it is issued against — generate these in Pinterest, as described in the next section. * In Zeotap CDP, a role that grants destination edit rights on the organisation that owns the destination. See [User Roles and Access](/articles/admin-customer/user-roles-and-access). * Your ingested fields mapped to the Catalogue, so the identifiers and attributes you want to send resolve at mapping time. * A journey to attach the destination to. See [Create a Workflow](/articles/orchestrate-customer/create-a-workflow). ## Generate the Pinterest conversion access token **Step 1** In Pinterest, open the **Business hub** menu and select **Ad account overview** under **Manage campaigns**. ![Pinterest Business hub menu, with Ad account overview highlighted in the Manage campaigns column](https://mintcdn.com/zeotap/0u0xLZ-nJKiSDdWY/articles/integrate-customer/Storage/integrate-customer/pinterest-capi/pinterest-capi-step-07.png?fit=max\&auto=format\&n=0u0xLZ-nJKiSDdWY\&q=85\&s=a8d7ee9db855e2536ba41e0d411e9f5a) Pinterest Business hub menu with Ad account overview highlighted under Manage campaigns **Step 2** Select **Conversions** under **Manage business**. ![Pinterest navigation menu, with Conversions highlighted in the Manage business column](https://mintcdn.com/zeotap/0u0xLZ-nJKiSDdWY/articles/integrate-customer/Storage/integrate-customer/pinterest-capi/pinterest-capi-step-02.png?fit=max\&auto=format\&n=0u0xLZ-nJKiSDdWY\&q=85\&s=a4426b2c05678856678211c799bb4fa4) Pinterest menu with Conversions highlighted under Manage business **Step 3** On the **Conversions** page, select **Set up API** under **Conversions API**. ![Pinterest Conversions page showing the left navigation with Set up API highlighted beneath Conversions API, and the Events overview chart behind it](https://mintcdn.com/zeotap/0u0xLZ-nJKiSDdWY/articles/integrate-customer/Storage/integrate-customer/pinterest-capi/pinterest-capi-step-04.png?fit=max\&auto=format\&n=0u0xLZ-nJKiSDdWY\&q=85\&s=2def4ffc054e8893a123f2e0d424b1fd) Pinterest Conversions page with Set up API selected under Conversions API **Step 4** Select **Conversion access token**, then click **Generate new token**. Pinterest issues the token against your user ID and notes that one token can be used for several ad accounts under that user ID. ![Pinterest card headed Generate conversion access token, with explanatory text and a Generate new token button](https://mintcdn.com/zeotap/0u0xLZ-nJKiSDdWY/articles/integrate-customer/Storage/integrate-customer/pinterest-capi/pinterest-capi-step-03.png?fit=max\&auto=format\&n=0u0xLZ-nJKiSDdWY\&q=85\&s=fb20a18f11a91d45fb6280abd3144412) The Generate conversion access token card with the Generate new token button **Step 5** Copy the newly generated token, which is displayed with your ad account ID. Pinterest does not store the token for you, so keep both values somewhere secure — you need them in the next section. ## Create the Pinterest CAPI destination **Step 1** In Zeotap CDP, go to **Destinations** under **Integrate**. **Step 2** Click **+ Create Destination**. **Step 3** Under **All Destinations**, search for **Pinterest CAPI** and open it. **Step 4** The left of the screen describes the integration; the right lists the fields required to establish it. Under **Enter Destination Details**, complete: a. **Destination Name** — a name for easy identification. b. **Access Token** — your Pinterest access token. c. **Ad Account ID** — your Pinterest ad account ID. d. **Destination Instance** — a unique instance name for this destination. e. Click **Next** to proceed to **Mapping**. ![Zeotap CDP destination creation screen for Pinterest CAPI, showing empty Destination Name, Access Token, Ad Account ID and Destination Instance fields, with the Destination Details and Mapping steps in the breadcrumb](https://mintcdn.com/zeotap/0u0xLZ-nJKiSDdWY/articles/integrate-customer/Storage/integrate-customer/pinterest-capi/pinterest-capi-step-01.png?fit=max\&auto=format\&n=0u0xLZ-nJKiSDdWY\&q=85\&s=1108cf44f4015646b58eec0e6a3fef3b) The Enter Destination Details step of the Pinterest CAPI destination in Zeotap CDP **Step 5** On the mapping screen, choose the action and define the mapping: a. Under **Choose your Action**, select **Send Conversions to Pinterest**. Under **Map the Fields**, choose the corresponding identifiers. By default, the output identifiers accepted by the platform — such as hashed email IDs and hashed phone numbers — are displayed. For how mapping works in general, see [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping) and [Choose the Output Identifiers](/articles/segment-customer/choose-the-output-identifiers). b. The mandatory fields are **Event ID** and **Event TIME**; both are marked with an asterisk on the mapping screen. Alongside them, you must send either a hashed email, hashed phone number, or hashed IP address. c. Click **Create Destination**. ![Zeotap CDP mapping screen showing the Choose your Action dropdown set to Send Conversions to Pinterest, and a Map the Fields table with Event ID and Event TIME marked as required destination fields](https://mintcdn.com/zeotap/0u0xLZ-nJKiSDdWY/articles/integrate-customer/Storage/integrate-customer/pinterest-capi/pinterest-capi-step-08.png?fit=max\&auto=format\&n=0u0xLZ-nJKiSDdWY\&q=85\&s=d26aae372ee5f53ef83862f04ba62ad3) The mapping step with Send Conversions to Pinterest selected and the mandatory Event ID and Event TIME destination fields ## Add the destination to a journey Pinterest CAPI is a real-time destination, so it is driven from a journey rather than linked to an audience. After creating the destination, attach it to a **Send to Destinations** node in your workflow. **Step 1** In the workflow, click **+** and choose **Send to Destinations**. ![Journey canvas Choose an action menu listing Add a Condition, Add a Delay, Create a Multi-branch Split, Create a True/False Split and Send to Destinations, with Send to Destinations highlighted](https://mintcdn.com/zeotap/0u0xLZ-nJKiSDdWY/articles/integrate-customer/Storage/integrate-customer/pinterest-capi/pinterest-capi-step-09.png?fit=max\&auto=format\&n=0u0xLZ-nJKiSDdWY\&q=85\&s=94680be565eceecd53fa2a8b242c7445) The journey canvas action menu with Send to Destinations highlighted **Step 2** Find your destination in the list of available destinations using the search box. ![Send to Destinations panel with the search field highlighted, an Add New Destination link, and a grid of existing destination cards](https://mintcdn.com/zeotap/0u0xLZ-nJKiSDdWY/articles/integrate-customer/Storage/integrate-customer/pinterest-capi/pinterest-capi-step-06.png?fit=max\&auto=format\&n=0u0xLZ-nJKiSDdWY\&q=85\&s=cfe411f995d9204bba2aa936fafdd71a) The Send to Destinations panel with the search box highlighted above the available destinations **Step 3** Under the **Destination Details** tab, the **Access Token** and **Ad Account ID** fields are populated automatically from the values you entered when you created the destination. **Step 4** Under **Event Name**, choose the option that matches what the journey is reporting: * Add to Cart * Checkout * Custom * Lead * Page Visit * Search * Sign Up * View Category * Watch Video **Step 5** Under **Action Source**, choose where the event happened: * Android * iOS * Web * Offline ![Pinterest CAPI destination panel on a journey node, showing the Destination Details and Destination Settings tabs with the Event Name and Action Source dropdowns highlighted at the bottom](https://mintcdn.com/zeotap/0u0xLZ-nJKiSDdWY/articles/integrate-customer/Storage/integrate-customer/pinterest-capi/pinterest-capi-step-05.png?fit=max\&auto=format\&n=0u0xLZ-nJKiSDdWY\&q=85\&s=63fb53b2ac8ef919683a21c6912daf36) The Pinterest CAPI node panel with the Event Name and Action Source dropdowns highlighted **Step 6** Under the **Destination Settings** tab, choose the action and mapping you need for this node. **Step 7** Click **Save Destination**. The destination is attached to the node. ![Send to Destinations panel showing an attached Pinterest CAPI destination card with its mapping name, above a search box and a list of further destination cards](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/pinterest-capi/pinterest-capi-2025-09-18.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=f9eb42d8ba9c62b054ab5856dbfde6e7) The Send to Destinations node with an attached Pinterest CAPI destination card ## Verify the events reach Pinterest Check both sides of the delivery. **In Zeotap CDP** — open the journey and inspect the **Send to Destinations** node. Destination nodes show success and error counts, and clicking a node opens the execution detail panel with the error code and affected record count. For per-user detail on what was sent, use [Journey Traces](/articles/orchestrate-customer/journey-traces). **In Pinterest** — open the **Business hub** menu, select **Ad account overview** under **Manage campaigns**, then **Conversions** under **Manage business**. On the **Conversions** page, select **Events overview**. The chart and the **Events activity** table below it report events by event name, event source and last received date, filtered by the date range and the event-type chips you select. ![Pinterest Conversions page with Events overview selected in the left navigation, showing the all-events tab, a Checkout filter chip and a conversion trend chart for the last 30 days](https://mintcdn.com/zeotap/puXmsvA7x0OblYvo/articles/integrate-customer/Storage/integrate-customer/pinterest-capi/pinterest-capi-2025-10-30.png?fit=max\&auto=format\&n=puXmsvA7x0OblYvo\&q=85\&s=32714e4db08c28042c4994f83a737b60) Pinterest Conversions page with Events overview selected in the left navigation ## Troubleshoot delivery failures Errors surface on the destination node in the journey canvas. The table below covers the failures most likely to affect this destination; for the full set, see [Journey Error Codes](/articles/orchestrate-customer/journey-error-codes). | What you see | Likely cause | What to do | | - | - | - | | A mandatory-field rejection such as `event_id is a required property, event_time is a required property` | The mapping omits a field Pinterest requires. | Reopen the mapping and confirm **Event ID** and **Event TIME** are mapped, along with a hashed email, hashed phone number or hashed IP address. | | `BAD_REQUEST` | Mandatory fields missing or invalid parameters in the payload. A null primary identifier is the most common cause. | Check the primary identifier mapping first, then cross-reference the remaining required fields. See [`BAD_REQUEST`](/articles/orchestrate-customer/journey-error-codes). | | `AUTHENTICATION_ERROR` | The access token has expired, or it was rotated on the Pinterest side without being updated in Zeotap. | Generate a new conversion access token in Pinterest and update the destination under **Destinations** in **Integrate**. | | `CONSENT_NOT_PROVIDED` | Consent attributes do not permit the send. | Check the user consent attributes and the destination mapping. | | `RATE_LIMIT` | Too many requests were sent to Pinterest in a short period. | Zeotap retries rate-limited requests with exponential backoff. If it persists, reduce the batch size in the destination settings, add wait nodes to the journey to stagger delivery, or ask Pinterest to raise your rate limit. See [`RATE_LIMIT`](/articles/orchestrate-customer/journey-error-codes). | | `SERVER_ERROR`, `SERVICE_UNAVAILABLE` | Transient conditions on the destination side. | These retry automatically. Monitor the node rather than reconfiguring it. | | The node reports successful deliveries but Pinterest shows nothing | The **Events overview** view is filtered. | Widen the date range and check the event-type chips so the event name you are sending is included. | If the error does not match any row above, or Pinterest confirms it received zero events while the journey node reports success, open a support ticket with the journey, the destination name, the timestamp and exact text of the failing run, and the Request ID from the execution detail panel. See [Identify Journey Errors](/articles/orchestrate-customer/identify-journey-errors). ## FAQ > [accordion] Do I need one access token per ad account? > > No. Pinterest issues the conversion access token against your user ID, and states on the token screen that one token can be used for several ad accounts under that user ID. You still enter the matching **Ad Account ID** on each Zeotap destination. > [accordion] Should I keep the Pinterest Tag if I use the Conversions API? > > Pinterest recommends it. The Conversions page carries a standing recommendation to use the Pinterest Tag in combination with the Pinterest Conversions API to maximise conversion visibility, and the Conversions API section includes its own **Deduplication** settings for events that arrive from both sources. > [accordion] What is the difference between Pinterest CAPI and the Pinterest destination? > > Pinterest CAPI is a real-time destination driven from a journey: it sends conversion events as they happen. The [Pinterest](/articles/integrate-customer/pinterest) destination is a batch integration that sends an audience to Pinterest as a Customer List for targeting. They serve different purposes and are configured separately. ## Next steps * [Send audiences to Pinterest as Customer Lists →](/articles/integrate-customer/pinterest) * [Explore how destinations, actions and mappings fit together →](/articles/integrate-customer/destinations) * [Build the journey that drives this destination →](/articles/orchestrate-customer/create-a-workflow) * [Debug a single user's path through the journey →](/articles/orchestrate-customer/journey-traces) * [Review the full list of supported integrations →](/articles/integrations-master-list-publication/integrations-master-list) # PromoteIQ Source: https://docs.zeotap.com/articles/integrate-customer/promote-iq Send Zeotap CDP audiences out to an Amazon S3 bucket you provision, then transfer the segment list into PromoteIQ to run retail media campaigns. ## What this is PromoteIQ is a **batch destination**: audience data flows out of Zeotap CDP towards PromoteIQ, and nothing flows back into the CDP. It is filed under **Integrate** > **Destinations** > **Batch Integrations**, so it attaches to an audience (segment) rather than to a journey. Unlike most destinations, the users in an audience are not delivered to PromoteIQ directly. Zeotap CDP creates the audience (segment) in PromoteIQ, and writes the matching user identifiers to an Amazon S3 bucket that **you** provision. You then transfer the segment list from that bucket into PromoteIQ to run relevant campaigns on your website. PromoteIQ is a platform that allows businesses to advertise to shoppers across the open web. By using retailers' first-party data, PromoteIQ enables advertisers to target their ads to individual shoppers, regardless of where they are browsing. Integrated with Zeotap CDP, it can help businesses increase their reach and efficiency when promoting their products and services to potential customers. The [integrations master list](/articles/integrations-master-list-publication/integrations-master-list) records PromoteIQ as a destination only, so there is no PromoteIQ source page to pair with this one. If you want audiences delivered to object storage and are not using PromoteIQ, use the [Amazon S3 destination](/articles/integrate-customer/amazon-s3-destination) instead. The workflow diagram below illustrates the integration with the PromoteIQ Destination. ![Sequence diagram of the Zeotap, customer and PromoteIQ integration. Zeotap creates an audience in PromoteIQ and sends the user identifier and segment ID to the customer's S3 bucket. A visitor then arrives on the customer's website, the website fetches that visitor's segment list from a customer service, calls PromoteIQ with the visitor's identifier and the audience IDs, and PromoteIQ runs the campaign tied to the audience.](https://mintcdn.com/zeotap/wwl-XxoFg7U2kGQg/articles/integrate-customer/Storage/integrate-customer/promote-iq/promote-iq-2024-05-27.png?fit=max\&auto=format\&n=wwl-XxoFg7U2kGQg\&q=85\&s=bd72e480f874e240f25f3a850aebc9d6) As the diagram shows, steps 3 to 5 run on your side: your website fetches the segment list for the visitor from a service you operate, then calls PromoteIQ with the visitor's identifier and the audience IDs. That call is to PromoteIQ's own API, not to a Zeotap API. ## Supported identifiers and actions This integration supports custom identifiers. In the mapping step you map a Catalogue attribute to the destination's custom identifier field. The following table lists the available action types for the integration and the supported features for each action type: | Action Name | [ID EXTENSION](/articles/segment-customer/extend-your-audience#id-extension) | [DELETE](/articles/segment-customer/delta-upload-and-delete-functions) | [DELTA UPLOAD](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send Identifiers to PromoteIQ | - | - | - | Because none of the three features is supported, every refresh writes a full file rather than only the changes since the previous run. ## Prerequisites Before you create a PromoteIQ Destination, make sure you have: * A PromoteIQ account, and the **API Key**, **API ID** and **API URL** for it. Obtain these from your PromoteIQ point of contact. * An Amazon S3 bucket that you have provisioned to receive the data files, along with its folder path, region, client ID and client secret. * An [audience](/articles/segment-customer/create-an-audience) in Zeotap CDP that you want to activate. ## Gather the PromoteIQ and Amazon S3 details Ensure that you have the following details available before creating a Destination: * API Key * API ID * API URL * S3 Bucket * S3 Folder * S3 Client ID and Client Secret * S3 Region ### API key and API ID An API key and API ID are two types of credentials used in PromoteIQ for authentication and authorisation purposes. PromoteIQ issues them as a single API Token, joined by a hyphen: the part before the hyphen is the **API ID**, and the part after it is the **API Key**. **Example** If your API Token is `-`, then: * `` — the short numeric portion before the hyphen — is your API ID. * `` — the long hexadecimal portion after it — is your API Key. ### API URL API URL is the endpoint of your PromoteIQ APIs that you have created. ### S3 bucket This is the name of your S3 bucket. You can obtain this information on your Amazon S3 account by navigating to **Buckets**. In the example shown below, **test-adobe-s3-bucket** is the bucket name. ![Amazon S3 console on a bucket detail page, reached through the Amazon S3 > Buckets breadcrumb. The bucket name in the page heading is outlined, and the Objects, Properties, Permissions and Metrics tabs run below it.](https://mintcdn.com/zeotap/wwl-XxoFg7U2kGQg/articles/integrate-customer/Storage/integrate-customer/promote-iq/promote-iq-2024-05-23.png?fit=max\&auto=format\&n=wwl-XxoFg7U2kGQg\&q=85\&s=2a3dc6cecc984cbcc171b21ce41557df) ### S3 folder In Amazon S3, a folder serves as a logical container for organising stored objects within a bucket. In reality, there are no actual folders in Amazon S3. Instead, the folder concept is emulated by employing object key names containing slashes ("/") to replicate a hierarchical arrangement. You can obtain this information from your Amazon S3 account by navigating to the **Objects** tab under the Amazon S3 bucket as shown in the image below. Ensure that you follow the folder structure shown below. `folder_name/sub_folder_name/` ![Amazon S3 console on the Objects tab of a bucket. The folder prefix is outlined in the page heading, and the objects table below lists a single sub-folder.](https://mintcdn.com/zeotap/wwl-XxoFg7U2kGQg/articles/integrate-customer/Storage/integrate-customer/promote-iq/promote-iq-2024-05-23-2.png?fit=max\&auto=format\&n=wwl-XxoFg7U2kGQg\&q=85\&s=a6a751bad7f98eef5eaa0465d7ea1bc7) ### S3 client ID and client secret These are the security tokens that provide secure access to your Amazon S3 resources. You can obtain the Client ID and Secret by navigating to the **AWS IAM Credentials** tab under **Security credentials** in your Amazon S3 account. ### S3 region This is the geographical location where the Amazon S3 storage is available. You can obtain this information by navigating to the **Properties** tab under the Amazon S3 bucket as shown in the image below. ![Amazon S3 console on the Properties tab of a bucket. The AWS Region row in the Bucket overview panel is outlined.](https://mintcdn.com/zeotap/wwl-XxoFg7U2kGQg/articles/integrate-customer/Storage/integrate-customer/promote-iq/promote-iq-2024-05-23-1.png?fit=max\&auto=format\&n=wwl-XxoFg7U2kGQg\&q=85\&s=b559baeea68033890c216d8bc4d59575) ## Create the PromoteIQ destination Perform the following steps to create a Destination for PromoteIQ: **Step 1** Log in to the Zeotap CDP App and go to **Integrate** > **Destinations**. **Step 2** Click **+ Create Destination.** ![Zeotap CDP Destinations listing, with the + Create Destination button at the top right outlined.](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_1.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=92dfe8ecb29e59c9d7d57cb954e54618) **Step 3** Under the **All Destinations** section, search for **PromoteIQ**. ![Zeotap CDP All Destinations catalogue showing a grid of destination tiles, with the Search for a Destination box outlined.](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_2.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=6f5f0f5367788fb4e9e946f4b3cb5874) **Step 4** Click **PromoteIQ**. A screen appears displaying details about the particular destination towards the left. On the right-hand side of the screen find a list of fields that are required for the integration to be established. Enter the required details as mentioned in the following steps: a. Enter a name for the Destination. b. Enter the **API Key**, **API Url** and **API ID** obtained from your PromoteIQ POC. c. In the **S3 Bucket** field, provide the name of the Amazon S3 Bucket. d. In the **S3 Folder** field, provide the folder path in your storage location where Zeotap CDP can store your exported data. e. Enter **S3 Client ID** and **S3 Client** **Secret** that you obtained from your Amazon S3 account. f. In the **S3 Region** field, choose the geographical region where your Amazon S3 bucket is available from the drop-down menu. g. Review all the values entered above and then click **Next** to proceed. ![Enter Destination Details step of the PromoteIQ destination in Zeotap CDP. The form shows the Destination Name, API Key, API Url and API ID fields, with the PromoteIQ description and its component checklist in the left-hand panel and Back and Next buttons at the foot of the screen.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/promote-iq/promote-iq-2024-05-23-5.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=aaae7251c174fdde2fd9edefb7f6aa75) **Step 5** In the new screen that appears, under **Choose your Action**, select **Send Identifiers to PromoteIQ** as the action for activating your audience (segment). Under **Map the Fields**, you can map any custom identifier that you wish to send to Promote IQ. ![Mapping step of the PromoteIQ destination in Zeotap CDP, with Send Identifiers to PromoteIQ chosen under Choose your Action and an empty Choose Catalogue Attribute selector paired with the destination's Custom Identifer field under Map the Fields.](https://mintcdn.com/zeotap/wwl-XxoFg7U2kGQg/articles/integrate-customer/Storage/integrate-customer/promote-iq/promote-iq-2024-05-23-4.png?fit=max\&auto=format\&n=wwl-XxoFg7U2kGQg\&q=85\&s=c38b112e88337b41acd2bbcd73f65a34) **Step 6** Click **Create Destination**. The created Destination gets listed in the **Audiences** application, which can be linked to an audience/segment. ## Link an audience to the destination For information about how to link an audience (segment) to the created Destination in the **Audiences** application, refer [here](/articles/integrate-customer/link-an-audience-to-the-destination). The refresh frequency you choose there controls how often Zeotap CDP writes a file to your S3 bucket. > [!NOTE] > > **Note:** > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. ## Verify the delivery Because the users are not sent to PromoteIQ directly, confirm the delivery in two places: 1. **In Zeotap CDP** — open the audience–destination pair and check its status. Linking the audience moves the Destination to In Progress, and it changes to Success once the IDs have been uploaded. See [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). 2. **In your S3 bucket** — open the folder you configured and confirm a segment file has arrived for the refresh cycle. ### Segment files in the S3 bucket After an Audience is linked to a Destination, Zeotap CDP generates segment files in CSV format with the following naming convention: `_.csv.gz` The file contains two columns (column 1: CID; column 2: Segment ID created in PromoteIQ) without any header. Here, the segment ID is your Audience ID designated to your audience (segment) that you created on Zeotap CDP. Note that these columns are comma-separated and the maximum file size limit for the Segment file is 5GB. If the file size is larger than 5GB, then they are split into different parts. > [!NOTE] > > **Note:** > > *Full refreshes will be sent to the S3 bucket as per the configured refresh frequency.* ## Troubleshoot the PromoteIQ destination | Symptom | What to check | | - | - | | No file arrives in the S3 bucket for a refresh cycle | Open the audience–destination pair and read the error recorded against it. The common delivery failures and what each one means are listed in [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail). | | One refresh produced several files instead of one | Expected above the 5GB limit for a Segment file — larger files are split into different parts. Treat the parts as one delivery. | | Every cycle writes the whole audience again, not just the changes | Expected. This integration supports neither delta upload nor delete, so full refreshes are sent as per the configured refresh frequency. | | The audience exists in PromoteIQ but has no members | Zeotap CDP creates the audience (segment) in PromoteIQ and writes the matching identifiers to your S3 bucket. Transferring those identifiers from the bucket into the PromoteIQ audience is a step you perform. | | The audience was never created in PromoteIQ | Creating the audience (segment) in PromoteIQ is Zeotap CDP's step, not yours. Open the audience–destination pair and read the error recorded against it — see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail). | | Identifiers you expected are missing from the file | Review the mapping on the destination. Only the identifiers present in the mapping are sent — see [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping) and [Choose the Output Identifiers](/articles/segment-customer/choose-the-output-identifiers). | If the error recorded against the audience–destination pair does not match any row above, see [When to contact support](/articles/integrate-customer/destinations#when-to-contact-support) for what to include in the request. ## Next steps * [Link an audience to the destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Understand how destinations, actions and mappings fit together →](/articles/integrate-customer/destinations) * [Send audiences to object storage without PromoteIQ →](/articles/integrate-customer/amazon-s3-destination) * [Check which identifiers every integration accepts →](/articles/integrations-master-list-publication/integrations-master-list) # Pub/Sub Batch Source: https://docs.zeotap.com/articles/integrate-customer/pub-sub-batch Pub/Sub Batch is a Message Queue source that brings data into Zeotap CDP in batches from a Google Cloud Pub/Sub topic you publish to. ## What this is Pub/Sub Batch is a Zeotap CDP **source**: it brings data **into** Zeotap CDP from a Google Cloud Pub/Sub (Publish/Subscribe) topic that you own and publish to. It belongs to the **Message Queue** source category and runs as a batch integration, so messages published to your topic are collected and ingested in batches rather than one at a time. The source accepts both Customer Data (CE) and [Non-Customer Entity (NCE) data](/articles/unify-customer/supported-data-entities). If you need messages to reach Zeotap CDP as soon as they are published, use [Pub/Sub Stream](/articles/integrate-customer/pub-sub-stream) instead — the real-time source in the same category. To send data the other way, out of Zeotap CDP and into your own Pub/Sub topic from a journey, see the [Google Pub/Sub](/articles/integrate-customer/google-pub-sub) destination. ## Prerequisites > [!NOTE] > > **Arrange the storage access before you start.** The Pub/Sub service account does not have the permissions it needs on the storage bucket by default, so batch subscriptions cannot push files to cloud storage until those permissions are granted. Contact your Zeotap POC before you set up the Pub/Sub Batch source. ## How the batch source works 1. You publish messages to a Pub/Sub topic in your own Google Cloud project. Each message must be minified (compact) JSON. 2. When you create the source in Zeotap CDP, you supply the fully qualified **Topic ID** of that topic, and Zeotap CDP displays the service account it will use. 3. You grant that service account the permission to attach a subscription to your topic (`pubsub.topics.attachSubscription`) in your Pub/Sub instance. 4. Zeotap CDP attaches a subscription to the topic. A batch subscription pushes the collected messages to cloud storage as files, which Zeotap CDP then ingests. ## Use a separate topic for batch and stream Use a different Topic ID for a Pub/Sub Batch source and a Pub/Sub Stream source. If both sources point at the same Topic ID, the same data arrives in both. ## Next steps * [Create a Pub/Sub Batch source](/articles/integrate-customer/create-a-pub-sub-batch-source) — prerequisites, Topic ID, service account, data format, and the step-by-step setup. * [Pub/Sub Stream](/articles/integrate-customer/pub-sub-stream) — the real-time source for the same Pub/Sub topic model. * [Message Queue](/articles/integrate-customer/message-queue) — every Message Queue source integration Zeotap CDP supports. # Pub/Sub Stream Source: https://docs.zeotap.com/articles/integrate-customer/pub-sub-stream The Pub/Sub Stream source brings data into Zeotap CDP in real time by subscribing to a Google Pub/Sub topic that your own systems publish to. ## What this is Pub/Sub Stream is a **source**: it brings data *into* Zeotap CDP. You nominate a Google Pub/Sub topic that your systems already publish to, Zeotap CDP subscribes to that topic, and each message is ingested as soon as it is published — rather than on a file drop or a scheduled export. The source sits in the **Message Queue** category, alongside [Pub/Sub Batch](/articles/integrate-customer/pub-sub-batch). If instead you want to send data *out of* Zeotap CDP onto a Pub/Sub topic from a journey, that is the [Google Pub/Sub destination](/articles/integrate-customer/google-pub-sub) — a separate integration with its own setup. ## How Pub/Sub messaging works In publish/subscribe messaging, a publisher does not address a specific receiver. Publishers send messages to a topic, and every subscriber registered on that topic receives them. This decouples the sending and receiving systems, so each runs at its own pace and new subscribers can be added without changing the publisher. For this source, your systems are the publishers and Zeotap CDP is the subscriber. ## What it ingests * **Messages as they are published** — suited to data your platforms emit continuously, such as activity or usage events you want available for unification and audience building without waiting for a scheduled export. * **Customer Data (CE) or Non-Customer Entity (NCE) data** — you choose the data entity when you create the source. * **JSON payloads** — messages carry event, user, and page details as JSON. The **IMPLEMENTATION DETAILS** tab on the created source shows the format Zeotap CDP expects. ## Stream or batch? Both Pub/Sub sources read from Google Pub/Sub topics, but they differ in send cadence and in the payload shape they expect. The two sources expect different JSON shapes — Pub/Sub Stream takes nested event/user/page objects, Pub/Sub Batch takes flattened keys in minified form — so check the data format on the create page for the source you choose. Choose **Pub/Sub Stream** when your systems publish messages continuously and you want each one ingested as it is published. Choose [Pub/Sub Batch](/articles/integrate-customer/pub-sub-batch) when you send many messages together in a single request instead of one at a time. > [!NOTE] > > We recommend using different Topic IDs for your Pub/Sub Stream and Pub/Sub Batch sources. If both sources point at the same Topic ID, you receive the same data in both. ## Next steps * [Create a Pub/Sub Stream source](/articles/integrate-customer/create-a-pub-sub-streaming-source) — the prerequisites (Topic ID, service account, and data format) and the step-by-step setup. * [Message Queue](/articles/integrate-customer/message-queue) — the other queue-based sources Zeotap CDP supports. # PubMatic Source: https://docs.zeotap.com/articles/integrate-customer/pubmatic Set up a PubMatic destination in Zeotap CDP to activate audience segments on PubMatic's sell-side platform. ## What this is PubMatic is a sell-side platform (SSP) that helps publishers monetise digital content by connecting them with advertisers. The PubMatic destination in Zeotap CDP delivers your audience segments to a PubMatic account so you can target those users in programmatic campaigns. Because PubMatic does not accept `map` and `mwebIDs` identifiers together in a single segment, a Zeotap segment that includes both is split into two entries in your PubMatic console — worth understanding before you build segments and configure sharing permissions. ## Prerequisites Before you create the destination, collect the following from your PubMatic point of contact: * **Account ID** — the unique identifier for your PubMatic account, used for tracking and reporting. * **Account Type** — one of `PUBLISHER`, `DEMAND_PARTNER`, or `BUYER`. * **Currency** — the currency for reporting. USD is selected by default. You also need access to the **Destinations** application in the Zeotap CDP app. ## Supported identifiers The PubMatic destination accepts these identifier types: * PubMatic Cookies * MAIDs (mobile advertising IDs) * IDP Base * ID5 You can edit, add, or remove identifiers during field mapping. ## Create the PubMatic destination **1. Open the Destinations app and start a new destination** In the Zeotap CDP app, open the **Destinations** application and choose **+ Create Destination**. ![Create Destination button in the Destinations application](https://mintcdn.com/zeotap/wwl-XxoFg7U2kGQg/articles/integrate-customer/Storage/integrate-customer/pubmatic/ADOBE_DMP_3.png?fit=max\&auto=format\&n=wwl-XxoFg7U2kGQg\&q=85\&s=bbc9384154e2f29441289e0b62fcf27c) **2. Select PubMatic from the destination catalogue** Under **All Destinations**, search for **PubMatic** and select it. ![Searching for PubMatic under All Destinations](https://mintcdn.com/zeotap/wwl-XxoFg7U2kGQg/articles/integrate-customer/Storage/integrate-customer/pubmatic/ADOBE_DMP_4.png?fit=max\&auto=format\&n=wwl-XxoFg7U2kGQg\&q=85\&s=7418bc2d2797ca5695fe5bf9dce05d28) **3. Enter the account details** On the destination detail screen, provide the values gathered in Prerequisites: * A name for the destination * The **Account Id** for the account receiving the segment * The **Currency** (USD by default) * The **Account type**: `PUBLISHER`, `DEMAND_PARTNER`, or `BUYER` Review the values and click **Next** to proceed. ![PubMatic destination detail screen with account fields](https://mintcdn.com/zeotap/wwl-XxoFg7U2kGQg/articles/integrate-customer/Storage/integrate-customer/pubmatic_1.png?fit=max\&auto=format\&n=wwl-XxoFg7U2kGQg\&q=85\&s=a99b9ff398c49680d9f414d8c108180e) **4. Choose an action and map identifiers** Choose an [action](/articles/integrate-customer/destinations#actionsanchor) under **Choose your Action**, then pick the identifiers under **Map the Fields**. The identifiers PubMatic accepts — MAIDs, Cookies, IDP Base, ID5 — are shown by default; edit the list if you need a different mapping. See the [mapping reference](/articles/integrate-customer/destinations#mappingsanchor) for details. Click **Create Destination** to save. The new destination is added to the **Audience** application, where you can link it to a segment. ![Choose your Action and Map the Fields screen for PubMatic](https://mintcdn.com/zeotap/wwl-XxoFg7U2kGQg/articles/integrate-customer/Storage/integrate-customer/pubmatic_2.png?fit=max\&auto=format\&n=wwl-XxoFg7U2kGQg\&q=85\&s=0233c605c5bbdc58048bf0700eeea291) ## Link an audience to the destination Attach an audience or segment to the PubMatic destination from the **Target** or **Connect** applications — see [Link an Audience to the Destination](/articles/integrate-customer/link-an-audience-to-the-destination) for the linking workflow. After linking, delivery to the PubMatic seat takes up to three business days. > [!NOTE] > > The terms *Audience* and *Segment* are used interchangeably to refer to a customer cohort — for example, users over 18 who performed an `addToCart` event in the last 30 days. ## Verify the segment reached PubMatic Once the destination is linked and the delivery window has passed, confirm the segment is available on PubMatic: 1. Open the PubMatic console and go to **Audience Segments**. 2. Locate the segment you linked. If your Zeotap segment used both `map` and `mwebIDs` identifiers, you will see two separate entries for the same segment name — Zeotap creates two versions of the segment and pushes both, because PubMatic does not accept these two identifiers in one segment. 3. In the Zeotap CDP app, the two versions show as two cards with two separate segment IDs — one for cookie and one for Device IDs. 4. Update the sharing permissions in PubMatic for the delivered segment(s) so downstream buyers can access them. ![Split segment entries listed under Audience Segments in the PubMatic console](https://mintcdn.com/zeotap/wwl-XxoFg7U2kGQg/articles/integrate-customer/Storage/integrate-customer/pubmatic-2023-05-12-2.png?fit=max\&auto=format\&n=wwl-XxoFg7U2kGQg\&q=85\&s=95137747b9472bb8158886bcf43ef3a7) A split segment appears in PubMatic like this: ```text theme={null} Zeotap segment: high_intent_shoppers identifiers: [map, mwebIDs] Delivered to PubMatic Audience Segments as: high_intent_shoppers (segment ID: ) high_intent_shoppers (segment ID: ) ``` ![Two segment cards with separate segment IDs in the Zeotap CDP app](https://mintcdn.com/zeotap/wwl-XxoFg7U2kGQg/articles/integrate-customer/Storage/integrate-customer/pubmatic/pubmatic-2023-05-18.png?fit=max\&auto=format\&n=wwl-XxoFg7U2kGQg\&q=85\&s=7ede0e78584f58fd98b93ad8e68b7e5d) ## How user disqualification works A user is disqualified from a Connect segment when they no longer meet the segment criteria, when required consent is withdrawn, or when another condition set on the segment no longer holds. * On the next refresh cycle after disqualification, Zeotap issues a user-deletion request for that user against the corresponding PubMatic audience. * Disqualified users are excluded from segments on the refresh frequency you configured for the Connect segment. * Disqualification runs automatically — you do not trigger it manually. You do need to enable deletion of users from segments during refresh in the **Admin** application for those deletions to be sent. ![Setting to delete users from segments during refresh in the Admin application](https://mintcdn.com/zeotap/xGzkHY-dcQy5tLit/articles/integrate-customer/Storage/integrate-customer/FB_1.png?fit=max\&auto=format\&n=xGzkHY-dcQy5tLit\&q=85\&s=a55c995439595f427f2a15d2591c5e52) ## Troubleshooting Use this table to diagnose the symptoms customers see after linking a PubMatic destination: | Symptom | What it means | Where to look | Fix | | - | - | - | - | | Linked segment does not appear in PubMatic **Audience Segments** after three business days | The delivery window has elapsed without the segment landing on the PubMatic seat | PubMatic console → **Audience Segments** | Confirm the Zeotap destination is enabled and the audience is linked; if both are correct, contact your Zeotap customer success representative with the segment ID | | Only one entry appears for a segment that combined `map` and `mwebIDs` | One of the two split versions has not been delivered yet, or delivery of one version failed | PubMatic console → **Audience Segments**, and the **Audience** application in Zeotap CDP (two cards with two segment IDs are expected) | Wait for the three-business-day window to complete; if only one entry remains after that, contact your Zeotap customer success representative | | A downstream buyer cannot see the delivered segment on PubMatic | Sharing permissions have not been configured on the delivered entry in PubMatic | PubMatic console → **Audience Segments** → segment sharing settings | Update sharing permissions on the delivered segment(s) so the buyer has access | | Users continue to appear in a PubMatic segment after they no longer qualify | Refresh-time deletion is not enabled, or the refresh cycle has not yet run | Zeotap **Admin** application → deletion of users from segments during refresh | Enable the setting and wait for the next configured refresh cycle for the Connect segment | | **Account Id** or **Account type** rejected during destination creation | The account identifier does not match a valid PubMatic account of the selected type | The destination configuration screen in the Zeotap CDP app | Re-request the correct **Account Id** and **Account Type** from your PubMatic point of contact and re-enter them | ## Next steps * [Explore linking an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore the PubMatic Publisher destination →](/articles/integrate-customer/pubmatic-publisher) * [Explore output identifiers →](/articles/segment-customer/choose-the-output-identifiers) * [Explore destination actions and mappings →](/articles/integrate-customer/destinations) # PubMatic Publisher Source: https://docs.zeotap.com/articles/integrate-customer/pubmatic-publisher Send audiences from Zeotap CDP to your account on PubMatic's sell-side platform for programmatic monetisation. ## What this is PubMatic Publisher is a batch **destination**: data flows one way, out of Zeotap CDP to your PubMatic account. You build an audience in Zeotap, activate it to this destination, and Zeotap uploads the mapped identifiers to your PubMatic seat, where the segment becomes available for programmatic monetisation. PubMatic is a global sell-side platform (SSP) that allows publishers to monetise their digital content by connecting them with a network of advertisers. Integrated with Zeotap it helps marketers better understand their customers, improve the targeting of advertising campaigns and optimise the marketing strategies. Zeotap offers two PubMatic destinations, and they differ only in what they ask for at setup: | Destination | Asks for | Use it when | | - | - | - | | **PubMatic Publisher** (this page) | Account ID and **Data Provider ID** | You are activating into a publisher account identified by a data provider ID. | | [**PubMatic**](/articles/integrate-customer/pubmatic) | Account ID, **Currency** and **Account Type** (`PUBLISHER`, `DEMAND_PARTNER` or `BUYER`) | You are activating into an account whose type you select at setup. | ## Supported identifiers and actions This channel supports PubMatic Cookies, MAIDs, IDP Base and ID5. | Action | What it sends | | - | - | | **Send identifiers to Pubmatic** | The [output identifiers](/articles/segment-customer/choose-the-output-identifiers) you map for each qualifying customer in the audience. | ## Prerequisites Before you create the destination, have the following ready. | What you need | Where it comes from | | - | - | | **Account ID** | The unique identifier assigned to each account on the PubMatic platform. It distinguishes between different accounts and is needed for tracking and reporting. Ask your PubMatic point of contact for it. | | **Data Provider ID** | The unique identifier assigned to each data provider account on the PubMatic platform. It distinguishes between different data sources and is required for activating, managing and reporting on audience segments. Ask your PubMatic point of contact for it. | | An **audience** to activate | Built in the Zeotap CDP App. See [Destinations](/articles/integrate-customer/destinations) for the upstream source, catalogue and audience setup. | ## Create the PubMatic Publisher destination **1. Open the Destinations application** Log into the Zeotap CDP App and go to the **DESTINATIONS** application. **2. Start a new destination** Click **+ Create Destination**. ![The Destinations list in the Zeotap CDP App, with the Create Destination button highlighted at the top right of the table.](https://mintcdn.com/zeotap/wwl-XxoFg7U2kGQg/articles/integrate-customer/Storage/integrate-customer/pubmatic/ADOBE_DMP_3.png?fit=max\&auto=format\&n=wwl-XxoFg7U2kGQg\&q=85\&s=bbc9384154e2f29441289e0b62fcf27c) **3. Find the destination in the catalogue** Under **All Destinations**, search for **PubMatic Publisher**. ![The All Destinations catalogue with the Search for a Destination box highlighted above a grid of destination tiles.](https://mintcdn.com/zeotap/wwl-XxoFg7U2kGQg/articles/integrate-customer/Storage/integrate-customer/pubmatic/ADOBE_DMP_4.png?fit=max\&auto=format\&n=wwl-XxoFg7U2kGQg\&q=85\&s=7418bc2d2797ca5695fe5bf9dce05d28) **4. Enter the destination details** Click **PubMatic Publisher**. Details about the destination appear on the left of the screen; the fields required for the integration appear on the right. Enter: a. A **Destination Name**, for easy identification. b. The **Account ID** corresponding to your PubMatic account. c. The **Data Provider ID** corresponding to your PubMatic account. d. Review the values, then click **Next**. ![The Enter Destination Details step for Pubmatic Publisher, showing the empty Destination Name, Account ID and Data Provider ID fields with the Next button at the bottom right.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-143.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=3854202216ed58415ca9837628544907) **5. Choose the action and mapping** On the **Mapping** screen: a. Choose **Send identifiers to Pubmatic** under **Choose your Action**, then choose the corresponding identifiers under **Map the Fields**. The [output identifiers](/articles/segment-customer/choose-the-output-identifiers) accepted by the platform — MAIDs, Cookies, IDP Base and ID5 — are displayed by default. You can edit, add or remove an identifier from the list; see [defining the mapping](/articles/integrate-customer/destinations#define-the-mapping). b. Click **Create Destination**. The destination is then listed in the **Audience** application, ready to be linked to an audience or segment. ![The Mapping step with Send identifiers to Pubmatic selected as the action, and catalogue identifier rows mapped to their PubMatic destination fields.](https://mintcdn.com/zeotap/wwl-XxoFg7U2kGQg/articles/integrate-customer/Storage/integrate-customer/pubmatic_2.png?fit=max\&auto=format\&n=wwl-XxoFg7U2kGQg\&q=85\&s=0233c605c5bbdc58048bf0700eeea291) For the general shape of this flow across all destinations, see [configuring a destination](/articles/integrate-customer/destinations#configure-a-destination). ## Link an audience to the destination For how to link an audience or segment to the destination in the **Target** and **Connect** applications, see [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination). It can take up to three business days for the segment to be available at the PubMatic seat. > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience or a segment can be a specific group of customers who are over 18 years of age and have performed an `addToCart` event within the last 30 days. ## Verify the segments in PubMatic In the PubMatic console, the segments pushed by Zeotap appear under **Audience Segments**, listed against the data provider ID they were uploaded for. ![The Audiences table in the PubMatic console, listing segments whose Source column reads Zeotap, alongside their DPID, Shared With, CPM, Total Users and Status columns.](https://mintcdn.com/zeotap/wwl-XxoFg7U2kGQg/articles/integrate-customer/Storage/integrate-customer/pubmatic-2023-05-12-2.png?fit=max\&auto=format\&n=wwl-XxoFg7U2kGQg\&q=85\&s=95137747b9472bb8158886bcf43ef3a7) PubMatic has limitations when it comes to handling `map` and `mwebIDs` within the same segment. If you create a segment in the Zeotap CDP App that includes both `map` and `mwebIDs`, Zeotap creates two versions of it and pushes them both to PubMatic. As a result, both versions are listed together under **Audience Segments**, and you are required to update the sharing permissions for both segments accordingly. Within the Zeotap CDP App you can see the matching pair as two cards with two separate segment IDs (one for cookie and the other for device IDs). ![A segment in the Zeotap CDP App showing its identifier counts and two PubMatic destination cards that share a destination ID but carry different segment IDs.](https://mintcdn.com/zeotap/wwl-XxoFg7U2kGQg/articles/integrate-customer/Storage/integrate-customer/pubmatic/pubmatic-2023-05-18.png?fit=max\&auto=format\&n=wwl-XxoFg7U2kGQg\&q=85\&s=7ede0e78584f58fd98b93ad8e68b7e5d) > [!NOTE] > > Once uploads are completed from Zeotap, it may take a few hours for the files to appear and be ingested on the PubMatic platform. ## How users are disqualified from segments A user may be disqualified from a segment for various reasons, such as not meeting the segment criteria, a consent requirement, or any other condition set for a particular Connect segment. * Once a user disqualifies from a Connect segment, Zeotap initiates a user deletion request in the subsequent refresh cycle. These requests are sent to the audiences that were created on PubMatic. * Disqualified users are excluded from the segments based on the refresh frequency configured for that Connect segment. * Disqualification is a programmatic process that works automatically — you do not have to specify anything to trigger it. You do, however, have to enable the deletion of users from segments during refresh, on the Admin application. ![The Refresh Frequency setting, set to Daily, with the Enable deletion of users from Segments during Refresh checkbox selected below it.](https://mintcdn.com/zeotap/xGzkHY-dcQy5tLit/articles/integrate-customer/Storage/integrate-customer/FB_1.png?fit=max\&auto=format\&n=xGzkHY-dcQy5tLit\&q=85\&s=a55c995439595f427f2a15d2591c5e52) ## Troubleshoot the integration | Symptom | What to check | | - | - | | The segment is not visible at the PubMatic seat yet. | It can take up to three business days for the segment to be available at the PubMatic seat. Once uploads complete from Zeotap, it can take a further few hours for the files to appear and be ingested on the PubMatic platform. | | Two segments appear in PubMatic for one Zeotap audience. | This is expected when the audience includes both `map` and `mwebIDs` — Zeotap pushes two versions. Update the sharing permissions on both. | | Disqualified users are still present in the PubMatic audience. | Exclusions follow the refresh frequency configured for the Connect segment, and require deletion of users from segments during refresh to be enabled. | | The audience–destination pair records a delivery error. | See [why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail) for the errors that surface on a destination and what each one means. | ## Next steps * [Set up the PubMatic destination →](/articles/integrate-customer/pubmatic) * [Link an audience to the destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Choose the output identifiers →](/articles/segment-customer/choose-the-output-identifiers) * [Explore the Destinations overview →](/articles/integrate-customer/destinations) # Quantcast Source: https://docs.zeotap.com/articles/integrate-customer/quantcast Send audience identifiers out of Zeotap CDP to your Quantcast seat as a batch destination. Quantcast is an outbound batch destination: Zeotap CDP sends audience identifiers **out to your Quantcast seat**, where they arrive as a segment you can target in Quantcast campaigns. Data does not flow the other way — the [Integrations Master List](/articles/integrations-master-list-publication/integrations-master-list) lists Quantcast as a destination-only batch integration, so there is no companion Quantcast source page to pair with this one. ## What this is Quantcast is an advertising technology company that empowers brands, agencies and publishers to know and grow their audiences online through the usage of their patented AI and machine learning engine. They deliver automated insights, marketing performance, and results at scale to drive business growth. In Zeotap CDP, Quantcast is one destination in the [Destinations](/articles/integrate-customer/destinations) module. You configure it once against your Quantcast Data owner pcode and then reuse it for every audience you link to it. ## Supported identifiers This integration supports Quantcast Cookies only. ## Available actions | Action | [ID Extension](/articles/segment-customer/extend-your-audience#id-extension) | [Delete](/articles/segment-customer/delta-upload-and-delete-functions) | [Delta Upload](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send identifiers to Quantcast | ✅ | — | — | The destination exposes a single action, **Send identifiers to Quantcast**. It supports [ID Extension](/articles/segment-customer/extend-your-audience#id-extension) for expanding the audience before delivery. Delete and Delta Upload are not supported. ## Prerequisites > [!NOTE] > > Before you create the destination, make sure you have: > > * **Your Data owner pcode** — the customer code Quantcast issues to you. It is the only Quantcast detail the destination configuration asks for. > * **An audience** defined in Zeotap CDP with the criteria for the cohort you want to activate. > * **Destination edit rights** on the organisation that owns the destination. See the [Destinations prerequisites](/articles/integrate-customer/destinations#prerequisites). ## Create the Quantcast destination **Step 1** Log into the Zeotap CDP App and go to the **DESTINATIONS** application. **Step 2** Click **+ Create Destination**. ![The Destinations module listing, with the + Create Destination button highlighted at the top right of the page.](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_1.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=92dfe8ecb29e59c9d7d57cb954e54618) **Step 3** Under **All Destinations**, search for **Quantcast**. ![The All Destinations catalogue, with the search box highlighted above a grid of destination tiles.](https://mintcdn.com/zeotap/oGjzXQ32KVGTt8MH/articles/integrate-customer/Storage/integrate-customer/adform/Destinations_all_2.png?fit=max\&auto=format\&n=oGjzXQ32KVGTt8MH\&q=85\&s=6f5f0f5367788fb4e9e946f4b3cb5874) **Step 4** Click **Quantcast**. A screen appears with details about the destination on the left and the fields the integration needs on the right. Fill in the **Enter Destination Details** step: a. Enter a name for the destination. Choose a name that identifies the Quantcast seat it connects to, so the destination is easy to find when you link an audience. b. Enter the **Data owner pcode**. c. Review the values you entered and click **Next**. ![The Enter Destination Details step of the Quantcast destination setup, showing the Destination Name and Data owner pcode fields, with the in-product note that it can take up to three business days for segments to be available at the Quantcast seat.](https://mintcdn.com/zeotap/wwl-XxoFg7U2kGQg/articles/integrate-customer/Storage/integrate-customer/quantcast/quantcast-2023-11-09.png?fit=max\&auto=format\&n=wwl-XxoFg7U2kGQg\&q=85\&s=5683eb1bd99dbb142f34d6c9899a89e1) **Step 5** On the **Mapping** step, choose the action and the identifiers to send: a. Under **Choose your Action**, select **Send identifiers to Quantcast**. For background on how actions work, see [Configure a destination](/articles/integrate-customer/destinations#configure-a-destination). b. Under **Choose your Output IDs to send to destinations**, map the [output identifiers](/articles/segment-customer/choose-the-output-identifiers) the platform accepts. The mapping is pre-populated; you can edit, add or remove a row so only the identifiers you intend to send remain. See [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). c. Click **Create Destination**. The created destination is listed in the **Audiences** application, where it can be linked to an audience or segment. ![The Mapping step of the Quantcast destination setup, with Send identifiers to Quantcast selected as the action and Quantcast Cookie mapped from the Catalogue field to the destination field.](https://mintcdn.com/zeotap/wwl-XxoFg7U2kGQg/articles/integrate-customer/Storage/integrate-customer/quantcast/quantcast-2023-11-09-1.png?fit=max\&auto=format\&n=wwl-XxoFg7U2kGQg\&q=85\&s=a3010a959d32583f8606d877b164ee5f) ## Link an audience to the destination For the end-to-end workflow for linking an audience or segment to the created destination in the **Audiences** application, see [Activate your batch audiences](/articles/integrate-customer/link-an-audience-to-the-destination). It can take up to three business days for segments to be available at the Quantcast seat. The destination configuration screen states the same expectation. > [!NOTE] > > **Note:** > > Keep the following in mind while linking an audience or segment to the Quantcast destination: > > * Ensure that a minimum of 2,000 customers are available in the segment. Otherwise, the segment might fail. > * If a segment contains fewer than 10,000 customers, then the effectiveness of ad targeting may be limited. ## Verify the activation reached Quantcast After you link an audience, confirm delivery from both sides: 1. **In Zeotap CDP** — the destination is listed among your saved destinations and is selectable when you link an audience, and the audience–destination pair records a completed run with a non-zero qualified count. For what a healthy run looks like and what the counts mean, see [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). 2. **At the Quantcast seat** — the segment appears and is available for targeting. Allow the full three-business-day window before treating a missing segment as a failure. ## Troubleshoot the Quantcast destination | Symptom | What it means | What to do | | :- | :- | :- | | The segment is not visible at the Quantcast seat | Segments can take up to three business days to become available at the seat after activation | Wait out the three-business-day window before investigating further | | The segment fails after activation | The linked audience may hold fewer than the 2,000 customers this destination requires | Widen the audience criteria so at least 2,000 customers qualify, then re-run the activation | | The segment reaches Quantcast but targeting performs poorly | Segments under 10,000 customers can limit the effectiveness of ad targeting | Widen the audience criteria to raise the qualifying count | | Fewer customers reach Quantcast than the audience count suggests | Quantcast Cookies are the only identifier this destination sends, so the reach of the delivered segment is bounded by how many audience members Zeotap CDP holds a Quantcast Cookie for | Check the mapping on the destination, and expect a gap between the audience count and the seat-side count | For errors that surface on the audience–destination pair itself — a failed refresh, a rejected payload, a run stuck in progress — see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail). If the destination is configured correctly and the problem persists, see [When to contact support](/articles/integrate-customer/destinations#when-to-contact-support) for what to include in the request. ## Next steps * [Explore how to activate your batch audiences →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore the Destinations module →](/articles/integrate-customer/destinations) * [Explore how to choose the output identifiers →](/articles/segment-customer/choose-the-output-identifiers) * [Explore ID Extension for extending an audience →](/articles/segment-customer/extend-your-audience#id-extension) * [Explore the full Integrations Master List →](/articles/integrations-master-list-publication/integrations-master-list) # Real-Time Integrations Source: https://docs.zeotap.com/articles/integrate-customer/real-time-integrations Understand how Zeotap CDP real-time destinations deliver activation data through Journeys, and how to configure and verify one end-to-end. ## What this is Real-time integrations in Zeotap CDP deliver activation data to a destination platform through the Journeys application. Each integration is configured once as a Destination — with the credentials and mapping the downstream platform requires — and then attached to a workflow through the **Send to Destinations** node so records flow as users move through the journey. Zeotap CDP supports real-time destinations across email and marketing automation (Adobe Campaign, Cleverpush), mobile engagement (Airship, Batch), and e-commerce (Channable), among others. This page covers what a real-time destination is, what you need before you configure one, the shared configuration pattern every real-time destination follows, and how to verify delivery is live. ## Prerequisites > [!NOTE] > > Before you configure a real-time destination, ensure you have: > > * An active account on the downstream platform with the credentials that integration requires (API key, access token, workspace/company/channel identifiers, or cloud-storage bucket details — the exact set depends on the destination). > * A Journeys workflow, or the ability to create one, in which the destination will be attached to a **Send to Destinations** node. See [Create a Workflow](/articles/orchestrate-customer/create-a-workflow). > * The identifiers and attributes you plan to send already declared on the downstream platform where that platform requires pre-registration. For example, Cleverpush attributes must exist on the channel before Zeotap CDP maps to them. ## Configure a real-time destination Every real-time destination follows the same configuration flow in Zeotap CDP, with per-destination fields for credentials and mapping. 1. In the Destinations application, start a new destination. Search for the destination by name and enter a name for it in your workspace. 2. Enter the credentials the destination requires. The exact fields differ by platform — Airship uses an **Access Token** and **X-UA-Appkey** with a region; Batch uses a **Live API Key** and **REST API Key**; Cleverpush uses a **Private API Key** and **Channel ID**; Channable uses an **API Key** and **Company ID**; Adobe Campaign uses either **S3** or **Azure** cloud-storage credentials. 3. Choose an action and complete the mapping. Under **Choose your Action**, pick the action the destination exposes — for example, **Send Named User to Airship**, **Batch Symphony**, or **Send identifiers and attributes to Cleverpush in Realtime**. Under **Map the Fields**, map Zeotap identifiers and attributes to the destination's fields, using **+ Add Mapping Field** to add custom ones. 4. Save the destination. It becomes available in the Destinations list and can be attached to a Journeys workflow. 5. In your Journeys workflow, add a **Send to Destinations** node, select the destination you created, and complete any per-workflow fields — for example, Batch requires an **Audience** name on the workflow; Channable requires a **Project ID**. Save the destination on the workflow. To attach more than one destination to the same node, click **Add Destinations**. ## Verify the destination is delivering * In Journeys, the destination appears attached inside the **Send to Destinations** node of your workflow, and the workflow is in **Published** state on the Workflow listing screen. * On the downstream platform, records begin appearing where that platform surfaces incoming data — for example, Batch surfaces user traits and events under **Settings → Custom data** in its dashboard. ## Why records are rejected Real-time destinations reject records when the mapping or credentials do not match what the downstream platform expects. The conditions Zeotap has documented across the supported real-time destinations are: | Error string | What it means | Where to look | | - | - | - | | Batch event attribute name contains uppercase or special characters | Batch accepts only lowercase letters, digits, and underscores in event attribute names | Mapping screen for the Batch destination — rename the attribute so it matches `^[a-z0-9_]+$` | | Channable stock update missing a mandatory field | Channable requires **Product ID** and **Stock** on every record | **Destination Settings** for the Channable destination | | Airship record missing every recipient identifier | Airship needs at least one of Named User, iOS Channel ID, Android Channel ID, or Web Channel ID (in that priority order), plus the mandatory Event Name and Event Timestamp | Mapping screen for the Airship destination | | Cleverpush attribute not pre-registered on the channel | Cleverpush requires each attribute to be added on the channel before Zeotap CDP maps to it | Cleverpush console → Channels → your channel → **Attributes**, then re-check the Zeotap CDP mapping | For Batch specifically, event attribute names must match the following character set or Batch rejects the record: ```regex theme={null} ^[a-z0-9_]+$ ``` > [!TIP] > > If a real-time destination stops delivering after previously working, re-check the credentials on the downstream platform first. Access tokens and API keys can be rotated or revoked outside of Zeotap CDP, and the destination will stop accepting requests until the credentials on the Zeotap side are refreshed. ## When to contact support Contact your Zeotap customer success representative if: * You configured the destination and mapping per the steps above and the downstream platform shows no incoming records after the workflow is published. * The downstream platform surfaces an error that is not covered by the table above and is not documented on the destination-specific integration page. Include in your request: the destination name, the destination platform, the workflow ID and its published state, the mapping you configured, and the exact error text from the downstream platform. ## FAQ > [accordion] What is the difference between a real-time integration and a batch integration? > > A real-time integration delivers records to the destination platform as they flow through a Journeys workflow, using the **Send to Destinations** node. A batch integration delivers records in scheduled files or API calls. Airship and Cleverpush, among other platforms, offer both a batch and a real-time integration; pick the mode that matches how you want the downstream platform to receive data. > [accordion] Can I attach more than one destination to a Journeys workflow? > > Yes. In the **Send to Destinations** node, click **Add Destinations** to attach additional destinations to the same workflow. > [accordion] Where do I find the full list of destinations Zeotap CDP supports? > > See the [Integrations Master List](/articles/integrations-master-list-publication/integrations-master-list) for the complete catalog of sources and destinations. ## Next steps * Explore the [Integrations Master List →](/articles/integrations-master-list-publication/integrations-master-list) to see every source and destination Zeotap CDP supports. * Explore [Source Integrations (Batch + Real-Time) →](/articles/integrate-customer/creating-a-source) to configure the source side of your data flow. * Explore the [Adobe Campaign Real-Time Integration →](/articles/integrate-customer/adobe-campaign-real-time-integration) for a worked end-to-end example of a cloud-storage-backed real-time destination. * Explore the [Airship Real-Time Integration →](/articles/integrate-customer/airship-real-time-destination-integration) for a worked end-to-end example of an API-backed real-time destination with identifier priority. * Explore the [Batch Real-Time Integration →](/articles/integrate-customer/batch-real-time-destination-integration) for a worked example including the attribute naming rule enforced by Batch. # Reddit Source: https://docs.zeotap.com/articles/integrate-customer/reddit Export Zeotap CDP audiences to your own Amazon S3 bucket as CSV files, then upload them to Reddit Ads Manager as a custom audience. ## What this is Data flows out of Zeotap CDP to Reddit. Reddit is a **batch** destination: when you link an audience to it, Zeotap CDP writes the audience members to an Amazon S3 bucket that you own, as CSV files. You then download those files and upload them to Reddit Ads Manager as a custom audience. This is a one-way export — the destination sends data to your bucket and reads nothing back from Reddit. Note that delivery into Reddit is not automatic. Zeotap CDP's part of the job finishes at your S3 bucket; moving the file into Reddit Ads Manager is a step you perform yourself. Reddit is a social media platform that offers a range of advertising solutions to help marketers reach their target audience through Reddit Ads Manager. This allows advertisers to show ads to users across multiple use cases based on their interests and activity on the platform. ### Other Reddit destinations Zeotap CDP has three Reddit destinations. All three carry data out of Zeotap CDP towards Reddit — this one by way of your own S3 bucket, the other two directly. There is no Reddit source that brings data back in. | Destination | Lane | What it sends | | :- | :- | :- | | **Reddit** (this page) | Batch | Audience members, as CSV files in your S3 bucket, for custom-audience targeting | | [Reddit CAPI](/articles/integrate-customer/reddit-capi) | Real-time | Conversion events, from a **Send to Destinations** node in a journey | | [Reddit Offline CAPI](/articles/integrate-customer/reddit-offline-capi) | Batch | Offline conversion events, linked to an audience | ## Supported identifiers and actions This integration supports email addresses (both raw and hashed) and MAIDs. The following table lists the available action types for the integration and the supported features for each action type: | Action name | [ID extension](/articles/segment-customer/extend-your-audience#id-extension) | [Delete](/articles/segment-customer/delta-upload-and-delete-functions) | [Delta upload](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send identifiers to Reddit | ✅ | - | - | ## Prerequisites To enable this integration, ensure that you have a Reddit Ads Manager account and an Amazon S3 cloud storage. ### Destination details you need Have the following to hand before you create the destination. All five describe your own S3 storage, not anything held in Reddit. | Field | What to enter | | :- | :- | | **Bucket** | The name of your S3 bucket. | | **S3 Bucket region** | The location of your S3 bucket where Zeotap CDP can store your export data as CSV files. | | **Folder** | The path in your storage location where Zeotap CDP can store your export data as CSV files. | | **S3 access token** | The security token that provides access to Amazon S3 resources for a limited time. | | **S3 secret token** | The cryptographic token that is generated to protect certain data stored on S3. | ## Create the Reddit destination **Step 1** Log into the Zeotap CDP App and go to the **DESTINATIONS** application. **Step 2** Click **+ Create Destination**. **Step 3** Under the **All Destinations** section, search for **Reddit**. ![The Integrate, Destinations screen in Zeotap CDP, with the All Destinations search box highlighted above the list of destination tiles.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/rtb-house/RTB_H2.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=4c1d1c71f84cc22f0a9975e76200c682) **Step 4** Click **Reddit**. A screen appears displaying details about the particular destination towards the left. On the right-hand side of the screen find a list of fields that are required for the integration to be established. Enter the required details as mentioned in the following steps: a. Enter a descriptive name for the Destination. b. In the **Bucket** field, enter the name of the S3 bucket. c. In the **S3 Bucket region** field, enter the region of your S3 bucket where Zeotap CDP can store your export data as CSV files. d. In the **Folder** field, provide the folder path in your storage location where Zeotap CDP can store your exported data. e. Enter **S3 access token** and **S3 secret token** in their respective fields. For more information about these fields, refer to the [Destination details you need](#destination-details-you-need) section. f. Review all the values entered above and then click **Next** to proceed. ![The Enter Destination Details step of the Reddit destination, showing the Bucket, S3 Bucket region, Folder, S3 access token and S3 secret token fields, with Back and Next buttons below.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/reddit/reddit_1.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=7a49b98783f294008a370c4ea3b620f5) **Step 5** In the new screen that appears, choose the appropriate [action](/articles/integrate-customer/destinations#configure-a-destination) under **Choose your Action** and then choose the corresponding identifiers under **Map the Fields**. By default, the [output identifiers](/articles/segment-customer/choose-the-output-identifiers) that this destination accepts — email addresses and MAIDs — are displayed. However, you can edit, add or remove an identifier from the list. To do so, refer to [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). **Step 6** Click **Create Destination**. The created Destination gets listed in the **Audiences** application, which can be linked to an Audience or segment. ![The Mapping step of destination creation, with Send identifiers to Reddit selected under Choose your Action, and Email Raw and Maid mapped to their destination fields under Output Identifiers Mapping.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/reddit/reddit_2.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=353de9ed742dbf5a8bdcfcea021b4169) ## Link an audience to the destination For information about how to link an Audience or segment to the created Destination in the **Audiences** application, refer to [Activate your batch audiences](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > **Note:** > > *The terms Audiences and Segments are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an Audience or a segment could be a specific group of customers who are over 18 years of age and who have performed an `addToCart` event within the last 30 days.* ## Find the segment files in your S3 bucket After an Audience is linked to a Destination, Zeotap CDP generates segment files in CSV format with the following naming convention: `SegmentName_SegmentID_IDtype_timestamp.csv` > [!NOTE] > > **Note:** > > You can recognise the segment files by the identifiers mapped. In addition, note that the timestamp in these files is in epoch format. Let's understand with an example. Suppose you create a segment called PublicAbove18 with the segment ID 1234. You map identifiers like email addresses (both raw and hashed) and MAIDs. Here's how the files are named: * For the segment file containing hashed email addresses: `PublicAbove18_1234_Email Addresses (hashed)_timestamp.csv` * For the segment file containing MAIDs: `PublicAbove18_1234_Mobile IDs_timestamp.csv` * For the segment file containing email addresses: `PublicAbove18_1234_Email Addresses_timestamp.csv` ## Upload a segment file to Reddit Ads Manager Download the CSV file from your S3 bucket and upload it to Reddit as explained in the following steps. **Step 1** Log into your Reddit platform and navigate to **Dashboard** > **Audiences**. ![The Reddit Ads Manager Dashboard menu open, with Audiences highlighted in the Assets column.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/reddit/reddit_platform_1.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=ef6963f2376b4a33e64ca0249d65af79) **Step 2** In the following page that appears, click **New Audience** > **Custom audience**. ![The Reddit Audience Manager with the New Audience menu open and Custom audience highlighted, above a list of existing saved and customer-list audiences.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/reddit/reddit_platform_2.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=1e5b84bbd265828a889154f69fe1df09) **Step 3** In the **Create new custom audience** panel that appears, under **Select audience type** choose **Customers lists**. ![Step 1 of 2 of the Create new custom audience panel, with Customers lists highlighted above the Website Retargeting and Reddit Engagement Retargeting options.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/reddit/reddit_platform_3.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=fa982d1165157eb779aa99f9ccad7f7c) **Step 4** On the **Customer Lists** step, provide the following information: a. Provide a **Custom audience name** for your CSV file. b. Under **Customer list source**, click **Upload File**, then drag and drop your CSV file or click **browse files** to select it. c. Select the **Agree to terms** checkbox and click **Create**. ![Step 2 of 2 of the Create new custom audience panel, showing the Custom audience name field, the Upload File and Copy and Paste source options, the drag-and-drop area, the Agree to terms checkbox and the Create button.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/reddit/reddit_platform_5.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=c920ff10892bc4edd872c2c8eea31247) ## Verify the audience in Reddit Ads Manager The uploaded CSV file gets listed on the **Audience Manager** page with the **Type** shown as **Customer Lists**. ![The Reddit Audience Manager list with a newly created audience row highlighted, showing its Type as Customer Lists.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/reddit/reddit_platform_6.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=05b3964d14f3dbad9de4e2f8c56a128a) ## Next steps * [Activate your batch audiences](/articles/integrate-customer/link-an-audience-to-the-destination) — link an Audience to this Destination. * [Choose the output identifiers](/articles/segment-customer/choose-the-output-identifiers) — control which identifiers are sent. * [Extend your audience](/articles/segment-customer/extend-your-audience#id-extension) — apply ID Extension to this Destination. * [Delta upload and delete functions](/articles/segment-customer/delta-upload-and-delete-functions) — background on these features; neither is supported by this destination. * [Reddit CAPI](/articles/integrate-customer/reddit-capi) and [Reddit Offline CAPI](/articles/integrate-customer/reddit-offline-capi) — send conversion events to Reddit instead of audience members. # Reddit CAPI destination Source: https://docs.zeotap.com/articles/integrate-customer/reddit-capi Send conversion events from a Zeotap CDP journey to your Reddit Ads account through the Reddit Conversions API. The Reddit CAPI destination sends conversion events **out of Zeotap CDP to your Reddit Ads account** through the Reddit Conversions API. It is a real-time integration: the destination is attached to a **Send to Destinations** node inside a journey, and each user who reaches that node has their event forwarded to Reddit. Reddit has two destinations in Zeotap CDP, across two lanes. Use this page for live conversion events. For offline conversions, see [Reddit Offline CAPI](/articles/integrate-customer/reddit-offline-capi). To activate audience lists on Reddit, see [Reddit](/articles/integrate-customer/reddit) — both of those are batch integrations driven from an audience rather than a journey. ## What this is Reddit is a social media platform that offers a range of advertising solutions to help marketers reach their target audience through Reddit Ads Manager. This allows advertisers to show ads to users across multiple use cases based on their interests and activity on the platform. The Reddit CAPI destination carries conversion events from a Zeotap CDP journey into the Reddit Pixel you nominate, so that conversions recorded in Zeotap CDP are counted alongside the ones Reddit's own pixel collects. You create the destination once in the **Destinations** application and then reuse it in any journey. ## Supported identifiers and actions This integration supports **SHA 256 Email** and **SHA 256 Phone Numbers**. You choose the action on the mapping screen when you create the destination. This page documents **Send Conversions to Reddit**. ## Prerequisites Before you start, confirm you have: * A **Reddit Ads account** with access to Reddit Ads Manager. * Access to the **Destinations** application in your Zeotap CDP workspace. * A journey you can attach the destination to. See [Create a workflow](/articles/orchestrate-customer/create-a-workflow) if you have not built one yet. ## Set up the Conversions API in Reddit Ads Manager Complete these steps in Reddit before you configure the destination in Zeotap CDP. You need two values from Reddit: a Pixel ID and a conversions access token. **Step 1** **Pixel ID** — in Reddit Ads Manager, go to **Events Manager** > **Pixel configuration** and copy the Pixel ID shown at the top of the page. ![Reddit business navigation panel listing Get Started, Dashboard, Create Campaign, Bulk Import, Events Manager (outlined), Audience Manager and Report Manager, with the campaign dashboard behind it](https://mintcdn.com/zeotap/wwl-XxoFg7U2kGQg/articles/integrate-customer/Storage/integrate-customer/reddit-capi/image-1.png?fit=max\&auto=format\&n=wwl-XxoFg7U2kGQg\&q=85\&s=90c1f3fa30aa2d03241ede0496a5fe1c) Reddit Ads Manager side navigation with Events Manager highlighted under Campaigns ![Reddit Events Manager Pixel configuration page showing the left navigation (Events overview, Pixel configuration, Event testing, Diagnostics, Conversions API, Attribution Settings), the Pixel ID label with an annotation arrow, and the Event Setup tab with no events yet](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/reddit-capi/image-2.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=ec68c02eccc7a31cec23319bdec44911) Pixel configuration page in Reddit Events Manager, with the Pixel ID label called out **Step 2** **Conversions access token** — go to **Events Manager** > **Conversions API** and click **+ Generate Access Token**. Copy the token that Reddit generates; you enter it as the **Access Token** when you create the destination. Reddit notes on this screen that conversion access tokens are secure keys granting permission to send conversion events to Reddit Ads, that they are generated by business administrators, and that one token can be used by any ad account in your business. ![Reddit Events Manager Conversions API page showing the Conversions access token card, its explanatory text, the + Generate Access Token button outlined, and a previously generated token listed by its name and last-accessed date](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/reddit-capi/image-3.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=62738b0159544cc50da10cf236b82498) Conversions API page in Reddit Events Manager, with the Generate Access Token button called out ## Create the Reddit CAPI destination **Step 1** Log into the Zeotap CDP App and go to the **DESTINATIONS** application. **Step 2** Click **+ Create Destination**. **Step 3** Under **All Destinations**, search for **Reddit CAPI**. **Step 4** Click **Reddit CAPI**. A screen appears with details about the destination on the left and the fields required to establish the integration on the right. Enter the following: a. **Destination Name** — a name you will recognise later in the destination list. b. **Access Token** — the conversions access token you generated in Reddit. This is the bearer token used to authenticate the calls to Reddit. c. **Destination Instance**. d. **Pixel ID** — the unique identifier for your Reddit Pixel. e. Click **Next** to proceed to mapping. ![Zeotap CDP Integrate > Destinations screen, step 1 Destination Details, showing the Reddit CAPI description panel on the left and empty Destination Name, Access Token, Destination Instance and Pixel ID fields on the right, with Back and Next buttons](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/reddit-capi/image-4.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=8e1456b094a3040182142228cd668d59) Destination Details step of the Reddit CAPI destination with all four fields still empty **Step 5** On the mapping screen, choose the action and map the fields. a. Under **Choose your Action**, select **Send Conversions to Reddit**. Under **Map the Fields**, choose the corresponding identifiers. By default the output identifiers accepted by the platform — the hashed email IDs list and hashed phone numbers — are displayed. b. **Event Timestamp** (Unix timestamp in milliseconds) is mandatory and must be mapped. > [!NOTE] > > **Note** > > *Please note that **events timestamp** must not be older than a **week**.* c. Click **Create Destination** to save the mapping. ![Zeotap CDP mapping step showing Choose your Action set to Send Conversions to Reddit, and a Map the Fields table pairing a Catalogue Field selector with the Click Id destination field, above Back and Create Destination buttons](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/reddit-capi/image-5.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=d9069580fdf4424893645eb31ec19781) Mapping step with Send Conversions to Reddit selected and the Catalogue-to-Destination field mapping below it ## Add the destination to a journey Because Reddit CAPI is a real-time integration, you activate it from a journey rather than by linking an audience. After creating the destination, attach it to the **Send to Destinations** node in your workflow. **Step 1** In the workflow, click **+** and choose **Send to Destinations**. ![Journey canvas node menu headed Choose an action, listing Add a Condition, Add a Delay, Create a Multi-branch Split, Create a True/False Split and Send to Destinations (outlined), with a tooltip explaining that it forwards customer data to channels](https://mintcdn.com/zeotap/wwl-XxoFg7U2kGQg/articles/integrate-customer/Storage/integrate-customer/reddit-capi/image-6.png?fit=max\&auto=format\&n=wwl-XxoFg7U2kGQg\&q=85\&s=c6a431b928f00b52323ad0830f7d736e) Choose an action menu on the journey canvas with Send to Destinations highlighted **Step 2** Choose the destination from the list of available destinations by using the search feature. ![Send to Destinations panel showing the + Add New Destination link, an outlined Search box, and a grid of existing destination cards, each showing a connector logo and the connector name](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/reddit-capi/image-7.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=9949432c28addaf167b698677c4dad78) Send to Destinations panel with the search box highlighted above the available destination cards **Step 3** Under the **Destination Details** tab, the **Access Token**, **Destination Instance** and **Pixel ID** fields are already filled in from the values you entered when you created the destination. **Step 4** Under **Event Source**, choose the appropriate option based on your requirement: * App * Website * Other **Step 5** Under **Event Type**, choose the event you are sending, using the drop-down menu: * Page Visit * View Content * Search * Add to Cart * Add to Wishlist * Purchase * Lead * Sign Up * Custom ![Reddit CAPI side panel inside a journey showing Destination Name, Access Token, Destination Instance and Pixel ID already filled in, with the Event Source and Event Type drop-downs outlined above the Save Destination button](https://mintcdn.com/zeotap/wwl-XxoFg7U2kGQg/articles/integrate-customer/Storage/integrate-customer/reddit-capi/image-8.png?fit=max\&auto=format\&n=wwl-XxoFg7U2kGQg\&q=85\&s=56578fffea47c168f7ef16e0728687ab) Reddit CAPI node panel with the Event Source and Event Type drop-downs called out **Step 6** Under the **Destination Settings** tab, choose the **Action** and mapping as per your requirement. **Step 7** Click **Save Destination**. The destination is attached to the node, as shown below. ![Send to Destinations panel with an attached Reddit CAPI destination card showing its name and the Send Conversions to Reddit mapping, above the search box and the remaining available destination cards](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/reddit-capi/image-9.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=a0272cf43e0692ec0958d213516253a9) Send to Destinations node after the Reddit CAPI destination has been attached ## Verify conversions in Reddit Ads Manager Once the journey is live, check that Reddit is receiving the events. **Step 1** Go to **Ads Manager** and select **Events Manager** > **Events overview**. ![Reddit Events overview page with an Event activity chart plotting All sources, CAPI and Pixel series over a date range, a Raw events table listing each event with Status, Total Raw Events, Pixel Events, CAPI Events and Source columns, and a Match Quality Score panel on the right](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/reddit-capi/image-10.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=cfc9d95ee8bae45dd5805de886af3080) Events overview in Reddit Ads Manager showing event activity, the raw events table and the Match Quality Score panel **Step 2** Confirm the following on that page: * The **Event activity** chart shows a CAPI series for the period you are checking. * In the **Raw events** table, the events you configured appear with a **Status** of Healthy and **CAPI** in the **Source** column, with a count under **CAPI Events**. * The **Match Quality Score** panel reports the identifier coverage Reddit was able to match for those events. ## Troubleshoot delivery issues **No CAPI events appear in Events overview.** Confirm the journey is published and that users are actually reaching the **Send to Destinations** node — [journey traces](/articles/orchestrate-customer/journey-traces) show, per user, which destination nodes were reached. Then confirm the destination is still attached to the node and that **Event Timestamp** is mapped on the destination's mapping screen. **Events are sent but are not accepted.** Check the event timestamps you are mapping. The event timestamp must not be older than a week, so events replayed from older data will not land. **The journey reports delivery errors.** Look up the code on [Journey error codes](/articles/orchestrate-customer/journey-error-codes), and see [Journey troubleshooting](/articles/orchestrate-customer/journey-troubleshooting) for the resolution steps. For failures common to every destination, see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail). ## Next steps * [Explore the batch Reddit destination for audience lists →](/articles/integrate-customer/reddit) * [Explore Reddit Offline CAPI for offline conversions →](/articles/integrate-customer/reddit-offline-capi) * [Explore how to activate your real-time audiences →](/articles/integrate-customer/activate-your-real-time-audiences) * [Explore how destination mapping works →](/articles/integrate-customer/destinations#define-the-mapping) * [Explore output identifier choices →](/articles/segment-customer/choose-the-output-identifiers) # Reddit Offline CAPI Source: https://docs.zeotap.com/articles/integrate-customer/reddit-offline-capi Send offline conversion events from Zeotap CDP to your Reddit Ads account through Reddit's Conversions API. ## What this is The **Reddit CAPI** destination, configured with the **Send Offline Conversions to Reddit** action, sends offline conversion events **out of Zeotap CDP to your Reddit Ads account**, through Reddit's Conversions API. It is a batch destination: you create it once, then link an audience to it. Reddit is a social media platform that offers a range of advertising solutions to help marketers reach their target audience through Reddit Ads Manager. This allows advertisers to show ads to users across multiple use cases based on their interests and activity on the platform. Zeotap CDP has two Reddit destinations. This page covers the offline-conversions use of the Reddit CAPI destination; pick the page that matches what you want to send: * [Reddit](/articles/integrate-customer/reddit) — batch audience activation. Zeotap CDP writes segment files to your own S3 bucket, and you upload them to Reddit as a custom audience. * [Reddit CAPI](/articles/integrate-customer/reddit-capi) — the same destination used for **real-time** conversions, attached to a **Send to Destinations** node inside a journey rather than to an audience. ## Supported identifiers and actions This integration supports **SHA 256 Email** and **SHA 256 Phone Numbers.** The action you choose on the mapping screen is **Send Offline Conversions to Reddit**. ## Prerequisites Complete the following in Reddit before you configure the destination in Zeotap CDP. **Step 1** **A Reddit Ads account.** **Step 2** **Your Pixel ID.** In Reddit Ads Manager, open **Events Manager**, then **Pixel configuration**. The Pixel ID is shown at the top of that page. ![Reddit Ads Manager with Events Manager highlighted in the left Campaigns navigation.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-113.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=f4b5300cbf925273375b94ff3fac0bc6) ![The Pixel configuration page in Reddit Events Manager, with an arrow pointing at where the Pixel ID is displayed beside its label.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/image-114.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=94fc085a2eb6956abcec70ff0d407352) **Step 3** **A conversions access token.** In **Events Manager**, open **Conversions API** and click **+ Generate Access Token**. Reddit allows only business administrators to generate a token; any ad account in the business can then use it. ![The same Reddit business navigation panel, used here to reach Conversions API.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-115.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=7f59dd4267f875f1aff74f09c8e8630c) ![The Conversions API page in Reddit Events Manager, showing the Generate Access Token button highlighted above the list of existing tokens.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/image-116.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=49f0c953bde76f78a795f61906c9595d) ## Create the Reddit CAPI destination **Step 1** Log in to Zeotap CDP and go to **Integrate** > **Destinations**. **Step 2** Click **+ Create Destination**. **Step 3** Under **All Destinations**, search for **Reddit CAPI.** **Step 4** Click **Reddit CAPI**. A screen appears with details about the destination on the left, and on the right the fields required to establish the integration. On the **Enter Destination Details** step, enter the following: a. **Destination Name** — a name that identifies this destination. b. **Access Token** — the conversions access token you generated in Reddit. c. **Destination Instance**. d. **Pixel ID** — the unique identifier for your Reddit Pixel. e. Click **Next** to proceed to **Mapping**. ![The Enter Destination Details step for Reddit CAPI in Zeotap CDP, with the empty Destination Name, Access Token, Destination Instance and Pixel ID fields and the Back and Next buttons.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/image-117.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=767f94cee4f951ed63d5d3472a32939c) **Step 5** On the mapping screen, under **Choose your Action**, select **Send Offline Conversions to Reddit**. Then choose the corresponding identifiers under **Map the Fields**. By default, the output identifiers the platform accepts — **Email** and **Phone Number** — are displayed. ![The mapping screen with Send Offline Conversions to Reddit chosen under Choose your Action, and the Map the Fields table pairing each Catalogue field with a destination field.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/image-118.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=bb1da635723fb91fbdac5b787c1df2dd) **Step 6** Map the mandatory field **Event At** — the event timestamp, as a Unix timestamp in milliseconds. > [!NOTE] > > **Note:** > > The event timestamp must not be older than a week. **Step 7** Scroll down to **Additional Settings** and select the **Event Type** you want to send. ![The lower half of the mapping screen, showing the remaining destination fields, the Add Mapping Field link, and the Additional Settings panel with the Event Type selector.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/image-119.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=8e0da68c919c0b15286ffc727211df5b) **Step 8** Click **Create Destination**. ## Link an audience to the destination For how to link an audience or segment to the destination you created, see [Activate your batch audiences](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > **Note:** > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience or a segment could be a specific group of customers who are over 18 years of age and who have performed an `addToCart` event within the last 30 days. ## Verify the conversions reached Reddit In Reddit Ads Manager, go to **Events Manager** > **Events overview**. The raw events table lists each event with its status, total raw events, pixel events, CAPI events and source, so you can confirm that conversions are arriving through the Conversions API. ![The Events overview page in Reddit Events Manager, with an event activity chart split by source and a raw events table listing each event's status and CAPI event count.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/image-120.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=11758bbe34b9c1ad5f374b173703a436) ## Troubleshoot the destination * **Events are missing from Events overview.** Check the timestamps you mapped to **Event At**: the event timestamp must not be older than a week. * **The destination reports a rejected payload.** A destination rejects the payload when the mapping omits a field it requires. Reopen the mapping for the action and confirm that every mandatory field, **Event At** included, is mapped. * **The delivery itself failed.** For the errors that surface on an audience–destination pair and what each one means, see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail). ## Next steps * [Send real-time conversions to Reddit from a journey →](/articles/integrate-customer/reddit-capi) * [Activate a Reddit custom audience through S3 →](/articles/integrate-customer/reddit) * [Review how destinations, actions and mappings fit together →](/articles/integrate-customer/destinations) * [Choose the output identifiers for an audience →](/articles/segment-customer/choose-the-output-identifiers) # Region of Storage Source: https://docs.zeotap.com/articles/integrate-customer/region-of-storage How Zeotap CDP decides which regional bucket ingested data is stored in, with the full country-to-region mapping for the EU, US and IN regions. ## What this is Zeotap CDP resolves the storage region for ingested data from the country associated with that data, using the country-to-region mapping on this page. No country code appears in more than one table, so each code resolves to exactly one region. > [!WARNING] > > The region names are storage labels and do not follow political boundaries — **EU** here does not mean the European Union: the **EU** table maps African countries, Russia, Ukraine, Egypt, Antarctica and the sub-Antarctic territories to EU alongside the European ones; the **US** table covers the whole of the Americas and the Caribbean; and the **IN** table covers Asia, the Middle East, Oceania and the Pacific islands, including Guam and American Samoa. Read the mapping for the specific country code you send rather than inferring the region from its name. ## How the region is resolved * **From the country code.** The Country defined at the time of source mapping resolves the region the data is stored in. Set it when you initialise the Zeotap JavaScript, using three-letter country codes such as `USA`, `DEU` or `IND`. * **From the IP address, as a fallback.** When the country code is absent, the IP address of the request is used to decide the region instead. Send an explicit country code whenever you know it, so that the storage region does not depend on the network a request happens to come from. ## EU Region Mapping The EU region table lists European and African country codes, Antarctica and the sub-Antarctic territories. | **Country Code** | **Zeotap Region** | | :- | :- | | DEU | EU | | EU | EU | | FRA | EU | | GBR | EU | | ITA | EU | | IRL | EU | | AUT | EU | | BEL | EU | | CHE | EU | | DNK | EU | | FIN | EU | | LUX | EU | | NLD | EU | | NOR | EU | | POL | EU | | SWE | EU | | AND | EU | | ALB | EU | | AGO | EU | | ATA | EU | | ALA | EU | | BIH | EU | | BFA | EU | | BGR | EU | | BDI | EU | | BEN | EU | | BVT | EU | | BWA | EU | | BLR | EU | | COD | EU | | CAF | EU | | COG | EU | | CIV | EU | | CMR | EU | | CPV | EU | | CYP | EU | | CZE | EU | | DJI | EU | | DZA | EU | | EST | EU | | EGY | EU | | ESH | EU | | ERI | EU | | ETH | EU | | FRO | EU | | GAB | EU | | GGY | EU | | GHA | EU | | GIB | EU | | GMB | EU | | GIN | EU | | GNQ | EU | | GRC | EU | | SGS | EU | | GNB | EU | | HMD | EU | | HRV | EU | | HUN | EU | | IMN | EU | | ISL | EU | | JEY | EU | | KEN | EU | | COM | EU | | LIE | EU | | LBR | EU | | LSO | EU | | LTU | EU | | LVA | EU | | LBY | EU | | MAR | EU | | MCO | EU | | MDA | EU | | MNE | EU | | MDG | EU | | MKD | EU | | MLI | EU | | MRT | EU | | MLT | EU | | MUS | EU | | MWI | EU | | MOZ | EU | | NAM | EU | | NER | EU | | NGA | EU | | PRT | EU | | REU | EU | | ROU | EU | | SRB | EU | | RUS | EU | | RWA | EU | | SYC | EU | | SDN | EU | | SHN | EU | | SVN | EU | | SJM | EU | | SVK | EU | | SLE | EU | | SMR | EU | | SEN | EU | | SOM | EU | | SSD | EU | | STP | EU | | SWZ | EU | | TCD | EU | | ATF | EU | | TGO | EU | | TUN | EU | | TZA | EU | | UKR | EU | | UGA | EU | | VAT | EU | | XKX | EU | | MYT | EU | | ZAF | EU | | ZMB | EU | | ZWE | EU | ## US Region Mapping The US region covers North America, Central America, South America and the Caribbean. | **Country Code** | **Zeotap Region** | | :- | :- | | USA | US | | CAN | US | | ARG | US | | BRA | US | | CHL | US | | COL | US | | MEX | US | | PER | US | | ECU | US | | PRY | US | | URY | US | | VEN | US | | ATG | US | | AIA | US | | ABW | US | | BRB | US | | BLM | US | | BMU | US | | BOL | US | | BES | US | | BHS | US | | BLZ | US | | CRI | US | | CUB | US | | CUW | US | | DMA | US | | DOM | US | | FLK | US | | GRD | US | | GUF | US | | GRL | US | | GLP | US | | GTM | US | | GUY | US | | HND | US | | HTI | US | | JAM | US | | KNA | US | | CYM | US | | LCA | US | | MAF | US | | MTQ | US | | MSR | US | | NIC | US | | PAN | US | | SPM | US | | PRI | US | | SUR | US | | SLV | US | | SXM | US | | TCA | US | | TTO | US | | VCT | US | | VGB | US | | VIR | US | ## India Region Mapping The India region covers Asia, the Middle East, Oceania and the Pacific islands. | **Country Code** | **Zeotap Region** | | :- | :- | | IND | IN | | ARE | IN | | AFG | IN | | ARM | IN | | ASM | IN | | AUS | IN | | AZE | IN | | BGD | IN | | BHR | IN | | BRN | IN | | BTN | IN | | CCK | IN | | COK | IN | | CHN | IN | | CXR | IN | | FJI | IN | | FSM | IN | | GEO | IN | | GUM | IN | | HKG | IN | | IDN | IN | | ISR | IN | | IOT | IN | | IRQ | IN | | IRN | IN | | JOR | IN | | JPN | IN | | KGZ | IN | | KHM | IN | | KIR | IN | | PRK | IN | | KOR | IN | | KWT | IN | | KAZ | IN | | LAO | IN | | LBN | IN | | LKA | IN | | MHL | IN | | MMR | IN | | MNG | IN | | MAC | IN | | MNP | IN | | MDV | IN | | MYS | IN | | NCL | IN | | NFK | IN | | NPL | IN | | NRU | IN | | NIU | IN | | NZL | IN | | OMN | IN | | PYF | IN | | PNG | IN | | PHL | IN | | PAK | IN | | PCN | IN | | PSE | IN | | PLW | IN | | QAT | IN | | SAU | IN | | SLB | IN | | SGP | IN | | SYR | IN | | THA | IN | | TJK | IN | | TKL | IN | | TLS | IN | | TKM | IN | | TON | IN | | TUR | IN | | TUV | IN | | TWN | IN | | UMI | IN | | UZB | IN | | VNB | IN | | VUT | IN | | WLF | IN | | WSM | IN | | YEM | IN | ## FAQ > [accordion] Does the EU region mean the European Union? > > No. **EU** is the name of a Zeotap storage region, not a statement about European Union membership or about any regulatory regime. The EU table maps African countries, Russia, Ukraine, Egypt, Antarctica and the sub-Antarctic territories to the EU region alongside European countries. Look the country code up in the mapping above rather than assuming the region from its name. > [accordion] What happens if my data does not carry a country code? > > The IP address of the request is used to decide the region instead. Send an explicit country code whenever you know it, so that the storage region does not depend on the network a request happens to come from. > [accordion] Which country-code format does Zeotap expect? > > Three-letter country codes — for example `USA`, `DEU` or `IND`. Set the code when you initialise the Zeotap JavaScript; if it is missing, the IP address of the request decides the region. > [accordion] Where do I set the country code? > > In the initialisation options of the integration you use: `user_country` in the [Web JS SDK](/articles/sdks/web-js/configurations/overview) and the React Native package, `userCountry` in the Android and iOS SDKs, and the **User Country** field in the [Google Tag Manager tag](/articles/sdks/gtm/setup-guide/configuration/initialisation). ## Next steps * [Explore Server-to-Server sources →](/articles/integrate-customer/server-to-server) * [Explore the Web JS SDK configuration options →](/articles/sdks/web-js/configurations/overview) * [Explore how sources bring data into Zeotap CDP →](/articles/integrate-customer/sources) # Release Notes Android SDK Source: https://docs.zeotap.com/articles/integrate-customer/release-notes-android-sdk > [!NOTE] > > **Legend** > > **✨ Features –** New functionalities or additions. \ > **🔄 Changes –** Modifications or updates to existing features. \ > **🛠 Fixes –** Bug fixes and issue resolutions. \ > **🚀 Initial Release –** First launch of the product. Learn about the updates and changes in each release of the Android Library. **Version 2.2.11** ( 18 July 2025) ## Version 2.2.11 **🛠** Fixes * **Kotlin Support**: Fixed obfuscation issue when SDK is used in Kotlin projects. **Version 2.2.10** ( 16 July 2025) ## Version 2.2.10 **🛠** Fixes * Fixed obfuscation issue in minified SDK causing conflicts with third-party libraries. **Version 2.2.9** (16 May 2025) ## Version 2.2.9 **🔄** Changes * **Brand Consent Changes**: Append `user_ ` prefix to all brand consent keys in the payload. **Version 2.2.8** (07 March 2025) ## Version 2.2.8 **🛠** Fixes * Fixed page view caching issue occurring on multiple requests. **Version 2.2.7** (28 February 2025) ## Version 2.2.7 **✨** Features * **Brand Consent Support:** Enhanced the `setConsent` method to accept brand consent along with primary consent. * **Callback Functionality:** Introduced support for callback functions in the `setConsent` method. **Version 2.2.6** ## Version 2.2.6 **✨** Features * **Initialization Callback:** Added support for a callback function in the initialization process to verify the response of function calls. **Version 2.2.5** ## Version 2.2.5 **✨** Features * **Callback Integration:** Enabled callback functions in certain SDK methods to monitor the responses of function calls. **Version 2.2.4** ## Version 2.2.4 **🔄** Changes * **Consent Function Update:** Modified the consent function to replace user identities after user synchronization if consent was revoked. **Version 2.2.3** ## Version 2.2.3 **✨** Features * **Event Name Tracking:** Appended event names as query parameters to all GET requests to record them as part of the SPL records. [Learn more](/articles/integrate-customer/implementing-android-sdk-source#track-user-actions) **Version 2.2.0** ## Version 2.2.0 **🔄** Changes * **Property Persistence:** Updated the SDK to persist User and Page properties across sessions. **Version 2.1.1** ## Version 2.1.1 **🛠** Fixes * **Patch Update:** Addressed issues identified in version 2.1.0. **Version 2.1.0** ## Version 2.1.0 **🔄** Changes * **GDPR Consent Resolution:** Implemented updates related to consent resolution under GDPR. [Learn more](/articles/integrate-customer/implementing-android-sdk-source#gdpr-tcf-cmp) * **SDK Optimization:** Removed external libraries from the SDK and integrated native Android components. **Version 2.0.1** ## Version 2.0.1 **🔄** Changes * **Integration Guide:** Added documentation for integrating the Zeotap Android SDK using Dependency Manager. [Learn more](/articles/integrate-customer/implementing-android-sdk-source#integrate-using-dependency-manager) * **Phone Number Hashing:** Updated to e164 standards for hashing cell phone numbers. [Learn more](https://docs.zeotap.com/articles/unify-customer/hashing-guidelines/a/h2_483454040) **Version 2.0.0** ## Version 2.0.0 **🔄** Changes * **PII Support:** Included changes related to [raw PII support](/articles/integrate-customer/implementing-android-sdk-source#raw-user-identities) support and [GDPR consent](/articles/integrate-customer/implementing-android-sdk-source#gdpr-tcf-cmp). **Version 1.0.0** ## Version 1.0.0 **🚀** Initial Release * **SDK Launch:** Introduced the initial release of the Android Library. # Release Notes iOS SDK Source: https://docs.zeotap.com/articles/integrate-customer/release-notes-ios-sdk > [!NOTE] > > **Legend** > > **✨ Features –** New functionalities or additions. \ > **🔄 Changes –** Modifications or updates to existing features. \ > **🛠 Fixes –** Bug fixes and issue resolutions. \ > **🚀 Initial Release –** First launch of the product. Learn about the updates and changes in each release of the iOS Library. **Version 1.3.9** (16 May 2025) ## Version 1.3.9 **🔄** Changes * **Brand Consent Changes**: Append `user_` prefix to all brand consent keys in the payload. **Version 1.3.8** (28 February 2025) ## Version 1.3.8 **✨** Features * **Brand Consent Support**: Enhanced the `setConsent` method to accept brand consent along with primary consent. * **Callback Functionality**: Introduced support for callback functions in the `setConsent `method. **Version 1.3.7** ## Version 1.3.7 **✨** Features * **Initialization Callback**: Added support for a callback function in the initialization process to verify the response of function calls. **Version 1.3.6** ## Version 1.3.6 **✨** Features * **Callback Integration**: Enabled callback functions in certain SDK methods to monitor the responses of function calls. **Version 1.3.4** ## Version 1.3.4 **🔄** Changes * **Consent Function Update**: Modified the consent function to replace user identities after user synchronization if consent was revoked. **Version 1.3.3** ## Version 1.3.3 **🔄** Changes * **Page Property Event Name**: Updated `setPageProperty` event name to align with other SDKs. **Version 1.3.2** ## Version 1.3.2 **✨** Features * **Event Name Tracking**: Appended event names as query parameters to all `GET` requests to record them as part of the SPL records. [Learn more](/articles/integrate-customer/implement-the-ios-sdk-source#track-user-actions) **Version 1.3.0** ## Version 1.3.0 **🔄** Changes * **Property Persistence**: Updated the SDK to persist `User` and `Page` properties across sessions. **Version 1.2.0** ## Version 1.2.0 **🔄** Changes * **GDPR Consent Resolution**: Implemented updates related to consent resolution under GDPR. [Learn more](/articles/integrate-customer/implement-the-ios-sdk-source#gdpr-tcf-cmp) **Version 1.0.1** ## Version 1.0.1 **🔄** Changes * **Integration Guide**: Added documentation for integrating the Zeotap iOS SDK using Swift Package Manager and CocoaPods. [Learn more](/articles/integrate-customer/implement-the-ios-sdk-source#integrate-the-ios-sdk) * **Phone Number Hashing**: Updated to `e164` standards for hashing cell phone numbers. [Learn more](/articles/unify-customer/hashing-guidelines#cell-phone-numbers) **Version 1.0.0** ## Version 1.0.0 **🚀** Initial Release * **SDK Launch**: Introduced the initial release of the iOS Library. # Release Notes - React Native Package Source: https://docs.zeotap.com/articles/integrate-customer/release-notes-react-native-package > [!NOTE] > > **Legend** > > **✨ Features –** New functionalities or additions. \ > **🔄 Changes –** Modifications or updates to existing features. \ > **🛠 Fixes –** Bug fixes and issue resolutions. \ > **🚀 Initial Release –** First launch of the product. Learn about the updates and changes in each release of the React Native Package. **Version 1.3.7** (18 July 2025) ## Version 1.3.7 (**Android:** 2.2.11, **iOS:** 1.3.9) **🛠** Fixes * **Kotlin Support**: Fixed obfuscation issue when SDK is used in Kotlin projects. **Version 1.3.6** (16 July 2025) ## Version 1.3.6 (**Android:** 2.2.10, **iOS:** 1.3.9) **🛠** Fixes * Fixed obfuscation issue in minified SDK causing conflicts with third-party libraries in Android. **Version 1.3.5** (16 May 2025) ## Version 1.3.5 (**Android:** 2.2.9, **iOS:** 1.3.9) **🔄** Changes * **Brand Consent Changes**: Append `user_ ` prefix to all brand consent keys in the payload. **Version 1.3.4** (14 March 2025) ## Version 1.3.4 (**Android:** 2.2.8, **iOS:** 1.3.8) **🛠** Fixes * Fixed the **SetUserIdentities** function mapping issue with **setUserProperties**. **Version 1.3.3** (07 March 2025) ## Version 1.3.3 (**Android:** 2.2.8, **iOS:** 1.3.8) **🛠** Fixes * Resolved page event caching issue on multiple requests in Android. **Version 1.3.2** (06 March 2025) ## Version 1.3.2 (**Android:** 2.2.7, **iOS:** 1.3.8) **🛠** Fixes * Fixed failing unit test case in integration. **Version 1.3.1** (28 February 2025) ## Version 1.3.1 (**Android:** 2.2.7, **iOS:** 1.3.8) **🛠** Fixes * Resolved function call issue on iOS. **Version 1.3.0** (27 February 2025) ## Version 1.3.0 (**Android:** 2.2.7, **iOS:** 1.3.8) **✨** Features * Introduced support for React Native's new architecture. * Enhanced `setConsent` method to accept both primary and brand consent. **Version 1.2.1** ## Version 1.2.1 (**Android:** 2.2.6, **iOS:** 1.3.7) **✨** Features * Added callback support for SDK initialization function. **Version 1.2.0** ## Version 1.2.0 (**Android:** 2.2.5, **iOS:** 1.3.6) **✨** Features * Introduced callback support for user tracking functions. **🔄** Changes * Modified `setUserProperties` function to prevent data persistence. **Version 1.1.6** ## Version 1.1.6 (**Android:** 2.2.4, **iOS:** 1.3.5) **🔄** Changes * Updated event name for page views on iOS. **Version 1.1.5** ## Version 1.1.5 (**Android:** 2.2.3, **iOS:** 1.3.4) **🔄** Changes * Refactored SDK function arguments for consistency. **Version 1.1.4** ## Version 1.1.4 (**Android:** 2.2.3, **iOS:** 1.3.2) **🔄** Changes * Removed unnecessary dependencies. **Version 1.1.3** ## Version 1.1.3 (**Android:** 2.2.3, **iOS:** 1.3.2) **✨** Features * Added event names for consent and user synchronization calls. **Version 1.1.2** ## Version 1.1.2 (**Android:** 2.2.2, **iOS:** 1.3.1) **🔄** Changes * Standardized handling of raw cell number identities. **Version 1.1.1** ## Version 1.1.1 (**Android:** 2.2.1, **iOS:** 1.3.0) **🛠** Fixes * Addressed database closure issue on Android. **Version 1.1.0** ## Version 1.1.0 (**Android:** 2.2.0, **iOS:** 1.3.0) **✨** Features * Enabled persistence of user and page properties across event tracking. **Version 1.0.1** ## Version 1.0.1 (**Android:** 2.1.1, **iOS:** 1.2.0) **🔄** Changes * Refined function arguments to accept JSON inputs. **Version 1.0.0** ## Version 1.0.0 (**Android:** 2.1.1, **iOS:** 1.2.0) **🚀** Initial Release * Launched the initial version of the SDK. # Responsys Source: https://docs.zeotap.com/articles/integrate-customer/responsys Push Zeotap CDP audiences out to Oracle Responsys profile lists and profile extension tables for campaign targeting. ## What this is The Responsys destination sends audiences **out of Zeotap CDP** to your Oracle Responsys instance, updating the profile list or profile extension table you nominate so that your Responsys campaigns can target that cohort. Oracle Responsys is a cloud-based marketing automation platform for running personalised, data-driven campaigns across email, mobile, web and social. This page covers the batch mode, where you link an audience to the destination and Responsys is refreshed on the schedule you set. To trigger a Responsys campaign on demand from a Journeys workflow instead, see [Responsys real-time integration](/articles/integrate-customer/responsys-real-time-integration). Both modes use the same Responsys account credentials. ## Key concepts * **Profile list** — the table that stores your recipient audience database records. Members of your audience might be leads, prospects, customers, contacts, consumers or visitors, depending on your terminology. Marketers use profile lists and related objects (such as profile extension tables and filters) primarily for campaign targeting and personalisation. * **Profile extension table (PET)** — stores additional information for each unique recipient in your profile list, so a record in a PET must map to exactly one record in its parent profile list. As with data in profile lists, audience data in PETs can be used for segmentation and targeting in filters as well as programs. ## Supported identifiers and actions This integration supports customerId, phone number, emailAddress, emailMD5Hash, emailSHA256Hash and other custom attributes. The destination carries two actions: | Action | What it updates | | - | - | | **Send data to Profile List** | The profile list named on the destination. | | **Send data to Profile Extension table** | The profile extension table named on the destination. | Each action has its own mapping. Configure a mapping for every action you intend to use, then choose which action and mapping run when you [link an audience to the destination](#link-an-audience-to-the-destination). ## Prerequisites Collect the following details from your Oracle Responsys account before you create the destination in Zeotap: * **Username** — the username of your Responsys account. * **Password** — the password of your Responsys account. * **URL** — your account's endpoint. Find it by going to your Oracle Responsys login screen and looking at the address bar of your browser. For example, `https://interact2.responsys.net`. * **Profile List name** — the name of the profile list where the data sent from Zeotap is updated. * **Profile Extension table name** — the name of the profile extension table where the data sent from Zeotap is updated. * **Folder** — the folder in Responsys where the data sent from Zeotap is populated. The destination asks for the folder path (see [Create the Responsys destination](#create-the-responsys-destination)). ![An Oracle Responsys Marketing Cloud sign-in page open in a browser, with the browser address bar outlined and an arrow pointing to the account endpoint shown in it.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-123.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=82440fce93af67d56ac284d4d897d79e) ## Create the Responsys destination **Step 1** Log into the Zeotap CDP App and go to **Destinations** under **Integrate**. **Step 2** Click **+ Create Destination**. ![The Destinations screen in the Integrate module, with the + Create Destination button outlined above a table of existing destinations listing ID, destination name, created date, last updated on and created by.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-134.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=00b3e8ae2dc201837f0eccc8c973512e) **Step 3** Under **All Destinations**, search for **Responsys**. ![The All Destinations catalogue in the Integrate module, with the Search for a Destination box outlined above a grid of destination platform cards.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-135.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=ef9360851a2bdb6ca4723dc2372a53d7) **Step 4** Click **Responsys**. Details about the destination appear on the left of the screen, and the fields required to establish the integration appear on the right. Provide the following: * **Destination Name** — a name for the destination. * **Username**, **Password** and **Responsys URL** — the Responsys account details from [Prerequisites](#prerequisites). Enter the URL of your Responsys instance. * **Profile List** and **Folder** — the Responsys objects from [Prerequisites](#prerequisites). The profile extension table is named on the mapping screen, not here. Review all the values you entered, then click **Next**. ![The Enter Destination Details step of the Responsys destination, with empty Destination Name, Username, Password, Responsys URL and Profile List fields, a Responsys description panel on the left, and Back and Next buttons at the foot of the screen.](https://mintcdn.com/zeotap/XyKebVSPNvFPQ62f/articles/integrate-customer/Storage/integrate-customer/image-136.png?fit=max\&auto=format\&n=XyKebVSPNvFPQ62f\&q=85\&s=3d336352aabce078cbe033c231f37d23) **Step 5** On the **Actions and Mapping** screen that appears, choose the action you want to configure — **Send data to Profile List** or **Send data to Profile Extension table** — and map the Catalogue fields to the corresponding destination fields. Map every mandatory field: an unmapped mandatory field causes the destination to fail. For how mappings work, see [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). **Step 6** Click **Create Destination**. The created destination is listed in the **Audiences** application, where it can be linked to an audience. ## Link an audience to the destination The action inputs that Responsys needs — the match columns and the insert and update behaviour — are set when you link an audience, not when you create the destination. For the full walkthrough of linking an audience or segment to a destination, see [Activate your batch audiences](/articles/integrate-customer/link-an-audience-to-the-destination); the Responsys-specific settings are below. > [!NOTE] > > The terms Audiences and Segments are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an Audience or a segment could be a specific group of customers who are over 18 years of age and who have performed an `addToCart` event within the last 30 days. In the **Destination Settings** tab of the linked Responsys destination: **Step 1** Under **Choose your Action and Mapping**, choose the action this activation runs and the corresponding mapping. ![The Destination Settings tab of a Responsys destination in the Audiences module, showing the Choose your Action and Mapping dropdowns set to Send data to Profile List and Untitled Mapping, the Mapping section below, and the start of the Choose Refresh Frequency section.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-137.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=71685704b03b3021b2e13304d348449a) **Step 2** Under **Choose Refresh Frequency**, set the refresh schedule for the audience, or select **Do Not Refresh**. **Step 3** Under **Audience Settings**, fill in the **Action Inputs** for the action you chose. For **Send data to Profile List**: * **Match Column 1** (required) — first match column for determining whether an insert or update should occur in Responsys. * **Match Column 2** (optional) — second match column for determining whether an insert or update should occur in Responsys. * **Insert On No Match** (required) — indicates what should be done for records where a match is not found in Responsys (true = insert / false = no insert). * **Update On Match** (required) — controls how the existing record should be updated in Responsys (values: Replace All, No Update). ![The Audience Settings step of the Destination Settings tab, with Do Not Refresh selected above it and the Action Inputs for Send data to Profile List below — Match Column 1, Match Column 2, Insert On No Match and Update On Match, all unset — with the Save Destination button at the foot of the screen.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-138.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=5c7d7606a0d253c5ef076ee5fe8257b8) For **Send data to Profile Extension table**: * **Match Column** (required) — match column for determining whether an insert or update should occur in Responsys. * **Insert On No Match** (required) — indicates what should be done for records where a match is not found in Responsys (true = insert / false = no insert). * **Update On Match** (required) — controls how the existing record should be updated in Responsys (values: Replace All, No Update). ![The Audience Settings step of the Destination Settings tab showing the Action Inputs for Send data to Profile Extension table — a single Match Column, Insert On No Match and Update On Match, all unset — above the Save Destination button.](https://mintcdn.com/zeotap/sBMx_EDYCwiX_b1v/articles/integrate-customer/Storage/integrate-customer/responsys/responsys-2025-05-12-2.png?fit=max\&auto=format\&n=sBMx_EDYCwiX_b1v\&q=85\&s=f84875f46b2a816e57e8c2202191c0f1) **Step 4** Click **Save Destination**. ## Verify the activation 1. **In Zeotap** — after you click **Save Destination**, the destination moves to **In Progress** while the IDs are uploaded, and changes to **Success** once all the IDs have uploaded. 2. **In Responsys** — open the profile list or profile extension table you named on the destination and confirm the records are present. The record count in Responsys does not necessarily match the audience count in Zeotap, because **Insert On No Match** governs whether records with no matching Responsys record are inserted at all. ## Troubleshoot the destination | Symptom | What to check | | - | - | | The destination fails. | Every mandatory field for the chosen action must be mapped. Reopen the mapping for that action and confirm each mandatory field has a Catalogue field against it. | | Records reach Responsys, but new recipients are not added. | **Insert On No Match** controls this. Set to false, records with no match in Responsys are not inserted; set to true, they are. Also confirm that **Match Column 1** (or **Match Column** for a profile extension table) names the column you expect Responsys to match on. | For delivery errors that surface on the audience–destination pair after activation, see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail). ## Next steps * [Activate your batch audiences](/articles/integrate-customer/link-an-audience-to-the-destination) — the full audience activation walkthrough. * [Responsys real-time integration](/articles/integrate-customer/responsys-real-time-integration) — trigger Responsys campaigns from a Journeys workflow. * [Destinations](/articles/integrate-customer/destinations) — how destinations, actions and mappings fit together. # Responsys real-time integration Source: https://docs.zeotap.com/articles/integrate-customer/responsys-real-time-integration Send customer records from a Zeotap CDP Journeys workflow to Oracle Responsys in real time and trigger a Responsys campaign. ## What this is This integration sends customer data **out of Zeotap CDP to Oracle Responsys**: when a customer reaches a **Send to Destinations** node in a Journeys workflow, Zeotap CDP passes that customer's record to Responsys and triggers the Responsys campaign you nominated on the destination. Oracle Responsys is a cloud-based marketing automation platform for building personalised, data-driven campaigns across email, mobile, web, and social. Pairing it with Journeys means a Responsys campaign fires off the back of the conditions and filters in your workflow, rather than off a linked audience. Zeotap CDP also has a batch Responsys destination, which links an audience in the **Audiences** application to a Responsys profile list or profile extension table. If that is what you need, see [Responsys](/articles/integrate-customer/responsys) instead. ## Supported identifiers and actions This integration supports customerId, emailAddress, emailMD5Hash, and emailSHA256Hash. You choose one of two actions per destination: | Action | What it does | | :- | :- | | **Trigger emails to existing recipients** | Triggers on-demand campaign message delivery to specific recipients. In Responsys this covers email, SMS, and push campaigns. | | **Trigger emails to existing and new recipients** | Merges the incoming data into your Responsys profile list and then immediately triggers the campaign to the merged recipients. | ## Prerequisites Before you create the Responsys destination, have the following Responsys details to hand: * **Username** — the username of your Responsys account. * **Password** — the password of your Responsys account. * **Responsys URL** — your account's endpoint. You can find it by going to your Oracle Responsys login screen and looking at the URL in your browser — for example, `https://interact2.responsys.net`. You enter this value in the **Responsys URL** field when you create the destination. ![The Oracle Responsys Marketing Cloud sign-in page, with the browser address bar highlighted to show where the account endpoint appears in the URL.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-124.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=b57cb067075a9f87529e15ff66e6c9c7) * **Profile List** — the name of the profile list where the data sent from Zeotap CDP is updated. * **Folder name** — the name of the folder within Responsys where the data sent from Zeotap CDP is populated. * **Campaign Name** — the campaign in Responsys that the Journeys workflow triggers. ## Create the Responsys destination You create this destination from inside a workflow. After you have obtained the required details from Responsys, [create a workflow in Journeys](/articles/orchestrate-customer/create-a-workflow) and add the filters and conditions you want for your users. Then, at the node where the Responsys campaign should fire, click **+** and choose **Send to Destinations**. A panel opens where you can either pick an existing destination or create a new one with **+ Add New Destination**. ![The Choose an action menu on a workflow node, with Send to Destinations highlighted and a tooltip reading: Forward customer data to channels that let you send emails, show ads, run analytics etc.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-126.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=e1347fa86bf26273ab50d6082a6b254e) **Step 1** Click **+ Add New Destination**. **Step 2** Search for **Responsys**. **Step 3** Click **Responsys** and enter a name for the destination. **Step 4** In the **Username** field, enter the username of your Responsys account. **Step 5** In the **Password** field, enter the password of your Responsys account. **Step 6** In the **Responsys URL** field, enter the URL of your Responsys instance. **Step 7** In the **Profile List** field, enter the name of the profile list in Responsys where the data sent from Zeotap CDP needs to be updated. **Step 8** In the **Folder** field, enter the folder path in your Responsys instance where the data sent from Zeotap CDP can be stored. **Step 9** Review the values you entered and click **Next**. ![The Enter Destination Details step of the Responsys destination form, showing the Destination Name, Username, Password, Responsys URL and Profile List fields, with Back and Next at the foot of the screen.](https://mintcdn.com/zeotap/0tBKU68VEaZ-cZhs/articles/integrate-customer/Storage/integrate-customer/image-125.png?fit=max\&auto=format\&n=0tBKU68VEaZ-cZhs\&q=85\&s=b5090f772d02c369bbbcecec7dfdf236) **Step 10** On the **Actions and Mapping** screen, choose the action you need — **Trigger emails to existing recipients** or **Trigger emails to existing and new recipients**. **Step 11** For the action you chose, map the Catalogue fields to the corresponding destination fields. Map every mandatory field: if a mandatory field is left unmapped, the destination fails. **Step 12** Click **Create Destination**. The destination is then listed in the Journeys application, ready to be linked to a workflow. ## Link the destination to a workflow Once the destination exists, link it in the **Send to Destinations** node of your workflow. **Step 1** In the workflow, at the node level, click **+** and choose **Send to Destinations**. ![The same Choose an action menu on a workflow node, with Send to Destinations highlighted.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-127.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=86a9c3f1c10c0a5227b01b4c619a5303) **Step 2** Use the search box to find the destination you created, then select it. ![The Send to Destinations panel, with the search box highlighted, the + Add New Destination link above it, and a grid of cards for destinations that already exist.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/image-128.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=fda0d2fa313a4165a733368e9d558de4) **Step 3** On the **Destination Details** tab, the fields you entered when you created the destination are already filled in. Enter the remaining details: * **Campaign Name** — the campaign in Responsys to be triggered from the Journeys workflow. * **Match Column 1** — the first match column for determining whether an insert or an update should occur in Responsys. * **Match Column 2** — the second match column for determining whether an insert or an update should occur in Responsys (optional). * **Insert On No Match** — what should be done for records where a match is not found in Responsys (`True` = insert, `False` = no insert). * **Update On Match** — how an existing record should be updated in Responsys (Replace All, No Update). ![The Destination Details tab of the Responsys destination, showing the Responsys URL, Campaign Name, Match Column 1, Match Column 2, Insert On No Match, and Update On Match fields, with Cancel and Save Destination at the foot of the panel.](https://mintcdn.com/zeotap/sBMx_EDYCwiX_b1v/articles/integrate-customer/Storage/integrate-customer/responsys-real-time-integration/Screenshot_2025-05-12_at_7-35-56_PM.png?fit=max\&auto=format\&n=sBMx_EDYCwiX_b1v\&q=85\&s=9c94e836bc7750493bb2990f1bf99c5a) **Step 4** On the **Destination Settings** tab, choose the action and the mapping you need. ![The Destination Settings tab, showing the Choose your Action and Mapping dropdowns above a Mapping panel that lists the Record Data fields to be sent, with an Edit Mapping link.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-129.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=324a897b74551a59b7ce04be16b20339) **Step 5** Click **Save Destination**. The destination is attached to the node. ![The Send to Destinations panel with a Responsys destination card attached at the top, showing its mapping name and selected action, and Add Destinations at the foot of the panel.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-130.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=6f6939ac9c3740fed7f331045f4a1e36) **Step 6** Click **Add Destinations**. You can add more than one destination at this step if you need to. ![The Send to Destinations panel with a destination attached at the top and the Add Destinations button highlighted.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-131.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=cc07ab6f8322415a5677a04c25e7301d) **Step 7** The linked destinations appear in the **Send to Destinations** node within the workflow. You can carry on building and customising the workflow by clicking **+**. Enter a name for the workflow in the text box provided, otherwise it cannot be saved. **Step 8** After adding your conditions and filters, choose one of the following: * **Save Draft** — lets you revisit and edit the workflow before publishing. * **Next: Define Re-entry Criteria** — determines whether a user can re-enter the same workflow. ![The journey canvas with the workflow name box at the top, a Send to Destination node on the canvas, and Cancel, Save Draft and Next: Define Re-entry Criteria at the foot of the screen.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-132.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=efef0c1d4fcab447061a67b3c6fe9bc1) **Step 9** From the same screen, click **Next: Define Re-entry Criteria**. ![The journey canvas, with Cancel, Save Draft and Next: Define Re-entry Criteria at the foot of the screen.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-133.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=89a59ec4a48f95e18c354c895fb1e3d1) After defining the re-entry criteria, click **Publish Workflow**. The workflow appears in the workflow listing screen with a **Published** status. ## Verify the delivery Once the workflow is published, check both sides: * **In Journeys** — [metrics](/articles/orchestrate-customer/understand-metrics) are available for every published workflow, so you can see how many users reached each node, including the **Send to Destinations** node. The listing screen also has an **ACTIVATED USERS** column for the total sent out by the workflow. * **Per user** — use [Journey Traces](/articles/orchestrate-customer/journey-traces) to search for one user and inspect the event that was sent to the destination node. * **In Responsys** — confirm the campaign you named in **Campaign Name** was triggered for the recipients you expected. If you chose **Trigger emails to existing and new recipients** and set **Insert On No Match** to `True`, records with no match are inserted into your profile list, so you can check that list for the new records too. ## Troubleshoot the integration > [accordion] The destination fails as soon as the workflow runs > > A mandatory field that is not mapped makes the destination fail. Open the destination on the **Destination Settings** tab and use **Edit Mapping** to check that every mandatory field for the action you chose is mapped. > [accordion] A destination node reports failures on the canvas > > Failures surface at node level on the journey canvas with a failure status code. See [Journey error codes](/articles/orchestrate-customer/journey-error-codes) for what each code means and the first action to take, and [Troubleshooting workflows](/articles/orchestrate-customer/journey-troubleshooting) for how to tell a global failure from an isolated one. Credential failures are among the most common, so re-check the **Username**, **Password**, and **URL** on the destination before looking further. > [accordion] Customers who were not already in Responsys receive nothing > > **Trigger emails to existing recipients** only triggers the campaign for recipients already held in your profile list. To add customers who are not yet in the list and then message them, use **Trigger emails to existing and new recipients** and set **Insert On No Match** to `True`. > [accordion] Records reach Responsys but existing profiles are not updated as expected > > **Match Column 1** and **Match Column 2** determine whether an incoming record is treated as an insert or an update, and **Update On Match** controls what happens to a record that does match — Replace All or No Update. Check all three on the **Destination Details** tab. ## Next steps * [Responsys](/articles/integrate-customer/responsys) — the batch destination, for linking an audience to a Responsys profile list or profile extension table. * [Create a workflow](/articles/orchestrate-customer/create-a-workflow) — build the workflow this destination is attached to. * [Add re-entry criteria](/articles/orchestrate-customer/add-re-entry-criteria) — control when a user can enter the same workflow again. * [Journey Traces](/articles/orchestrate-customer/journey-traces) — inspect what was sent for an individual user. # Rokt Source: https://docs.zeotap.com/articles/integrate-customer/rokt Send audience segments out of Zeotap CDP to Rokt as custom audiences, using raw or SHA-256 hashed email addresses. ## What this is Rokt is a **batch destination**: data flows out of Zeotap CDP to Rokt, where each linked Zeotap audience arrives as a Rokt custom audience. Nothing flows back from Rokt into Zeotap CDP. Rokt provides tools to boost revenue, scale customer acquisition, and build stronger customer relationships. Integrated with Zeotap CDP, Rokt enables you to send audience segment data for precise and effective customer targeting. Because this is a batch destination, you activate it by linking it to an **audience**, not by adding it to a journey. Zeotap CDP ships no other Rokt connector — there is no Rokt source and no real-time Rokt destination. For every Zeotap integration and the lane it belongs to, see the [Integrations master list](/articles/integrations-master-list-publication/integrations-master-list). ## Supported identifiers and actions This integration supports email addresses (both raw and hashed). The following table lists the available action types for the integration and the supported features for each action type: | Action Name | [ID EXTENSION](/articles/segment-customer/extend-your-audience#id-extension) | [DELETE](/articles/segment-customer/delta-upload-and-delete-functions) | [DELTA UPLOAD](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send Raw Emails to Rokt Audiences | - | ✅ | - | | Send SHA-256 Hashed Emails to Rokt Audiences | - | ✅ | - | ## Prerequisites Obtain the following details from Rokt before you create the destination: **Account ID** — the account ID associated with your Rokt account. You can find it on Rokt OnePlatform. **ROKT Public Key and ROKT Secret Key** — these keys authenticate the endpoint for sending data from Zeotap to Rokt. Reach out to your Rokt account manager to create a public and secret key pair for the account where you plan to send data from Zeotap CDP. ## Create the Rokt destination **Step 1** Log into the Zeotap CDP App and open the **Destinations** application under **Integrate**. **Step 2** Click **+ Create Destination.** ![The Destinations list in Zeotap CDP, with the + Create Destination button highlighted above the table of existing destinations.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/rokt/rokt-2024-11-07-3.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=63615bc97edf619416268a8465aadf2b) **Step 3** Under the **All Destinations** section, search for **Rokt**. ![The All Destinations catalogue of destination tiles, with the search box highlighted.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/rokt/rokt-2024-11-07-2.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=6293c1d5401dca05994eaeca3695a9ad) **Step 4** Click **Rokt**. The **Enter Destination Details** screen appears, with details about the destination on the left and the fields required for the integration on the right. Enter the required details: a. Under **Destination Name**, enter a descriptive name for the destination.\ \ b. Under **Account ID**, enter the account ID associated with your Rokt account.\ \ c. Under **ROKT Public Key** and **ROKT Secret Key**, enter the key pair obtained from your Rokt account manager. ![The Enter Destination Details step of the Rokt destination form, showing the Destination Name, Account ID, ROKT Public Key and ROKT Secret Key fields, with Back and Next at the foot of the screen.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/rokt/rokt-2024-11-07.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=0133d60c8f23e8601fce7f35ef4505d4) **Step 5** Review all the values entered above and then click **Next** to proceed. **Step 6** On the **Mapping** screen, under **Choose your Action**, select either **Send Raw Emails to Rokt Audiences** or **Send SHA-256 Hashed Emails to Rokt Audiences**, depending on whether you want to send raw or hashed email addresses to Rokt. Then, under **Map the Fields**, map the corresponding Catalogue field to the Rokt destination field. ![The Mapping step with the raw-email action selected under Choose your Action, and a raw email Catalogue field mapped to the Rokt destination field under Map the Fields.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/rokt/rokt-2024-11-07-1.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=f6145f790c874733c2dac09ef5cfb15c) **Step 7** Click **Create Destination**. The created Destination gets listed in the **Audiences** application, which can be linked to an Audience/segment. ## Link an audience to the destination For information about how to link an Audience to the created Destination in the **Audiences** application, refer [here](/articles/integrate-customer/link-an-audience-to-the-destination). ## Verify the audience reached Rokt To view the audiences sent from Zeotap CDP to Rokt, perform the following steps: **Step 1** Log into the Rokt platform. **Step 2** In the left navigation panel, click **Campaigns** > **Custom Audiences**. Your audiences are listed with the type **Email list**. Note that the custom audience name displayed on Rokt is exactly the same as the audience name provided while creating it in Zeotap CDP. ![The Custom Audiences screen in Rokt, reached from Campaigns in the left navigation, listing audiences with their status, type Email list and last updated date.](https://mintcdn.com/zeotap/sBMx_EDYCwiX_b1v/articles/integrate-customer/Storage/integrate-customer/rokt/rokt-2024-11-08-2.png?fit=max\&auto=format\&n=sBMx_EDYCwiX_b1v\&q=85\&s=157286716e141d12990ead9b11f2ea95) > [!NOTE] > > **Note:** > > It can take up to four hours for custom audiences pushed from Zeotap CDP to propagate through > Rokt's system and be visible on the front end. ## Next steps * [Activate your batch audiences](/articles/integrate-customer/link-an-audience-to-the-destination) — link this destination to an audience. * [Delta upload and delete functions](/articles/segment-customer/delta-upload-and-delete-functions) — how refreshes after the first full upload behave. * [Destinations](/articles/integrate-customer/destinations) — how destinations are configured and mapped across the catalogue. # RTB House Source: https://docs.zeotap.com/articles/integrate-customer/rtb-house Send audiences from Zeotap CDP to your RTB House S3 bucket for retargeting and real-time bidding campaigns. ## What this is RTB House is a demand-side platform (DSP) that specialises in retargeting and real-time bidding (RTB). This destination connects Zeotap CDP to RTB House by writing audience files to an S3 bucket that RTB House provides. Once you link an audience to the destination, Zeotap CDP delivers RTB House Cookies as identifiers so RTB House can activate the audience in your campaigns. If instead you need to send real-time events from Journeys to RTB House's server-to-server API, use [RTB House Conversions API (CAPI)](/articles/integrate-customer/rtb-house-capi). ## Prerequisites > [!NOTE] > > Before you create this destination, confirm the following: > > * Cookie syncing between Zeotap CDP and RTB House is enabled. > * You have the **Tagging Hash ID** for your RTB House account — obtain it from your RTB House point of contact. > * You have the **Client Name** for your RTB House account — find it in the RTB House console. ## Supported identifiers This integration supports RTB House Cookies. ## Available actions and supported features The following table lists the available action types for the integration and the supported features for each action type: | Action name | [ID EXTENSION](/articles/segment-customer/extend-your-audience#id-extension) | [DELETE](/articles/integrate-customer/delta-upload-and-delete-functions) | [DELTA UPLOAD](/articles/integrate-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send Identifiers to RTB House | ✅ | ✅ | - | ## Gather your RTB House account details Collect the following two values before you open the destination form in Zeotap CDP. ### Tagging Hash ID The Tagging Hash associated with your RTB House account. Contact your RTB House point of contact to obtain this value. ### Client Name The Client Name for your RTB House account. Locate it in the RTB House console. A quick reference of what you will enter into the destination form: ```yaml theme={null} destination_name: tagging_hash_id: client_name: ``` ## Create the RTB House destination **Step 1** Log into the Zeotap CDP App and open the **DESTINATIONS** application. **Step 2** Click **+ Create Destination**. ![Destinations application with the + Create Destination button](https://mintcdn.com/zeotap/sBMx_EDYCwiX_b1v/articles/integrate-customer/Storage/integrate-customer/rtb-house/RTB_H1.png?fit=max\&auto=format\&n=sBMx_EDYCwiX_b1v\&q=85\&s=989bf48b86088d10e9d6c3b3b8bc0448) **Step 3** Under the **All Destinations** section, search for **RTB House**. ![Searching for RTB House under the All Destinations section](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/rtb-house/RTB_H2.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=4c1d1c71f84cc22f0a9975e76200c682) **Step 4** Click **RTB House**. A screen appears with the destination description on the left and the required integration fields on the right. Enter the following details: a. A name for the destination. b. The **Tagging Hash ID** associated with your RTB House account. c. The **Client Name** of your RTB House account. d. Review all values, then click **Next** to proceed. ![RTB House destination form with Tagging Hash ID and Client Name fields](https://mintcdn.com/zeotap/sBMx_EDYCwiX_b1v/articles/integrate-customer/Storage/integrate-customer/rtb-house/RTB_H3.png?fit=max\&auto=format\&n=sBMx_EDYCwiX_b1v\&q=85\&s=835bcc63cec0dd216e25e62aa3ae9129) **Step 5** Choose the appropriate action and mapping: a. Under **Choose your Action**, select the desired [action](/articles/integrate-customer/destinations#actions). Under **Map the Fields**, select the corresponding identifiers. By default, the [Output Identifiers](/articles/segment-customer/choose-the-output-identifiers) accepted by the platform — such as MAIDs, Cookies, and email IDs — are displayed. You can edit, add, or remove an identifier from this list; see [Mappings](/articles/integrate-customer/destinations#mappings) for details. b. Click **Create Destination**. The new destination is listed in the **Audiences** application, ready to be linked to an audience or segment. ![Choose your Action and Map the Fields screen for the RTB House destination](https://mintcdn.com/zeotap/sBMx_EDYCwiX_b1v/articles/integrate-customer/Storage/integrate-customer/rtb-house/RTB_H4.png?fit=max\&auto=format\&n=sBMx_EDYCwiX_b1v\&q=85\&s=dad5dc727b8c12bf59dc7ef7408dd002) ## Link an audience to the destination For instructions on linking an audience or segment to your RTB House destination in the **Audiences** application, see [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience or segment could be a specific group of customers over 18 years of age who have performed an `addToCart` event within the last 30 days. ## Verify the delivery You know the destination is working when: 1. The RTB House destination appears in the **DESTINATIONS** application list after creation. 2. Linking an audience to the destination in the **Audiences** application completes without an error. 3. RTB House receives the delivered files in the configured S3 bucket and begins matching RTB House Cookies in campaigns. ## Troubleshooting If the destination does not behave as expected, check the following conditions. | Symptom | What it means | Where to look | | :- | :- | :- | | The destination form does not submit | The **Tagging Hash ID** or **Client Name** field was left blank | The RTB House destination creation form | | Audience links complete but RTB House receives no cookies | Cookie syncing between Zeotap CDP and RTB House is not enabled | Confirm the cookie-sync status with your RTB House point of contact | | RTB House reports zero matches for a delivered audience | The **Client Name** entered in Zeotap CDP does not match the account in the RTB House console | RTB House console → account settings; then update the destination's **Client Name** in Zeotap CDP | | The Tagging Hash ID is rejected during setup | The Tagging Hash was copied incorrectly or belongs to a different RTB House account | Re-request the Tagging Hash from your RTB House point of contact | ## FAQ > [accordion] What is the difference between the RTB House destination and RTB House Conversions API (CAPI)? > > The RTB House destination described on this page writes audience files to an S3 bucket that RTB House provides, delivering RTB House Cookies as identifiers for retargeting and RTB campaigns. [RTB House Conversions API (CAPI)](/articles/integrate-customer/rtb-house-capi) sends real-time events from Zeotap's Journeys module to RTB House's server-to-server endpoint. Choose the destination that matches whether you need audience delivery or real-time event streaming. > [accordion] Which identifiers can I send to RTB House? > > This integration supports RTB House Cookies. In the **Map the Fields** step, additional Output Identifiers accepted by the platform — such as MAIDs, Cookies, and email IDs — are displayed by default, and you can edit the mapping to match what RTB House expects. > [accordion] Where do I find the Tagging Hash ID and Client Name? > > The **Tagging Hash ID** comes from your RTB House point of contact. The **Client Name** is available in the RTB House console under your account details. > [accordion] Do I need to enable cookie syncing before creating the destination? > > Yes. Cookie syncing between Zeotap CDP and RTB House is listed as a prerequisite for this integration. Without it, Zeotap CDP cannot deliver RTB House Cookies for RTB House to match. ## Next steps * Explore [RTB House Conversions API (CAPI)](/articles/integrate-customer/rtb-house-capi) → for sending real-time events from Journeys to RTB House's server-to-server endpoint. * Explore [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination) → to activate your first audience on the RTB House destination. * Explore [Destinations overview](/articles/integrate-customer/destinations) → for actions, mappings, and shared destination concepts. * Explore [Extend your audience with ID Extension](/articles/segment-customer/extend-your-audience#id-extension) → to grow reach before delivering to RTB House. # RTB House Conversions API (CAPI) Source: https://docs.zeotap.com/articles/integrate-customer/rtb-house-capi Stream on-site and conversion events from a Zeotap CDP journey to the RTB House Conversions API for retargeting. ## What this is RTB House Conversions API (CAPI) is a real-time destination: it sends on-site and conversion events **out of Zeotap CDP to RTB House**, one event per customer as they pass a **Send to Destinations** node in a journey. RTB House is a DSP platform that specialises in personalised retargeting, so the events you stream describe what a customer did on your site — viewed a category, viewed a product, changed their cart, completed an order — and RTB House targets against that behaviour. Every event is keyed on the customer's RTB House Cookie, so cookie syncing between Zeotap CDP and RTB House has to be in place before anything will match. This page covers the real-time, journey-driven integration. To send a whole audience to RTB House instead, see [RTB House](/articles/integrate-customer/rtb-house), the batch destination that attaches to an audience rather than a journey and delivers RTB House Cookies to the S3 bucket RTB House provides. ## Supported identifiers and actions Select **Stream events to RTB house** under **Choose your Action** when you create the destination. | Catalogue field | Destination field | Type | | :- | :- | :- | | [RTB House Cookie](/articles/unify-customer/zeotap-standard-fields) | RTB House Cookie ID | String | | Event Timestamp | Event Timestamp | String | | *No pre-mapped field* | Category Id | String | | *No pre-mapped field* | Offer Product ID | String | | *No pre-mapped field* | Listing Product IDs | List | | *No pre-mapped field* | Add to Cart Product ID | String | | *No pre-mapped field* | Cart Added Product IDs | List | | *No pre-mapped field* | Order ID | String | | *No pre-mapped field* | Conversion Product IDs | List | | *No pre-mapped field* | Order Conversion Value | Integer | The mapping screen marks **RTB House Cookie ID** and **Event Timestamp** as required. Both sit under **Global Attributes**. The remaining fields are grouped by event — **Category Page Event Attributes**, **Offer Product Page Event Attributes** and so on — so map only the attributes that belong to the event you are sending on that node. ## Prerequisites Address all of the following before you start the integration. * **PKey.** An advertiser's public key is a unique string RTB House uses for authentication and authorisation. Obtain it from your RTB House representative. * **API Tagging Hash.** This is the static client tagging hash identifier associated with your RTB House account. Obtain it from your RTB House representative. * **Cookie syncing is enabled between Zeotap CDP and RTB House.** The integration keys every event on the RTB House Cookie, so without the sync there is no identifier to send. See [Cookie Syncing](/articles/integrate-customer/understanding-cookies#cookie-syncing). * **RTB House has enabled server-to-server (S2S) requests on your account.** Notify RTB House of your intent to send S2S requests so they can enable the configuration on their end. * **Custom event names are shared with RTB House in advance.** If you plan to send custom events, give RTB House the event name (key) first so they can configure it. ## RTB House event names and parameters RTB House identifies each piece of on-site behaviour by an event name of its own. The **Event Type** list on the destination uses the same vocabulary. ### Event names | Event name | When to send it | | :- | :- | | `home` | A visit to the home page of your website. | | `category2_{{categoryID}}` | A visit to a category page. Replace `{{categoryID}}` with the ID of that category. | | `offer_{{ID}}` | A visit to a product page. Replace `{{ID}}` with the product's unique ID from your product feed. | | `listing_{{ID}},{{ID}},{{ID}},{{ID}},{{ID}}` | A visit to a search results page. Replace each `{{ID}}` with the ID of a product displayed on the page. The list can include up to 5 IDs; any IDs beyond this limit are ignored. | | `basketadd_{{ID}}` | A product added to the cart. Replace `{{ID}}` with the ID of the product just added, regardless of quantity. **Example:** if the product with ID 12 is added to the cart, use `basketadd_12`. | | `basketstatus_{{ID}},{{ID}},{{ID}},{{ID}},{{ID}}` | A shopping cart page being displayed. Replace each `{{ID}}` with the ID of a product currently in the cart, regardless of quantity. **Example:** for a cart containing products with IDs 12, 14, 8 and 7, use `basketstatus_12,14,8,7`. | | `startorder` | A visit to the page that begins order processing, such as the checkout page reached after filling the cart. This is usually the contact details form, or whatever page follows a "Go to checkout" button. | | `conversion_order_purchase_{{VALUE}}{{ORDER-ID}}{{ID}},{{ID}},{{ID}}&cd={DEDUPLICATION}` | The order confirmation page. Trigger this for every order placed on your website, whatever the traffic source — confirming the tag is what makes customer segmentation work, which in turn optimises later advertising space purchases. • Replace `{{VALUE}}` with the order value, formatted with a decimal point (dot or comma) and no thousands separators. • Replace `{{ORDER-ID}}` with your own shop order identifier. • Replace each `{{ID}}` with the ID of a product in the cart. • Replace `{{DEDUPLICATION}}` with either `false` or `true`. Set it to `true` in all cases. • Do not encode the `&`, so that `cd=...` is treated as an additional parameter on the main request. | | `custom_{{Event_Name}}_{{Value}}` | A custom event. Replace `{{Event_Name}}` with the name of the event and `{{Value}}` with a boolean or any ID relevant to it. **Examples:** `custom_cartabandoned_true` adds a user to the pool of users with abandoned carts — `cartabandoned` is the event and `true` is the value. `custom_loyaltitypoints_100` indicates 100 loyalty points. \[!NOTE] **Note:** Share the event name (key) with RTB House in advance so they can configure it. | ### Sending events directly to RTB House RTB House also accepts server-to-server postbacks sent straight to its own endpoint. This is RTB House's API, not Zeotap's: the request goes from your server to RTB House and does not pass through Zeotap CDP. Send it as an HTTPS POST, for example with curl: ```bash theme={null} curl -v -X POST 'https://omni.creativecdn.com/partner/omni/postbacks?pkey={{PKEY}}&uid={{UID}}&time={{MSEC}}&tag=pr_{{TAGGING_HASH}}_{{EVENT}}' ``` Replace the macros as follows: | Name | Description | | :- | :- | | `{{PKEY}}` | The PKey RTB House issued for your account. | | `{{TAGGING_HASH}}` | The tagging hash RTB House issued for your account. | | `{{UID}}` | The user ID, the same one passed via the web tag. This is the RTB House cookie. | | `{{MSEC}}` | The event time in milliseconds since the UNIX epoch (1 January 1970 00:00:00 UTC). | | `{{EVENT}}` | The event name for the information you are sending — see [Event names](#event-names). | ## Create the RTB House CAPI destination The destination is created under **Integrate > Destinations**, or inline from a journey's **Send to Destinations** panel. Either route opens the same two-step form. For the general model behind destinations, actions and mappings, see [Configure a destination](/articles/integrate-customer/destinations#configure-a-destination). **Step 1** Once you have applied filters or added conditions for your users in Journeys, open **Send to Destinations**. The panel lists the destinations already available to you — pick one of those, or click **+ Add New Destination** to create one. ![The Send to Destinations panel showing the + Add New Destination link, a search box and a grid of existing destination cards](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/rtb-house-capi/rtb-house-capi-2024-09-03.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=b8650c4f80afb43d67285d175958ad24) The Send to Destinations panel, with the + Add New Destination link above the search box and a grid of existing destination cards **Step 2** Search for **RTB House** and select **RTB House CAPI**. **Step 3** On the **Enter Destination Details** step, complete the three fields and click **Next**: * **Destination Name** — a name that makes the destination easy to identify later. * **PKey** — the PKey obtained from your RTB House representative. * **API Tagging Hash** — the tagging hash associated with your RTB House account. The PKey and the tagging hash are what authorise you on the RTB House platform. ![Enter Destination Details form for RTB House CAPI, showing the Destination Name, PKey and API Tagging Hash fields with Back and Next buttons](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/rtb-house-capi/rtb-house-capi-2024-09-03-1.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=55c8a9d9eb71f622b7d8e5a38487c20d) The Enter Destination Details step of the RTB House CAPI destination, with the Destination Name, PKey and API Tagging Hash fields **Step 4** On the **Mapping** step, select **Stream events to RTB house** under **Choose your Action**. Then, under **Map the Fields**, pair each Catalogue field with the RTB House destination field it feeds. Map only the attributes that correspond to the event you intend to send on this destination — see [Supported identifiers and actions](#supported-identifiers-and-actions) and [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). ![Mapping step showing the Choose your Action drop-down set to Stream events to RTB house, and the Map the Fields table pairing Catalogue fields with RTB House destination fields grouped under Global Attributes, Category Page Event Attributes and Offer Product Page Event Attributes](https://mintcdn.com/zeotap/sBMx_EDYCwiX_b1v/articles/integrate-customer/Storage/integrate-customer/rtb-house-capi/rtb-house-capi-2024-09-03-2.png?fit=max\&auto=format\&n=sBMx_EDYCwiX_b1v\&q=85\&s=e060617153a76587e8f7a043dac7e943) The Mapping step, with Stream events to RTB house chosen as the action and the Map the Fields table grouped by event **Step 5** Click **Create Destination**. The destination is created and made available for activation on Journeys. ## Add the destination to a journey A real-time destination does not attach to an audience. Once it exists, you link it in a **Send to Destinations** node inside the journey workflow. **Step 1** On the journey canvas, click **+** where you want the node, then choose **Send to Destinations** from the **Choose an action** menu. ![Choose an action menu on the journey canvas listing Add a Condition, Add a Delay, Create a Multi-branch Split, Create a True/False Split and Send to Destinations, with Send to Destinations highlighted](https://mintcdn.com/zeotap/sBMx_EDYCwiX_b1v/articles/integrate-customer/Storage/integrate-customer/rtb-house-capi/rtb-house-capi-2024-09-03-4.png?fit=max\&auto=format\&n=sBMx_EDYCwiX_b1v\&q=85\&s=b0e2128b519f7460d75175b2316a4519) The Choose an action menu on the journey canvas with Send to Destinations selected **Step 2** Find your RTB House CAPI destination in the list of available destinations, using the search box if the list is long. ![Send to Destinations picker with the search box highlighted above a grid of available destination cards](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/rtb-house-capi/rtb-house-capi-2024-09-03-5.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=1bd0f3fe78c5585b223cc6ec0fe05bf2) The destination picker with the search box highlighted above the grid of available destinations **Step 3** On the **Destination Details** tab, the **Destination Name**, **PKey** and **API Tagging Hash** are already filled in from the destination you created. Choose the **Event Type** for this node from the drop-down; the options include **Home**, **Category**, **Offer**, **Listing**, **Basket Add** and **Basket Status**, and the list continues below these. ![Destination Details tab for the RTB House CAPI node, showing the pre-filled Destination Name, PKey and API Tagging Hash fields and the open Event Type list with Home, Category, Offer, Listing, Basket Add and Basket Status](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/rtb-house-capi/rtb-house-capi-2024-09-03-3.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=b46219d69a8a17f7711fada96335f256) The Destination Details tab of the RTB House CAPI node, with the Event Type list open **Step 4** On the **Destination Settings** tab, choose the action and mapping you need. **Step 5** Click **Save Destination**. The node shows the attached destination card with its action and mapping. ![An attached RTB House CAPI destination card labelled with its mapping and the Stream events to RTB house action, above the destination picker grid and the Add Destinations button](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/rtb-house-capi/rtb-house-capi-2024-09-03-6.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=493cfa39aac57b8df268460964d3c299) The attached RTB House CAPI destination card showing its Stream events to RTB house mapping, above the destination picker ## Verify the delivery Once the journey is live, confirm the events are leaving Zeotap and landing at RTB House: 1. **On the journey canvas** — open the execution details for the **Send to Destinations** node. A node that has run reports the total events entered, the successful events and the failed events. See [Identify Journey Errors](/articles/orchestrate-customer/identify-journey-errors). 2. **For one customer** — use [Journey Traces](/articles/orchestrate-customer/journey-traces) to follow a single record through the node and inspect the input and output event data. 3. **With RTB House** — confirm with your RTB House representative that events are arriving against your PKey. Zeotap reports what it sent; only RTB House can confirm what it accepted. ## Troubleshoot delivery failures When a journey execution fails at this node, a failure status code is recorded against the node. [Journey Error Codes](/articles/orchestrate-customer/journey-error-codes) is the full reference; these are the ones most likely to appear on a conversions-API destination. | Code | What it points to here | First thing to check | | :- | :- | :- | | `AUTHENTICATION_ERROR` | RTB House rejected the request's credentials. | The **PKey** and **API Tagging Hash** on the destination, against the values RTB House issued. Re-enter them if RTB House reissued them. | | `BAD_REQUEST` | A mandatory field was missing or invalid. | That **RTB House Cookie ID** and **Event Timestamp** are mapped and not null — the mapping screen marks both as required. | | `EVENT_PARSING_FAILED` | The event could not be built into the format RTB House expects. | The **Map the Fields** mapping for the event type configured on this node. | | `CONSENT_NOT_PROVIDED` | The customer had not given the consent this destination requires. | The consent attributes on the profile and the consent mapping on the destination. | | `RATE_LIMIT`, `SERVER_ERROR`, `SERVICE_UNAVAILABLE` | A transient fault on the RTB House side. | Nothing immediately — these retry automatically. Investigate if they persist across runs. | Three causes specific to this integration may not surface as an error code at all: * **No RTB House Cookie on the profile.** Every event is keyed on this identifier, so a customer without a synced cookie has nothing to send. Confirm cookie syncing is in place — see [Cookie Syncing](/articles/integrate-customer/understanding-cookies#cookie-syncing). * **A custom event RTB House has not configured.** RTB House has to set up the event name (key) before you send it. If a custom event was never shared with them, confirm with your RTB House representative that it has been configured. * **S2S not enabled on the account.** RTB House has to enable server-to-server requests for your account before it accepts them. For the wider journey-level checks, see [Troubleshooting Workflows](/articles/orchestrate-customer/journey-troubleshooting). ## FAQ > [accordion] What is the difference between the RTB House and RTB House CAPI destinations? > > They sit in different lanes and carry different payloads. **RTB House CAPI**, on this page, is a real-time destination: it attaches to a **Send to Destinations** node in a journey and streams one behavioural event at a time. [**RTB House**](/articles/integrate-customer/rtb-house) is a batch destination: it attaches to an audience and delivers that audience's RTB House Cookies to the S3 bucket RTB House provides. Both send data from Zeotap CDP to RTB House, and both depend on cookie syncing being enabled. > [accordion] Which destination fields do I have to map? > > **RTB House Cookie ID** and **Event Timestamp** are marked as required on the mapping screen, so map those for every event. Beyond them, map only the fields belonging to the event type you are sending: the screen groups fields by event, so a category-page event needs **Category Id** and a product-page event needs **Offer Product ID**. Fields belonging to other events can be left unmapped. ## Next steps * [Send an audience to RTB House as a batch delivery →](/articles/integrate-customer/rtb-house) * [Understand how destinations, actions and mappings fit together →](/articles/integrate-customer/destinations) * [Build the journey workflow this destination attaches to →](/articles/orchestrate-customer/create-a-workflow) * [Look up a journey failure code →](/articles/orchestrate-customer/journey-error-codes) * [Read how cookie syncing works →](/articles/integrate-customer/understanding-cookies#cookie-syncing) # Salesforce CRM source Source: https://docs.zeotap.com/articles/integrate-customer/salesforce-crm Import standard and custom Salesforce CRM objects into Zeotap CDP on a scheduled sync, and use the first-party user IDs they carry for user matching. A Salesforce CRM source brings data **from your Salesforce CRM account into Zeotap CDP**, so the records your sales, service and support teams keep in Salesforce can be unified with the rest of your customer data. To send data in the opposite direction — out of Zeotap CDP and into Salesforce — see [Salesforce CRM (Sales and Service Cloud)](/articles/integrate-customer/salesforce-crm-sales-and-service-cloud) for the batch destination and [Salesforce CRM Real Time Integration](/articles/integrate-customer/salesforce-crm-real-time-integration) for the real-time destination. ## What this is Salesforce CRM stores data as standard objects, which behave like tables. Although Salesforce has many standard objects, Zeotap CDP supports data sync from **all standard objects and custom objects** associated with a particular Salesforce account. * For the list of all standard Salesforce objects, refer to the Salesforce [standard object reference](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_list.htm). * To learn more about how Zeotap interacts with custom objects created in Salesforce, refer to the Salesforce [custom object reference](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_custom_objects.htm). The source sits in the **CRM Data** category of the Sources application, alongside the other [CRM Data sources](/articles/integrate-customer/crm-data). ## Supported identifiers Some standard objects — Account, Contact, Lead, Case and Opportunity — contain columns corresponding to first-party user IDs, which can facilitate user matching. Make sure you ingest the user ID in such cases. ## Sync frequency The first data sync takes place once you create the source. Subsequent syncs take place based on the refresh frequency that you select. The following sync frequencies are supported: * Daily * Weekly * Monthly ## Example use case An automobile manufacturer can use the Salesforce CRM integration to streamline its data management. By syncing data from Salesforce's Account, Contact and Lead objects, the manufacturer centralises customer information and uses the first-party user IDs those objects carry for user matching. That makes it possible to build targeted marketing campaigns, personalise communication with prospects and customers, and track the customer journey. Choosing a sync frequency keeps the data current for decision-making and customer engagement. ## Set up the source > [card] [Create a Salesforce CRM source](/articles/integrate-customer/creating-salesforce-crm) > > Set up the connected app on the Salesforce side and collect the connection details it returns, then create the source in Zeotap CDP and choose the Salesforce object and the fields to ingest. > [card] [Best practices for Salesforce CRM source](/articles/integrate-customer/best-practices-for-salesforce-crm-source) > > What to get right while configuring: at least one user ID per source, accurate country-to-region mapping, valid country values in the records, and the catalogue mapping. ## Next steps * Decide whether the data you are ingesting is customer data or non-customer data — see [supported data entities](/articles/unify-customer/supported-data-entities) and [customer data](/articles/unify-customer/customer-data). * Once the source is created, map the incoming fields to Zeotap's catalogue — see [map the catalogue for customer data](/articles/unify-customer/map-the-catalogue-for-customer-data). # Salesforce CRM Real Time Integration Source: https://docs.zeotap.com/articles/integrate-customer/salesforce-crm-real-time-integration Send Contact records and custom-object records from Zeotap CDP to Salesforce CRM in real time, from a Send to Destinations node inside a journey. ## What this is **Salesforce CRM : Journeys** is a real-time destination: data flows **out of Zeotap CDP and into your Salesforce org**. As a journey runs, Zeotap upserts **Contact records or custom-object records** into Salesforce, so your sales and service teams work from the same profile the journey acted on. Because this is a real-time destination, you attach it to a **Send to Destinations** node inside a journey — not to an audience. Two related pages cover the other directions and lanes for the same vendor: * To bring Salesforce data **into** Zeotap CDP, use the [Salesforce CRM source](/articles/integrate-customer/salesforce-crm). * To send **audience** data out to Salesforce standard objects in batch, use [Salesforce CRM (Sales and Service Cloud)](/articles/integrate-customer/salesforce-crm-sales-and-service-cloud). ## Supported actions and identifiers The destination exposes two actions, both available to journeys: | Action | What it sends | Mandatory mapping | | - | - | - | | **Send Contact Data to Salesforce CRM** | Upserts Contact records. | **Last Name**, **Email** | | **Send Custom Objects to Salesforce CRM** | Upserts records of any custom object in your org. | **Unique ID** | For the Contact action, the mapping screen starts with the fields the platform accepts — **Last Name**, **First Name**, **Email** and **Phone** — and you can edit, add, or remove entries. For the complete set of Contact fields Salesforce accepts, see Salesforce's [List of Supported Fields](https://developer.salesforce.com/docs/atlas.en-us.sfFieldRef.meta/sfFieldRef/salesforce_field_reference_Contact.htm). For the custom-object action, the **Unique ID** value is matched against the external ID field on the target object. Where no record matches, Salesforce creates one; where a record matches, Salesforce updates it in place. ## Prerequisites Before you create the destination, make sure you have: 1. **A Salesforce org** — an active org (Developer, Sandbox, or Production). The org's unique domain name is under **Setup > My Domain**. 2. **An API user** — a Salesforce user with API access permissions, plus object-level (**Read, Create, Edit**) and field-level security on the objects and fields you intend to send. You log in as this user when connecting the destination. 3. **An external ID field** — the target sObject must have an **external ID field** configured for upsert operations. ## Prepare Salesforce The external ID field is a custom field you create on the target object. In Salesforce: **Step 1** Go to **Setup > Object Manager** and open the object you want Zeotap to write to. **Step 2** Open **Fields & Relationships** and click **New**. **Step 3** Create the field, and make sure the **External ID** attribute is checked. Note the object's API name (shown in **Setup > Object Manager**) and the external ID field's API name (shown under that object's **Fields & Relationships**). You enter both when you map a custom object. > [!NOTE] > > If your org uses managed packages, object and field API names can carry a namespace prefix. Enter the API name exactly as Salesforce shows it, prefix included. ## Create the Salesforce CRM : Journeys destination **Step 1** Log into the **Zeotap CDP** App and go to the **DESTINATIONS** application. **Step 2** Click **+ Create Destination**. **Step 3** Under **All Destinations**, search for **Salesforce CRM : Journeys**. **Step 4** Click on **Salesforce CRM : Journeys**. A screen appears displaying details about the particular destination towards the left. On the right-hand side of the screen, enter the required details: a. Enter a name for the Destination. \ \ b. Enter the **Domain Name** — your Salesforce domain, excluding the domain suffix. For example, for `zeotap6-dev-ed.develop.my.salesforce.com`, enter `zeotap6-dev-ed.develop`. \ \ c. Enter the **Destination Instance**. ![Destination details form showing Destination Name, Domain Name and Destination Instance fields above the Connect Salesforce CRM : Journeys button](https://mintcdn.com/zeotap/d2txhFo8GBrXwocm/articles/integrate-customer/Storage/integrate-customer/salesforce-crm-real-time-integration/salesforce-crm-real-time-integration-1.png?fit=max\&auto=format\&n=d2txhFo8GBrXwocm\&q=85\&s=5637ab11087cf7bc11774a98dbb429da) The Enter Destination Details step, with the Destination Name, Domain Name and Destination Instance fields filled in and the Connect button below them. **Step 5** Click **Connect Salesforce CRM : Journeys** and log in with your Salesforce API user when prompted. Ensure this user has the necessary permissions (including API access) to read and update the records (for example, Contacts or custom objects) used in this destination. Once connected, the form confirms who established the connection and when, shows a note with the date on which the refresh token expires, and auto-fills the **Expires In** field. Reconnect the destination when the refresh token expires to keep the integration running. ![Destination details form after connecting, with a panel showing the last-updated time, a note giving the refresh token expiry date, and the Expires In field](https://mintcdn.com/zeotap/d2txhFo8GBrXwocm/articles/integrate-customer/Storage/integrate-customer/salesforce-crm-real-time-integration/salesforce-crm-real-time-integration-6.png?fit=max\&auto=format\&n=d2txhFo8GBrXwocm\&q=85\&s=ca2fc2655b41904dcfaaf8be879c0950) The same form after connecting, showing the connection panel with the refresh-token expiry note and the Expires In field. Click **Next** to proceed to the Mapping screen. **Step 6** Name the mapping, then under **Choose your Action**, select the action that matches what you want to send: ![Choose your Action dropdown listing Send Contact Data to Salesforce CRM and Send Custom Objects to Salesforce CRM, each tagged Journeys](https://mintcdn.com/zeotap/d2txhFo8GBrXwocm/articles/integrate-customer/Storage/integrate-customer/salesforce-crm-real-time-integration/salesforce-crm-real-time-integration-7.png?fit=max\&auto=format\&n=d2txhFo8GBrXwocm\&q=85\&s=50161901dd69c784405ed60d2fcffcd3) The Choose your Action dropdown on the Mapping step, open to show both actions. * **Send Contact Data to Salesforce CRM** — upserts Contact records. * **Send Custom Objects to Salesforce CRM** — upserts records of any custom object in your org. **Step 7** **If you chose Send Contact Data to Salesforce CRM**, map the fields to send under **Map the Fields**: a. By default, the fields accepted by the platform, such as **Last Name, First Name, Email and Phone**, are displayed. However, you can edit, add, or remove a field from the list.\ \ b. Mandatory Fields 1. **Last Name** 2. **Email** c. Click **+Add Mapping Field** to include additional fields. For a complete reference, see the [List of Supported Fields](https://developer.salesforce.com/docs/atlas.en-us.sfFieldRef.meta/sfFieldRef/salesforce_field_reference_Contact.htm). ![Map the Fields table for the Contact action, pairing a Choose Catalogue Attribute selector with the Last Name, First Name and Email destination fields](https://mintcdn.com/zeotap/d2txhFo8GBrXwocm/articles/integrate-customer/Storage/integrate-customer/salesforce-crm-real-time-integration/salesforce-crm-real-time-integration-2.png?fit=max\&auto=format\&n=d2txhFo8GBrXwocm\&q=85\&s=9cbfadd5d4b25fd61c2e256a1f9c2243) The Map the Fields section for the Contact action, with a Catalogue attribute selector against each destination field. **Step 8** **If you chose Send Custom Objects to Salesforce CRM**, configure the mapping as follows: a. Map a Catalogue attribute to **Unique ID**. This is mandatory — its value is matched against the external ID field on your custom object to upsert the record.\ \ b. Click **+Add Mapping Field** to add each field you want to send, entering the field's name on the destination side and mapping a Catalogue attribute to it.\ \ c. Under **Additional Settings**, enter the **Custom Object Name** — the object's API name (for example, `Loyalty_Event__c`) — and the **External ID Field** — the API name of the external ID field on that object. ![Map the Fields table showing Unique ID and Name destination fields with an Add Mapping Field link, above Additional Settings containing empty Custom Object Name and External ID Field inputs](https://mintcdn.com/zeotap/d2txhFo8GBrXwocm/articles/integrate-customer/Storage/integrate-customer/salesforce-crm-real-time-integration/salesforce-crm-real-time-integration-8.png?fit=max\&auto=format\&n=d2txhFo8GBrXwocm\&q=85\&s=674c70fc08d3d1ff96b55d69a55c857b) The Map the Fields section for the custom-object action, above the Additional Settings section with the Custom Object Name and External ID Field inputs. > [!NOTE] > > Both values in **Additional Settings** come from Salesforce: find the object's API name in **Setup > Object Manager**, and the external ID field's API name under that object's **Fields & Relationships**. **Step 9** Click **Create Destination**. ## Add the destination to a journey A real-time destination delivers only when a journey sends to it. Link the destination from a **Send to Destinations** node in your workflow, as explained below. For the surrounding workflow steps, see [Create a Workflow](/articles/orchestrate-customer/create-a-workflow). **Step 1** In the workflow, **click + and choose Send to Destinations.** ![Choose an action menu listing Add a Condition, Add a Delay, Create a Multi-branch Split, Create a True/False Split and Send to Destinations, with Send to Destinations outlined](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/salesforce-crm-real-time-integration/salesforce-crm-real-time-integration-3.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=f40b618b914e91cb74c2fd5add1e4826) The Choose an action menu on the journey canvas, with Send to Destinations highlighted. **Step 2** Choose the destination from the list of available destinations by using the search feature. ![Send to Destinations panel with a highlighted search box, an Add New Destination link, and a grid of destination cards](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/salesforce-crm-real-time-integration/salesforce-crm-real-time-integration-4.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=84893404a65f54ed056418209d4c5024) The Send to Destinations panel with the search box highlighted above the available destination cards. **Step 3** Under the Destination Details tab, the connection details you entered while creating the destination are **automatically populated**. **Step 4** Under the Destination Settings tab, **choose the Action and mapping** as per your requirement. **Step 5** Upon clicking **Save Destination**. The destination is attached as shown in the image below. ![Send to Destinations panel showing an attached Salesforce CRM : Journeys card with its destination name, mapping name and the Send Contact Data to Salesforce CRM action, above further destination cards](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/salesforce-crm-real-time-integration/salesforce-crm-real-time-integration-5.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=cb62185f160fc43da1cfcb372bd60d12) The Send to Destinations panel after the destination is attached, showing the attached card with its mapping name and chosen action. ## Verify the delivery Confirm delivery from both sides once the workflow is published and traffic is flowing: 1. **On the journey canvas** — open the **Send to Destinations** node. Successful deliveries show green indicators; failures show a red error count. Click the node to open the execution detail panel, which carries the failure status code and the request ID. See [Identify Journey Errors](/articles/orchestrate-customer/identify-journey-errors). 2. **For a single profile** — use [Journey Traces](/articles/orchestrate-customer/journey-traces) to inspect the output event that was sent to the destination node, and confirm the mapped fields carry the values you expect. 3. **In Salesforce** — open the target object and confirm the record is present with the expected field values. A record whose external ID already matched is updated in place rather than duplicated. ## Troubleshoot delivery failures Failures surface on the destination node with a failure status code; the full list and its resolution steps are in [Journey Error Codes](/articles/orchestrate-customer/journey-error-codes). The checks below are specific to Salesforce. | Symptom | Likely cause | What to do | | - | - | - | | Deliveries stop and the node reports an authentication failure. | The refresh token has expired. | Open the destination and reconnect it with your Salesforce API user. The expiry date is shown on the destination details form. | | Records are rejected only when they do not already exist in Salesforce. | A field Salesforce requires on that object has no default value and is not in the mapping, so the create half of the upsert fails. | Add the required field to the mapping, or give it a default value on the Salesforce object. | | More than one Salesforce record matches the same external ID value. | The external ID field is not unique on that object. | In Salesforce, resolve the duplicate records and mark the external ID field as **Unique**. | | Salesforce reports that the object or field cannot be found. | The **Custom Object Name** or **External ID Field** under **Additional Settings** is not the Salesforce API name, or a managed-package namespace prefix is missing. | Re-copy both API names from **Setup > Object Manager** and that object's **Fields & Relationships**, including any namespace prefix. | | A mapped field arrives empty. | No Catalogue attribute is mapped to it, or the attribute carries no value for those profiles. | Check the mapping for that action, then use [Journey Traces](/articles/orchestrate-customer/journey-traces) to inspect the output event for an affected profile. | | Deliveries slow down or are rejected in bursts across several Salesforce integrations at once. | Salesforce applies a per-org daily API request limit that is shared across all API traffic into the org, not just Zeotap's. | Review the org's API usage in Salesforce and confirm the limit for your Salesforce edition. | The API user's object-level and field-level permissions apply to every field in the mapping, not only the external ID field. If a single field consistently fails to write, check that user's field-level security on it first. ## Next steps * [Create a Workflow in Journeys →](/articles/orchestrate-customer/create-a-workflow) * [Add or delete a node →](/articles/orchestrate-customer/add-or-delete-a-node) * [Debug a single profile with Journey Traces →](/articles/orchestrate-customer/journey-traces) * [Send audience data to Salesforce in batch →](/articles/integrate-customer/salesforce-crm-sales-and-service-cloud) * [Bring Salesforce data into Zeotap CDP →](/articles/integrate-customer/salesforce-crm) * [How destinations work →](/articles/integrate-customer/destinations) # Salesforce CRM (Sales and Service Cloud) Source: https://docs.zeotap.com/articles/integrate-customer/salesforce-crm-sales-and-service-cloud Send Zeotap CDP audiences out to standard and custom objects in Salesforce Sales Cloud and Service Cloud as a batch destination. ## What this is Salesforce CRM is a **batch destination**: Zeotap CDP sends audience data *out* to standard and custom objects in your Salesforce org. You create the destination once, then link an audience to it — the audience drives every delivery. Salesforce is a cloud-based customer relationship management platform that organisations use to manage customer relationships, sales processes and service operations. This destination writes the customers in a Zeotap audience into the Salesforce objects your sales and service teams already work in. Two related pages cover the other directions: * To bring Salesforce data **into** Zeotap CDP, use the [Salesforce CRM source](/articles/integrate-customer/salesforce-crm). * To send records to Salesforce from a **journey** rather than an audience, use [Salesforce CRM Real Time Integration](/articles/integrate-customer/salesforce-crm-real-time-integration). It is a separate destination and appears in the catalogue under a different name. ## Supported objects and actions Each action writes to one Salesforce object. Pick the action that matches the object you want to populate. | Salesforce object | What it represents | Action in Zeotap | | - | - | - | | [Account](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_account.htm) | An individual account — an organisation or person involved with your business, such as a customer, competitor or partner. | Send Account data | | [Contact](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contact.htm) | A person associated with an account. | Send Contacts data | | [Lead](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_lead.htm) | A prospect or lead. | Send Lead data | | [Case](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_case.htm) | A customer issue or problem. | Send Case data | | [Opportunity](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunity.htm) | A sale or pending deal. | Send Opportunity data | | [Account Partner](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountpartner.htm) | A partner involved in a customer's account, such as a reseller or strategic ally. | Send Account Partner Data | | [Campaign](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_campaign.htm) | A marketing program, promotion or initiative, such as an advertisement, seminar or direct mail effort. | Send Campaign Data | | [Opportunity Line Item](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunitylineitem.htm) | A product or service added to an opportunity, detailing the price, quantity and total amount. | Send Opportunity Line Item Data | | [Task](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_task.htm) | A standard work item or to-do assigned to a user, typically with a due date and completion status. | Send Task Data | | Custom Object | A database table created in your org to store information specific to your organisation or industry. | Send Custom Object Data | The integration supports all the standard and custom attributes for each of these objects. ### Fields Salesforce requires on each object Salesforce rejects a record that arrives without the fields it requires for that object. Map at least the following, on top of whatever else you want to send: | Object | Fields Salesforce requires | | - | - | | Account | `Name` | | Contact | `LastName` | | Lead | `LastName`, `Company` | | Case | `Status` | | Opportunity | `Name`, `CloseDate`, `StageName` | | Campaign | `Name` | | Opportunity Line Item | `OpportunityId`, `PricebookEntryId`, `Quantity` — plus `UnitPrice` if you use custom pricing | | Task | `Subject`, `Status` | > [!NOTE] > > Picklist fields such as `StageName` and `Status` only accept values that are valid in your own org. Your org's validation rules, triggers and workflows can also require fields beyond the ones listed here, so check the object in Salesforce before you finalise a mapping. ## Prerequisites Before you create the destination, make sure you have the following: 1. **Salesforce Organization** — an active Salesforce org (Developer, Sandbox or Production). The org's unique domain name can be found in **Setup > My Domain**. 2. **Connection details** — the destination form asks for a **Destination Name**, a **Destination Instance Name** and your **Domain Name**. The connected app's **App Client ID** and **App Client Secret** are not typed into Zeotap CDP; they authorise the OAuth handshake you complete in the next step, so have the connected app configured before you start. 3. **A connected app in Salesforce** — the App Client ID and App Client Secret are the connected app's Consumer Key and Consumer Secret. If you do not already have one, [Create a Salesforce CRM Source](/articles/integrate-customer/creating-salesforce-crm) walks through creating a connected app in **Setup > Apps > App Manager** and finding its Consumer Key and Consumer Secret. 4. **A Salesforce user with API access** — you sign in as this user when you connect the destination. The user needs the object-level permissions for whichever objects you send to. ## Create the Salesforce CRM destination **1. Open the Destinations module** Log into the Zeotap CDP App and go to **Destinations** under **Integrate**, where you can view **Active Destinations** and **Archived Destinations**. **2. Start a new destination** Click **+ Create Destination**. ![The Destinations listing in the Integrate module, with a destination search box and the + Create Destination button highlighted at the top right.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-121.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=5d7dd55bcba6f967e4b2b9e8481d46cb) **3. Pick Salesforce CRM from the catalogue** Under **All Destinations**, search for **Salesforce CRM** and click it. ![The All Destinations catalogue showing destination cards in a grid, with the Search for a Destination box highlighted above them.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-122.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=dbd17d637251cb40651ed32d6923a1f2) > [!NOTE] > > Choose the entry named **Salesforce CRM**. The catalogue also contains **Salesforce CRM : Journeys**, which is the [real-time destination](/articles/integrate-customer/salesforce-crm-real-time-integration) driven from a journey rather than from an audience. **4. Enter the destination details** A screen appears with details about the destination on the left and the fields the integration needs on the right. Under **Enter Destination Details**, complete: ![The Enter Destination Details step of the Salesforce CRM destination, with empty fields for Destination Name, Destination Instance Name and Domain Name above a Connect Salesforce CRM button.](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/salesforce-crm-sales-and-service-cloud/salesforce-crm-sales-and-service-cloud-2025-11-18.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=23ef845350d9c7a603f3c9e4ef5c7f2d) a. **Destination Name** — a name that identifies this destination for you. b. **Destination Instance Name** — a value of your choosing. c. **Domain Name** — your Salesforce domain name. **5. Connect to Salesforce** Review the values above, then click **Connect Salesforce CRM**. You are redirected to Salesforce to sign in — use the Salesforce user that has API access to the objects you intend to write to. **6. Move on to the mapping** Click **Next** to go to the **Mapping** step. **7. Choose your action** Under **Choose your Action**, select the action for the object you want to populate — see [Supported objects and actions](#supported-objects-and-actions). **8. Map the fields** Under **Map the Fields**, map each Catalogue field to the Salesforce field it should populate. Fields are grouped into **Standard Fields** and **Custom Fields**, and **+ Add Mapping Field** adds a row to either group. a. The field name you enter on the destination side must exactly match the **Salesforce API field name**, not the display label you see in the Salesforce UI. A display label such as `First Name` is rejected where the API field name is `FirstName`. b. To find a field's API name in Salesforce, go to **Object Manager** → *\[Object]* → **Fields & Relationships** and use the **Field Name**, not the **Label**. c. Append `__c` to the name of every custom field — for example, enter `Loyalty_Points__c` rather than `Loyalty Points`. **9. If you chose Send Custom Object Data, name the object** Under **Additional Settings**, enter the object's API name in the **Custom Object** field, including the `__c` suffix — for example, `Customer_Feedback__c`. Find it in Salesforce under **Object Manager** → *\[Object]* → **Fields & Relationships**. ![The Mapping step showing the Map the Fields table with Catalogue Field and Destination Field columns, Standard Fields and Custom Fields groups each offering + Add Mapping Field, and an Additional Settings section containing the Custom Object field.](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/salesforce-crm-sales-and-service-cloud/salesforce-crm-sales-and-service-cloud-2025-11-18-1.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=30c0284c19425bb1ad336348c6c32bc2) **10. Check the payload before you save (optional)** **Generate Preview** sits at the bottom of the mapping screen and shows exactly what Zeotap would send, so you can check field values and structure before the mapping goes live. See [Payload Preview for Destination Mappings](/articles/integrate-customer/payload-preview-for-destination-mappings). **11. Create the destination** Click **Create Destination**. The destination is then listed in the **Audiences** application, ready to be linked to an audience. ## Link an audience to the destination This is a batch destination, so deliveries are driven by an audience. Once the destination exists, link an audience to it and set its refresh frequency — see [Activate Your Batch Audiences](/articles/integrate-customer/link-an-audience-to-the-destination). If the destination does not appear in the activation list for a folder, an access rule may be blocking it. See [Destination Access Rules](/articles/integrate-customer/destination-access-rules). ## Verify the delivery Confirm the delivery from both sides, as described in [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked): 1. **In Zeotap** — open the destination and review its activity. A successful run records a non-zero qualified count and a completed status; a failed run records an error message. 2. **In Salesforce** — open the object you targeted and confirm the expected records are present with the mapped field values populated. The two counts will not match exactly, because Salesforce applies its own validation to each record it receives. ## Troubleshoot | What you see | Likely cause | What to do | | - | - | - | | Records are rejected for an invalid or unknown field | A destination field name does not match the Salesforce API field name — it is a UI display label, or a custom field is missing its `__c` suffix. | In Salesforce, open **Object Manager** → *\[Object]* → **Fields & Relationships** and copy the **Field Name**. Correct the mapping and save it again. | | Records are rejected for a missing required field | The mapping omits a field Salesforce requires on that object, or your org's validation rules require more. | Check the mapping against [Fields Salesforce requires on each object](#fields-salesforce-requires-on-each-object), and against the object's own validation rules in your org. | | Records are rejected for a picklist value | A value sent for a field such as `StageName` or `Status` is not one of the values configured in your org. | Compare the values in the Catalogue attribute against the picklist values on the object in Salesforce. | | The delivery fails with an access or permissions error | The Salesforce user you connected with does not have the permissions needed on the target object. | Grant that user the object-level permissions for the object, then run the delivery again. | | The delivery fails with an authorisation error after previously working | The connected app or the connected user has changed in Salesforce — for example the app was disabled, or the user lost API access. | Confirm in Salesforce that the connected app is still enabled and that the user still has API access, then create the destination's connection again. | For errors that are not specific to Salesforce — an audience that qualifies zero customers, a refresh that stalls, or a pair stuck in progress — see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail) and [When to contact support](/articles/integrate-customer/destinations#when-to-contact-support). ## FAQ > [accordion] Which Salesforce CRM destination should I use? > > Use this one when the delivery should be driven by an audience on a refresh schedule. Use [Salesforce CRM Real Time Integration](/articles/integrate-customer/salesforce-crm-real-time-integration) when records should be sent as a journey runs — it attaches to a **Send to Destination** node rather than to an audience, and it is listed separately in the destination catalogue. > [accordion] Does this destination also bring Salesforce data into Zeotap? > > No. This destination only sends data out of Zeotap CDP. To ingest Salesforce objects into Zeotap, set up the [Salesforce CRM source](/articles/integrate-customer/salesforce-crm) — it is a separate integration with its own configuration, and the two can run alongside each other. ## Next steps * [Link an audience to this destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Preview the payload before a mapping goes live →](/articles/integrate-customer/payload-preview-for-destination-mappings) * [Understand how destinations work →](/articles/integrate-customer/destinations) * [Send to Salesforce from a journey instead →](/articles/integrate-customer/salesforce-crm-real-time-integration) * [Bring Salesforce data into Zeotap →](/articles/integrate-customer/salesforce-crm) # Salesforce Marketing Cloud — Data Extension Source: https://docs.zeotap.com/articles/integrate-customer/salesforce-marketing-cloud-data-extension Send audiences and identifiers from Zeotap CDP to a Salesforce Marketing Cloud Data Extension for use in journeys and campaigns. ## What this is Salesforce Marketing Cloud (SFMC) — Data Extension is a destination that writes audience members and their attributes as rows into a Data Extension table inside your SFMC account, where they become addressable for journeys, sends and filtered subsets. The integration uses a Server-to-Server API Integration on the SFMC side, paired with a matching Destination on the Zeotap CDP side; the two are joined by a Client ID, Client Secret, subdomain, and Data Extension External Key. Once linked, any audience you activate in Zeotap CDP appears as rows in the specified Data Extension. ## Prerequisites > [!NOTE] > > Before you start, confirm you have: > > * An **Admin account** in Salesforce Marketing Cloud with permission to install packages and create Data Extensions. > * Access to the Zeotap CDP **Destinations** application with permission to create a destination. > * A decision on which identifiers and attributes you will send. The Data Extension column names must match the destination field names in Zeotap exactly (case-sensitive). ## Create the SFMC package and API Integration The package holds the API Integration component that authorises Zeotap to write to your Data Extensions. Create it once per SFMC business unit that will receive data. **Step 1** In the SFMC console, go to **Settings → Setup → Apps → Installed Packages**. The existing list of packages appears. **Step 2** Click **New**, enter a name for the package, and save. Include the word **Zeotap** in the name so the package is easy to identify later. ![New Package Details dialog in SFMC Installed Packages](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/Image_2.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=476b65e0de049e5bc7401222f7c293f0) **Step 3** Open the package you just created and click **Add Component**. ![Add Component button on the installed package page](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/Image_4.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=0f61d34f1394d11acd7d7d9d96516cb6) **Step 4** Choose **API Integration** as the Component Type and click **Next**. ![Component Type selection with API Integration highlighted](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/Image_5.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=212f5bb3cca924a5ff6b58814d146781) **Step 5** Choose **Server-to-Server** as the Integration Type and click **Next**. ![Integration Type selection with Server-to-Server highlighted](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/Image_6.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=5fa52ee34befa91f45ef8fabc8bf3cee) **Step 6** Under **Data**, enable both **Read** and **Write** permissions for **Data Extensions**. Without both permissions, SFMC returns an **Insufficient Privileges** error when Zeotap attempts to write records. ![Data Extensions Read and Write permissions enabled under Data](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/salesforce-marketing-cloud-data-extension-2022-10-17.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=c5bfe711557af776808824b2e3d37368) **Step 7** Click **Save**. The API Integration details — **Client ID**, **Client Secret** and the authentication base URI — appear under the package **Summary**. Keep this tab open; you will copy these values in a later step. ## Create the Data Extension table The Data Extension is the table that Zeotap writes rows into. Column names on the SFMC side must match the destination field names on the Zeotap side exactly. **Step 1** In the SFMC console, go to **Audience Builder → Contact Builder → Data Extensions** and click **Create**. **Step 2** Under **Properties**, set: * **Creation Method** — Create from New * **Name** — a descriptive name for the table * **Description** — the purpose of this table * **External Key** — enter your own, or leave blank to use the system-generated key * **Type** — Standard (the only Type this integration supports) * **Is Sendable?** — checked, so the Data Extension can be used as the audience source for a send ![Data Extension Properties form in Contact Builder](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/salesforce-marketing-cloud-data-extension/salesforce.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=2010c1b724b5fefeaa3556d49a6166df) **Step 3** Under **Data Retention Policy**, set the retention rules you want SFMC to apply to rows in this Data Extension. **Step 4** Under **Attributes**, define at least one column and mark one column as the **Primary Key**. Set the **Length** of each column to accommodate the largest value you will send. **For hashed emails from Zeotap, set the column length to 200.** > [!WARNING] > > The **Name** of every attribute must exactly match the **Destination field** name you configure in Zeotap. If you create a column called `email`, the destination field in Zeotap must also be `email` — including case. **Step 5** Review the fields and click **Complete**. **Step 6** Copy the **External Key** for the Data Extension from the properties panel. You will paste it into the Zeotap destination configuration in the next section. ![External Key shown in the Data Extension properties panel](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/image-20220623-025126.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=90f17f58433ba34dede8e2899bbd1aa8) ## Collect the four connection values Before you configure the Zeotap destination, gather these four values from SFMC: | Value | Where to find it in SFMC | | - | - | | **Client ID** | Package **Summary → API Integration** component | | **Client Secret** | Package **Summary → API Integration** component | | **Sub Domain** | The 28-character string starting with `mc` in your SFMC base URI | | **Data Extension External Key** | The Data Extension's **Properties** panel | The subdomain is the tenant-specific prefix of your SFMC base URI. It has the shape: ``` https://mcXXXXXXXXXXXXXXXXXXXXXXXXXXXX./ └─────────── 28-char subdomain ───────────┘ ``` Copy only the `mc…` prefix (without the protocol, the dot, or the rest of the hostname) into the Zeotap **Sub Domain** field. ## Create the destination in Zeotap CDP With the four values in hand, open the Zeotap CDP **Destinations** application and add a new destination for Salesforce Marketing Cloud — Data Extension. **Step 1** Open the **Destinations** application in Zeotap CDP and start a new destination using **+ Create Destination**. ![Create Destination button in the Zeotap CDP Destinations application](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/salesforce-marketing-cloud-data-extension/ADOBE_DMP_3.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=b7d451f68af482ca2d2501bd0e8aea87) **Step 2** Under **All Destinations**, search for **Salesforce Marketing Cloud — Data Extension** and select it. ![Searching for the destination under All Destinations](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/salesforce-marketing-cloud-data-extension/ADOBE_DMP_4.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=f7c0fe41b896f71eec988f544cef9eaf) **Step 3** Fill in the destination form: * **Name** — a name for this destination in Zeotap * **Sub Domain** — the 28-character `mc…` subdomain * **Client ID** — from the SFMC package * **Client Secret** — from the SFMC package * **Data Extension External Key** — from the Data Extension properties Review the values and proceed to the next step. ![Destination configuration form for Salesforce Marketing Cloud Data Extension](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/salesforce-marketing-cloud-data-extension/salesforce_data_extension_1.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=5d290714db9e73347f15bddb2a24f4b9) **Step 4** Under **Choose your Action**, pick one: * **Send Raw emails to Data extension** — sends only raw email addresses to the Data Extension. * **Send email and attributes to Data extension** — sends the full set of attributes defined on the Data Extension. Under **Map the Fields**, the Zeotap catalogue fields are mapped to Destination fields; edit, add, or remove identifiers as needed. See the [destination field mapping reference](/articles/integrate-customer/destinations#mappings) for the mapping mechanics. > [!WARNING] > > The **Destination field** name in the mapping must exactly match the **Name** of the corresponding column in the Data Extension. **Step 5** Save the destination with **Create Destination**. It now appears in the destination list and is available to link to an audience. ![Newly created destination listed and ready to link to an audience](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/salesforce_data_extension_2.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=e138c6040ab26e8872a3b659d413863e) ## Link an audience to the destination Once the destination is saved, link it to an audience in the **Audiences** application using the standard flow described in [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination). Segment delivery to the Salesforce Marketing Cloud — Data Extension seat takes up to one business day after the audience is linked. > [!NOTE] > > "Audience" and "Segment" refer to the same object in this context — a cohort of customers who share a definition, for example customers over 18 who performed an `addToCart` event within the last 30 days. ## Verify the integration worked Open the SFMC console and go to **Audience Builder → Contact Builder → Data Extensions**. Select the Data Extension you created for this integration, then open the **Records** tab. You know the integration is working when: 1. The Data Extension shows a non-zero row count after Zeotap has processed the linked audience (allow up to one business day for the first delivery). 2. Rows in the **Records** tab contain values for every column you mapped in the Zeotap destination. 3. Hashed identifier columns (for example a `SHA-256` email column) contain the full-length hash — a truncated value points to a column-length problem. ![Records tab of the Data Extension showing rows delivered by Zeotap](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/image-20220623-025551.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=6138a799deb7afb4e551bd8f4930c965) Once the Data Extension is receiving rows, you can build a **Filtered Data Extension** on top of it inside SFMC using the column names Zeotap wrote. See the [Salesforce documentation on filtered Data Extensions](https://help.salesforce.com/s/articleView?id=sf.mc_es_create_filtered_de.htm\&type=5) for how to configure the filter. ## Troubleshoot If records are missing or the destination is failing, match the symptom you see against this table, then work through the numbered steps for that row. | Error string / symptom | What it means | Where to look | | - | - | - | | `Insufficient Privileges` (from SFMC) | The API Integration is missing Read or Write on Data Extensions | SFMC **Installed Packages → \[package] → API Integration** | | Destination is saved but records never appear in the Data Extension | Destination field name in Zeotap does not match a Data Extension column name | Zeotap destination **Map the Fields** and SFMC Data Extension **Attributes** | | Hashed identifier values are truncated in the Data Extension | Column length is smaller than the hash length | SFMC Data Extension **Attributes → Length** | | Data Extension is not selectable as a send source in SFMC | **Is Sendable?** was not checked when the Data Extension was created | SFMC Data Extension **Properties** | ### `Insufficient Privileges` from SFMC SFMC rejects the write because the API Integration does not have Data Extension permissions. 1. In SFMC, open **Settings → Setup → Apps → Installed Packages** and open the Zeotap package. 2. Open the **API Integration** component and confirm both **Read** and **Write** are enabled under **Data → Data Extensions**. 3. Save the component. New writes from Zeotap use the updated permissions on the next attempt — no re-creation of the destination is required. If the error persists after both permissions are set, escalate — see [Before you contact support](#before-you-contact-support). ### Records never appear in the Data Extension The destination is saved and the audience is linked, but the **Records** tab in SFMC stays empty, or specific columns stay empty. 1. In SFMC, open the Data Extension and note the **Name** of every column, exactly as spelled. 2. In Zeotap, open the destination and open **Map the Fields**. Confirm the **Destination field** value for each mapping matches an SFMC column name character-for-character, including case. 3. Correct any mismatched names in the destination mapping and save. 4. Wait for the next audience refresh, then re-check the **Records** tab. If the row count is still zero one business day after the refresh, escalate. ### Hashed identifier values are truncated The Data Extension column is shorter than the hash string Zeotap sends. 1. In SFMC, open the Data Extension and open **Attributes**. 2. Set the **Length** of the hashed identifier column to **200** and save. 3. Re-run the audience so the truncated rows are overwritten with the full hash value. ### Data Extension is not selectable as a send source The Data Extension was created without **Is Sendable?** checked, so SFMC will not allow it to be used as an audience source for a send. 1. In SFMC, open the Data Extension's **Properties** and check whether **Is Sendable?** is enabled. 2. If it is unchecked, create a new Data Extension with **Is Sendable?** checked and repoint the Zeotap destination to the new **External Key**. ### Before you contact support If the steps above did not resolve the symptom, contact your Zeotap customer success representative and include the following in your request: * The **destination name** and **destination ID** in Zeotap CDP. * The **Data Extension External Key** and the **SFMC business unit** the Data Extension lives in. * The **audience** (or **segment**) name you linked to the destination. * The **timestamp** of the last successful delivery and the timestamp of the first failed or empty delivery. * The exact **error string** from the destination activity log (for example `Insufficient Privileges`). * Whether the Client ID, Client Secret, or Data Extension External Key was rotated in SFMC in the last 24 hours. ## FAQ > [accordion] Which identifiers and attributes can I send? > > Any identifier or attribute for which you have created a matching column in the Data Extension. Zeotap writes whatever fields are mapped in the destination configuration; SFMC accepts values for the columns that exist on the Data Extension. > [accordion] How long after linking an audience will rows appear in SFMC? > > Segment delivery to the Salesforce Marketing Cloud — Data Extension seat takes up to one business day after the audience is linked. > [accordion] Can I filter the Data Extension further inside SFMC? > > Yes. Once Zeotap is writing rows to the Data Extension, build a Filtered Data Extension on top of it using SFMC's standard tooling. See the [Salesforce documentation on filtered Data Extensions](https://help.salesforce.com/s/articleView?id=sf.mc_es_create_filtered_de.htm\&type=5). > [accordion] Do I have to send hashed identifiers, or can I send raw? > > Both are supported. If you send hashed emails, set the Data Extension column length to 200 to hold the full hash. If you send raw values, size the column to fit your longest expected value. ## Next steps * [Explore how to link an audience to the destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore the destination field mapping reference →](/articles/integrate-customer/destinations#mappings) * [Explore Salesforce CRM (Sales and Service Cloud) as an alternative Salesforce destination →](/articles/integrate-customer/salesforce-crm-sales-and-service-cloud) * [Explore Salesforce CRM Real Time Integration for journey-triggered sends →](/articles/integrate-customer/salesforce-crm-real-time-integration) # SDK Reference Source: https://docs.zeotap.com/articles/integrate-customer/sdk-reference What the status and message values returned through a Zeotap SDK callback mean, and which SDKs accept one. The Zeotap SDKs send first-party events and identities from your app into Zeotap CDP. This page explains the `status` and `message` values an SDK passes back to your app through an optional callback. > [!NOTE] > > Looking for the full SDK developer documentation? See the [Zeotap SDKs](/articles/sdks/overview) section for per-platform installation, configuration, API reference, consent, and release notes. ## What this is Many Zeotap SDK methods accept an optional callback as their final parameter. When the method finishes, the SDK invokes that callback with a short response object, so your app can log the outcome, inspect it during QA, or branch on it in code. The method-by-method signatures live in each SDK's own API reference. This page covers only the response the callback receives. ## Supported SDKs The callback is optional on every method that accepts one, and its parameter type is named differently on each platform: | SDK | Callback parameter type | | - | - | | Android | `SDKCallback` | | iOS | `ResponseCallback?` | | React Native | `Function` | ## SDKCallback The **SDKCallback** function receives data in the following format: ```javascript theme={null} {status: , message: } ``` The **status** field indicates the result of the function call. Possible values are: * **SUCCESS**: Indicates successful completion of an operation. * **WARNING**: Indicates potential issues or incomplete actions that require attention. * **ERROR**: Indicates a failure or exception during the operation. The **message** field provides additional context about the status. Below are examples of the **status** and **message** combinations. ### Success messages * `{status: "SUCCESS", message: "SDK initialized successfully"}` * `{status: "SUCCESS", message: "Event logged successfully"}` * `{status: "SUCCESS", message: "Page properties set successfully"}` * `{status: "SUCCESS", message: "User properties set successfully"}` * `{status: "SUCCESS", message: "User identities set successfully"}` ### Warning messages * `{status: "WARNING", message: "SDK already initialized"}` * `{status: "WARNING", message: "SDK initialization is in progress"}` * `{status: "WARNING", message: "SDK not initialized"}` * `{status: "WARNING", message: "Event name is empty"}` * `{status: "WARNING", message: "Event properties are empty"}` * `{status: "WARNING", message: "User identities are empty"}` * `{status: "WARNING", message: "User IDs already set"}` * `{status: "WARNING", message: "User IDs not set as consent not provided"}` * `{status: "WARNING", message: "Page properties are empty"}` * `{status: "WARNING", message: "User properties are empty"}` * `{status: "WARNING", message: "Event not logged as consent not provided"}` * `{status: "WARNING", message: "Page properties not set as consent not provided"}` * `{status: "WARNING", message: "User properties not set as consent not provided"}` ### Error messages When the function encounters issues with the data provided or an exception occurs, it returns an **ERROR** status with a descriptive **message**: * `{status: "ERROR", message: ""}` For example: * `{status: "ERROR", message: "Failed to update user identities"}` * `{status: "ERROR", message: "Invalid data format"}` * `{status: "ERROR", message: "Null pointer exception"}` ## Next steps Go back to the guide you came from: * [Android SDK API reference](/articles/sdks/android/api-reference/set-user-identities) — method signatures and callback examples for Android. * [iOS SDK API reference](/articles/sdks/ios/api-reference/set-user-identities) — method signatures and callback examples for iOS. * [React Native SDK API reference](/articles/sdks/react-native/api-reference/set-user-identities) — method signatures and callback examples for React Native. * [Zeotap SDKs](/articles/sdks/overview) — installation, configuration, consent and release notes for every SDK. To set up the source in Zeotap CDP that receives this data, see [Android SDK](/articles/integrate-customer/android-sdk) or [iOS SDK](/articles/integrate-customer/ios-sdk). # Send events to Facebook Conversions API using the /events endpoint Source: https://docs.zeotap.com/articles/integrate-customer/send-events-using-the-api Post server-side events directly to Meta's Conversions API /events endpoint, including the payload structure, required parameters, and how to verify receipt in Meta Events Manager. ## What this is Facebook Conversions API (CAPI) is Meta's server-to-server endpoint for sending web, app, and offline events directly to a Meta Pixel or Dataset — complementing browser-side pixel tracking with data you post from your own backend. This page describes the direct `POST /events` call to Meta's Graph API: the URL structure, the required payload fields, and how to confirm Meta received the event. If you want Zeotap CDP to send events on your behalf from an audience or a Journey instead of calling the endpoint yourself, use the [Facebook Conversions API destination](/articles/integrate-customer/facebook-conversions-api). ## Prerequisites > [!NOTE] > > Before you can post events to the Conversions API, obtain the following: > > * A Meta **Business Manager** account. > * A Meta **Pixel** (or Dataset) linked to your Business Manager. > * The **Pixel ID** (or Dataset ID) from Facebook Events Manager. > * A **generated access token** with Conversions API permission. The Generate access token link in Events Manager is visible only to users with developer privileges for the business. > > Web and app events shared using the Conversions API require specific parameters. By using the Conversions API, you agree that the `action_source` parameter is accurate to the best of your knowledge. For the full parameter reference, see the [Conversions API parameters appendix](https://docs.zeotap.com/articles/project-integrate/appendix/a/h2__49116610). ## Post an event to the /events edge To create new server events, send a `POST` request to the `/events` edge for your Pixel ID: ``` https://graph.facebook.com/{API_VERSION}/{PIXEL_ID}/events?access_token={TOKEN} ``` Attach your generated access token using the `access_token` query parameter. Meta creates a new server event for each entry in the `data` array of your payload. Example `cURL` request: ```bash theme={null} curl -X POST \ -F 'data=[ { "event_name": "Purchase", "event_time": 1697131000, "user_data": { "em": [ "309a0a5c3e211326ae75ca18196d301a9bdbd1a882a4d2569511033da23f0abd" ], "ph": [ "254aa248acb47dd654ca3ea53f48c2c26d641d23d7e2e93a1ec56258df7674c4", "6f4fcb9deaeadc8f9746ae76d97ce1239e98b404efe5da3ee0b7149740f89ad6" ], "client_ip_address": "123.123.123.123", "client_user_agent": "$CLIENT_USER_AGENT", "fbc": "fb.1.1554763741205.AbCdEfGhIjKlMnOpQrStUvWxYz1234567890", "fbp": "fb.1.1558571054389.1098115397" }, "custom_data": { "currency": "usd", "value": 123.45, "contents": [ { "id": "product123", "quantity": 1, "delivery_category": "home_delivery" } ] }, "event_source_url": "http://jaspers-market.com/product/123", "action_source": "website" } ]' \ -F 'access_token=' \ https://graph.facebook.com/v18.0//events ``` > [!TIP] > > You can also POST to `//events` interactively from Meta's [Graph API Explorer](https://developers.facebook.com/tools/explorer/?method=POST\&path=%7BPIXEL_ID%7D%2Fevents%2F\&version=v3.2) while iterating on your payload. ## Structure the request body Each request body carries a `data` array — one entry per event. Each entry accepts standard event fields, hashed user identifiers, and optional custom data. The example below sends two `Purchase` events in one call: ```json theme={null} { "data": [ { "event_name": "Purchase", "event_time": 1633552688, "event_id": "event.id.123", "event_source_url": "http://jaspers-market.com/product/123", "action_source": "website", "user_data": { "client_ip_address": "192.19.9.9", "client_user_agent": "test ua", "em": [ "309a0a5c3e211326ae75ca18196d301a9bdbd1a882a4d2569511033da23f0abd" ], "ph": [ "254aa248acb47dd654ca3ea53f48c2c26d641d23d7e2e93a1ec56258df7674c4", "6f4fcb9deaeadc8f9746ae76d97ce1239e98b404efe5da3ee0b7149740f89ad6" ], "fbc": "fb.1.1554763741205.AbCdEfGhIjKlMnOpQrStUvWxYz1234567890", "fbp": "fb.1.1558571054389.1098115397" }, "custom_data": { "value": 100.2, "currency": "USD", "content_ids": [ "product.id.123" ], "content_type": "product" }, "opt_out": false }, { "event_name": "Purchase", "event_time": 1633552688, "user_data": { "client_ip_address": "192.88.9.9", "client_user_agent": "test ua2" }, "custom_data": { "value": 50.5, "currency": "USD" }, "opt_out": true } ] } ``` Field reference: * `event_name` — a standard Meta event (`Purchase`, `AddToCart`, `Lead`, `ViewContent`, and so on) or a custom event name. Mapping this field is mandatory; otherwise the call fails. * `event_time` — Unix timestamp in seconds indicating when the event occurred. Mapping this field is mandatory; otherwise the call fails. * `event_source_url` — required for **website** events. Must begin with `http://` or `https://` and match a domain verified against the Pixel. * `action_source` — where the event originated (for example, `website` or `app`). * `event_id` — optional, and used together with a matching Pixel `event_id` for deduplication. * `user_data.client_user_agent` — required for website events. * `user_data.em`, `user_data.ph`, first name, and last name — must be **SHA-256 hashed** before you send them. `client_ip_address`, `client_user_agent`, `fbc` (Click ID), and `fbp` (Browser ID) are sent unhashed. * `custom_data` — `value` and `currency` are mandatory for `Purchase` events. * `opt_out` — set to `true` to exclude the event from ads optimisation and attribution. ## Why this happens The `/events` endpoint rejects a request when required parameters are missing, credentials are invalid, or identifiers are formatted incorrectly. The conditions below cover the failures documented for the Conversions API integration. | Error condition | What it means | Where to look | | - | - | - | | Missing `event_name` | Meta cannot categorise the event, and the destination fails. | Your outbound request payload | | Missing `event_time` | Meta cannot timestamp the event, and the destination fails. | Your outbound request payload | | Missing `event_source_url` on a website event | Website events require the source URL; Meta rejects the request. | Your outbound request payload | | Missing `client_user_agent` on a website event | Website events require the browser user agent; Meta rejects the request. | Your outbound request payload | | Invalid or revoked `access_token` | The token was not generated, was revoked, or lacks Conversions API permission. | Meta Events Manager → Settings → Conversions API | | Identifier sent as plaintext | `em`, `ph`, `fn`, or `ln` was not SHA-256 hashed, so Meta cannot match the user. | Your hashing step before the POST | | `event_source_url` domain not verified | The domain in the URL does not match a domain verified on the Pixel. | Meta Events Manager → Data Sources → your Pixel → Settings | ## Verify events were received Meta Events Manager surfaces events posted to the Conversions API against the Pixel or Dataset you targeted. Once your POST returns a success response, the event appears against the Pixel in Events Manager. > [!NOTE] > > To verify from Meta's side: > > 1. Log into Meta Events Manager. > 2. Open the Pixel or Dataset that corresponds to the `PIXEL_ID` you posted to. > 3. Review the event activity for the `event_name` values you sent. > > For the full Events Manager guide, see Meta's [Conversions API documentation](https://developers.facebook.com/docs/marketing-api/conversions-api). If the same events also flow through a Zeotap-managed Facebook Conversions API destination, open the Destinations application in Zeotap CDP and review the destination linked to your Pixel. ## Troubleshoot rejected or missing events Work through these checks when Meta returns an error or when events do not appear against your Pixel: 1. Confirm your POST target is `https://graph.facebook.com/{API_VERSION}/{PIXEL_ID}/events`, with a supported `API_VERSION` and the correct Pixel or Dataset ID. 2. Confirm the `access_token` query parameter is present, has Conversions API permission, and has not been revoked. Regenerate the token from Events Manager if in doubt. 3. Confirm every website event carries both `event_source_url` and `user_data.client_user_agent`. 4. Confirm `em`, `ph`, `fn`, and `ln` are SHA-256 hashed strings, not plaintext. 5. Confirm the domain in `event_source_url` is verified against the Pixel. 6. For duplicate events across the Pixel and the API, send the same `event_name` and either a shared `event_id` or a combination of `external_id` and `fbp` on both calls — Meta uses these to deduplicate. ## FAQ > [accordion] Do I still need the Facebook Pixel if I'm using the Conversions API? > > Meta recommends a setup that uses both the Pixel and the Conversions API to pass events. Zeotap's integration covers only the server-to-server Conversions API — implementing the browser Pixel is your responsibility. > [accordion] How do I avoid duplicate events when I send from both the Pixel and the API? > > Use the same `event_name` for the Pixel and the server event, and include either a shared `event_id` or a combination of `external_id` and `fbp` on both. Meta uses these values to deduplicate identical events. > [accordion] Which user_data fields must be SHA-256 hashed before I send them? > > Hash `em` (email), `ph` (phone), `fn` (first name), and `ln` (last name), along with date of birth, gender, city, state, zip, and country. Send `client_ip_address`, `client_user_agent`, `fbc` (Click ID), and `fbp` (Browser ID) unhashed. > [accordion] Which Meta event names does the /events endpoint accept? > > You can send any standard Meta event — `Purchase`, `AddToCart`, `AddToWishlist`, `CompleteRegistration`, `Lead`, `InitiateCheckout`, `Search`, `ViewContent`, `StartTrial`, `Subscribe`, and others — or a custom event name defined for your business. ## Next steps * [Explore the Facebook Conversions API destination in Zeotap CDP →](/articles/integrate-customer/facebook-conversions-api) * [Explore Facebook Enhanced Conversions API for offline events →](/articles/integrate-customer/facebook-enhanced-conversions-api-capi) * [Explore linking an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore the Amazon Conversions API destination →](/articles/integrate-customer/amazon-conversions-api) # SendGrid Source: https://docs.zeotap.com/articles/integrate-customer/sendgrid Send unified customer data out of Zeotap CDP to a Twilio SendGrid contact list, adding or updating contacts as a journey runs. ## What this is SendGrid is a destination: data flows **out of** Zeotap CDP to your Twilio SendGrid account, where the integration adds or updates contacts in a SendGrid contact list. SendGrid appears only as a destination in the [integrations master list](/articles/integrations-master-list-publication/integrations-master-list), so there is no SendGrid source page carrying data the other way. It runs as a real-time integration driven from Journeys. You configure the destination once under **Integrate > Destinations**, then attach it to a **Send to Destinations** node in a journey workflow. Each time a customer reaches that node, Zeotap sends the mapped fields to SendGrid. ## Supported identifiers and actions The connector exposes a single action, **Add or Update a Contact**. Under **Map the Fields** you map Catalogue fields to the destination's fields: | Field | Notes | | - | - | | Email | Mandatory. Mapped from a Catalogue email field. | | Country | Optional. | | Any other field | Add it with **+ Add Mapping**. | > [!NOTE] > > **An update must carry the contact's existing identifiers.** To update a contact, include all of its existing identifiers in the request. Any fields you omit from the request remain unchanged. ## Prerequisites In Zeotap CDP: * Admin access to your Zeotap account. * Permission to create and manage integrations. * The customer segments or data you want to sync are ready. For the source, Catalogue-mapping and role setup this destination depends on, see [Destinations](/articles/integrate-customer/destinations#prerequisites) — the audience bullet there applies to the audience lane only. In SendGrid: * An active SendGrid account with API access. * Admin permissions to generate API keys. * A contact list created for the contacts you want to add or update. * A decision on which contact fields you want to map. ## Get your SendGrid API key and list ID **Step 1** Log in to your SendGrid account at [https://app.sendgrid.com](https://app.sendgrid.com). **Step 2** Go to **Settings** in the left sidebar and select **API Keys**. ![The SendGrid Settings menu expanded in the left sidebar, with API Keys highlighted](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/sendgrid/sendgrid-1.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=24fcbcdde2acabe21fdbc9ea3f5fd4f8) **Step 3** Click **Create API Key**. Choose **Full Access**, or **Custom Access** for a tighter scope, and give the key a descriptive name — for example, `Zeotap Integration`. ![The SendGrid API Keys list, with the Create API Key button highlighted](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/sendgrid/sendgrid-2.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=3c04ec418adb83f0147594b32b9bd311) **Step 4** Set the key's permissions: * Under **Mail Send**, select **Full Access**. * Under **Marketing Campaigns**, select **Full Access**. * Under **Lists and Segments**, select **Full Access**. Click **Create & View**. **Step 5** Copy the key and store it securely. SendGrid does not display it again once you leave the page, and it grants access to your SendGrid account, so treat it like a password. **Step 6** In **Contacts**, create the contact list you want Zeotap to write to, and note its List Id — you enter it when you attach the destination to a journey. ![The SendGrid Contact Lists page with the Create menu open and New List highlighted](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/sendgrid/sendgrid-3.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=e6f4d0da428d38539ec6363f303c1400) ![A contact list open in SendGrid Contacts, with the browser address bar highlighted](https://mintcdn.com/zeotap/kl8L6sBUYwhq5T7t/articles/integrate-customer/Storage/integrate-customer/sendgrid/sendgrid-4.png?fit=max\&auto=format\&n=kl8L6sBUYwhq5T7t\&q=85\&s=ea271040682d11280456dc8a0fe40bf1) ## Create the SendGrid destination **Step 1** Log into the Zeotap CDP App and go to **Destinations** under **Integrate**. **Step 2** Click **+ Create Destination**. ![The Destinations module in Zeotap CDP, with the + Create Destination button highlighted](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/sendgrid/sendgrid-5.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=931b5c57241235de60a2b021f8809d7a) **Step 3** Under **All Destinations**, search for SendGrid. ![The All Destinations catalogue with the Search for a Destination box highlighted](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/sendgrid/sendgrid-6.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=4db0ebdb662a7fbcd1b39e569556b55f) ![The destination search returning a single SendGrid result card](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/sendgrid/sendgrid-7.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=ab69c3763abb974f65dda6009a16e5dd) **Step 4** Click **SendGrid**. The left of the screen describes the destination; the right lists the fields the integration needs. Enter them: a. **Destination Name** — a name that identifies this destination. b. **Api Key** — the key you created in SendGrid. c. **Server** — select your server from the list. ![The SendGrid destination's Enter Destination Details step, showing the empty Destination Name, Api Key and Server fields](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/sendgrid/sendgrid-8.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=8c0c9066b5347867cf75c9d6a8e6de97) Review the values and click **Next**. **Step 5** On the mapping screen, choose the [action](/articles/integrate-customer/destinations#configure-a-destination) and [mapping](/articles/integrate-customer/destinations#define-the-mapping). Under **Choose your Action**, select **Add or Update a Contact**, then map the fields: * Email — mandatory. * Country. * Any other field, using **+ Add Mapping**. ![The Choose your Action panel showing Add or Update a Contact, above Map the Fields pairing Catalogue fields with destination fields](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/sendgrid/sendgrid-9.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=fc6e14978dec3494f0ad9ff0571fa7aa) **Step 6** Click **Create Destination**. The destination is then listed in the Journeys application and can be linked to any journey. ## Link the destination to a journey Once the destination exists, link it in a **Send to Destinations** node inside the journey workflow. **Step 1** In the workflow, click **+** and choose **Send to Destinations**. See [Add or delete a node](/articles/orchestrate-customer/add-or-delete-a-node) for the full node menu. ![The Choose an action menu on a journey canvas, with Send to Destinations highlighted](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/sendgrid/sendgrid-10.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=dd725bc01a657264f2cec634363883d1) **Step 2** Choose your destination from the list of available destinations, using the search feature. ![The Send to Destinations picker listing the destinations available to the journey, with the search box highlighted](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/sendgrid/sendgrid-11.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=b51173fae788fe3424da48dd0fb4cb87) **Step 3** Under the **Destination Details** tab, the Api Key and Server fields are populated automatically from the values you entered when you created the destination. **Step 4** On the same **Destination Details** tab, enter the **List Id** of the SendGrid contact list you noted in SendGrid. ![The attached SendGrid destination panel showing the Destination Details and Destination Settings tabs, with the Save Destination button highlighted](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/sendgrid/sendgrid-12.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=f32d863044f6518b8aeb83b89b9af801) **Step 5** Click **Save Destination**. The destination is attached to the node, which then shows the destination and its action. ![A journey's Send to Destinations node showing the attached SendGrid destination and its Add or Update a Contact action](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/sendgrid/sendgrid-13.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=55240d6a659aae7f52c90b6340d738c9) ## Verify the delivery Check both sides once the journey has run: 1. **In Zeotap CDP** — on the journey canvas, destination nodes carry success and error counts, and the **View Executions** panel reports Total Events Entered, Successful Events and Failed Events. To follow one customer end to end, use [Journey Traces](/articles/orchestrate-customer/journey-traces), which shows the output event sent to each destination node. 2. **In SendGrid** — open **Contacts** and check the Count recorded against the list you mapped. ## Troubleshoot the delivery A failure at the destination node is recorded with a journey failure status code. The full reference is [Journey Error Codes](/articles/orchestrate-customer/journey-error-codes). | Code | What it means here | What to do | | - | - | - | | `BAD_REQUEST` | Mandatory fields are missing or invalid in the request. | Email is the mandatory destination field for **Add or Update a Contact** — confirm the Catalogue field mapped to it is populated and not null. Remember that an update must carry all of the contact's existing identifiers. | | `AUTHENTICATION_ERROR` | The destination rejected the request because the credentials were refused. | Confirm the key still exists under **Settings > API Keys** in SendGrid and still carries the permissions listed above, then re-enter the Api Key on the destination under **Integrate > Destinations**. | | `EVENT_PARSING_FAILED` | The event could not be transformed into the required format before sending. | Review the mapping for null values and for data types that do not match what the destination expects. | | `RATE_LIMIT` | SendGrid is throttling the volume of requests. | Retried automatically with backoff, but sustained throttling needs action — add a wait node to stagger delivery, or ask SendGrid to raise your API rate limit. | | `SERVER_ERROR`, `SERVICE_UNAVAILABLE` | SendGrid was unavailable or errored while processing the request. | Retried automatically. Monitor the node and check SendGrid's status page rather than changing the configuration. | ## Next steps * [Destinations](/articles/integrate-customer/destinations) — how destinations, actions and mappings fit together. * [Create a Destination](/articles/integrate-customer/create-a-destination) — the generic destination creation flow. * [Journey Traces](/articles/orchestrate-customer/journey-traces) — per-customer debugging for journey deliveries. * [Journey Error Codes](/articles/orchestrate-customer/journey-error-codes) — the full failure-code reference. # Server-to-Server (CE+NCE) Source: https://docs.zeotap.com/articles/integrate-customer/server-to-server Server-to-Server sources send customer and non-customer entity data straight from your own server into Zeotap CDP through the HTTP API source. ## What this is Server-to-server integration moves data directly from a server you own into Zeotap CDP, with no file drop, browser snippet, or mobile SDK in between. You register an **HTTP API** source in the Sources module, and your server then makes API calls to the Zeotap CDP endpoint that source issues. Once the data is in Zeotap CDP it is available for segmentation and activation across platforms, so you can use it to build audiences and optimise your engagement strategies. Zeotap CDP supports server-to-server data transfer exclusively through the HTTP API source. ## When to use a server-to-server source Choose a server-to-server source when you own the system that emits the data and you want an authenticated, JSON-first ingestion path rather than an intermediary file drop or a client-side SDK. The source type supports both **Customer Data (CE)** and **Non-Customer Entity (NCE)** data — you choose which **Data Entity** applies when you create the source. Delta fetch is not supported for this source type — see [Source Integrations](/articles/integrate-customer/creating-a-source) for how it compares with the other source types. ## Key concepts * **HTTP API source** — server-to-server sources are registered under the HTTP API source type in the Sources module. The source's details carry the API endpoint and the `write_key` your server uses to send data. * **`eventType`** — server-to-server calls set the `eventType` parameter to `s2s`. * **Identifiers** — server-to-server data must be tied to at least one identifier. Preferably send both your own first-party user ID — it must be the same value you send in the Web JS or App SDKs — and a digital identifier such as a mobile advertising ID (MAID), so Zeotap can match the records to the right user. * **Country and region** — server-to-server calls must carry the user's country, because Zeotap does not infer country from the request IP address for this source type. See [Region of Storage](/articles/integrate-customer/region-of-storage) for the country-to-region mapping that decides where the data is stored. * **Real-time and batched calls** — a real-time call carries a single event; a batched call wraps an array of events. Both use the same endpoint and credentials, and only the shape of the payload body differs. ## Next steps * [Explore how to create and implement a Server-to-Server source →](/articles/integrate-customer/implementing-server-to-server-source-2665709918) * [Explore the country-to-region storage mapping →](/articles/integrate-customer/region-of-storage) * [Explore all source categories →](/articles/integrate-customer/sources) * [Explore the supported source integrations →](/articles/integrate-customer/creating-a-source) # Set up a Databricks source Source: https://docs.zeotap.com/articles/integrate-customer/set-up-a-databricks-source Create a Databricks source to pull data from a table in your Databricks workspace into Zeotap CDP, using either a JDBC or a job-based connection. A Databricks source moves data **into** Zeotap CDP: the platform connects to a table in your Databricks workspace and pulls the columns you select into the **Sources** application, on a schedule you choose. To move audiences in the opposite direction — out of Zeotap CDP and into Databricks — see [Databricks destination](/articles/integrate-customer/databricks_destination). ## What this is This page is the click-by-click walkthrough for creating the source in the Zeotap CDP App. It covers both connection types that Databricks sources support: * **JDBC** — Zeotap CDP queries your Databricks SQL warehouse directly over a JDBC connection. Best suited to smaller tables. * **Job Based** — the extraction runs as a job inside your own Databricks workspace rather than over a JDBC connection, and the temporary resources it uses are removed once the run finishes. Recommended for large tables. For background on each value you need to supply and where to find it in Databricks, see [Create and Implement a Databricks Source](/articles/integrate-customer/create-and-implement-a-databricks-source). For the Databricks integration in general, see [Databricks](/articles/integrate-customer/databricks). ## Prerequisites Collect the following from your Databricks account before you start. [Components of Databricks Source](/articles/integrate-customer/create-and-implement-a-databricks-source#components-of-databricks-source) explains where each one lives in the Databricks UI. | You need | Applies to | | :- | :- | | Databricks host (your workspace URL) | Both connection types | | Catalog name, schema name and table name | Both connection types | | Client ID and Client Secret | [JDBC](/articles/integrate-customer/create-and-implement-a-databricks-source#prerequisites-for-jdbc-approach) | | HTTP Path of your SQL warehouse | [JDBC](/articles/integrate-customer/create-and-implement-a-databricks-source#prerequisites-for-jdbc-approach) | | An access token, Cluster ID and Warehouse ID | [Job Based](/articles/integrate-customer/create-and-implement-a-databricks-source#prerequisites-for-job-based-approach) | ## Create the Databricks source ### Step 1: Open Sources and start a new source Navigate to **Integrate → Sources** in the Zeotap CDP App, then click **+ Create Source** in the top-right corner of the Sources listing page. ![The Sources listing page on the Available tab, showing existing sources with their status and the Create Source button in the top-right corner.](https://mintcdn.com/zeotap/eruOOrzoSjga8a0u/articles/integrate-customer/Storage/integrate-customer/create-a-databricks-source/create-a-databricks-source-step1-create-source-tab.png?fit=max\&auto=format\&n=eruOOrzoSjga8a0u\&q=85\&s=dac15492934863acdc69822bce9a0a79) ### Step 2: Choose Data Warehouse as the category The **Create Source** dialog opens on the **Data Source** step with a list of categories. Select **Data Warehouse**, then choose **Databricks** as the data source. ![The Create Source dialog on the Data Source step, listing the source categories available for selection, including Data Warehouse.](https://mintcdn.com/zeotap/eruOOrzoSjga8a0u/articles/integrate-customer/Storage/integrate-customer/create-a-databricks-source/create-a-databricks-source-step2-select-data-warehouse.png?fit=max\&auto=format\&n=eruOOrzoSjga8a0u\&q=85\&s=053a87e4e9a5fd0bb7cc436032c4da08) ### Step 3: Fill in the source details The **Source Details** step collects everything needed to reach your table: * **Source Name** — a short, descriptive name for the source. * **Sync Frequency** — how often Zeotap CDP pulls from the table. The first sync runs as soon as you create the source; later syncs follow this setting. See [Create and Implement a Databricks Source](/articles/integrate-customer/create-and-implement-a-databricks-source#create-a-databricks-source) for the full list of frequencies and the sync time options. * **Select your Region** — the region of upload for the source. * **Databricks Host** — your Databricks workspace URL. * **Catalog Name**, **Schema Name** and **Table Name** — the table to ingest. * **Data Entity** — choose **Customer Data** or **Non Customer Data**. See [Supported data entities](/articles/unify-customer/supported-data-entities) for the difference. * **Delta Queries Selection** — set to **true** to fetch only new and updated records based on a timestamp column; you then supply the delta column name and its data type. Set to **false** to fetch all records on every run. ![The Source Details step scrolled to the Catalog Name, Schema Name and Table Name fields, followed by the Data Entity, Delta Queries Selection and Type options.](https://mintcdn.com/zeotap/eruOOrzoSjga8a0u/articles/integrate-customer/Storage/integrate-customer/create-a-databricks-source/create-a-databricks-source-step3-configure-source-details.png?fit=max\&auto=format\&n=eruOOrzoSjga8a0u\&q=85\&s=dc70b5feb94ab0a646cf6c509b73f77e) ### Step 4: Choose the connection type Under **Type**, select the mechanism used to pull the data: **JDBC** or **Job Based**. > [!NOTE] > > **Note** > > If you are ingesting more than 1 million records, use the **Job Based** approach. JDBC may encounter performance issues with large data volumes. ![The Type option on the Source Details step with Job Based selected, above the note about using the job-based approach beyond 1 million records.](https://mintcdn.com/zeotap/eruOOrzoSjga8a0u/articles/integrate-customer/Storage/integrate-customer/create-a-databricks-source/create-a-databricks-source-step4-authentication-type.png?fit=max\&auto=format\&n=eruOOrzoSjga8a0u\&q=85\&s=ed8f3a29b8b7b47e1f128b282c950419) Once you have chosen the Type, select the **Auth Type**. The options available differ depending on the connection type. ![The Auth Type dropdown on the Source Details step, shown below the Type selection and not yet expanded.](https://mintcdn.com/zeotap/eruOOrzoSjga8a0u/articles/integrate-customer/Storage/integrate-customer/create-a-databricks-source/create-a-databricks-source-step5-jdbc-auth.png?fit=max\&auto=format\&n=eruOOrzoSjga8a0u\&q=85\&s=59710ad29c88d454682e3f1bd8164432) ### Step 5: Enter the JDBC credentials If you selected **JDBC**, enter the following: | Field | Description | | :- | :- | | **Client ID** | The OAuth client ID from your Databricks service principal. | | **Client Secret** | The OAuth client secret associated with your service principal. | | **HTTP Path** | The HTTP path of your Databricks SQL warehouse. Found under **SQL Warehouses → Connection details**. | | **Partition Column** | Optional. A column used to split large datasets for parallel reads. Use a unique column if no partition column exists. | For guidance on obtaining these values, see [Prerequisites for JDBC Approach](/articles/integrate-customer/create-and-implement-a-databricks-source#prerequisites-for-jdbc-approach). ### Step 6: Enter the job-based credentials If you selected **Job Based**, choose the **Auth Type** and enter the corresponding values: **PAT Token** | Field | Description | | :- | :- | | **Access Token** | A personal access token generated from your Databricks account. Navigate to **Settings → User Settings → Developer → Generate new token**. | **Service Principal** | Field | Description | | :- | :- | | **Client ID** | The client ID of the Databricks service principal. | | **Client Secret** | The client secret associated with the service principal. | For guidance on obtaining these values, see [Prerequisites for Job Based Approach](/articles/integrate-customer/create-and-implement-a-databricks-source#prerequisites-for-job-based-approach). > [!WARNING] > > **Security notice** > > Keep all credentials — Client ID, Client Secret, and Pack Token — secure. Do not share them publicly or commit them to version control. ### Step 7: Select the columns and create the source Click **Next** to move to the **Filter** step. Zeotap CDP reads the table schema and lists the available columns; select the ones you want to ingest, then click **Create Source**. ## Verify the source Once the source is created, Zeotap CDP triggers the first pull automatically. **Step 1** Open the source. The header shows the connector and a status of **INTEGRATED**, and the **IMPLEMENTATION DETAILS** tab holds the configuration you submitted. **PREVIEW DATA**, **CATALOGUE MAPPING** and **SOURCE REPORT** cover the data itself. ![A created Databricks source showing the INTEGRATED status and the Implementation Details, Preview Data, Catalogue Mapping and Source Report tabs.](https://mintcdn.com/zeotap/eruOOrzoSjga8a0u/articles/integrate-customer/Storage/integrate-customer/create-a-databricks-source/create-a-databricks-source-step6-job-based-auth.png?fit=max\&auto=format\&n=eruOOrzoSjga8a0u\&q=85\&s=9a300c84bee51866edbcb2d6426db5ca) **Step 2** Go back to the Sources listing. The source appears with a status of **Integrated**, and the **Total Records Ingested** and **Last Ingested** columns tell you whether data has arrived yet. ![The Sources listing page with newly created Databricks sources showing the Integrated status alongside the Total Records Ingested and Last Ingested columns.](https://mintcdn.com/zeotap/eruOOrzoSjga8a0u/articles/integrate-customer/Storage/integrate-customer/create-a-databricks-source/create-a-databricks-source-step7-finalize.png?fit=max\&auto=format\&n=eruOOrzoSjga8a0u\&q=85\&s=483fe664fdff1d77b10be5a1d6d73a6f) > [!NOTE] > > **Note** > > The initial data transfer from Databricks to Zeotap CDP may take time depending on data volume. ## Troubleshoot a Databricks source **A column you selected does not appear when you map the source.** If every row in that column is empty in the Databricks table, the column is left out of the pull, so it never reaches mapping — even though the source configuration still lists it as selected. In Databricks, check whether the column actually holds values. If it should, populate it at source and wait for the next sync; if it should not, leave it unmapped. **A sync stops working after you change the table.** If a column configured on the source can no longer be resolved in the Databricks table, the pull cannot complete. Add the column in Databricks first, and only then configure it on the source. **Pulls are slow or appear to stall.** On large tables, use **Job Based** rather than JDBC. On a JDBC connection the query runs on your own Databricks SQL warehouse, so pull duration also depends on that warehouse's capacity and on how much other work is running on it at the time — worth checking before raising a ticket. If the problem persists, contact the Zeotap support team at [support@zeotap.com](mailto:support@zeotap.com) with the source name, the connection type you selected and the time of the failed sync. ## Next steps > [card] [Create and Implement a Databricks Source](/articles/integrate-customer/create-and-implement-a-databricks-source) > [card] [Databricks destination](/articles/integrate-customer/databricks_destination) > [card] [Create a Snowflake Source](/articles/integrate-customer/create-a-snowflake-source) > [card] [Create a BigQuery Source](/articles/integrate-customer/create-a-bigquery-source) # SFMC Journey Builder Source: https://docs.zeotap.com/articles/integrate-customer/sfmc-journey-builder Stream events from a Zeotap CDP journey out to a Salesforce Marketing Cloud Journey Builder journey in real time. The SFMC Journey Builder destination sends data **out of Zeotap CDP** to Salesforce Marketing Cloud: events from a workflow in Journeys are streamed in real time into a journey in Journey Builder. For Salesforce data travelling the other way — into Zeotap CDP — see the [Salesforce CRM source](/articles/integrate-customer/salesforce-crm). For the other Salesforce Marketing Cloud destinations, see [SFMC Personalization (Journeys)](/articles/integrate-customer/sfmc-personalization-journeys), [SFMC Personalization (Audiences)](/articles/integrate-customer/sfmc-personalization-audiences) and [Salesforce Marketing Cloud - Data Extension](/articles/integrate-customer/salesforce-marketing-cloud-data-extension). ## What this is Salesforce Marketing Cloud (SFMC) Journey Builder offers visibility into consumer interactions across various marketing channels, including email, mobile, social ads and more. By connecting these actions or conversations, you gain a deeper understanding of your customers, improve message building, design and automate campaigns, deliver a seamless customer experience, and secure customer loyalty. The Zeotap CDP integration is a real-time destination. You configure it once with the credentials of your Salesforce Marketing Cloud account, then attach it to a **Send to Destinations** node in a workflow. Each time a user reaches that node, Zeotap streams an event to one specific journey in Journey Builder — the journey identified by the Event Definition Key you supply. That journey's entry source is a data extension you create in SFMC, so the fields you map in Zeotap have to line up with the columns of that data extension. This is what lets marketers base SFMC campaigns on real-time data sent from Zeotap. ## Supported identifiers and actions This integration allows you to send any identifiers of your choice and custom attributes. | Action | What it does | | - | - | | **Stream Events to SFMC Journey Builder (Legacy)** | Sends an event, carrying the identifiers and attributes you mapped, to the Journey Builder journey named by the Event Definition Key. | ## Prerequisites > [!NOTE] > > Before you start, make sure that: > > * You have **Admin access** to Salesforce Marketing Cloud. Admin access is needed to reach all the features this integration uses. > * You have created a **data extension table** in SFMC with the relevant fields, to be used as the entry source in Journey Builder. See [Create a Data Extension Table](/articles/integrate-customer/appendix-for-sfmc-journey-builder#create-a-data-extension-table). > * You have created a **package** in SFMC and granted it the required API permissions. See [Create a Package](/articles/integrate-customer/appendix-for-sfmc-journey-builder#create-a-package). > * The journey you want to push data into has been **validated and saved** in Journey Builder. Validation confirms that all elements of the journey design are complete and ready for testing. Journey Testing is unavailable for Single Send journeys. > * You have collected the SFMC values listed in [Gather the SFMC details you need](#gather-the-sfmc-details-you-need). ## Gather the SFMC details you need Six values move from Salesforce Marketing Cloud into Zeotap CDP. Four of them belong to the destination itself; the last two belong to the journey you are targeting, so you supply them when you link the destination in a workflow. | Value | What it is | Where you enter it | | - | - | - | | Client ID | Part of the API Integration component of your installed package. | When you create the destination | | Client Secret | Part of the same API Integration component. | When you create the destination | | Sub Domain | The 28-character string, starting with `mc`, that appears in your base URIs. | When you create the destination | | Account ID | The member ID (MID) of your Salesforce Marketing Cloud account. | When you create the destination | | Event Definition Key | The unique identifier assigned to a journey in Journey Builder. It determines which journey receives the data. | When you link the destination in a workflow | | Contact Key | The unique ID from the data extension used as the entry source for Journey Builder, for example Email. This is typically the primary key of the data extension, but not always. | When you link the destination in a workflow. The same field must also be mapped under **Map the Fields** | ### Client ID, Client Secret and Sub Domain **Step 1** Log in to your SFMC account and open the package you created, under **Settings** > **Setup** > **Apps** > **Installed Packages**. **Step 2** Under **Components**, in the **API Integration** component, read off: a. **Client Id** \ \ b. **Client Secret** **Step 3** **Sub Domain** — your subdomain is a 28-character string that starts with the letters `mc` in any of your base URIs. In a REST base URI of the form `https://.rest.marketingcloudapis.com/`, the subdomain is the part that precedes `.rest.marketingcloudapis.com`. ### Account ID This is the member ID (MID) of your Salesforce Marketing Cloud account. You can obtain it in either of two ways. **Option 1** — log in to SFMC, hover over your account name in the top right corner, and copy the MID value. This is your `account_id`. ![The Salesforce Marketing Cloud account menu expanded, showing the account name and its MID.](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/sfmc-journey-builder/sfmc-journey-builder-2024-09-06-1.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=dec652c63a86b67817300c7000f2b959) **Option 2** — log in to SFMC and navigate to **Email Studio**. In the top navigation bar, click the **Admin** tab, then locate your **Account ID** under the **General Settings** section. ![The Admin tab of Email Studio in Salesforce Marketing Cloud, with the Account ID field outlined under General Settings.](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/sfmc-journey-builder/sfmc-journey-builder-2024-09-06-2.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=04388f1391173c2cc6dabba4d0ba4677) ### Event Definition Key **Step 1** Log in to SFMC and navigate to **Journey Builder**. **Step 2** In the top panel, click **Events** > **Entry Source**. **Step 3** Select the entry source of the journey you want to send data to. **Step 4** Find the event definition key under the **Properties** tab, as shown in the image below. ![The Define Entry Source wizard in Journey Builder, on the Properties step, with the Event Definition Key field outlined.](https://mintcdn.com/zeotap/kl8L6sBUYwhq5T7t/articles/integrate-customer/Storage/integrate-customer/sfmc-journey-builder/sfmc-journey-builder-2024-09-06-3.png?fit=max\&auto=format\&n=kl8L6sBUYwhq5T7t\&q=85\&s=2e3ca9c67a2210a8cd697a8ec8cafcb3) ## Create the SFMC Journey Builder destination A destination can be set up ahead of time from the **Destinations** module with **+ Create Destination** and reused, or created inline while you are building a workflow — both routes create the same object. The steps below take the inline route: after you have applied filters or added conditions for your users in Journeys, open **Send to Destinations**. A new window appears listing the destinations already available to you; pick one of those, or create a new one. ![The Send to Destinations panel in Zeotap CDP, showing the search box, the + Add New Destination link, and cards for destinations that already exist.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/sfmc-journey-builder/sfmc-journey-builder-2024-09-06-4.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=e805b028d90b2206df40a94fb6a88764) **Step 1** Click **+ Add New Destination**. **Step 2** Search for **SFMC Journey Builder** and select it. **Step 3** On the **Destination Details** step, enter a **Destination Name** that will identify this SFMC account later, then enter the **Client ID**, **Client Secret**, **Account ID** and **Sub Domain** you gathered. Click **Next**. ![The Enter Destination Details step of the SFMC Journey Builder destination form in Zeotap CDP, with the Destination Name, Client ID, Client Secret, Account ID and Sub Domain fields.](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/sfmc-journey-builder/sfmc-journey-builder-2024-09-06-5.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=26e3474a745e009e2eb7cd2419fccebf) **Step 4** On the **Mapping** step, under **Choose your Action**, select **Stream Events to SFMC Journey Builder (Legacy)**. Under **Map the Fields**, use **+ Add Mapping Field** to add as many identifiers and attributes as you want to send, mapping each Catalogue field to the matching Destination field. ![The Mapping step of the destination form, with Stream Events to SFMC Journey Builder (Legacy) chosen under Choose your Action and one Catalogue field mapped to a Destination field under Map the Fields.](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/sfmc-journey-builder/sfmc-journey-builder-2024-09-11.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=a082d10dd7b2c1fbda27f584507aecff) > [!NOTE] > > Each **Destination Field** name must match the attribute name in your data extension exactly. If the data extension has a column called `email`, the Destination field for the email data you send from Zeotap CDP must also be `email`. **Step 5** Click **Create Destination**. The destination is created and becomes available for activation on Journeys. ## Link the destination to a journey Creating the destination stores the connection to your SFMC account. Linking it inside a workflow is what points it at one specific journey. **Step 1** In the workflow, click **+** at the point where the node belongs and choose **Send to Destinations** from the **Choose an action** menu. ![The Choose an action menu on the journey canvas, with Send to Destinations outlined among the available node types.](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/sfmc-journey-builder/sfmc-journey-builder-2024-09-06-7.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=103329e05d26ff64a946f8ff0c86c78b) **Step 2** Find your destination in the list using the search box, and select it. ![The Send to Destinations panel with its search box outlined and destination cards listed beneath it.](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/sfmc-journey-builder/sfmc-journey-builder-2024-09-06-8.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=859ecf9420374c29bc76ba209c13c77c) **Step 3** Under the **Destination Details** tab, the **Client ID**, **Client Secret**, **Sub Domain** and **Account ID** fields are already populated from the destination you created. Enter the two journey-specific values: a. **Event Definition Key** — the key of the journey in Journey Builder that should receive this data. See [Event Definition Key](#event-definition-key). \ \ b. **Contact Key** — the unique ID from the data extension used as the entry source. This field must also be mapped under **Map the Fields**; if Email is your Contact Key, make sure Email is mapped. ![The SFMC Journey Builder destination dialog opened from a journey node, with the connection fields already populated and the Event Definition Key and Contact Key fields below them.](https://mintcdn.com/zeotap/kl8L6sBUYwhq5T7t/articles/integrate-customer/Storage/integrate-customer/sfmc-journey-builder/sfmc-journey-builder-2024-09-06-13.png?fit=max\&auto=format\&n=kl8L6sBUYwhq5T7t\&q=85\&s=2e28ebafb5ae38bcdf4ad2ba9b5120a0) **Step 4** Under the **Destination Settings** tab, choose the action and the mapping you want this node to use. **Step 5** Click **Save Destination**. The destination is attached to the node. ![The Send to Destinations panel with the SFMC Journey Builder destination attached, showing the destination name and the Stream Events to SFMC Journey Builder (Legacy) action.](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/sfmc-journey-builder/sfmc-journey-builder-2024-09-06-10.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=64c9a409d572ae07f7fdf96e1056320a) ## Verify the integration Check both ends before you rely on the node: 1. **In the Send to Destinations panel** — the attached destination card shows the destination name and the **Stream Events to SFMC Journey Builder (Legacy)** action, so you can confirm at a glance that the right destination and action are wired in. 2. **In Zeotap CDP** — once the workflow runs, open the **Execution Details** panel for the destination node. It records the failure status code, the timestamp, the destination name and a Request ID for any profile that did not make it through. See [Identify Journey Errors](/articles/orchestrate-customer/identify-journey-errors). 3. **In Salesforce Marketing Cloud** — open the journey whose Event Definition Key you entered and confirm it is receiving the contacts you expect. ## Troubleshoot the integration | Symptom | Likely cause | What to do | | - | - | - | | SFMC returns an `Insufficient Privileges error` | The installed package's API Integration component is missing the permissions this integration needs | Add the READ permissions listed in [Create a Package](/articles/integrate-customer/appendix-for-sfmc-journey-builder#create-a-package) to the package, then retry | | `AUTHENTICATION_ERROR` on the destination node | The credentials stored on the destination are no longer valid | Re-check the Client ID, Client Secret, Sub Domain and Account ID on the destination against your installed package. See [Journey Error Codes](/articles/orchestrate-customer/journey-error-codes) | | `BAD_REQUEST` or `EVENT_PARSING_FAILED` on the destination node | A mandatory field is missing from the payload, or the mapping does not produce what the destination expects. A null primary identifier is the most common cause of `BAD_REQUEST` | Open the field mapping for the node and check every mapped field, including the Contact Key field. See [Identify Journey Errors](/articles/orchestrate-customer/identify-journey-errors) | | Data does not land in the data extension as expected | The Destination field names in the mapping do not match the data extension's attribute names exactly | Compare the two name by name and correct the mapping | | The journey cannot be tested in Journey Builder | The journey has not been validated and saved, or it is a Single Send journey | Validate and save the journey first | If the destination is configured correctly and the failure persists, contact your Zeotap representative. Include the journey and the node that failed, the destination name, the Request ID from the Execution Details panel, and the timestamp of the failure. ## FAQ > [accordion] Which journey in Journey Builder receives the data? > > The one identified by the Event Definition Key. Because that key is entered when you link the destination in a workflow rather than when you create the destination, a single SFMC destination can feed different journeys from different workflows — each link supplies its own key. > [accordion] Do I have to create the destination from inside a workflow? > > No. A destination can be created ahead of time from the Destinations module and reused across audiences and journeys, or created inline from the Send to Destinations panel. Both routes create the same object and ask for the same details. See [Configure a destination](/articles/integrate-customer/destinations#configure-a-destination). > [accordion] Can I cap how often a user is sent to this destination? > > Yes. Gateway policies can be applied to destinations that trigger a message send, and SFMC Journey Builder with the Stream Events to SFMC Journey Builder (Legacy) action is one of them, under the Email message category. Destinations that do not trigger a message send — data exports, audience syncs — are not covered. See [Gateway](/articles/orchestrate-customer/gateway). ## Next steps * [Explore the appendix for SFMC Journey Builder →](/articles/integrate-customer/appendix-for-sfmc-journey-builder) * [Explore how destinations are configured and mapped →](/articles/integrate-customer/destinations) * [Explore journey error codes →](/articles/orchestrate-customer/journey-error-codes) * [Explore Gateway frequency policies →](/articles/orchestrate-customer/gateway) * [Explore the SFMC Personalization (Journeys) destination →](/articles/integrate-customer/sfmc-personalization-journeys) # SFMC Personalization (Audiences) Source: https://docs.zeotap.com/articles/integrate-customer/sfmc-personalization-audiences Send the User Profile objects of a Zeotap CDP audience out to Salesforce Marketing Cloud Personalization as CSV files over SFTP. ## What this is SFMC Personalization (Audiences) is a Zeotap CDP **destination**: data flows out of Zeotap CDP to Salesforce Marketing Cloud (SFMC) Personalization, delivering the [User Profile objects](https://help.salesforce.com/s/articleView?id=sf.mc_pers_user_profile_object.htm\&type=5) of an audience as CSV files to an SFTP account in your SFMC instance. Nothing flows back into Zeotap CDP from this integration. SFMC Personalization, formerly Interaction Studio, lets you visualise, track and manage customer experiences through real-time interaction management, so you can drive engagement at the right moment and tailored to your audience's preferences. Related Salesforce pages: * **Data into Zeotap CDP from Salesforce** — there is no Salesforce Marketing Cloud source. The Salesforce product that can be read into Zeotap CDP is the CRM: see [Salesforce CRM](/articles/integrate-customer/salesforce-crm). * **Other Salesforce Marketing Cloud destinations** — [SFMC Personalization (Journeys)](/articles/integrate-customer/sfmc-personalization-journeys) sends User Profile objects to the same Personalization product in real time from a Journeys workflow instead of in batch from an audience. [Salesforce Marketing Cloud - Data Extension](/articles/integrate-customer/salesforce-marketing-cloud-data-extension) and [SFMC Journey Builder](/articles/integrate-customer/sfmc-journey-builder) target other SFMC products. ## Supported identifiers and attributes This integration allows you to send any identifiers and attributes of your choice. However, **User ID** and **Object ID** are mandatory — the mapping step cannot be completed without both of them. > [!NOTE] > > **Note:** > > For more information about the limits and capabilities in Marketing Cloud Personalization, including user attribute limits per dataset, user profile object limits, and account profile attribute limits, refer [here](https://help.salesforce.com/s/articleView?id=sf.mc_pers_limits.htm\&type=5). ## Supported actions The following table lists the available action types for the integration and the supported features for each action type: | Action name | [ID EXTENSION](/articles/segment-customer/extend-your-audience#id-extension) | [DELETE](/articles/segment-customer/delta-upload-and-delete-functions) | [DELTA UPLOAD](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send attributes to SFMC Personalization | - | ✅ | - | ## Prerequisites Address the following before you start the integration: * **Create an SFTP account within SFMC.** For information about how to create one, refer [here](https://help.salesforce.com/s/articleView?id=sf.mc_pers_sftp_account_create.htm\&type=5). Obtain the Username, Password and SFTP Login URL — you provide these when you create the destination in Zeotap CDP. * **Configure your User Profile objects.** Enable the user profile object on the **Catalog and Profile Objects** page in your SFMC instance. * **Create a dataset.** In your SFMC Personalization instance, create a dataset with the related catalog objects and attributes before you map them in Zeotap CDP. This enables easy transfer of the corresponding data from Zeotap CDP. * **Build the audience to send.** In Zeotap CDP, have an audience ready to link to the destination. See [Create an Audience](/articles/segment-customer/create-an-audience). ## File requirements The audience is delivered to your SFTP account as CSV files. Those files must meet the following requirements. * **Format** — CSV file. * **Naming convention** — use the following format for the file name: `user-profile-objects-delta/replace>-.csv` * **ObjectTypeId** — represents the User Profile Object type in SFMC. For example, Lease or Mortgage. * **File mode** — `replace`. This replaces the existing data file with a new one each time you upload. * **Sorting** — sort files by identity (for example, `userId`). For multiple identities, ensure consistent identity values across rows for each user. * **Data handling** * Include all necessary information; empty fields may clear existing data. * Ensure that the upload file references only one object type per file. ### Sample file with multiple identifiers **Filename**: `user-profile-objects-Mortgage-delta-1.csv` In this example, create attributes such as start date, end date and active status in your SFMC instance before mapping those fields in Zeotap CDP. If you send data from Zeotap CDP to SFMC without first creating these attributes, the corresponding data will not populate. | **identityAttribute** | **objectId** | **attribute:startDate** | **attribute:endDate** | **attribute:APR** | **attribute:active** | **relatedCatalogObject:Mortgage** | **relatedCatalogObject:Product** | **remove** | | :- | :- | :- | :- | :- | :- | :- | :- | :- | | [john.doe@example.com](mailto:john.doe@example.com) | mortgage1 | 2022-01-01T00:00:00.000Z | 2024-01-01T00:00:00.000Z | 0.4 | TRUE | fixedRateMortgage | debitCard | | | [jane.doe@example.com](mailto:jane.doe@example.com) | mortgage2 | 2022-01-01T00:00:00.000Z | 2024-01-01T00:00:00.000Z | 0.25 | TRUE | adjustableRateMortgage | creditCard | | | user103925 | mortgage3 | 2022-01-01T00:00:00.000Z | 2026-01-01T00:00:00.000Z | 0.3 | TRUE | conventionalLoan | creditCard | | | personalizationuser | mortgage5 | | | | | | | TRUE | ## Create the SFMC Personalization destination Perform the following steps to create the destination: **Step 1** Log into the Zeotap CDP App and go to the **DESTINATIONS** application. **Step 2** Click **+ Create Destination.** ![Destinations listing in the Zeotap CDP app, showing the destination table, with the + Create Destination button highlighted at the top right.](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-audiences/sfmc-personalization-audiences-2024-09-26.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=8774c01844cb69d923ee91c5801e2300) **Step 3** Under the **All Destinations** section, search for **SFMC**. ![All Destinations catalogue in the Zeotap CDP app, with the Search for a Destination field highlighted above the grid of destination cards.](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-audiences/sfmc-personalization-audiences-2024-09-26-1.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=de0f15e151409a3f88db3e37892d8c2c) **Step 4** Click **SFMC - Personalization (Audience)**. A screen appears with details about the destination on the left and, on the right, the fields required to establish the integration. **Step 5** Enter a descriptive name for the Destination. **Step 6** Provide the **Object Type ID**. This represents your User Profile Object type in SFMC. For example, Lease or Mortgage. **Step 7** Under **SFTP Host**, provide the SFTP Login URL, then provide the **SFTP Username** and **SFTP Password** in the respective fields. You obtain all three when you create the SFTP account within your SFMC instance. [Learn more](#prerequisites) ![Enter Destination Details step of the SFMC Personalization destination in Zeotap CDP, with empty fields for Destination Name, Object Type ID, SFTP Host, SFTP Username and SFTP Password.](https://mintcdn.com/zeotap/4xl9wnXlFu0GG8Va/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-audiences/sfmc-personalization-audiences-2024-09-26-2.png?fit=max\&auto=format\&n=4xl9wnXlFu0GG8Va\&q=85\&s=3169072f82f9660fc02bcb17480c6c60) **Step 8** Click **Next** to proceed to the action and mapping step. **Step 9** Under **Choose your Action**, choose **Send attributes to SFMC Personalization**. Under **Map the Fields**, map the identifiers and attributes you want to send to your SFMC instance. You must map **User ID** and **Object ID**; otherwise, you cannot proceed. ![Mapping step of the SFMC Personalization destination, with Send attributes to SFMC Personalization chosen under Choose your Action and the User ID and Object ID destination fields marked as required under Map the Fields.](https://mintcdn.com/zeotap/kl8L6sBUYwhq5T7t/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-audiences/sfmc-personalization-audiences-2024-09-26-3.png?fit=max\&auto=format\&n=kl8L6sBUYwhq5T7t\&q=85\&s=133c8bc762ed8e03759b4c72d11ac4be) **Step 10** Click **Create Destination**. The destination is listed in the **Audiences** application, ready to be linked to an audience. For how destinations, actions and mappings fit together across Zeotap CDP, see [Configure a destination](/articles/integrate-customer/destinations#configure-a-destination) and [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). ## Link an audience to the destination For information about how to link an audience or segment to the created destination in the **Audiences** application, refer to [Activate Your Batch Audiences](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > **Note:** > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an Audience or a segment could be a specific group of customers who are over 18 years of age and who have performed an *`addToCart`* event within the last 30 days. ## Verify the delivery worked Check both sides once the audience is linked and the first refresh has run: 1. **In Zeotap CDP** — open the destination and review its activity. A successful delivery records a run with a non-zero qualified count and a completed status. See [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). 2. **In SFMC Personalization** — open the dataset you created for this integration and confirm the User Profile objects of the object type you configured are present, with the attributes you mapped populated. The two counts will not match exactly, but both should be non-zero and of the same order of magnitude. ## Troubleshoot SFMC Personalization deliveries | Symptom | Likely cause | What to do | | - | - | - | | **Create Destination** stays unavailable on the mapping step | **User ID** or **Object ID** is not mapped. | Map both. They are mandatory for the **Send attributes to SFMC Personalization** action. | | Objects arrive in SFMC but the attribute values do not populate | The attributes were not created in your SFMC Personalization instance before the data was sent. | Create the attributes in SFMC first — for example start date, end date and active status — then map them in Zeotap CDP and refresh the audience. | | Values that were present in SFMC are cleared after an upload | The file carried empty fields for those attributes. | Include all necessary information in the upload. Empty fields may clear existing data. | | Files do not reach SFMC at all | The SFTP Host, SFTP Username or SFTP Password on the destination does not match the SFTP account in your SFMC instance. | Re-read the SFTP Login URL, Username and Password from the SFTP account in SFMC and correct them on the destination. [Learn more](#prerequisites) | | The delivery fails before it reaches SFMC | A delivery-level failure on the audience–destination pair. | See [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail) for the errors that surface on the pair and what each one means. | ## FAQ > [accordion] Can I send more than one object type in a single file? > > No. Each upload file must reference only one object type. The Object Type ID is a destination-level field, so configure one destination per User Profile Object type you want to send — for example, one for Lease and one for Mortgage. > [accordion] How is this different from SFMC Personalization (Journeys)? > > Both destinations send User Profile objects to the same Personalization product, but by different routes. This page is the batch path: it is driven from an audience and delivers CSV files to an SFTP account, so it needs the SFTP Login URL, Username and Password. [SFMC Personalization (Journeys)](/articles/integrate-customer/sfmc-personalization-journeys) is the real-time path: it is driven from a Journeys workflow and calls the Personalization API, so it needs your Personalization account name, API instance, dataset and an API token instead. The mandatory mapping differs too: this destination requires **User ID** and **Object ID**, while the Journeys destination requires an identifier under **User Attribute** plus the **Profile Object ID**. > [accordion] Why do the attributes have to exist in SFMC first? > > The dataset, its related catalog objects and its attributes define what SFMC Personalization will accept. Data sent for an attribute that does not yet exist in the dataset has nowhere to land, so it does not populate. Creating the dataset and its attributes before you map fields in Zeotap CDP avoids a first refresh that delivers successfully but populates nothing. ## Next steps * [Create an audience to send →](/articles/segment-customer/create-an-audience) * [Activate the audience to this destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Understand delta uploads and delete functions →](/articles/segment-customer/delta-upload-and-delete-functions) * [Send the same profiles in real time from a Journeys workflow →](/articles/integrate-customer/sfmc-personalization-journeys) * [Send to a Marketing Cloud Data Extension instead →](/articles/integrate-customer/salesforce-marketing-cloud-data-extension) # SFMC Personalization (Journeys) Source: https://docs.zeotap.com/articles/integrate-customer/sfmc-personalization-journeys Send User Profile objects out of a Zeotap CDP Journeys workflow to Salesforce Marketing Cloud Personalization in real time. ## What this is SFMC Personalization (Journeys) is a Zeotap CDP **destination**: data flows out of Zeotap CDP to Salesforce Marketing Cloud (SFMC) Personalization, sending the [User Profile objects](https://help.salesforce.com/s/articleView?id=sf.mc_pers_user_profile_object.htm\&type=5) of users who qualify for a [workflow in Journeys](/articles/orchestrate-customer/create-a-workflow) to your SFMC Personalization instance as a real-time integration. Nothing flows back into Zeotap CDP from this integration. SFMC Personalization, formerly Interaction Studio, allows you to visualise, track and manage customer experiences through real-time interaction management. Using this, you can drive engagement at the right moment, tailored to your audience's preferences. Related Salesforce pages: * **Data into Zeotap CDP from Salesforce** — there is no Salesforce Marketing Cloud source. The Salesforce product that can be read into Zeotap CDP is the CRM: see [Salesforce CRM](/articles/integrate-customer/salesforce-crm). * **The same Personalization product, in batch** — [SFMC Personalization (Audiences)](/articles/integrate-customer/sfmc-personalization-audiences) sends User Profile objects from an audience instead of from a Journeys workflow. * **Other Salesforce Marketing Cloud destinations** — [SFMC Journey Builder](/articles/integrate-customer/sfmc-journey-builder) and [Salesforce Marketing Cloud - Data Extension](/articles/integrate-customer/salesforce-marketing-cloud-data-extension) target other SFMC products. ## Supported identifiers and actions This integration allows you to send any identifiers and attributes of your choice. Map an identifier under **User Attributes**, and mandatorily map the **Profile Object ID**, which appears under **Profile Object Attributes** in the mapping screen. **Profile Object ID** represents your User Profile Object type in SFMC. For example, Lease, Mortgage and so on. Under **Choose your Action**, select **Send attributes to SFMC Personalization** when you define the mapping. > [!NOTE] > > **Note:** > > For more information about the limits and capabilities in Marketing Cloud Personalization, including user attribute limits per dataset, user profile object limits, and account profile attribute limits, refer [here](https://help.salesforce.com/s/articleView?id=sf.mc_pers_limits.htm\&type=5). ## Prerequisites Ensure that you have addressed the following before starting the integration: * **Create a dataset.** In your SFMC Personalization instance, create a dataset with related catalog objects and attributes before mapping them in Zeotap CDP. This enables easy transfer of corresponding data from Zeotap CDP. * **Create an API token in SFMC.** You need an API token to authenticate requests on SFMC. The API token must be a strict Base64 encoding of your API Key ID and API Secret Key, separated by a colon. You can use an existing API token with the required permissions, or ask an administrator to create one in the Personalization UI under **Security > API Tokens > Create Token**. * **Build the Journeys workflow you want to activate from.** See [Create a Workflow](/articles/orchestrate-customer/create-a-workflow). ### Collect your SFMC Personalization details When you create the destination, Zeotap CDP asks for the following values from your SFMC instance. | Field | What it is | Where to get it | | :- | :- | :- | | **Account Name** | Your Personalization account name. | Access **Gears** in the Personalization UI and review the URL. For example, if the Gears URL is `https://testaccount.us-1.evergage.com/`, the account name is `testaccount`. | | **API Instance** | Your Personalization instance identifier. | The same Gears URL. In the example above, the instance identifier is `us-1`. | | **Dataset Name** | The name or identifier of the Personalization dataset to which you are sending data. | The dataset you created above. | | **API Username** | The API Key ID of your API token. | The API token you created above. | | **API Password** | The API Secret Key of your API token. | The API token you created above. | ## Create the SFMC Personalization (Journeys) destination You create this destination from inside a Journeys workflow. Once you have addressed the prerequisites, proceed to [creating a workflow in Journeys](/articles/orchestrate-customer/create-a-workflow). After you have applied filters or added conditions for your users, you can activate them in SFMC Personalization (Journeys) from the **Send to Destinations** node. ![Journeys workflow canvas with the Choose an action menu open below a Performed an event node. Send to Destinations is highlighted at the bottom of the menu, alongside Add a Condition, Add a Delay, Create a Multi-branch Split and Create a True/False Split.](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=8ed8abd70040c3e575c94c98ad4e6956) A new window appears, where you can set up your destination. You can use an already existing destination from the list of available Destinations, or create a new one by clicking **+ Add New Destination**. > [!NOTE] > > **Note:** > > To use an existing destination for activation in Journeys, see [Link the destination to a Journeys workflow](#link-the-destination-to-a-journeys-workflow). ![Send to Destinations panel listing the destinations already available in the workspace as a grid of cards, each showing its platform, with a Search field above the grid and + Add New Destination at the top right.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-25.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=9436e6620f33e4a53c427900a718e9a2) Perform the following steps to add a new destination: **Step 1** Click **+ Add New Destination** as shown below. ![Send to Destinations panel with the + Add New Destination link highlighted above the Search field and the grid of existing destination cards.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26-1.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=45aec566d6937bbb28613e4b880207c4) **Step 2** Search for **SFMC Personalization (Journeys)**. **Step 3** Click **SFMC Personalization (Journeys)** and enter a name for the Destination in **Destination Name**. **Step 4** Enter the **Account Name**, **API Instance** and **Dataset Name** obtained from your SFMC instance. [Learn more](#collect-your-sfmc-personalization-details) **Step 5** Provide the **API Username** and **API Password** for authenticating the API requests on SFMC. [Learn more](#collect-your-sfmc-personalization-details) ![Enter Destination Details step of the destination wizard, showing the Destination Details and Mapping progress markers above empty fields for Destination Name, Account Name, API Instance, Dataset Name and API Username.](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-25-1.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=2de798faea0c16cca777f5ab13cfb92e) **Step 6** Review the fields entered above and click **Next**. **Step 7** In the mapping screen that appears, under **Choose your Action**, select **Send attributes to SFMC Personalization** as the action for sending data from the workflow created in Journeys. Under **Map the Fields**, use **+ Add Mapping Field** to add any number of identifiers and attributes you wish to send to SFMC Personalization (Journeys). Note that you need to map an identifier under **User Attributes** and mandatorily map the **Profile Object ID**. Otherwise, you cannot proceed. ![Map the Fields screen with Catalogue Field and Destination Field columns. The User Attributes group offers + Add Mapping Field, and the Profile Object Attributes group shows a Choose Catalogue Attribute dropdown mapped to a Profile Object ID (string) destination field marked as required.](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-12-12-1.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=32f340bd17ad5ea74dcae6d541c112f7) **Step 8** Once the mapping is complete, click **Create Destination**. The destination is created and made available for activation on Journeys as shown below. ![Send to Destinations panel with the newly created SFMC - Personalization destination card selected in the grid of available destinations.](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26-2.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=267a44fc9b1c80ab0d5809bfc6aea66e) For how destinations, actions and mappings fit together across Zeotap CDP, see [Key concepts](/articles/integrate-customer/destinations#key-concepts) and [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). ## Link the destination to a Journeys workflow After creating a destination, you can link it in the **Send to Destination** node within the workflow, as explained below. **Step 1** Click the destination you created from the list of available destinations. ![Send to Destinations panel with an SFMC - Personalization destination card selected in the grid of available destinations.](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26-2.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=267a44fc9b1c80ab0d5809bfc6aea66e) **Step 2** Under the **Destination Details** tab, the **Account Name**, **API Instance**, **Dataset Name**, **API Username** and **API Password** fields are automatically populated based on the values that you entered while creating the destination. However, you need to enter the following node-specific inputs to save the Destination: * **Action Name** — the name of the action associated with the event. * **Profile Object Name** — the Object name associated with the event. **Step 3** Under the **Destination Settings** tab, choose the Action and mapping as per your requirement. **Step 4** Click **Save Destination**. The destination is attached as shown in the image below. ![Send to Destinations panel with the attached destination card at the top left, showing the destination name above an Untitled Mapping labelled Send attributes to SFMC Personalization.](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26-3.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=a9a980e7e294460ac438a8df0d54fb41) **Step 5** Click **Add Destinations**. You can also add multiple destinations at this step if needed. ![Send to Destinations panel with the attached destination card at the top and the full grid of available destinations below it, with the Add Destinations button highlighted at the bottom right beside Cancel.](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26-4.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=fd6df4739a5d2a393fd1c77112c833ff) **Step 6** The linked Destinations appear in the **Send to Destination** node within the workflow as shown below. You can then build and customise your workflow as needed by clicking **+**. Note that you must enter a name for your workflow in the provided text box to save it. ![Journeys workflow canvas with a named workflow, a Have Certain Attributes / IDs node, a Performed an event node and a Send to Destination node carrying the Salesforce icon, above the Cancel, Save Draft and Next: Define Re-entry Criteria buttons.](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26-7.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=b115f3bbc04540d675d2e9145a7f91d6) **Step 7** After adding conditions and filters for users, choose one of the following options: * **Save Draft**: Enables you to revisit and edit the workflow before publishing. * **Next: Define Re-entry Criteria**: Determines whether a user can re-enter the same workflow. **Step 8** After defining the re-entry criteria, click **Publish Workflow**. The workflow appears in the Workflow listing screen with a **Published** status. ![Re-entry conditions panel asking "Allow user to re-enter the journey?" with Yes and No options, above the Cancel, Save Draft and Publish Workflow buttons.](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sfmc-personalization-journeys/sfmc-personalization-journeys-2024-09-26-8.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=634ab0c131fbe99396837bc9f7b8fc91) For more about re-entry, see [Add Re-entry Criteria](/articles/orchestrate-customer/add-re-entry-criteria). ## Verify the workflow is delivering Once the workflow is published, check both sides: 1. **In Journeys** — confirm the workflow carries a **Published** status on the Workflow listing screen, then review the per-node counts. Metrics are available for all workflows in the published state and show how many users reached each node over the last 7 days, including the **Send to Destination** node. For the total number of users the workflow has sent out, rather than the node-level count, use the **ACTIVATED USERS** column on the listing screen. See [Understand Metrics](/articles/orchestrate-customer/understand-metrics). 2. **For a single user** — [Journey Traces](/articles/orchestrate-customer/journey-traces) shows how one user's event flowed through each node and what was ultimately delivered to each destination, which is the fastest way to confirm the mapping produced what you expected. 3. **In SFMC Personalization** — open the dataset you named in the destination and confirm the User Profile objects are present, with the attributes you mapped populated. ## Troubleshoot the SFMC Personalization (Journeys) destination | Symptom | Likely cause | What to do | | :- | :- | :- | | You cannot move past the mapping step when creating the destination | No identifier is mapped under **User Attributes**, or **Profile Object ID** is not mapped. | Map both. Use **+ Add Mapping Field** under **User Attributes** to add an identifier, and map a Catalogue field to **Profile Object ID**. | | **Save Destination** does not save the node configuration | **Action Name** or **Profile Object Name** is empty on the **Destination Details** tab. | Enter both. They are node-specific inputs and are not carried over from the destination you created. | | The workflow cannot be saved | The workflow has no name. | Enter a name for the workflow in the text box provided at the top of the canvas. | | User Profile objects are created under an object type you did not expect | The Catalogue field mapped to **Profile Object ID** is not carrying the object type you intended. | Check the mapping against the object types configured in your Personalization instance. | | Objects arrive in SFMC but the attribute values do not populate | The dataset's related catalog objects and attributes were not created in SFMC Personalization before the data was sent. | Create the dataset and its attributes in your SFMC Personalization instance first, then map them in Zeotap CDP. [Learn more](#prerequisites) | | The node reports `AUTHENTICATION_ERROR` | The credentials on the destination are not accepted by SFMC. | Re-read the API Key ID and API Secret Key from the API token in the Personalization UI and correct **API Username** and **API Password** on the destination. [Learn more](#collect-your-sfmc-personalization-details) | | The node reports `BAD_REQUEST` | Mandatory fields are missing or parameters are invalid in the request. | Review the mapping for the action and confirm every mandatory field is populated. | | Some users fail at the node, or all of them do | A node-level execution failure that is either isolated to certain profiles or global to the node. | Work out the scope first, then the cause: see [Determining if a Failure is Global or Isolated](/articles/orchestrate-customer/journey-troubleshooting#determining-if-a-failure-is-global-or-isolated) and [Identify Journey Errors](/articles/orchestrate-customer/identify-journey-errors). | The full list of codes that surface on a Journeys node, and what each one means, is in [Journey Error Codes](/articles/orchestrate-customer/journey-error-codes). ## FAQ > [accordion] How is this different from SFMC Personalization (Audiences)? > > Both destinations send User Profile objects to the same SFMC Personalization product, but by different routes. This page is the real-time path: it is driven from a Journeys workflow, is configured from the **Send to Destinations** node, and authenticates with your Personalization account name, API instance, dataset and an API token. [SFMC Personalization (Audiences)](/articles/integrate-customer/sfmc-personalization-audiences) is the batch path: it is driven from an audience, is configured from the **DESTINATIONS** application, and delivers CSV files to an SFTP account in your SFMC instance instead. ## Next steps * [Create a workflow in Journeys →](/articles/orchestrate-customer/create-a-workflow) * [Add re-entry criteria →](/articles/orchestrate-customer/add-re-entry-criteria) * [Understand workflow metrics →](/articles/orchestrate-customer/understand-metrics) * [Debug a single user with Journey Traces →](/articles/orchestrate-customer/journey-traces) * [Send the same profiles in batch from an audience →](/articles/integrate-customer/sfmc-personalization-audiences) * [Activate any real-time destination from Journeys →](/articles/integrate-customer/activate-your-real-time-audiences) # SFTP Audience Integration Source: https://docs.zeotap.com/articles/integrate-customer/sftp-audience-integration Configure an SFTP destination in Zeotap CDP to securely push audience files to your SFTP server for downstream targeting. ## What this is SFTP is a protocol for transferring files securely between a client and a server. An SFTP destination in Zeotap CDP writes each linked audience to a folder on your SFTP server as one or more CSV or JSON files, so your downstream systems can pick the files up and use them for targeting, suppression, or enrichment. Because the transfer is file-based, this destination is designed for batch audience delivery, not real-time event streaming — event data cannot be sent through it. ## Prerequisites > [!NOTE] > > Before you start, gather the following from your IT team. Each value maps directly to a field on the destination form. > > * **SFTP Host** — the server address (IP or domain) where the SFTP service runs. > * **SFTP Port** — the port the SFTP service listens on. > * **SFTP Username** — the account name for the SFTP session. > * **Authentication credential** — either the account **Password** or, for key-based authentication, permission to add Zeotap's SSH public key to the account. Zeotap uses SSH-2. > * **Folder** — the absolute path Zeotap will write to (for example `/home/user/data/`). Relative paths such as `../data/` are rejected. > * **Destination Instance Name** — an internal label you will assign to this destination. > * **PGP public key** (optional) — required only if you enable PGP encryption on the payload. For background, see [PGP encryption in destinations](/articles/integrate-customer/pgp-encryption-in-destinations). ## Configure the SFTP destination Follow these steps in the Zeotap CDP app. Every input on the form maps to a value from Prerequisites. **Step 1** Sign in to the Zeotap CDP app and open the **DESTINATIONS** application. ![Destinations application with the Create Destination button](https://mintcdn.com/zeotap/sBMx_EDYCwiX_b1v/articles/integrate-customer/Storage/integrate-customer/rtb-house/RTB_H1.png?fit=max\&auto=format\&n=sBMx_EDYCwiX_b1v\&q=85\&s=989bf48b86088d10e9d6c3b3b8bc0448) **Step 2** Click **+ Create Destination**, then under **All Destinations** search for and select **SFTP**. ![Searching for a destination under All Destinations](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/rtb-house/RTB_H2.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=4c1d1c71f84cc22f0a9975e76200c682) **Step 3** On the destination detail screen, enter the connection details on the right-hand panel: 1. Enter a name for the destination. 2. Fill in **SFTP Port**, **Destination Instance Name**, **SFTP Host**, and **SFTP Username** with the values from your IT team. 3. In **Folder**, enter the absolute path Zeotap should write to (for example `/home/user/data/`). 4. In **Filename Prefix**, enter a plain text value. Underscores (`_`), spaces, and the symbols `#`, `@`, `$`, `%`, `&`, and `*` are not permitted. ![Destination detail panel with connection and filename fields](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/integrate-customer/amazon-s3-destination/amazon-s3-destination-2025-08-06-1.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=9815ce4ace2add60e912e2a98028d8d4) Files are written to your folder using this naming pattern: ```text theme={null} ${filenamePrefix}part-${sequence}_${destinationAudienceId}_${timestamp}.csv ``` | Variable | Description | | :- | :- | | `filenamePrefix` | The prefix you entered on the form. | | `_json_` | Inserted between the prefix and the part sequence when the file is JSON. | | `part-${sequence}` | Chunk number when the audience is split across multiple files. | | `${destinationAudienceId}` | The ID Zeotap CDP assigns after you link the audience to this destination. | | `${timestamp}` | Generation time in `yyyyMMdd-hhmmssSSS` format. | | `.csv` / `.json` | File extension. | Example filenames: ```text theme={null} exportpart-01_894548842_20250113-113649855.csv export_JSON_part-0_14534354564740_20250113-113649855.json ``` **Step 4** Under **Authentication**, choose one option: * **SSH Key** — Zeotap displays an SSH public key. Copy it and add it to the authorized keys for your SFTP account. Zeotap uses SSH-2. * **Password** — Enter the password supplied by your IT team. ![Authentication panel showing the SSH public key option](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/sftp-audience-integration/sftp-audience-integration-2025-02-06.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=c197c8e8ad8e07d885bbbc0e803cd5fb) **Step 5** Under **Send Encrypted Data**, decide whether to encrypt the outgoing files with PGP. If you select **Yes**, upload the PGP **Public Key** on the same panel. ![Send Encrypted Data option with PGP public key upload](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/google-cloud-storage-2025-01-31.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=ee987cfe15afd49be9f5838c54d02e95) Review the values and click **Next**. **Step 6** On the **Actions and Mapping** screen, choose one action: * **Send CSV file to SFTP** * **Send JSON file to SFTP** Under **Map the Fields**, map the Catalogue fields you want to export to the destination fields. This destination transfers audience data only — event data cannot be sent through it. > [!WARNING] > > When you select **Send CSV file to SFTP**, nested objects are not flattened into separate columns. For example, an input field: > > ```json theme={null} > "order_shipped": { > "c_email": "test@example.com", > "c_prename": "test" > } > ``` > > produces a single column named `order_shipped` whose value is the raw JSON: > > ```json theme={null} > { > "c_email": "test@example.com", > "c_prename": "test" > } > ``` > > If your downstream system expects flat columns, switch to **Send JSON file to SFTP** or flatten the object in your Catalogue before mapping. **Step 7** Click **Create Destination**. The destination is added to the list in the **Audiences** application and can be linked to an audience. ## Link an audience to the destination Once the destination exists, link an audience to it from the **Audiences** application. See [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination) for the full flow. > [!NOTE] > > The terms *Audiences* and *Segments* refer to the same customer cohorts in Zeotap CDP — a group of customers who share a set of attributes or behaviours (for example, customers over 18 years of age who performed an `addToCart` event within the last 30 days). ## Verify the delivery After you link an audience and the first refresh runs, confirm the file arrived on your SFTP server: 1. Sign in to your SFTP server and open the folder you configured in the destination. 2. Look for a file whose name starts with your **Filename Prefix** and ends in `.csv` or `.json`, containing the `${destinationAudienceId}` assigned to the linked audience. 3. Open the file. The header row (CSV) or first record (JSON) contains the fields you mapped under **Map the Fields**. 4. If PGP encryption is enabled, decrypt the file with your private key before opening it — the file extension is unchanged. If the file is present and readable, the destination is delivering successfully. ## Troubleshoot common issues Use this table to map the condition you observe to the field to correct. Every row here is validated at setup or at file-generation time, before support involvement. | Error string | What it means | Where to look | | :- | :- | :- | | Folder path rejected during setup | The value entered is a relative path (for example `../data/`); Zeotap requires an absolute path such as `/home/user/data/` | Destinations → your SFTP destination → **Folder** | | Filename Prefix rejected during setup | The prefix contains a disallowed character — underscore (`_`), space, or one of `#`, `@`, `$`, `%`, `&`, `*` | Destinations → your SFTP destination → **Filename Prefix** | | SSH key authentication rejected at connect time | The SSH public key Zeotap displayed was not added to the account, or the server does not accept SSH-2 keys | Your SFTP server's authorized-keys configuration for the **SFTP Username** you supplied | | Password authentication rejected at connect time | The password stored on the destination does not match the account, or the account is locked | Destinations → your SFTP destination → **Authentication → Password**, and the account status on your SFTP server | | Event field cannot be mapped in **Map the Fields** | This destination transfers audience data only — event data is not supported | **Actions and Mapping → Map the Fields** | | CSV column contains raw JSON instead of flat columns | You selected **Send CSV file to SFTP** and mapped a nested object; the CSV action does not flatten nested objects | **Actions and Mapping → Choose your Action** — switch to **Send JSON file to SFTP**, or flatten the object upstream | If the file never appears in your folder after a linked audience has been refreshed, and none of the rows above match, contact Zeotap support. Include in your request: * The destination name and the linked audience name * The **Folder** path configured on the destination * The **SFTP Host**, **SFTP Port**, and **SFTP Username** on the destination (do not include the password or private key) * The `${destinationAudienceId}` shown on the linked audience * The expected timestamp of the last refresh in your time zone ## FAQ > [accordion] Can I send event data through the SFTP destination? > > No. This destination transfers audience data only. Event data must go through a destination that accepts event streams. > [accordion] Which SSH version does Zeotap use for key-based authentication? > > Zeotap uses SSH-2. Your SFTP server must accept an SSH-2 public key. > [accordion] Why does my CSV column contain a JSON blob instead of separate columns? > > The **Send CSV file to SFTP** action does not flatten nested objects — a nested field is written as one column whose value is the raw JSON. To get flat columns, switch to **Send JSON file to SFTP**, or flatten the object in your Catalogue before mapping. > [accordion] What format is the timestamp in the filename? > > The `${timestamp}` component uses the `yyyyMMdd-hhmmssSSS` format (for example `20250113-113649855`). ## Next steps * [Explore PGP encryption in destinations →](/articles/integrate-customer/pgp-encryption-in-destinations) * [Explore linking an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore the SFMC Personalization destination for a related SFTP-based flow →](/articles/integrate-customer/sfmc-personalization-audiences) # SFTP (Secure File Transfer Protocol) Source: https://docs.zeotap.com/articles/integrate-customer/sftp-secure-file-transfer-protocol Overview of the Zeotap CDP SFTP source — when to choose Push vs Pull, what data to prepare, and how to complete implementation. ## What this is The **SFTP (Secure File Transfer Protocol)** source lets you move batch data between your systems and Zeotap CDP over an SSH-encrypted channel. It belongs to the **Flat Files** category of sources and is the right choice when your upstream system produces CSV or JSON files rather than an event stream or API feed. SFTP comes in two variants — **Push** and **Pull** — and which one you pick depends on where the SFTP folder lives. ## Choose between SFTP (Push) and SFTP (Pull) Pick the variant that matches where your SFTP folder is hosted: | Variant | Who hosts the SFTP folder | Direction of data movement | Authentication you configure | | - | - | - | - | | **SFTP (Push)** | Zeotap CDP | You push files into the Zeotap-hosted folder | Credentials issued by Zeotap after source creation; PGP encryption is optional | | **SFTP (Pull)** | Your infrastructure | Zeotap CDP pulls files from your folder on a schedule | User ID + Password, or SSH keys (public and private) | If you do not run an SFTP server yourself and want the shortest path to onboarding, choose **SFTP (Push)**. If your data already lands on an SFTP endpoint you control and you want Zeotap CDP to fetch from it, choose **SFTP (Pull)**. ## Prerequisites > [!NOTE] > > Before you create an SFTP source, confirm the following: > > * **Data format** — Files are in **CSV** or **JSON**. > * **Identifiers** — Every record carries at least one identifier. For strong user matching, include both your organisation's first-party user ID (the same identifier you send from Web JS or App SDKs) and a digital identifier such as MAID. > * **Data entity decision** — You know whether the data is **Customer Data** or **Non Customer Data**. An account is capped at **five NCE sources**, and that cap counts both active and archived NCE sources. > * **For SFTP (Pull) only** — You have the **Host**, **Port**, **User Id**, credentials (password or SSH keys), and the **absolute** folder path on your SFTP server that Zeotap CDP will read from. > * **Support handoff** — You know that source creation completes with a support ticket. Zeotap Support finalises the implementation after you save the source in the UI. ## Prepare your data Your files must satisfy three constraints: 1. **Format** — CSV or JSON. For SFTP (Push), you also choose the **delimiter** and the upload **region** at source-creation time. 2. **Identifiers per record** — At least one. Pair a first-party ID with a digital identifier such as MAID to raise the match rate. 3. **Folder path** — When you configure SFTP (Pull), the **Folder** value must be an absolute path. Relative paths are rejected. ```text theme={null} Absolute path (accepted): /exports/customer-data/ Relative path (rejected): ../data/ ``` ## Create the source The step-by-step UI flow differs between Push and Pull, and each has its own page: * **[SFTP (Push) source](/articles/integrate-customer/creating-sftp-push-source)** — covers naming the source, picking the file format, choosing the delimiter and region, selecting **Customer Data** or **Non Customer Data**, and enabling **PGP Encrypted** if you want the PGP public key issued after creation. * **[SFTP (Pull) source](/articles/integrate-customer/create-an-sftp-pull-source)** — covers entering **User Id**, **Host**, **Port**, the absolute **Folder** path, the **Sync Frequency**, and the **Delta Query Selection** setting (set to `true` to fetch only files created since the previous pull, `false` to re-fetch every file on every run). > [!WARNING] > > Saving the source in the UI does not complete the integration on its own. After you create either variant, raise a ticket with Zeotap Support so the implementation can be finalised. Files sent or expected before that step are not ingested. ## Verify the source is set up You know the source is set up correctly when all of the following are true: * The new source appears in the **Sources** listing under **Integrate**, under the **Flat Files** category. * For **SFTP (Push)**: the source's **Implementation Details** include the SFTP credentials issued by Zeotap and — if you selected **PGP Encrypted: True** — a downloadable **PGP Public Key**. * For **SFTP (Pull)**: the credentials you provided authenticate against your server, and files placed in the configured folder are picked up on the next scheduled sync. * Your Zeotap Support contact has confirmed the implementation ticket is closed. Once files are flowing, map the data to the Catalogue so it can be used downstream. ## Troubleshooting Run through these checks before contacting support: * **The folder path is absolute.** A path like `../data/` is rejected; use a path that starts at the filesystem root of your SFTP server. * **Files match the declared format and delimiter.** A CSV source configured with a comma delimiter does not parse tab-separated files. * **Every record carries at least one identifier.** Records with no identifier cannot be matched. * **NCE source cap.** If source creation is blocked and the data entity is Non Customer Data, confirm you have fewer than five NCE sources (active + archived) in the account. * **Delta Query behaviour.** If SFTP (Pull) is re-fetching files you expected to be ingested only once, confirm **Delta Query Selection** is set to `true`. * **PGP mismatch.** If SFTP (Push) files fail to decrypt, confirm they were encrypted with the PGP public key downloaded from the source's **Implementation Details**. If the issue persists after these checks, raise a ticket with Zeotap Support and include the source name, the source type (Push or Pull), the timestamp of the affected transfer, and — for SFTP (Pull) — the exact folder path and authentication method you configured. ## FAQ > [accordion] Can I ingest event data through SFTP? > > The SFTP source is designed for batch files of customer or non-customer records in CSV or JSON. For event data, use the Web JS, App SDK, Server-to-Server, or Message Queue source categories instead. > [accordion] Do I need SSH keys, or can I use a password? > > SFTP (Pull) supports either **User ID + Password** or **SSH keys (public and private)**. Choose whichever your infrastructure team already manages. SFTP (Push) uses credentials issued by Zeotap after source creation. > [accordion] What is the difference between Customer Data and Non Customer Data? > > Customer Data describes people you want to unify into user profiles. Non Customer Data (NCE) covers reference or lookup entities — products, stores, campaigns — that enrich profiles without being profiles themselves. An account can hold up to five NCE sources; there is no equivalent cap on Customer Data sources. > [accordion] Why do I have to raise a support ticket after creating the source? > > Source creation in the UI captures your configuration, but the SFTP implementation — provisioning the Zeotap-hosted folder for Push, or connecting to your server for Pull — is completed by Zeotap Support. Raising the ticket triggers that final step. ## Next steps * [Explore how to create an SFTP (Push) source →](/articles/integrate-customer/creating-sftp-push-source) * [Explore how to create an SFTP (Pull) source →](/articles/integrate-customer/create-an-sftp-pull-source) * [Explore SFTP as an audience destination →](/articles/integrate-customer/sftp-audience-integration) * [Explore other Flat File source options →](/articles/integrate-customer/flat-files) * [Explore the full source creation guide →](/articles/get-started-guide/create-source) # Smadex Source: https://docs.zeotap.com/articles/integrate-customer/smadex Send batch audiences out of Zeotap CDP to Smadex, so they become targetable segments in your Smadex demand-side platform campaigns. ## What this is Smadex is a **batch destination**: data flows out of Zeotap CDP to Smadex, never the other way. Zeotap uploads audience segments to Smadex using the Smadex API, sending CSV files containing user data, so your audiences become targetable in your Smadex campaigns without manual exports or file transfers. Smadex is a mobile-first programmatic demand-side platform (DSP) for user acquisition, retargeting and branding campaigns. Because this is a batch destination, you attach it to an **audience**, not to a journey. Smadex sits under [Batch Integrations](/articles/integrate-customer/destination-batch-integrations) in the Destinations catalogue, and Zeotap CDP does not list Smadex among its sources — so this page covers the outbound direction only. ## Supported identifiers and actions Smadex supports the following ID types: | ID type | Description | | :- | :- | | Raw device ID | Unhashed mobile advertising ID (MAID). | | Hashed device ID | Hashed mobile advertising ID. | | IDFV | iOS Identifier for Vendors. | | IP | IP address. | The integration exposes a single action: **Smadex Audience Upload**. > [!NOTE] > > **Note:** > > Smadex accepts a single ID type per audience. Select the **ID type** under **Additional Settings** that corresponds to the identifier you map, and ensure it matches how your Smadex campaigns are configured. You cannot activate the same audience using a different identifier. In Smadex, uploaded audiences appear under the tab matching their ID type (**Device ID**, **IP** or **IDFV**). ## Prerequisites Before you create a Smadex destination in Zeotap CDP, make sure you have: * An active Smadex account with access to the Smadex platform (`hub.smadex.com`). * A **Smadex API Key**, used for Smadex API authentication. If you are unsure where to find your API Key, contact your Smadex account representative. * A Catalogue attribute that holds the identifier you intend to send, so it is available to map. * The upstream setup covered in the [Destinations prerequisites](/articles/integrate-customer/destinations#prerequisites). ## Create the Smadex destination **Step 1** In the Zeotap CDP app, go to **Integrate** > **Destinations**. **Step 2** Click **+ Create Destination**. **Step 3** Under **All Destinations**, search for **Smadex** and click the Smadex card (*Upload audience segments to Smadex*). ![The All Destinations search in Zeotap CDP with a partial search term typed, showing the Smadex destination card alongside another result.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/smadex/smadex-2026-07-06-1.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=3f897671ab30bbc6a4d97fc2f968d389) **Step 4** On the **Enter Destination Details** screen, enter the required details: a. Under **Destination Name**, enter a name for the destination. b. Under **Smadex API Key**, enter your Smadex API Key. ![The Enter Destination Details step for Smadex, showing the Destination Name field and the Smadex API Key field with its reveal toggle.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/smadex/smadex-2026-07-06-2.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=32ecdeebd2320afd08fa8586193f1e2e) c. Review the values and click **Next** to move to the **Mapping** step. **Step 5** On the **Mapping** step, under **Choose your Action**, select **Smadex Audience Upload**. ![The Mapping step with Smadex Audience Upload selected under Choose your Action, above an empty Map the Fields table.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/smadex/smadex-2026-07-06-3.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=4c0e1453c30c993ba432468b1ae632d7) **Step 6** Under **Map the Fields**, map the Catalogue attribute that holds your identifier (for example, **Maid**) to the **Identifier** destination field. Then, under **Additional Settings**, select the **ID type** that corresponds to the mapped identifier from the [supported identifiers](#supported-identifiers-and-actions) above. ![The Map the Fields table mapping the Maid Catalogue attribute to the required Identifier destination field, with ID type set to Raw device ID under Additional Settings.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/smadex/smadex-2026-07-06-4.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=b113b9c72d89480d55a461be4341f7b6) **Step 7** Click **Create Destination**. A confirmation message appears and the new destination is listed on the **Active Destinations** tab of the **Destinations** page, ready to be linked to an audience. ![The Active Destinations list with a success message, showing the newly created Smadex destination at the top of the table.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/smadex/smadex-2026-07-06-5.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=450b882a7daf7d0759f4da4cabc341c2) ## Link an audience to the destination > [!NOTE] > > **Note:** > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an Audience or a segment could be a specific group of customers who are over 18 years of age and who have performed an `addToCart` event within the last 30 days. In **Segment** > **Audiences**, [create the audience](/articles/segment-customer/create-an-audience) you want to send to Smadex: define the audience criteria as a **Batch** audience, click **Check Estimates** to review the estimated audience size, and save the audience. You can then attach the Smadex destination to it by dragging it from the **Select Destination** panel onto the canvas. ![The audience activation canvas in Segment, Audiences, with the Select Destination panel open on the right listing the Smadex destination among other destination cards.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/smadex/smadex-2026-07-06-6.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=c4fd5c386daf3fe6403700cc9fcda736) Open the destination and review **Destination Settings**, which show the action and the mapping you configured. Under **Refresh Frequency**, choose how often the audience is pushed — a one-time push, which pushes once on save with no recurring schedule, or a recurring schedule — then set the **Start Date**, optionally a specific time, and the **Timezone**. Click **Save Destination**. ![The Destination Settings tab of the Smadex destination, showing the mapped field and the Refresh Frequency section with One-time push selected, a Start Date, a specific time and a Timezone.](https://mintcdn.com/zeotap/wvUFdw6t_0UH99JT/articles/integrate-customer/Storage/integrate-customer/smadex/smadex-2026-07-06-7.png?fit=max\&auto=format\&n=wvUFdw6t_0UH99JT\&q=85\&s=36dcd9d558b48f140c04645f398a984d) Once the activation is saved, a confirmation message appears on the **Audiences** list. ![The Audiences list on the Batch tab after activation, showing a success message and the audience row with its Audience Status and Activation Status columns.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/smadex/smadex-2026-07-06-8.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=359bd16ea176438dd76695baf4debbee) > [!NOTE] > > **Note:** > > Every push delivers a **full refresh** of the audience to Smadex; incremental (delta) uploads are not sent. For the full activation walkthrough, including output identifiers and audience extensions, see [Activate Your Batch Audiences](/articles/integrate-customer/link-an-audience-to-the-destination). ## Verify the audience reached Smadex In Zeotap CDP, the audience row on the **Batch** tab of the **Audiences** list carries an **Audience Status** and an **Activation Status**; see [Audience Status and Activation Status](/articles/segment-customer/audience-status-and-activation-status) for what each value means. Once the audience is activated and the data is delivered, verify it in Smadex: **Step 1** Log into your **Smadex** account and go to **Audiences > My Audiences**. **Step 2** On the **My Audiences list** page, find the audience sent from Zeotap. Audiences are grouped under the tab that matches their ID type (**Device ID**, **IP** or **IDFV**), and the list shows the audience ID, name, number of **Active files**, **Type** and **Dev ID Type** (Raw or Hashed), along with the created and updated dates. ![The My Audiences list in Smadex with Device ID, IP and IDFV tabs, listing audiences with their Active files, Type and Dev ID Type columns.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/smadex/smadex-2026-07-06-9.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=05318e222853412a1da6f240216bf867) **Step 3** Open the audience to review its details and upload activity. The uploaded files sent by Zeotap are listed with names in the `Zeotap__.csv` format, along with the **Status** of each file. ![The Edit Audience screen in Smadex, listing uploaded CSV files with their Source, Description and Status columns.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/smadex/smadex-2026-07-06-10.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=f54da6ff3cc2a8514bcd4d0817e2fe70) > [!NOTE] > > **Note:** > > When a new file is uploaded, Smadex automatically removes the older files of the audience. This keeps the audience data fresh and prevents an incorrect audience count, so files showing a **DELETED** status after a new upload are expected and not an error. ## Troubleshoot the Smadex destination | What you see | Why it happens | What to do | | :- | :- | :- | | The audience is not on the tab you expected in Smadex (**Device ID**, **IP** or **IDFV**). | Smadex groups audiences by ID type, and the tab follows the **ID type** selected under **Additional Settings** on the destination mapping. | Confirm the **ID type** matches the identifier you mapped and how your Smadex campaigns are configured. Because Smadex accepts a single ID type per audience, you cannot re-activate the same audience with a different identifier. | | Older files in the Smadex audience show a **DELETED** status. | Smadex removes the older files of an audience when a new file is uploaded. | Nothing — this is expected after a new upload, not an error. | | A file in the Smadex audience shows a **FAILED** status. | That upload did not complete on the Smadex side. | Check the **Active files** count for the audience on the **My Audiences list**, then review the destination's delivery record in Zeotap — see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail). | | The audience in Smadex does not reflect a recent change to the audience in Zeotap. | Each push is a full refresh of the audience, and a destination saved with a one-time push does not push again. | Open **Destination Settings** for the audience–destination pair and check **Refresh Frequency**, the **Start Date** and the **Timezone**. | | The Smadex destination does not appear in the **Select Destination** panel when you link the audience. | A Destination Access Rule can block a destination for the folder the audience sits in. | See [Destination Access Rules](/articles/integrate-customer/destination-access-rules). | ## Next steps * [Explore batch audiences versus real-time audiences →](/articles/segment-customer/batch-audience-vs-real-time-audience) * [Activate your batch audiences →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Create a destination from the Destinations module →](/articles/integrate-customer/create-a-destination) * [Explore how destinations, actions and mappings fit together →](/articles/integrate-customer/destinations) * [Explore the other batch integrations →](/articles/integrate-customer/destination-batch-integrations) # Snapchat Source: https://docs.zeotap.com/articles/integrate-customer/snapchat Send Zeotap CDP audiences to a Snapchat Ad Account as a batch destination, after granting Zeotap access through Snapchat Business Settings. ## What this is Snapchat is a batch destination: Zeotap CDP sends audiences out of the platform to a Snapchat Ad Account, where they appear under **Assets → Audiences** in Snapchat Business Manager and can be targeted or suppressed in Snapchat campaigns. Data flows one way — from Zeotap CDP to Snapchat. Snapchat is a messaging application whose users exchange pictures and videos (called snaps) that are meant to disappear after they are viewed. Activating a Zeotap CDP audience here lets you reach a younger demographic and build interactive campaigns. This destination is authorised by a manual access-granting process: you invite Zeotap into your Snapchat Business Manager and grant it access to the specific Ad Accounts you want to push to. The separate [Snapchat OAuth 2.0](/articles/integrate-customer/snapchat-oauth-2-0) destination sends the same identifiers to the same place, but replaces that manual process with an authorisation flow you complete in a few clicks. ## Supported identifiers and actions This channel supports email-SHA256, Mobile-SHA256 and MAIDs. | Action name | [ID extension](/articles/segment-customer/extend-your-audience#id-extension) | [Delete](/articles/segment-customer/delta-upload-and-delete-functions) | [Delta upload](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send identifiers to Snapchat | ✅ | – | – | ## Prerequisites Have the following ready before you create the destination in Zeotap CDP: * **Your Snapchat Ad Account ID** — the ID of the Ad Account that will receive the audience. It appears in the **Ad Account ID** column under **Business Settings → Ad Accounts**. * **Zeotap granted access to that Ad Account** — complete [Grant Zeotap access to your Ad Account](#grant-zeotap-access-to-your-ad-account) first. Before you push segments to an Ad Account for the first time, Zeotap's Snap Business Manager account has to be linked to it. Once that link is in place you can create the destination and push segments. ## Grant Zeotap access to your Ad Account Granting access takes two steps: you invite Zeotap to join your Business Manager membership, then you give Zeotap access to the specific Ad Accounts that segments will be pushed to. ### Step 1 — Invite Zeotap to your membership **1. Open Business Settings in Ads Manager** Sign in to Snapchat [Ads Manager](https://ads.snapchat.com/) as an Admin, and under **Business Settings**, select **Members**. **2. Start the invitation** Click **Invite Member**. ![Snapchat Business Settings Members page with the Invite Member button highlighted and the Invite Member dialog open, showing its Name, Email and Role fields](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/Imported/snapchat-published-improvisation-img0004.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=932edbba54b6e0e98fa0a2768ad9c749) **3. Enter the member details** Fill in the dialog as follows: * **Name**: Zeotap_User_Name * **Email**: [channel.admin@zeotap.com](mailto:channel.admin@zeotap.com) * **Role**: Member **4. Send the invitation** Click **Invite Member**. > [!NOTE] > > An email invite is sent to Zeotap for confirmation. It contains details about the membership and a link to **Join**. ### Step 2 — Give Zeotap access to the Ad Account Once Zeotap has accepted the request to join, grant access to each Ad Account that segments will be pushed to. **1. Open the Ad Accounts list** Sign in to [Ads Manager](https://ads.snapchat.com/) and, under **Business Settings**, select **Ad Accounts**. ![Snapchat Business Settings Ad Accounts page with Ad Accounts highlighted in the left navigation, listing accounts by Account Name, Ad Account ID, Account Type and Account Status](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/Imported/snapchat-published-improvisation-img0005.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=b666443fe141b6bc331052e9d6f6d618) **2. Open the account's member settings** Select the Ad Account and go to **Members and Billing**. ![The Members and Billing tab of a Snapchat Ad Account, with a field to link new members, a role selector and an Add Member button above a Payment Methods section](https://mintcdn.com/zeotap/-spfyJZUUrgjpAOo/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/Imported/snapchat-published-improvisation-img0006.png?fit=max\&auto=format\&n=-spfyJZUUrgjpAOo\&q=85\&s=1bf40ce7dcf2e74ace1e26d68aefd871) **3. Link the Zeotap member** Under **Members**, enter [channel.admin@zeotap.com](mailto:channel.admin@zeotap.com) in the **Type to link new members...** field, choose a role in the **Select role...** dropdown, and click **Add Member**. ## Create the Snapchat destination **1. Open the Destinations application** Sign in to the Zeotap CDP app and go to **Integrate → Destinations**. **2. Start a new destination** Click **+ Create Destination**. ![The Destinations list in Zeotap CDP, with Private Destination and Public Destination tabs, a search box and the + Create Destination button highlighted](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/s4m/Destinations_all_1.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=135c601e72be8861a3b3670e7c377aff) **3. Select Snapchat** Under **All Destinations**, search for **Snapchat**. ![The All Destinations catalogue in Zeotap CDP with the search box highlighted above a grid of destination tiles](https://mintcdn.com/zeotap/sBMx_EDYCwiX_b1v/articles/integrate-customer/Storage/integrate-customer/s4m/Destinations_all_2.png?fit=max\&auto=format\&n=sBMx_EDYCwiX_b1v\&q=85\&s=0754c153bcfb10821185d9ecc8920122) **4. Enter the destination details** Click **Snapchat**, then on the **Enter Destination Details** screen: 1. In **Destination Name**, enter a name that identifies this destination in your Destinations list. 2. In **Ad Account Id**, enter the Snapchat Ad Account ID linked to your Business Manager. 3. Click **Next** to proceed to mapping. ![The Enter Destination Details step of the Snapchat destination in Zeotap CDP, showing the Destination Name and Ad Account Id fields, the Snapchat description panel, and the Back and Next buttons](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/snapchat/snapchat-2023-11-09.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=508adcc8b87f50c12fc45cfd2447755c) **5. Choose the action and map the identifiers** Name the mapping, then: 1. Choose the desired [action](/articles/integrate-customer/destinations#configure-a-destination) under **Choose your Action**, and choose the corresponding identifiers under **Map the Fields**. By default, the [Output Identifiers](/articles/segment-customer/choose-the-output-identifiers) that are accepted by the platform — such as MAIDs, Cookies, email Ids and more — are displayed. You can edit, add or remove an identifier from the list; to do so, see [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). 2. Click **Create Destination**. The created destination is listed in the **Target** and **Audiences** applications, where it can be linked to an audience or segment. ![The Mapping step of the Snapchat destination, with Send identifiers to Snapchat chosen under Choose your Action and an output-identifier mapping table pairing a Catalogue Field with a Destination Field](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/snapchat/snapchat-2023-11-09-1.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=7e5c4d14fcf4c32a423c16029278d631) ## Link an audience to the destination Link the audience or segment to the Snapchat destination in the **Audiences** and **Target** applications. For the procedure, see [Link an Audience to the Destination](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience or a segment can be a specific group of customers who are over 18 years of age and have performed an `addToCart` event within the last 30 days. ## Verify the audience reached Snapchat Allow up to 24 hours after linking for the segment to become available at the Snapchat seat. To confirm it arrived, open Snapchat Business Manager and go to **Assets → Audiences**. The pushed segments are listed there. ![The Snapchat Business Manager navigation menu with Assets → Audiences highlighted, over the Audiences list showing columns for Retention in Days, Created On and Actions](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/Imported/snapchat-published-improvisation-img0003.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=187933c3ad2615612f505d90dec00331) ## Next steps * [Explore the Snapchat OAuth 2.0 destination →](/articles/integrate-customer/snapchat-oauth-2-0) to connect a Snapchat Ads account through an authorisation flow instead of the manual access-granting process on this page * [Explore linking an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore choosing the output identifiers →](/articles/segment-customer/choose-the-output-identifiers) * [Explore ID extension to widen audience reach →](/articles/segment-customer/extend-your-audience#id-extension) # Snapchat OAuth 2.0 Source: https://docs.zeotap.com/articles/integrate-customer/snapchat-oauth-2-0 Send audiences from Zeotap CDP to a Snapchat ad account using the OAuth 2.0 authorisation flow, with no manual whitelisting step. ## What this is The Snapchat OAuth 2.0 destination sends audiences **out of Zeotap CDP and into a Snapchat ad account**, where they arrive as audiences you can target from Snapchat Ads Manager. It is a batch destination: you link it to an audience, not to a journey. Snapchat is a messaging application that lets users exchange pictures and videos (called snaps) that are meant to disappear after they are viewed. Integrated with Zeotap it allows marketers to reach a younger demographic and create engaging and interactive campaigns. This destination connects your Snapchat Ads account to Zeotap through an OAuth 2.0 authorisation flow. Previously, clients had to complete a manual **whitelisting process** — inviting Zeotap to their Business Manager and granting Ad Account access. For this destination that step is replaced by an authorisation flow you complete yourself in a few clicks while creating the destination. Zeotap also documents a separate [Snapchat destination](/articles/integrate-customer/snapchat), which uses the manual whitelisting route rather than OAuth 2.0. ## Supported identifiers and actions This channel supports email-SHA256, Mobile-SHA256 and MAIDs. The following table lists the available action types for the integration and the supported features for each action type: | Action Name | [ID EXTENSION](/articles/segment-customer/extend-your-audience#id-extension) | [DELETE](/articles/segment-customer/delta-upload-and-delete-functions) | [DELTA UPLOAD](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Send identifiers to Snapchat | ✅ | - | - | ## Prerequisites Before you create the destination, have the following ready: * **Ad Account Id** — the 16-digit Snapchat Ad account ID linked to your Business Manager. The ID number appears next to your Ad Account's name under **Ad Account ID**. * **A Snapchat sign-in with Ads Manager access** — you complete the authorisation flow yourself, so sign in with a Snapchat account that has access to Ads Manager for that ad account. * **An audience to activate**, plus the upstream source and Catalogue mapping it depends on. See the [destination prerequisites](/articles/integrate-customer/destinations#prerequisites). ## Create the Snapchat OAuth 2.0 destination **Step 1** Log in to the Zeotap CDP App and go to **Integrate** > **Destinations**. **Step 2** Click **+ Create Destination**. ![The Destinations list in Zeotap CDP, with the + Create Destination button highlighted above the table of existing destinations.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/s4m/Destinations_all_1.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=135c601e72be8861a3b3670e7c377aff) **Step 3** Under **All Destinations**, search for Snapchat and select **Snapchat OAuth 2.0**. ![The All Destinations catalogue, with the Search for a Destination box highlighted above the grid of destination tiles.](https://mintcdn.com/zeotap/sBMx_EDYCwiX_b1v/articles/integrate-customer/Storage/integrate-customer/s4m/Destinations_all_2.png?fit=max\&auto=format\&n=sBMx_EDYCwiX_b1v\&q=85\&s=0754c153bcfb10821185d9ecc8920122) **Step 4** On **Enter Destination Details**, fill in the two fields and authorise the connection: a. In **Destination Name**, enter a name for the destination so you can identify it later. b. In **Ad Account Id**, enter the 16-digit Snapchat Ad account ID on which the segment has been requested. c. Click **Connect Snapchat OAuth 2.0**. You are redirected to the Snapchat sign-in page — sign in with an account that has access to Ads Manager, then follow the on-screen prompts to allow the permissions. ![The Enter Destination Details step for Snapchat OAuth 2.0, showing the Destination Name and Ad Account Id fields with their placeholder text above the Connect Snapchat OAuth 2.0 button.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/snapchat-oauth-2-0/snapchat-oauth-2-0-2025-09-22.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=d2689f9b7badcfc877fd37833116ac92) d. Once the Snapchat account is connected, click **Next** to go to **Mapping**. **Step 5** On the **Mapping** screen, choose the action and define the mapping: a. Under **Choose your Action**, select **Send identifiers to Snapchat**. Under **Map the Fields**, map your Catalogue fields to the destination fields. Zeotap pre-populates the [output identifiers](/articles/segment-customer/choose-the-output-identifiers) that Snapchat accepts — MAID, Email and Mobile in the capture below — and you can edit, add or remove an identifier from the list. For how mappings work, see [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). b. Click **Create Destination**. The destination is then listed in the **Target** and **Audiences** applications, where it can be linked to an audience. ![The Mapping screen, with Send identifiers to Snapchat selected under Choose your Action and three Output Identifiers Mapping rows under Map the Fields.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/snapchat-oauth-2-0/snapchat-oauth-2-0-2025-09-22-1.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=dfa7901cf4439b348a02f8c960966f5b) ## Link an audience to the destination For how to link an audience or segment to the created destination in the **Audiences** and **Target** applications, see [Activate Your Batch Audiences](/articles/integrate-customer/link-an-audience-to-the-destination). It can take up to 24 hours for the segment to be available at the Snapchat seat. > [!NOTE] > > **Note:** > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an Audience or a segment can be a specific group of customers who are over 18 years of age and have performed an `addToCart` event within the last 30 days. ## Verify the audience reached Snapchat Check both sides of the delivery: 1. **In Zeotap** — open the destination and review its latest run. See [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). 2. **In Snapchat** — in Snapchat Ads Manager, find the pushed audiences under **Assets** → **Audiences**. ![The Snapchat Ads Manager navigation menu expanded, with Audiences highlighted under the Assets column, over the audience list behind it.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/shared-destination-assets/Imported/snapchat-published-improvisation-img0003.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=187933c3ad2615612f505d90dec00331) ## Troubleshoot the Snapchat OAuth 2.0 destination * **The audience has not appeared in Snapchat yet.** Allow up to 24 hours after activation for the segment to be available at the Snapchat seat before treating it as a failure. * **The counts in Zeotap and Snapchat do not match.** They are not expected to match exactly — Snapchat applies its own match-rate filtering to the identifiers it receives. Both counts should be non-zero and in the same order of magnitude. * **The activation recorded an error.** Look up the error text in [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail), which covers the platform- and configuration-level errors you can act on directly. If the error is not listed there, see [When to contact support](/articles/integrate-customer/destinations#when-to-contact-support) for what to include in the request. ## Next steps * [Snapchat](/articles/integrate-customer/snapchat) — the Snapchat destination that uses the manual whitelisting route instead of OAuth 2.0. * [Activate Your Batch Audiences](/articles/integrate-customer/link-an-audience-to-the-destination) — link this destination to an audience. * [Destinations](/articles/integrate-customer/destinations) — how actions, mappings and activation work across every destination. * [Delta Upload and Delete Functions](/articles/segment-customer/delta-upload-and-delete-functions) — how Zeotap handles full and incremental uploads on audience refreshes. # Snowflake Source: https://docs.zeotap.com/articles/integrate-customer/snowflake The Snowflake source brings data from a table in your own Snowflake account into Zeotap CDP on the sync frequency you choose. To send data the other way, out of Zeotap CDP and into Snowflake, use the Snowflake destination. ## What this is The Snowflake **source** brings data *into* Zeotap CDP: you connect Zeotap CDP directly to a table that already sits in your own Snowflake account, and Zeotap CDP reads records from it on the **Sync Frequency** you set. To send data the other way, *out* of Zeotap CDP and into Snowflake, use the [Snowflake destination](/articles/integrate-customer/snowflake-destination) instead; the two are separate integrations that point in opposite directions. Snowflake is one of the [Data Warehouse](/articles/integrate-customer/data-warehouse) sources, alongside BigQuery, Amazon S3, Databricks and Microsoft Fabric. Like the rest of that category it carries both **Customer Data (CE)** and **Non-Customer Entity (NCE)** data, so the same connector covers customer profiles and the reference data around them. ## Prerequisites > [!NOTE] > > Before you create a Snowflake source, confirm: > > * You have a Snowflake account, and the data you want to import into Zeotap CDP already resides in it. > * You have the connection details the source form asks for — **Username**, **Password**, **Account Name**, **Warehouse**, **Database**, **Schema** and **Table**. [Create a Snowflake Source and Load Data](/articles/integrate-customer/create-a-snowflake-source) shows where to find each one in the Snowflake console. > * The warehouse you connect is in **Started** (Active) status. ## How the Snowflake source works You create the source under **Data Warehouse**, point it at one table in your own Snowflake account with the connection details Snowflake issues, and choose how often Zeotap CDP re-reads it. [Create a Snowflake Source](/articles/integrate-customer/create-a-snowflake-source) documents every field and the delta-fetch setup. ## In this section > [card] [Create a Snowflake Source and Load Data](/articles/integrate-customer/create-a-snowflake-source) > [card] [Best Practices for Snowflake Source](/articles/integrate-customer/best-practices-for-snowflake-source) > [card] [Error Handling and More](/articles/integrate-customer/snowflake-source-error-handling-and-more) > [card] [FAQs for Snowflake](/articles/integrate-customer/faqs-for-snowflake) ## Next steps * [Create a Snowflake source and load data into it →](/articles/integrate-customer/create-a-snowflake-source) * [Send data out of Zeotap CDP into Snowflake with the Snowflake destination →](/articles/integrate-customer/snowflake-destination) * [Explore the Data Warehouse source category →](/articles/integrate-customer/data-warehouse) * [Explore every source integration Zeotap CDP supports →](/articles/integrate-customer/creating-a-source) * [Explore Sources →](/articles/integrate-customer/sources) # Snowflake Source: https://docs.zeotap.com/articles/integrate-customer/snowflake-destination Send audiences and journey data out of Zeotap CDP into Snowflake, staged through a Google Cloud Storage bucket and auto-ingested with Snowpipe. ## What this is Snowflake is a Zeotap CDP **destination**: data flows **out** of Zeotap CDP and into your Snowflake account. To move data the other way — importing data that already lives in Snowflake into Zeotap CDP — see the [Snowflake source](/articles/integrate-customer/snowflake). Snowflake is a cloud-based data warehousing platform designed for scalable data storage, processing, and analytics. It is known for its flexibility, performance, and ease of use in handling large volumes of structured and semi-structured data. Integrated with Zeotap CDP, it allows you to send batched and real-time data based on the audiences (segments) and workflows created in Zeotap CDP. Delivery runs in two hops. You establish a connection between your Google Cloud Storage (GCS) bucket and your Snowflake account. Zeotap CDP pushes data to your GCS bucket, where you can set up automation to receive data either in batches at fixed intervals or in real time by configuring a Pub/Sub notification for the bucket. > [!NOTE] > > *Audiences* and *Segments* refer to the same thing throughout the Zeotap CDP UI — a group of customer profiles that match a set of criteria you define. ## Prerequisites > [!NOTE] > > Before you begin with the integration, ensure you have the following: > > * A **Google Cloud Storage bucket** for storing your data files. > * A **Pub/Sub topic** to enable notifications for automating data loading. > * A **Snowflake account**, together with the database, schema, and table where the data should land. ## Supported identifiers and actions Use this integration to send any number of identifiers and attributes to Snowflake. However, sending event attributes when transferring data from audiences to Snowflake is not supported. | Action | Delivery | Linked to | | :- | :- | :- | | **Send data to Snowflake** | Batched data | An audience in the **Audiences** application | | **Stream data to Snowflake** | Real-time data | A workflow in the **Journeys** application | With **Stream data to Snowflake**, you enable batching in the action to aggregate real-time data before sending it to Snowflake. Batching occurs based on two factors: Batch duration and Record count, whichever is met first. For example, if you set the batch duration to 2 minutes and the Record Count to 100, then the file is generated and sent when either condition is met. ## How the integration works This architecture illustrates the integration of Snowflake with Zeotap CDP Infrastructure. ![Architecture diagram showing Zeotap CDP writing data to a Google Cloud Storage bucket, from which Snowflake ingests it](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/snowflake-destination/snowflake-destination-2025-01-27-1.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=e074fed17fc74b1a1c5a331107da7df4) ### Storage integration Storage Integration is a feature in Snowflake that securely connects Snowflake with external cloud storage systems, such as Google Cloud Storage (GCS). This integration enables Snowflake to access and interact with external storage securely and efficiently. Permissions required for the `STORAGE_GCP_SERVICE_ACCOUNT`: * **Storage Object User** * **Storage Insights Collector Service** ### Notification integration Notification Integration enables Snowflake to automatically detect and respond to new data in external storage for auto-ingest scenarios like Snowpipe. This integration works by sending notifications (for example, through Pub/Sub) when new data is available, triggering the data loading process. Without this integration, Snowflake would rely on manual processes or continuous pulling, which is less efficient. Permissions required for the `GCP_PUBSUB_SERVICE_ACCOUNT`: * **Pub/Sub Subscriber** * **Monitoring Viewer** > [!NOTE] > > The bucket-side and Pub/Sub-side grants are covered in [Connect Snowflake to your Google Cloud Storage bucket](#connect-snowflake-to-your-google-cloud-storage-bucket). ## Connect Snowflake to your Google Cloud Storage bucket An integration in Snowflake securely connects Snowflake to external cloud storage, such as Google Cloud Storage (GCS). Snowflake creates a service account for the integration, which you use to grant access to your GCS bucket. This service account acts as a secure link between Snowflake and GCS. Complete the following sections in order before you create the destination in Zeotap CDP. ### Run the SQL commands in a Snowflake worksheet Every Snowflake command in this procedure runs in a SQL worksheet in the Snowflake console. **Step 1** In the Snowflake console, navigate to **Projects** > **Worksheets**. **Step 2** Click **create New SQL** worksheet. ![Creating a new SQL worksheet under Projects in the Snowflake console](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/snowflake-destination/snowflake-destination-2025-01-29-10.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=c14524016326971994dc989472251212) **Step 3** Choose the **Database** and **Schema** where you want to send the data, as shown below. ![Selecting the target database and schema for the SQL worksheet](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/snowflake-destination/snowflake-destination-2025-01-29-11.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=c1c34f30af571dbb71156187602ff83c) **Step 4** Enter the command you want to run and click the **Run** button. In this example, the provided command is used to create the storage integration. ![Running a command from a Snowflake SQL worksheet using the Run button](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/snowflake-destination/snowflake-destination-2025-01-29-13.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=7a2ef9f6bae89f440071ac7251f52fa0) ### Create a storage integration in Snowflake To connect Snowflake to your GCS bucket, create a storage integration object. This defines the connection and permissions. Run the following command in the [Snowflake SQL worksheet](#run-the-sql-commands-in-a-snowflake-worksheet) to create the storage integration: ```sql theme={null} CREATE STORAGE INTEGRATION TYPE = EXTERNAL_STAGE STORAGE_PROVIDER = GCS ENABLED = TRUE STORAGE_ALLOWED_LOCATIONS = ('gcs:///'); ``` * Replace `` with a name for your integration (for example, `my_gcs_integration`). * Replace `` with the name of your GCS bucket. ![CREATE STORAGE INTEGRATION command run in a Snowflake SQL worksheet](https://mintcdn.com/zeotap/IaZjYE7XwRssOe8Q/articles/integrate-customer/Storage/integrate-customer/snowflake-destination/snowflake-destination-2025-01-29-9.png?fit=max\&auto=format\&n=IaZjYE7XwRssOe8Q\&q=85\&s=ee1165ccc9ab29372924d47172b8c332) After creating the integration, retrieve its details using: ```sql theme={null} DESC STORAGE INTEGRATION ; ``` > [!NOTE] > > Note the `STORAGE_GCP_SERVICE_ACCOUNT` value, which is the service account Snowflake created for the integration. You need this to grant permissions to the bucket, as described in [Grant the storage service account access to the bucket](#grant-the-storage-service-account-access-to-the-bucket). ### Grant the storage service account access to the bucket The GCS bucket resides at your end, so you need to grant access to the Snowflake service account created in the previous section (`STORAGE_GCP_SERVICE_ACCOUNT`). To do so, perform the following steps: **Step 1** Open the Google Cloud Console. **Step 2** In the left panel, navigate to your **Cloud Storage** > **Buckets**. **Step 3** Select your GCS bucket and go to the **PERMISSIONS** tab. **Step 4** Under **VIEW BY PRINCIPALS**, click **GRANT ACCESS**. **Step 5** Under **Add principals**, add the service account (`STORAGE_GCP_SERVICE_ACCOUNT`) as a new principal, select the custom role you have created, and assign the following roles to it: * `storage.buckets.get` * `storage.objects.update` * `storage.objects.get` * `storage.objects.list` * `storage.objects.delete` * `storage.objects.restore` > [!NOTE] > > For information about how to create a custom role in the Google Cloud Console, see the [Google Cloud documentation](https://cloud.google.com/iam/docs/creating-custom-roles#creating). ![Granting access to a principal on the Permissions tab of a Google Cloud Storage bucket](https://mintcdn.com/zeotap/IaZjYE7XwRssOe8Q/articles/integrate-customer/Storage/integrate-customer/snowflake-destination/snowflake-destination-2025-02-01-1.png?fit=max\&auto=format\&n=IaZjYE7XwRssOe8Q\&q=85\&s=2b65bef3aed16a3ace56ad56aa15c2cc) **Step 6** Click **Save**. ### Create a Pub/Sub notification for the bucket **Notification Integration** enables Snowflake to detect when new data arrives in GCS. So, configure a notification connection between the GCS bucket and a Pub/Sub topic. Run the following command in the Google Cloud Console shell: ```bash theme={null} gsutil notification create -t -f json -e OBJECT_FINALIZE gs:// ``` * Replace `` with the Pub/Sub topic name. * Replace `` with the name of your GCS bucket. After successful creation, create a pull-based subscription for the topic. Copy the Subscription ID from the topic subscription. For more information, see the [Pub/Sub documentation](https://cloud.google.com/storage/docs/reporting-changes). ### Create a notification integration in Snowflake To automate the process, set up notifications using Pub/Sub. Run the following command in the [Snowflake SQL worksheet](#run-the-sql-commands-in-a-snowflake-worksheet): ```sql theme={null} CREATE NOTIFICATION INTEGRATION TYPE = QUEUE NOTIFICATION_PROVIDER = GCP_PUBSUB ENABLED = TRUE GCP_PUBSUB_SUBSCRIPTION_NAME = ''; ``` * Replace `` with a name for the integration (for example, `my_notification_integration`). * Replace `` with the ID copied in [Create a Pub/Sub notification for the bucket](#create-a-pubsub-notification-for-the-bucket). Retrieve integration details using: ```sql theme={null} DESC NOTIFICATION INTEGRATION ; ``` > [!NOTE] > > Note the `GCP_PUBSUB_SERVICE_ACCOUNT` value, which is the **service account created for the Notification integration**. You need to grant permissions to the Pub/Sub subscription, as described in the next two sections. ### Grant the Pub/Sub service account access to the subscription Snowflake needs to be notified when new data arrives in GCS. Hence, grant the Snowflake service account (`GCP_PUBSUB_SERVICE_ACCOUNT`) access to your Pub/Sub subscription: **Step 1** Open the Google Cloud Console and search for **Pub/Sub**. **Step 2** Select **Pub/Sub Subscriptions**. ![Pub/Sub Subscriptions in the Google Cloud Console](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/snowflake-destination/snowflake-destination-2025-01-29-3.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=ba43c54342908e5e20752545c9bcd186) **Step 3** Select the subscription you created for the bucket notification. **Step 4** Click the three dots on the subscription and click **View Permissions** > **Add Principal**. **Step 5** Add the role **Pub/Sub Subscriber** and click **Save**. ![Assigning the Pub/Sub Subscriber role to a principal on a subscription](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/snowflake-destination/snowflake-destination-2025-01-29-2.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=c0ea69abe19ac087ba4142d7af801762) ### Grant monitoring access to the Pub/Sub service account Grant the Snowflake service account (`GCP_PUBSUB_SERVICE_ACCOUNT`) monitoring viewer access: **Step 1** Open the Google Cloud Console. **Step 2** In the left panel, navigate to **IAM & Admin** > **IAM**. **Step 3** Under **VIEW PRINCIPALS**, click **GRANT ACCESS**. **Step 4** Assign the following role to the Snowflake service account: * `Monitoring Viewer` These permissions allow Snowflake to access monitoring information for the subscription. ![Granting the Monitoring Viewer role on the IAM page of the Google Cloud Console](https://mintcdn.com/zeotap/uj9kV6WkF-FC0bHW/articles/integrate-customer/Storage/integrate-customer/snowflake-destination/snowflake-destination-2025-01-29-6.png?fit=max\&auto=format\&n=uj9kV6WkF-FC0bHW\&q=85\&s=27db5956e91ad1597344536f74f06bfd) ### Create a stage in Snowflake Create a stage referencing the GCS bucket. Run the following command in the [Snowflake SQL worksheet](#run-the-sql-commands-in-a-snowflake-worksheet): ```sql theme={null} CREATE STAGE URL = 'gcs:///' STORAGE_INTEGRATION = ; ``` * Replace `` with the stage name. * Replace `` with your GCS bucket name. * Replace `` with the storage integration name you created earlier. ### Create a Snowpipe Create a Snowpipe to load data from the GCS bucket into Snowflake automatically. Run the following command in the [Snowflake SQL worksheet](#run-the-sql-commands-in-a-snowflake-worksheet): ```sql theme={null} CREATE PIPE AUTO_INGEST = TRUE INTEGRATION = '' AS COPY INTO FROM @// FILE_FORMAT = (TYPE = 'JSON') MATCH_BY_COLUMN_NAME = CASE_INSENSITIVE; ``` * Replace `` with the pipe name. * Replace `` with the notification integration name you created earlier. * Replace `` with the destination table name. * Replace `` with the stage name you created earlier. * Replace `` with the folder name for the data. Once configured, Zeotap CDP can drop files into the GCS bucket. The system automatically triggers and loads data into Snowflake. ## Understand the destination components Ensure that you have the details of the following Google Cloud Storage components before creating the destination in Zeotap CDP. * **Bucket** — the name of your Google Cloud Storage bucket. You can obtain this information from your Google Cloud Storage account as shown in the image below. ![Bucket name shown in the Google Cloud Storage console](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/gcs_bucket.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=27a98eddfc923035a9733033c5c0fc10) * **Folder** — a logical container for organising stored objects within a bucket. In reality, there are no actual folders in Google Cloud Storage. Instead, the folder concept is emulated by employing object key names containing slashes ("/") to replicate a hierarchical arrangement. You can obtain this information from your Google Cloud Storage account as shown in the image below. ![Folder path inside a bucket in the Google Cloud Storage console](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/gcs_folder.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=ee827f65a647fe9656d55c7b3a13717c) * **Account** — the Zeotap Service Account used to access the Google Cloud Storage account. Ensure that you whitelist the Zeotap Service Account to successfully push audiences (segments) from Zeotap CDP to Google Cloud Storage. ## Create the Snowflake destination in Zeotap CDP Perform the following steps to create a destination for Snowflake: **1. Open the Destinations application** Log into the Zeotap CDP App and go to the **DESTINATIONS** application. **2. Start a new destination** Click **+ Create Destination**. ![Create Destination button in the Destinations application](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/ADOBE_DMP_3_\(1\).png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=562fa59a1a1e2b76442fa98f6e6f991e) **3. Select Snowflake** Under the **All Destinations** section, search for **Snowflake** and click it. ![Searching for a destination under the All Destinations section](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/ADOBE_DMP_4_\(1\).png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=653728565c7ed5863548171765d4086f) **4. Fill in the destination fields** A screen appears displaying details about the particular destination towards the left. On the right-hand side of the screen you find the list of fields required for the integration to be established. Provide the required details: a. Enter a name for the destination. b. In the **Destination Instance Name** field, provide a desired value for this internal field. c. In the **Bucket** field, provide the name of the Google Cloud Storage bucket. d. In the **Folder** field, provide the folder path in your storage location where Zeotap CDP can store your exported data. > [!NOTE] > > Ensure you follow the below points while providing the folder path: > > * The folder path should follow the below structure: > * `folder_name/sub_folder_name/` > * The folder name should not start with a `/` > * The folder name and sub-folder name should end with a `/` e. Under **Account**, choose either **Zeotap Service Account** or **Client Service Account Json** using the drop-down menu based on the type of authentication you need. If you wish to use the Zeotap Service Account, then ensure that you whitelist it to send audiences (segments) from Zeotap CDP to Snowflake. ![Account drop-down on the destination configuration form, with the Zeotap Service Account and Client Service Account Json options](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/google-cloud-storage-2024-05-08.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=4035a760431f47f9e2282dd46a2e57d4) * If you choose **Zeotap Service Account** as the Account, then ensure that you whitelist the service account provided by Zeotap CDP to send the audiences (segments) from Zeotap CDP to Snowflake. This service account information auto-populates under **Service Account to be Whitelisted** as shown in the image below. ![Service Account to be Whitelisted auto-populated on the destination configuration form](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/google-cloud-storage-2024-05-08-1.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=80b9f59a37bb2c7b8b83268ea131378a) * If you choose **Client Service Account Json** as the Account, then you need to upload the JSON file with the required authentication information using the **+ Select File** option so that Zeotap CDP can push the audiences to the Google Cloud Storage platform. ![Uploading a client service account JSON using the + Select File option](https://mintcdn.com/zeotap/UNwlFBI6l-jpipWP/articles/integrate-customer/Storage/integrate-customer/google-cloud-storage/google-cloud-storage-2024-05-08-2.png?fit=max\&auto=format\&n=UNwlFBI6l-jpipWP\&q=85\&s=a5bc85536732956d054503de1b2bc797) f. Review all the values entered above and then click **Next** to proceed. **5. Choose the action and map fields** In the new screen that appears, choose the appropriate action and mapping. Under **Choose your Action**, choose either **Send data to Snowflake** or **Stream data to Snowflake**, depending on whether you want to use Audiences (batched data activation) or Journeys (real-time activation). > [!WARNING] > > Ensure that you map the exact column names to the Destination Fields in Zeotap CDP. a. If you choose **Send data to Snowflake** as your action, then you can send any attributes and identifiers to Snowflake and [link it to any Audience](/articles/segment-customer/link-the-destination) created. b. If you choose **Stream data to Snowflake** as your action, then you can send any attributes and identifiers to Snowflake and link it to any [workflow created in Journeys](/articles/orchestrate-customer/create-a-workflow). Use the **Enable Batching** checkbox to aggregate data before sending it to Snowflake through the workflow. Batching occurs based on two factors: processing time and record count, whichever occurs first. For example, if you set the batch processing time to 2 minutes and the record count limit to 100, then the file is generated and sent to Snowflake when either condition is met. ![Action and mapping screen for the Snowflake destination, with the Enable Batching option](https://mintcdn.com/zeotap/IaZjYE7XwRssOe8Q/articles/integrate-customer/Storage/integrate-customer/snowflake-destination/snowflake-destination-2025-01-29.png?fit=max\&auto=format\&n=IaZjYE7XwRssOe8Q\&q=85\&s=08bfc9e8fe8f67d868ed2bac4c3544d0) **6. Create the destination** After finalising the attributes and identifiers to send, click **Create Destination**. ## Link an audience or a workflow to the destination The created destination gets listed in the **Audiences** and **Journeys** applications, which can be linked to an audience or a workflow as per your requirement. * For batched activation with the **Send data to Snowflake** action, see [Link the destination](/articles/segment-customer/link-the-destination). * For real-time activation with the **Stream data to Snowflake** action, see [Create a workflow](/articles/orchestrate-customer/create-a-workflow). ## Verify the data lands in Snowflake After linking an audience or a Journeys workflow to the destination, Zeotap CDP sends the data to your Google Cloud Storage bucket. Snowflake then pulls the data from the bucket into your Snowflake account. In Snowflake, the data appears in the `Database/Schema/Table` you selected for data transfer, as shown below. ![Delivered records shown in the target table in the Snowflake console](https://mintcdn.com/zeotap/IaZjYE7XwRssOe8Q/articles/integrate-customer/Storage/integrate-customer/snowflake-destination/snowflake-destination-2025-01-30.png?fit=max\&auto=format\&n=IaZjYE7XwRssOe8Q\&q=85\&s=db72fb602c7360b941ad97dbb140b807) ## Next steps * [Explore the Snowflake source →](/articles/integrate-customer/snowflake) — import data from Snowflake into Zeotap CDP * [Explore linking an audience to the destination →](/articles/segment-customer/link-the-destination) — activate an audience against the destination you just created * [Explore creating a Journeys workflow →](/articles/orchestrate-customer/create-a-workflow) — send real-time data through the destination * [Explore how destinations work →](/articles/integrate-customer/destinations) — actions, mappings, and delivery across all destinations # Error Handling and More Source: https://docs.zeotap.com/articles/integrate-customer/snowflake-source-error-handling-and-more | **Sample Error** | **Description** | **Resolution** | | :- | :- | :- | | IP `34.77.XXX.XX` is not allowed to access Snowflake. Contact your local security administrator or please create a case with Snowflake Support or reach us on our support line. | This error message appears when an active Network Policy is applied to the customer account or user, and the source IP address attempting to access the account is not included in the `Allowed IP Addresses` block. | To resolve this issue, follow the steps below: 1. Contact the Snowflake Account Admin or Security Admin and provide them with the IP address displayed in the error message. 2. Request them to include the IP address in the `Allowed IP Addresses` block. 3. If you are the only Account Admin or Security Admin user for the Snowflake account, then reach out to Snowflake support for assistance. | > [!NOTE] > > **Note:** > > Here are the recommendations to avoid the above error. > > 1. Designate at least two Account Admin or Security Admin users for your Snowflake account. > 2. Collaborate with your network/security teams to verify if a CIDR block range can be provided in the Allowed IP Addresses list. This approach can help avoid issues with dynamic IP addresses. ## Key Pair Authentication Issues If you created the source using **Key Pair** as the **Authentication Type**, the following are the most common causes of a failed connection. For more information about generating and registering the key pair, refer to [Create a Snowflake Source and Load Data](/articles/integrate-customer/create-a-snowflake-source#key-pair). | **Issue** | **Cause** | **Resolution** | | :- | :- | :- | | The source cannot authenticate with Snowflake. | The public key is not registered against the Snowflake user, or it does not correspond to the private key that you uploaded. | Register the public key using `ALTER USER ADD KEY PAIR PUBLIC_KEY = '';`, then compare the fingerprint reported by `DESC USER` against your local key as described in the [Key Pair](/articles/integrate-customer/create-a-snowflake-source#key-pair) section. | | The source cannot read the uploaded key. | The private key is encrypted, but **Private Key Passphrase** was left empty or contains an incorrect passphrase. | Enter the passphrase that you set when generating the key. If the key was generated with the `-nocrypt` option, leave the field empty. | | The uploaded file is rejected. | The key is not in the Privacy Enhanced Mail (PEM) format using the PKCS#8 standard, or it is smaller than 2048 bits. | Regenerate the key pair using the commands in the [Key Pair](/articles/integrate-customer/create-a-snowflake-source#key-pair) section, and upload the resulting `rsa_key.p8` file. | | The connection stops working after it was previously fine. | The key pair was rotated or removed in Snowflake, or the key has expired. | Register the current public key against the Snowflake user and upload the matching private key to the source. | ## Data Ingestion Specification ### Supported Regions Currently, we support data ingestion in the following regions: * EU – All EU countries' data are ingested to the bucket provisioned for you in the EU region * UK – United Kingdom's data are ingested to the bucket provisioned for you in the UK region. You can find the full list of Country to Region mapping under [Country to Region Mapping](https://docs.zeotap.com/smart/project-collect-customer/region-of-storage-2709356573). ### Supported PII For raw personal identifiers (PII), we mask the PII information across the UI for all roles once you classify them in your organisation's catalogue. Flagging the raw PII fields in your organisation's catalogue is a critical step and is the responsibility of the organisation. The encrypted data is only available to the downstream systems for activation purposes. > [!NOTE] > > **Note:** > > We use the RSA Encryption Algorithm. # Source Access Rules Source: https://docs.zeotap.com/articles/integrate-customer/source-access-rules Sources bring data into Zeotap CDP. Source access rules let org admins block a source, or specific attributes within it, from individual audience and journey folders. ## What this is Sources bring data **into** Zeotap CDP, and source access rules govern where that inbound data may then be used: they let an org admin block a source — or only specific attributes within it — from individual audience and journey folders. This is useful when a source holds a mix of safe and sensitive data. Rather than making the whole source off-limits, you can leave it broadly available and block only the sensitive fields in the folders where they should not be used. For the outbound direction — restricting which destinations a folder is allowed to activate to — see [Destination Access Rules](/articles/integrate-customer/destination-access-rules). For the governance model both sit inside, including how access rules relate to Folder Access Control and Mandatory Templates, see [Access Rules](/articles/admin-customer/access-rules). > [!NOTE] > > **Composable sources.** The Join Key in sources tagged as **Customer Parent Model** cannot be restricted in any folder. It is the foundation that enables profile unification — restricting it would break identity resolution across the org. ## What you can restrict A single rule on a source is always a blocklist — anything you do not block stays available. | You can block | Scope | | - | - | | Every attribute in the source | The folders named in the rule | | Specific attributes in the source | The folders named in the rule | | Neither (the default) | Nothing is blocked anywhere | Rules apply to **audience** folders and, where the source is eligible for journeys, **journey** folders — chosen on separate tabs of the same rule. ## Prerequisites * A role that can edit access rules. The built-in **CDP Admin**, **CDP Manager**, **Integrations Admin** and **Integrations Manager** roles can; alternatively, grant the view/edit access rules permissions to a [custom role](/articles/admin-customer/my-roles). * A source that already exists and has its attributes mapped — a rule is built from the source's mapped attributes. See [creating a source](/articles/integrate-customer/creating-a-source). * The audience and journey folders you want to restrict. Access rules cannot be applied to **Archive** folders. ## When to use source access rules **Block sensitive attributes from specific teams.** Your CRM source contains email, transaction history, loyalty tier, and national ID. Your marketing teams need email and transactions to build campaign audiences. They do not need national ID. You can block the national ID attribute from the marketing folders while keeping the rest of the source fully accessible. **Restrict an entire source to specific contexts.** You have a source containing medical or financial data that should only be accessible to a compliance-approved folder. You can block the entire source from all other folders, ensuring it only appears in the right context. **Enforce data minimisation.** Different teams should work with the minimum data necessary for their use case. A growth marketing team running acquisition campaigns doesn't need loyalty or retention attributes. Blocking those attributes from the acquisition folder keeps the data environment clean and reduces the risk of misuse. **Meet regional data requirements.** Certain attributes may be permissible in one market but restricted in another. You can apply different rules to region-specific folders — for example, blocking a sensitive field from your Germany marketing folder while keeping it accessible in other markets. ## How source access rules work ### Default state By default, every source — both new and existing — is available across all folders. No restrictions apply unless an admin explicitly configures them. ### Attribute-level control Admins can either select all attributes from the source or select specific attributes within it. * Only the explicitly selected attributes are blocked in the targeted folders. * All other attributes from that source remain fully accessible in those folders. * For any new folder created after the rule is set, the source is fully accessible — including the otherwise blocked attributes. The new folder must be explicitly added to the rule for attribute restrictions to apply. **Behaviour for new attribute mappings added after a rule is set:** * Any new attribute mapping added to the source after the rule is set is accessible in all folders by default. It is not automatically blocked unless explicitly added to the rule. ### Subfolder inheritance A rule applied to a folder extends to all of that folder's current and future subfolders, so you do not have to repeat the configuration down a folder tree. > [!WARNING] > > **Unified attributes.** Zeotap unifies attributes across sources. If two ingested sources both contribute to a unified attribute (e.g., `Email`) and one source is blocked in a folder, the unified attribute becomes unavailable in that folder — even though the second source is still active. Admins will see a prominent warning before confirming any configuration that has this effect. ## Create a source access rule **1. Open the source** Go to **Integrate > Sources** and open the source you want to configure a rule for. **2. Open the Access Rule tab** Select the **Access Rule** tab. If no rules exist yet, the **Access Restrictions** panel shows the **No Rules Configured** empty state. ![Source Access Rule tab showing the Access Restrictions panel and the No Rules Configured empty state.](https://mintcdn.com/zeotap/nhERkVvrBii8WWnl/articles/integrate-customer/Storage/integrate-customer/source-access-rules/source-empty-state.png?fit=max\&auto=format\&n=nhERkVvrBii8WWnl\&q=85\&s=dda3f516d22071e761462c9830e62ef6) Figure 1 — Access Rule tab on a source with no rules configured yet. **3. Choose the folders** Click **+ Add Folder Rule**. In the **Select Folders** panel, use the **Audience** and **Journey** tabs to tick the folders the restriction should apply to, then click **Next**. Use **Select all** to pick every folder on a tab, or the search box to find one. Permissions applied to a folder extend to all its current and future subfolders. ![Select Folders panel with Audience and Journey tabs, a search box, a checklist of folders, and a note that permissions extend to subfolders.](https://mintcdn.com/zeotap/nhERkVvrBii8WWnl/articles/integrate-customer/Storage/integrate-customer/source-access-rules/source-select-folders.png?fit=max\&auto=format\&n=nhERkVvrBii8WWnl\&q=85\&s=9580d4f707c8fa8901392a71f4b4b502) Figure 2 — Select Folders panel, with separate Audience and Journey tabs. **4. Choose the attributes to block** In the **Configure field access** panel, tick **Select all** to block every attribute from the source, or tick individual attributes to restrict access more narrowly. Each row shows how many sources contribute to that attribute, which is a useful signal of how wide the impact will be. Click **Apply to Folders & Save** when the selection is right. ![Configure field access panel with a Select all checkbox, an attribute checklist showing contributing source counts, and a warning that restricting attributes may affect other sources contributing to the same unified catalogue attributes.](https://mintcdn.com/zeotap/nhERkVvrBii8WWnl/articles/integrate-customer/Storage/integrate-customer/source-access-rules/source-configure-field-access.png?fit=max\&auto=format\&n=nhERkVvrBii8WWnl\&q=85\&s=02dc3157996a85194ed6758869a9ba58) Figure 3 — Configure field access. Choose Select all, or only the specific attributes to block in the selected folders. **5. Review the folders and counts** Back on the **Access Rule** tab, the chosen folders are listed under **Audience Folders List** and **Journey Folders List**, each showing how many attributes are blocked. Click **Check and Save Permission**. ![Access Rule tab listing three audience folders and two journey folders, each tagged with a blocked-attribute count, with a Check and Save Permission button.](https://mintcdn.com/zeotap/nhERkVvrBii8WWnl/articles/integrate-customer/Storage/integrate-customer/source-access-rules/source-rule-listed.png?fit=max\&auto=format\&n=nhERkVvrBii8WWnl\&q=85\&s=2df42a37e75ad0ea38e3c641fe80f631) Figure 4 — The configured rule, listing each folder with its blocked-attribute count, before saving. **6. Confirm the save** If the rule affects unified attributes, the **Do You Want To Save?** dialog calls out the cross-source impact before anything is applied. Review it, then click **Confirm & Save**. ![Do You Want To Save dialog explaining that existing audiences and journeys keep running but are flagged for review, with a Cross-Source Impact callout.](https://mintcdn.com/zeotap/nhERkVvrBii8WWnl/articles/integrate-customer/Storage/integrate-customer/source-access-rules/source-confirm-save-dialog.png?fit=max\&auto=format\&n=nhERkVvrBii8WWnl\&q=85\&s=822565660d62ae98993fb83e05043c96) Figure 5 — Save confirmation with the cross-source impact warning. ## Edit or remove a source access rule Open the source, select the **Access Rule** tab, then: * **Change which attributes are blocked for one folder** — click the edit icon on that folder's blocked-attribute tag. * **Remove one folder from the rule** — click the cross icon on that folder's tag. * **Add more folders** — click **+ Add Folders**. (On a source with no rules yet, the same button reads **+ Add Folder Rule**.) * **Remove every folder rule on the source** — click **Clear All Rules**. Changes are applied the same way as a new rule: **Check and Save Permission**, then **Confirm & Save**. ## What users see when a source is restricted ### In the Audience Builder Blocked attributes are not available for selection — even if the source itself is otherwise accessible. Templates that use restricted attributes cannot be used either. Users also cannot send the restricted attributes to any destinations within the folder. > [!WARNING] > > Users can still use **calculated attributes** that reference blocked attributes within these folders. **Existing audiences affected by a new rule:** Existing audiences continue running without interruption. However, any audience using a now-restricted attribute is flagged with a warning status on both the folder and the audience definition page. ![Audiences list showing an active audience row with a warning icon and a tooltip reading that the audience uses mappings which are restricted in this folder.](https://mintcdn.com/zeotap/nhERkVvrBii8WWnl/articles/integrate-customer/Storage/integrate-customer/source-access-rules/source-flagged-audience-listing.png?fit=max\&auto=format\&n=nhERkVvrBii8WWnl\&q=85\&s=3c7b4995d068062540c657309ecd4f8a) Figure 6 — Audiences listing, with a hover tooltip warning that the audience uses mappings restricted in this folder. ![Audience criteria builder with the restricted attribute highlighted and a banner explaining that the audience will keep running but changes cannot be published until the conflict is resolved.](https://mintcdn.com/zeotap/nhERkVvrBii8WWnl/articles/integrate-customer/Storage/integrate-customer/source-access-rules/source-flagged-audience-criteria.png?fit=max\&auto=format\&n=nhERkVvrBii8WWnl\&q=85\&s=64d675fc0b11f5fc41071aae6ad0b6a2) Figure 7 — Audience criteria view, with the inline banner naming the restricted attribute and the action required. > [!WARNING] > > Users cannot publish changes to a flagged audience until the conflict is resolved — either by removing the restricted attribute from the audience definition, or by an admin updating the rule. ### In the Journey Builder Blocked attributes are not available for selection — even if the source itself is otherwise accessible. Templates that use restricted attributes cannot be used either. Users also cannot send the restricted attributes to any destinations within the folder. > [!WARNING] > > Users can still use **real-time calculated attributes** that reference blocked attributes within these folders. **Existing journeys affected by a new rule:** Existing journeys continue running without interruption. However, any journey using a now-restricted attribute is flagged with a warning status on both the folder and the journey definition page. As with audiences, users cannot publish changes to a flagged journey until the conflict is resolved. ## Verify the rule applied * On the source's **Access Rule** tab, each folder in the rule is listed with its blocked-attribute count. * In a restricted folder, open the Audience Builder or Journey Builder — the blocked attributes are no longer offered for selection. * Any audience or journey in that folder that already used a blocked attribute now carries a warning icon in the listing, and an inline banner on its definition page. ## Troubleshoot source access rules **An attribute disappeared from a folder even though a different source still supplies it.** Zeotap unifies attributes across sources, so blocking one contributing source removes the unified attribute in that folder. Narrow the rule to the attributes you actually need to block, or exclude that folder. **A user cannot publish changes to an audience or journey.** It uses an attribute that is now restricted in its folder. Either remove that attribute from the definition, or ask your org admin to update the rule. The item keeps running in the meantime. **A newly created folder is not restricted.** New folders get full access by design. Add the folder to the rule explicitly. **A newly mapped attribute is not blocked.** New attribute mappings are accessible by default. Add the attribute to the rule explicitly. **The Join Key cannot be blocked.** On sources tagged as **Customer Parent Model**, the Join Key cannot be restricted in any folder, because profile unification depends on it. **A rule cannot be applied to an Archive folder.** Access rules are not supported on Archive folders. **A calculated attribute still exposes blocked data.** Calculated attributes — and real-time calculated attributes in journeys — that reference a blocked attribute remain usable in a restricted folder. Review them separately. ## Next steps * [Access Rules](/articles/admin-customer/access-rules) — the three-layer governance model these rules belong to. * [Destination Access Rules](/articles/integrate-customer/destination-access-rules) — restrict the outbound direction: which destinations a folder can activate to. * [My Roles](/articles/admin-customer/my-roles) — folder access control, and the custom-role permissions that allow editing access rules. # Source Alerts Source: https://docs.zeotap.com/articles/integrate-customer/source-alerts Configure and act on the email alerts that notify subscribed users when a Zeotap source stops receiving data, fails ingestion, or takes too long to process. ## What this is Source alerts are the daily email notifications Zeotap sends to subscribed users when one of your sources has a data problem — no file arrived, ingestion failed for a large share of records, or a file has been in progress for a long time. Each email lists the affected source IDs and the failure reason, so you can diagnose whether the issue sits on the sending side (your export, your API, your file drop) or on the ingestion side. This page explains how to subscribe, what each alert scenario means, and how to respond when one lands in your inbox. ## Prerequisites > [!NOTE] > > Source alerts are opt-in. Only users on a subscription list receive them; a source failure will not surface as an alert email until at least one address is subscribed for your organisation. To subscribe or update the list, contact the [Zeotap support team](mailto:support@zeotap.com) with the email addresses that should receive the alerts. ## Subscribe to source alerts To start receiving alerts, send a request to [support@zeotap.com](mailto:support@zeotap.com) that includes: * The email addresses to add to the alert list. * The alert types you want to receive (see the four supported types below). * The time of day, as a single hour in your organisation's local time, at which the daily digest should arrive. * For ingestion failures, the failure-rate threshold at which you want to be alerted. The default fires when more than 20% of the records in a file or streaming batch fail within 24 hours. The four supported alert types are: ```text theme={null} NO_DATA PULL_FAILURE INGESTION_FAILURE DELAYED_INGESTION_FAILURE ``` > [!NOTE] > > `DELAYED_INGESTION_FAILURE` is not enabled by default. Ask for it explicitly in your subscription request if you want to be alerted when files stay in progress for more than 48 hours. ## Alert scenarios you will receive Each alert email groups the failed sources by scenario. Use the source IDs in the email to open the affected sources from the Sources application and cross-check status, last-ingested time, and record counts before you start troubleshooting. ## Why this happens | Error string | What it means | Where to look | | - | - | - | | `NO_DATA` | The scheduled pull ran but no file was found at the source location. | Confirm the file was generated and dropped at the expected path on your side. | | `PULL_FAILURE` | No file arrived within the sync frequency configured for the source. | Verify the sending job ran on your side and that Zeotap still has access (credentials, allow-list, storage permissions). | | `INGESTION_FAILURE` | More than 20% of records in a file or streaming batch failed within a 24-hour window. | Open the error log for the source in Cloud Storage, at `/error-log/`. | | `DELAYED_INGESTION_FAILURE` | An ingested file has been in progress for more than 48 hours. | Contact Zeotap support with the source ID and file name. This alert is opt-in. | ## Respond to a source alert Work through the subsection that matches the scenario in the email. ### A. `NO_DATA` 1. Confirm on your side that the expected file was generated for the scheduled date. If no file was generated, this alert is expected — no Zeotap-side action is required. 2. If a file was generated, verify that it was dropped at the exact path the source is configured to read (bucket, folder, file-name pattern). 3. If the file is present at the expected path but the alert fires again the next day, contact [Zeotap support](mailto:support@zeotap.com) with the source ID and the file path. ### B. `PULL_FAILURE` 1. Confirm your source (BigQuery, CRM, storage bucket, or another pull-based integration) produced data for the scheduled window. If your upstream pipeline did not run, no Zeotap-side fix is possible — re-run the upstream job. 2. If your data is present, verify Zeotap still has access to the source: check that credentials have not been rotated, that any IP allow-list still includes Zeotap, and that storage or API permissions have not changed. 3. If credentials and access are intact and the next scheduled sync still fails, contact [Zeotap support](mailto:support@zeotap.com). ### C. `INGESTION_FAILURE` The error log for a failing source is written to Cloud Storage under the source's ID: ```text theme={null} /error-log/ ``` 1. Open the error log for the affected source. The log names the field, record, or record range that failed and the validation reason (schema mismatch, missing required field, malformed timestamp, and similar). 2. Fix the underlying data problem in the sending system and re-drop the file. Zeotap re-ingests the corrected records on the next scheduled sync. > [!TIP] > > If the same field fails across many files, the fix is a mapping change, not a re-drop. Correct the mapping for the source before re-sending, so the corrected file ingests cleanly on the first attempt. ### D. `DELAYED_INGESTION_FAILURE` This alert fires when a file has been in progress for more than 48 hours. There is no self-serve action to unblock a delayed ingestion. > [!NOTE] > > Contact [Zeotap support](mailto:support@zeotap.com) with the source ID, the file name, and the time the file was dropped. Support investigates the delay and updates the ticket with next steps. ## Verify your alert subscription is working After subscribing, confirm alerts are reaching the intended inboxes: 1. Confirm at least one subscribed recipient received the daily digest at the requested hour on a day when a subscribed source had a known failure. 2. Cross-check the source IDs in the email against your Sources list. Every ID in the email corresponds to a source you can open from the Sources application. If an ID does not resolve, the subscription is scoped to a different organisation — contact support to correct it. 3. If a source has been paused for ingestion, alerts for that source are suppressed. You receive one confirmation alert when the source is resumed, and then normal alerting continues. ## When to contact support Contact [Zeotap support](mailto:support@zeotap.com) if: * You subscribed but no alert arrived after two full days that included a known failure. * An alert lists a source ID that does not appear in your organisation. * A `DELAYED_INGESTION_FAILURE` alert has fired and the file is still in progress 24 hours later. * An `INGESTION_FAILURE` alert continues to fire for the same source after you have corrected the data and re-dropped the file across two subsequent sync cycles. Include in your request: * The source ID, plus the file name for batch sources. * The alert type from the email (`NO_DATA`, `PULL_FAILURE`, `INGESTION_FAILURE`, or `DELAYED_INGESTION_FAILURE`). * The date and time of the alert email. * For ingestion failures, a copy of the error-log entries you inspected. ## FAQ > [accordion] Why did I stop receiving alerts for a source I know is failing? > > Alerts are suppressed while a source is in a `Paused` or `Paused (Ingestion)` state. Recurring failure, overdue, and pull-stuck alerts do not send for paused sources; a single confirmation alert sends when the source is resumed. > [accordion] Can I get alerts more than once a day? > > Source alerts are delivered as a single daily digest at the hour configured for your organisation. To change the delivery hour, contact Zeotap support. > [accordion] Does the alert email include the failed records themselves? > > No. The email lists the affected source IDs and the scenario (`NO_DATA`, `PULL_FAILURE`, `INGESTION_FAILURE`, or `DELAYED_INGESTION_FAILURE`). For `INGESTION_FAILURE`, the failing records are written to the source's error log in Cloud Storage under `/error-log/`. > [accordion] Can I add or remove recipients myself? > > Not from the Zeotap UI today. Send the updated recipient list to [Zeotap support](mailto:support@zeotap.com) and the subscription is updated for your organisation. ## Next steps * [Explore the Source listing page →](/articles/integrate-customer/components-of-the-source-listing-page) * [Explore how to archive a source →](/articles/integrate-customer/archived-source) * [Explore how to create a Salesforce CRM source →](/articles/integrate-customer/creating-salesforce-crm) --- title: "Source Alerts" description: "Source alerts are email notifications that inform Zeotap CDP customers about failures in their created sources on Zeotap CDP. The report includes a list of failed sources and the causes of failure. Recipients, thresholds and filters for these alerts are configured in Admin → Alerts & Notifications." *** Configure who receives these alerts, and the thresholds and filters that control when they fire, in [Alerts & Notifications](/articles/admin-customer/alerts-and-notifications) under **Admin**. The following are the error scenarios notified in the report: | **Scenario** | **Reason** | **Next Steps** | | :- | :- | :- | | **No data** | Triggers when no file is dropped and the uploader fails to pull data | In this case, first confirm that the file was generated or dropped as expected. Then, verify the connection and access to the source. If the issue persists, reach out to the [Zeotap support team](mailto:support@zeotap.com) for assistance. | | **Pull fail scenario** | Triggers if there is no file received as per the sync frequency configured for the source. | This scenario is similar to the "No Data" scenario, but in this case, the file itself is not generated. If this source (BigQuery, platforms, or CRM) is configured to pull data on a scheduled basis, then verify whether data was generated on your end for the specified date and confirm if this is an expected behaviour. If no data was generated, then the issue might relate to the source connection or access. In such cases, reach out to the [Zeotap support team](mailto:support@zeotap.com). | | **Ingestion failure scenario** | Triggers if more than 20% of the received records of a file or a streaming source fail within 24 hours. | • Refer to the error log in GCS under \/error log. • Fix the error mentioned in the report to ingest all the data successfully. | | **Delayed ingestion scenario** | Triggers if the ingested file remains in progress for more than 48 hours. | This notification is not activated by default. To receive this error, reach out to the [Zeotap support team](mailto:support@zeotap.com). | # Source Report Source: https://docs.zeotap.com/articles/integrate-customer/source-report The SOURCE REPORT tab on a source's details page shows the ingestion health of that one source — how many records arrived, how many were ingested, and what happened to each file dropped. ## What this is The source report is the per-source view of ingestion health in Zeotap CDP. It sits on a source's details page under the **SOURCE REPORT** tab, alongside **IMPLEMENTATION DETAILS**, **PREVIEW DATA** and **CATALOGUE MAPPING**, and it answers one question about a single source: of everything this source has sent, how much arrived, how much was ingested and is available for activation, and how much failed. This page covers what the tab is, how to reach it, and what each of its two panels is for. [Exploring Source Reports](/articles/integrate-customer/exploring-source-reports) documents every field in both panels in full, and [Understanding the Ingestion Log Error](/articles/integrate-customer/understanding-the-ingestion-log-error) explains the errors the report surfaces. ## Prerequisites > [!NOTE] > > Before you open a source report, confirm: > > * The source already exists under **Integrate → Sources**. A source still in **Created** status has not received any data yet, so its report has no counts to show. > * You have permission to view source reports for that source. > * The **File Ingestion Details** panel appears only for sources that share data in files. ## Key concepts The **SOURCE REPORT** tab is divided into two panels: **Data Ingestion Details**, which counts records for the lifetime of the source, and **File Ingestion Details**, which lists the individual files a batch source has dropped. ![The SOURCE REPORT tab showing lifetime record counts, ingestion efficiency, and the table of files dropped for a batch source.](https://mintcdn.com/zeotap/IaZjYE7XwRssOe8Q/articles/integrate-customer/Storage/integrate-customer/source-report/source-report-2024-08-09.png?fit=max\&auto=format\&n=IaZjYE7XwRssOe8Q\&q=85\&s=16aec4f3c668bdf27aa8824c6d7adbb4) The SOURCE REPORT tab of a source details page, with the Data Ingestion Details panel above the File Ingestion Details panel. ### Data Ingestion Details This panel counts records for the lifetime of the source — from the moment the source was created — and shows how they split between received, in progress, ingested and available for activation, and failed, together with an **Ingestion Efficiency** figure and a chart of the same split. The timestamp of the last refresh appears beside the panel name. Two controls sit at the top of the panel: * **View Graph** plots the trend of records received and processed by status over a period you choose. * **Download Report** saves an image snapshot of the source report. ### File Ingestion Details This panel lists one row per file a batch source has dropped, and is shown only for sources that share data in files. Each row names the file, its ingestion status for both real-time and batch activation, the records ingested against the total record count, the file size, the file type, and a **View Logs** link that opens the detailed ingestion log for that file — including the errors found when a file fails. A filter above the table limits the rows to the last 7, 30 or 90 days, with 7 days as the default, and the panel also reports the total number of files dropped. > [!NOTE] > > Once a source is mapped, ingestion may take up to **15 minutes** to begin, so a report opened straight after mapping can show no counts yet. [Exploring Source Reports](/articles/integrate-customer/exploring-source-reports) covers the ingestion timings for streaming and batch sources in full. ## Open the source report **1. Open the Sources listing** In Zeotap CDP, go to **Integrate → Sources**. The listing shows your sources with their status and total records ingested. **2. Open the source details page** Click the source name. The details page opens with the source name, its data source type and its current status in the header, and a **Back to Sources** link above them. **3. Select the SOURCE REPORT tab** Select **SOURCE REPORT**. The **Data Ingestion Details** panel loads first; for a batch source, the **File Ingestion Details** panel follows it. ## Next steps * [Explore every field in the source report →](/articles/integrate-customer/exploring-source-reports) * [Explore the ingestion log errors and how to fix them →](/articles/integrate-customer/understanding-the-ingestion-log-error) * [Explore the Source Listing page controls →](/articles/integrate-customer/components-of-the-source-listing-page) * [Explore source alert notifications →](/articles/integrate-customer/source-alerts) * [Explore sources →](/articles/integrate-customer/sources) # Sources Source: https://docs.zeotap.com/articles/integrate-customer/sources Sources gather customer data from websites, mobile apps, flat files, CRMs, data warehouses, and other systems into Zeotap CDP as unified customer profiles. ## What this is Sources are the entry points that bring customer data into Zeotap CDP. Each source represents one origin of data — a single website, a mobile app, a CRM export feed, a data warehouse table, or a message queue — and streams or batches events and attributes toward a unified customer profile. Zeotap groups sources into nine categories so you can pick the integration that matches how your data leaves its origin system, and every source you create issues its own **write key** that identifies its traffic on ingestion. ## Prerequisites > [!NOTE] > > Before you create a source, confirm: > > * You have permission to create sources in your Zeotap CDP tenant. > * You know the origin system (website URL, app bundle identifier, warehouse project, or file location) and the region where its records live. > * Your catalog has the target attributes defined, or you are ready to add them during mapping. ## Understand the source categories Zeotap CDP exposes nine source categories. Pick the one that matches how your data leaves its origin system: * **Website Events** — capture actions and interactions on a website. Create one source per website. See [Website Events](/articles/integrate-customer/website-events). * **App Events** — track interactions inside mobile applications for a deeper view of user engagement. See [App Events](/articles/integrate-customer/app-events). * **Flat Files** — batch data delivered as CSV or JSON, transferred via SFTP or Zeotap Google Cloud Storage. See [Flat Files](/articles/integrate-customer/flat-files). * **Server-to-Server** — server-to-server data transfer through the HTTP API source. See [Server-to-Server](/articles/integrate-customer/server-to-server). * **Tag Managers** — manage tracking tags and scripts on websites and mobile apps. See [Tag Managers](/articles/integrate-customer/tag-managers). * **CRM Data** — comprehensive customer records collected through tools such as Salesforce CRM. See [CRM Data](/articles/integrate-customer/crm-data). * **Data Warehouse** — centralised structured and unstructured data from warehouses that support analytics. See [Data Warehouse](/articles/integrate-customer/data-warehouse). * **Customer Engagement Channels** — communication touchpoints such as email and push platforms. See [Customer Engagement Channels](/articles/integrate-customer/customer-engagement-channels). * **Message Queue** — payloads or metadata processed in order by another sub-system through a queue. See [Message Queue](/articles/integrate-customer/message-queue). ## Choose one source per origin — a worked example Create one source for each unique origin. Two websites are two Web JS sources. Three flat files carrying different CRM extracts are three flat-file sources, even if they land in the same folder. A practical scenario: you want to track events on a marketing website. 1. Choose **Website Events** as the source category. 2. Choose **Web JS** as the source type. 3. Enter the source name (for example, `Website A`) and the site URL (for example, `a.com`). The result is a source named `Website A` visible on the Sources listing. When you add a second website later, create a second Web JS source rather than reusing the first — that keeps write keys, catalogs, and delivery traffic separated per origin. Three CRM-derived flat files become three separate sources in the same way: * one file carrying user login information * one file carrying user classifications * one file per website carrying purchase events ## Configure a source 1. Open the Sources module in the Zeotap CDP application and start a new source. **Expected result:** the source-category picker opens. 2. Pick the category and source type that match the origin. For a website, pick **Website Events** and one of **Web JS**, **Web Pixel**, or **iFrame**. For a mobile app, pick **App Events** and one of **Android Native SDK** or **iOS Native SDK**. **Expected result:** the configuration form for that source type opens. 3. Enter a short, descriptive source name, then the origin details — website URL, region of upload, and any type-specific fields. 4. Save the source. **Expected result:** the source appears in the Sources listing, and its detail view exposes the **write key** the SDK, snippet, or server-side integration uses to send data to this source. For flat-file sources, a minimal CSV payload has one row per user, one column per attribute, a header row, country in ISO3, and at least one user identifier: ```csv theme={null} user_id,email,country,event_timestamp usr_001,alex@example.com,USA,2024-01-15T10:23:00Z usr_002,sam@example.com,DEU,2024-01-15T10:24:11Z ``` Every file uploaded to the source must repeat the same delimiter, header casing, and country encoding it was created with. Mixing formats within one source corrupts ingestion. ## Verify the source is receiving data Once the source is created and the integration is live, open the source's preview view to confirm events are landing. A healthy source shows recent records in the preview pane, with the expected attribute names and non-null values in the columns you mapped. If no records appear, check: * The origin-side integration is sending to the write key this source issued. * The source is not archived — archived sources pause all future ingestion. * The region of upload matches the region where the records live. ## Enable source alert notifications Zeotap can email designated recipients when a source has an ingestion issue. Configure alerts to notify one or more addresses when any of the following conditions occur: | Alert code | What it means | Where to look | | - | - | - | | `PULL_FAILURE` | Zeotap could not pull data from the origin system on the last attempt | Source detail → Activity | | `INGESTION_FAILURE` | Records reached Zeotap but were rejected during ingestion | Source detail → Activity | | `DELAYED_INGESTION_FAILURE` | Ingestion did not complete within the configured freshness threshold | Source detail → Activity | | `NO_DATA` | The source received no records in the alert window | Source detail → Activity | Contact your Zeotap customer success representative to enable alert notifications for your org and to set the notification time-of-day, the recipient list, and the failure threshold. ## Key features and benefits * **Real-time data streaming** — streaming sources collect and process data as it arrives, so you can respond to customer actions in the moment. * **Customisable data mapping** — map origin fields to a standardised catalog schema so downstream audiences and destinations see consistent attributes. * **Improved data accuracy** — one write key per origin removes cross-source ambiguity when profiles are stitched. * **Efficient data management** — automated ingestion removes custom-pipeline maintenance work from your team. * **Data standardisation** — records from every source merge into one catalog held at the user-profile level. ## Troubleshooting * **A newly added field is missing in preview even though records exist for it** — confirm the field was added to the source mapping and that the origin file contains the column with the expected header casing. * **Ingestion fails on a flat file that worked before** — check that the delimiter, encoding, and header casing match the source's original definition; a change corrupts ingestion. * **The source is archived** — unarchive the source to resume ingestion. Zeotap retains the data already ingested before archival. For streaming sources, put the Zeotap pixel or SDK back on your pages so the origin resumes sending. ## Next steps * [Explore how to create each source type →](/articles/integrate-customer/creating-a-source) * [Explore the Source Listing page controls →](/articles/integrate-customer/components-of-the-source-listing-page) * [Explore best practices for flat-file sources →](/articles/integrate-customer/best-practices-for-flat-file-source-2709422090) * [Explore archiving and unarchiving sources →](/articles/integrate-customer/archived-source) * [Explore how to create a Web Pixel or iFrame source →](/articles/integrate-customer/2676392376) ## FAQ > [accordion] Do I need a separate source for each website? > > Yes. Create one source per unique origin. Two websites become two Web JS sources so their write keys, catalogs, and delivery traffic stay separated. > [accordion] What is the write key used for? > > Each source issues its own write key. Your integration — the Web JS snippet, a mobile SDK, or a server-side call — includes the write key with every event so Zeotap routes the traffic to the correct source. > [accordion] What happens to data when I archive a source? > > Zeotap retains all data ingested before archival. All future ingestions are paused. For streaming sources, remove the Zeotap pixel or SDK from your pages so the origin stops sending. Unarchiving resumes ingestion. > [accordion] Can one flat-file source accept multiple file formats? > > No. Every file uploaded to a flat-file source must use the same format and delimiter defined at source creation. Mixing formats within one source corrupts ingestion. Create separate sources for different formats. # Sportradar Source: https://docs.zeotap.com/articles/integrate-customer/sportradar Configure a Sportradar destination in Zeotap CDP to deliver an audience as a suppression list, so the users in it are excluded from downstream targeting. ## What this is Sportradar is a global sports data and technology company whose advertising arm runs targeted campaigns across its media network. A Sportradar destination in Zeotap CDP delivers a linked audience to Sportradar as a list of user IDs, so Sportradar can apply it as a **suppression list** — the users in the audience are excluded from targeting rather than targeted. Because delivery is file-based, this destination is designed for batch audience delivery, not real-time event streaming. Event data cannot be sent through it. > [!NOTE] > > In the destination picker the tile is labelled **Sportsradar**. Search for `Sport` to find it. ## Prerequisites > [!NOTE] > > Before you start, confirm the following. Only the last two are entered in the Zeotap CDP app. > > * **Delivery location** — the cloud storage location Sportradar reads from, and its credentials, are configured by Zeotap during onboarding. If your organisation has not been onboarded to Sportradar yet, contact your Zeotap account manager. > * **Destination and audience permissions** — you need access to the **Integrate** application to create destinations, and to the **Audiences** application to link an audience to one. > * **The brand or property the audience belongs to** — this determines which action you select, so identify it before you start. > * **An audience** — create the audience in Zeotap CDP first. See [Create an audience](/articles/segment-customer/create-an-audience). ### Supported identifiers This destination accepts a single destination field, **User IDs** (String) — the user identifier Sportradar matches against the users it can reach. Map one Catalogue attribute to it. ### Available actions and supported features Your Sportradar destination is provisioned with **one exclusion action per brand or property your organisation runs**. Each action sends the user ID for that brand, so the action you choose and the audience's brand must line up. Action names follow the pattern `Send User ID to [brand] for Exclusion`. | Action | [ID EXTENSION](/articles/segment-customer/extend-your-audience#id-extension) | [DELETE](/articles/segment-customer/delta-upload-and-delete-functions) | [DELTA UPLOAD](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | `Send User ID to [brand] for Exclusion` | - | ✅ | ✅ | If your organisation runs more than one brand, create a separate destination and mapping per brand, and name each one so the brand is obvious — for example `Sportradar – [brand] exclusion`. ## How the connection works Zeotap delivers to Sportradar through a **cloud storage drop** rather than a direct API call: 1. Zeotap writes the audience to the storage location agreed during onboarding. 2. Sportradar reads that location on a schedule and ingests the audience. 3. As audience membership changes, Zeotap writes delta files so Sportradar's copy stays current. You do not enter bucket details, folder paths or access keys anywhere in the Zeotap CDP app — the destination form asks only for a name and an instance. ## Configure the destination **1. Open the Destinations application** Sign in to the Zeotap CDP app and go to **Integrate → Destinations**. **2. Select the Sportradar destination** Click **+ Create Destination**. Under **All Destinations**, search for `Sport` and select the **Sportsradar** tile. ![All Destinations search filtered to Sport, showing the Sportsradar destination tile](https://mintcdn.com/zeotap/WYkctbMw8zMkB8Yi/articles/integrate-customer/Storage/integrate-customer/sportradar/sportradar-2026-09-17-1.png?fit=max\&auto=format\&n=WYkctbMw8zMkB8Yi\&q=85\&s=748e91e7eed47e77f371d5667ba375ed) **3. Enter the destination details** On the **Enter Destination Details** screen: 1. In **Destination Name**, enter a name that makes the brand and purpose obvious — for example `Sportradar – [brand] exclusion`. 2. In **Destination Instance**, enter a unique instance name for this destination. This value identifies the destination as distinct, so give each destination its own. There are no credential fields to complete — the connection itself is configured by Zeotap. ![Enter Destination Details screen with the Destination Name and Destination Instance fields](https://mintcdn.com/zeotap/WYkctbMw8zMkB8Yi/articles/integrate-customer/Storage/integrate-customer/sportradar/sportradar-2026-09-17-2.png?fit=max\&auto=format\&n=WYkctbMw8zMkB8Yi\&q=85\&s=bc2a9f0a1781f7fc807c25d1a5326b57) Click **Next** to go to the Mapping screen. **4. Name the mapping, choose the action and map the field** 1. At the top of the screen, click the pencil beside **Untitled Mapping** and give the mapping a name. 2. Under **Choose your Action**, select the exclusion action for the brand this audience belongs to. 3. Under **Map the Fields**, map the Catalogue attribute holding that brand's user identifier to the **User IDs** destination field. ![Mapping screen with the mapping name, Choose your Action dropdown and the Map the Fields panel showing the User IDs destination field. The brand name in the action is redacted.](https://mintcdn.com/zeotap/WYkctbMw8zMkB8Yi/articles/integrate-customer/Storage/integrate-customer/sportradar/sportradar-2026-09-17-3.png?fit=max\&auto=format\&n=WYkctbMw8zMkB8Yi\&q=85\&s=49b3ff2cb15c2f1a015563ab486781ea) > [!NOTE] > > The brand name is redacted in this screenshot. In your workspace the action carries your own brand name — for example `Send User ID to [your brand] for Exclusion`. **5. Create the destination** Click **Create Destination**. The destination is added to the list in the **Audiences** application and can now be linked to an audience. ## Link an audience to the destination Once the destination exists, link an audience to it from the **Audiences** application. Open the audience, choose **Select Destination**, and search for the destination you created. ![Select Destination panel with a search for the Sportradar destination and the matching destination card](https://mintcdn.com/zeotap/WYkctbMw8zMkB8Yi/articles/integrate-customer/Storage/integrate-customer/sportradar/sportradar-2026-09-17-4.png?fit=max\&auto=format\&n=WYkctbMw8zMkB8Yi\&q=85\&s=f697a95be2a19917388e4b6c3c382d63) Select the mapping you created, and check it matches the audience's brand — a brand's audience must send that brand's user IDs. Under **Destination Settings**, review **Channel Consent Rule**, then set **Refresh Frequency**: * **One-time push** sends the audience once and creates no recurring schedule — the destination becomes inactive after the push completes. By default it runs as soon as you click **Save Destination**; set a **Start Date** and a specific time, with a timezone, if you want the single push to run at a particular moment instead. * A **recurring schedule** syncs on a cadence — hourly, daily, weekly or monthly — and requires an end date. For exclusion targeting, a recurring daily refresh keeps the suppression list current. ![Destination Settings tab showing Channel Consent Rule, Refresh Frequency set to One-time push, Start Date, specific time and Timezone](https://mintcdn.com/zeotap/WYkctbMw8zMkB8Yi/articles/integrate-customer/Storage/integrate-customer/sportradar/sportradar-2026-09-17-5.png?fit=max\&auto=format\&n=WYkctbMw8zMkB8Yi\&q=85\&s=415a4c829ea75a559e70d6db00e9667c) Click **Save Destination**. The audience is queued for delivery to Sportradar. For the full linking flow see [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination); for every scheduling option see [Audience Scheduling](/articles/segment-customer/audience-scheduling). If a consent rule is configured for the mapping or its parent channel, it is applied on top of your audience definition before activation — see [Consent Orchestration](/articles/protect-customer/consent-orchestration-2830401643#consent-rule-at-channel-level). ## Understand delta updates After the first delivery, Zeotap sends only what has changed. Both **associations** (users joining the audience) and **dissociations** (users leaving it) are handled automatically as delta updates, so Sportradar's copy of the suppression list tracks the audience as it changes. You do **not** need to create a separate delta or removals mapping. Once the audience is linked and saved, the changes are sent on their own. For how delta and delete operations work across destinations, see [Delta Upload and Delete functions](/articles/segment-customer/delta-upload-and-delete-functions). ## Confirm the audience was sent Delivery goes straight from Zeotap to Sportradar's cloud storage. That location is not exposed to you, so there is no bucket or folder you can open to check the files — you cannot verify the delivery yourself. What you can confirm in the Zeotap CDP app is that the audience was linked and the refresh ran: 1. Open the audience in the **Audiences** application and confirm the Sportradar destination card is attached, showing the mapping you selected. 2. Check the destination's last refresh against the schedule you set under **Refresh Frequency**. To confirm the audience actually arrived, or to check the user ID count on Sportradar's side, contact **Zeotap support** or your **Sportradar support** contact. Sportradar reads the storage location on its own schedule, so the audience lands on their side after their next ingestion run rather than immediately on save. ## Troubleshoot common issues | What you see | What it means | Where to look | | :- | :- | :- | | No exclusion action appears under **Choose your Action** | The destination has not been provisioned with an action for your organisation's brands | Contact your Zeotap account manager | | The wrong brand's users are being suppressed | The mapping's action does not match the audience's brand | **Audiences → your audience → Destination Settings**, and the action on the mapping | | The audience never reaches Sportradar | The refresh has not run yet, or the schedule was left as a one-time push that has already fired | **Destination Settings → Refresh Frequency**, and [Audience Scheduling](/articles/segment-customer/audience-scheduling) | | Fewer users than expected arrive | A channel consent rule is being applied on top of the audience definition | [Consent Orchestration](/articles/protect-customer/consent-orchestration-2830401643#consent-rule-at-channel-level) | | Users who left the audience are still being suppressed | Sportradar has not yet ingested the latest delta file | Confirm the last refresh time, then contact Zeotap support or your Sportradar support contact | If the audience has refreshed successfully and none of the rows above match, contact Zeotap support with the destination name, the linked audience name, the mapping name, and the expected time of the last refresh in your time zone. ## FAQ > [accordion] Do I need a separate destination for each brand? > > The action is brand-specific, so the mapping must match the brand whose user IDs you are sending. Create a destination and mapping that reflect that brand, and name both clearly so the right one is easy to pick later. > [accordion] What happens when a user drops out of the audience? > > That change is captured as a dissociation and sent to Sportradar as part of the automatic delta update. No manual action is needed. > [accordion] Do I need to set up a separate delta or removals mapping? > > No. Associations and dissociations are both handled automatically once the audience is linked and saved. > [accordion] Do I need to provide storage credentials or a bucket path? > > No. The storage location and its credentials are configured by Zeotap during onboarding. The destination form asks only for a destination name and an instance. > [accordion] Can I see the files that were delivered to Sportradar? > > No. Delivery goes directly from Zeotap to Sportradar's cloud storage, and that location is not exposed to you — there is no bucket or folder for you to open. You can confirm in the Zeotap CDP app that the audience is linked and the refresh ran; to confirm the audience arrived, contact Zeotap support or your Sportradar support contact. > [accordion] Can I send event data or profile attributes through this destination? > > No. The action sends a single destination field, **User IDs**. This destination delivers audience membership for suppression, not event data or profile attributes. ## Next steps * [Explore linking an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore the scheduling options for a linked audience →](/articles/segment-customer/audience-scheduling) * [Explore how delta and delete operations work →](/articles/segment-customer/delta-upload-and-delete-functions) # StackAdapt DSP Source: https://docs.zeotap.com/articles/integrate-customer/stackadapt-dsp Set up the StackAdapt DSP destination in Zeotap CDP to push audiences to the S3 bucket provided by StackAdapt for programmatic activation. ## What this is StackAdapt is an AI-powered demand-side platform (DSP) that runs programmatic advertising campaigns across display, native, video, connected TV, audio, and in-game inventory. The Zeotap CDP integration with StackAdapt pushes your audiences to an S3 bucket that StackAdapt provisions for your advertiser account; StackAdapt then ingests those files and makes the audiences available for targeting. Each StackAdapt destination in Zeotap CDP is configured to send exactly one identifier type — StackAdapt Cookies, mobile advertising IDs, or IP addresses — chosen when you configure the action and mapping. To send more than one identifier type, create one StackAdapt destination per type. ## Prerequisites > [!NOTE] > > Before you create the destination, obtain the following from your StackAdapt point of contact: > > * **3P Marketplace Advertiser ID** — the identifier StackAdapt uses to route your audiences to the correct advertiser account and its provisioned S3 bucket. > * **Destination Instance Name** — the name that will be used for the internal reference of the destination inside Zeotap CDP. ## Supported identifiers This integration supports the following identifiers, one per destination: * **Mobile Advertising IDs (MAIDs)** — AAID (Android) and IDFA (iOS). * **IP Address**. * **StackAdapt Cookies**. ## Create the StackAdapt destination **Step 1** Log into the Zeotap CDP app and open the **DESTINATIONS** application. Click **+ Create Destination**. ![Destinations application with the + Create Destination button](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/integrate-customer/ADOBE_DMP_3.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=6075f08f8549bf57641bc708bedd2c67) **Step 2** Under **All Destinations**, search for **StackAdapt** and open the StackAdapt tile. ![Searching for a destination under All Destinations](https://mintcdn.com/zeotap/99ae7Xt83Dkoy1LQ/articles/integrate-customer/Storage/integrate-customer/integrate-customer/ADOBE_DMP_4.png?fit=max\&auto=format\&n=99ae7Xt83Dkoy1LQ\&q=85\&s=6f2123e794a7b43ed44d9d40d0075893) **Step 3** On the destination details screen, complete the configuration fields on the right-hand side: a. Enter a name for the destination in **Destination Name**. b. Enter the 3P Marketplace Advertiser ID provided by StackAdapt in **Advertiser ID**. c. Enter the **Destination Instance Name** from your prerequisites. ![StackAdapt destination configuration form with the Destination Name, Advertiser ID and Destination Instance Name fields](https://mintcdn.com/zeotap/IaZjYE7XwRssOe8Q/articles/integrate-customer/Storage/integrate-customer/stackadapt-dsp/stackadapt-dsp-2025-10-31-1.png?fit=max\&auto=format\&n=IaZjYE7XwRssOe8Q\&q=85\&s=7c70807d2c04915c0aee4943c115811c) Review the values and click **Next** to continue to mapping. **Step 4** On the **Action and Mapping** screen, choose one action — this choice fixes the identifier type this destination will send: * **Send Cookie to Stackadapt** — sends StackAdapt Cookies only. ![Action and Mapping screen with the Send Cookie to Stackadapt action selected](https://mintcdn.com/zeotap/IaZjYE7XwRssOe8Q/articles/integrate-customer/Storage/integrate-customer/stackadapt-dsp/stackadapt-dsp-2025-10-31-2.png?fit=max\&auto=format\&n=IaZjYE7XwRssOe8Q\&q=85\&s=8d0a90de1ce246fd0a02ceb56d4462ff) * **Send Maid to Stackadapt** — sends MAIDs only. ![Action and Mapping screen with the Send Maid to Stackadapt action selected](https://mintcdn.com/zeotap/IaZjYE7XwRssOe8Q/articles/integrate-customer/Storage/integrate-customer/stackadapt-dsp/stackadapt-dsp-2025-10-31-4.png?fit=max\&auto=format\&n=IaZjYE7XwRssOe8Q\&q=85\&s=2a14b55a180953add9492cfb94cbeef4) * **Send IP address** — sends IP addresses only. ![Action and Mapping screen with the Send IP address action selected](https://mintcdn.com/zeotap/IaZjYE7XwRssOe8Q/articles/integrate-customer/Storage/integrate-customer/stackadapt-dsp/stackadapt-dsp-2025-10-31-5.png?fit=max\&auto=format\&n=IaZjYE7XwRssOe8Q\&q=85\&s=0ca4417d6d8d4962a314e5b0f86201de) Then map the **Catalogue** fields (your Zeotap catalogue attributes) to the corresponding **Destination** fields for the selected action. **Step 5** Click **Create Destination**. The destination is created and listed in the **Audiences** application, where it can be linked to an audience. The action you pick on the mapping screen is the single decision that determines what StackAdapt receives from this destination: ```yaml theme={null} # Action on the mapping screen → identifier sent to StackAdapt Send Cookie to Stackadapt: StackAdapt Cookies Send Maid to Stackadapt: Mobile Advertising IDs (AAID, IDFA) Send IP address: IP Address ``` ## Link an audience to the destination Once the destination is created, link an audience to it from the **Audiences** application. For the step-by-step procedure, refer to [Link an Audience to the Destination](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > The terms **Audiences** and **Segments** are used interchangeably in Zeotap CDP to refer to customer cohorts belonging to a specific category — for example, customers who are over 18 years of age and have performed an `addToCart` event within the last 30 days. ## Verify the destination is set up You know the setup worked when all of the following are true: 1. After you click **Create Destination**, the new destination appears in the list of destinations available for linking in the **Audiences** application. 2. After you link an audience to the destination, the audience shows a delivery status against the StackAdapt destination in the Audiences application. 3. Files for the linked audience land in the S3 bucket that StackAdapt provisioned for the advertiser matching your **3P Marketplace Advertiser ID**. ## Troubleshooting If the destination does not behave as expected, match what you see in the UI to a row below and act on the location listed. | Condition you see | What it means | Where to look | | - | - | - | | StackAdapt does not appear when searching **All Destinations** | Your Zeotap CDP account is not entitled to the StackAdapt integration | Destinations → All Destinations search | | **Next** does not proceed from the destination details screen | A required field is empty or invalid — the destination name or the **3P Marketplace Advertiser ID** | The destination configuration form (right-hand pane) | | The new destination is missing from the list to link | Step 5 (**Create Destination**) did not complete — recreate the destination | Audiences application → destination selector | | An audience linked to the destination shows no delivery | The identifier the destination is configured to send is empty for that audience — for example, a **Send Maid to Stackadapt** destination linked to an audience of profiles without MAIDs | Audiences → the linked audience → destination status | | Files do not appear in the StackAdapt S3 bucket | The **3P Marketplace Advertiser ID** does not match the advertiser account StackAdapt provisioned the S3 bucket for | Destination configuration → 3P Marketplace Advertiser ID | For conditions that remain after these checks, contact your Zeotap customer success representative. Include the **Destination Instance Name**, the **3P Marketplace Advertiser ID**, the **audience ID** you linked, and the timestamp of the most recent activation attempt. ## Next steps * [Explore linking an audience to the destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore Amazon DSP as an alternative programmatic destination →](/articles/integrate-customer/amazon-dsp) * [Explore Amazon Conversions API for server-to-server conversion events →](/articles/integrate-customer/amazon-conversions-api) * [Explore Active Agent for omnichannel DSP activation →](/articles/integrate-customer/active-agent-virtual-minds) # Supported File Formats Source: https://docs.zeotap.com/articles/integrate-customer/supported-file-formats The character encodings Zeotap CDP accepts for files uploaded to a flat-file source, and the encodings it does not accept. ## What this is This page lists the character encodings Zeotap CDP accepts for the files you upload to a [flat-file source](/articles/integrate-customer/flat-files), whether the file is delivered through Zeotap Google Cloud Storage or through SFTP. It covers encoding only. The file format (CSV or JSON) and the delimiter are fixed when the source is created, and every later file uploaded to that source must use the same format and delimiter — mixing formats within one source corrupts ingestion. Column names must keep the same casing across files too, otherwise a renamed column is treated as a new one. See [Best Practices for Flat File Source](/articles/integrate-customer/best-practices-for-flat-file-source-2709422090) for those rules and for the full set of checks to run on a sample file before the first upload. ## Supported character encodings Check the encoding of a sample file against this table before you upload it. Confirming that the encoding type is one of the supported types is one of the file validations Zeotap recommends ahead of ingestion. | **Encoding Type** | **Supported** | | :- | :- | | UTF-8 | Yes | | UTF-8 with BOM | Yes | | Western (Windows 1252) | Yes | | Central European (Windows 1250) | Yes | | UTF-16 LE | No | | UTF-16 LE with BOM | No | | UTF-16 BE | No | | UTF-16 BE with BOM | No | ## FAQ > [accordion] Do I need to remove the byte-order mark from a UTF-8 file? > > No. UTF-8 and UTF-8 with BOM are both listed as supported, so a UTF-8 file can be uploaded either way. > [accordion] Can I upload a UTF-16 file? > > No. All four UTF-16 variants — LE, LE with BOM, BE, and BE with BOM — are unsupported. Re-save the file in one of the supported encodings, such as UTF-8, before you upload it. > [accordion] Which sources do these encodings apply to? > > Files uploaded to a flat-file source, delivered either through Zeotap Google Cloud Storage or through SFTP. See [Flat Files](/articles/integrate-customer/flat-files) for the two transfer methods. > [accordion] What should I check if a file fails to parse? > > When a file cannot be parsed, the status records a `Parse error` against the whole file. View it under **Integrate > Sources > \[Source Name] > SOURCE REPORT > File Ingestion Details**. The remediation is to verify the delimiter, encoding, and header row of the file against the source configuration, correct the file, and re-ingest. See [Understanding the Ingestion Log Error](/articles/integrate-customer/understanding-the-ingestion-log-error). ## Next steps * [Explore best practices for flat-file sources →](/articles/integrate-customer/best-practices-for-flat-file-source-2709422090) * [Explore the two flat-file transfer methods →](/articles/integrate-customer/flat-files) * [Explore how to read ingestion log errors →](/articles/integrate-customer/understanding-the-ingestion-log-error) * [Explore Sources in Zeotap CDP →](/articles/integrate-customer/sources) # Tableau AWS S3 Source: https://docs.zeotap.com/articles/integrate-customer/tableau-aws-s3 Destination: send Zeotap CDP audiences as CSV files to your Amazon S3 bucket, then connect that bucket to Tableau with the Amazon S3 connector. ## What this is Tableau AWS S3 is a **destination** — data leaves Zeotap CDP. Zeotap CDP writes your audiences (segments) as CSV files into an Amazon S3 bucket you own, and Tableau then reads those files straight from the bucket using its Amazon S3 connector, so analysts can prep, discover and visualise the audience alongside the rest of their reporting. To bring data the other way — from Amazon S3 *into* Zeotap CDP — see the [Amazon S3](/articles/integrate-customer/amazon-s3) source instead. Delivery runs in two hops, and this page covers both: 1. **Zeotap CDP → your S3 bucket.** Configured as an Amazon S3 destination. The destination form is documented in full on [Amazon S3 destination](/articles/integrate-customer/amazon-s3-destination); this page gives the outline and adds what a Tableau reader needs on top. 2. **Your S3 bucket → Tableau.** Configured in Tableau with the Amazon S3 connector. This page owns that half. > [!NOTE] > > **Note:** > > Amazon S3 is not the only route into Tableau. You can use another storage destination to push the data, as long as that service is available to your Tableau instance as a data source. Configure it the same way you would any other destination. ## Prerequisites > [!NOTE] > > **Note:** > > Gather the following before you begin. > > **On the AWS side** > > * An account with Amazon S3, and the bucket you want Zeotap CDP to write to. > * The **Bucket**, **S3 Bucket Region**, **Folder** and credentials for that bucket — see [Gather your Amazon S3 details](#gather-your-amazon-s3-details). > > **On the Tableau side** > > * Tableau Desktop or Server (2023.2 or later recommended). > * AWS IAM credentials with read access to the S3 bucket. > * The Amazon S3 connector installed via Tableau Exchange, if it is not already present. > > **In Zeotap CDP** > > * Access to the **Destinations** application, and an audience (segment) to activate. ## Supported identifiers and actions This integration supports MAIDs, hashed email addresses, hashed mobile numbers and CRM IDs. You can send any number of identifiers and attributes to Amazon S3 using this integration. Two [actions](/articles/integrate-customer/destinations#key-concepts) are available when you configure the destination: * **Send identifiers to Amazon S3 Audiences** — sends MAIDs, IDP Base, raw mobile numbers and raw email addresses. * **Send attributes and identifiers to Amazon S3 Audiences** — sends any attributes and identifiers you add with the **+ Add Mapping Field** option. ## Gather your Amazon S3 details You need these bucket details in two places: in the Zeotap CDP destination, and again when Tableau connects to the same bucket. ### Bucket This is the name of your S3 bucket. You can obtain this information on your Amazon S3 account by navigating to Buckets. In the example shown below, **test-adobe-s3-bucket** is the bucket name. ![Bucket name listed under Buckets in the Amazon S3 console](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-an-amazon-s3-source/amazon_s3_pre_1_\(1\).png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=285e645295f67b8e7ed9880ed63f79fe) ### S3 Bucket Region This is the geographical location where the Amazon S3 storage is available. You can obtain this information by navigating to the **Properties** tab under the Amazon S3 bucket as shown in the image below. ![AWS Region shown on the Properties tab of an Amazon S3 bucket](https://mintcdn.com/zeotap/nvqTscX2rya8znmd/articles/integrate-customer/Storage/integrate-customer/create-an-amazon-s3-source/amazon_s3_pre_2_\(1\).png?fit=max\&auto=format\&n=nvqTscX2rya8znmd\&q=85\&s=d4920504cf29017e61b52e67b48d80d6) ### Folder In Amazon S3, a folder serves as a logical container for organising stored objects within a bucket. In reality, there are no actual folders in Amazon S3. Instead, the folder concept is emulated by employing object key names containing slashes ("/") to replicate a hierarchical arrangement. You can obtain this information from your Amazon S3 account by navigating to the **Objects** tab under the Amazon S3 bucket as shown in the image below. ![Folders listed on the Objects tab of an Amazon S3 bucket](https://mintcdn.com/zeotap/ROPrHg77hrORMuiL/articles/integrate-customer/Storage/integrate-customer/create-an-amazon-s3-source/amazon_s3_pre_3_\(1\).png?fit=max\&auto=format\&n=ROPrHg77hrORMuiL\&q=85\&s=6b21f4fa5854f281b445578813dcc048) Ensure that you follow the folder structure shown below. `folder_name/sub_folder_name/` ### Access Token and Secret Access Token These are the security tokens that provide secure access to your Amazon S3 resources. You can obtain the Access Token and Secret Access Token by navigating to the **AWS IAM Credentials** tab under **Security credentials** in your Amazon S3 account. These are the values you enter in the Zeotap CDP destination. Tableau signs in to the bucket separately, with an AWS Access Key ID and Secret Access Key you enter in Tableau — see [Connect the bucket to Tableau](#connect-the-bucket-to-tableau). ## Create the Amazon S3 destination in Zeotap CDP Zeotap CDP delivers to the bucket through its Amazon S3 destination, and the same configuration applies to the Tableau AWS S3 destination. The full walkthrough — every field, with screenshots — lives on [Amazon S3 destination](/articles/integrate-customer/amazon-s3-destination). Follow it with the values you gathered above. In outline: **Step 1** Log into the Zeotap CDP App and go to the **DESTINATIONS** application, then click **+ Create Destination**. **Step 2** Under the **All Destinations** section, search for **Amazon S3** and click it. **Step 3** Provide the destination details: a name for the destination, the **Destination Instance Name**, the **Bucket**, the **S3 Bucket region**, the **Folder**, a **Filename Prefix**, and the **Access Token** and **Secret Access Token** you obtained from your Amazon S3 account. Then set **Encryption Choice** — the field has no default, so open **Select your choices** and pick either **Encrypt with PGP** or **Send without Encryption**. Review the values and click **Next**. **Step 4** Choose the [action](/articles/integrate-customer/destinations#key-concepts) — **Send identifiers to Amazon S3 Audiences** or **Send attributes and identifiers to Amazon S3 Audiences** — and complete the [mapping](/articles/integrate-customer/destinations#define-the-mapping). **Step 5** Click **Create Destination**. The created Destination gets listed in the **Audiences** application, which can be linked to an audience. ### How the exported files are named The **Filename Prefix** takes a text value without special characters, such as underscores (`_`), spaces, or symbols (`#, @, $, %, &, *`). Zeotap CDP writes files into the folder you configured, following this format: `${filenamePrefix}part-${sequence}_${destinationAudienceId}_${timestamp}.csv` The timestamp is the file generation time in epoch milliseconds (UTC), and `destinationAudienceId` is the ID associated with your audience (segment) in Zeotap CDP, generated after the audience is linked to a Destination. For example: `exportpart-0_894548842_1722931200000.csv` The variable-by-variable breakdown is on [Amazon S3 destination](/articles/integrate-customer/amazon-s3-destination). Knowing the pattern matters here, because it is how you recognise the right files when you browse the bucket from Tableau. ## Link an audience to the destination For information about how to link an Audience or segment to the created Destination in the **Audiences** application, refer to [Link an Audience to the Destination](/articles/integrate-customer/link-an-audience-to-the-destination). > [!NOTE] > > **Note:** > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an Audience or a segment could be a specific group of customers who are over 18 years of age and who have performed an `addToCart` event within the last 30 days. ## Connect the bucket to Tableau The Tableau Amazon S3 connector lets you connect Tableau directly to data files stored in Amazon S3 buckets. Supported file formats include CSV, Excel and Parquet, both compressed and uncompressed — Zeotap CDP exports CSV. The connection lets Tableau analysts prep, discover and visualise insights from cloud data, leveraging Tableau's Hyper engine for high performance. **1. Install the connector** If necessary, download the connector (`.taco` file) and place it in Tableau's **Connectors** folder for your operating system. Restart Tableau. **2. Create a connection** * Launch Tableau and go to **Connect** > **To a Server** > **Amazon S3**. * Enter the AWS region, S3 bucket name, your IAM Access Key ID and Secret Access Key. * Click **Sign In**. **3. Browse and select files** * Upon successful authentication, you'll see the contents of your bucket. * Navigate to the folder you configured on the destination and select the relevant file(s). You can drag multiple files into Tableau's canvas to create unions or joins if desired. **4. Configure the data source** * Optionally rename your data source for clarity. * Drag files into the canvas as needed. * Use Tableau's data prep tools (join, union, filter) to organise your data quickly. * Click into *Sheet 1* or further tabs to begin your analysis. ## Verify the delivery After linking an audience and letting an activation run, confirm the hand-off at all three points: 1. **In Zeotap CDP** — open the destination and review its activity. A successful delivery records a completed run with a non-zero qualified count; a failed run records an error message you can use to diagnose the cause. 2. **In Amazon S3** — open the bucket and the folder you configured, and confirm a CSV file is present whose name starts with your **Filename Prefix** and carries the expected date. 3. **In Tableau** — reconnect or refresh the Amazon S3 connection, browse to the same folder, and confirm the file is listed and its fields load when you drag it into the canvas. If the run completed in Zeotap CDP but no file reaches the bucket, re-check the **Bucket**, **S3 Bucket Region**, **Folder** and credentials on the destination. For the delivery errors that surface on an audience–destination pair and what each one means, see [Destinations](/articles/integrate-customer/destinations). ## FAQ > [accordion] Which file formats can Tableau read from the bucket? > > The Amazon S3 connector supports CSV, Excel and Parquet files, both compressed and uncompressed. Zeotap CDP exports audiences as CSV, so no conversion step is needed. > [accordion] Can I use a storage service other than Amazon S3? > > Yes. You can use other services to push the data, provided the service is available to your Tableau instance as a data source. Configure it as a normal destination in Zeotap CDP. > [accordion] Do I need to install anything in Tableau first? > > Tableau needs the Amazon S3 connector. If it is not already present, install it via Tableau Exchange, or download the `.taco` file, place it in Tableau's **Connectors** folder for your operating system, and restart Tableau. ## Next steps * [Explore the Amazon S3 destination →](/articles/integrate-customer/amazon-s3-destination) — the full field-by-field walkthrough of the destination this page configures * [Explore the Amazon S3 source →](/articles/integrate-customer/amazon-s3) — the opposite direction, bringing S3 data into Zeotap CDP * [Explore linking an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) — activate an audience against the destination you just created * [Explore Looker →](/articles/integrate-customer/looker) — the same pattern for a BI tool reading exported audiences from Google Cloud Storage # Taboola Source: https://docs.zeotap.com/articles/integrate-customer/taboola Send Zeotap CDP audience identifiers out to your Taboola advertiser seat for activation as a custom audience. This page covers the Taboola destination, which sends audience identifiers **out of Zeotap CDP** to your Taboola advertiser account (seat), where they are activated as a custom audience. Data moves in one direction only: Zeotap CDP does not read data back from Taboola. After you link an audience, two details have to reach the Taboola team by email — see [Taxonomy file and Channel ID](/articles/integrate-customer/appendix-taboola-destination). ## What this is Taboola is a content discovery and native advertising platform that helps marketers drive traffic and engagement to their websites. Integrated with Zeotap CDP, it lets marketers use the content discovery platform to drive engagement and meet their business goals through programmatic advertising. The Taboola destination is a batch integration for audiences: you configure it once against a Taboola Seat ID and then reuse it for every audience you link to it. Taboola appears in the [integrations master list](/articles/integrations-master-list-publication/integrations-master-list) as a destination only — there is no Taboola source integration, so nothing flows from Taboola into the CDP. ## Supported identifiers The Taboola destination accepts: * Mobile advertising IDs (MAIDs) * Taboola Cookies On the mapping screen these appear as the Catalogue fields **Maid** and **Taboola**, mapped to the Taboola destination fields **MAID** and **Taboola Cookie**. ## Available actions | Action | ID Extension | Delete | Delta Upload | | - | - | - | - | | Send identifiers to Taboola | ✅ | — | — | The destination exposes a single action, **Send identifiers to Taboola**. It supports [ID Extension](/articles/segment-customer/extend-your-audience#id-extension) for expanding an audience before delivery. Taboola is not listed among the integrations where [Delete and Delta Upload](/articles/segment-customer/delta-upload-and-delete-functions) are enabled. ## Prerequisites > [!NOTE] > > Before you create the destination, gather: > > * **Your Taboola Seat ID** — the ID of your Taboola advertiser account. This is the only Taboola detail the integration requires; see [Get your Taboola Seat ID](#get-your-taboola-seat-id) below. > * **Access to the Taboola console** for the account you want to deliver to, so you can read the Seat ID. > * **The currency for the destination.** USD is selected by default. > * An audience to activate, and the destination rights described in the [Destinations prerequisites](/articles/integrate-customer/destinations#prerequisites). ## Get your Taboola Seat ID Log in to the Taboola console and open the **Audiences** page for the account you want to deliver to. The Seat ID is the account ID carried in the page URL — copy it from the browser address bar, as highlighted below. ## Create the Taboola destination **Step 1** Log in to the Zeotap CDP app and go to **Integrate > Destinations**. **Step 2** Click **+ Create Destination**. ![The Destinations listing in Zeotap CDP with the Create Destination button highlighted](https://mintcdn.com/zeotap/IaZjYE7XwRssOe8Q/articles/integrate-customer/Storage/integrate-customer/tabmo-hawk/ADOBE_DMP_3.png?fit=max\&auto=format\&n=IaZjYE7XwRssOe8Q\&q=85\&s=d0772aa322e0b598f3fd92597bf5e752) **Step 3** Under **All Destinations**, search for **Taboola**. ![The All Destinations catalogue with the Search for a Destination box highlighted](https://mintcdn.com/zeotap/IaZjYE7XwRssOe8Q/articles/integrate-customer/Storage/integrate-customer/tabmo-hawk/ADOBE_DMP_4.png?fit=max\&auto=format\&n=IaZjYE7XwRssOe8Q\&q=85\&s=60bab5aa85170d32076d4cf83eb8218d) **Step 4** Click **Taboola**. Details about the destination appear on the left of the screen; the fields the integration needs appear on the right. Enter: a. A name for the destination. Choose a name that identifies the Taboola seat it connects to, so the destination is easy to find when you link an audience. b. The Taboola **Seat ID** you copied above. c. The **Currency**. USD is selected by default. d. Review the values you entered, then click **Next**. ![The Enter Destination Details step for Taboola, showing the Destination Name, Taboola Seat ID and Currency fields](https://mintcdn.com/zeotap/IaZjYE7XwRssOe8Q/articles/integrate-customer/Storage/integrate-customer/tabmo-hawk/taboola.png?fit=max\&auto=format\&n=IaZjYE7XwRssOe8Q\&q=85\&s=62a2011c1572c40980fea3466e8ed30a) **Step 5** On the mapping screen, choose the action and the identifiers to send: a. Under **Choose your Action**, select **Send identifiers to Taboola**, then choose the corresponding identifiers under **Map the Fields**. The [output identifiers](/articles/segment-customer/choose-the-output-identifiers) the platform accepts — MAIDs, Cookies and more — are shown by default. You can edit, add or remove an identifier from the list; see [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping). b. Click **Create Destination**. The created destination is then listed in the **Target** and **Audiences** applications, ready to be linked to an audience. ![The Mapping step with Send identifiers to Taboola selected and the Maid and Taboola catalogue fields mapped to MAID and Taboola Cookie](https://mintcdn.com/zeotap/IaZjYE7XwRssOe8Q/articles/integrate-customer/Storage/integrate-customer/tabmo-hawk/taboola_2.png?fit=max\&auto=format\&n=IaZjYE7XwRssOe8Q\&q=85\&s=b5f4acc1e27d49c03f6c270730323a29) For the two entry points into destination configuration and what each part of the configuration does, see [Configure a destination](/articles/integrate-customer/destinations#configure-a-destination). ## Link an audience to the destination Once the destination is created, link it to the audience you want to activate from the **Audiences** or **Target** application — see [Link an audience to the destination](/articles/integrate-customer/link-an-audience-to-the-destination) for the end-to-end workflow. It can take up to one business day for a linked segment to be available at the Taboola seat. Once the audience is linked, share both of the following with the Taboola team, which maps them to your account: * The [taxonomy file](/articles/integrate-customer/appendix-taboola-destination#taxonomy-file), sent as a CSV to your Taboola Account Manager. * The [Channel ID](/articles/integrate-customer/appendix-taboola-destination#channel-id), which Zeotap CDP generates for the audience. > [!NOTE] > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an audience or a segment can be a specific group of customers who are over 18 years of age and have performed an `addToCart` event within the last 30 days. ## Verify the audience reached Taboola Confirm delivery from both sides: 1. **In Zeotap CDP** — saving the destination settings on the linked audience moves the destination to **In Progress**, which triggers the upload of the IDs. Once all the IDs are uploaded, the status changes to **Success**. For what a successful run records, see [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). 2. **In the Taboola console** — open **Audiences > Custom Audiences** for the seat. Audiences delivered from the CDP are listed with **Zeotap** in the **Source** column, along with their status, monthly reach and Taboola's own match rate. Allow up to one business day before expecting the audience to appear. ## Troubleshoot the Taboola destination | Symptom | What it means | What to do | | - | - | - | | The audience is not in the seat's Custom Audiences list shortly after linking | Segments can take up to one business day to be available at the Taboola seat | Confirm the destination reached **Success** in Zeotap CDP, then re-check the seat after a business day | | The audience is at the seat but Taboola has not mapped it to your account | The taxonomy file, the Channel ID, or both have not reached the Taboola team — Taboola uses them to map the audience to the right client account | Share the [taxonomy file](/articles/integrate-customer/appendix-taboola-destination#taxonomy-file) and the [Channel ID](/articles/integrate-customer/appendix-taboola-destination#channel-id) with your Taboola Account Manager | | The delivery completes but Taboola matches far fewer users than the audience holds | The identifiers mapped on the destination are not identifiers Taboola holds for those users | Review the destination's mapping and confirm the mapped identifiers (MAIDs, Taboola Cookies) are actually present on the audience | | The Seat ID on the destination does not match the account you expect | The destination was configured against a different Taboola advertiser account | Re-read the account ID from the Taboola console URL and correct the Seat ID on the destination | For delivery errors that are not specific to Taboola — no customers qualified, a terminated refresh, a rejected payload — see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail) and [When to contact support](/articles/integrate-customer/destinations#when-to-contact-support). ## Next steps * [Explore the taxonomy file and Channel ID to share with Taboola →](/articles/integrate-customer/appendix-taboola-destination) * [Explore how to link an audience to a destination →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Explore how destinations work across platforms →](/articles/integrate-customer/destinations) * [Explore ID Extension for expanding an audience →](/articles/segment-customer/extend-your-audience#id-extension) # Taboola Custom Audience Source: https://docs.zeotap.com/articles/integrate-customer/taboola-custom-audience Send Zeotap audiences to your Taboola advertiser account as first-party audiences, matched on hashed emails and mobile advertising IDs. ## Overview Taboola Custom Audience sends your Zeotap audiences to Taboola as first-party audiences in your Taboola advertiser account, where you can target them in your campaigns. Users are matched on hashed emails and mobile advertising IDs through the Taboola Backstage API. > [!NOTE] > > This is a separate Destination from [Taboola](/articles/integrate-customer/taboola), which sends Taboola cookies and MAIDs to a Taboola seat. Use Taboola Custom Audience to activate audiences built on your own customer emails or device IDs in your Taboola advertiser account. ## Supported Identifiers This integration supports the following identifiers: * **Emails**, sent as SHA-256 hashes. Taboola requires the email address to be converted to lowercase before hashing. * **MAIDs** (GAID for Android and IDFA for iOS), sent in clear text. Taboola can only match users in the countries it supports, and the list is different for emails and device IDs. Check [Taboola's supported countries](https://developers.taboola.com/backstage-api/docs/onboarding-overview#supported-countries) before you activate an audience. Audiences outside these countries will stay very small in Taboola. ## Available Actions and Supported Features The following table lists the available action types for the integration and the supported features for each action type: | Action Name | [ID EXTENSION](/articles/segment-customer/extend-your-audience#id-extension) | [DELETE](/articles/segment-customer/delta-upload-and-delete-functions) | [DELTA UPLOAD](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :- | :- | :- | | Add Email ID to 1P Audience | - | ✅ | ✅ | | Add Device ID to 1P Audience | - | ✅ | ✅ | ## Components of Taboola Custom Audience This integration requires a Taboola **advertiser** account. Ensure that you have the following details from that account before creating a Destination: * Client ID * Client Secret * Taboola Account Id ### Client ID, Client Secret and Taboola Account Id Zeotap uses these details to connect to your Taboola advertiser account and manage your audiences in it. You get all three when you generate API credentials in Taboola. Perform the following steps: **Step 1** Log into your Taboola advertiser account. **Step 2** Go to the [API Keys](https://ads.realizeperformance.com/push-api?reportId=api-keys) page. **Step 3** Generate a new set of API credentials, then copy the **Client ID**, **Client Secret** and **Account ID**. The Taboola Account Id is a text value that begins with `taboolaaccount-`, as shown in the hint on the field. Do not use a numeric account ID in its place. If the API Keys page is not available in your account, ask your Taboola account manager to enable API access or to issue the credentials for you. > [!WARNING] > > The Client Secret gives access to your Taboola account. Enter it only in the Destination setup screen and do not share it over email or chat. If you generate new credentials in Taboola later, update them in the Destination. ## Create a Destination for Taboola Custom Audience Perform the following steps to create a Destination for Taboola Custom Audience: **Step 1** Log into the Zeotap CDP App and go to the **DESTINATIONS** application. **Step 2** Click **+ Create Destination.** ![](https://mintcdn.com/zeotap/IaZjYE7XwRssOe8Q/articles/integrate-customer/Storage/integrate-customer/tabmo-hawk/ADOBE_DMP_3.png?fit=max\&auto=format\&n=IaZjYE7XwRssOe8Q\&q=85\&s=d0772aa322e0b598f3fd92597bf5e752) **Step 3** Under **All Destinations**, search for **Taboola Custom Audience.** ![](https://mintcdn.com/zeotap/IaZjYE7XwRssOe8Q/articles/integrate-customer/Storage/integrate-customer/tabmo-hawk/ADOBE_DMP_4.png?fit=max\&auto=format\&n=IaZjYE7XwRssOe8Q\&q=85\&s=60bab5aa85170d32076d4cf83eb8218d) **Step 4** Click **Taboola Custom Audience.** A screen appears displaying details about the particular destination towards the left. On the right-hand side of the screen find a list of fields that are required for the integration to be established. Enter the required details as mentioned in the following steps: a. Under **Destination Name**, enter a name for the Destination. b. Enter the **Client ID**. c. Enter the **Client Secret**. d. Enter the **Taboola Account Id**. e. Review all the values entered above and then click **Next** to proceed. ![](https://mintcdn.com/zeotap/Xy_KICJOumPG2I2b/articles/integrate-customer/Storage/integrate-customer/taboola-custom-audience/taboola-custom-audience-2026-10-16.png?fit=max\&auto=format\&n=Xy_KICJOumPG2I2b\&q=85\&s=f69a8d2f77292a7652afa9f0c3492b14) **Step 5** In the new screen that appears, choose the appropriate action and mapping as explained below. a. Under **Choose your Action**, choose **Add Email ID to 1P Audience** or **Add Device ID to 1P Audience**, and then choose the corresponding identifiers under **Map the Fields**: * **Add Email ID to 1P Audience** maps a Catalogue Field to the `Email Id (hashed)` Destination Field. Map an email identifier hashed with SHA-256 in lowercase. * **Add Device ID to 1P Audience** maps a Catalogue Field to the `Device ID` Destination Field. Map MAIDs. You can edit, add or remove an identifier from the list. To do so, refer [here](/articles/integrate-customer/destinations#define-the-mapping). ![](https://mintcdn.com/zeotap/Xy_KICJOumPG2I2b/articles/integrate-customer/Storage/integrate-customer/taboola-custom-audience/taboola-custom-audience-2026-10-16-1.png?fit=max\&auto=format\&n=Xy_KICJOumPG2I2b\&q=85\&s=b35d288bd1551102cb6d8653596b4cba) b. Click **Create Destination**. The created Destination gets listed in the **Target** and **Audiences** applications, which can be linked to an Audience/segment. ## Link an Audience to the Taboola Custom Audience Destination For information about how to link an Audience or segment to the created Destination in the **Audiences** and **Target** applications, refer [here](/articles/integrate-customer/link-an-audience-to-the-destination). When you link an Audience, Zeotap creates a first-party audience in your Taboola account and adds the matched users to it. With [Delta Upload and Delete](/articles/segment-customer/delta-upload-and-delete-functions) enabled, each later refresh adds new users and removes users who no longer qualify. Keep the following in mind after linking: * A newly created audience can take up to one hour to become available in Taboola. * Allow one to three days for the audience to reach its full size. * Taboola reports audience size as the number of uploaded users it has seen on its network in the last 30 days. This is usually lower than the number of users Zeotap sends. * Taboola recommends testing with an audience of at least 1,000 users. Once the audience is available, you can target it in your Taboola campaigns. To check that Zeotap delivered the audience, see [Audience Status and Activation Status](/articles/segment-customer/audience-status-and-activation-status). ## View Your Audiences in Taboola To see the audiences that Zeotap has sent, log into your Taboola advertiser account and perform the following steps: **Step 1** Go to **Audiences**. **Step 2** Open the **Custom Audiences** tab. Audiences that Zeotap has pushed appear here with **Taboola API** in the **Source** column. ![](https://mintcdn.com/zeotap/Xy_KICJOumPG2I2b/articles/integrate-customer/Storage/integrate-customer/taboola-custom-audience/taboola-custom-audience-2026-10-16-2.png?fit=max\&auto=format\&n=Xy_KICJOumPG2I2b\&q=85\&s=285c56a1326f9ef02a4a695a3e77074a) The listing shows the following details for each audience: | Column | What it tells you | | :- | :- | | **Source** | Where the audience came from. Audiences sent from Zeotap show **Taboola API**. | | **Status** | Shows **Processing** while Taboola is still matching the users that Zeotap sent. | | **Monthly Reach** | The number of uploaded users Taboola has seen on its network in the last 30 days. This stays at 0 until processing completes, and is usually lower than the number of users Zeotap sends. | | **Match Rate** | The proportion of the users sent that Taboola was able to match. | | **Campaigns Using** | The number of campaigns currently targeting the audience. | > [!NOTE] > > If a newly linked audience is not listed yet, wait and check again — a new audience can take up to one hour to appear, and one to three days to reach its full size. Use the **Audience Status** filter if you have archived audiences in the account. > [!NOTE] > > **Note:** > > The terms *Audiences* and *Segments* are used interchangeably to refer to customer cohorts belonging to a specific category. For example, an Audience or a segment can be a specific group of customers who are over 18 years of age and have performed an `addToCart` event within the last 30 days. # Tag Managers (CE) Source: https://docs.zeotap.com/articles/integrate-customer/tag-managers Tag manager sources bring website events and user identities into Zeotap CDP through the Zeotap Collect Tag, deployed from the tag manager you already run. ## What this is Tag managers are a **source** category: they bring customer data *into* Zeotap CDP from your website, rather than sending data out of it. Zeotap does not supply a tag manager of its own — it publishes the **Zeotap Collect Tag** for the two tag managers it integrates with, so you deploy and manage it from the tag manager's own interface rather than editing your site's tag code for every configuration change. A tag manager simplifies implementing and managing tracking tags and scripts on a website or mobile app. It gives marketers and website administrators an interface for adding, updating, and managing tracking codes without direct involvement from developers or frequent code changes on the website. Tag manager sources carry **Customer Data (CE)** only. ## Prerequisites > [!NOTE] > > Before you create a tag manager source, confirm: > > * You have permission to create sources in your Zeotap CDP tenant. > * You already run one of the supported tag managers — a Google Tag Manager account with its container installed on your website, or an Adobe Experience Platform Tags property (Adobe Experience Platform Tags are included for Adobe Experience Cloud customers). > * You can edit tags in that tag manager, or you can work with whoever can. ## Choose your tag manager > [card] [Adobe Experience Platform Tag Extension](/articles/integrate-customer/adobe-experience-platform-tag-extension) > > The Zeotap Collect Tag Extension in the Adobe Experience Platform marketplace. Captures events and user identities, and enables cookie syncing on the web. > [card] [Google Tag Manager (GTM)](/articles/integrate-customer/google-tag-manager) > > The Zeotap Collect Tag as a custom GTM template. An asynchronous JavaScript tag that captures events and user information as customers navigate your website. ## How a tag manager source works Both tag managers follow the same three stages. 1. **Create the source in Zeotap CDP.** In the **Sources** application under **Integrate**, click **CREATE SOURCE**, choose **Tag Managers** as the category and your tag manager as the data source, then set a name, the region of upload, and **Customer Data** as the data entity. The system autogenerates a **write key** for the source — you need it in the next stage. * Google Tag Manager: [Create a Tag Manager Source](/articles/integrate-customer/creating-tag-manager-source-2676490586) * Adobe: [Create an Adobe Experience Platform Tag Extension Source](/articles/integrate-customer/create-an-adobe-experience-platform-tag-extension-source) 2. **Deploy the Zeotap Collect Tag in your tag manager, using that write key.** In Adobe Experience Platform Tags, install the Zeotap Collect Tag Extension in your property and configure it. In Google Tag Manager, add the Zeotap Collect Tag Template to your workspace from the GTM template gallery, configure the tag, and set up a trigger — the GTM template reads a data layer on your website to capture event information, so the data layer has to be in place. * Google Tag Manager: [Implement the Google Tag Manager Source](/articles/integrate-customer/implementing-google-tag-manager-source-2665775403) * Adobe: [Implement an Adobe Experience Platform Tag Extension Source](/articles/integrate-customer/implement-an-adobe-experience-platform-tag-extension-source) 3. **Confirm data is arriving.** Once the source has been taken live, open its [**PREVIEW DATA** tab](/articles/integrate-customer/knowing-the-fields-on-the-preview-data-tab) on the **SOURCES** listing page to see incoming records. ## Next steps * Explore the other ways to collect site activity in [Website Events →](/articles/integrate-customer/website-events) * Explore every source category in [Sources →](/articles/integrate-customer/sources) * Explore the full integration list in [Source Integrations (Batch+Real-Time) →](/articles/integrate-customer/creating-a-source) * Explore the developer guide for [the Zeotap GTM Tag →](/articles/sdks/gtm/intro) * Explore the developer guide for [the Adobe Launch integration →](/articles/sdks/adobe-launch/intro) * Explore how to [map the Catalogue for Customer Data (CE) →](/articles/unify-customer/map-the-catalogue-for-customer-data) # Talon.One Trigger Custom Events Source: https://docs.zeotap.com/articles/integrate-customer/talon-one Send custom events from a Zeotap CDP journey to Talon.One, so that customer activity can drive your promotion and loyalty rules. ## What this is The **Talon.One : Trigger Custom Events** destination sends custom event data **out of Zeotap CDP to Talon.One**, so that activity captured in a journey can drive your promotion and loyalty rules. Events leave Zeotap CDP from the **Send to Destinations** node of a Journeys workflow. Talon.One is an API-first promotion and loyalty engine. Marketers build rules without coding and trigger discounts, coupons, loyalty points and gamified rewards from customer data, across online, in-store and mobile channels. This destination gives those rules a live event feed from Zeotap CDP. > [!NOTE] > > Talon.One also has a batch destination. [Talon.One Audience](/articles/integrate-customer/talon-one-audience) adds customer profiles to, and removes them from, Talon.One audiences in a batch. Use that integration for audience membership, and this one for events. ## Supported identifiers and actions * **Direction** — Zeotap CDP to Talon.One, from a Journeys workflow. * **Action** — **Trigger Custom Events in Talon.One**. * **Mandatory fields** — **Profile Id** and **Custom Event Name**. Both are mapped from a Catalogue attribute, and the mapping cannot be saved until both are populated. * **Event attributes** — you can map further event attributes alongside the mandatory fields, each from a Catalogue attribute, and set the data type for each one. You can edit, add or remove entries in the list. ## Prerequisites 1. An **active Talon.One account** and Application. 2. Your **Talon.One Base URL** — the URL of your Talon.One instance, for example `https://retailstore.talon.one`. 3. A Talon.One **Integration API Key**. See **Get your Talon.One base URL and API key** below. 4. The **custom events and attributes** you want to send, defined in Talon.One. See [Creating a custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Talon.One documentation. 5. A workflow in Journeys to send the events from, with your filters and conditions already applied. See [Create a Workflow](/articles/orchestrate-customer/create-a-workflow). ## Get your Talon.One base URL and API key Both values come from Talon.One, not from Zeotap CDP. * **Base URL** — the URL of your Talon.One instance. * **Integration API Key** — in Talon.One, open the Application you want to use and go to **Settings > Integration API Keys > Create API Key**. Give the key a name and an expiration date. > [!WARNING] > > Copy the API key as soon as Talon.One generates it. It is shown only once and cannot be retrieved afterwards. For a step-by-step walkthrough of the same Talon.One screens, with screenshots, see the **Retrieving the Talon.One API Key** section of [Talon.One Audience](/articles/integrate-customer/talon-one-audience). ## Create the Talon.One destination **Step 1** Log in to the **Zeotap CDP** app and go to **Integrate > Destinations**. **Step 2** Click **+ Create Destination**. **Step 3** Under **All Destinations**, search for **Talon.One : Trigger Custom Events** and select it. **Step 4** On the **Enter Destination Details** screen, the left panel describes the integration. Enter the following on the right: a. **Destination Name** — a name that identifies this destination in Zeotap CDP. \ b. **Base URL** — the base URL of your Talon.One instance. \ c. **API Key** — the Integration API Key you generated in Talon.One. ![The Enter Destination Details screen for the Talon.One : Trigger Custom Events destination, with empty Destination Name, Base URL and API Key fields and a two-step Destination Details to Mapping progress bar above them.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-108.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=e7841e1ec663ee0778395037a2fe652f) **Step 5** Click **Next** to move to the **Mapping** step. **Step 6** Under **Choose your Action**, select **Trigger Custom Events in Talon.One**. Under **Map the Fields**, map a Catalogue attribute to each destination field. **Profile Id** and **Custom Event Name** are mandatory; add, edit or remove the optional event attribute rows beneath them as needed. ![The Mapping step with Trigger Custom Events in Talon.One selected under Choose your Action, and Map the Fields showing the required Profile Id and Custom Event Name destination fields above an event attribute row with a data-type selector.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-109.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=526e7dea07da040347ee640650b8366e) **Step 7** Click **Create Destination**. ## Link the destination to a journey The destination sends events only once it is attached to a workflow. After you have applied your filters and conditions in Journeys, link the destination in the **Send to Destinations** node. **Step 1** In the workflow, click **+** and choose **Send to Destinations**. ![The Choose an action menu in a Journeys workflow, with Send to Destinations highlighted below Add a Condition, Add a Delay, Create a Multi-branch Split and Create a True/False Split.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-110.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=2fe2fba9f868b1cd0779e9fc634feeef) **Step 2** Choose your Talon.One destination from the list of available destinations, using the search box if the list is long. You can also create a new one here with **+ Add New Destination**. ![The Send to Destinations panel listing the destinations already configured in the workspace as cards, with a highlighted search box above them and the Add New Destination link in the corner.](https://mintcdn.com/zeotap/eToLLIFlmf1QY4Al/articles/integrate-customer/Storage/integrate-customer/image-111.png?fit=max\&auto=format\&n=eToLLIFlmf1QY4Al\&q=85\&s=7b1482dac54668bda44122eaeca706c5) **Step 3** Under the **Destination Details** tab, the **Base URL** and **API Key** fields are automatically populated from the values you entered when you created the destination. **Step 4** Under the **Destination Settings** tab, choose the **Action** and **mapping** you want this node to use. **Step 5** Click **Save Destination**. ## Verify the destination is attached The Talon.One destination appears as a card in the **Send to Destinations** node, showing its name and the mapping action it will run. ![A Talon.One : Trigger Custom Events destination attached in the Send to Destinations node, its card showing the destination name above the Trigger Custom Events in Talon.One mapping, with the remaining available destinations listed underneath.](https://mintcdn.com/zeotap/CSAMM_Rlvn0jps6x/articles/integrate-customer/Storage/integrate-customer/image-112.png?fit=max\&auto=format\&n=CSAMM_Rlvn0jps6x\&q=85\&s=a9c3868d8b3ee586ae73832852b06184) Name the workflow and publish it before you expect events to reach Talon.One. For the full activation sequence, including re-entry conditions and publishing, see [Activate your real-time audiences](/articles/integrate-customer/activate-your-real-time-audiences). ## Next steps * [Talon.One Audience](/articles/integrate-customer/talon-one-audience) — the batch destination that adds profiles to and removes them from Talon.One audiences. * [Configure a destination](/articles/integrate-customer/destinations#configure-a-destination) and [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping) — how destinations and mappings work in general. * [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail) — what to check when a destination stops delivering. * [Create a Workflow](/articles/orchestrate-customer/create-a-workflow) — build the journey this destination runs from. * [Activate your real-time audiences](/articles/integrate-customer/activate-your-real-time-audiences) — attach, name and publish a real-time destination in Journeys. * [Real-time integrations](/articles/integrate-customer/real-time-integrations) — the index for Zeotap CDP's real-time destinations. # Talon.One Audience Source: https://docs.zeotap.com/articles/integrate-customer/talon-one-audience Send audiences out of Zeotap CDP to Talon.One, adding and removing customer profiles from Talon.One audiences that power promotion, loyalty and incentive campaigns. ## What this is Talon.One Audience is a **batch destination**: data flows out of Zeotap CDP into Talon.One. Zeotap sends a batch of customer profile IDs along with the Talon.One audiences they should be added to or removed from, so your promotion, loyalty and incentive campaigns stay targeted at the right people. Because it is a batch destination, you activate it by linking it to an audience rather than from a journey. If a customer profile ID sent from Zeotap does not yet exist in Talon.One, it is created automatically when the audience is sent — there is no need to pre-create profiles in Talon.One before using this integration. Talon.One also offers a real-time destination that sends custom events from a journey instead of audience membership from an audience. See [Talon.One: Trigger Custom Events](/articles/integrate-customer/talon-one). ## Supported identifiers and actions | Action | What it does | | - | - | | **Send Audience to Talon One** | Adds the audience's customer profiles to the matching audience in Talon.One, and removes profiles that no longer qualify. | Map a Catalogue attribute to the **Customer Profile Id** destination field. The Customer Profile Id can be any identifier you want to send to Talon.One — for example, **email**, **MAID**, or any other customer profile ID. There is no restriction on the identifier type. Talon.One accepts the value as a string. ## Prerequisites **In Talon.One:** * An active **Talon.One account** and an **Application**. * A **Talon.One API Key** generated for that Application — see **Generate the Talon.One API key** below. * Your **Talon.One Destination Hostname** — the hostname of your Talon.One deployment, for example `mycompany.europe-west1.talon.one`. Enter the hostname on its own, without `https://`. **In Zeotap CDP:** * The upstream setup every destination shares — a connected source, fields mapped to the Catalogue, and the destination rights on your organisation. See [Destinations](/articles/integrate-customer/destinations#prerequisites). * An audience built with the criteria for the cohort you want to send. See [Create an Audience](/articles/segment-customer/create-an-audience). ## Generate the Talon.One API key **Step 1** In your Talon.One instance, select the **Application** you want to use and open **Settings**. Scroll down the left menu and click **Integration API Keys**. ![The Talon.One Settings area for an Application, with Integration API Keys listed in the left menu below General Settings.](https://mintcdn.com/zeotap/T1xhQZQjvwjLE9lW/articles/integrate-customer/Storage/integrate-customer/talon-one-audience/talon-one-audience-settings-nav.jpg?fit=max\&auto=format\&n=T1xhQZQjvwjLE9lW\&q=85\&s=1ffde25e65ce8618a442fd1c3b958789) **Step 2** Click **+ Create API Key**. In the **Create Production API Key** drawer, enter a **Key name** and a **Key expiration date** — both are required. Under **Third-party integration**, choose whether the key will be used with a third-party integration, then click **Create API Key**. > [!NOTE] > > Talon.One warns that the expiration date cannot be edited after the key is created. Pick a date that covers how long you expect to run the integration; when the key expires you generate a new one and update the destination in Zeotap. > [!NOTE] > > Generate the key as a third-party key for a **Customer Data Platform**. A standard Integration API key that is not scoped to a Customer Data Platform is refused when Zeotap connects, and the destination fails to authenticate. ![The Talon.One Integration API Keys page listing existing keys with their expiration dates and status, and the Create Production API Key drawer open with the Key name, Key expiration date and Third-party integration fields.](https://mintcdn.com/zeotap/T1xhQZQjvwjLE9lW/articles/integrate-customer/Storage/integrate-customer/talon-one-audience/talon-one-audience-create-api-key.jpg?fit=max\&auto=format\&n=T1xhQZQjvwjLE9lW\&q=85\&s=a888f08899e40851180259063f28228a) **Step 3** Copy the generated API key straight away and paste it into the **Talon.One API Key** field in Zeotap. > [!WARNING] > > Talon.One shows the key once. Once you close the drawer you cannot view it again — if you lose it, generate a new key. ![The Create Production API Key drawer after the key has been generated, showing the copy control, a Copied to clipboard confirmation, and Talon.One's reminder that the key cannot be seen again after the drawer is closed.](https://mintcdn.com/zeotap/kl8L6sBUYwhq5T7t/articles/integrate-customer/Storage/integrate-customer/talon-one-audience/talon-one-audience-copy-api-key.jpg?fit=max\&auto=format\&n=kl8L6sBUYwhq5T7t\&q=85\&s=78dd349133aad0c47b6ce8a58131ec8c) ## Create the Talon One Audience destination **Step 1** Log in to the **Zeotap CDP** app and go to the **Integrate > Destinations** module. Click **+ Create Destination** and search for **Talon One Audience**. **Step 2** Select **Talon One Audience**. On the **Enter Destination Details** screen, the left panel describes the integration; enter your details on the right. ![The Enter Destination Details step for the Talon One Audience destination in Zeotap CDP, with empty Destination Name, Talon.One API Key and Talon.One Destination Hostname fields.](https://mintcdn.com/zeotap/T1xhQZQjvwjLE9lW/articles/integrate-customer/Storage/integrate-customer/talon-one-audience/talon-one-audience-destination-details.jpg?fit=max\&auto=format\&n=T1xhQZQjvwjLE9lW\&q=85\&s=9f7b2a27082fc7106ae992491e8fc20c) **Step 3** Provide the following details: a. **Destination Name** — a name to identify this destination in Zeotap. \ b. **Talon.One API Key** — the key you generated in Talon.One. \ c. **Talon.One Destination Hostname** — the hostname of your Talon.One deployment, entered without `https://`. ![The same Enter Destination Details step completed, with a destination name entered, the API key field filled and hidden behind a show control, and a hostname in the Talon.One Destination Hostname field.](https://mintcdn.com/zeotap/T1xhQZQjvwjLE9lW/articles/integrate-customer/Storage/integrate-customer/talon-one-audience/talon-one-audience-filled-form.jpg?fit=max\&auto=format\&n=T1xhQZQjvwjLE9lW\&q=85\&s=ee9114099c32de91d469bf7283ca1808) **Step 4** Click **Next** to proceed to the **Mapping** step, and provide a name for your mapping. **Step 5** Under **Choose your Action**, select **Send Audience to Talon One**. **Step 6** Under **Map the Fields**, map a Catalogue Attribute to the **Customer Profile Id** destination field. ![The Mapping step with Send Audience to Talon One selected under Choose your Action, and a Map the Fields row pairing a Catalogue Attribute with the Customer Profile Id destination field of type String.](https://mintcdn.com/zeotap/T1xhQZQjvwjLE9lW/articles/integrate-customer/Storage/integrate-customer/talon-one-audience/talon-one-audience-mapping.jpg?fit=max\&auto=format\&n=T1xhQZQjvwjLE9lW\&q=85\&s=574ad8f622581bdb0f95dc10c3493612) **Step 7** Click **Create Destination** to save the destination. > [!NOTE] > > If a profile sent from Zeotap does not already exist in Talon.One, it is created automatically when the audience is sent. You do not need to pre-create profiles in Talon.One. ## Link an audience to the destination Once saved, the Talon.One Audience destination is available in the Audiences module and can be linked to any audience. Linking is where you choose the mapping, confirm the identifiers that leave Zeotap, and set the refresh frequency at which the audience is re-sent to Talon.One. Follow the shared activation steps in [Activate Your Batch Audiences](/articles/integrate-customer/link-an-audience-to-the-destination). ## Verify the audience reached Talon.One Check both sides of the delivery: 1. **In Zeotap** — open the audience–destination pair and confirm the run completed with a non-zero qualified count. See [Verify the activation worked](/articles/integrate-customer/destinations#verify-the-activation-worked). 2. **In Talon.One** — click **Audiences** in the left navigation. The audience appears in the **AUDIENCE NAME** column with its member count under **MEMBERS**, tagged **CDP** to show it arrived from a customer data platform rather than being created by hand. ![The Audiences list in Talon.One, showing audience names with a CDP tag, their member counts in the MEMBERS column, and edit and delete actions.](https://mintcdn.com/zeotap/T1xhQZQjvwjLE9lW/articles/integrate-customer/Storage/integrate-customer/talon-one-audience/talon-one-audience-in-talon.jpg?fit=max\&auto=format\&n=T1xhQZQjvwjLE9lW\&q=85\&s=cefe1be2d0291f4a7d2aab5923b908db) ## Troubleshoot the Talon.One Audience destination | Symptom | Likely cause | What to do | | - | - | - | | The destination cannot authenticate with Talon.One. | The API key is not a third-party key scoped to a Customer Data Platform, or it was mistyped when pasted. | Generate a new key in Talon.One as a third-party Customer Data Platform key, then paste it into the **Talon.One API Key** field. | | The destination worked and then stopped. | The Talon.One API key reached its expiration date. Talon.One marks keys **Expired** or **Expires Soon** in the **Integration API Keys** list, and the date cannot be extended once the key exists. | Generate a replacement key in Talon.One and update the **Talon.One API Key** field on the destination. | | Talon.One rejects the connection even though the key is valid. | The **Talon.One Destination Hostname** includes `https://`, a path, or a trailing slash. | Enter the hostname on its own — for example `mycompany.europe-west1.talon.one`. | | The audience shows members in Talon.One, but a profile is not visible in the Application. | A profile Zeotap sent did not already exist in Talon.One, so Talon.One created it as a placeholder. It stays a placeholder until Talon.One receives a session or a profile update for that customer. | No action in Zeotap. The profile fills in once your own Talon.One integration sends activity for it. | For failures that are not specific to Talon.One — a run that returns no qualifying customers, a refresh terminated after inactivity, or a pair stuck in progress — see [Why deliveries fail](/articles/integrate-customer/destinations#why-deliveries-fail) and [When to contact support](/articles/integrate-customer/destinations#when-to-contact-support). ## Next steps * [Activate Your Batch Audiences →](/articles/integrate-customer/link-an-audience-to-the-destination) * [Send custom events to Talon.One from a journey →](/articles/integrate-customer/talon-one) * [Explore how Destinations work →](/articles/integrate-customer/destinations) * [Explore Destination Access Rules →](/articles/integrate-customer/destination-access-rules) # TikTok Source: https://docs.zeotap.com/articles/integrate-customer/tiktok Configure the TikTok destination to push custom audiences from Zeotap to a TikTok Ad Account through the TikTok Marketing API. ## What this is The TikTok destination connects your Zeotap audiences to a TikTok Ad Account through the TikTok Marketing API, letting you push custom audiences for targeting and personalisation on TikTok. The integration is offered as a Private Destination, supports batch delivery of email addresses, hashed cellphone numbers, and MAIDs, and refreshes your TikTok audience on each scheduled sync cycle. ## Prerequisites Before you configure the destination, confirm the following: * A TikTok Ad Account exists for your brand. * A TikTok business centre account is set up and the Ad Account is added to it. See TikTok's guide on [adding an Ad Account to the business centre](https://ads.tiktok.com/help/article?aid=12786). * You have your **Advertiser ID** — this is your TikTok Ad Account ID, visible in TikTok Ads Manager. * You have a contact at Zeotap (your CSM/TAM) who will exchange the `auth_code` you generate for an **Access Token** that the destination setup needs. ## Supported identifiers and actions The TikTok integration supports `Email addresses`, `Hashed cellphone numbers`, and `MAIDs`. TikTok requires hashed cellphone numbers in e164 format (e164 is an international standard that assigns globally unique numbers to devices in the worldwide Public Switched Telephone Network (PSTN). A cellphone number in e164 format is represented as \[+] \[country code] \[Cellphone number including area code]. For example, a subscriber from the United States with the phone number 6171339687 (country code: 1) is represented in e164 format as +16171339687.). The table below shows the action exposed for TikTok and which delivery features it supports. | Action | [ID EXTENSION](/articles/segment-customer/extend-your-audience#id-extension) | [DELETE](/articles/segment-customer/delta-upload-and-delete-functions) | [DELTA UPLOAD](/articles/segment-customer/delta-upload-and-delete-functions) | | :- | :-: | :-: | :-: | | Send identifiers to TikTok | ✅ | ✅ | — | ## Generate the access token You authorise the Zeotap CDP App to push audiences to your TikTok Ad Account on your behalf. The authorisation produces a short-lived `auth_code` that your Zeotap CSM/TAM exchanges for the **Access Token** used in the destination configuration. > [!WARNING] > > The `auth_code` expires **10 minutes** after it is issued. Hand it to your Zeotap CSM/TAM through a secure channel as soon as you generate it — not by email. If it expires, repeat this procedure from step 1. **Step 1** Open the TikTok Business API authorisation URL in your browser: ```bash theme={null} https://business-api.tiktok.com/portal/auth?app_id=7010666682221854722&state=your_custom_params&redirect_uri=https%3A%2F%2Fads.tiktok.com%2Fmarketing_api%2Fdocs ``` You are redirected to the TikTok login page. ![](https://mintcdn.com/zeotap/IaZjYE7XwRssOe8Q/articles/integrate-customer/Storage/integrate-customer/tiktok/tiktok-2024-09-05.png?fit=max\&auto=format\&n=IaZjYE7XwRssOe8Q\&q=85\&s=09426b76af667bbc9e0c9bf69ba3fb3e) **Step 2** Sign in with your TikTok credentials. A permissions dialog appears — grant the requested permissions to the Zeotap CDP App. ![](https://mintcdn.com/zeotap/IaZjYE7XwRssOe8Q/articles/integrate-customer/Storage/integrate-customer/tiktok-1p/tiktok_2.png?fit=max\&auto=format\&n=IaZjYE7XwRssOe8Q\&q=85\&s=bd4bbe3e7e267f5a5adc9652b96c3446) **Step 3** Click **Confirm**. TikTok redirects you to a new page. **Step 4** In the browser address bar, copy the value of the `auth_code` parameter from the callback URL. ![](https://mintcdn.com/zeotap/IaZjYE7XwRssOe8Q/articles/integrate-customer/Storage/integrate-customer/tiktok-1p/tiktok_3.png?fit=max\&auto=format\&n=IaZjYE7XwRssOe8Q\&q=85\&s=e194cdd5ee549b9bb8a74e313764dc5d) **Step 5** Send the `auth_code` and your Advertiser ID to your Zeotap CSM/TAM through a secure channel. Your Zeotap CSM/TAM generates the **Access Token** from the `auth_code` and returns it to you for the destination setup. > [!NOTE] > > You can find your **Advertiser ID** (your TikTok Ad Account ID) in TikTok Ads Manager, in either of the two places highlighted below. > > ![](https://mintcdn.com/zeotap/IaZjYE7XwRssOe8Q/articles/integrate-customer/Storage/integrate-customer/tiktok/tiktok_ad_id.png?fit=max\&auto=format\&n=IaZjYE7XwRssOe8Q\&q=85\&s=b5164feba8bcfd61dff3f9de244c39c0) ## Create the TikTok destination in Zeotap TikTok is offered as a Private Destination only. Sign in to the Zeotap CDP App, then follow these steps. **Step 1** Open the **DESTINATIONS** application and click **+ Create Destination**. ![](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/s4m/Destinations_all_1.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=135c601e72be8861a3b3670e7c377aff) **Step 2** Under **All Destinations**, search for **TikTok** and select it. ![](https://mintcdn.com/zeotap/sBMx_EDYCwiX_b1v/articles/integrate-customer/Storage/integrate-customer/s4m/Destinations_all_2.png?fit=max\&auto=format\&n=sBMx_EDYCwiX_b1v\&q=85\&s=0754c153bcfb10821185d9ecc8920122) **Step 3** On the destination configuration screen, enter: * A name for the destination. * The **Advertiser ID** of your TikTok Ad Account. * The **Access Token** provided by your Zeotap CSM/TAM. Click **Next** to proceed to mapping. **Step 4** Choose an [action](/articles/integrate-customer/destinations#actions) under **Choose your Action** and map the corresponding identifiers under **Map the Fields**. The default [Output Identifiers](/articles/segment-customer/choose-the-output-identifiers) accepted by TikTok are pre-populated. You can edit, add, or remove identifiers as described in [destination mappings](/articles/integrate-customer/destinations#mappings). ![](https://mintcdn.com/zeotap/IaZjYE7XwRssOe8Q/articles/integrate-customer/Storage/integrate-customer/tiktok/tiktok-2023-11-09.png?fit=max\&auto=format\&n=IaZjYE7XwRssOe8Q\&q=85\&s=47d6a4c7fcf29ee033ae74d16d237ce1) **Step 5** Click **Create Destination**. The created destination is listed in the **Target** and **Audiences** applications and is ready to be linked to an audience. See [Link an Audience to the Destination](/articles/integrate-customer/link-an-audience-to-the-destination). > [!TIP] > > To enrich an audience with additional online identifiers (cookies, device IDs) derived from your first-party email or phone records before activation, enable [ID Extension](/articles/segment-customer/extend-your-audience#id-extension) on the destination link. ## Verify the destination is active The destination is configured correctly when all of the following hold: 1. The new TikTok destination appears in the **Target** and **Audiences** applications with no error badge on the card. 2. After you link an audience and the first refresh completes, the destination card in [Audience Insights](/articles/segment-customer/audience-insights) shows a **Last Refresh** timestamp and a populated **Next Fire Time** under the **Schedule** tab. 3. The audience appears in TikTok Ads Manager under **Tools → Audience manager**. Allow up to **three business days** for an audience to be available at the TikTok seat after the first successful push. > [!NOTE] > > The audience size shown in TikTok Ads Manager will be lower than the audience size in Zeotap — only the records that match a known TikTok user are kept after TikTok's identity match runs. Depending on the audience composition, the matched count can be substantially lower than the input count. ## How disqualified users are removed The TikTok destination supports user disqualification. When a profile no longer meets the audience criteria (for example, consent is withdrawn, or the profile falls out of the audience rules), Zeotap CDP issues a delete on the next refresh cycle and the profile is excluded from the linked TikTok audience at the next scheduled run. This is automatic — no configuration is required to enable it. See [Delta Upload and Delete Functions](/articles/segment-customer/delta-upload-and-delete-functions) for the file-level mechanics. ## Troubleshooting Use the table to identify the symptom, then follow the matching numbered resolution path below. | Symptom | What it means | Where to look | | :- | :- | :- | | `auth_code` expired before it reached your Zeotap CSM/TAM | The `auth_code` was not exchanged within 10 minutes of issue | TikTok auth callback URL | | **Expired** badge on the destination card | The TikTok Access Token authorisation has lapsed and the destination has stopped accepting syncs | Audience listing screen; destination card in **Audience Insights**; destination card in **Link to Destination** | | Audience not visible in TikTok Ads Manager after a refresh | The audience has not yet propagated to the TikTok seat, or no successful refresh has run | TikTok Ads Manager → **Tools → Audience manager**; destination card → **Last Refresh** column | | Audience size on TikTok much lower than the Zeotap audience size | TikTok matched only a subset of the supplied identifiers to known TikTok users | TikTok Ads Manager → audience details; identifier format on the Zeotap side | ### 1. `auth_code` expired before it reached your Zeotap CSM/TAM The `auth_code` is valid for 10 minutes from issue. 1. Repeat the steps in [Generate the access token](#generate-the-access-token) to produce a fresh `auth_code`. 2. Hand the new `auth_code` and your Advertiser ID to your Zeotap CSM/TAM through a secure channel immediately — do not send it by email. 3. Once you receive the new **Access Token**, continue with [Create the TikTok destination in Zeotap](#create-the-tiktok-destination-in-zeotap). ### 2. **Expired** badge on the destination card The destination needs to be re-authorised against TikTok. 1. Generate a new `auth_code` by repeating [Generate the access token](#generate-the-access-token). 2. Send the `auth_code` and Advertiser ID to your Zeotap CSM/TAM so a new **Access Token** can be issued. 3. Open the destination's settings in the Zeotap CDP App and paste the new **Access Token** into the Access Token field, then save. 4. Confirm the **Expired** badge clears on the destination card in [Audience Insights](/articles/segment-customer/audience-insights) and that the next scheduled refresh runs to completion. ### 3. Audience not visible in TikTok Ads Manager after a refresh 1. In Zeotap, open the destination card in [Audience Insights](/articles/segment-customer/audience-insights) and check the **Last Refresh** column. If no successful refresh has run, trigger one with **Push now + follow schedule** from the audience's destination settings (see [Audience Scheduling](/articles/segment-customer/audience-scheduling)) or wait for the next scheduled cycle. 2. If the last refresh succeeded but the audience is still not visible in TikTok Ads Manager, allow up to **three business days** for the audience to propagate to the TikTok seat after the first successful push. 3. If three business days have passed and the audience is still missing, follow the escalation steps below. ### 4. Audience size on TikTok much lower than the Zeotap audience size 1. Confirm the identifier format. TikTok requires hashed cellphone numbers in e164 format (for example, `+16171339687`). Numbers in another format are dropped during TikTok's match. 2. Enable [ID Extension](/articles/segment-customer/extend-your-audience#id-extension) on the destination link to derive additional online identifiers from your first-party email or phone records, raising the pool of records that TikTok can match. 3. A match rate below your expectation that persists after the above is a property of TikTok's identity match, not a Zeotap-side issue. Compare the matched count in TikTok Ads Manager with the input count on the destination card to size the gap before escalating. ### When to escalate Contact your Zeotap CSM/TAM if: * The destination still shows **Expired** after a fresh Access Token has been applied and saved. * An audience has not appeared in TikTok Ads Manager three business days after the first successful refresh. * You see an error or badge on the destination card that is not listed in the table above. Include in your request: audience name and ID, destination name, Advertiser ID, the timestamp of the most recent successful refresh from the **Last Refresh** column, and a screenshot of the destination card showing the symptom. ## Next steps * [Explore audience scheduling →](/articles/segment-customer/audience-scheduling) * [Explore delta upload and delete functions →](/articles/segment-customer/delta-upload-and-delete-functions) * [Explore extending your audience with ID Extension and Lookalike →](/articles/segment-customer/extend-your-audience) * [Explore the integrations master list →](/articles/integrations-master-list-publication/integrations-master-list) # TikTok Events Source: https://docs.zeotap.com/articles/integrate-customer/tiktok-events Send conversion and event data from Zeotap CDP to TikTok over a server-to-server connection to the TikTok Events API, to improve measurement, attribution and campaign optimisation with your first-party data. ## What this is The TikTok Events destination sends conversion and event data **out of Zeotap CDP to TikTok**, over a server-to-server connection to the TikTok Events API rather than a browser-side pixel. TikTok uses those events to improve measurement, attribution and campaign optimisation against your first-party data. This is a real-time destination. It is driven from a workflow in Journeys and attaches to the **Send to Destinations** node — it is not linked to an audience on a schedule. > [!NOTE] > > To send **custom audiences** to a TikTok Ad Account through the TikTok Marketing API instead, use the [TikTok](/articles/integrate-customer/tiktok) destination. That is the batch, audience-driven integration for the same vendor. ## Supported identifiers and actions The destination exposes one action: **Send Events to TikTok**. The mapping screen groups the destination fields as follows. | Group | Destination fields | | :- | :- | | **Attributes** | **Event Time** (required, in EPOCH seconds), Event Id, Event Source ID | | **User** | SHA256 Hashed Email, SHA256 Hashed Phone, SHA256 Hashed External Id, Ttclid (TikTok click ID), Ttp (the `_ttp` cookie value), IP, User Agent, Locale, Apple Advertiser ID, Apple Vendor Advertiser ID, Google Advertiser ID | | **Properties** | Event-level attributes such as Currency, Value, Content Type, Content Ids, Num Items, Order Id, Shop Id, Referrer | | **Ad** | Attribution Share | > [!NOTE] > > Ensure that the **Email**, **Phone** and **External Id** values you map are SHA-256 hashed before they are sent to TikTok. ## Prerequisites Before you create a TikTok Events destination in Zeotap CDP, ensure that you have the following: * A TikTok Ads Manager account within a TikTok Business Center. * A data source (dataset) set up in **TikTok Events Manager** with the **Events API** enabled. * An **Access Token** generated for that data source — see [Generate the access token in TikTok Events Manager](#generate-the-access-token-in-tiktok-events-manager). * A workflow in Journeys to send the events from. See [Create a Workflow](/articles/orchestrate-customer/create-a-workflow). ## Generate the access token in TikTok Events Manager The access token authenticates with the TikTok Business API and sends events to your data source. In TikTok Events Manager, open your data source's **Data connection** step, locate the **Events API** section, and select **Generate access token**, then copy the token. For details on setting up the Events API, generating the access token, and the full list of **Standard Events** supported by TikTok (for example, `CompletePayment`, `AddToCart` and `ViewContent`), refer to TikTok's [Supported Events guide](https://business-api.tiktok.com/portal/docs/supported-events/v1.3). ## Create the TikTok Events destination **Step 1** Log into the **Zeotap CDP** App and go to **Destinations** under **Integrate**. **Step 2** Click **+ Create Destination**. **Step 3** Under the **All Destinations** section, search for TikTok Events and click **TikTok Events**. **Step 4** A screen appears displaying details about the destination towards the left. On the right-hand side, provide the required details: a. In the **Destination Name** field, enter a name for the destination. b. In the **Access Token** field, enter the access token generated in TikTok Events Manager. ![The Enter Destination Details step of the destination wizard, with the Destination Name field above the Access Token field, and Back and Next buttons at the foot of the screen.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/tiktok-events/tiktok-events-2026-06-30-1.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=d945d17095a5065e168b56c942adb2cb) **Step 5** Click **Next** to proceed to the **Mapping** screen. **Step 6** On the **Mapping** screen, configure the action and the field mapping: a. Under **Choose your Action**, select **Send Events to TikTok**. This action sends your conversion events to TikTok through Journeys. b. Under **Map the Fields**, map the catalogue fields to the destination fields. See [Define the mapping](/articles/integrate-customer/destinations#define-the-mapping) for how the mapping screen works. The fields are grouped as follows: i. **Attributes** — map the required **Event Time** (the value must be in **EPOCH seconds** format), along with **Event Id** and **Event Source ID**. ![The Mapping step with Send Events to TikTok selected as the action, and the Map the Fields table open at the Attributes group showing Event Time, Event Id and Event Source ID.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/tiktok-events/tiktok-events-2026-06-30-2.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=ceaaf6a62df5e7465e386e7ce4ef499a) ii. **User** — map the identity fields you want to send: SHA256 Hashed Email, SHA256 Hashed Phone, SHA256 Hashed External Id, Ttclid, Ttp, IP, User Agent, Locale, Apple Advertiser ID, Apple Vendor Advertiser ID, and Google Advertiser ID. iii. **Properties** — map event-level attributes such as Currency, Value, Content Type, Content Ids, Num Items, Order Id, Shop Id, and Referrer. ![The Map the Fields table scrolled to the User group, listing Ttp, Ip, User Agent, Locale, Apple Advertiser ID, Apple Vendor Advertiser ID and Google Advertiser ID, with the Properties group beginning below it.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/tiktok-events/tiktok-events-2026-06-30-3.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=b4f8c0bcedd8a02a2b613efdd616533d) iv. **Ad** — map Attribution Share. > [!NOTE] > > Zeotap CDP transmits events to TikTok only for users who have provided the required advertising and data processing consent. Ensure that only consented users enter your journey criteria. c. Under **Additional Settings**, configure the event details: i. **Event Source** — select where the event originates: **Web**, **Offline**, **App**, or **CRM**. ![The Additional Settings panel with the Event Source list open, offering Web, Offline, App and CRM.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/tiktok-events/tiktok-events-2026-06-30-4.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=8fedfb54581a9501f0ec0d6f1d95c380) ii. **Event Name** — enter the name of the event you are sending. This can be a TikTok **Standard** event (for example, `AddToCart`) or a **Custom** event name. ![The Additional Settings panel with Event Source set to Web and AddToCart entered in the Event Name field.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/tiktok-events/tiktok-events-2026-06-30-5.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=769f6b7a45258e8635ad215739b87223) > [!NOTE] > > For the full list of Standard Events you can send and how to format event parameters, refer to TikTok's [Supported Events guide](https://business-api.tiktok.com/portal/docs/supported-events/v1.3). **Step 7** Click **Create Destination**. A **Destination created successfully!** confirmation appears and the new destination is listed under **Active Destinations**. ![The Active Destinations list with a Destination created successfully confirmation at the top and the newly created TikTok Events destination as the most recently updated row.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/tiktok-events/tiktok-events-2026-06-30-6.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=f0893142cc09486e4a32f5b95219d16c) ## Add the destination to a journey The **Send Events to TikTok** action runs in Journeys. After you create the destination, attach it to the **Send to Destinations** node in your workflow, then publish the workflow. For the full procedure, see [Activate Your Real Time Audiences](/articles/integrate-customer/activate-your-real-time-audiences). ## Verify events are reaching TikTok Once the destination is attached to a published workflow and events begin flowing, verify them in TikTok Events Manager: **Step 1** In TikTok Events Manager, open **Data sources** and select the data source linked to this destination. **Step 2** The data source shows the **Total events** received. Use the **Overview**, **Test events** and **Diagnostics** tabs to inspect the events and resolve any issues. ![The Data sources screen in TikTok Events Manager, showing a connected data source card with its creation time and a Total events count.](https://mintcdn.com/zeotap/ZBV-p-fo0S8Gu6fO/articles/integrate-customer/Storage/integrate-customer/tiktok-events/tiktok-events-2026-06-30-7.png?fit=max\&auto=format\&n=ZBV-p-fo0S8Gu6fO\&q=85\&s=49789ca430350c506ed42f1c0ccd5ef4) Until events are received, the view shows no activity. Allow time for the first events to be processed before treating an empty view as an error. ## Troubleshoot TikTok Events | Symptom | What it means | What to do | | :- | :- | :- | | **Create Destination** stays unavailable on the **Mapping** screen | A mandatory field is not mapped | **Event Time** is mandatory. Map a catalogue attribute to it, and to any other field marked as required, before you can proceed. | | The data source in TikTok Events Manager shows no activity | No event has reached the data source yet | Confirm the workflow carrying the **Send to Destinations** node is published, then allow time for the first events to be processed. | | Fewer users reach TikTok than entered the journey | Zeotap CDP transmits events only for users who have provided the required advertising and data processing consent | Check that your journey criteria admit only consented users, and size the gap against the journey's own entry count. | | TikTok does not match the users you send | The identity fields were not hashed before they were sent | Confirm that the catalogue fields mapped to **SHA256 Hashed Email**, **SHA256 Hashed Phone** and **SHA256 Hashed External Id** are already SHA-256 hashed. | | The event name is not the one you expect in TikTok | **Event Name** is set per destination under **Additional Settings** | Open the destination's mapping and check the **Event Name** value against TikTok's [Supported Events guide](https://business-api.tiktok.com/portal/docs/supported-events/v1.3). | If the symptom is not in the table, contact your Zeotap CSM/TAM with the destination name, the workflow name, the **Event Name** and **Event Source** configured on the destination, the data source you expect the events in, and the time window in which you expected them. ## Next steps * [Explore activating your real-time audiences in Journeys →](/articles/integrate-customer/activate-your-real-time-audiences) * [Explore creating a workflow in Journeys →](/articles/orchestrate-customer/create-a-workflow) * [Explore the TikTok destination for custom audiences →](/articles/integrate-customer/tiktok) * [Explore destination access rules →](/articles/integrate-customer/destination-access-rules) * [Explore the integrations master list →](/articles/integrations-master-list-publication/integrations-master-list) # Troubleshoot Batch Uploads to a Destination Source: https://docs.zeotap.com/articles/integrate-customer/troubleshoot-batch-destination-uploads What to do when a batch destination upload stays In Progress or shows Failed — wait out transient stalls, re-trigger the refresh, confirm destination credentials, and collect the data Support needs. ## What Happened Your batch upload to a destination did not deliver. The run stays in an `In Progress` state long past its expected completion time, or the run finished with a `Failed` status, and the records have not reached the destination platform. ## Why This Happens A batch destination upload moves through several stages — the audience build completes, the export is generated, and the upload to the destination is triggered. The run stalls or fails at the upload stage for a small number of reasons: * A transient processing error on the upload step that needs the run to be re-triggered. * The destination credential has expired or been rotated at the destination platform, and the destination rejects the upload. * The destination platform has hit one of its own limits (for example, a cap on the number of audiences it accepts). | Status | What it means | Where to look | | :- | :- | :- | | `In Progress` (does not advance past expected completion) | The upload step was triggered but a processing stage stalled before recording a final state. | The affected destination | | `Failed` | The upload step did not complete and the records were not delivered to the destination. | The affected destination | ## How to Resolve ### The Run Is Stuck in In Progress **Step 1** Open the destinations list to find the affected destination. ![](https://mintcdn.com/zeotap/rrZnBXv0RPiHQdQw/articles/integrate-customer/Storage/integrate-customer/troubleshoot-batch-destination-uploads/troubleshoot-batch-destination-uploads-2026-06-10.png?fit=max\&auto=format\&n=rrZnBXv0RPiHQdQw\&q=85\&s=5c1d3d16ebd8d7f4b950af2f5e077c8b) **Step 2** Go to the **Audiences** application and open the audience linked to that destination. Its **Activation Status** shows `In Progress` for the upload that has not advanced past its expected completion time. For what each status value means, see [Audience Status and Activation Status](/articles/segment-customer/audience-status-and-activation-status). **Step 3** Wait for the next scheduled refresh. A single stuck run is treated as transient, and the next scheduled refresh clears it in nearly all cases. **Step 4** If the audience is time-sensitive or the next refresh has also not advanced, contact Support and ask for the run to be re-triggered. See [When to Contact Support](#when-to-contact-support) below for the data to attach. ### The Run Finished with a Failed Status **Step 1** Open the affected destination and confirm the most recent run shows the `Failed` status. **Step 2** Re-trigger the audience refresh. A re-trigger clears transient upload failures without any change on your side. **Step 3** If the re-triggered run also fails, confirm that the destination credential is still valid. Credentials rotated at the destination platform reject uploads until the new value is saved in Zeotap. > [!NOTE] > > Credential rotations happen in the destination platform itself (your S3 console, your Braze workspace, your DV360 account). Confirm the current credential value there before updating it in Zeotap. **Step 4** If the re-triggered run still fails after the credential is confirmed, check whether the destination platform has hit a cap on the number of audiences it accepts. Remove or rename audiences in the destination platform that are no longer in use, then re-trigger the refresh. **To verify the fix worked:** open the affected destination and confirm the most recent run shows a completed/published status and a non-zero record count. ## When to Contact Support Contact Zeotap Support when: * The stuck run has not cleared after the next scheduled refresh. * A re-triggered run fails again with the destination credential confirmed valid. * You see a status or message that does not match the table above. Include in your request: ```json theme={null} { "audience_name": "", "audience_id": "", "destination_name": "", "scheduled_refresh_time": "