All Collections
API Documentation
Webhook for sending an invitation to fill out a survey
Webhook for sending an invitation to fill out a survey
Artur Zbiejcik avatar
Written by Artur Zbiejcik
Updated over a week ago

It is possible to send an invitation to complete a survey to the indicated email address by requesting the so-called Webhook. A webhook is a URL requested using another IT system or opened in an ordinary browser.

The form of the URL is as follows:[id_account]/[webhook_key]/[webhook_auth]/[webhook_name]?additional_parameters


  • 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: send-invitation

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

Additional parameters:

  • email – email address of the addressee (invitation recipient)

  • l1, l2, …., l10 – additional labels of the contact field. Labels 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 invitation is sent (contact us for the parameter value). Mandatory parameter

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

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

  • footer – possibility of disabling the footer with information about the sender. By default, the footer is enabled

  • reminder_delay – number of hours from mailing after which a reminder is to be sent to respondents who did not fill out the survey. If the parameter is not set, the reminder will not be sent

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

The above webhook will send an invitation to the address If there are macros using the respondent's labels in the content of the invitation template (with id_template = 1833), they will appear in its content. The invitation will be sent 15 minutes after the webhook was made.


If the mailing takes place to the respondent who resigned from receiving invitations to the surveys, the webhook will return an error:

{„type”:”error”,”msg”:”Respondents not found”}

In the event that the account's limits for sending invitations are exhausted, the webhook will return an error:

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

The invitation will be sent according to the mail server settings in the user's account.


To obtain the values of parameters: id_account, id_survey, id_template, contact us at

Did this answer your question?