The task_notes object is included in some webhook callbacks. For example, the Order Is Done callback object includes the task_notes object.
Order Notes Details
| Parameter | Description |
|---|---|
| action_id Int32 | Bringg's ID of the Driver App action that created this note, when the note was generated by a configured action such as a required photo, form or signature. |
| author_name string | Name of the user associated with the note. This is usually the name of the driver but can also be that of the dispatcher, admin or customer. |
| created_at datetime | The date and time this note was created. This is in UTC and is in the format "%Y-%m-%dT%H:%M:%S%z". |
| customer_id Int32 | The ID of the customer with which this note is associated. |
| external_id string | The external system ID for this note. The default value is the id value. |
| flow_uuid string | The unique ID of the Driver App flow in which this note was created. |
| form_field_key string | For notes of Form type, the key of the form field whose value this note holds. |
| form_group_uuid string | For notes of Form type, the unique ID of the form submission to which this note belongs. All notes created by the same form submission share this value. |
| happened_at datetime | The date and time when this note was added to the order (by API or via the Bringg Driver App). This is in UTC and is in the format "%Y-%m-%dT%H:%M:%S%z". |
| id Int32 | Bringg's unique ID for this note. |
| lat double | The geoposition latitude of the user (driver) when the task note was added. |
| lng double | The geoposition longitude of the user (driver) when the task note was added. |
| merchant_id Int32 | The ID of the merchant to which this note belongs. |
| note string | The text of the note. |
| pending_upload boolean | Indicates whether the note is pending upload (or was already uploaded). A note may be pending upload due to the size of the note or system latency. - false or 0 - the note is not pending upload - true or 1 - the note is pending upload |
| share_with_customer boolean | Indicates whether this note is shared with the end customer, for example on the tracking page. - false or 0 - the note is not shared with the customer - true or 1 - the note is shared with the customer |
| task_id Int32 | Bringg's ID for the order to which this note is attached. |
| task_inventory_id Int32 | Bringg's ID of the inventory item to which this note is attached, for notes added on a specific inventory item. |
| title string | This consists of the date-time the note was created along with the name of the user associated with the note. |
| type string | The type of task note. The values include: - TaskNote (text)- FormattedTaskNote- HtmlTaskNote- Form- Signature- TaskPhoto- Document- DeliveryReceipt |
| updated_at datetime | The date and time of the last update for this note. This is in UTC and is in the format "%Y-%m-%dT%H:%M:%S%z". |
| url text | For notes of "HtmlTaskNote" type, this is the website URL added to this note. For notes of "TaskPhoto" or "Signature" type, this is the link to the image file. URLs are valid for 6 days, after which time the link expires. Therefore, it is important to extract the asset from the link as soon as possible. If the link has expired, it is possible to 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 . |
| user_id Int32 | The Bringg ID of the user who is associated with the note. This is usually the driver but can also be the dispatcher, admin or customer. |
| way_point_id Int32 | The Bringg ID of the waypoint to which this note is attached. |

