Skip to content
plugboard.appRequest a demo

Reference

Events

One set of events drives three things: the toasts in the console, the realtime stream, and outbound webhooks.

Field
typeThe event type, listed below
messageA short human-readable line, shown in the toast
permissionThe permission a person must hold to be sent this event
siteIdThe site the event belongs to, where it belongs to one
stickyWhether the toast stays until dismissed
dataStructured payload: ids, loan number, person name
atISO timestamp

A repair is a submission in the event types.

TypeFires when
submission.createdA repair is lodged. Sticky when lodged by a client
submission.statusIts status changes
submission.vendorIt is sent to, or updated by, an external repair vendor
part.reorderA part in the parts catalogue reaches its reorder level, through a repair that used it or a change to its stock or level. Sticky
TypeFires when
ticket.createdA ticket is raised
ticket.statusIts status changes
ticket.commentA reply or an internal note is added. The note version is sent only to people who can read internal notes
ticket.actionAn action run on a ticket sends the desk a notice
ticket.mergedTwo tickets are merged
ticket.unmergedA merged ticket is separated again
ticket.escalatedA ticket is escalated or de-escalated to somebody. Sent only to the person it is handed to, and opens the ticket
TypeFires when
loan.assignedA loan is issued
loan.returnedA loan comes back
loan.awaitingEraseA returned loan device is held until it is erased, because its loan group holds for erase. Sent only to people with device.wipe.request at the loan’s campus; not sticky. Names the loan, never the borrower
loan.registeredA device is added to a pool
loan.removedA device is removed
loan.bulkA bulk action runs
loan.syncedA pool syncs from an MDM smart group
TypeFires when
device.sync.partialA fleet sync from an MDM finishes, but some devices could not be recorded
device.sync.failedA fleet sync from an MDM fails. Sticky
device.wipeAn erase is requested for a device, and again when it is sent. Sticky, to everyone who can see the device
device.lapsA local administrator password is read. Sticky, and sent only to people with device.laps.read
fleet.healthA fleet health scan finds devices that need attention
TypeFires when
sla.breachA response or resolution target is missed. One shot per item
automation.matchA flow’s Notify the desk step raised an alert about a repair or another record that is not a ticket
TypeFires when
monitor.upA monitored service recovers
monitor.downIt goes down
monitor.alertAn alert threshold is reached, or a directory sync needs attention. Also, when a monitor goes down, the changes made near it in the last 72 hours, sent only to people with change.view
service.statusA service’s status changes in any way, planned work starting or ending included. Sent to people with service.view to keep the desk current, without a toast of its own, because its monitors raise their own. Its data carries the service’s id, its status and the status before, from
service.downA service reads Down or Having problems after reading anything else. Sent the same way, without a toast. Its data carries serviceId, name, status and from
service.upA service that was Down or Having problems reads Working. Sent the same way, with the same data
dns.recordChangedA watched DNS record changes
dns.expiringA watched domain or certificate is about to expire
network.syncedA refresh from the network connectors finishes
TypeFires when
backup.successA backup completes
backup.failedOne does not
TypeFires when
kiosk.requestAn assistance request is raised at the kiosk
kiosk.resolvedIt is approved or denied
security.resolvedA security approval request is decided
TypeFires when
identity.actionAn identity action, such as an MFA reset or a sign-out, is taken on an account. Sent only to people with identity.view

In the console. Automatic. This is what makes the desk update itself.

In your own system. Register an outbound webhook. Signed with HMAC-SHA256, and you can filter to specific types.

In a browser client of your own. Subscribe to /api/events with EventSource, inside an authenticated session.

ticket.comment fires for internal notes too, but not to everybody. A note generates an event carrying the ticket.internal permission, so only people who could read the note are told one was added. It still never sends an email. The note’s text is never in the event either way.

sla.breach fires once per item. A breach that stays breached does not generate a new event every minute.

Order is not guaranteed. Two events fired close together can arrive in either order at a webhook receiver. Build for that.

Three filters are applied in order, and all three must pass.

Tenant. A subscriber receives only their own tenant’s events.

Permission. Every event names the permission that governs the record behind it: a repair event carries repair.view, a kiosk event client.view, a local administrator password retrieval device.laps.read. Somebody who could not open the record is not told about it. A role holding * passes this check for everything. The permission keys are listed in permissions.

Site. Where the event belongs to a site, only people whose access covers that site receive it. Somebody with no site restriction receives all of them.

Some events belong to no single site: a backup result, a monitor alert, a fleet-wide sync, a bulk loan checkout. Those are treated as unassigned, so people restricted to a site do not receive them. The alternative would be telling every campus about every other campus.

An outbound webhook endpoint is configured per school by an administrator, not per person, so there is nobody to check a permission against. Endpoints receive every event for their tenant, filtered only by the types you selected when you registered them.