Additional Fees Apply
Event Plugin
Events refer to data captured by Corrigo Enterprise in the course of core workflow. Event data may be generated by an end user (a Technician that invokes "Check In" procedure, for example), or by system actor. Event Notifications describes the sub-system used by advanced integrated systems to tap into this event stream - in real time - using a simple JSON-based API. Two components make up Event Notifications: the Event Plugin and the Event Service.
Event Plugins are installed at Corrigo, by Corrigo Integration Services, and they are registered for specific Companies. This registration process includes URL information about the presence of the Event Service to which this plugin is connected.
Event Service describes a simple REST/JSON service hosted outside of Corrigo, on a web server that is (usually, not always) on same local network as the external interfaces required to complete the integration. The Event Service receives a single message type, the EventNotification Class, which carries relevant data about the event. The "last mile" of the integration occurs after these Events are forwarded to the target system API.
| Event Category | Event Category Description | Triggered by Action Type |
|---|---|---|
| Status | WO status is changed | WOActionType.Create, WOActionType.PickUp, WOActionType.Start (Check-In) WOActionType.OnHold, WOActionType.Complete, WOActionType.Cancel, WOActionType.Reopen, WOActionType.Stop (Check-Out) |
| Updates | Flag is Set Flag is Cleared WO is assigned/reassigned WO is Verified Scheduled Start updated | WOActionType.Attention WOActionType.FlagCleared WOActionType.Assign WOActionType.Verified WOActionType.SchedStartChanged |
| Financial Status | Change to Vendor Invoice Status Change to Internal Cost Status | WOActionType.APInvStatus WOActionType.CostStatus |
| Quote Status | Quote workflow | WOActionType.QuoteRequested WOActionType.QuoteSubmitted WOActionType.QuoteApproved WOActionType.QuoteRejected |
| Note Update | WO Note is added/updated | WOActionType.Note |
| Estimate Approval | WO estimate changed | WOActionType.EstimateApproved WOActionType.EstimateRejected |
| Owner Update | WO user replaced | WOActionType.OwnerChanged |
| Document Attach | Attach document to WorkOrder | WOActionType.WonDocAttach |
Sample Payloads
WOActionType.Note
{
"WoNote": {
"Id": 269648,
"WoId": 198494,
"WoNumber": "CHSA33414764",
"Body": "Testing",
"CreatedByDisplayAs": "System Administrator",
"NoteDate": "2021-04-28T05:42:07",
"NoteTypeId": "Public"
},
"TypeId": 17
}
WOActionType.Create
{
"WorkOrder": {
"Id": 198501,
"WoActionLog": {
"ActionDate": "2021-04-28T07:13:05.05",
"SystemDateUtc": "2021-04-28T12:13:05.05",
"ActorTypeId": "CorrigoNet",
"ActorDisplayAs": "PMRM Module",
"TypeId": "Create",
"UiTypeId": "System"
}
},
"TypeId": 1
}