Notifications

Notifications are the maintenance events raised against your network: a fault reported, an inspection finding, or a request for work on a particular asset. Each notification records what needs attention and carries the surrounding work-order metadata, so the platform can track maintenance activity alongside the assets it affects.

At a glance

• Represents: a maintenance notification raised against an asset
• Body: a JSON array of notification objects
• Keyed by: id — your external identifier, and the upsert key
• Belongs to: an asset (assetId)
• References: the shared geolocation concept

Tip

The full field list, required vs. optional flags, and a runnable example payload are in the API Reference under Notification Import.

What it represents

A notification describes a maintenance event and its lifecycle:

• Status (for example, Active) and descriptive text — a name, type, and short and long descriptions — that say what the event is about.
• Work-order metadata from your source maintenance system: the responsible department, priority and classification, planner group and work centre, the functional location, order type and code, and the system and user statuses that track progress.
• Dates that frame the work: start and end, the desired repair date, and the required end date, plus the source creation and update timestamps.

Where the event sits on the network is described through the shared geolocation concept.

Linking to assets

A notification is most useful when it’s tied to the thing it concerns. Set assetId to the identifier of the asset the notification relates to, so the event shows up against that asset and rolls up with its maintenance history. Since this references an identifier you’ve already imported, import (or define) the asset before or alongside the notifications that point at it.

The status field is required. id and assetId are optional in the schema, but you’ll almost always want both: id so the notification can be updated later, and assetId so it’s linked to its asset.

Using it

• Keep id stable across imports — re-sending a notification with an existing id updates it in place, while a new id creates a new record.
• Set assetId to an asset you’ve already imported; a reference the platform doesn’t recognise passes request validation but surfaces later at job time — see Common Errors.
• Provide whatever work-order metadata your source system knows; the fields are optional.