HTTP POST/PUT Data Destination

 

About

The HTTP 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.

[ top ]

 

admin.pngnouser.pngnomobile.png

Basic Set Up

 2016-01-13-POSTPUTDest.png

  1. Create the data destination following the instructions here.
  2. Destination Basics: Name the destination.  Optionally choose to auto-link forms and documents to this destination.
  3. Add Filtering:  With a filter set up, form submissions will only be sent through the destination if the filter is met.  Read more here.
  4. Connection: Set up an HTTP Connection or choose an existing connection.
  5. Set up the Request/Response Configuration tab as discussed below.

[ top ] 

 

Request/Response Configuration

HTTP Method

ProntoForms supports both POST and PUT HTTP methods. Select which option to use based on the destination's settings.

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 create or update an existing object in an external system.

An object may be as simple as a line of data in a database.

2016-01-13-POSTPUTbuttons.png

 

Request Headers

These headers are displayed in both PUT and POST methods. Use the Request Header builder to choose which individual answers to send.

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.

POST Parameters

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.

POSTparameters.png

[ top ]

Legacy Format

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

2016-03-09-HTTPPOSTLegacy.png

 

HTTP Call Success Analysis

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.

[ top ]

 

Link the Data Destination to Forms

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.

[ top ]

 

Testing and Troubleshooting Data Destinations

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.

[ top ]

Was this article helpful?
1 out of 1 found this helpful
Have more questions? Submit a request

Comments

  • Avatar
    Andrew Pike

    Is URL-encoding how data is being handled with this HTTP POST method?  If not, what method is being used?

    If URL-encoding is how we're handling the data, is it a safe assumption that it's also using the mutipart/form-data content type as well since we could be dealing with signature images, etc?

    Is there any sample parameter information that could be included for format reference?

  • Avatar
    Sinan Serifov

    HTTP POST uses standard POST formatting, not multipart.

    To send images/signatures, HTTP File Upload is recommended. This sends the entire record in our standard Data Record Document format. Images/signatures/etc are encoded in Base64 in this case. HTTP File Upload performs a standard HTTP request, with the method set to PUT.