Skip to main content
Welcome to the integration and API documentation portal for Voyado Engage.
The AI assistant is already ready to help you. Hit the “Ask Assistant” button above or write your question in the input area at the bottom of the page where it says “Ask a question”.

​
API version

These docs cover the latest version of the Voyado API, which is version 3. The docs for the legacy API v2 can be found here:

See the docs for the legacy v2 API

If you are moving from v2 to v3 it is recommended to read the changes page:

See changes between Engage API v2 and v3

​
Initial setup

This walks you through how to get started with Engage.
1

Configure your Engage account

A lot of your basic configuration can be done in the Config Hub. See here:

Config Hub articles

2

Understand your data model

Customer (contact) data and consents are central to working with Engage:

Contacts data model

Working with consents

3

Customer and store data

Read these sections to learn about customer and store data:

Contacts

Transactions

Orders

Stores

Importing historical data

4

Product data

Here you can learn about working with your product data and feeds:

Product data

Article register

5

Integrations

When integrating your systems with Engage you’ll be working with the Engage API and/or the FTP. Learn about those here:

File transfer by FTP

The Engage API

6

Deliverability

Making sure your emails get delivered is important before going live with Engage:

Domain authentication

For a more detailed guide on integrating your systems with Engage, see the Integrations Best Practice guide.

​
Config hub

As mentioned, your Engage environment has a self-service area, called Config Hub, where several parts of the initial setup of Engage can be done. All guides for Config Hub can be found in the Engage Help Center:

Show me the Config Hub articles

Only users belonging to the “Configurator” permission group can access the Config Hub.

Read more about permission groups

User guides and instructional articles can be found at the Engage Help Center:

Show me the Help Center

On the status page for Engage you can see if there are any current issues. You can also subscribe to be informed of important service updates which is recommended.

Engage Status Page

Partner integration articles can be found at the dedicated portal:

Take me to the partner integrations portal

Voyado takes no responsibility for code created and shared by unauthorized third parties. Any code you download and use from public repositories such as GitHub is done entirely at your own risk, even if it has “Voyado” in the name.