Installation

First, you need to add the app to your account like this

mutation addApp {
  addApp(appId:"tycka/voyado")
}

After the app has been registered on your account, you need to configure it like this

mutation configureApp {
  configureApp(
    appId: "tycka/voyado"
  	configuration: [
        {
            key: "baseUrl",
            value: "*your voyado base url*"
        }, {
            key: "apiKey",
            value: "*your voyado api key*"
        }, {
            key: "contactTypes",
            value: "*the voyado contact types we should search for contacts in*"
        }, {
            key: "automationTypes",
            value: "*the automation types we should trigger on ppe*"
        }, {
            key: "emailField",
            value: "*email field name (optional)*"
        }
    ]
  )
}

<aside> <img src="/icons/info-alternate_blue.svg" alt="/icons/info-alternate_blue.svg" width="40px" /> emailField is an optional field that can be used if the recipient's email address is not stored in customFields.email on the transaction.

Example

You have stored your recipient's email in a field called customerEmail under the custom fields on your transaction. Then you would set emailField to "customerEmail".

</aside>

With the app added and configured, the only thing left to do is to enable it like this

mutation enableApp {
  enableApp(appId:"tycka/voyado")
}