Page tree
Skip to end of metadata
Go to start of metadata

Using the Interaction Studio Identity System with the Event API, you can configure the identifiers that determine a unique, known individual within Interaction Studio.  The Event API supports leveraging multiple identities for looking up and merging profiles in Interaction Studio.

This Article Explains

This article details the process for configuring the identity system for the Event API.

Sections in this Article

Considerations

  • You must be an Interaction Studio administrator (tenant administrator) to perform the steps outlined in this article
  • Complete the process detailed in Configure Identity Types and Attributes first
  • You must include the channel parameter of “Server” in your event API request for the event to be compatible with the Identity System
  • Once campaigns are active, the Event API setting should not be altered or it could affect what content is rendered for active campaigns.
  • There are two ways to configure the identity system for the event api.  Both ways should be reviewed in detail before implementation. 



Configure the Identity System for the Event API: Option 1

In this setup option you will not have to configure any settings on the setting screen.  You will leverage user attributes to submit your identity attributes.


Configure the Event API Request:

  1. You can complete the rest of the configuration by following the instructions and leveraging the Event API Requests documentation, available on the developer.evergage.com.  In your API request, configure the following few critical components.
    1. Include the channel parameter:
      1. Value = “Server
      2. Uppercase
      3. Nested under the source parameter
    2. Do not include the user ID parameter in your configuration
    3. Include = identity values as user attributes

Sample Request:

In the following code example,  email address and customer id are configured identity attributes in Interaction Studio and those values are being sent in as user attributes. 

Sample request including an identity attribute

{

    "action": "sample",

    "user": {

        "attributes": {

            "emailAddress": "test@test.com",

            "CustomerId": "123"}

        },

    "source": {

            "channel": "Server",

    }

}

Configure the Identity System for the Event API: Option 2

You can configure one identity as the default identity and leverage any other identity values as user attributes in the event api call for looking up and merging. 

Configure the Identity System for the Event API

  1. Access Interaction Studio
  2. Navigate to Settings > General Setup
  3. Click Advanced
  4. Navigate to Select the Identity attribute to use as the Server Side events Identity
  5. Select the default identity attribute from the drop down menu
  6. Click SAVE

Configure the Event API Request:

  1. After you complete the setup steps for identities and the Event API, you can complete the rest of the configuration by following the instructions and leveraging the Event API Requests documentation, available on the developer.evergage.com.  In your API request, configure the following few critical components. 

    1. Include the channel parameter:
      1. Value = “Server”
      2. Uppercase
      3. Nested under the source parameter
    2. Include the ID parameter.  Set the ID parameter to the associated identity attribute value that you have selected as the default server side identity.
    3. Include other identity values as user attributes

Sample Request:

In the following code example customer id was selected as the default identity in the settings screen and is being sent as the user id field.  Email Address is also a configured identity in Interaction Studio and is being sent as a user attribute. 

Sample request including an identity attribute

{

    "action": "sample",

    "user": {

        "id": "456",

        "attributes": {

            "emailAddress": "test@test.com"}

        },

    "source": {

            "channel": "Server",

    }

}