To integrate Okendo with Omnisend, you will first need to provide Okendo with permission to send your Omnisend account messages. This guide will give details for this process and the next steps you can take to complete the integration.

Contents

Create an API Key in Omnisend

Connecting Okendo to Omnisend

Using Custom Events in Omnisend Workflows

Okendo Review Custom Event

Okendo Review Request Custom Event

Example Review Payload

Review Request Payload

Example HTML for the Review Request Email

Create an API Key in Omnisend

  1. Log in to your Omnisend account.
  2. In the top right, you will find a drop-down menu—select Store Settings.
  3. Select the Integrations & API tab and then CREATE API KEY +.
  4. Give it an informative name and select Custom Permissions, making sure to select both Contacts and Events. For details on how Okendo uses these permissions, see below.
  5. Click Save. The page will then change to a list of your API keys, including your newly created one, required to complete the integration.

Connecting Okendo to Omnisend

  1. Navigate to the Integrations page on the Okendo App (Settings > Integrations).
  2. Open the Omnisend section, enable the integration, and copy your API Key into the corresponding field.
  3. Click Save. Okendo will connect to Omnisend and set up your custom events for use as outlined below.

Using Custom Events in Omnisend Workflows

Omnisend allows you to create customized Workflows by selecting the Automation tab in the Omnisend admin app. The first step will be to select a "trigger" which will initiate the workflow. To implement data sent from Okendo, you will need to select a custom event with the Okendo prefix.

Okendo Review Custom Event

When a user leaves a review for a product, either using the "Write A Review" button or by following the links in a "Review Request Email", Okendo will send the data from the review to a custom event in Omnisend called Okendo Review. An example payload can be found at the bottom of this article.

An example workflow using this data could be a simple "thank you" message or, if the reviewer has left a 4 or 5-star review with no photos or videos, you can ask them if they would like to add a photo or video to their review.

Note that we will also update your contacts to include this new reviewer or update their details if contact with their email already exists in Omnisend. If you are on Okendo's Pro plan or above, you can set customer attributes on products in the Attributes section of the Okendo app. These customer attributes will also be added to your contacts in Omnisend, alongside:

  • The reviewer's latest review rating.
  • The reviewer's total number of reviews.

To view your contacts, select the Audience tab in the Omnisend admin app, and you will be able to view your entire list of contacts and set up Segments based on these properties. Possible use cases would be:

  • Send a special "thank you" email to users who have left more than 10 reviews.
  • Create a marketing campaign for users who have a specific custom attribute. For example, if you have a new product designed for people with blonde hair, then you can specify that only users with hair color: blonde will receive the marketing emails.

Okendo Review Request Custom Event

When a customer purchases a product and their order is fulfilled, the customer's order will enter an email sequence, which can be customized on the Sequences section of the Okendo app. By selecting the "Forward to Omnisend" template, instead of sending a Review Request Email from Okendo, we will send the details of the order, customer, and product to a custom event in Omnisend called Okendo Review Request.

Also included in the payload will be the URLs for each purchased product, which will link to the Review Recorder, where the customer will be able to leave a review. An example payload can be found at the bottom of this article.

If a customer refunds their product, or the order is canceled for another reason, Okendo will inform Omnisend by posting a message to the Okendo Cancel Review Request custom event. Remember to set this as one of the "Exit conditions" in your Omnisend Workflow.

Omnisend uses a special template language in their emails, which allows us to insert images, text, and links into the emails using the data sent from Okendo (such as product images and links to the Review Recorder). Omnisend's email template customization is very flexible, so you can structure your Review Request emails however you would like. We have some sample HTML at the end of this article, which you can include (in an HTML block) in your email template, which will list up to five of the products purchased and links to the Review Recorder.

Example Review Payload

Below is an example of a payload that Okendo would send to Omnisend when a customer leaves a review of your store's products. Note that you can set custom attributes for your product reviews within the Okendo app, and these will appear in the payload as well (converted to "camel case", with a number at the end in the case of multi-select attributes).

"rating": 4, 
"reviewTitle": "My New Favourite Product",
"reviewBody": "I cannot believe how much I love this new product.",
"isRecommended": true,
"sentiment": "positive",
"languageCode": "en",
"source": "write-review-button",
"productID": "1885452822491",
"productName": "Small Cat Toy",
"variantID": "17387480307827",
"variantName": "Roller Coaster",
"sku": "888888",
"reviewerDisplayName": "Bob M.",
"reviewerFullName": "Bob McGee",
"couponCode": "OKR-DISCOUNT-CODE",
"couponDescription": "$5 off your next order",
"loyaltyEvents": "OkendoLoyaltyEvent",
"loyaltyPoints": "100",
"loyaltyProvider": "LoyaltyLlama",
"imageCount": 1,
"imageUrls1": "https://i.imgur.com/PU37h8I.jpg",
"videoCount": 0,
"sizePurchased": 4,
"thingsIWantTheProductFor1": "Myself",
"thingsIWantTheProductFor2": "My Cat"

Review Request Payload

Below is a list of properties sent from Okendo to Omnisend when an order is fulfilled in your store. Each of the properties prefixed with "product1" will also have property included for "product2", "product3", "product4", and "product5", but they aren't in the snippet below to conserve space.

emailAddress
firstName
lastName
product1Name
product1ImageUrl
product1ReviewUrl
product1Rate1Url
product1Rate2Url
product1Rate3Url
product1Rate4Url
product1Rate5Url

The "Rate5Url", "Rate4Url", etc. will take the user to the Review Recorder and prefill their rating as 5 stars, 4 stars, etc.

Example HTML for the Review Request Email

Below is the raw HTML, which can be copied and pasted directly into an HTML block in an Omnisend Workflow's email template to display the list of products with star ratings which link to the Review Recorder similar to the default email which Okendo sends to customers.

[% if custom_event.product1Name %]<div style="margin:0px auto;max-width:600px;background:#fff;"> <tab

Did this answer your question?