Incoming Webhooks

About Incoming Webhooks

In general terms, a webhook is how applications communicate with each other automatically. In other words, a message is sent over the web, which is triggered automatically whenever a specific event occurs. The incoming webhook automation is triggered when new respondent data comes in which prompts a survey email invitation to the respondent. 

Webhooks are intended for users who know how to handle them. Please note that we cannot troubleshoot your code or give step-by-step development instructions.

Create an Incoming Webhook Automation

To setup an incoming webhook automation, you have to:

  1. Go to the automations area () and click on Enalyzer in the side menu.
  2. In the side menu, click on Enalyzer.
  3. Click on create automation. If you already have one or more automations click on the add automation icon () to add an automation.
  4. Select the webhooks option and click on incoming webhook.
  5. Select the survey you want to send out.
  6. Under incoming data, specify the data fields you want to include in your webhook by excluding or including the necessary fields.

    To match the data to a survey variable, make sure you create the background variable before setting up the automation.

  7. You can add filter(s) to condition the automation, i.e. you can define filters that the incoming data needs to meet in order to run.
  8. Use the API key to set up your connection and once you've done that, test your connection. Once your connection is successful, click next
  9. Now you need to map the data fields to the survey variables.

    If there is a field that you don't want to upload or import, you can skip it.

  10. When you're done mapping, click next.
  11. Now you can set up the automation settings:
    • Name: Name your automation.
    • Message: Select the message that will be sent by the automation. Learn more about messages.
    • Delay invitations: Enable the setting if you'd like to delay the invitations and select the number of days for the delay. 
  12. When you have finalized your question and customized the settings, click next.
  13. Set the automation status. By default it is enabled, however, you can disable it before you create it.
  14. When you're ready to create your automation, click done.

Receive Error Notifications

Incoming webhooks can fail for different reasons and cause your automation to be disabled. Whatever the reason is, you are able to enable email error notifications for your automation. You can define the person(s) that need to receive these notifications.

To enable error notifications, you have to:

  1. Go to the automations area (AutomationsIcon.png) and click on Enalyzer in the side menu.
  2. Click on the automation you want to enable error notifications for.
  3. Under error notifications, enable the email notifications setting.
  4. Click the add recipient and enter the email address that will receive the error notification emails. Repeat this step to add more recipients.
  5. Your changes will be saved immediately. 

Was this article helpful?

1 out of 2 found this helpful