Voyado
Use GrowthLoop audiences and warehouse data for Voyado Engage contact attributes.
Connect this destination to export audience membership onto a Voyado contact attribute, or to write warehouse rows onto Voyado contacts, for use in Voyado segments, automations, and personalization.
This destination writes to your Voyado account and is a good fit when you want to:
- Match Voyado contacts on Email, Mobile Phone, External ID, or Member Number
- Use Voyado segments or automations with GrowthLoop audience membership or warehouse contact fields
This maps to GrowthLoop Audiences, Journeys, and Syncs:
| Use it for | Audiences | Journeys | Syncs |
|---|---|---|---|
| Writing audience membership to a Voyado contact attribute | ✓ | ✓ | |
| Creating or updating Voyado contacts from a warehouse table | ✓ |
Audience exports manage membership on the Audience Attribute. Syncs write other mapped contact fields. They do not add or remove audience membership.
Prerequisites
Make sure you have:
- A Voyado Engage account with permission to create API connections.
- A Voyado API Key that can read and update contacts. See Voyado's API connections.
- Your Voyado tenant URL, such as
https://mytenant.voyado.com. Do not include/api/v3. - A custom contact attribute in Voyado Engage for audience membership. GrowthLoop defaults to
growthloopaudience. Create it in Voyado before you export.
NoteGrowthLoop does not create the audience attribute. If it is missing, exports fail or membership does not appear on the contact.
Set up Voyado as a destination
- In GrowthLoop, click the Destinations tab on the left sidebar.
- Click New Destination in the top right corner.
- Search for Voyado and click Add Voyado.
- Enter the required information, then click Create.
| Field | Description |
|---|---|
| Destination Name | Name this destination in GrowthLoop. Use a name so your team recognizes its purpose, like "Voyado Engage". |
| Sync Frequency | Set the default export frequency (for example, daily or weekly). You can override this setting for individual exports and syncs. |
| API URL | Voyado Engage tenant URL without /api/v3, such as https://mytenant.voyado.com. |
| API Key | API key from your Voyado Engage API connection. |
| Prefix for Personalization Fields (optional) | Prefix GrowthLoop adds to personalization fields, then strips before writing the Voyado attribute. The default value is fw. Leave this blank for no prefix. If you set one, it must start with a letter and use up to 5 letters or numbers. |
| Source (optional) | Value GrowthLoop sends when it creates a contact. Defaults to growthloop_cdp. |
| Audience Attribute (optional) | Custom contact attribute that stores audience membership. Defaults to growthloopaudience. Use the same name you created in Voyado. |
GrowthLoop validates the connection against the Voyado health endpoint. Voyado then appears in your list of connected destinations.
Export to Voyado
From within GrowthLoop, export from an audience or from a journey Destination Node. See Export an audience or Build a journey if you need more information on these steps.
After building or selecting an audience, click Export, then search for Voyado. In a journey, add a Destination Node under Email and select Voyado.
Map contact identifiers
On an audience or in a journey Destination Node, map one match field:
| Match field | Notes |
|---|---|
| Voyado email | |
| Mobile Phone | Voyado mobile phone |
| External ID | Voyado external ID |
| Member Number | Voyado member number |
You can also map additional fields, including custom attributes from the audience or from the journey. GrowthLoop writes those as Voyado contact attributes. GrowthLoop can prefix those field names with Prefix for Personalization Fields.
Configure the export
This is where you set the campaign type and schedule for audience exports. On a journey Destination Node, you set timing on the journey canvas.
| Setting | Audience export | Journey Destination Node |
|---|---|---|
| Export Name | Defaults to {audience name}_GL_Audience_{audience ID}. GrowthLoop writes that name onto the Audience Attribute. | Required. Enter a name so you can find the export in GrowthLoop. GrowthLoop writes that name onto the Audience Attribute. |
| Campaign type | Choose a one-time or ongoing export. | The journey schedule controls when the journey runs and contacts are sent to Voyado. |
| Export Inclusion Criteria | All audience members for a full refresh, or Newly added audience members for additions and removals since the last export. | The journey sends contacts who reach this node. |
| Schedule | Set frequency, start date, end date, and days of the week for ongoing exports. | Users reach this node when the journey runs. Add a Delay Node or set Criteria Evaluation to control timing. |
Export behavior
This is what GrowthLoop writes when you export an audience.
| Behavior | What happens |
|---|---|
| What GrowthLoop writes | Audience membership on the Audience Attribute, plus any mapped personalization attributes. Direction is GrowthLoop → Voyado Engage. |
| When it runs | GrowthLoop sends the export as a batch on the next successful run. An export that starts Now runs within about 15 minutes. Journeys send exports on demand when users reach the Destination Node. |
| Match field | Email, Mobile Phone, External ID, or Member Number. |
| Adds | GrowthLoop appends the export name to the audience attribute. If the contact is in more than one exported audience, the attribute is a comma-separated list. |
| Removes | GrowthLoop removes that export name from the attribute. The attribute is empty when no exported audiences remain. |
| Personalization | Mapped additional fields write as contact attributes on add. GrowthLoop strips Prefix for Personalization Fields before writing the attribute name. |
| New contacts | Contacts that do not yet exist in Voyado are created, then updated with membership and mapped fields. |
| One-time exports | GrowthLoop sends current membership once. |
| Ongoing adds and removals | Ongoing exports add contacts who enter the audience and remove contacts who leave. |
| Deletes | GrowthLoop does not delete Voyado contacts. |
Create a sync in GrowthLoop
Create a sync from a warehouse table to write rows onto Voyado contacts. See Syncs for information on how to complete those steps.
Select an Object Type:
| Object | Use it for | Sync modes |
|---|---|---|
| Contact | Create or update Voyado contacts | Insert only, Update only, or Insert or update |
When you configure the sync:
- Connection: Select your Voyado destination.
- Object Type: Select Contact.
- Update Rule: Choose Insert only, Update only, or Insert or update. See Sync behavior.
- Dataset/Table: Select the warehouse table that holds the records.
- Match Field: Map Email, Mobile Phone, External ID, or Member Number.
After you map fields, click Save Sync or Update Sync. Enable the sync with the toggle at the top of the page.
When you update mappings on an existing sync, choose Updates only unless you need Back-fill. Back-fill rewrites already synced rows and can be expensive on your warehouse.
The mapping UI lists common Voyado contact fields. Type every other custom attribute name in the destination field. Names must already exist in Voyado Engage.
Syncs write contact attributes. They do not add or remove audience membership. To manage membership, export an audience.
Contact fields
| Destination field | Required | Description |
|---|---|---|
| Email, Mobile Phone, External ID, or Member Number | Yes | Map at least one identifier |
| First Name | No | Contact first name |
| Last Name | No | Contact last name |
| Street | No | Street address |
| Zip Code | No | Postal code |
| City | No | City |
| Country | No | Country |
| Gender | No | Gender |
| Birth Date | No | Birth date |
| Preferred Language | No | Preferred language |
| Audience Membership | No | Writes growthloopaudience. A sync overwrites this attribute. Use an audience export to add or remove membership |
| Additional Voyado attribute names | No | Type the exact attribute name from Voyado Engage |
Sync behavior
| Behavior | What happens |
|---|---|
| When it runs | GrowthLoop sends the sync as a batch on the next successful run. |
| Insert only | GrowthLoop creates contacts that do not already match. Rows that already exist are skipped. |
| Update only | GrowthLoop updates mapped fields on matching contacts. Rows that do not match are skipped. |
| Insert or update | GrowthLoop updates the contact when it matches, and creates a contact when it does not. |
| Match field | Email, Mobile Phone, External ID, or Member Number. |
| Audience membership | Syncs do not add or remove names on the Audience Attribute. |
| Deletes | GrowthLoop does not delete Voyado contacts. |
Rows without a contact identifier fail.
Confirm the export was successful
When the run finishes, confirm you can use the data in Voyado.
- Audience export: Look up a contact from the export and confirm the Audience Attribute contains the
_GL_Audience_name unless you changed Export Name. You can then filter Voyado segments and automations on that attribute. - Journey Destination Node: Look up a contact who reached the node and confirm the Audience Attribute includes the export name.
- Contact sync: Search for the contact and check the mapped attributes.
In GrowthLoop, review counts on the audience Exports tab, open the Activity tab on the journey Destination Node, or confirm the sync appears in the Syncs table. See Export an audience, Monitor a journey, or Syncs for more information.
Congrats on successfully exporting to Voyado!
Troubleshooting
These are the issues we see most often. You can always email us at [email protected] for help.
| Problem | Cause | Resolution |
|---|---|---|
| Connection fails to validate | API URL or API Key is wrong, or the URL includes /api/v3 | Paste the tenant URL only, such as https://mytenant.voyado.com. Copy the API key from Voyado API connections |
| Rows fail to export or sync | No contact identifier is mapped | Map Email, Mobile Phone, External ID, or Member Number |
| You cannot find membership in Voyado | The Audience Attribute does not exist, or you are searching for the unsuffixed audience name | Create the attribute in Voyado, then search the contact for the _GL_Audience_ export name |
| An insert-only sync skipped a row | Update Rule is Insert only and the contact already exists | Use Insert or update to update existing contacts |
| An update-only sync skipped a row | Update Rule is Update only and no Voyado contact matched | Use Insert or update to create missing contacts, or map an identifier that already exists |
| A sync overwrote audience membership | You mapped Audience Membership or growthloopaudience | Remove that mapping. Export an audience to add or remove membership |
| A sync did not change audience membership | Syncs write other contact attributes only | Export an audience to add or remove names on the Audience Attribute |
Updated 16 days ago