It is possible to add a respondent to the survey invitation recipient database without sending an invitation. A Webhook is simply a URL called by another IT system or opened in a standard browser.

The URL address format is as follows:

https://app.customerhero.com/webhooks/[id_account]/[webhook_key]/[webhook_auth]/[webhook_name]?additional_parameters

Where:

  • id_account – ID of your account on the Webankieta platform.

  • webhook_key and webhook_auth – Webhook key and authorization. Parameters are available after logging into the user account in the Account -> Settings -> Integrations tab. After generating the keys, you will receive their values.

  • webhook_name – in this case it is add-respondent

  • additional_parameters – additional parameters specifying the respondent. Additional parameters can be sent as GET parameters or as POST parameters. These are:

    email – recipient's e-mail address (invitation receiver)
    l1, l2, …., l10 – additional attributes of the contact field. Attributes must be previously defined for the survey to which the invitation is sent. All parameters are optional.

  • id_survey – ID of the survey to which the respondent will be added. (It is the Survey ID from the PROJECTS tab). Mandatory parameter

An example URL format with additional parameters sent as GET is:

https://app.customerhero.com/webhooks/387487/TUwNjNDg3M/84b750d6956f02503015938fc38bfe36/add-respondent?id_survey=399793&email=j.kowalski@webankieta.pl&l1=Jan&l2=Kowalski&l3=CEO&l4=VIP&l5=601602603

The above Webhook will add the respondent with the address j.kowalski@webankieta.pl to the survey with ID = 399793. The respondent will also be described with the attribute values: Jan, Kowalski, CEO, VIP, 601602603.

In this example, the attributes created in the survey are: First name, Last name, Position, Segment, phone number.

{
"type":"success",
"msg":"Respondent has been saved on the survey's mailing list",
"data":
{"id_respondent":52909566,"token":"96BD97"}
}