The Forward to HTTP Endpoint sequence block allows you to forward review requests from Okendo to a specified endpoint. This can be particularly useful to trigger a review request flow in your email marketing platform if a direct integration does not currently exist with Okendo.
In the article, you'll learn about:
Setting up a sequence with a HTTP block
Create a new sequence
Navigate to Mail > Sequences and click the + New Sequence button.
Select the Forward to HTTP Endpoint template and click Create Sequence.
A template will be generated with 3 blocks: Recruit, Wait and HTTP.
Define the steps in your sequence
Click on each block to configure it.
The Recruit Block automatically pulls in orders fulfilled after your selected start date. Choose an end date or leave it blank to continue recruiting orders indefinitely.
The Wait Block allows you to specify the number of days before proceeding with the next block for both Domestic & International orders.
Configure your HTTP request
Click on the HTTP block.
Set your destination URL such as the API endpoint of the platform you want to send the review request data to or the URL provided by a webhook receiver.
Select your HTTP method:
POST - Create a new resource.
PATCH - Update part of a resource.
PUT - Replace a resource entirely.
Define the headers for your request. For example, if your body is using the JSON format the you will need to set the Key as
content-typeand Value asapplication/json.Add the body for your request in the accepted format of the destination to include the required review request data. If you're sending it directly to a platform rather than middleware then the API documentation will typically include this. For a list of variables that can be used, refer to this section. A sample body is below which provides the name of the reviewer, the product ID, product variant as well as the review URL:
{
"firstName": "{{firstName}}",
"lastName": "{{lastName}}",
{{#each reviewRequestProductList}}
"{{this.productId}}": {
"name": "{{#if this.variantName}}{{this.variantName}}{{else}}{{this.name}}{{/if}}",
"reviewUrl": "{{this.reviewUrl}}"
}{{#unless @last}},{{/unless}}
{{/each}}
}
Once you are happy with the configuration, save your changes and click the Start button to initiate your sequence.
Testing your sequence
You can follow the steps below to test that your sequence is working as expected.
Navigate to a site such as Webhook.site and copy the unique URL that will receive and display requests.
Set this as the destination URL. A validation event is sent when a template is created and then saved. If the request is successful you should see these events coming through with content similar to the below.
{
"firstName": "Jane",
"lastName": "Smith",
"shopify-7935669666048": {
"name": "Black / Aluminium",
"reviewUrl": "https://okendo.reviews/subscriberId=fc8ed315-0b95-4767-99e7-36bec4a0abc6&productId=shopify-7935669666048&testMode=true"
},
"shopify-7935679136000": {
"name": "Black / Plastic",
"reviewUrl": "https://okendo.reviews/subscriberId=fc8ed315-0b95-4767-99e7-36bec4a0abc6&productId=shopify-7935679136000&testMode=true"
},
"shopify-7992059527424": {
"name": "Black / Aluminum",
"reviewUrl": "https://okendo.reviews/subscriberId=fc8ed315-0b95-4767-99e7-36bec4a0abc6&productId=shopify-7992059527424&testMode=true"
}
}Trigger a test purchase on your store and fulfil the order. If successful you should see the request coming through.
Tip: to skip the sequence delay, navigate to Send Queue from the side navigation and skip the wait.
Note: We retry requests up to 5 times. If they are not successful, the sequence will be paused automatically. Once the issue is fixed, restart the sequence to test again.
Variables that can be used
The following variables are available to be used within the body of the request. Make use of Handlebars looping syntax (the {{#each}} helper) for looping through arrays.
Top-level fields
emailAddress (string) – The customer’s email address
firstName (string, optional) – The customer’s first name
lastName (string, optional) – The customer’s last name
reviewRequestProductList (array of Products) – The list of products included in the review request
Product fields (inside reviewRequestProductList)
Each product in the list includes the following:
imageUrl (string) – The product image URL
name (string) – The product name
productId (string) – The product ID
variantName (string, optional) – The name of the variant (if applicable)
variantRemoteId (string, optional) – The remote ID of the variant (if applicable)
variantSku (string, optional) – The SKU of the variant (if applicable)
reviewUrl (string) – The link where the customer can leave a review
reviewVoteUrls (array of VoteUrls) – Links for quick star rating feedback
VoteUrl fields (inside reviewVoteUrls)
Each VoteUrl includes:
stars (number) – The number of stars (e.g. 1–5)
url (string) – The link for submitting that star rating
Sending follow up emails
Depending on your email marketing platform, it may be possible to trigger follow up emails after a shopper submits a review.
If your email platform supports webhook based triggers, you can subscribe to the Okendo review.create topic. This allows your email platform to receive a notification when a new review is submitted and use that event to start a flow or automation.
If your email platform does not support inbound webhooks, a middleware tool can be used to receive the Review Created event and pass the data into your email platform in a supported format. Refer to our webhooks help article for details on available events and payload structure.
Use cases include:
Detecting if a review has not been submitted and sending a follow up email after a wait period to submit a review
Requesting a site review after a product review has been submitted
Requesting media to be added to an existing review, if a text-only review has been submitted
If you need help building a sequence or require a specific body template, speak to your customer success manager or reach out to our support team.