API Reference

Form was Added to Order

The Form Was Added To Task callback occurs when a form is completed and added to an order This callback returns detailed information describing the form and the information entered in the form.

📘

Register Your URL for this Webhook

To start receiving webhooks from Bringg, you must first register a URL. Detailed guidance on setting up and managing Bringg webhooks is available in the following resources:


Response

{
	"id": 9947827,
	"note": {
		"Comment_Key": "Your service is great!",
		"Satisfaction_Key": 5,
		"Time_of_Day_Key": "\"Morning\"",
		"Unable_Key": true,
		"Type_Key": "\"Do not ring bell (baby sleeping)\""
	},
	"way_point_id": 11117309,
	"type": "Form",
	"user_id": 77484,
	"task_id": 8922180,
	"url": null,
	"lat": 32.0940501,
	"lng": 34.8283315
}

{
   "task_note": {
      "id": 2957,
      "note": {
         "key1": "value",
         "key2": "value",
         "key3": "value"
      },
      "user_id": null,
      "task_id": 3257,
      "created_at": "2020-12-14T08:32:12.718Z",
      "updated_at": "2020-12-14T08:32:12.718Z",
      "type": "Form",
      "url": null,
      "way_point_id": null,
      "customer_id": null,
      "pending_upload": false,
      "lat": null,
      "lng": null,
      "form_group_uuid": null,
      "action_id": null,
      "task_inventory_id": null,
      "flow_uuid": null,
      "happened_at": null,
      "form_field_key": null,
      "external_id": "2957",
      "share_with_customer": false,
      "task": {
         "id": 3257,
         "title": "058-017799",
         "fleet": {
            "id": 28,
            "name": "Paack"
         }
      }
   },
   "webhook_type": "form_created",
   "merchant_id": 178
}

Output Params

id

Int32

The unique Id of this form.

lat

double

The geoposition latitude of the user (driver) completing this form.

lng

double

The geoposition longitude of the user (driver) completing this form.

note

JSON

A JSON containing the information entered in this form. The information varies according to the fields defined in the form. For example:

  • the param Comment_Key and its value Your service is great!
  • the param Satisfaction_Key and its value 5
  • the param Time_of_Day_Key and its value Morning
  • the param Unable_Key and its value true
  • the param Type_Key and its value Do not ring bell (baby sleeping)

task_id

Int32

The Id of the order to which this form belongs.

type

string

The type of note is "form".

url

text

The URL added in this form.

user_id

Int32

The Id of the user creating this form.

way_point_id

Int32

The Id of the way point to which this form was added.