Skip to main content

Voyado Engage

Zendesk

Zendesk Support is a simple system for tracking, prioritizing, and solving customer support tickets. Read more at zendesk.com.

Voyado Zendesk integrations starter kit

Voyado ships a starter kit, consisting of a front end source code solution, possible to compile and to be installed as a so called “private app” in Zendesk. The solution show cases reading and writing towards some of Voyado’s entities, via Voyado’s external API. All this without leaving Zendesk.

Within the Zendesk configuration it will also be able to activate some loyalty components for those Clients using reward vouchers.

Voyado clients will need to handle the installation, modifications and maintenance for this integration within their own teams or external partners.

The app, when in place, will thus not be supported by Voyado. Questions regarding the source code and general integrations issues can be addressed to your Voyado contact.

Partner guided setup

For clients desiring adaptations and maintenance of the solution and guidance in such an integration project Voyado will be able to refer to a partner specialized in Zendesk: The Service Corporation.

This firm is well aware of Voyado’s capabilities as well as the starter kit solution itself. Please contact The Service Corporation directly or reach out to your Voyado contact for such an introduction.

Staff/resources and knowledge requirements

To handle such an integration project the IT department needs to get involved, or an external IT resource. Generally this kind of work requires a development setup or a person comfortable with installing and follow guides on how to add packages in some power shell like environment.

The solution is built using the Aurelia front end framework. Most developers used to front end libraries will be able to compile, alter and modify the solution and install it in Zendesk.

Furthermore accessing data from Rest API:s is a fundamental functionality for this solution as all logic and presentation is residing in the Front end.

The only critical logic residing and written specifically for the Zendesk-application-production environment is the application configuration covering the data access: with the API-key and Voyado environment-URL.

Previously administration of the client’s Zendesk environment is of course of good use.

Installation notes

  • Download the source code base as a Zip.

  • Unzip, read and follow the readme-instructions. This will include a compilation of the source code to an “app”.

  • With your compiled private app-zip, note it must weigh less than 2MB in size, go to your Zendesk environment (with admin rights) > Open APPS > Manage under the configuration wheel:

    zendesk.png
  • Chose Upload private app

  • Under My apps click the Voyado app and enable the app.

    zendesk2.png
  • Configure app with Client specific authentication and API access accordingly

    zendesk3.png

Available data

The data you can access to read and update is presented in the table below.

Field

Accessibility

Name

Read/Update

Address

Read/Update

Email opt-in

Read/Update

Mobile opt-in

Read/Update

Postal opt-in

Read/Update

Consents

Read/Update

Reward vouchers (if activated)

Read/Redeem

Reward point history (if activated)

Read

Purchase statistics

Read

Purchase history

Read

Target audience

Read

Included API endpoints

Endpoints

Information

api/v2/contactoverview

Contact information, consents

api/v2/contacts/{contactId}

Updates the contact

api/v2/purchasehistorysummary

Purchase statistics

api/v2/contacts/{contactId}/bonuspointtransactions

Point transactions

api/v2/contacts/{contactId}/bonuschecks?count=20

Reward vouchers available

api/v2/contacts/{contactId}/transactions

Purchases and returns