Delivering Form Submissions to a Custom Endpoint (Direct POST)

  • Updated
  • ~ minute read

Overview

The Direct POST method in FastField allows you to directly deliver submitted forms to a private endpoint of your choice.  Using this method, you can configure your account to send both images and form JSON to your own third-party services, bypassing our cloud services/storage vault.
 
Note: If you enable the Direct POST delivery methods, services such as Global Workflow and custom reporting cannot be leveraged within the FastField environment since no form data is stored on or routed through our servers. This will affect all submissions on your account and you will NOT be able to set this up for specific forms.
 

How to Set Up Direct POST

To set up a Direct POST configuration:
  1. Go to Account > Company Settings > Data Delivery in the Portal.
  2. Under Destination, select HttpPost from the drop-down list.
  3. Follow the prompts and provide the endpoint URL for the form data and/or the media. 
If you do not choose to provide a service endpoint for media delivery, collected media files will be stored on FastField in an Amazon S3 encrypted bucket.  However, when you specify a media URL in your settings, all media files associated with the form submissions will be posted to your service as a multi-part POST, and you will receive one call per media file.
 

Form Data Body

The body of the post includes the raw JSON document posted from the FastField application.
The JSON structure contains the field keys and their respective values extracted from the form. Media assets sent to your Amazon S3 storage bucket or your endpoint can be tied back to the form submission using the GUID-based file names in the JSON data.
 

Screenshot_2023-03-24_at_9.43.38_AM.png

If you do not choose to provide a service endpoint for media delivery, collected media files will be stored on FastField in an Amazon S3 encrypted bucket.  However, when you specify a media URL in your settings, all media files associated with the form submissions will be posted to your service as a multi-part POST, and you will receive one call per media file.

 

Form Data Body

The body of the post includes the raw JSON document posted from the FastField application.

The JSON structure contains the field keys and their respective values extracted from the form. Media assets sent to your Amazon S3 storage bucket or your endpoint can be tied back to the form submission using the GUID based file names in the JSON data.

 

Sample Form Submission JSON

 {
 "rep_tried_the_listed_phone": true,
 "unit_photo": "73e0d68e-a648-43e9-9299-518cb81e8359.jpg",
 "unable_to_locate": true,
 "collateral_located": true,
 "field_rep_asked_neighbor": true,
 "license_plate": "df48dfc1-f7a5-4c02-bfb5-eb87df4d1e2f.jpg",
 "audio_cond_notes": "1f49d2f0-7d21-44b4-a686-3dd26144eddf.caf",
 "client_updated_phone_numbers": [
 {
 "cell_n": 64455555
 },
 {
 "work_n": 64542333
 }
 ],
 "lic_numb_verified": true,
 "apartment_phone": "",
 "contact_made": [
 "No Direct Contact"
 ],
 "address_is_gated_or_secured?": true,
 "comments": "",
 "field_rep_asked_best_time_to_call": true,
 "formId": 1073,
 "field_rep_initiated_call_to_client": true,
 "mileage_val": 7374,
 "damage_on_vehicle": "0acbda09-2321-482c-b3fb-a4934bfdd05c.png",
 "asked_for_condition": true,
 "asked_whereabouts": true,
 "chase_date": "2013-12-18",
 "submissionId": "0c93f7dd-0ac0-4d71-8517-84d86d80e914",
 "co-operative": true,
 "mileage_verified": true,
 "addressed_standard_and_specifc_request": true,
 "field_rep_contact_results": [
 "Refused"
 ],
 "customer_filed?": true,
 "rep_advise_customer": true,
 "userId": 15,
 "utilities_appear_to_be_on": true,
 "hear_phone_ring_inside_the_home?": true,
 "reason_for_delinquency": [
 "Refused"
 ],
 "3rd_p_contact_was_made_at": [
 "Neighboring Address"
 ],
 "adviced_cust": true,
 "sign_here": "94e06dd1-22c6-4427-9abd-42dc04efa1e1.jpg",
 "filing_type": [
 "Chapter 13"
 ],
 "home_appear_to_look_occupied": true,
 "address_is": [
 "CONDO"
 ],
 "vehicles_spotted": true,
 "rep_updated_all_contact_info": true,
 "gen_cond": [
 "Poor"
 ],
 "listing_agent": [
 {
 "list_agent_phone_number": "",
 "cell_number": 8383,
 "zip": 8383
 }
 ],
 "exact_address_requested": true,
 "front_view_of_home": "2985a081-cac3-4edf-b60c-59fbef0d5c26.png",
 "property_for_sale": true,
 "formVersion": 13,
 "formName": "Field Call Checklist",
 "accountId": 1,
 "updatedAt": "2013-12-18T22:54:34.335Z",
 "userName": "user"
}

 

Response:

An HTTP response code of 200 will indicate that the form data was received successfully by the service. Any other return codes will result in an error being displayed in the application. The form will remain in the sync folder until the user initiates a re-sync.

Subform Value Example:

"subform_1": [
{
    "name": "john",
    "phone": "555-555-5555"
},
{
    "name": "jim",
    "phone": "555-555-5555"
}]

List Selector Value Example:

"interests" : [ 
    "Arts & Entertainment", 
    "Autos & Vehicles", 
    "Books & Literature"
]

Location Selector Example:

"location_of_review" : {
    "horizontal_accuracy" : 0,
    "vertical_accuracy" : 0,
    "longitude" : 0,
    "latitude" : 0
}

Securing Your Custom Endpoint for Direct POST

For Direct POST integrations (FastField app to client-hosted service), the FastField mobile apps can authenticate against your custom endpoint via Basic Authentication using username and password credentials that are configured in your account settings.  You can optionally provide a customer API token for extra security. 

 

Support

For help setting up your account to post data to a custom endpoint, please contact us at fastfieldsupport@mergemobile.com.

Related articles