# Voyado (prebuilt connector)

## Description

**Voyado** is a customer experience platform helping retailers with marketing automations, loyalty schemes, campaign management, and more.

## Authentication&#x20;

When adding connector instances for **Voyado**, the following authentication methods are supported:

* [API key](#api-key-authentication)

## API documentation

API documentation for **Voyado** (used to build this connector) can be found via the link below:

{% embed url="<https://developer.voyado.com/en/api/introduction.html>" %}

### API key authentication

When a user chooses to [add a connector instance](https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance) using **API key** authentication, the credentials below are prompted:

<table><thead><tr><th>Credential</th><th width="145" data-type="checkbox">Required?</th><th>Notes</th></tr></thead><tbody><tr><td><code>api key</code></td><td>true</td><td> API keys are issued by Voyado support. </td></tr><tr><td><code>base url</code></td><td>true</td><td>Enter the full URL that you use to access Voyado. For example: <code>https://abc123.staging.voyado.com</code></td></tr><tr><td><code>user agent</code></td><td>true</td><td>This identifies which Voyado system and version you are using. For example: <code>AcmePOS/1.5</code>.</td></tr></tbody></table>
