Technician checked out
Every time your company's work order is completed via CorrigoPro Desktop/Mobile, your WebHook receives notification containing detailed information provided to a customer during the Complete operation.
Fields
Field | Value Type | Verification | Description |
---|---|---|---|
Header | MessageHeader | Mandatory | Complex object that contains important information about the request. |
Comment | string | Mandatory, Maximum length: 3000 | An actor’s comment justifying the action. |
Location | GeoLocation | Mandatory | Coordinates of a technician during work order completion. |
Procedures | Procedure[] | Optional | Contains information about Procedures. |
CheckList | CheckListItem[] | * Optional | Contains information about a CheckList. |
RepairInfo | RepairInfo | ** Optional | Contains repair code and repair category information provided during work order completion. |
CustomFields | CustomField[] | ** Optional | Contains values of custom fields provided during work order completion. |
* Mandatory if available in a work order. All items should be in state other than Uncompleted. (Note: See Warning below)
** Mandatory - depends on the customer settings. Custom field values are case-sensitive.
Important
Checklists are becoming Procedures for most Enterprise clients on March 22, 2018, and we discourage their usage.
Example
{
"Comment": null,
"Location": {
"Latitude": 36.281445,
"Longitude": -75.794662
},
"CheckList": null,
"RepairInfo": {
"CodeId": 2,
"Code": "Checked operation - unit OK",
"CategoryId": 1,
"Category": "Beverage Equipment"
},
"CustomFields": null,
"Header": {
"WorkOrderId": 42,
"BranchId": 500772,
"Sender": {
"Name": "Jon Snow",
"Phone": "+12025550141",
"Type": "CorrigoPro"
},
"Action": "CheckedOut",
"ActionDate": "2017-10-05T12:55:40.7456893Z",
"ApiVersion": "1.0",
"MessageId": "ffc0ba5e-649d-417c-939c-f7dd5b073508"
}
}
Updated over 5 years ago