Classic Form Builder Elements

The iForm Third Party URL Scheme is used to communicate between iForm and a custom iOS application. This article is designed to go over how to design your own custom 3rd Party Widget for use on the iOS Platform.

STEP 1. Calling your Application from iForm

In order to call your application from iForm your app must support URL Scheme. This is accomplished using iFormBuilder 3rd party widget. https://iformbuilder.zendesk.com/hc/en-us/articles/202917180

STEP 2. Place the following in your 3rd Party Widget Settings:

iOS URL Scheme:  iOS Application that support a custom URL Scheme can be called from the iForm Application. Learn about how to implement a URL scheme HERE.

Example URL Scheme: myURLScheme://

STEP 3. Passing data to a 3rd Party Application

Data is passed into the 3rd party application in the form of Name Value pairs.

Name/Value pairs:

Example Name Value Pair: myname=myvalue&myname1=myvalue1

*Another key value pair is passed (behind the scenes) that includes the element_id which is used to update the data in that specific field.

state={“element_id”:######}

In this example the final URL that is passed across looks like this:

myURLScheme://?myname=myvalue&myname1=myvalue1&state={“element_id”:######}

When tapping on the 3rd party widget it will pass the above string across into your application. In order to update the data in the field when calling back your application must capture the state Name/Value pair.

Your custom application performs its actions. Once the actions are completed in order to call back to the iForm form and store data for that element ID use the following:

STEP 4. Returning Data to the iForm Application.

iForm Third Party URL Scheme:  iform-third-party://?

Name/Value Pairs:

state={“element_id”:######}&results=yourDataString

The final URL that is being passed back to iForm looks like this:

iform-third-party://?state=%7B%22element_id%22:######%7D&results=yourDataString

**Please Note the above URL is URL Encoded when passed back into the application.

In the iFormBuilder 3rd Party Widget the following will be displayed in the widget:

yourDataString