Work order received
Each time a new work order is sent to your company, a request will be made to your WebHook containing all the necessary information.
Fields
| Field | Value Type | Verification | Description |
|---|---|---|---|
| Header | MessageHeader | Mandatory | Complex object that contains important information about the request. |
| Details | WorkOrder | Mandatory | All information about a new work order from a customer. |
| Attachments | Attachment[] | Optional | Metadata of all attachments that are shared with a work order. |
Example: new work order notification
The following example shows a sample work order notification body:
{
"Details": {
"WorkOrderNumber": "WN73243",
"WorkOrderId": 42,
"Schedule": {
"ScheduledStart": "2018-03-27T19:19:58.4597178Z",
"Pte": "CallFirst"
},
"Type": "PMRM",
"AccompanyingMessage": "Here goes accompanying message, description of a Work Order in a plain text format.",
"Nte": {
"Amount": 300,
"Quote": null
},
"Sla": {
"DueDate": "2018-03-28T08:19:58.4597178Z",
"OnSiteBy": "2018-03-27T19:19:58.4597178Z",
"AcknowledgeBy": "2018-03-27T14:19:58.4597178Z",
"PriorityId": 2,
"PriorityName": "HIGH",
"IsEmergency": true
},
"WorkDetails": {
"CheckList": [
{
"SortingIndex": 1,
"Description": "Visual Inspections Task A001 PIPING-HOSE/MECH/VI-01 General",
"Id": 6,
"Comment": null,
"Exception": null,
"IsDone": false
},
{
"SortingIndex": 2,
"Description": "Visual Inspections Task A002 PIPING-HOSE/MECH/VI-01 Hoses/Nozzels/Pipe",
"Id": 7,
"Comment": null,
"Exception": null,
"IsDone": false
}
],
"Procedures": null,
"Assets": [
{
"Id": 46182,
"Path": "BUILDING EXTERIOR>BACK LOT",
"Task": "Graffiti",
"AssetName": "Dumpster Area",
"Comment": "Some optional description."
},
{
"Id": 45822,
"Path": "EQUIPMENT>COOKING",
"Task": "Cleaning problem",
"AssetName": "Combi Oven",
"Comment": null
}
]
},
"Contact": {
"FullName": "Jon Snow",
"ContactAt": "Please, email me at: [email protected], or call: 2025550141",
"Phones": [
"+12025550141"
],
"Emails": [
"[email protected]"
]
},
"ServiceLocation": {
"OccupantID": 327,
"Address": {
"City": "San Mateo",
"Country": "United States",
"State": "CA",
"Street1": "S. Norfolk St. Suite 100",
"Street2": null,
"PostalCode": "1900"
},
"Geo": {
"Latitude": 33.803559,
"Longitude": -117.930203
},
"OccupantName": "5340 - 12909 HARBOR BOULEVARD",
"SpaceName": "Restaurant",
"SpaceId": 28111
},
"Customer": {
"Id": 234,
"Name": "ABC Inc"
},
"IsPreBilled": false,
"IsWarranty": false,
"Created": "2018-03-26T22:19:58.4440932Z",
"LastUpdate": "2018-03-26T22:19:58.4440932Z",
"Feedback": null,
"Status": "New",
"Currency": "USD",
"TimeZone": "Standard Time Zone",
"WorkZoneNumber": "5340"
},
"Attachments": [
{
"Id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"Sender": {
"Name": "Samwell Tarly",
"Phone": "+12025550148",
"Type": "CorrigoPro"
},
"Name": "test.doc",
"MimeType": "application/msword",
"Size": 234256756,
"SentAt": "2018-03-27T22:19:58.4440932Z"
},
{
"Id": "ba68655d-9e2a-498a-a8c4-7d6f821ded25",
"Sender": {
"Name": "Petyr Baelish",
"Phone": "+12025550149",
"Type": "CorrigoProDirect"
},
"Name": "test.png",
"MimeType": "image/png",
"Size": 754368,
"SentAt": "2018-03-26T22:19:58.4440932Z"
}
],
"Header": {
"WorkOrderId": 42,
"BranchId": 101138,
"Sender": {
"Name": "Tyrion Lannister",
"Phone": "+12025556632",
"Type": "Customer"
},
"Action": "NewWorkOrder",
"ActionDate": "2018-03-27T22:19:58.4284698Z",
"ApiVersion": "1.1",
"MessageId": "7243c996-6f42-42da-aee4-b92febbbec98"
}
}
Deprecation Warning
Check lists are becoming Procedures for most Enterprise clients on March 22, 2018, and we discourage their usage.
Currently, in order to maintain compatibility with existing implementations, the Notification Emulator does send both check list and procedure data as shown in the example notification above.
Updated over 5 years ago
What’s Next