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 MetersAutomatically update MaintainX meters using MachineMetrics in-cycle time and number of cycles data

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 assets with their MaintainX equivalents.

Creating the MMid Field​

If MaintainX hasn't added this field yet, the integration can create it automatically:

  1. Create a workflow in MachineMetrics with any trigger (Operator or Scheduled recommended)

  2. Add a Webhook action with these settings:

    • URL: https://maintainx.svc.machinemetrics.com/setup
    • Secret: Use the same secret from your integration authorization

  3. Trigger the workflow manually

  4. Refresh MaintainX and confirm the MMid field appears under your assets

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 actual machine data.

Prerequisites​

Ensure your MaintainX meters use Hours and Cycles as measurements.

Setting Up Meter Updates​

  1. Open 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
  8. Save the workflow

What Gets Updated​

When this workflow runs, all time-in-cycle and cycle meters for each machine are updated in MaintainX:

Meter TypeMachineMetrics Data Source
HoursTotal in-cycle time
CyclesTotal cycle count

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: Daily Meter Updates​

Use case: Keep MaintainX meters current for preventive maintenance scheduling.

SettingValue
NameDaily Meter Sync to MaintainX
TriggerScheduled
ScheduleDaily at 11:00 PM
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 field missingRun the setup workflow to create MMid field
Meters not updatingWrong meter typeEnsure meters use Hours or Cycles measurement

Getting Help​

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