> ## Documentation Index
> Fetch the complete documentation index at: https://developer.voyado.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting started

Welcome to the integration and API documentation portal for Voyado Engage.

<Tip>
  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".
</Tip>

## 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:

<Card title="See the docs for the legacy v2 API" href="https://legacy.developer.voyado.com" icon="right" horizontal />

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

<Card title="See changes between Engage API v2 and v3" href="/docs/api/api-changes-v3" icon="https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399" horizontal width="128" height="128" data-path="icons/developer-link.png" />

## Initial setup

This walks you through how to get started with Engage.

<Steps>
  <Step title="Configure your Engage account">
    A lot of your basic configuration can be done in the Config Hub. See here:

    <Card title="Config Hub articles" href="https://help.engage.voyado.com/hc/en-gb/sections/21844508239004-Configuring-Engage-via-Config-Hub" icon="https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/help-center-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=3e7ca2ce0b8cfb9fbd27a4bdf53b2ce1" horizontal width="128" height="128" data-path="icons/help-center-link.png" />
  </Step>

  <Step title="Understand your data model">
    Customer (contact) data and consents are central to working with Engage:

    <Columns cols={2}>
      <Card title="Contacts data model" href="/docs/contacts/contact-field-definitions" icon="https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399" horizontal width="128" height="128" data-path="icons/developer-link.png" />

      <Card title="Working with consents" href="/docs/setup/consents" icon="https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399" horizontal width="128" height="128" data-path="icons/developer-link.png" />
    </Columns>
  </Step>

  <Step title="Customer and store data">
    Read these sections to learn about customer and store data:

    <Columns cols={2}>
      <Card title="Contacts" href="/docs/contacts" icon="https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399" horizontal width="128" height="128" data-path="icons/developer-link.png" />

      <Card title="Transactions" href="/docs/transactions" icon="https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399" horizontal width="128" height="128" data-path="icons/developer-link.png" />

      <Card title="Orders" href="/docs/orders" icon="https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399" horizontal width="128" height="128" data-path="icons/developer-link.png" />

      <Card title="Stores" href="/docs/setup/stores" icon="https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399" horizontal width="128" height="128" data-path="icons/developer-link.png" />

      <Card title="Importing historical data" href="/docs/file-based-transfer/historical-data" icon="https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399" horizontal width="128" height="128" data-path="icons/developer-link.png" />
    </Columns>
  </Step>

  <Step title="Product data">
    Here you can learn about working with your product data and feeds:

    <Columns cols={2}>
      <Card title="Product data" href="/docs/setup/product-feeds" icon="https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399" horizontal width="128" height="128" data-path="icons/developer-link.png" />

      <Card title="Article register" href="/docs/setup/article-register" icon="https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399" horizontal width="128" height="128" data-path="icons/developer-link.png" />
    </Columns>
  </Step>

  <Step title="Integrations">
    When integrating your systems with Engage you'll be working with the Engage API and/or the FTP. Learn about those here:

    <Columns cols={2}>
      <Card title="File transfer by FTP" href="/docs/file-based-transfer/file-transfer-by-ftp" icon="https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399" horizontal width="128" height="128" data-path="icons/developer-link.png" />

      <Card title="The Engage API" href="/docs/api/the-engage-api" icon="https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399" horizontal width="128" height="128" data-path="icons/developer-link.png" />
    </Columns>
  </Step>

  <Step title="Deliverability">
    Making sure your emails get delivered is important before going live with Engage:

    <Card title="Domain authentication" href="https://help.engage.voyado.com/hc/en-gb/articles/23408480085788-Domain-authentication-email" icon="https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/help-center-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=3e7ca2ce0b8cfb9fbd27a4bdf53b2ce1" horizontal width="128" height="128" data-path="icons/help-center-link.png" />
  </Step>
</Steps>

<Tip>
  For a more detailed guide on integrating your systems with Engage, see the [Integrations Best Practice guide](/docs/setup/best-practice-guide).
</Tip>

## 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:

<Card title="Show me the Config Hub articles" href="https://help.engage.voyado.com/hc/en-gb/sections/21844508239004-Configuring-Engage-via-Config-Hub" icon="https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/help-center-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=3e7ca2ce0b8cfb9fbd27a4bdf53b2ce1" horizontal width="128" height="128" data-path="icons/help-center-link.png" />

<Warning>
  Only users belonging to the "Configurator" permission group can access the Config Hub.
</Warning>

<Card title="Read more about permission groups" href="https://help.engage.voyado.com/hc/en-gb/articles/23404517912092-About-Permission-Groups" icon="https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/help-center-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=3e7ca2ce0b8cfb9fbd27a4bdf53b2ce1" horizontal width="128" height="128" data-path="icons/help-center-link.png" />

## Other links

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

<Card title="Show me the Help Center" href="https://help.engage.voyado.com/hc" icon="https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/help-center-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=3e7ca2ce0b8cfb9fbd27a4bdf53b2ce1" horizontal width="128" height="128" data-path="icons/help-center-link.png" />

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.

<Card title="Engage Status Page" href="https://status.voyado.com" icon="right" horizontal />

Partner integration articles can be found at the dedicated portal:

<Card title="Take me to the partner integrations portal" href="https://partner-integrations.voyado.com/" icon="https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/partner-integrations-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=4302f860750a0d1c4c00820d018f6659" horizontal width="128" height="128" data-path="icons/partner-integrations-link.png" />

<Warning>
  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.
</Warning>
