Skip to main content

MaintainX Integration Guide

Connect MachineMetrics to MaintainX to automatically create work orders and update meters from your shop floor data.

Overview​

The MachineMetrics and MaintainX integration creates a streamlined connection between front line workers and your maintenance team by automatically creating work orders and updating meters in MaintainX through MachineMetrics Workflows.

Integration Type​

AttributeValue
DirectionOne-Way (MachineMetrics → MaintainX)
Data FlowWork requests, work orders, and meter updates TO MaintainX
MethodWebhooks via MachineMetrics Workflows
TypeCMMS (Computerized Maintenance Management System)

Note: This integration requires the Premium tier of MaintainX for work orders and the Enterprise tier for metering.

Integration Features​

FeatureDescription
Create Work RequestsAutomatically create MaintainX work requests from MachineMetrics alarms, downtimes, or manually triggered workflows
Create Work OrdersGenerate work orders directly when maintenance is needed
Update MetersPush any MachineMetrics data item to any MaintainX meter you configure in the Integration Manager

Requirements​

Prerequisites​

RequirementDetails
MaintainX TierPremium (work orders) or Enterprise (metering)
MachineMetrics API KeyWith Reporting scope
MaintainX JWTGenerated from MaintainX Integrations page
Secret KeyUser-created password for webhook authentication

Step-by-Step Setup Guide​

Initial Configuration​

Step 1: Access the Integration Portal​

  1. In MachineMetrics, navigate to the Integration Portal
  2. Select the MaintainX integration
  3. Click Authorize

Step 2: Enter MachineMetrics API Key​

  1. Go to Settings → API Keys in MachineMetrics
  2. Click Create API Key
  3. Check the Reporting scope box
  4. Copy the API key
  5. Paste it into Enter MachineMetrics API Key in the integration portal

Step 3: Enter MaintainX JWT​

  1. Navigate to the Integrations page in MaintainX
  2. Click New Key
  3. Name and generate the key
  4. Copy the JWT
  5. Paste it into Enter MaintainX JWT in the integration portal

Step 4: Create a Secret Key​

  1. Create your own secret password
  2. Enter it in the integration portal
  3. Record this secret for later use when configuring workflows

Map Assets: MachineMetrics and MaintainX​

This integration uses a custom MaintainX field (MMid) to match MachineMetrics machines with their MaintainX asset equivalents.

Configure via MaintainX Integration Manager​

Use the MaintainX Integration Manager in Labs to verify credentials, create the MMid field, and map assets:

  1. In MachineMetrics, go to Labs
  2. Search for MaintainX Integration Manager and open it
  3. If no error appears, your credentials (API key, MaintainX JWT, and secret) are configured correctly
  4. Opening this UI automatically creates the MMid custom field in MaintainX (if it does not already exist)
  5. Click Map to link each MachineMetrics machineId with the corresponding MaintainX asset

After mapping, refresh MaintainX and confirm the MMid field appears on your assets with the correct values.

Note: Do not use the legacy /setup webhook to create the MMid field. Asset setup is handled entirely through the Integration Manager.

Create Work Requests/Orders in MaintainX​

Setting Up the Workflow​

  1. Go to Workflows under Automations in MachineMetrics

  2. Click New Workflow

  3. Name your workflow (e.g., "Create MaintainX Work Order")

  4. Set a trigger type:

    • Downtime — Create work order when machine goes down
    • Alarm — Create work order when specific alarm fires
    • Manual — Create work order on-demand

  5. Select Webhook as the Action

  6. Set Delay = 0 for immediate triggering

  7. In Enter URL, add one of the following:

    ActionURL
    Work Requesthttps://maintainx.svc.machinemetrics.com/WorkRequest
    Work Orderhttps://maintainx.svc.machinemetrics.com/WorkOrder

  8. In Enter Secret, click Create New and enter your secret

  9. Click Save Changes

How It Works​

When triggered, this workflow automatically creates a corresponding work request or order in MaintainX with:

  • Machine information
  • Alarm or downtime details
  • Timestamp
  • Any relevant context from MachineMetrics

Update MaintainX Meters​

Automatically keep your MaintainX meters up to date with shop floor data from MachineMetrics.

Map Meters in the Integration Manager​

In Labs → MaintainX Integration Manager, map each MaintainX meter to the MachineMetrics data item that should drive it. You can map any data item to any meter in MaintainX—not only hours and cycles.

Complete asset mapping (see Map Assets) before configuring meter mappings.

Common mappings (examples, not requirements)​

Many shops use Hours and Cycles meters in MaintainX. When you map those meter types (or equivalent data items), they typically align with these MachineMetrics sources:

MaintainX meterMachineMetrics data source
HoursTotal in-cycle time
CyclesCycle count (parts produced)

These pairings are a common starting point, not a restriction. You can map other data items—runtime, utilization, custom signals, and more—to whichever MaintainX meters fit your maintenance program.

Set Up the Meter Webhook Trigger​

Meter mappings are applied when a workflow calls the Meter endpoint. Configure the trigger in Automations:

  1. Go to Automations → Workflows → New Workflow
  2. Name your workflow (e.g., "Update MaintainX Meters")
  3. Configure the trigger:
    • Scheduled is recommended (e.g., daily at end of shift)
  4. Set the Action to Webhook
  5. Set Delay = 0 for immediate triggering
  6. In Enter URL, use: 
    https://maintainx.svc.machinemetrics.com/Meter
  7. Enter your secret (same secret used during integration authorization)
  8. Save the workflow

When the workflow runs, each mapped meter in MaintainX is updated with the latest value from its linked MachineMetrics data item.

Example Workflows​

Workflow 1: Create Work Order on Alarm​

Use case: Automatically notify maintenance when a critical alarm occurs.

SettingValue
NameCritical Alarm → MaintainX Work Order
TriggerAlarm
Alarm FilterSpecific alarm codes (e.g., "Spindle Overtemp")
ActionWebhook
URLhttps://maintainx.svc.machinemetrics.com/WorkOrder
Delay0

Workflow 2: Create Work Request on Extended Downtime​

Use case: Alert maintenance when a machine is down for more than 30 minutes.

SettingValue
NameExtended Downtime → MaintainX Request
TriggerDowntime
Downtime Duration> 30 minutes
ActionWebhook
URLhttps://maintainx.svc.machinemetrics.com/WorkRequest
Delay0

Workflow 3: Scheduled Meter Sync​

Use case: Push mapped MachineMetrics data items to MaintainX meters on a schedule (configure mappings in the Integration Manager first).

SettingValue
NameScheduled Meter Sync to MaintainX
TriggerScheduled
ScheduleDaily at 11:00 PM (adjust to your needs)
ActionWebhook
URLhttps://maintainx.svc.machinemetrics.com/Meter
Delay0

Troubleshooting​

IssuePossible CauseSolution
Workflow not triggeringWorkflow disabledEnable the workflow in Automations
Authentication errorInvalid secretVerify secret matches integration config
Work orders not appearingMaintainX JWT expiredGenerate new JWT in MaintainX
Assets not matchingMMid not set or incorrect mappingOpen MaintainX Integration Manager in Labs and use Map to link machines to assets
MMid field missing in MaintainXIntegration Manager not openedOpen MaintainX Integration Manager once; it creates the MMid field automatically
Meters not updatingMappings or webhook missingConfigure meter mappings in Integration Manager and ensure a workflow triggers the /Meter webhook
Integration Manager shows an errorInvalid or missing credentialsRe-enter API key, MaintainX JWT, and secret in the Integration Portal

Getting Help​

  • Setup Assistance: Contact your MachineMetrics Solution Delivery Manager (SDM)
  • Technical Issues: Email support@machinemetrics.com
  • MaintainX Configuration: Consult MaintainX support or documentation