Amazon Kinesis setup for Data Activation

The Data Activation connector for Amazon Kinesis allows you to stream segmented audience data in real-time to your Kinesis data streams. Amazon Kinesis makes it easy to collect, process, and analyze real-time streaming data, enabling you to get timely insights and react quickly to new information.

Before you begin

Before configuring the Kinesis make sure you have the following details available:

• AWS access key

• AWS secret key

• Kinesis stream name

• AWS region for your Kinesis stream

Instructions

Step 1: Configure destination

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

2. Select Event connector and click New event connector.

3. Select Kinesis. The form requires the following information:

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

   • Partner number: The partner number which contains the identifiers you would like to receive in Kinesis (mandatory)

   • Kinesis access key: Access key linked to the AWS customer account (mandatory)

   • Kinesis secret key: Secret key linked to the AWS customer account (mandatory)

   • AWS region: The AWS region linked to the customer Kinesis stream (mandatory)

   • Stream name: The customer Kinesis stream name (mandatory)

Step 2: Add the destination connector to an audience or journey

When adding Kinesis to an audience or journey, you can add a source and up to 10 variables. These variables can be mapped to engagement and fact properties, allowing you to send profile variables to Kinesis.

• Source name: Optional.

  • A specific field to understand the source of this data.

  • The "Fill" button will populate the audience name. You can also use team/campaign names

• Property - Value: Optional.

  • Key-value pairs added to the payload for this specific audience/journey step.

  • Useful for sending additional information not related to profile data

Both these values are on the audience/journey step level.

Payload structure

The Data Activation communicates the trackId and its corresponding partnerIds and profile variables.

Example payload:

{
    "profileId": "aaaabbbb-cccc-dddd-eeee-ffffffffffff",
    "sourceId": "dc0beb89-2d63-4ec7-899a-6e986ed8932f",
    "partnerNumber": 33,
    "callType": "NEW",
    "partnerIds": ["4"],
    "profileVars": {
        "lastCategory": "5678"
    },
    "timestamp": 1234567890,
    "siteNumber": 1234,
    "sourceName": "some name",
    "sourceNumber": 123,
    "data": {
        "custom": "variable",
        "another": 123 
    }
}

Field descriptions

• profileId: The current profile identifier (partnerNumber 42) for this profile

• sourceId: The unique identifier of the audience/journey step

• partnerNumber: The identifier type selected when creating the connector

• callType: Indicates if the person is newly added, removed, or profileVars have been modified (NEW, MODIFIED, REMOVED)

• partnerIds: Always contains one partnerId. If there are multiple partnerIds on this slot, you will receive multiple messages

• profileVars: The variable values configured to pass to the connector from within the interface

• timestamp: The time in milliseconds since 01-01-1970

• siteNumber: The siteNumber of the specified Data Activation instance

• sourceName: Free format text field to identify the audience in a descriptive manner

• sourceNumber: The numeric ID of an audience. Empty if the message comes from Journey Orchestration

• data: Contains the custom properties defined when creating the audience or journey step

Note

All fields above will always exist but can be empty if they are optional (like profileVars or data).

Deprecated fields

The following fields are deprecated and will be removed in a future version: