IBM UBX Integration Guide

(Difference between revisions)
Jump to: navigation, search
(Available Events)
(Available Events)
Line 7: Line 7:
 
Social-ID for Customer Identity platform currently integrates with the following [https://ubx-01.ibmmarketingcloud.com/#/taxonomy UBX events]:  
 
Social-ID for Customer Identity platform currently integrates with the following [https://ubx-01.ibmmarketingcloud.com/#/taxonomy UBX events]:  
  
* Connected to social channel (Social Events)
+
=== Connected to social channel (Social Events) ===
** Event Code: connectedSocial
+
** Identifiers: social_id, email, facebook_id<sup style="color: red">[1]</sup>, gplus_id, linkedin_id<sup style="color: red">[1]</sup>, twitter_id
+
** Attributes: eventId, eventName, description, brandTag, socialPlatform, contactConsent
+
* Contact Update (Engage Contact Update Event)
+
** Event Code: contactUpdate
+
** Namespace: com.ibmmarketingcloud.engage
+
** Identifiers: social_id, email, facebook_id<sup style="color: red">[1]</sup>, gplus_id, linkedin_id<sup style="color: red">[1]</sup>, twitter_id
+
** Attributes<sup style="color: red">[2]</sup>: SocialId, Email, SocialIdProfileURL, Birthday, PictureURL, Gender, RelationshipStatus, CurrentLocation, Religion, Locale, Industry, FirstName, LastName, WorkPosition, Company, TwitterId, FacebookId, GplusId, LinkedInId, TwitterHandle, GplusHandle, contactConsent, [http://dev.socialidnow.com/index.php?title=GET_login/users/:user_id/data user data] attributes and [http://dev.socialidnow.com/index.php?title=PUT_login/apps/clustering/rules clustering features] attributes (using FeatureLabel name pattern).
+
  
<span style="color:red">[1]: App-Scoped ID.</span>
+
* Event Code: connectedSocial
 +
* Namespace: com.ibm.commerce.ubx
 +
* Identifiers: social_id, email, facebook_id<sup style="color: red">[1]</sup>, gplus_id, linkedin_id<sup style="color: red">[1]</sup>, twitter_id
 +
* Attributes: eventId, eventName, description, brandTag, socialPlatform, contactConsent
 +
 
 +
=== Contact Update (Engage Contact Update Event) ===
 +
 
 +
* Event Code: contactUpdate
 +
* Namespace: com.ibmmarketingcloud.engage
 +
* Identifiers: social_id, email, facebook_id<sup style="color: red">[1]</sup>, gplus_id, linkedin_id<sup style="color: red">[1]</sup>, twitter_id
 +
* Attributes<sup style="color: red">[2]</sup>: SocialId, Email, SocialIdProfileURL, Birthday, PictureURL, Gender, RelationshipStatus, CurrentLocation, Religion, Locale, Industry, FirstName, LastName, WorkPosition, Company, TwitterId, FacebookId, GplusId, LinkedInId, TwitterHandle, GplusHandle, contactConsent, [http://dev.socialidnow.com/index.php?title=GET_login/users/:user_id/data user data] attributes and [http://dev.socialidnow.com/index.php?title=PUT_login/apps/clustering/rules clustering features] attributes (using FeatureLabel name pattern).
 +
 
 +
<span style="color:red">[1]: App-scoped ID, i.e., the ID namespace is unique per social app and not for the entire social network.</span>
  
 
<span style="color:red">[2]: Most of these attribute names can be customized when the Engagement Engine channel is configured.</span>
 
<span style="color:red">[2]: Most of these attribute names can be customized when the Engagement Engine channel is configured.</span>

Revision as of 18:02, 5 July 2017

Contents

Introduction

The IBM Universal Behavior Exchange is an open exchange that makes it easy to share customer data between certified solutions. The Social-ID integration with IBM UBX allows you to leverage social login events and social profiles to be easily used across different marketing applications.

Available Events

Social-ID for Customer Identity platform currently integrates with the following UBX events:

Connected to social channel (Social Events)

  • Event Code: connectedSocial
  • Namespace: com.ibm.commerce.ubx
  • Identifiers: social_id, email, facebook_id[1], gplus_id, linkedin_id[1], twitter_id
  • Attributes: eventId, eventName, description, brandTag, socialPlatform, contactConsent

Contact Update (Engage Contact Update Event)

  • Event Code: contactUpdate
  • Namespace: com.ibmmarketingcloud.engage
  • Identifiers: social_id, email, facebook_id[1], gplus_id, linkedin_id[1], twitter_id
  • Attributes[2]: SocialId, Email, SocialIdProfileURL, Birthday, PictureURL, Gender, RelationshipStatus, CurrentLocation, Religion, Locale, Industry, FirstName, LastName, WorkPosition, Company, TwitterId, FacebookId, GplusId, LinkedInId, TwitterHandle, GplusHandle, contactConsent, user data attributes and clustering features attributes (using FeatureLabel name pattern).

[1]: App-scoped ID, i.e., the ID namespace is unique per social app and not for the entire social network.

[2]: Most of these attribute names can be customized when the Engagement Engine channel is configured.

How To Integrate with IBM UBX

  • On Social-ID for Customer Identity Platform
    • On Account Settings
      • Take note of API id and API secret from API page
    • On Campaign Engine > Campaigns
      • Create a new campaign using: Social Login - Sign In or Social Login - Profile Update as a trigger; All contacts as a filter; and UBX Integration as a channel, choosing an event type
  • On UBX
    • On Endpoints tab
      • Register a new Social-ID endpoint choosing the appropriate environment
        • Use the API id and secret as keys
  • Now the Social-ID endpoint should be ready to use.

How To Integrate with IBM Marketing Cloud

  • Follow all the steps to integrate Social-ID with IBM UBX, choosing Contact Update as event type on the Campaign Engine
  • On IBM Marketing Cloud
    • On Data tab
      • Optional → create a database if needed
        • Databases > Create
      • Click on a database then click on Show Additional Details to take note of the Database ID
      • Optional → add any of the following fields to the database: FirstName, LastName, WorkPosition, Company, PictureURL, Gender, RelationshipStatus, Birthday, CurrentLocation, Religion, Locale, Industry, SocialIDProfileURL
      • On Settings > Organization Settings > Application Account Access > Add Account Access
        • Set application to IBM Universal Behavior Exchange and add
        • Check e-mail for User Account Refresh Token and take note
  • On UBX
    • On Endpoints tab
      • Register a new IBM Engage endpoint
        • Use Account Refresh Token and Database ID as keys
    • On Events tab
      • Subscribe to Events
        • Select Social-ID > Contact Update event as source and IBM Engage as destination and subscribe
  • Anytime a login happens, it will now create/update a contact in the selected IBM Marketing Cloud database
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox