- Basic Set Up
- Request/Response Configuration
- Link the Data Destination to Forms
- Testing and Troubleshooting
The HTTP PATCH/POST/PUT Data Destination can send any form submission data, including files, emails, photos to external services. It can also send raw data from the submitted forms or create objects in CRM systems. When correctly configured on both sides, it is possible to send any data from a submitted form anywhere in the publicly-accessible internet. The external service that receives the information from ProntoForms is developed and hosted by the customer.
Data destinations automatically send data collected in the field. They reduce the need to visit the web portal by making submitted forms available through the services you already use. The information from your submitted form can be routed to different places: the customer can receive a finished form, and the data from that form can be sent to back-office systems seamlessly. Read here for more information on data destinations.
- Create the data destination following the instructions here.
- Destination Basics: Name the destination. Optionally choose to auto-link forms and documents to this destination.
- Add Filtering: With a filter set up, form submissions will only be sent through the destination if the filter is met. Read more here.
- Connection: Set up an HTTP Connection or choose an existing connection.
- Set up the Request/Response Configuration tab as discussed below.
ProntoForms supports PATCH, POST, and PUT HTTP methods. Select which option to use based on the destination's settings.
PATCH: PATCH uses data from a submitted form to update or modify an object in an external system
POST: POST uses data from a submitted form to create an object in an external system.
PUT: PUT uses data from a submitted form to modify or update an existing object in an external system.
An object may be as simple as a line of data in a database.
Use the Request Header builder to choose which individual answers to send.
Key: The name of the POST parameter that the destination will use.
Send all answers
If using POST, selecting this option will automatically add all of the submission's answers to the POST request. This eliminates the need to reference questions individually in the "POST Parameters" section below.
Note: This, and any POST parameters, will be overridden by attaching a document to the data.
These parameters are only displayed when using the POST method. Use the parameter builder to choose which individual answers to send.
- Key: The name of the POST parameter that the destination will use.
- Value Expression: Use Data Record Expression Language to choose the data to send. Use the answer to a question by referencing question labels.
- Note: Answer values which are binary data (e.g. data from an image capture or signature) are base64 encoded.
When this option is selected, the information from answered questions will be sent in an old format, using the question label as a unique identifier for each answer. This format will send all data as a comma separated string instead of a list of HTTP POST parameters. This option is not recommended for forms containing:
- Attachment data
- Barcode data
- Multiselect questions
- Repeatable sections
Select which HTTP response codes indicate a successful call. Optionally, you can use a Regular Expression to analyze the HTTP response body to determine success vs. failure. The Regular Expression results in success if the pattern is found anywhere in the body.
In order for the destination to send any submitted form data, it must first be connected to the form. This is done in the Data Destinations tab of the form builder.
In many cases, a JSON or XML document is required by the web end point you will communicate with through the HTTP destination. ProntoForms has several features that enable sending our standard JSON or XML formats, or create your own custom formats through our DREL or Freemarker document template features. To make use of one of these document generation options with an HTTP destination, follow the instructions to Link a document to a data destination.
Data destinations should be configured and tested carefully before using them in production. This is key to ensuring that ProntoForms data is received correctly. Please consult the recommendations for testing and troubleshooting data destinations.