Available for
- Roles: Administrator
- Plans: Starter, Premium, On demand
The maintenance plan via external trigger (API) allows you to automatically create maintenance tasks from external systems. Unlike time-based or task-completion plans, this type of plan is triggered by an event, rule, or external data.
It is a key building block for automating maintenance from your existing tools: industrial controllers, ERP systems, cloud platforms, IoT sensors, or other business systems.
How It Works
When a maintenance plan via API is configured:
- an external system calls the Mobility Work API;
- this call triggers a predefined maintenance plan in Mobility Work;
- Mobility Work automatically creates the task associated with the plan;
- the generated task then follows the standard lifecycle (assignment, execution, completion).
The trigger does not depend on a fixed date, task completion, or meter reading entered in the app, but solely on the external event calling the API.
Main Plan Parameters
A maintenance plan via API requires few parameters on the Mobility Work side:
- Maintenance plan: central configuration (checklist, assignees, tags, equipment, etc.);
- Plan ID: used by the external system to trigger task creation.
All triggering logic (rules, calculations) is handled outside Mobility Work in the calling system.
Common Scenario Examples
Example 1: Preventive Maintenance Triggered by a Controller
An industrial controller has internal diagnostic logic capable of anticipating degradation or an upcoming fault.
- A critical threshold is reached.
- The controller calls the Mobility Work API.
- The corresponding maintenance plan is triggered.
- A preventive maintenance task is automatically created.
This allows intervention before failure and reduces downtime.
Example 2: Trigger from a Simple Tool (Excel, Script, Cloud)
Even without a complex industrial system, an API trigger can be used.
- An Excel file contains readings or calculated indicators.
- A script or cloud service (AWS, Azure, etc.) detects a specific condition.
- The API is called to trigger the maintenance plan.
This scenario provides great flexibility for heterogeneous environments.
Example 3: Maintenance Triggered by a Business Event
A business event may require a maintenance intervention.
- Equipment is moved, reconfigured, or put back into service.
- The business system (ERP, upstream CMMS, internal tool) calls the API.
- A maintenance task for inspection or compliance is automatically created.
This type of trigger is useful when maintenance depends on operational actions rather than time or usage.
Behavior of Generated Tasks
Tasks created via an API maintenance plan:
- are generated on demand, only when an API call is made;
- are all linked to the same maintenance plan, simplifying tracking;
- behave exactly like tasks from other types of plans (fixed-date, task-completion, or meter-based).
There is no functional limit to the number or frequency of triggers as long as the API is called.
For time-based or task-completion scheduling, see the dedicated articles on fixed-date maintenance plans and task-completion plans in the help center.