Introduction
This guide covers general concepts and the step-by-step actions you'll take when integrating Voyado Engage to your system. This is a high-level view so data fields and JSON specifications will not be covered in any detail. If you need that, see your Swagger page, or the Engage developer documentation.
Important
This guide deals with how to connect your own system to Voyado Engage from scratch. Engage also has prebuilt integrations (accelerators) supporting many third-party systems, enabling a faster and easier integration. See a selection here.
Synchronous integration
When connecting your system to Engage, you'll be building a synchronous integration. This means that once the Engage API is called your workflow needs to wait for a response before continuing in its flow. If Engage does not return a response in time, you'll need a fallback with a retry function in place to handle this.
Read more about Engage's retry policy here.
Prerequisites
Some initial configuration is needed in Engage before you can start integrating your data and flows. So make sure that these basic steps have been completed before you continue.
Confirm that stores are created and configured correctly in Engage. This is needed since contact data usually contains a reference to the store where the contact signed up.
Confirm that contact attributes are set up. This involves the configuration of the contact identification key and the mandatory and unique fields for contacts in Engage.
You should have an article register in your Engage environment. This is so you can segment contacts based on purchases using article data attributes like category and brand.
Integration flows
You'll find these various integration flows in their own articles.