Skip to main content

Integrating Iterable with Okendo

G
Written by Glenn Lee
Updated this week

Okendo integrates with Iterable, making it easier to incorporate Okendo data into journeys and template customizations, enabling you to reach audiences, with highly personalized and timely communications.

In this article, you'll learn:

  • How to connect Okendo and Iterable

  • What properties and events are sent to Iterable

  • Using properties and events in journeys, campaigns and emails

Connecting Okendo and Iterable

Follow these steps to connect Okendo with Iterable:

  1. Create an API Key (type Server-side) called “Okendo”. See instructions here. Copy the API key

2. Go to Shopify Admin > Apps > Okendo > Settings > Integrations

3. Open the Iterable section and enter your API Key into the corresponding field

4. Select Save and exit Integrations

⚠️ Establishing the connection will automatically deliver some properties and events to Iterable, and where applicable, perform a data backfill. You can use these to customize your templates in Iterable.

Profile properties and events sent to Iterable

Customer profile properties

The following are custom fields, that are added to a customer's profile, in Iterable.

Property name

Description

Okendo Given Name

The first name of the customer.

Okendo Family Name

The last name of the customer.

Okendo Average Review Rating

The average rating given by the customer across all reviews.

Okendo Average Review Sentiment

The general sentiment of the customer's reviews.

Okendo Latest Review Rating

The rating given in the customer's most recent review.

Okendo Latest Review Sentiment

The sentiment of the customer's most recent review.

Okendo Latest NPS Category

The category of the customer's latest Net Promoter Score (NPS).

Okendo Latest NPS Date

The date of the customer's latest NPS.

Okendo Latest NPS

The score of the customer's latest NPS.

Okendo Number of Reviews

The total number of reviews submitted by the customer.

Okendo Number of Survey Responses

The total number of survey responses submitted by the customer.

Okendo Referral Shareable Link

A link that the customer can share for referrals, if present.

Okendo Number of Successful Referrals

The total number of successful referrals made by the customer.

Okendo Latest Successful Referral Date

The date of the customer's latest successful referral.

Okendo Total Successful Referral Revenue

The total revenue generated from the customer's successful referrals.

Okendo Loyalty Enrolment Date

The date when the customer enrolled in the loyalty program.

Okendo Loyalty Next Birthday Date

The next birthday date for the customer in the loyalty program.

Okendo Loyalty Points Balance

The current balance of loyalty points for the customer.

Okendo Loyalty Points Expiry Date

The date when the customer's loyalty points will expire.

Okendo Loyalty Program Status

The current status of the customer in the loyalty program.

Okendo Loyalty VIP Tier

The VIP tier of the customer in the loyalty program.

Okendo Loyalty VIP Tier Expiry Date

The expiry date of the customer's VIP tier status.

Custom event data

Custom events are a way for your business to keep track of the important actions customers take as they interact with third-party websites and apps, across their journey with your brand. Events can track customer actions (for example, enrolling in a loyalty program) or track other actions, related to customer actions (for example, when a first-time buyer acts on a referral, sent to them by the customer).

Event structure

The following describes the base object sent for all events:

  • Resource ID: Unique identifier for the resource (e.g, review, survey, etc.).

  • Email Address: The related user’s email address.

  • Event Name: The event name describing the event. See various Event Names for each event below.

  • Event Properties: Additional properties related to the event, see descriptions for each event below.

  • Date Created: Timestamp of when the event was created, as a Unix timestamp.

Event types and event properties

The following are custom events and their subsequent properties, added to customer profiles in Iterable. For more information about how to access these events, view this article on the Iterable Support Center.

Okendo Review Created

A custom event that is logged in Iterable, when a customer submits a review.

Properties

  • Coupon Code: The code for a discount coupon, if present.

  • Coupon Description: A description of the discount coupon, if present.

  • Is Recommended: Indicates whether the reviewer recommends the product (Yes/No).

  • Language Code: The language in which the review is written.

  • Loyalty Events: Information about loyalty events, if present.

  • Loyalty Points: The number of loyalty points awarded, if present.

  • Loyalty Provider: The provider of the loyalty program, if present.

  • Overall Sentiment: The general feeling or sentiment expressed in the review.

  • Photo Count: The number of photos included with the review.

  • Photo Urls: A list of web addresses (URLs) for the photos included with the review.

  • Product Name: The name of the product being reviewed.

  • Product URL: The web address (URL) for the product.

  • Review Body: The main text of the review.

  • Review Title: The title or headline of the review.

  • Review Created Date: The date when the review was created.

  • Reviewer Country Code: The country code of the reviewer.

  • Reviewer Display Name: The display name of the reviewer.

  • Reviewer Full Name: The full name of the reviewer.

  • Reviewer Zone Code: The zone code of the reviewer.

  • Variant Name: The name of the product variant, if applicable.

  • Video Count: The number of videos included with the review.

  • ProductID: The unique identifier for the product.

  • Rating: The rating given to the product, typically on a scale (e.g., 1 to 5 stars).

  • SKU: The stock keeping unit, a unique identifier for the product.

  • Source: The source of the review, if present.

  • VariantID: The unique identifier for the product variant, if applicable.

  • Okendo Average Review Rating: The average rating given by the customer across all reviews.

  • Okendo Has Submitted Media: Indicates whether the customer has submitted photos or videos (Yes/No).

  • Okendo Latest Review Rating: The rating given in the customer's most recent review.

  • Okendo Number of Reviews: The total number of reviews submitted by the customer.

Submitted Okendo Quiz

A custom event that is logged in Iterable, when a customer completes a quiz.

Properties

  • Quiz Name: The name of the quiz taken by the customer.

  • Quiz Response ID: A unique identifier for the quiz response.

  • Redirect URL: The URL to which the customer is redirected after completing the quiz, if applicable.

  • Recommended Products: A list of products recommended to the customer based on their quiz responses, if applicable.

  • Recommended Product IDs: A list of identifiers for the recommended products.

  • First Recommended Product: The first product recommended to the customer, if applicable.

  • First Recommended Product ID: The identifier for the first recommended product, if applicable.

  • Answered Questions: Additional properties containing questions and answers provided by the customer during the quiz.

Received Okendo Referral Coupon

A custom event that is logged in Iterable, when a referral coupon is issued to a customer.

Properties

  • Date Received: The date when the coupon was received.

  • Customer Role: The role of the customer (e.g., referrer or recipient).

  • Locale: The locale or language preference of the customer.

  • Coupon Code: The unique code for the coupon issued to the customer.

  • Coupon Description: A brief description of the coupon.

  • Coupon Expiry Date: The date when the coupon will expire.

  • Order Details (if applicable):

    • Recipient Order Discount Amount: The discount amount applied to the recipient's order.

    • Recipient Order ID: The identifier for the recipient's order, converted to a remote ID format.

    • Recipient Order Number: The order number for the recipient's order.

    • Recipient Order Total Price: The total price of the recipient's order.

Redeemed Okendo Referral Coupon

A custom event that is logged in Iterable, when a customer redeems a referral coupon.

Properties

  • Date Redeemed: The date when the coupon was redeemed.

  • Customer Role: The role of the customer (e.g., referrer or recipient).

  • Locale: The locale or language preference of the customer.

  • Order Discount Amount: The discount amount applied to the redeemer's order.

  • Order ID: The identifier for the redeemer's order.

  • Order Number: The order number for the redeemer's order.

  • Order Total Price: The total price of the redeemer's order.

Opted In to Okendo Referrals

A custom event that is logged in Iterable, when a referrer opts into a referral program.

Properties

  • Date Opted-In: The date when the referrer opted into the referral program.

  • Customer Role: The role of the customer (e.g., referrer).

  • Locale: The locale or language preference of the referrer.

  • Invitation Link: A link for inviting others, if applicable.

  • Referrer Email: The email address of the referrer.

  • Referrer Name: The name of the referrer.

Okendo Referral Shareable Link Used

A custom event that is logged in Iterable, when a recipient opts into a referral program. This event is triggered when an anonymous recipient, completes their details, after clicking on an shared referral link.

Properties

  • Date Opted-In: The date when the recipient opted into the referral program.

  • Customer Role: The role of the customer (e.g., recipient).

  • Recipient Email: The email address of the recipient.

  • Recipient Full Name: The full name of the recipient.

  • Verification URL: A URL for verifying the referral, if applicable.

  • Locale: The locale or language preference of the recipient.

Opted In to Okendo Referrals

A custom event that is logged in Iterable, when a customer opts into a referral program.

Properties

  • Date Opted-In: The date when the customer opted into the referral program.

  • Customer Role: The role of the customer (e.g., recipient).

  • Locale: The locale or language preference of the customer.

  • Invitation Link: A link for inviting others, if applicable.

  • Verification URL: A URL for verifying the referral, if applicable.

  • Recipient Email: The email address of the recipient.

  • Recipient First Name: The first name of the recipient.

  • Recipient Last Name: The last name of the recipient.

Sent Okendo Referral

A custom event that is logged in Iterable, when a referrer sends an invitation to a recipient.

Properties

  • Date Sent: The date when the invitation was sent.

  • Customer Role: The role of the customer (e.g., referrer).

  • Invitation URL: The URL of the invitation.

  • Locale: The locale or language preference of the referrer.

  • Recipient Full Name: The full name of the recipient.

  • Recipient Email: The email address of the recipient.

  • Referrer First Name: The first name of the referrer.

  • Referrer Last Name: The last name of the referrer.

Okendo Referral Invitation

A custom event that is logged in Iterable, when a recipient is sent an invitation link by a referrer.

Properties

  • Customer Role: The role of the customer (e.g., recipient).

  • Date Sent: The date when the invitation was sent.

  • Locale: The locale or language preference of the recipient.

  • Recipient Email: The email address of the recipient.

  • Recipient First Name: The first name of the recipient.

  • Recipient Last Name: The last name of the recipient.

  • Referrer First Name: The first name of the referrer.

  • Referrer Last Name: The last name of the referrer.

  • Invitation URL: The URL of the invitation.

Okendo Referral Rejected

A custom event that is logged in Iterable, when a referral is rejected.

Properties

  • Customer Role: The role of the customer (e.g., referrer or recipient).

  • Should Notify Customer: Indicates whether the customer should be notified.

  • Rejection Reason: The reason for the referral rejection.

  • Email: The email address of the customer.

  • Locale: The locale or language preference of the customer.

  • Rejection Type: The type of rejection (e.g., manual, automatic).

Enrolled in Okendo Loyalty

A custom event that is logged in Iterable, when a customer's loyalty status changes. No additional properties are sent.

Okendo Loyalty Points Awarded

A custom event that is logged in Iterable, when a customer earns loyalty points.

Properties

  • Points Earned: The number of points earned by the customer.

  • Description: A description of the action that earned the points.

  • Action: The specific action that resulted in earning points.

Okendo Loyalty Points Redeemed

A custom event that is logged in Iterable, when a customer redeems loyalty points, for a reward.

Properties

  • Points Spent: The number of points spent by the customer.

  • Description: A description of the redemption.

  • Coupon Code: The code for any coupon associated with the redemption.

  • Coupon Description: A description of the coupon.

Okendo Loyalty Tier Changed

A custom event that is logged in Iterable, when a customer's loyalty tier changes.

Properties

  • Old Tier: The previous tier of the customer.

  • New Tier: The new tier of the customer.

  • Earning Period End: The end date of the earning period for the new tier.

  • Is Tier Upgrade: Indicates whether the change is an upgrade.

Okendo Loyalty Points Adjusted

A custom event that is logged in Iterable, when a customer's loyalty points are adjusted by the merchant.

Properties

  • Adjusted Amount: The amount by which the points were adjusted.

  • Adjusted Description: A description of the adjustment.

Okendo Loyalty Tier Upgrade Nudge

A custom event that is logged in Iterable, when a customer is eligible for a Loyalty tier upgrade. The nudge event is sent, when the customer is within 80% of the spend required for the next tier.

Properties

  • Current Tier: The current loyalty tier of the customer before the upgrade.

  • Next Tier: The next loyalty tier that the customer is being nudged to upgrade to.

  • Spend To Upgrade Tier: The amount the customer needs to spend to reach the next tier.

  • Lifetime: If the eligibility period is 'lifetime', the following property is included:

    • All Time Spend: The total amount the customer has spent over their lifetime.

  • Specific Period: If the eligibility period is a specific time window, the following properties are included:

    • Spent Within Tier Upgrade Window: The amount spent by the customer within the current upgrade window.

    • Tier Upgrade Window End Date: The end date of the current tier upgrade window.

Submitted Okendo Survey

A custom event that is logged in Iterable, when a customer submits a survey response.

Properties

  • Survey Name: The name of the survey that the customer completed.

  • Email Address: The email address provided by the customer.

  • First Name: The first name of the customer.

  • Last Name: The last name of the customer.

  • Survey Questions and Answers: Additional properties containing questions from the survey and the corresponding answers provided by the customer.

  • Reward Information: Depending on the rewardType, additional fields may be included:

    • If rewardType is "coupon":

      • "Coupon Description": A description of the coupon awarded.

      • "Coupon Code": The code for the coupon awarded to the customer.

    • If rewardType is "loyalty":

      • "Loyalty Events": The event ID associated with the loyalty reward, if applicable.

      • "Loyalty Points": The number of loyalty points awarded, if applicable.

      • "Loyalty Provider": The provider of the loyalty program.

Okendo Review Request Cancelled

A custom event that is logged in Iterable, when a review request is cancelled for a customer.

Properties

  • Review Request Id: The unique identifier for the original review request

Adjusting other Okendo settings, before sending communications from Iterable

Before using Iterable, you will want to adjust other settings in Okendo, to ensure communications are not duplicated. Please refer to the following articles to for more information:

Using Okendo data in Iterable

Once you've integrated Okendo with Iterable, you can use custom profile properties and events to help create relevant, highly personalized communications, for various touch points with your customers.

  • Use Handlebars to add custom profile properties and event content to message templates. View this Iterable support article on how to do this.

  • Use custom profile properties and event data to segment customers into static and dynamic lists, for use in journeys and campaigns. View this Iterable support article on how to do this.

  • Use custom profile properties and event data as triggers and conditions within journeys. View this Iterable support article on how to do this.

If you have any specific questions or need further assistance, feel free to reach out to our support team.

Related Articles
Integrating Postscript with Okendo
Integrating Referrals and Klaviyo
Integrating Loyalty with Klaviyo
Getting started with Attentive and Okendo
Did this answer your question?