Run Workflows from Survey123
You can configure Survey123 to send survey event data to server workflows using webhooks.
Server workflows require on-premises Workflow. Cloud Workflow cannot run server workflows.
To configure a Survey123 survey to run a workflow, you must create a workflow that can receive webhook requests. Next, you must add a webhook to the survey settings and configure it to point to the workflow.
This procedure assumes that you already have an account with Survey123.
To configure a workflow to receive webhook requests
If you do not have a workflow configured to receive webhook requests, you can use a workflow sample to get started.
Open Workflow Designer.
Click File | New.
Select the Receive Webhook Request sample.
Modify the workflow for your own environment and save your changes.
Your workflow can access the Survey123 event data via the workflow's inputs. For more information about inputs, see Workflow Inputs.
To configure a Survey123 survey to run a workflow:
Sign in to Survey123.
Edit the survey Settings.
From the menu on the left side of the window, select Webhooks.
Click Add webhook.
Set the Name of the Webhook to a name of your choice, for example:
Run workflow on submit.
In the Payload URL property, use the example below as an guide for your entry.
In the example,
<server>is the machine where VertiGIS Studio Workflow is installed, and
<workflow-id>is the id of the server workflow.
<query-string>is optional and can be used to provide any additional inputs to the server workflow.
Query string inputs must use the following format:
Content of the record is sent automatically, regardless of a query string being specified.
Set the type of Trigger event you wish to use.
You must select at least one type of event.
Select the types of Event data you wish to be sent to your server workflow.If your workflow is secured, you must:
- Enable Portal info
- Share your workflow with the end users of the Survey123 app
Set Status to On if you want the webhook to be active immediately. Set the Status to Off to set the webhook to be inactive.
Confirm your changes and click Save.