API Reference

Note was Added to Order

This callback is triggered when a note (Text, Photo, Signature, Form) is added to an order This callback returns detailed information describing the note.

📘

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:

🚧

URL Lifespan

URLs provided in Bringg webhooks, such as the link to an uploaded photo, are valid for 6 days, after which time the link expires.

Therefore, it is important to extract the asset from the link as possible.

If the link has expired, send the Get Order API call which will return a fresh link for the relevant URL in the response.

For Personal Information (PI) data concerns, all proof of delivery (POD) assets are deleted after 45 days. See our Help page on PI.


Response

{
   "id": 9492388,
   "note": "Ask foreman about 5 additional cases for return.",
   "user_id": 30218,
   "task_id": 18651509,
   "created_at": "2020-11-26T13:24:17.741Z",
   "updated_at": "2020-11-26T13:24:17.741Z",
   "type": "TaskNote",
   "url": null,
   "way_point_id": 22503324,
   "customer_id": null,
   "lat": null,
   "lng": null,
   "task_inventory_id": null,
   "happened_at": null,
   "form_field_key": null,
   "external_id": "32286477",
   "webhook_type": "note_created",
   "merchant_id": 178
}

{
   "task_inventory_id": "null",
   "note": "null",
   "lng": "-75.7152377675204",
   "way_point_id": "177716809",
   "form_field_key": "5",
   "happened_at": "null",
   "created_at": "2020-11-25T13:23:58.559Z",
   "task_id": "129600882",
   "external_id": "145169974",
   "merchant_id": "12013",
   "type": "Signature",
   "url": "https://task-images-prod-us1.s3.amazonaws.com/uploads/signature/url/145169974/3ceff698-45fe-4ccf-98de-9a7390922a15.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJ2QRASBTU2XQXVVA%2F20201125%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20201125T132358Z&X-Amz-Expires=518400&X-Amz-Signature=eb492568824864cecfe8ac4cc498b5c6625fa8c6a31e6db44d873544f3cc3bd8&X-Amz-SignedHeaders=host",
   "updated_at": "2020-11-25T13:23:58.559Z",
   "webhook_type": "note_created",
   "form_group_uuid": "38a92140-4c27-40c4-a1bc-d1d250fa63fe",
   "flow_uuid": "null",
   "user_id": "1484868",
   "action_id": "1",
   "id": "145169974",
   "customer_id": "null",
   "lat": "41.4891541891287"
}

{
   "task_inventory_id": "null",
   "note": "{\"Merchandise Received in Good Condition Except Where Noted Otherwise Above\":true,\"No Home Damage Occurred During Delivery\":true}",
   "lng": "-75.7152377675204",
   "way_point_id": "177716809",
   "form_field_key": "null",
   "happened_at": "null",
   "created_at": "2020-11-25T13:24:00.944Z",
   "task_id": "129600882",
   "external_id": "145169978",
   "merchant_id": "12013",
   "type": "Form",
   "url": "null",
   "updated_at": "2020-11-25T13:24:00.944Z",
   "webhook_type": "note_created",
   "form_group_uuid": "38a92140-4c27-40c4-a1bc-d1d250fa63fe",
   "flow_uuid": "null",
   "user_id": "1484868",
   "action_id": "1",
   "id": "145169978",
   "customer_id": "null",
   "lat": "41.4891541891287"
}

{
   "note": "null",
   "task_inventory_id": "null",
   "lng": "-74.2141617139629",
   "way_point_id": "178973372",
   "form_field_key": "null",
   "happened_at": "null",
   "created_at": "2020-11-25T19:42:17.598Z",
   "task_id": "130505668",
   "external_id": "145427646",
   "merchant_id": "12013",
   "type": "TaskPhoto",
   "url": "https://task-images-prod-us1.s3.amazonaws.com/uploads/task_photo/url/145427646/3718aed4-bd96-4264-bc7b-36a91e5619ae.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJ2QRASBTU2XQXVVA%2F20201125%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20201125T194217Z&X-Amz-Expires=518400&X-Amz-Signature=791cc2fba89ff9e4d123fd0ca71901471dc0ab33ea831be0f444530ad0ad98a8&X-Amz-SignedHeaders=host",
   "webhook_type": "note_created",
   "updated_at": "2020-11-25T19:42:17.598Z",
   "form_group_uuid": "null",
   "user_id": "1468997",
   "action_id": "null",
   "flow_uuid": "null",
   "id": "145427646",
   "customer_id": "null",
   "lat": "40.7786311258378"
}

Output Params

id

Int32

The unique Id of this note.

lat

double

The geoposition latitude of the user creating this note.

lng

double

The geoposition longitude of the user creating this note.

note

text

The text of this note.

task_id

Int32

The Id of the order to which this note belongs.

type

string

The options are: TaskNote (text), Form, Signature, TaskPhoto, HtmlTaskNote

url

text

The URL to the Signature or Photo, or the URL provided in HtmlTaskNote type of notes.

user_id

Int32

The Id of the user creating this note.

way_point_id

Int32

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