Voyado Integration

Last modified: October 29, 2025

The Voyado integration allows Trustvoice to both write review data back to Voyado Engage and optionally read customer, order, and product data via Voyado Delta Share.


Voyado API Integration – Write back review content to Voyado Engage

Overview

Trustvoice writes back two kinds of data to Voyado Engage:

  • Interactions – individual reviews created in Trustvoice are posted as “Completed Trustvoice review” interactions.
  • Custom contact attributes – each customer’s aggregated review data (latest date, latest score, average rating) is updated on the contact card.

These updates require that the Interactions feature is enabled in your Engage tenant and that an API key is created and shared securely with Trustvoice.

If you are using multiple tenants in Voyado Engage, you also need to share how the Trustvoice Client IDs and the Voyado Engage tenants map to each other.

Prerequisites

Before proceeding, ensure the following:

  1. Interactions are enabled for your tenant – this must be done by a Voyado representative.
  2. You know your Tenant ID – this identifies your Voyado environment (for example, exampletenant.voyado.com).
  3. An API key with permission to use the Interactions and Contacts APIs has been created in Engage.

Steps to Configure

1. Enable Interactions

Ask your Voyado account manager or project manager to activate Interactions for your tenant.

You can verify this under Administration → Integrations → Interactions.

2. Create the Interaction Schema

Trustvoice will create an Interaction schema in your Engage environment.

Voyado uses JSON Schema to define each interaction type.

The following schema will be created by Trustvoice automatically:

{
  "jsonSchema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
      "productSku": {
        "type": "string",
        "displayName": "Sku",
        "showInContactCard": "true",
        "addToSegmentation": "true"
      },
      "rating": {
        "type": "integer",
        "displayName": "Rating",
        "showInContactCard": "true",
        "addToSegmentation": "true"
      },
      "comment": {
        "type": "string",
        "displayName": "Comment",
        "showInContactCard": "true"
      }
    }
  },
  "id": "completedProductRating",
  "displayName": "Completed Trustvoice review"
}

3. Create Custom Contact Attributes

Trustvoice uses three additional contact attributes to store aggregate review data:

ID Name Type Description
reviewLatest Review Latest Date Date of most recent review
reviewLatestValue Review Latest Value Integer Rating from most recent review
reviewAverageGrade Review Average Grade Number Contact’s overall average rating

Configure these as:

  • Segmentable
  • Exportable
  • Read-only in contact card

You can optionally group them in a separate contact-card tab such as “Ratings & Reviews”.

Example of data Trustvoice sends to update a contact:

{
  "reviewAverageGrade": 4.5,
  "reviewLatest": "2025-10-20T13:00:00.000Z",
  "reviewLatestValue": 5
}

4. Sending Review Interactions

When a customer submits a review in Trustvoice, the integration posts a corresponding interaction to Engage.

{
  "schemaId": "completedProductRating",
  "contactId": "ea50e150-e12a-49f9-a496-b21001450d55",
  "createdDate": "2025-07-05T09:26:01.000Z",
  "payload": {
    "productSku": "17184225",
    "rating": 5,
    "comment": "Great fit just as I expected"
  }
}

Endpoint: POST /api/v3/interactions

These interactions appear on the contact card under the Interactions tab and can be used for segmentation, automations, or reporting.


Voyado Delta Share – Read Data from Engage

Overview

Voyado’s Delta Share provides Trustvoice with access to your Engage data (orders, order items, customers, stores and products).
This allows Trustvoice to generate review invitations based on transactions stored in Voyado.

Prerequisites

  • The Delta Share feature must be activated by Voyado’s CX team.
  • A separate Delta Share key must be generated and shared with Trustvoice. This key is distinct from the API key used for write-back operations.

References