It is possible to update the respondent's data in the recipient database for the purpose of repeated mailing. A webhook is a URL requested using another IT system or opened in an ordinary browser.

The form of the URL is as follows:

https://www.startquestion.com/webhooks/[id_account]/[webhook_key]/[webhook_auth]/[webhook_name]?additional_parameters

Where:

  • id_account – ID of your account on the Startquestion platform. To find it out, please contact us

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

  • webhook_name – here: update-respondent

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

- id_respondent – ID of the respondent who is an addressee from the mailing list

- l1, l2, …., l10 – additional labels in the contact field. All parameters are optional.

- id_survey – ID of the survey to which a respondent will be added (contact us to obtain the parameter values). Mandatory parameter.

Sample format of the URL with additional parameters sent as GET:

https://www.startquestion.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 respondent ID 12345 in survey ID = 399793. The respondent will obtain new values of labels: l4 = SuperVIP and l7 = 9 (sample value of the NPS question).

Sample response from the server:

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

Note!

  • To obtain the values of parameters: id_account, id_survey, contact us at: contact@startquestion.com

  • To obtain the values of parameter id_respodnent, you can use the [ID_RESPONDENT] macro

Did this answer your question?