SharinPix Forms - Context Parameters
Overview
Context Parameters allow you to pass custom values to a SharinPix Form when it is launched. These parameters become available throughout the form and can be used in formulas to control behavior, customize content, and adapt the form to different use cases.
This documentation covers:
Prerequisites:
- A SharinPix Form Template should already be created. Refer to the SharinPix Form Template Editor documentation.
- Basic understanding of SharinPix Form Formulas.
What are Context Parameters
Context parameters are key-value pairs passed to the form via the URL when launching it. Once passed, these values become available throughout the form and can be accessed using the form.params object.
Example: If you launch a form with &context=inspection in the URL, you can access this value anywhere in the form using form.params.context. This returns "inspection".
Passing Context Parameters
Context parameters are passed as URL query parameters when launching the form.
URL Format
Universal Link:
https://app.sharinpix.com/native_app/form?token=<your_form_token>&<param_name>=<value>Deeplink:
sharinpix://form?token=<your_form_token>&<param_name>=<value>Using Context Parameters in Formulas
Below are usage examples of Context Parameters in Formulas for a dynamic SharinPix Form.
Conditional Visibility
Show different form sections based on the context
Visibility Formula:
form.params.context = "inspection"This makes the element visible only when context=inspection is passed in the URL.
Example URL:
https://app.sharinpix.com/native_app/form?token=<your_form_token>&context=inspectionThe form launches with the inspection section. The section was not visible on the editor since the Context Parameter was not present there.
Use Case
Create a single form template that adapts to different scenarios:
- context=inspection → Shows inspector-related fields
- context=customer → Shows customer-related fields
Dynamic Default Values
Pre-populate fields with values from the URL:
form.params.stageWhen launched with &stage=Initial, the field defaults to "Initial".
Example URL:
https://app.sharinpix.com/native_app/form?token=<your_form_token>&stage=InitialThe image below shows the form launched with the Context Parameter stage=Initial.
0 Comments
Add your comment