It is possible to send an invitation to complete a survey to a specified e-mail address, to which we have previously sent an invitation. This is possible by calling a so-called Webhook. A Webhook is nothing more than 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]/send-invitation-to-token?additional_parameters

Additional parameters are:

  • token – token of the respondent to whom we want to send the invitation.

  • id_survey – ID of the survey to which the invitation is sent (It is the Survey ID from the PROJECTS tab). Mandatory parameter

  • id_template – ID of the sent invitation template (to find out how to retrieve the ID_template click HERE). Mandatory parameter

  • delay – delay in sending the invitation in minutes. Optional parameter.

  • footer – possibility to disable the footer with sender information. By default, the footer is enabled

  • reminder - number of hours after sending when a reminder should be sent to respondents who have not completed the survey. When the parameter is not set, the reminder will not be sent.


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

https://app.customerhero.com/webhooks/171257/MjU3ABUyMj/3a12307689817111c82711d910f5f4aa/send-invitation-to-token?id_survey=419349&id_template=3593&token=81a2B7


Important! 
In case the limits for sending invitations on the account are exhausted, the webhook will return an error

{„type”:”error”,”msg”:”Invitations limit has been reached”}

If the access code (token) was previously removed from the survey or is incorrect, the webhook will return an error („token not found”)


Remember!

To get the value of the parameter: id_template, go to the instructions at this link: https://pomoc.webankieta.pl/en/support/solutions/articles/206000085774