It is possible to update respondent data in the recipient database for the purpose of resending. 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 update-respondent

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

    • id_respondent – ID of the recipient respondent from the mailing list

    • l1, l2, …., l10 – additional attributes of the contact field. 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/update-respondent?id_survey=399793&id_respondent=12345&l4=SuperVIP&l7=9


The above Webhook will update the data of the respondent with ID 12345 in the survey with ID = 399793. The respondent will gain new attribute values: l4 = SuperVIP and l7 = 9 (example value of an NPS question).

Example server response:

{"type":"success","msg":"Respondent has been updated on the survey's mailing list"}


Remember!

  • To get the value of the id_respondent parameter, you can use the [ID_RESPONDENT] macro