Form submitted
Configure a webhook to be informed when a new form is uploaded from a device or from the browser into the platform. The webhook will POST all information regarding the form to the endpoint you configure in the platform. POST values
Note: there may be a lot more data fields in the Webhook; depending on the data collected by the app and options you may have enabled (or not). Here follow some of the most relevant fields. Should you miss something, please check the actual POST from the webhook, or contact us.
All response values are provided as string values and are appropriately escaped.
id
Unique reference for each submitted form
scan_code
Scanned reference (e.g. the file barcode)
device_nick / nick
Given name of the device (app), used to fill in the form.
submit_date_time
Date/timestamp of the form being saved
Form.title
The given title of the form
Form.fields is an array (depending on the form length), with the following important key values:
Form.fields[].name
The given name (question) of the form field
Form.fields[].value
The given output of the form field
The full schema of the response is:
{
"type": "object",
"properties": {
"tenant_id": {
"type": "integer"
},
"form_id": {
"type": "integer"
},
"device_id": {
"type": "integer"
},
"file_id": {
"type": "integer"
},
"submit_date_time": {
"type": "string"
},
"nick": {
"type": "string"
},
"location_id": {
"type": "integer"
},
"scan_code": {
"type": "string"
},
"shared": {
"type": "boolean"
},
"latitude": {
"type": "string"
},
"longitude": {
"type": "string"
},
"gps_timestamp": {
"type": "string"
},
"workflow_id": {
"type": "integer"
},
"workflow_description": {
"type": "string"
},
"workflow_step_id": {
"type": "integer"
},
"workflow_step_description": {
"type": "string"
},
"geocoding": {
"type": "object",
"properties": {
"summary": {
"type": "object",
"properties": {
"queryTime": {
"type": "integer"
},
"numResults": {
"type": "integer"
}
}
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "object",
"properties": {
"buildingNumber": {
"type": "string"
},
"streetNumber": {
"type": "string"
},
"routeNumbers": {
"type": "array"
},
"street": {
"type": "string"
},
"streetName": {
"type": "string"
},
"streetNameAndNumber": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"countrySubdivision": {
"type": "string"
},
"municipality": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"country": {
"type": "string"
},
"countryCodeISO3": {
"type": "string"
},
"freeformAddress": {
"type": "string"
},
"boundingBox": {
"type": "object",
"properties": {
"northEast": {
"type": "string"
},
"southWest": {
"type": "string"
},
"entity": {
"type": "string"
}
}
},
"extendedPostalCode": {
"type": "string"
},
"localName": {
"type": "string"
}
}
},
"position": {
"type": "string"
}
},
"required": [
"address",
"position"
]
}
}
}
},
"updated_at": {
"type": "string"
},
"created_at": {
"type": "string"
},
"id": {
"type": "integer"
},
"upload_type": {
"type": "string"
},
"scan_date_time": {
"type": "string"
},
"form": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"title": {
"type": "string"
},
"tenant_id": {
"type": "integer"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"deleted_at": {},
"default_shared": {
"type": "boolean"
},
"location_id": {
"type": "integer"
},
"display_empty_values": {
"type": "boolean"
},
"order": {
"type": "integer"
},
"language": {},
"location_filter": {},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"form_id": {
"type": "integer"
},
"value": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"field_name": {
"type": "string"
},
"type": {
"type": "string"
},
"label": {
"type": "string"
},
"id": {
"type": "integer"
}
},
"required": [
"form_id",
"value",
"created_at",
"updated_at",
"field_name",
"type",
"label",
"id"
]
}
}
}
}
}
}
Example response:
{
"id": 228900,
"form_id": 1573,
"device_id": 2927,
"file_id": 903926,
"submit_date_time": "2020-09-18T07:58:17+00:00",
"created_at": "2020-09-18T07:58:17+00:00",
"updated_at": "2020-09-18T08:01:53+00:00",
"deleted_at": null,
"location_id": 9,
"scan_code": "9780984380213",
"nick": "DK",
"user_id": null,
"shared": true,
"latitude": "51.9923665",
"longitude": "4.5037559",
"gps_timestamp": "1600415844057",
"workflow_id": 1771,
"workflow_step_id": 10758,
"workflow_description": "Damage Inspection",
"workflow_step_description": "Fill in damage form",
"upload_type": "form",
"scan_date_time": "2020-09-18T07:58:17.827000Z",
"form": {
"id": 1573,
"title": "Damage inspection of pallets",
"tenant_id": 1,
"created_at": "2020-07-22T08:31:59+00:00",
"updated_at": "2020-07-22T08:31:59+00:00",
"deleted_at": null,
"default_shared": true,
"location_id": 1,
"display_empty_values": true,
"order": null,
"language": null,
"location_filter": null,
"fields": [
{
"form_id": 1573,
"value": "black",
"created_at": "2020-09-18T07:58:18+00:00",
"updated_at": "2020-09-18T08:00:14+00:00",
"field_name": "",
"type": "single_select",
"label": "color of the pallet",
"id": 17072
},
{
"form_id": 1573,
"value": "Right",
"created_at": "2020-09-18T07:58:18+00:00",
"updated_at": "2020-09-18T07:58:18+00:00",
"field_name": "",
"type": "single_select",
"label": "Damage area",
"id": 15974
},
{
"form_id": 1573,
"value": "Top",
"created_at": "2020-09-18T07:58:18+00:00",
"updated_at": "2020-09-18T07:58:18+00:00",
"field_name": "",
"type": "single_select",
"label": "Pallet damage area",
"id": 15975
}
{
"form_id": 1573,
"value": "https:\\/\\/cargosnapstorage.blob.core.windows.net\\/tenant1\\/drawings\\/20200918\\/84YL1eXGhlJUExWG8t38sD\\/drawing.svg",
"created_at": "2020-09-18T07:58:18+00:00",
"updated_at": "2020-09-18T07:58:18+00:00",
"field_name": "",
"type": "drawing",
"label": "sign",
"id": 16129
}
]
}
}