Using surveys in a Peoplevine Webhook

Forms can only be added to a survey form activity webhook, and are a little different than parameters. They require extra setup prior to using them in a webhook. To set up a Form webhook, follow these instructions:

1. Login to the Peoplevine Control Panel.

2. Navigate to Engage -> Setup New Form.

3. Provide a name for the form and then optionally type instructions or information to display at the top of your form when your customer views it.

4. You can either click Create Form which will take you to adding questions, or you can define advanced options. At the bottom of the advanced options is a Continue button to begin creating questions.

5. Next, you need to add questions to the form.

6. Type out the question you would like to ask your customer.

7. Select the Question Type. This will decide the type of answer that the customer can provide. There are many different types of answers available that fit most any type of question.

8. Once you are finished with the question, click Assign Question.

9. Continue adding questions until all of your desired questions have been added.

10. When saving the last question you want in this form, click Assign & Finished at the bottom of the page to complete the form.

11. Navigate to Engage >> Manage Questions.

12. Each question has a unique ID under the Settings column that will look something like field_11111_0. Copy this ID.

13. Paste this into a HAPI variable, like this: {@field_39435_0@}. This can be added to either the Body of your webhook or added to the end of your webhook URL.

Example JSON

This is an example JSON of a survey. The information requested in the form is the data name in quotations, such as "drink_preference", and the survey question that requests that information is the HAPI variable, "{@field_1234_56789@}".

{
   "drink_preference": "{@field_1234_56789@}", 
   "age": "{@field_56789_1234@}"
}