Guides

Our Webhooks

Here is an overview of the webhooks we offer as well as detailed information on how they are structured

To receive updates on new versions or breaking changes you can subscribe to our Developer Newsletter.

JSON Schemas

This list contains all available webhook schemas. The ones marked as deprecated should be avoided or upgraded. To upgrade a webhook, refer to this guide on How to Upgrade Webhhoks without Downtime.

Order completed v2

Send when order is completed

📘

Here is the JSON schema

Click to expand
{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "type": "object",
 "title": "Order complete version 1",
 "properties": {
   "version": {
     "type": "integer",
     "enum": [2]
   },
   "fullVersion": {
     "type": "string",
     "enum": ["2.1"]
   },
   "realm": {
     "type": "string",
     "enum": ["order.complete"]
   },
   "data": {
     "type": "object",
     "properties": {
       "id": {
         "type": "integer"
       },
       "templateId": {
         "type": ["null", "integer"]
       },
       "name": {
         "type": "string"
       },
       "description": {
         "type": "string"
       },
       "comments": {
         "type": "string"
       },
       "priority": {
         "type": "integer"
       },
       "automaticCompletion": {
         "type": "boolean"
       },
       "state": {
         "type": "string",
         "enum": ["done"]
       },
       "startDate": {
         "type": "string"
       },
       "dueDate": {
         "type": ["string", "null"]
       },
       "assigneeId": {
         "type": ["null", "integer"]
       },
       "assigneeUserName": {
         "type": ["null", "string"]
       },
       "canBeTakenOver": {
         "type": "boolean"
       },
       "progressIds": {
         "type": "array",
         "items": {
           "type": "number"
         }
       },
       "completedProgressIds": {
         "type": "array",
         "items": {
           "type": "number"
         }
       },
       "event": {
         "oneOf": [
           { "type": "null" },
           {
             "type": "object",
             "properties": {
               "id": {
                 "type": "integer"
               },
               "name": {
                 "type": ["null", "string"]
               },
               "comments": {
                 "type": "string"
               },
               "startsAt": {
                 "type": "string"
               },
               "endsAt": {
                 "type": "string"
               },
               "createdAt": {
                 "type": "string"
               },
               "updatedAt": {
                 "type": "string"
               },
               "createdBy": {
                 "type": "integer"
               },
               "updatedBy": {
                 "type": "integer"
               },
               "createdByUserName": {
                 "type": "string"
               },
               "updatedByUserName": {
                 "type": "string"
               }
             },
             "required": [
               "id",
               "name",
               "comments",
               "startsAt",
               "endsAt",
               "createdAt",
               "updatedAt",
               "createdBy",
               "updatedBy",
               "createdByUserName",
               "updatedByUserName"
             ],
             "unevaluatedProperties": false
           }
         ]
       },
       "recurrence": {
         "oneOf": [
           { "type": "null" },
           {
             "type": "object",
             "properties": {
               "id": {
                 "type": "integer"
               },
               "name": {
                 "type": "string"
               },
               "comments": {
                 "type": "string"
               },
               "startsAt": {
                 "type": "string"
               },
               "endsAt": {
                 "type": "string"
               },
               "repeatsUntil": {
                 "type": "string"
               },
               "rrule": {
                 "type": "object",
                 "properties": {
                   "tzid": {
                     "type": "string"
                   },
                   "rdates": {
                     "type": "array",
                     "items": {
                       "type": "string"
                     }
                   },
                   "rrules": {
                     "type": "array",
                     "items": {
                       "type": "object",
                       "properties": {
                         "end": {
                           "type": "string"
                         },
                         "days": {
                           "type": "array",
                           "items": {
                             "type": "string"
                           }
                         },
                         "time": {
                           "type": "string"
                         },
                         "start": {
                           "type": "string"
                         },
                         "duration": {
                           "type": "string"
                         },
                         "interval": {
                           "type": "integer"
                         },
                         "byweekday": {
                           "type": "array",
                           "items": {
                             "type": "number"
                           }
                         },
                         "bysetpos": {
                           "type": "array",
                           "items": {
                             "type": "number"
                           }
                         },
                         "bymonthday": {
                           "type": "array",
                           "items": {
                             "type": "number"
                           }
                         },
                         "bymonth": {
                           "type": "array",
                           "items": {
                             "type": "number"
                           }
                         },
                         "freq": {
                           "type": "number"
                         }
                       },
                       "required": ["end", "time", "start", "duration", "interval"],
                       "unevaluatedProperties": false
                     }
                   },
                   "exdates": {
                     "type": "array",
                     "items": {
                       "type": "string"
                     }
                   },
                   "exrules": {
                     "type": "array",
                     "items": {
                       "type": "string"
                     }
                   }
                 },
                 "required": ["tzid", "rdates", "rrules", "exdates", "exrules"],
                 "unevaluatedProperties": false
               },
               "createdAt": {
                 "type": "string"
               },
               "updatedAt": {
                 "type": "string"
               },
               "createdBy": {
                 "type": "integer"
               },
               "updatedBy": {
                 "type": "integer"
               },
               "createdByUserName": {
                 "type": "string"
               },
               "updatedByUserName": {
                 "type": "string"
               }
             },
             "required": [
               "id",
               "name",
               "comments",
               "startsAt",
               "endsAt",
               "repeatsUntil",
               "rrule",
               "createdAt",
               "updatedAt",
               "createdBy",
               "updatedBy",
               "createdByUserName",
               "updatedByUserName"
             ],
             "unevaluatedProperties": false
           }
         ]
       },
       "createdAt": {
         "type": "string"
       },
       "updatedAt": {
         "type": "string"
       },
       "createdBy": {
         "type": "integer"
       },
       "createdByUserName": {
         "type": "string"
       },
       "updatedBy": {
         "type": "integer"
       },
       "updatedByUserName": {
         "type": "string"
       },
       "customOrderId": {
         "type": ["null", "string"]
       },
       "tasks": {
         "type": "object",
         "properties": {
           "total": {
             "type": "integer"
           },
           "completed": {
             "type": "integer"
           }
         },
         "required": ["total", "completed"],
         "unevaluatedProperties": false
       },
       "templateOrderName": {
         "type": ["null", "string"]
       },
       "variables": {
         "type": ["null", "object"]
       },
       "orderInstructionAssignments": {
         "type": "array",
         "items": {
           "type": "object",
           "properties": {
             "id": { "type": "integer" }
           },
           "additionalProperties": true
         }
       },
       "executionMode": {
         "type": "string"
       },
       "archived": {
         "type": "boolean"
       }
     },
     "required": [
       "id",
       "templateId",
       "name",
       "description",
       "comments",
       "priority",
       "automaticCompletion",
       "state",
       "startDate",
       "dueDate",
       "assigneeId",
       "assigneeUserName",
       "canBeTakenOver",
       "progressIds",
       "completedProgressIds",
       "createdAt",
       "updatedAt",
       "createdBy",
       "createdByUserName",
       "updatedBy",
       "updatedByUserName",
       "customOrderId",
       "tasks",
       "templateOrderName",
       "variables",
       "orderInstructionAssignments",
       "executionMode",
       "archived"
     ],
     "unevaluatedProperties": false
   }
 },
 "required": ["version", "fullVersion", "realm", "data"],
 "unevaluatedProperties": false
}

Report completed v1

Send when report is completed

📘

Here is the JSON schema

Click to expand
{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "type": "object",
 "title": "Report complete version 1",
 "properties": {
   "version": {
     "type": "integer",
     "enum": [1]
   },
   "fullVersion": {
     "type": "string",
     "enum": ["1.1"]
   },
   "realm": {
     "type": "string",
     "enum": ["report.complete"]
   },
   "data": {
     "type": "object",
     "properties": {
       "id": {
         "type": "integer"
       },
       "instructionId": {
         "type": "integer"
       },
       "comments": {
         "type": ["null", "string"]
       },
       "numOfSteps": {
         "type": "integer"
       },
       "stepIndex": {
         "type": "integer"
       },
       "createdAt": {
         "type": "string"
       },
       "createdBy": {
         "type": "integer"
       },
       "updatedAt": {
         "type": "string"
       },
       "updatedBy": {
         "type": "integer"
       },
       "orderId": {
         "type": ["null", "integer"]
       },
       "state": {
         "type": "string"
       },
       "offline": {
         "type": "boolean"
       },
       "revision": {
         "type": "integer"
       },
       "interactionData": {
         "type": "array",
         "items": {
           "type": "object",
           "properties": {
             "progressId": {
               "type": "integer"
             },
             "progressName": {
               "type": ["null", "string"]
             },
             "instructionName": {
               "type": ["null", "string"]
             },
             "progressState": {
               "type": "string"
             },
             "progressPassed": {
               "type": "string"
             },
             "stepId": {
               "type": "integer"
             },
             "stepName": {
               "type": ["null", "string"]
             },
             "stepTimestamp": {
               "type": ["null", "string"]
             },
             "stepUpdatedBy": {
               "type": "integer"
             },
             "stepUpdatedByUserName": {
               "type": "string"
             },
             "stepOpenedAt": {
               "type": "string"
             },
             "rowId": {
               "type": "integer"
             },
             "rowHeader": {
               "type": ["null", "string"]
             },
             "interactionId": {
               "type": "integer"
             },
             "interactionVersionPersistentId": {
               "type": "integer"
             },
             "interactionType": {
               "type": "string"
             },
             "interactionKey": {
               "type": ["null", "string"]
             },
             "interactionValueId": {
               "type": "integer"
             },
             "interactionValue": {
               "anyOf": [
                 {
                   "type": "null"
                 },
                 {
                   "type": "boolean"
                 },
                 {
                   "type": "string"
                 },
                 {
                   "type": "number"
                 },
                 {
                   "type": "object",
                   "patternProperties": {
                     "^\\d+$": {
                       "type": "boolean"
                     }
                   },
                   "unevaluatedProperties": false
                 },
                 {
                   "type": "object",
                   "required": ["pdfFeedbackIds", "imageFeedbackIds", "videoFeedbackIds"],
                   "unevaluatedProperties": false,
                   "properties": {
                     "pdfFeedbackIds": {
                       "type": "array",
                       "items": {
                         "type": "integer"
                       }
                     },
                     "imageFeedbackIds": {
                       "type": "array",
                       "items": {
                         "type": "integer"
                       }
                     },
                     "videoFeedbackIds": {
                       "type": "array",
                       "items": {
                         "type": "integer"
                       }
                     }
                   }
                 }
               ]
             },
             "interactionValuePassed": {
               "type": "string"
             },
             "interactionValueUpdatedAt": {
               "type": "string"
             },
             "interactionValueUpdatedBy": {
               "type": ["null", "integer"]
             },
             "interactionValueUpdatedByUserName": {
               "type": ["null", "string"]
             },
             "interactionComment": {
               "type": ["null", "string"]
             },
             "interactionNotApplicable": {
               "type": "boolean"
             },
             "interactionUnit": {
               "type": ["null", "string"]
             },
             "interactionTagIds": {
               "type": "string"
             },
             "interactionTagNames": {
               "type": "string"
             },
             "stepPosition": {
               "type": "integer"
             }
           },
           "required": [
             "progressId",
             "progressName",
             "instructionName",
             "progressState",
             "progressPassed",
             "stepId",
             "stepName",
             "rowId",
             "rowHeader",
             "stepPosition"
           ]
         }
       }
     },
     "required": [
       "id",
       "instructionId",
       "comments",
       "numOfSteps",
       "stepIndex",
       "createdAt",
       "createdBy",
       "updatedAt",
       "updatedBy",
       "orderId",
       "state",
       "offline",
       "revision",
       "interactionData"
     ],
     "unevaluatedProperties": false
   }
 },
 "required": ["version", "fullVersion", "realm", "data"],
 "unevaluatedProperties": false
}

Document in review v2

Send when document is review

📘

Here is the JSON schema

Click to expand
{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "type": "object",
 "title": "Instruction review version 2",
 "properties": {
   "version": {
     "type": "integer",
     "enum": [2]
   },
   "fullVersion": {
     "type": "string",
     "enum": ["2.0"]
   },
   "realm": {
     "type": "string",
     "enum": ["instruction.review"]
   },
   "data": {
     "type": "object",
     "properties": {
       "id": {
         "type": "integer"
       },
       "name": {
         "type": ["string", "null"]
       },
       "version": {
         "type": "string"
       },
       "visible": {
         "type": "boolean"
       },
       "hasVariables": {
         "type": "boolean"
       },
       "state": {
         "type": "string"
       },
       "createdAt": {
         "type": "string"
       },
       "updatedAt": {
         "type": "string"
       },
       "createdBy": {
         "type": "integer"
       },
       "createdByUserName": {
         "type": "string"
       },
       "updatedBy": {
         "type": "integer"
       },
       "updatedByUserName": {
         "type": "string"
       },
       "reviewedAt": {
         "type": ["null", "string"]
       },
       "reviewedBy": {
         "type": ["null", "integer"]
       },
       "reviewedByUserName": {
         "type": ["null", "string"]
       },
       "tags": {
         "type": "array",
         "items": {
           "type": "object",
           "properties": {
             "id": {
               "type": "integer"
             },
             "name": {
               "type": "string"
             },
             "archived": {
               "type": "boolean"
             }
           },
           "required": ["id", "name", "archived"],
           "unevaluatedProperties": false
         }
       },
       "notes": {
         "type": ["string", "null"]
       },
       "changenotes": {
         "type": ["string", "null"]
       },
       "dirty": {
         "type": "boolean"
       },
       "isResolveDirtyVersion": {
         "type": "boolean"
       },
       "validityDate": {
         "type": ["string", "null"]
       },
       "confidentiality": {
         "type": ["string", "null"]
       },
       "availableLocales": {
         "type": "array",
         "items": {
           "type": "object",
           "properties": {
             "instructionId": {
               "type": "integer"
             },
             "localeCode": {
               "type": "string"
             }
           },
           "required": ["instructionId", "localeCode"],
           "unevaluatedProperties": false
         }
       },
       "type": {
         "type": "string"
       },
       "progressHidden": {
         "type": "boolean"
       },
       "baseInstructionId": {
         "type": "integer"
       },
       "acceptChangenotes": {
         "type": "boolean"
       }
     },
     "required": [
       "id",
       "name",
       "version",
       "visible",
       "hasVariables",
       "state",
       "createdAt",
       "updatedAt",
       "createdBy",
       "createdByUserName",
       "updatedBy",
       "updatedByUserName",
       "reviewedAt",
       "reviewedBy",
       "reviewedByUserName",
       "tags",
       "notes",
       "changenotes",
       "dirty",
       "isResolveDirtyVersion",
       "validityDate",
       "confidentiality",
       "availableLocales",
       "type",
       "progressHidden",
       "baseInstructionId",
       "acceptChangenotes"
     ],
     "unevaluatedProperties": false
   }
 },
 "required": ["version", "fullVersion", "realm", "data"],
 "unevaluatedProperties": false
}

Report reopened v1

Send when report reopened

📘

Here is the JSON schema

Click to expand
{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "type": "object",
 "title": "Report reopen version 1",
 "properties": {
   "version": {
     "type": "integer",
     "enum": [1]
   },
   "fullVersion": {
     "type": "string",
     "enum": ["1.0"]
   },
   "realm": {
     "type": "string",
     "enum": ["report.reopen"]
   },
   "data": {
     "type": "object",
     "properties": {
       "id": {
         "type": "integer"
       },
       "instructionId": {
         "type": "integer"
       },
       "comments": {
         "type": ["null", "string"]
       },
       "numOfSteps": {
         "type": "integer"
       },
       "stepIndex": {
         "type": "integer"
       },
       "createdAt": {
         "type": "string"
       },
       "createdBy": {
         "type": "integer"
       },
       "updatedAt": {
         "type": "string"
       },
       "updatedBy": {
         "type": "integer"
       },
       "orderId": {
         "type": ["null", "integer"]
       },
       "state": {
         "type": "string"
       },
       "offline": {
         "type": "boolean"
       },
       "revision": {
         "type": "integer"
       },
       "interactionData": {
         "type": "array",
         "items": {
           "type": "object",
           "properties": {
             "progressId": {
               "type": "integer"
             },
             "progressName": {
               "type": ["null", "string"]
             },
             "instructionName": {
               "type": ["null", "string"]
             },
             "progressState": {
               "type": "string"
             },
             "progressPassed": {
               "type": "string"
             },
             "stepId": {
               "type": "integer"
             },
             "stepName": {
               "type": ["null", "string"]
             },
             "stepTimestamp": {
               "type": ["null", "string"]
             },
             "stepUpdatedBy": {
               "type": "integer"
             },
             "stepUpdatedByUserName": {
               "type": "string"
             },
             "stepOpenedAt": {
               "type": "string"
             },
             "rowId": {
               "type": "integer"
             },
             "rowHeader": {
               "type": ["null", "string"]
             },
             "interactionId": {
               "type": "integer"
             },
             "interactionVersionPersistentId": {
               "type": "integer"
             },
             "interactionType": {
               "type": "string"
             },
             "interactionKey": {
               "type": ["null", "string"]
             },
             "interactionValueId": {
               "type": "integer"
             },
             "interactionValue": {
               "anyOf": [
                 {
                   "type": "null"
                 },
                 {
                   "type": "boolean"
                 },
                 {
                   "type": "string"
                 },
                 {
                   "type": "number"
                 },
                 {
                   "type": "object",
                   "patternProperties": {
                     "^\\d+$": {
                       "type": "boolean"
                     }
                   },
                   "unevaluatedProperties": false
                 },
                 {
                   "type": "object",
                   "required": ["pdfFeedbackIds", "imageFeedbackIds", "videoFeedbackIds"],
                   "unevaluatedProperties": false,
                   "properties": {
                     "pdfFeedbackIds": {
                       "type": "array",
                       "items": {
                         "type": "integer"
                       }
                     },
                     "imageFeedbackIds": {
                       "type": "array",
                       "items": {
                         "type": "integer"
                       }
                     },
                     "videoFeedbackIds": {
                       "type": "array",
                       "items": {
                         "type": "integer"
                       }
                     }
                   }
                 }
               ]
             },
             "interactionValuePassed": {
               "type": "string"
             },
             "interactionValueUpdatedAt": {
               "type": "string"
             },
             "interactionValueUpdatedBy": {
               "type": ["null", "integer"]
             },
             "interactionValueUpdatedByUserName": {
               "type": ["null", "string"]
             },
             "interactionComment": {
               "type": ["null", "string"]
             },
             "interactionNotApplicable": {
               "type": "boolean"
             },
             "interactionUnit": {
               "type": ["null", "string"]
             },
             "interactionTagIds": {
               "type": "string"
             },
             "interactionTagNames": {
               "type": "string"
             },
             "stepPosition": {
               "type": "integer"
             },
             "interactionCaptureMode": {
               "type": ["null", "string"]
             }
           },
           "required": [
             "progressId",
             "progressName",
             "instructionName",
             "progressState",
             "progressPassed",
             "stepId",
             "stepName",
             "stepTimestamp",
             "stepUpdatedBy",
             "stepUpdatedByUserName",
             "rowId",
             "rowHeader",
             "stepPosition"
           ],
           "unevaluatedProperties": true
         }
       }
     },
     "required": [
       "id",
       "instructionId",
       "comments",
       "numOfSteps",
       "stepIndex",
       "createdAt",
       "createdBy",
       "updatedAt",
       "updatedBy",
       "orderId",
       "state",
       "offline",
       "revision",
       "interactionData"
     ],
     "unevaluatedProperties": false
   }
 },
 "required": ["version", "fullVersion", "realm", "data"],
 "unevaluatedProperties": false
}

Task created v1

Send when task created

📘

Here is the JSON schema

Click to expand
{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "type": "object",
 "title": "Task create version 1",
 "properties": {
   "version": {
     "type": "integer",
     "enum": [1]
   },
   "fullVersion": {
     "type": "string",
     "enum": ["1.0"]
   },
   "realm": {
     "type": "string",
     "enum": ["task.create"]
   },
   "data": {
     "type": "object",
     "properties": {
       "id": {
         "type": "integer"
       },
       "title": {
         "type": "string"
       },
       "systemCreatedBy": {
         "type": ["integer", "null"]
       },
       "systemCreatedByUserName": {
         "type": ["string", "null"]
       },
       "createdBy": {
         "type": "integer"
       },
       "createdByUserName": {
         "type": "string"
       },
       "updatedBy": {
         "type": "integer"
       },
       "updatedByUserName": {
         "type": "string"
       },
       "createdAt": {
         "type": "string"
       },
       "updatedAt": {
         "type": "string"
       },
       "rowId": {
         "type": ["integer", "null"]
       },
       "progressId": {
         "type": ["integer", "null"]
       },
       "archived": {
         "type": "boolean"
       },
       "state": {
         "type": "string"
       },
       "assigneeId": {
         "type": ["null", "integer"]
       },
       "assigneeUserName": {
         "type": ["null", "string"]
       },
       "priority": {
         "type": "integer"
       },
       "dueDate": {
         "type": ["string", "null"]
       },
       "description": {
         "type": "string"
       },
       "rowHeader": {
         "type": ["null", "string"]
       },
       "instructionName": {
         "type": ["null", "string"]
       },
       "progressName": {
         "type": ["null", "string"]
       },
       "customExternalClassifier": {
         "type": "boolean"
       },
       "externalClassifierEntries": {
         "type": "array",
         "items": {
           "type": "object",
           "properties": {
             "id": {
               "type": "integer"
             },
             "name": {
               "type": "string"
             },
             "externalClassifierId": {
               "type": "integer"
             },
             "externalClassifierName": {
               "type": "string"
             },
             "data": {
               "type": "object"
             },
             "createdAt": {
               "type": "string"
             },
             "updatedAt": {
               "type": "string"
             },
             "createdBy": {
               "type": ["integer", "null"]
             },
             "createdByUserName": {
               "type": ["string", "null"]
             },
             "updatedBy": {
               "type": ["integer", "null"]
             },
             "updatedByUserName": {
               "type": ["string", "null"]
             },
             "archived": {
               "type": "boolean"
             }
           },
           "required": [
             "id",
             "name",
             "externalClassifierId",
             "externalClassifierName",
             "data",
             "createdAt",
             "updatedAt",
             "createdBy",
             "createdByUserName",
             "updatedBy",
             "updatedByUserName",
             "archived"
           ],
           "unevaluatedProperties": false
         }
       },
       "stepId": {
         "type": ["integer", "null"]
       },
       "interactionValueId": {
         "type": ["null", "integer"]
       },
       "isSignatureRequestTask": {
         "type": "boolean"
       }
     },
     "required": [
       "id",
       "title",
       "systemCreatedBy",
       "systemCreatedByUserName",
       "createdBy",
       "createdByUserName",
       "updatedBy",
       "updatedByUserName",
       "updatedAt",
       "rowId",
       "progressId",
       "archived",
       "state",
       "assigneeId",
       "assigneeUserName",
       "priority",
       "dueDate",
       "description",
       "rowHeader",
       "instructionName",
       "progressName",
       "customExternalClassifier",
       "externalClassifierEntries",
       "interactionValueId"
     ],
     "unevaluatedProperties": false
   }
 },
 "required": ["version", "fullVersion", "realm", "data"],
 "unevaluatedProperties": false
}

Interaction value updated v1

Send when interaction value updated

📘

Here is the JSON schema

Click to expand
{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "type": "object",
 "title": "Interaction value update version 1",
 "properties": {
   "version": {
     "type": "integer",
     "enum": [1]
   },
   "fullVersion": {
     "type": "string",
     "enum": ["1.0", "1.1"]
   },
   "realm": {
     "type": "string",
     "enum": ["interaction_value.update"]
   },
   "data": {
     "type": "object",
     "properties": {
       "interactionValue": {
         "type": "object",
         "properties": {
           "comment": {
             "type": ["null", "string"]
           },
           "exceedsDeviation": {
             "type": ["null", "boolean"]
           },
           "id": {
             "type": "integer"
           },
           "interactionId": {
             "type": "integer"
           },
           "notApplicable": {
             "type": "boolean"
           },
           "numberOfChanges": {
             "type": "integer"
           },
           "passed": {
             "type": "string"
           },
           "progressId": {
             "type": "integer"
           },
           "rowLogId": {
             "type": "integer"
           },
           "signatureState": {
             "type": ["null", "string"]
           },
           "stepPosition": {
             "type": "integer"
           },
           "updatedAt": {
             "type": "string"
           },
           "updatedBy": {
             "type": ["integer", "null"]
           },
           "updatedByUserName": {
             "type": ["string", "null"]
           },
           "value": {
             "anyOf": [
               {
                 "type": "null"
               },
               {
                 "type": "boolean"
               },
               {
                 "type": "string"
               },
               {
                 "type": "number"
               },
               {
                 "type": "object",
                 "patternProperties": {
                   "^\\d+$": {
                     "type": "boolean"
                   }
                 },
                 "unevaluatedProperties": false
               },
               {
                 "type": "object",
                 "required": ["pdfFeedbackIds", "imageFeedbackIds", "videoFeedbackIds"],
                 "unevaluatedProperties": false,
                 "properties": {
                   "pdfFeedbackIds": {
                     "type": "array",
                     "items": {
                       "type": "integer"
                     }
                   },
                   "imageFeedbackIds": {
                     "type": "array",
                     "items": {
                       "type": "integer"
                     }
                   },
                   "videoFeedbackIds": {
                     "type": "array",
                     "items": {
                       "type": "integer"
                     }
                   }
                 }
               }
             ]
           },
           "parentConditionMatches": {
             "type": ["null", "boolean"]
           },
           "serialNumbers": {
             "type": ["array", "null"],
             "items": {
               "type": "string"
             }
           }
         },
         "required": [
           "comment",
           "exceedsDeviation",
           "id",
           "interactionId",
           "notApplicable",
           "numberOfChanges",
           "passed",
           "progressId",
           "rowLogId",
           "signatureState",
           "stepPosition",
           "updatedAt",
           "updatedBy",
           "updatedByUserName",
           "value",
           "parentConditionMatches"
         ]
       },
       "progress": {
         "type": "object",
         "properties": {
           "id": {
             "type": "integer"
           },
           "instructionId": {
             "type": "integer"
           },
           "comments": {
             "type": ["null", "string"]
           },
           "numOfSteps": {
             "type": "integer"
           },
           "stepIndex": {
             "type": "integer"
           },
           "createdAt": {
             "type": "string"
           },
           "createdBy": {
             "type": "integer"
           },
           "updatedAt": {
             "type": "string"
           },
           "updatedBy": {
             "type": "integer"
           },
           "orderId": {
             "type": ["null", "integer"]
           },
           "state": {
             "type": "string"
           },
           "offline": {
             "type": "boolean"
           },
           "passed": {
             "type": "string"
           },
           "interactionData": {
             "type": "array",
             "items": {
               "type": "object",
               "properties": {
                 "progressId": {
                   "type": "integer"
                 },
                 "progressName": {
                   "type": ["null", "string"]
                 },
                 "instructionName": {
                   "type": ["null", "string"]
                 },
                 "progressState": {
                   "type": "string"
                 },
                 "progressPassed": {
                   "type": "string"
                 },
                 "stepId": {
                   "type": "integer"
                 },
                 "stepName": {
                   "type": ["null", "string"]
                 },
                 "stepTimestamp": {
                   "type": ["null", "string"]
                 },
                 "stepUpdatedBy": {
                   "type": "integer"
                 },
                 "stepUpdatedByUserName": {
                   "type": "string"
                 },
                 "stepOpenedAt": {
                   "type": "string"
                 },
                 "rowId": {
                   "type": "integer"
                 },
                 "rowHeader": {
                   "type": ["null", "string"]
                 },
                 "interactionId": {
                   "type": "integer"
                 },
                 "interactionVersionPersistentId": {
                   "type": "integer"
                 },
                 "interactionType": {
                   "type": "string"
                 },
                 "interactionKey": {
                   "type": ["null", "string"]
                 },
                 "interactionValueId": {
                   "type": "integer"
                 },
                 "interactionValue": {
                   "anyOf": [
                     {
                       "type": ["number"]
                     },
                     {
                       "type": ["string"]
                     },
                     {
                       "type": ["boolean"]
                     },
                     {
                       "type": ["null"]
                     },
                     {
                       "type": "object",
                       "patternProperties": {
                         "^\\d+$": {
                           "type": "boolean"
                         }
                       },
                       "unevaluatedProperties": false
                     },
                     {
                       "type": "object",
                       "required": ["pdfFeedbackIds", "imageFeedbackIds", "videoFeedbackIds"],
                       "unevaluatedProperties": false,
                       "properties": {
                         "pdfFeedbackIds": {
                           "type": "array",
                           "items": {
                             "type": "integer"
                           }
                         },
                         "imageFeedbackIds": {
                           "type": "array",
                           "items": {
                             "type": "integer"
                           }
                         },
                         "videoFeedbackIds": {
                           "type": "array",
                           "items": {
                             "type": "integer"
                           }
                         }
                       }
                     }
                   ]
                 },
                 "interactionValuePassed": {
                   "type": "string"
                 },
                 "interactionValueUpdatedAt": {
                   "type": "string"
                 },
                 "interactionValueUpdatedBy": {
                   "type": ["null", "integer"]
                 },
                 "interactionValueUpdatedByUserName": {
                   "type": ["null", "string"]
                 },
                 "interactionComment": {
                   "type": ["null", "string"]
                 },
                 "interactionNotApplicable": {
                   "type": "boolean"
                 },
                 "interactionUnit": {
                   "type": ["null", "string"]
                 },
                 "interactionTagIds": {
                   "type": "string"
                 },
                 "interactionTagNames": {
                   "type": "string"
                 },
                 "interactionNominalValue": {
                   "type": ["null", "string"]
                 },
                 "interactionToleranceUp": {
                   "type": ["number", "null"]
                 },
                 "interactionToleranceDown": {
                   "type": ["number", "null"]
                 },
                 "interactionToleranceType": {
                   "type": "string"
                 },
                 "stepPosition": {
                   "type": "integer"
                 },
                 "interactionFailValueLess": {
                   "type": "boolean"
                 },
                 "interactionFailValueMore": {
                   "type": "boolean"
                 },
                 "interactionCaptureMode": {
                   "type": ["null", "string"]
                 }
               },
               "required": [
                 "progressId",
                 "progressName",
                 "instructionName",
                 "progressState",
                 "progressPassed",
                 "stepId",
                 "stepName",
                 "rowId",
                 "rowHeader",
                 "stepPosition"
               ]
             }
           },
           "instructionBaseId": {
             "type": "integer"
           },
           "externalClassifierEntries": {
             "type": "array",
             "items": {
               "type": "object",
               "properties": {
                 "id": {
                   "type": "integer"
                 },
                 "name": {
                   "type": "string"
                 },
                 "externalClassifierId": {
                   "type": "integer"
                 },
                 "externalClassifierName": {
                   "type": "string"
                 }
               },
               "required": ["id", "name", "externalClassifierId", "externalClassifierName"]
             }
           }
         },
         "required": [
           "id",
           "instructionId",
           "comments",
           "numOfSteps",
           "stepIndex",
           "createdAt",
           "createdBy",
           "updatedAt",
           "updatedBy",
           "orderId",
           "state",
           "offline",
           "passed",
           "interactionData",
           "instructionBaseId",
           "externalClassifierEntries"
         ],
         "unevaluatedProperties": false
       },
       "order": {
         "oneOf": [
           {
             "type": "null"
           },
           {
             "type": "object",
             "properties": {
               "id": {
                 "type": "integer"
               },
               "customOrderId": {
                 "type": ["null", "string"]
               },
               "name": {
                 "type": "string"
               }
             },
             "required": ["id", "customOrderId", "name"]
           }
         ]
       },
       "instruction": {
         "type": "object",
         "properties": {
           "id": {
             "type": "integer"
           },
           "baseInstructionId": {
             "type": "integer"
           },
           "name": {
             "type": ["null", "string"]
           },
           "version": {
             "type": "string"
           },
           "confidentiality": {
             "type": ["null", "string"]
           },
           "tags": {
             "type": "array",
             "items": {
               "type": "object",
               "properties": {
                 "id": {
                   "type": "number"
                 },
                 "name": {
                   "type": "string"
                 }
               }
             }
           }
         },
         "required": ["id", "baseInstructionId", "name", "version", "confidentiality", "tags"],
         "unevaluatedProperties": false
       },
       "interaction": {
         "type": "object",
         "properties": {
           "id": {
             "type": "integer"
           },
           "versionPersistentId": {
             "type": "integer"
           },
           "type": {
             "type": "string"
           },
           "allowAdditionalFeedback": {
             "type": "boolean"
           },
           "canBeNotApplicable": {
             "type": "boolean"
           },
           "customPartId": {
             "type": ["null", "string"]
           },
           "interactionChoices": {
             "type": "array",
             "items": {
               "type": "object",
               "properties": {
                 "id": {
                   "type": "integer"
                 },
                 "versionPersistentId": {
                   "type": "integer"
                 }
               },
               "additionalProperties": true
             }
           },
           "interactionTags": {
             "type": "array",
             "items": {
               "type": "object",
               "properties": {
                 "id": {
                   "type": "integer"
                 },
                 "name": {
                   "type": "string"
                 }
               },
               "additionalProperties": true
             }
           },
           "key": {
             "type": ["null", "string"]
           },
           "localPartId": {
             "type": ["null", "integer"]
           },
           "localPartName": {
             "type": ["null", "string"]
           },
           "mandatory": {
             "type": "boolean"
           },
           "nominalValue": {
             "type": ["null", "string"]
           },
           "position": {
             "type": "integer"
           },
           "quantity": {
             "type": ["null", "integer"]
           },
           "toleranceDown": {
             "type": ["null", "number"]
           },
           "toleranceType": {
             "type": ["null", "string"]
           },
           "toleranceUp": {
             "type": ["null", "number"]
           },
           "unitId": {
             "type": ["null", "integer"]
           },
           "unitName": {
             "type": ["null", "string"]
           },
           "uri": {
             "type": ["null", "string"]
           },
           "rowId": {
             "type": "integer"
           },
           "stepId": {
             "type": "integer"
           }
         },
         "required": [
           "id",
           "versionPersistentId",
           "type",
           "allowAdditionalFeedback",
           "canBeNotApplicable",
           "customPartId",
           "interactionChoices",
           "interactionTags",
           "key",
           "localPartId",
           "localPartName",
           "mandatory",
           "nominalValue",
           "position",
           "quantity",
           "toleranceDown",
           "toleranceType",
           "toleranceUp",
           "unitId",
           "unitName",
           "uri",
           "rowId",
           "stepId"
         ],
         "unevaluatedProperties": false
       },
       "userId": {
         "type": "integer"
       }
     },
     "required": ["interactionValue", "progress", "order", "instruction", "interaction", "userId"],
     "unevaluatedProperties": false
   }
 },
 "required": ["version", "fullVersion", "realm", "data"],
 "unevaluatedProperties": false
}

Order created v2

Send when order created

📘

Here is the JSON schema

Click to expand
{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "type": "object",
 "title": "Order create version 2",
 "properties": {
   "version": {
     "type": "integer",
     "enum": [2],
     "examples": [2]
   },
   "fullVersion": {
     "type": "string",
     "enum": ["2.1"],
     "examples": ["2.1"]
   },
   "realm": {
     "type": "string",
     "enum": ["order.create"],
     "examples": ["order.create"]
   },
   "data": {
     "type": "object",
     "properties": {
       "id": {
         "type": "integer",
         "examples": [1234]
       },
       "templateId": {
         "type": ["null", "integer"],
         "examples": [null, 1234]
       },
       "name": {
         "type": "string",
         "examples": ["New Order"]
       },
       "description": {
         "type": "string",
         "examples": ["A new Order"]
       },
       "comments": {
         "type": "string",
         "examples": ["", "Comments are in here"]
       },
       "priority": {
         "type": "integer",
         "examples": [5]
       },
       "automaticCompletion": {
         "type": "boolean",
         "examples": [true]
       },
       "state": {
         "type": "string",
         "examples": ["in-edit"]
       },
       "startDate": {
         "type": "string",
         "examples": ["2023-03-14T00:00:00.000Z"]
       },
       "dueDate": {
         "type": ["string", "null"],
         "examples": ["2023-03-16T00:00:00.000Z"]
       },
       "assigneeId": {
         "type": ["null", "integer"],
         "examples": [null, 1234]
       },
       "assigneeUserName": {
         "type": ["null", "string"],
         "examples": [null, "Max Mustermann", "User"]
       },
       "canBeTakenOver": {
         "type": "boolean",
         "examples": ["true"]
       },
       "progressIds": {
         "type": "array",
         "items": {
           "type": "number",
           "examples": ["[]", "1234.1234"]
         }
       },
       "completedProgressIds": {
         "type": "array",
         "items": {
           "type": "number",
           "examples": [[], [1234, 1235]]
         }
       },
       "event": {
         "oneOf": [
           { "type": "null" },
           {
             "type": "object",
             "properties": {
               "id": {
                 "type": "integer",
                 "examples": [1234]
               },
               "name": {
                 "type": ["null", "string"],
                 "examples": [null, "A Name"]
               },
               "comments": {
                 "type": "string",
                 "examples": ["", "comment"]
               },
               "startsAt": {
                 "type": "string",
                 "examples": ["2023-03-14T00:00:00.000Z"]
               },
               "endsAt": {
                 "type": "string",
                 "examples": ["2023-03-16T00:00:00.000Z"]
               },
               "createdAt": {
                 "type": "string",
                 "examples": ["2023-03-14T00:00:00.000Z"]
               },
               "updatedAt": {
                 "type": "string",
                 "examples": ["2023-03-14T00:00:00.000Z"]
               },
               "createdBy": {
                 "type": "integer",
                 "examples": [1234]
               },
               "updatedBy": {
                 "type": "integer",
                 "examples": [1234]
               },
               "createdByUserName": {
                 "type": "string",
                 "examples": ["Max Mustermann"]
               },
               "updatedByUserName": {
                 "type": "string",
                 "examples": ["Max Mustermann"]
               }
             },
             "required": [
               "id",
               "name",
               "comments",
               "startsAt",
               "endsAt",
               "createdAt",
               "updatedAt",
               "createdBy",
               "updatedBy",
               "createdByUserName",
               "updatedByUserName"
             ],
             "unevaluatedProperties": false
           }
         ]
       },
       "recurrence": {
         "oneOf": [
           { "type": "null" },
           {
             "type": "object",
             "properties": {
               "id": {
                 "type": "integer"
               },
               "name": {
                 "type": "string"
               },
               "comments": {
                 "type": "string"
               },
               "startsAt": {
                 "type": "string"
               },
               "endsAt": {
                 "type": "string"
               },
               "repeatsUntil": {
                 "type": "string"
               },
               "rrule": {
                 "type": "object",
                 "properties": {
                   "tzid": {
                     "type": "string"
                   },
                   "rdates": {
                     "type": "array",
                     "items": {
                       "type": "string"
                     }
                   },
                   "rrules": {
                     "type": "array",
                     "items": {
                       "type": "object",
                       "properties": {
                         "end": {
                           "type": "string"
                         },
                         "days": {
                           "type": "array",
                           "items": {
                             "type": "string"
                           }
                         },
                         "time": {
                           "type": "string"
                         },
                         "start": {
                           "type": "string"
                         },
                         "duration": {
                           "type": "string"
                         },
                         "interval": {
                           "type": "integer"
                         },
                         "byweekday": {
                           "type": "array",
                           "items": {
                             "type": "number"
                           }
                         },
                         "bysetpos": {
                           "type": "array",
                           "items": {
                             "type": "number"
                           }
                         },
                         "bymonthday": {
                           "type": "array",
                           "items": {
                             "type": "number"
                           }
                         },
                         "bymonth": {
                           "type": "array",
                           "items": {
                             "type": "number"
                           }
                         },
                         "freq": {
                           "type": "number"
                         }
                       },
                       "required": ["end", "time", "start", "duration", "interval"],
                       "unevaluatedProperties": false
                     }
                   },
                   "exdates": {
                     "type": "array",
                     "items": {
                       "type": "string"
                     }
                   },
                   "exrules": {
                     "type": "array",
                     "items": {
                       "type": "string"
                     }
                   }
                 },
                 "required": ["tzid", "rdates", "rrules", "exdates", "exrules"],
                 "unevaluatedProperties": false
               },
               "createdAt": {
                 "type": "string"
               },
               "updatedAt": {
                 "type": "string"
               },
               "createdBy": {
                 "type": "integer"
               },
               "updatedBy": {
                 "type": "integer"
               },
               "createdByUserName": {
                 "type": "string"
               },
               "updatedByUserName": {
                 "type": "string"
               }
             },
             "required": [
               "id",
               "name",
               "comments",
               "startsAt",
               "endsAt",
               "repeatsUntil",
               "rrule",
               "createdAt",
               "updatedAt",
               "createdBy",
               "updatedBy",
               "createdByUserName",
               "updatedByUserName"
             ],
             "unevaluatedProperties": false
           }
         ]
       },
       "createdAt": {
         "type": "string"
       },
       "updatedAt": {
         "type": "string"
       },
       "createdBy": {
         "type": "integer"
       },
       "createdByUserName": {
         "type": "string"
       },
       "updatedBy": {
         "type": "integer"
       },
       "updatedByUserName": {
         "type": "string"
       },
       "customOrderId": {
         "type": ["null", "string"]
       },
       "tasks": {
         "type": "object",
         "properties": {
           "total": {
             "type": "integer"
           },
           "completed": {
             "type": "integer"
           }
         },
         "required": ["total", "completed"],
         "unevaluatedProperties": false
       },
       "templateOrderName": {
         "type": ["null", "string"],
         "examples": [null, "Template Name"]
       },
       "variables": {
         "type": ["null", "object"],
         "examples": [null, { "color": "blue", "serialNumber": "AB151_S" }]
       },
       "orderInstructionAssignments": {
         "type": "array",
         "items": {
           "type": "object",
           "properties": {
             "id": { "type": "integer" }
           },
           "additionalProperties": true
         }
       },
       "executionMode": {
         "type": "string"
       },
       "archived": {
         "type": "boolean"
       }
     },
     "required": [
       "id",
       "templateId",
       "name",
       "description",
       "comments",
       "priority",
       "automaticCompletion",
       "state",
       "startDate",
       "dueDate",
       "assigneeId",
       "assigneeUserName",
       "canBeTakenOver",
       "progressIds",
       "completedProgressIds",
       "createdAt",
       "updatedAt",
       "createdBy",
       "createdByUserName",
       "updatedBy",
       "updatedByUserName",
       "customOrderId",
       "tasks",
       "templateOrderName",
       "variables",
       "orderInstructionAssignments",
       "executionMode",
       "archived"
     ],
     "unevaluatedProperties": false
   }
 },
 "required": ["version", "fullVersion", "realm", "data"],
 "unevaluatedProperties": false
}

Order started v1

Send when order started

📘

Here is the JSON schema

Click to expand
{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "type": "object",
 "title": "Order started version 1.0",
 "properties": {
   "version": {
     "type": "integer",
     "enum": [1],
     "examples": [1]
   },
   "fullVersion": {
     "type": "string",
     "enum": ["1.0"],
     "examples": ["1.0"]
   },
   "realm": {
     "type": "string",
     "enum": ["order.start"],
     "examples": ["order.start"]
   },
   "data": {
     "type": "object",
     "properties": {
       "id": {
         "type": "integer",
         "examples": [1234]
       },
       "templateId": {
         "type": ["null", "integer"],
         "examples": [null, 1234]
       },
       "name": {
         "type": "string",
         "examples": ["New Order"]
       },
       "description": {
         "type": "string",
         "examples": ["A new Order"]
       },
       "comments": {
         "type": "string",
         "examples": ["", "Comments are in here"]
       },
       "priority": {
         "type": "integer",
         "examples": [5]
       },
       "automaticCompletion": {
         "type": "boolean",
         "examples": [true]
       },
       "state": {
         "type": "string",
         "examples": ["in-edit"]
       },
       "startDate": {
         "type": "string",
         "examples": ["2023-03-14T00:00:00.000Z"]
       },
       "dueDate": {
         "type": ["string", "null"],
         "examples": ["2023-03-16T00:00:00.000Z"]
       },
       "assigneeId": {
         "type": ["null", "integer"],
         "examples": [null, 1234]
       },
       "assigneeUserName": {
         "type": ["null", "string"],
         "examples": [null, "Max Mustermann", "User"]
       },
       "canBeTakenOver": {
         "type": "boolean",
         "examples": ["true"]
       },
       "progressIds": {
         "type": "array",
         "items": {
           "type": "number",
           "examples": ["[]", "1234.1234"]
         }
       },
       "completedProgressIds": {
         "type": "array",
         "items": {
           "type": "number",
           "examples": [[], [1234, 1235]]
         }
       },
       "event": {
         "oneOf": [
           { "type": "null" },
           {
             "type": "object",
             "properties": {
               "id": {
                 "type": "integer",
                 "examples": [1234]
               },
               "name": {
                 "type": ["null", "string"],
                 "examples": [null, "A Name"]
               },
               "comments": {
                 "type": "string",
                 "examples": ["", "comment"]
               },
               "startsAt": {
                 "type": "string",
                 "examples": ["2023-03-14T00:00:00.000Z"]
               },
               "endsAt": {
                 "type": "string",
                 "examples": ["2023-03-16T00:00:00.000Z"]
               },
               "createdAt": {
                 "type": "string",
                 "examples": ["2023-03-14T00:00:00.000Z"]
               },
               "updatedAt": {
                 "type": "string",
                 "examples": ["2023-03-14T00:00:00.000Z"]
               },
               "createdBy": {
                 "type": "integer",
                 "examples": [1234]
               },
               "updatedBy": {
                 "type": "integer",
                 "examples": [1234]
               },
               "createdByUserName": {
                 "type": "string",
                 "examples": ["Max Mustermann"]
               },
               "updatedByUserName": {
                 "type": "string",
                 "examples": ["Max Mustermann"]
               }
             },
             "required": [
               "id",
               "name",
               "comments",
               "startsAt",
               "endsAt",
               "createdAt",
               "updatedAt",
               "createdBy",
               "updatedBy",
               "createdByUserName",
               "updatedByUserName"
             ],
             "unevaluatedProperties": false
           }
         ]
       },
       "recurrence": {
         "oneOf": [
           { "type": "null" },
           {
             "type": "object",
             "properties": {
               "id": {
                 "type": "integer"
               },
               "name": {
                 "type": "string"
               },
               "comments": {
                 "type": "string"
               },
               "startsAt": {
                 "type": "string"
               },
               "endsAt": {
                 "type": "string"
               },
               "repeatsUntil": {
                 "type": "string"
               },
               "rrule": {
                 "type": "object",
                 "properties": {
                   "tzid": {
                     "type": "string"
                   },
                   "rdates": {
                     "type": "array",
                     "items": {
                       "type": "string"
                     }
                   },
                   "rrules": {
                     "type": "array",
                     "items": {
                       "type": "object",
                       "properties": {
                         "end": {
                           "type": "string"
                         },
                         "days": {
                           "type": "array",
                           "items": {
                             "type": "string"
                           }
                         },
                         "time": {
                           "type": "string"
                         },
                         "start": {
                           "type": "string"
                         },
                         "duration": {
                           "type": "string"
                         },
                         "interval": {
                           "type": "integer"
                         },
                         "byweekday": {
                           "type": "array",
                           "items": {
                             "type": "number"
                           }
                         },
                         "bysetpos": {
                           "type": "array",
                           "items": {
                             "type": "number"
                           }
                         },
                         "bymonthday": {
                           "type": "array",
                           "items": {
                             "type": "number"
                           }
                         },
                         "bymonth": {
                           "type": "array",
                           "items": {
                             "type": "number"
                           }
                         },
                         "freq": {
                           "type": "number"
                         }
                       },
                       "required": ["end", "days", "time", "start", "duration", "interval"],
                       "unevaluatedProperties": false
                     }
                   },
                   "exdates": {
                     "type": "array",
                     "items": {
                       "type": "string"
                     }
                   },
                   "exrules": {
                     "type": "array",
                     "items": {
                       "type": "string"
                     }
                   }
                 },
                 "required": ["tzid", "rdates", "rrules", "exdates", "exrules"],
                 "unevaluatedProperties": false
               },
               "createdAt": {
                 "type": "string"
               },
               "updatedAt": {
                 "type": "string"
               },
               "createdBy": {
                 "type": "integer"
               },
               "updatedBy": {
                 "type": "integer"
               },
               "createdByUserName": {
                 "type": "string"
               },
               "updatedByUserName": {
                 "type": "string"
               }
             },
             "required": [
               "id",
               "name",
               "comments",
               "startsAt",
               "endsAt",
               "repeatsUntil",
               "rrule",
               "createdAt",
               "updatedAt",
               "createdBy",
               "updatedBy",
               "createdByUserName",
               "updatedByUserName"
             ],
             "unevaluatedProperties": false
           }
         ]
       },
       "createdAt": {
         "type": "string"
       },
       "updatedAt": {
         "type": "string"
       },
       "createdBy": {
         "type": "integer"
       },
       "createdByUserName": {
         "type": "string"
       },
       "updatedBy": {
         "type": "integer"
       },
       "updatedByUserName": {
         "type": "string"
       },
       "customOrderId": {
         "type": ["null", "string"]
       },
       "tasks": {
         "type": "object",
         "properties": {
           "total": {
             "type": "integer"
           },
           "completed": {
             "type": "integer"
           }
         },
         "required": ["total", "completed"],
         "unevaluatedProperties": false
       },
       "templateOrderName": {
         "type": ["null", "string"],
         "examples": [null, "Template Name"]
       },
       "variables": {
         "type": ["null", "object"],
         "examples": [null, { "color": "blue", "serialNumber": "AB151_S" }]
       },
       "orderInstructionAssignments": {
         "type": "array",
         "items": {
           "type": "object",
           "properties": {
             "id": { "type": "integer" }
           },
           "additionalProperties": true
         }
       },
       "executionMode": {
         "type": "string"
       },
       "archived": {
         "type": "boolean"
       }
     },
     "required": [
       "id",
       "templateId",
       "name",
       "description",
       "comments",
       "priority",
       "automaticCompletion",
       "state",
       "startDate",
       "dueDate",
       "assigneeId",
       "assigneeUserName",
       "canBeTakenOver",
       "progressIds",
       "completedProgressIds",
       "createdAt",
       "updatedAt",
       "createdBy",
       "createdByUserName",
       "updatedBy",
       "updatedByUserName",
       "customOrderId",
       "tasks",
       "templateOrderName",
       "variables",
       "orderInstructionAssignments",
       "executionMode",
       "archived"
     ],
     "unevaluatedProperties": false
   }
 },
 "required": ["version", "fullVersion", "realm", "data"],
 "unevaluatedProperties": false
}

Order published v1

Send when order published

📘

Here is the JSON schema

Click to expand
{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "type": "object",
 "title": "Order published version 1.0",
 "properties": {
   "version": {
     "type": "integer",
     "enum": [1],
     "examples": [1]
   },
   "fullVersion": {
     "type": "string",
     "enum": ["1.0"],
     "examples": ["1.0"]
   },
   "realm": {
     "type": "string",
     "enum": ["order.publish"],
     "examples": ["order.publish"]
   },
   "data": {
     "type": "object",
     "properties": {
       "id": {
         "type": "integer",
         "examples": [1234]
       },
       "templateId": {
         "type": ["null", "integer"],
         "examples": [null, 1234]
       },
       "name": {
         "type": "string",
         "examples": ["New Order"]
       },
       "description": {
         "type": "string",
         "examples": ["A new Order"]
       },
       "comments": {
         "type": "string",
         "examples": ["", "Comments are in here"]
       },
       "priority": {
         "type": "integer",
         "examples": [5]
       },
       "automaticCompletion": {
         "type": "boolean",
         "examples": [true]
       },
       "state": {
         "type": "string",
         "examples": ["in-edit"]
       },
       "startDate": {
         "type": ["null", "string"],
         "examples": ["2023-03-14T00:00:00.000Z"]
       },
       "dueDate": {
         "type": ["string", "null"],
         "examples": ["2023-03-16T00:00:00.000Z"]
       },
       "assigneeId": {
         "type": ["null", "integer"],
         "examples": [null, 1234]
       },
       "assigneeUserName": {
         "type": ["null", "string"],
         "examples": [null, "Max Mustermann", "User"]
       },
       "canBeTakenOver": {
         "type": "boolean",
         "examples": ["true"]
       },
       "progressIds": {
         "type": "array",
         "items": {
           "type": "number",
           "examples": ["[]", "1234.1234"]
         }
       },
       "completedProgressIds": {
         "type": "array",
         "items": {
           "type": "number",
           "examples": [[], [1234, 1235]]
         }
       },
       "event": {
         "oneOf": [
           { "type": "null" },
           {
             "type": "object",
             "properties": {
               "id": {
                 "type": "integer",
                 "examples": [1234]
               },
               "name": {
                 "type": ["null", "string"],
                 "examples": [null, "A Name"]
               },
               "comments": {
                 "type": "string",
                 "examples": ["", "comment"]
               },
               "startsAt": {
                 "type": "string",
                 "examples": ["2023-03-14T00:00:00.000Z"]
               },
               "endsAt": {
                 "type": "string",
                 "examples": ["2023-03-16T00:00:00.000Z"]
               },
               "createdAt": {
                 "type": "string",
                 "examples": ["2023-03-14T00:00:00.000Z"]
               },
               "updatedAt": {
                 "type": "string",
                 "examples": ["2023-03-14T00:00:00.000Z"]
               },
               "createdBy": {
                 "type": "integer",
                 "examples": [1234]
               },
               "updatedBy": {
                 "type": "integer",
                 "examples": [1234]
               },
               "createdByUserName": {
                 "type": "string",
                 "examples": ["Max Mustermann"]
               },
               "updatedByUserName": {
                 "type": "string",
                 "examples": ["Max Mustermann"]
               }
             },
             "required": [
               "id",
               "name",
               "comments",
               "startsAt",
               "endsAt",
               "createdAt",
               "updatedAt",
               "createdBy",
               "updatedBy",
               "createdByUserName",
               "updatedByUserName"
             ],
             "unevaluatedProperties": false
           }
         ]
       },
       "recurrence": {
         "oneOf": [
           { "type": "null" },
           {
             "type": "object",
             "properties": {
               "id": {
                 "type": "integer"
               },
               "name": {
                 "type": "string"
               },
               "comments": {
                 "type": "string"
               },
               "startsAt": {
                 "type": "string"
               },
               "endsAt": {
                 "type": "string"
               },
               "repeatsUntil": {
                 "type": "string"
               },
               "rrule": {
                 "type": "object",
                 "properties": {
                   "tzid": {
                     "type": "string"
                   },
                   "rdates": {
                     "type": "array",
                     "items": {
                       "type": "string"
                     }
                   },
                   "rrules": {
                     "type": "array",
                     "items": {
                       "type": "object",
                       "properties": {
                         "end": {
                           "type": "string"
                         },
                         "days": {
                           "type": "array",
                           "items": {
                             "type": "string"
                           }
                         },
                         "time": {
                           "type": "string"
                         },
                         "start": {
                           "type": "string"
                         },
                         "duration": {
                           "type": "string"
                         },
                         "interval": {
                           "type": "integer"
                         },
                         "byweekday": {
                           "type": "array",
                           "items": {
                             "type": "number"
                           }
                         },
                         "bysetpos": {
                           "type": "array",
                           "items": {
                             "type": "number"
                           }
                         },
                         "bymonthday": {
                           "type": "array",
                           "items": {
                             "type": "number"
                           }
                         },
                         "bymonth": {
                           "type": "array",
                           "items": {
                             "type": "number"
                           }
                         },
                         "freq": {
                           "type": "number"
                         }
                       },
                       "required": ["end", "days", "time", "start", "duration", "interval"],
                       "unevaluatedProperties": false
                     }
                   },
                   "exdates": {
                     "type": "array",
                     "items": {
                       "type": "string"
                     }
                   },
                   "exrules": {
                     "type": "array",
                     "items": {
                       "type": "string"
                     }
                   }
                 },
                 "required": ["tzid", "rdates", "rrules", "exdates", "exrules"],
                 "unevaluatedProperties": false
               },
               "createdAt": {
                 "type": "string"
               },
               "updatedAt": {
                 "type": "string"
               },
               "createdBy": {
                 "type": "integer"
               },
               "updatedBy": {
                 "type": "integer"
               },
               "createdByUserName": {
                 "type": "string"
               },
               "updatedByUserName": {
                 "type": "string"
               }
             },
             "required": [
               "id",
               "name",
               "comments",
               "startsAt",
               "endsAt",
               "repeatsUntil",
               "rrule",
               "createdAt",
               "updatedAt",
               "createdBy",
               "updatedBy",
               "createdByUserName",
               "updatedByUserName"
             ],
             "unevaluatedProperties": false
           }
         ]
       },
       "createdAt": {
         "type": "string"
       },
       "updatedAt": {
         "type": "string"
       },
       "createdBy": {
         "type": "integer"
       },
       "createdByUserName": {
         "type": "string"
       },
       "updatedBy": {
         "type": "integer"
       },
       "updatedByUserName": {
         "type": "string"
       },
       "customOrderId": {
         "type": ["null", "string"]
       },
       "tasks": {
         "type": "object",
         "properties": {
           "total": {
             "type": "integer"
           },
           "completed": {
             "type": "integer"
           }
         },
         "required": ["total", "completed"],
         "unevaluatedProperties": false
       },
       "templateOrderName": {
         "type": ["null", "string"],
         "examples": [null, "Template Name"]
       },
       "variables": {
         "type": ["null", "object"],
         "examples": [null, { "color": "blue", "serialNumber": "AB151_S" }]
       },
       "orderInstructionAssignments": {
         "type": "array",
         "items": {
           "type": "object",
           "properties": {
             "id": { "type": "integer" }
           },
           "additionalProperties": true
         }
       },
       "executionMode": {
         "type": "string"
       },
       "archived": {
         "type": "boolean"
       }
     },
     "required": [
       "id",
       "templateId",
       "name",
       "description",
       "comments",
       "priority",
       "automaticCompletion",
       "state",
       "startDate",
       "dueDate",
       "assigneeId",
       "assigneeUserName",
       "canBeTakenOver",
       "progressIds",
       "completedProgressIds",
       "createdAt",
       "updatedAt",
       "createdBy",
       "createdByUserName",
       "updatedBy",
       "updatedByUserName",
       "customOrderId",
       "tasks",
       "templateOrderName",
       "variables",
       "orderInstructionAssignments",
       "executionMode",
       "archived"
     ],
     "unevaluatedProperties": false
   }
 },
 "required": ["version", "fullVersion", "realm", "data"],
 "unevaluatedProperties": false
}

Order overdue v1

Send when order reached end date while in state:

  • not started
  • in progress
  • problem
  • paused

📘

Here is the JSON schema

Click to expand
{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "type": "object",
 "title": "Order overdue version 1.0",
 "properties": {
   "version": {
     "type": "integer",
     "enum": [1],
     "examples": [1]
   },
   "fullVersion": {
     "type": "string",
     "enum": ["1.0"],
     "examples": ["1.0"]
   },
   "realm": {
     "type": "string",
     "enum": ["order.overdue"],
     "examples": ["order.overdue"]
   },
   "data": {
     "type": "object",
     "properties": {
       "id": {
         "type": "integer",
         "examples": [1234]
       },
       "templateId": {
         "type": ["null", "integer"],
         "examples": [null, 1234]
       },
       "name": {
         "type": "string",
         "examples": ["New Order"]
       },
       "state": {
         "type": "string",
         "examples": ["in-edit"]
       },
       "startDate": {
         "type": ["string", "null"],
         "examples": ["2023-03-14T00:00:00.000Z"]
       },
       "dueDate": {
         "type": ["string", "null"],
         "examples": ["2023-03-16T00:00:00.000Z"]
       },
       "customOrderId": {
         "type": ["null", "string"]
       }
     },
     "required": ["id", "templateId", "name", "state", "startDate", "dueDate", "customOrderId"],
     "unevaluatedProperties": false
   }
 },
 "required": ["version", "fullVersion", "realm", "data"],
 "unevaluatedProperties": false
}

Task updated v1

Send when task updated

📘

Here is the JSON schema

Click to expand
{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "type": "object",
 "title": "Task update version 1",
 "required": ["version", "fullVersion", "realm", "data"],
 "unevaluatedProperties": false,
 "properties": {
   "version": {
     "type": "integer",
     "enum": [1]
   },
   "fullVersion": {
     "type": "string",
     "enum": ["1.0"]
   },
   "realm": {
     "type": "string",
     "enum": ["task.update"]
   },
   "data": {
     "type": "object",
     "required": ["task", "taskChanges"],
     "unevaluatedProperties": false,
     "properties": {
       "task": {
         "type": "object",
         "required": [
           "id",
           "title",
           "systemCreatedBy",
           "systemCreatedByUserName",
           "createdBy",
           "createdByUserName",
           "updatedBy",
           "updatedByUserName",
           "createdAt",
           "updatedAt",
           "rowId",
           "progressId",
           "archived",
           "state",
           "assigneeId",
           "assigneeUserName",
           "priority",
           "dueDate",
           "description",
           "rowHeader",
           "instructionName",
           "progressName",
           "interactionValueId",
           "customExternalClassifier"
         ],
         "unevaluatedProperties": false,
         "properties": {
           "id": {
             "type": "integer"
           },
           "title": {
             "type": "string"
           },
           "systemCreatedBy": {
             "type": "integer"
           },
           "systemCreatedByUserName": {
             "type": "string"
           },
           "createdBy": {
             "type": "integer"
           },
           "createdByUserName": {
             "type": "string"
           },
           "updatedBy": {
             "type": "integer"
           },
           "updatedByUserName": {
             "type": "string"
           },
           "createdAt": {
             "type": "string"
           },
           "updatedAt": {
             "type": "string"
           },
           "rowId": {
             "type": ["null", "integer"]
           },
           "progressId": {
             "type": ["null", "integer"]
           },
           "archived": {
             "type": "boolean"
           },
           "state": {
             "type": "string"
           },
           "assigneeId": {
             "type": ["integer", "null"]
           },
           "assigneeUserName": {
             "type": ["null", "string"]
           },
           "priority": {
             "type": "integer"
           },
           "dueDate": {
             "type": ["string", "null"]
           },
           "description": {
             "type": "string"
           },
           "rowHeader": {
             "type": ["null", "string"]
           },
           "instructionName": {
             "type": ["null", "string"]
           },
           "progressName": {
             "type": ["string", "null"]
           },
           "interactionValueId": {
             "type": ["null", "integer"]
           },
           "customExternalClassifier": {
             "type": "boolean"
           },
           "externalClassifierEntries": {
             "type": "array",
             "items": {
               "type": "object",
               "required": [
                 "id",
                 "name",
                 "externalClassifierId",
                 "externalClassifierName",
                 "data",
                 "createdAt",
                 "updatedAt",
                 "createdBy",
                 "createdByUserName",
                 "updatedBy",
                 "updatedByUserName",
                 "archived"
               ],
               "unevaluatedProperties": false,
               "properties": {
                 "id": {
                   "type": "integer"
                 },
                 "name": {
                   "type": "string"
                 },
                 "externalClassifierId": {
                   "type": "integer"
                 },
                 "externalClassifierName": {
                   "type": "string"
                 },
                 "data": {
                   "type": "object"
                 },
                 "createdAt": {
                   "type": "string"
                 },
                 "updatedAt": {
                   "type": "string"
                 },
                 "createdBy": {
                   "type": ["integer", "null"]
                 },
                 "createdByUserName": {
                   "type": ["string", "null"]
                 },
                 "updatedBy": {
                   "type": ["integer", "null"]
                 },
                 "updatedByUserName": {
                   "type": ["string", "null"]
                 },
                 "archived": {
                   "type": "boolean"
                 }
               }
             }
           },
           "stepId": {
             "type": ["null", "integer"]
           },
           "isSignatureRequestTask": {
             "type": ["null", "boolean"]
           }
         }
       },
       "taskChanges": {
         "type": "array",
         "items": {
           "type": "object",
           "required": ["id", "createdBy", "createdByUserName", "createdAt", "taskId", "type", "comment"],
           "unevaluatedProperties": false,
           "properties": {
             "id": {
               "type": "integer"
             },
             "createdBy": {
               "type": "integer"
             },
             "createdByUserName": {
               "type": "string"
             },
             "createdAt": {
               "type": "string"
             },
             "taskId": {
               "type": "integer"
             },
             "type": {
               "type": "string"
             },
             "comment": {
               "oneOf": [
                 {
                   "type": "object",
                   "properties": {
                     "to": {
                       "oneOf": [
                         {
                           "type": ["number"]
                         },
                         {
                           "type": ["string"]
                         },
                         {
                           "type": ["null"]
                         }
                       ]
                     },
                     "from": {
                       "oneOf": [
                         {
                           "type": ["number"]
                         },
                         {
                           "type": ["string"]
                         },
                         {
                           "type": ["null"]
                         }
                       ]
                     },
                     "field": {
                       "type": "string"
                     }
                   }
                 },
                 {
                   "type": "string"
                 }
               ]
             },
             "toUserName": {
               "type": ["string", "null"]
             },
             "fromUserName": {
               "type": ["string", "null"]
             },
             "taskMedia": {
               "type": ["object", "null"],
               "additionalProperties": false,
               "properties": {
                 "id": {
                   "type": "integer"
                 },
                 "name": {
                   "type": "string"
                 },
                 "taskId": {
                   "type": "integer"
                 },
                 "createdBy": {
                   "type": "integer"
                 },
                 "createdByUserName": {
                   "type": "string"
                 },
                 "createdAt": {
                   "type": "string"
                 },
                 "media": {
                   "type": "object"
                 }
               }
             }
           }
         }
       }
     }
   }
 }
}

Report started v1

Send when report started

📘

Here is the JSON schema

Click to expand
{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "type": "object",
 "title": "Report start version 1",
 "properties": {
   "version": {
     "type": "integer"
   },
   "fullVersion": {
     "type": "string"
   },
   "realm": {
     "type": "string"
   },
   "data": {
     "type": "object",
     "properties": {
       "id": {
         "type": "integer"
       }
     },
     "required": ["id"]
   }
 },
 "required": ["version", "fullVersion", "realm", "data"]
}

Document in review v1 (deprecated)

Send when document is review

📘

Here is the JSON schema

Click to expand
{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "type": "object",
 "title": "Instruction review version 1",
 "properties": {
   "version": {
     "type": "integer",
     "enum": [1]
   },
   "fullVersion": {
     "type": "string",
     "enum": ["1.0"]
   },
   "realm": {
     "type": "string",
     "enum": ["instruction.review"]
   },
   "data": {
     "type": "object",
     "properties": {
       "id": {
         "type": "integer"
       },
       "name": {
         "type": ["string", "null"]
       },
       "version": {
         "type": "string"
       },
       "visible": {
         "type": "boolean"
       },
       "hasVariables": {
         "type": "boolean"
       },
       "state": {
         "type": "string"
       },
       "createdAt": {
         "type": "string"
       },
       "updatedAt": {
         "type": "string"
       },
       "createdBy": {
         "type": "integer"
       },
       "createdByUserName": {
         "type": "string"
       },
       "updatedBy": {
         "type": "integer"
       },
       "updatedByUserName": {
         "type": "string"
       },
       "reviewedAt": {
         "type": ["null", "string"]
       },
       "reviewedBy": {
         "type": ["null", "integer"]
       },
       "reviewedByUserName": {
         "type": ["null", "string"]
       },
       "tags": {
         "type": "array",
         "items": {
           "type": "object",
           "properties": {
             "id": {
               "type": "integer"
             },
             "name": {
               "type": "string"
             },
             "archived": {
               "type": "boolean"
             }
           },
           "required": ["id", "name", "archived"],
           "unevaluatedProperties": false
         }
       },
       "notes": {
         "type": ["string", "null"]
       },
       "changenotes": {
         "type": ["string", "null"]
       },
       "dirty": {
         "type": "boolean"
       },
       "isResolveDirtyVersion": {
         "type": "boolean"
       },
       "validityDate": {
         "type": ["string", "null"]
       },
       "confidentiality": {
         "type": ["string", "null"]
       },
       "availableLocales": {
         "type": "array",
         "items": {
           "type": "object",
           "properties": {
             "instructionId": {
               "type": "integer"
             },
             "localeCode": {
               "type": "string"
             }
           },
           "required": ["instructionId", "localeCode"],
           "unevaluatedProperties": false
         }
       },
       "type": {
         "type": "string"
       },
       "progressHidden": {
         "type": "boolean"
       },
       "baseInstructionId": {
         "type": "integer"
       },
       "numberOfOptionalTextfieldInteractions": {
         "type": "integer"
       },
       "numberOfOptionalKeyValueInteractions": {
         "type": "integer"
       },
       "numberOfOptionalCheckInteractions": {
         "type": "integer"
       },
       "numberOfOptionalConfirmInteractions": {
         "type": "integer"
       },
       "numberOfOptionalNominalActualInteractions": {
         "type": "integer"
       },
       "numberOfOptionalNumberInteractions": {
         "type": "integer"
       },
       "numberOfOptionalImageFeedbackInteractions": {
         "type": "integer"
       },
       "numberOfOptionalVideoFeedbackInteractions": {
         "type": "integer"
       },
       "numberOfOptionalImageAndVideoFeedbackInteractions": {
         "type": "integer"
       },
       "numberOfOptionalSignatureFeedbackInteractions": {
         "type": "integer"
       },
       "numberOfOptionalMultipleChoiceInteractions": {
         "type": "integer"
       },
       "numberOfMandatoryTextfieldInteractions": {
         "type": "integer"
       },
       "numberOfMandatoryKeyValueInteractions": {
         "type": "integer"
       },
       "numberOfMandatoryCheckInteractions": {
         "type": "integer"
       },
       "numberOfMandatoryConfirmInteractions": {
         "type": "integer"
       },
       "numberOfMandatoryNominalActualInteractions": {
         "type": "integer"
       },
       "numberOfMandatoryNumberInteractions": {
         "type": "integer"
       },
       "numberOfMandatoryImageFeedbackInteractions": {
         "type": "integer"
       },
       "numberOfMandatoryVideoFeedbackInteractions": {
         "type": "integer"
       },
       "numberOfMandatoryImageAndVideoFeedbackInteractions": {
         "type": "integer"
       },
       "numberOfMandatorySignatureFeedbackInteractions": {
         "type": "integer"
       },
       "numberOfMandatoryMultipleChoiceInteractions": {
         "type": "integer"
       },
       "numberOfPartInteractions": {
         "type": "integer"
       },
       "acceptChangenotes": {
         "type": "boolean"
       },
       "numberOfLinkInteractions": {
         "type": "integer"
       },
       "numberOfOptionalExternalRequestInteractions": {
         "type": "integer"
       },
       "numberOfMandatoryExternalRequestInteractions": {
         "type": "integer"
       },
       "numberOfDescriptionInteractions": {
         "type": "integer"
       }
     },
     "required": [
       "id",
       "name",
       "version",
       "visible",
       "hasVariables",
       "state",
       "createdAt",
       "updatedAt",
       "createdBy",
       "createdByUserName",
       "updatedBy",
       "updatedByUserName",
       "reviewedAt",
       "reviewedBy",
       "reviewedByUserName",
       "tags",
       "notes",
       "changenotes",
       "dirty",
       "isResolveDirtyVersion",
       "validityDate",
       "confidentiality",
       "availableLocales",
       "type",
       "progressHidden",
       "baseInstructionId",
       "numberOfOptionalTextfieldInteractions",
       "numberOfOptionalKeyValueInteractions",
       "numberOfOptionalCheckInteractions",
       "numberOfOptionalConfirmInteractions",
       "numberOfOptionalNominalActualInteractions",
       "numberOfOptionalNumberInteractions",
       "numberOfOptionalImageFeedbackInteractions",
       "numberOfOptionalVideoFeedbackInteractions",
       "numberOfOptionalImageAndVideoFeedbackInteractions",
       "numberOfOptionalSignatureFeedbackInteractions",
       "numberOfOptionalMultipleChoiceInteractions",
       "numberOfMandatoryTextfieldInteractions",
       "numberOfMandatoryKeyValueInteractions",
       "numberOfMandatoryCheckInteractions",
       "numberOfMandatoryConfirmInteractions",
       "numberOfMandatoryNominalActualInteractions",
       "numberOfMandatoryNumberInteractions",
       "numberOfMandatoryImageFeedbackInteractions",
       "numberOfMandatoryVideoFeedbackInteractions",
       "numberOfMandatoryImageAndVideoFeedbackInteractions",
       "numberOfMandatorySignatureFeedbackInteractions",
       "numberOfMandatoryMultipleChoiceInteractions",
       "numberOfPartInteractions",
       "acceptChangenotes",
       "numberOfLinkInteractions",
       "numberOfOptionalExternalRequestInteractions",
       "numberOfMandatoryExternalRequestInteractions",
       "numberOfDescriptionInteractions"
     ],
     "unevaluatedProperties": false
   }
 },
 "required": ["version", "fullVersion", "realm", "data"],
 "unevaluatedProperties": false
}

Order completed v1 (deprecated)

Send when order is completed

📘

Here is the JSON schema

Click to expand
{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "type": "object",
 "title": "Order complete version 1",
 "properties": {
   "version": {
     "type": "integer",
     "enum": [1]
   },
   "fullVersion": {
     "type": "string",
     "enum": ["1.1"]
   },
   "realm": {
     "type": "string",
     "enum": ["order.complete"]
   },
   "data": {
     "type": "object",
     "properties": {
       "id": {
         "type": "integer"
       },
       "templateId": {
         "type": ["null", "integer"]
       },
       "name": {
         "type": "string"
       },
       "description": {
         "type": "string"
       },
       "comments": {
         "type": "string"
       },
       "priority": {
         "type": "integer"
       },
       "automaticCompletion": {
         "type": "boolean"
       },
       "state": {
         "type": "string",
         "enum": ["done"]
       },
       "startDate": {
         "type": "string"
       },
       "dueDate": {
         "type": ["string", "null"]
       },
       "assigneeId": {
         "type": ["null", "integer"]
       },
       "assigneeUserName": {
         "type": ["null", "string"]
       },
       "canBeTakenOver": {
         "type": "boolean"
       },
       "instructions": {
         "type": "array",
         "items": {
           "type": "object",
           "properties": {
             "id": { "type": "integer" }
           },
           "additionalProperties": true
         }
       },
       "progressIds": {
         "type": "array",
         "items": {
           "type": "number"
         }
       },
       "completedProgressIds": {
         "type": "array",
         "items": {
           "type": "number"
         }
       },
       "event": {
         "oneOf": [
           { "type": "null" },
           {
             "type": "object",
             "properties": {
               "id": {
                 "type": "integer"
               },
               "name": {
                 "type": ["null", "string"]
               },
               "comments": {
                 "type": "string"
               },
               "startsAt": {
                 "type": "string"
               },
               "endsAt": {
                 "type": "string"
               },
               "createdAt": {
                 "type": "string"
               },
               "updatedAt": {
                 "type": "string"
               },
               "createdBy": {
                 "type": "integer"
               },
               "updatedBy": {
                 "type": "integer"
               },
               "createdByUserName": {
                 "type": "string"
               },
               "updatedByUserName": {
                 "type": "string"
               }
             },
             "required": [
               "id",
               "name",
               "comments",
               "startsAt",
               "endsAt",
               "createdAt",
               "updatedAt",
               "createdBy",
               "updatedBy",
               "createdByUserName",
               "updatedByUserName"
             ],
             "unevaluatedProperties": false
           }
         ]
       },
       "recurrence": {
         "oneOf": [
           { "type": "null" },
           {
             "type": "object",
             "properties": {
               "id": {
                 "type": "integer"
               },
               "name": {
                 "type": "string"
               },
               "comments": {
                 "type": "string"
               },
               "startsAt": {
                 "type": "string"
               },
               "endsAt": {
                 "type": "string"
               },
               "repeatsUntil": {
                 "type": "string"
               },
               "rrule": {
                 "type": "object",
                 "properties": {
                   "tzid": {
                     "type": "string"
                   },
                   "rdates": {
                     "type": "array",
                     "items": {
                       "type": "string"
                     }
                   },
                   "rrules": {
                     "type": "array",
                     "items": {
                       "type": "object",
                       "properties": {
                         "end": {
                           "type": "string"
                         },
                         "days": {
                           "type": "array",
                           "items": {
                             "type": "string"
                           }
                         },
                         "time": {
                           "type": "string"
                         },
                         "start": {
                           "type": "string"
                         },
                         "duration": {
                           "type": "string"
                         },
                         "interval": {
                           "type": "integer"
                         },
                         "byweekday": {
                           "type": "array",
                           "items": {
                             "type": "number"
                           }
                         },
                         "bysetpos": {
                           "type": "array",
                           "items": {
                             "type": "number"
                           }
                         },
                         "bymonthday": {
                           "type": "array",
                           "items": {
                             "type": "number"
                           }
                         },
                         "bymonth": {
                           "type": "array",
                           "items": {
                             "type": "number"
                           }
                         },
                         "freq": {
                           "type": "number"
                         }
                       },
                       "required": ["end", "time", "start", "duration", "interval"],
                       "unevaluatedProperties": false
                     }
                   },
                   "exdates": {
                     "type": "array",
                     "items": {
                       "type": "string"
                     }
                   },
                   "exrules": {
                     "type": "array",
                     "items": {
                       "type": "string"
                     }
                   }
                 },
                 "required": ["tzid", "rdates", "rrules", "exdates", "exrules"],
                 "unevaluatedProperties": false
               },
               "createdAt": {
                 "type": "string"
               },
               "updatedAt": {
                 "type": "string"
               },
               "createdBy": {
                 "type": "integer"
               },
               "updatedBy": {
                 "type": "integer"
               },
               "createdByUserName": {
                 "type": "string"
               },
               "updatedByUserName": {
                 "type": "string"
               }
             },
             "required": [
               "id",
               "name",
               "comments",
               "startsAt",
               "endsAt",
               "repeatsUntil",
               "rrule",
               "createdAt",
               "updatedAt",
               "createdBy",
               "updatedBy",
               "createdByUserName",
               "updatedByUserName"
             ],
             "unevaluatedProperties": false
           }
         ]
       },
       "createdAt": {
         "type": "string"
       },
       "updatedAt": {
         "type": "string"
       },
       "createdBy": {
         "type": "integer"
       },
       "createdByUserName": {
         "type": "string"
       },
       "updatedBy": {
         "type": "integer"
       },
       "updatedByUserName": {
         "type": "string"
       },
       "customOrderId": {
         "type": ["null", "string"]
       },
       "tasks": {
         "type": "object",
         "properties": {
           "total": {
             "type": "integer"
           },
           "completed": {
             "type": "integer"
           }
         },
         "required": ["total", "completed"]
       },
       "templateOrderName": {
         "type": ["null", "string"]
       },
       "variables": {
         "type": ["null", "object"]
       },
       "orderInstructionAssignments": {
         "type": "array",
         "items": {
           "type": "object",
           "properties": {
             "id": { "type": "integer" }
           },
           "additionalProperties": true
         }
       },
       "executionMode": {
         "type": "string"
       },
       "archived": {
         "type": "boolean"
       }
     },
     "required": [
       "id",
       "templateId",
       "name",
       "description",
       "comments",
       "priority",
       "automaticCompletion",
       "state",
       "startDate",
       "dueDate",
       "assigneeId",
       "assigneeUserName",
       "canBeTakenOver",
       "instructions",
       "progressIds",
       "completedProgressIds",
       "createdAt",
       "updatedAt",
       "createdBy",
       "createdByUserName",
       "updatedBy",
       "updatedByUserName",
       "customOrderId",
       "tasks",
       "templateOrderName",
       "variables",
       "orderInstructionAssignments",
       "executionMode",
       "archived"
     ],
     "unevaluatedProperties": false
   }
 },
 "required": ["version", "fullVersion", "realm", "data"],
 "unevaluatedProperties": false
}

Order created v1 (deprecated)

Send when order created

📘

Here is the JSON schema

Click to expand
{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "type": "object",
 "title": "Order create version 1",
 "properties": {
   "version": {
     "type": "integer",
     "enum": [1]
   },
   "fullVersion": {
     "type": "string",
     "enum": ["1.1"]
   },
   "realm": {
     "type": "string",
     "enum": ["order.create"]
   },
   "data": {
     "type": "object",
     "properties": {
       "id": {
         "type": "integer"
       },
       "templateId": {
         "type": ["null", "integer"]
       },
       "name": {
         "type": "string"
       },
       "description": {
         "type": "string"
       },
       "comments": {
         "type": "string"
       },
       "priority": {
         "type": "integer"
       },
       "automaticCompletion": {
         "type": "boolean"
       },
       "state": {
         "type": "string"
       },
       "startDate": {
         "type": "string"
       },
       "dueDate": {
         "type": ["string", "null"]
       },
       "assigneeId": {
         "type": ["null", "integer"]
       },
       "assigneeUserName": {
         "type": ["null", "string"]
       },
       "canBeTakenOver": {
         "type": "boolean"
       },
       "instructions": {
         "type": "array",
         "items": {
           "type": "object",
           "properties": {
             "id": { "type": "integer" }
           },
           "additionalProperties": true
         }
       },
       "progressIds": {
         "type": "array",
         "items": {
           "type": "number"
         }
       },
       "completedProgressIds": {
         "type": "array",
         "items": {
           "type": "number"
         }
       },
       "event": {
         "oneOf": [
           { "type": "null" },
           {
             "type": "object",
             "properties": {
               "id": {
                 "type": "integer"
               },
               "name": {
                 "type": ["null", "string"]
               },
               "comments": {
                 "type": "string"
               },
               "startsAt": {
                 "type": "string"
               },
               "endsAt": {
                 "type": "string"
               },
               "createdAt": {
                 "type": "string"
               },
               "updatedAt": {
                 "type": "string"
               },
               "createdBy": {
                 "type": "integer"
               },
               "updatedBy": {
                 "type": "integer"
               },
               "createdByUserName": {
                 "type": "string"
               },
               "updatedByUserName": {
                 "type": "string"
               }
             },
             "required": [
               "id",
               "name",
               "comments",
               "startsAt",
               "endsAt",
               "createdAt",
               "updatedAt",
               "createdBy",
               "updatedBy",
               "createdByUserName",
               "updatedByUserName"
             ],
             "unevaluatedProperties": false
           }
         ]
       },
       "recurrence": {
         "oneOf": [
           { "type": "null" },
           {
             "type": "object",
             "properties": {
               "id": {
                 "type": "integer"
               },
               "name": {
                 "type": "string"
               },
               "comments": {
                 "type": "string"
               },
               "startsAt": {
                 "type": "string"
               },
               "endsAt": {
                 "type": "string"
               },
               "repeatsUntil": {
                 "type": "string"
               },
               "rrule": {
                 "type": "object",
                 "properties": {
                   "tzid": {
                     "type": "string"
                   },
                   "rdates": {
                     "type": "array",
                     "items": {
                       "type": "string"
                     }
                   },
                   "rrules": {
                     "type": "array",
                     "items": {
                       "type": "object",
                       "properties": {
                         "end": {
                           "type": "string"
                         },
                         "days": {
                           "type": "array",
                           "items": {
                             "type": "string"
                           }
                         },
                         "time": {
                           "type": "string"
                         },
                         "start": {
                           "type": "string"
                         },
                         "duration": {
                           "type": "string"
                         },
                         "interval": {
                           "type": "integer"
                         },
                         "byweekday": {
                           "type": "array",
                           "items": {
                             "type": "number"
                           }
                         },
                         "bysetpos": {
                           "type": "array",
                           "items": {
                             "type": "number"
                           }
                         },
                         "bymonthday": {
                           "type": "array",
                           "items": {
                             "type": "number"
                           }
                         },
                         "bymonth": {
                           "type": "array",
                           "items": {
                             "type": "number"
                           }
                         },
                         "freq": {
                           "type": "number"
                         }
                       },
                       "required": ["end", "time", "start", "duration", "interval"],
                       "unevaluatedProperties": false
                     }
                   },
                   "exdates": {
                     "type": "array",
                     "items": {
                       "type": "string"
                     }
                   },
                   "exrules": {
                     "type": "array",
                     "items": {
                       "type": "string"
                     }
                   }
                 },
                 "required": ["tzid", "rdates", "rrules", "exdates", "exrules"],
                 "unevaluatedProperties": false
               },
               "createdAt": {
                 "type": "string"
               },
               "updatedAt": {
                 "type": "string"
               },
               "createdBy": {
                 "type": "integer"
               },
               "updatedBy": {
                 "type": "integer"
               },
               "createdByUserName": {
                 "type": "string"
               },
               "updatedByUserName": {
                 "type": "string"
               }
             },
             "required": [
               "id",
               "name",
               "comments",
               "startsAt",
               "endsAt",
               "repeatsUntil",
               "rrule",
               "createdAt",
               "updatedAt",
               "createdBy",
               "updatedBy",
               "createdByUserName",
               "updatedByUserName"
             ],
             "unevaluatedProperties": false
           }
         ]
       },
       "createdAt": {
         "type": "string"
       },
       "updatedAt": {
         "type": "string"
       },
       "createdBy": {
         "type": "integer"
       },
       "createdByUserName": {
         "type": "string"
       },
       "updatedBy": {
         "type": "integer"
       },
       "updatedByUserName": {
         "type": "string"
       },
       "customOrderId": {
         "type": ["null", "string"]
       },
       "tasks": {
         "type": "object",
         "properties": {
           "total": {
             "type": "integer"
           },
           "completed": {
             "type": "integer"
           }
         },
         "required": ["total", "completed"]
       },
       "templateOrderName": {
         "type": ["null", "string"]
       },
       "variables": {
         "type": ["null", "object"]
       },
       "orderInstructionAssignments": {
         "type": "array",
         "items": {
           "type": "object",
           "properties": {
             "id": { "type": "integer" }
           },
           "additionalProperties": true
         }
       },
       "executionMode": {
         "type": "string"
       },
       "archived": {
         "type": "boolean"
       }
     },
     "required": [
       "id",
       "templateId",
       "name",
       "description",
       "comments",
       "priority",
       "automaticCompletion",
       "state",
       "startDate",
       "dueDate",
       "assigneeId",
       "assigneeUserName",
       "canBeTakenOver",
       "instructions",
       "progressIds",
       "completedProgressIds",
       "createdAt",
       "updatedAt",
       "createdBy",
       "createdByUserName",
       "updatedBy",
       "updatedByUserName",
       "customOrderId",
       "tasks",
       "templateOrderName",
       "variables",
       "orderInstructionAssignments",
       "executionMode",
       "archived"
     ],
     "unevaluatedProperties": false
   }
 },
 "required": ["version", "fullVersion", "realm", "data"],
 "unevaluatedProperties": false
}