Supported on all tiers:
Each action has additional parameters, as described in the following sections.
Info:Different identifiers apply at different stages in a workflow. When you build an App‑to‑App request, you must use valid combinations of identifier and location. The topic How to Use Form Identifiers in an App‑to‑App Request describes these combinations in more detail.
launch
parameters
reconcile
Description
Launches the ProntoForms app and triggers a reconcile to ensure that users have the most up-to-date forms.
Required
No
Default value
0 (false)
Expected values
0
or1
Example
Launch the ProntoForms app and trigger a reconcile.
prontoforms://x‑callback‑url/launch?reconcile=1
list
parameters
reconcile
Description
Displays the ProntoForms app and triggers a reconcile to ensure that users have the most up-to-date forms.
Required
No
Default value
0 (false)
Expected values
0
or1
Example
Display the Forms (default) view of the ProntoForms app and trigger a reconcile.
prontoforms://x‑callback‑url/list?reconcile=1
type
Description
Displays a specific area of the ProntoForms app (Forms, Drafts, Inbox, or Sent).
Required
No
Default value
forms
Expected values
forms
drafts
inbox
Example
Display the Inbox view of the ProntoForms app and trigger a reconcile.
prontoforms://x‑callback‑url/list?reconcile=1&type=inbox
open
parameters
Open a form or a list of forms that match the specified parameters.
Tip:You can use multiple parameters to improve the precision of the results. For example, use the name
and type=Inbox
parameters to open a list of matching forms in the user’s Inbox.
name
Description
Open a form or list of forms based on the form name. This parameter matches partial strings.
Note:You must enter the form name using launch parameters.
Example
Open a list of forms that have the words “asset” and “list” in the name.
prontoforms://x‑callback‑url/open?name=asset%20list
tag
Description
Open a form or a list of forms based on one or more form tags. If more than one form matches the tags, the ProntoForms app displays a list of matching forms in the user’s Forms box.
Tip:Use the
type
parameter along withtag
to specify the user’s Forms or Inbox. Without thetype
parameter, the results default to Forms.Example
Open a list of forms that have the tag “install”.
prontoforms://x‑callback‑url/open?tag=install
Open a list of forms that have the tags “install” and “checklist”.
prontoforms://x‑callback‑url/open?tag=install&tag=checklist
type
Description
Use the
type
parameter to specify whether the form opens from the user’s Forms or Inbox.Default value
forms
Example
Open a list of forms that have the tag “install” in the user’s Inbox.
prontoforms://x‑callback‑url/open?tag=install&type=inbox
formID
Description
Open a form or list of forms based on the form ID. This is the unique identifier of an empty form.
Examples
Open a form with ID of “99999999”.
prontoforms://x-callback-url/open?formID=99999999
Open and prepopulate the form with the customer name and work order number. This is an example of a “dispatch” type request.
prontoforms://x-callback-url/open?formID=99999999&CustomerName=Best%20Pianos&WorkOrderID=1234
Note:ProntoForms ignores any question unique IDs that are not defined in the form.
formIterationID
Description
Open a form or list of forms based on the form iteration ID. This is the unique identifier of a specific version of a form.
Examples
Open an active form with the version (iteration) of “98765432”.
prontoforms://x-callback-url/open?formIterationID=98765432
Open and prepopulate the form with the customer name and work order number.
prontoforms://x-callback-url/open?formIterationID=formIterationID&CustomerName=Best%20Pianos&WorkOrderID=1234
dataRecordID
Description
Open a dispatched form based on its form submission ID (the “data record” ID assigned when the ProntoForms server sends a form or receives a submitted form). The form can only be in the Inbox. The form can be
a dispatched form
a completed form sent for editing, or
a reassigned incomplete ProntoForms Teamwork-enabled form.
Example
Open a dispatched form with a form submission ID of “123456789”.
prontoforms://x-callback-url/open?dataRecordID=123456789
clientDataRecordID
Description
Open a form that’s in a user’s Drafts.
This parameter is usually used for a previously opened form that the user saved in Drafts. Any previous App‑to‑App requests that have the x-success parameter included return the
clientDataRecordID
when the user saves the form to Drafts.Example
Open a saved form with a form clientDataRecordID of “A1A1A1A1-AAAA-1111-AAAAAA111111”.
prontoforms://x-callback-url/open?clientDataRecordID=A1A1A1A1-AAAA-1111-AAAAAA111111
open
action to prepopulate (dispatch) a form, make sure that the answers match the supported question and data types.For example:
To prepopulate a question that has an “Integer” data type, you must send an integer in your URL.
To prepopulate a dropdown question, you must send an answer that’s defined as an option for that question.
send
parameters
Note:The type
and at least one form identifier are required for the send
request.
type
Description
Specify the location of the form to send from the ProntoForms app to the ProntoForms server.
Required? Yes Default value None (you must provide a value)
Note:An unspecified or invalid value triggers the x‑error callback. If the x-error is triggered but isn’t included in the request, the end user receives an error message.
Expected values drafts
inbox
sent
Example
Send a form that a user started and saved to Drafts in the ProntoForms app.
prontoforms://x-callback-url/send?type=drafts&clientDataRecordID=A1A1A1A1-AAAA-1111-AAAAAA111111
formID
Description
Open, populate, and send a form from the ProntoForms app to the ProntoForms server based on the form ID. This is the unique identifier of a form.
Example
Open a form, populate an answer that triggers conditional logic to populate other answers, and send a form. This process requires no user interaction.
Note:On an iOS device, the user might have to select OK to confirm and send the form. To avoid this, in the ProntoForms mobile app settings, switch the Confirm Send option off.
prontoforms://x‑callback‑url/send?type=forms&formID=99999999&ServiceType=Warranty
formIterationID
Description
Open, populate, and send a form from the ProntoForms app to the ProntoForms server based on the form iteration ID. This is the unique identifier of a specific version of a form.
Example
Open, populate, and send a form with the version (iteration) of “98765432”.
Note:On an iOS device, the user might have to select OK to confirm and send the form. To avoid this, in the ProntoForms mobile app settings, switch the Confirm Send option off.
prontoforms://x‑callback‑url/send?type=forms&formIterationID=98765432&ServiceType=Warranty
dataRecordID
Description
Send a dispatched
, transferred, or completed form based on its form submission ID (the “data record” ID assigned when the ProntoForms server receives the submitted form).Note:The term transferred only applies to ProntoForms Teamwork-enabled forms.
Example
Open and send a form from the user’s Inbox with a dispatched form ID of “123456789”.
prontoforms://x‑callback‑url/send?type=inbox&dataRecordID=123456789
clientDataRecordID
Description
Send a form already opened by your source app and saved by the ProntoForms app user in their Drafts.
You can find the
clientDataRecordID
in any previous App‑to‑App requests that have the x‑success parameter included. An x-success callback returns theclientDataRecordID
when the user saves the form to Drafts.Example
Open and send a saved form with a clientDataRecordID of “A1A1A1A1-AAAA-1111-AAAAAA111111”.
prontoforms://x‑callback‑url/send?type=drafts&clientDataRecordID=A1A1A1A1-AAAA-1111-AAAAAA111111
search
parameters
Note:To use the search
action, the mobile device user must belong to a ProntoForms team that has Search enabled.
searchText
Description
Open a list of forms based on the form submission name. This parameter matches partial strings so that the user can select from a list of matching forms.
Note:You must enter the form submission name using App‑to‑App URL Encoding.
Example
Open a list of forms that have the words “asset” and “list” in the name.
prontoforms://x‑callback‑url/search?searchText=asset%20list
Tip:For ProntoForms Teamwork-enabled forms (Enterprise tier only), use the
search
action when you want a user to claim an incomplete form from the list.
Comments
0 comments
Please sign in to leave a comment.