> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zeotap.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Cleverpush Real Time Integration

## Overview

Cleverpush is a web-based platform that enables website owners and developers to send <Tooltip tip="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.">push notifications</Tooltip> to users who have subscribed to receive them. Integrated with Zeotap CDP, it enables marketers to engage with their customers in real-time and at scale. This integration lets you send notifications through mobile applications, websites and emails.

## Supported Identifiers

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.

<Note>
  **Note:**

  *Ensure to create the standard and custom attributes in the Cleverpush account before mapping them in Zeotap CDP. [Learn more](#add-identifiers-and-attributes-in-cleverpush)*
</Note>

## Components of Cleverpush

Ensure that you have the details about the below components of the Cleverpush account available before creating a Destination.

<CardGroup>
  <Card title="Private API Key" icon="key" horizontal href="#private-api-key" />

  <Card title="Channel ID" icon="id-card" horizontal href="#channel-id" />
</CardGroup>

### Private API Key

A Private API Key is a unique identifier associated with your Cleverpush account. This is used to authenticate and authorise access to certain features or APIs of Cleverpush. Perform the following steps to obtain the Private API Key from Cleverpush:

<Steps>
  <Step>
    Log into the Cleverpush console and navigate to **Settings**.
  </Step>

  <Step>
    In the left panel, click **API** and copy the **Private API Key** displayed on the screen.
  </Step>

  <Step>
    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.

    <Frame>
      <img src="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" width="1958" height="1041" data-path="articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/0f57bafc-d4c8-4078-ae21-b075ebd5f18b.png" />
    </Frame>
  </Step>
</Steps>

### Channel ID

A Channel ID is a unique identifier assigned to the push notification channel that you create within Cleverpush. Perform the following steps to obtain the Channel ID in Cleverpush:

<Steps>
  <Step>
    Log into Cleverpush console and navigate to **Channels** on the top navigation bar.
  </Step>

  <Step>
    Under **Channels**, click the channel that you wish to use for sending push notifications. If the desired channel is not available, then you can create one by clicking **Add Channel** from the drop-down menu. For more information on how to create a channel in Cleverpush, refer .

    <Frame>
      <img src="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" width="3022" height="1572" data-path="articles/integrate-customer/Storage/integrate-customer/cleverpush-destination/Channel_ID_1.png" />
    </Frame>
  </Step>

  <Step>
    Once the channel is created, you need to setup the platforms on which you want to send notifications. The following are the platforms that Zeotap CDP supports:

    * Web Push
    * App Push
    * Email Push

    <Note>
      **Note:**

      For more information about how to set up these platforms, refer .
    </Note>

    <Frame>
      <img src="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" width="1958" height="1029" data-path="articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/cleverpush_b3.png" />
    </Frame>
  </Step>

  <Step>
    Click the desired platform and navigate to **General > Advance Settings > Channel ID**.

    <Frame>
      <img src="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" width="1958" height="1031" data-path="articles/integrate-customer/Storage/integrate-customer/create-a-cleverpush-batch-source/cleverpush_b_4.png" />
    </Frame>
  </Step>
</Steps>

## Prerequisites

Ensure that you add the identifiers in the Cleverpush account before mapping them in the **Actions and Mapping** screen as explained below. Otherwise, data will not be sent correctly.

### Add Identifiers and Attributes in Cleverpush

To add the identifiers and attributes in Cleverpush, perform the following steps:

<Steps>
  <Step>
    Log into Cleverpush console and navigate to **Channels** on the top navigation bar.
  </Step>

  <Step>
    Under **Channels**, click the channel that you wish to use for sending push notifications. For more information about Channels, refer [here](#channel-id).
  </Step>

  <Step>
    Navigate to your desired platform and go to **Attributes** as shown in the image below. Under **ID**, a standard list of commonly used attributes are displayed. You can add any or all of these attributes by selecting them and providing a name for each attribute selected.

    <Frame>
      <img src="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" width="2990" height="1654" data-path="articles/integrate-customer/Storage/integrate-customer/cleverpush-real-time-integration/cleverpush-real-time-integration-2024-08-05-13.png" />
    </Frame>

    * For example, if you want to add **firstname** from the standard list, choose **firstname** from the standard list and provide the display name for the attribute. Here, the display name is **First Name**. Note that the standard field **firstname** acts as a connection between the attributes in Cleverpush and Zeotap CDP.

    <Frame>
      <img src="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" width="2992" height="1656" data-path="articles/integrate-customer/Storage/integrate-customer/cleverpush-real-time-integration/cleverpush-real-time-integration-2024-08-05-9.png" />
    </Frame>
  </Step>

  <Step>
    Click **Add attribute**. Similarly, you can also add any custom identifier or attribute on Cleverpush. Once the attribute is added, you can map the particular field in the **Actions and Mapping** screen, in Zeotap CDP, as shown below. To learn more about the mappings, read ahead.

    <Frame>
      <img src="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" width="1528" height="548" data-path="articles/integrate-customer/Storage/integrate-customer/cleverpush-real-time-integration/cleverpush-real-time-integration-2024-08-05-10.png" />
    </Frame>
  </Step>
</Steps>

## Destination Setup

After you have applied filters or added conditions for your users in Journeys, you can activate them in Cleverpush 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**.

<Frame>
  <img src="https://mintcdn.com/zeotap/PbPkxJRQX6AvIPbW/articles/integrate-customer/Storage/integrate-customer/cleverpush-real-time-integration/cleverpush-real-time-integration-2024-08-05.png?fit=max&auto=format&n=PbPkxJRQX6AvIPbW&q=85&s=306b7c06ab50e8b9de49d3290859e4b5" width="1858" height="1070" data-path="articles/integrate-customer/Storage/integrate-customer/cleverpush-real-time-integration/cleverpush-real-time-integration-2024-08-05.png" />
</Frame>

### Add New Destination

Perform the following steps to add a new destination:

<Steps>
  <Step>
    Click **Add New Destination.**
  </Step>

  <Step>
    Search for **Cleverpush.**
  </Step>

  <Step>
    Click **Cleverpush** and enter a name for the Destination.
  </Step>

  <Step>
    Choose the **API Type** from the drop-down menu. You can either choose **POST** or **PATCH** as per your Enter the **Private API Key** associated with your Cleverpush account. For information about how to obtain this from Cleverpush, refer to the [Components of Cleverpush](#private-api-key) section.
  </Step>

  <Step>
    Enter the **Channel ID** associated with your push notification channel. For information about how to obtain this from Emarsys, refer to the [Components of Cleverpush](#channel-id) section.

    <Frame>
      <img src="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" width="1058" height="1028" data-path="articles/integrate-customer/Storage/integrate-customer/cleverpush-real-time-integration/cleverpush-real-time-integration-2024-08-05-1.png" />
    </Frame>
  </Step>

  <Step>
    In the mapping screen that appears, under **Choose your Action**, you can either choose **Send identifiers and attributes to Cleverpush in Realtime** or **Send identifiers to Cleverpush in Realtime** as the action for sending data from the workflow created in Journeys.

    a. If you choose **Send identifiers and attributes to Cleverpush in Realtime** as your action, then along with the Subscription ID, you can send the standard attributes such as First Name, Last Name, Email Address (raw) and Gender. However, to use them, first, you need to [add them in the Cleverpush console](#add-identifiers-and-attributes-in-cleverpush). Note that you can also send custom identifiers and attributes to Cleverpush by using **+ Add Mapping Field** shown in the image below. Ensure that even these attributes are added in Cleverpush console before adding it in the Mapping (Zeotap CDP) screen. Otherwise, the data will not be sent correctly. [Learn more](#components-of-cleverpush)

    <Frame>
      <img src="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" width="1612" height="1518" data-path="articles/integrate-customer/Storage/integrate-customer/cleverpush-real-time-integration/cleverpush-real-time-integration-2024-08-08.png" />
    </Frame>

    b. If you choose **Send identifiers to Cleverpush in Realtime** as your action, then you can only send Subscription ID to Cleverpush.

    <Frame>
      <img src="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" width="1932" height="1750" data-path="articles/integrate-customer/Storage/integrate-customer/cleverpush-real-time-integration/cleverpush-real-time-integration-2024-08-05-3.png" />
    </Frame>
  </Step>

  <Step>
    Once the mapping is complete, click **Create Destination**. The destination is created and made available for activation on Journeys.
  </Step>
</Steps>

## Activate the Destination on Journeys

After creating a destination, next, you have to add workflow-level inputs as mentioned below.

<Steps>
  <Step>
    Choose the destination from the list of available destinations by using the search feature.

    <Frame>
      <img src="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" width="1896" height="700" data-path="articles/integrate-customer/Storage/integrate-customer/cleverpush-real-time-integration/cleverpush-real-time-integration-2024-08-05-4.png" />
    </Frame>
  </Step>

  <Step>
    The **Private API Key** and **Channel ID** fields are automatically populated based on the value that you had entered while creating the destination.
  </Step>

  <Step>
    Under **Audience**, choose from the drop-down to categorise your users based on specific characteristics related to your workflow. You can either choose from the list of existing tags or create a new one by clicking + **Create New Tag** option.

    <Frame>
      <img src="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" width="1086" height="1808" data-path="articles/integrate-customer/Storage/integrate-customer/cleverpush-real-time-integration/cleverpush-real-time-integration-2024-08-05-5.png" />
    </Frame>

    In CleverPush, tags are labels or identifiers that you can assign to users to categorise them based on specific characteristics, interests, behaviours or demographics. Tags help you segment your users and target them with relevant and personalised messages.
  </Step>

  <Step>
    Under **Destination Settings**, choose the Action and Mapping as per your requirement.

    <Frame>
      <img src="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" width="1840" height="1154" data-path="articles/integrate-customer/Storage/integrate-customer/cleverpush-real-time-integration/cleverpush-real-time-integration-2024-08-05-6.png" />
    </Frame>
  </Step>

  <Step>
    Upon clicking **Save Destination**. The destination is attached as shown in the image below.

    <Frame>
      <img src="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" width="1896" height="1112" data-path="articles/integrate-customer/Storage/integrate-customer/cleverpush-real-time-integration/cleverpush-real-time-integration-2024-08-05-7.png" />
    </Frame>
  </Step>
</Steps>
