# 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](/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance.md) 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>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/patchworks-connectors/voyado-prebuilt-connector.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
