Custom Queue Implementation: API

Introduction

This is a short guide to demonstrate how you can build your own Queue to send e-satisfaction Questionnaires to your users.

You will have to create yourself a Questionnaire Instance and send the message to your customers.

Step 1: Setup Metadata (optional)

When creating a Questionnaire Instance, you can create some Metadata to identify the responder or the transaction. Make sure you have added all the metadata you need in your Application Metadata section:

You can also Create your Own Metadata.

Step 2: Create Questionnaire Instance (API)

Step 2.1: Get the Ids you need for API Calls

You will have to get the following information:

Questionnaire Id

To find the Questionnaire Id, you have to go to your Questionnaire Settings page and get the Questionnaire Id:

Step 2.2: Make the API Call

Before moving forward, make sure you have read and understood our API Documentation.

Read the Create new questionnaire instance API specification to help you setting up your API Call.

From your response you will be able to get the following fields:

Choose one of the following according to your channel. For SMS channel we suggest using the shortened url so that you can write a longer and more personalized message to the user.

Send Message to your Customer

Now that you have created the Questionnaire instance and you have received the collection urls, setup your message and embed the url like the following examples:

SMS

Thank you for your purchase! Take 30 seconds to tell us your opinion here: %{collection_url_short}

Where %{collection_url_short} will be replaced with the url.

Email

Somewhere inside the HTML of the email, you can add a button with the following link:

<a href="%{collection_url_long}">Take the Survey!</a>

Where %{collection_url_long} will be replaced with the url.

For email you can choose either long or short urls as there is no content limitation.

Page updated

Report abuse