HTTP POST Connector
If you have access to technical personnel (software developers) and are looking to tightly integrate with our platform, then this Connector option is worth a look.
The HTTP POST Connector will send automatically form entry data in XML or JSON format to a web service address that you specify.
This allows you to integrate with us on an event level – i.e. whenever a new Form entry is received by us, you will receive a POST with the data.
Your web service must implement the API that we specify in order to understand the data we send.
Technical staff should see our Form Entries API documentation (found in the Integration section of our help site).
Adding the Connector
The Connectors page can be accessed from your Form design, settings or from the Screens listing if you mouse over the Form row in question.
Once you are in the Connectors page, setting up a HTTP POST Connector is easy:
1. Hover over the “Add Connector” button to see a list of the available Connectors.
Click the HTTP POST option.
2. This will refresh the page and display your Connector, ready for configuration.
Note that at this stage nothing has been saved – you must click the Save button to save your Connector after you’ve finished setting it up.
3. You need to specify the destination URL to which our platform will POST data.
You can either enter an address directly into the given field, or you can tick the “Use Hosted Forms POST URL” box.
The Host Forms POST URL option allows you to have a single global URL that can be reused for multiple Connectors.
This option is configured in the Organisation Setup page (My Account -> Organisation Setup -> Advanced section).
4. At this stage, your Connector is ready to go.
Hit the Save button to save your changes and activate the Connector.
Add a Run Condition
Sometimes you may have a Connector that you only want to fire in the event that the Form entry has a given answer value.
For example you may have an Audit Form, which has a risk rating question with options like “Low”, “Medium” and “High”.
If the user answers the risk rating as “High”, then you may want to send the form data to your system via an HTTP Post.
This is where a Run Condition comes in.
Run Conditions are defined by creating a true/false formula.
The Connector will only run if the formula you define in the Run Condition has a true result.
So in the example above, the Run Condition formula would be something like:
{{riskRating}} = ‘High’
When you hover over the Run Condition field, you will see a hammer icon appear.
Clicking the hammer will take you into the Formula Builder, which helps you to put together the formula you desire.
See the Creating a Formula page to learn more about form formulae.