• Documentation >
• Apps >
• Business Operations and ERPs >
• MaintainX

MaintainX

With MaintainX modules in Ibexa Connect, you can watch, create, update, search, retrieve, and delete:

• watch work order category

• create a new message

• list and retrieve locations

• list and retrieve users

• watch, search, create, update, and retrieve work orders

• create a work request

To get started with MaintainX, create an account at getmaintainx.com

Connect MaintainX to Ibexa Connect

To connect MaintainX app, you need to obtain the API Key.

1. Log in to your MaintainX account.

2. Click Settings > Integrations > New Key.

   

3. Click Generate Key and copy the API Key to a safe place.

   

4. Log in to your Ibexa Connect account, insert a MaintainX scenario, and click the Add button next to the Connection field.

   

5. In the Connection name field, enter a name for the connection.

6. In the API Key field, enter the details copied in step 3 and click Save.

You have successfully connected the MaintainX app and can now build scenarios.

Categories

You can watch the work order categories by using the following module.

Watch a Work Order Category

Triggers when a new work order category has been chosen.

Category	Select or map the categories whose work order you want to update.
Limit	Set the maximum number of work order categories Ibexa Connect will return during one execution cycle. The default value is 10.

Conversions

You can create new messages by using the following module.

Create a New Message

Creates a new message.

Conversation ID	Select or map the Conversation ID whose message you want to create.
Content	Enter the message to post.

Locations

You can list and retrieve locations by using the following modules.

List Locations

Retrieves a list of locations.

Limit	Set the maximum number of locations Ibexa Connect will return during one execution cycle. The default value is 10.

Get a Location

Retrieves a location.

Location ID	Select or map the Location ID whose details you want to retrieve.

Users

You can list, and retrieve users by using the following modules.

List Users

Retrieves a list of users

Only Assignable	Select whether to show only the users who can be assigned to the work order.
Limit	Set the maximum number of users Ibexa Connect will return during one execution cycle. The default value is 10.

Get a User

Retrieves a user.

User ID	Select or map the User ID whose details you want to retrieve.

Work Orders

You can watch, search, create, update, and retrieve work orders by using the following module.

Watch Work Orders

Triggers when a new work order has been created.

Limit	Set the maximum number of work orders Ibexa Connect will return during one execution cycle. The default value is 10.

Search Work Orders

Searches for work orders.

Limit	Set the maximum number of work orders Ibexa Connect will return during one execution cycle. The default value is 10.

See MaintainX Work Orders API reference for entering the field values to search the work orders that match the specified value.

Create a Work Order

Creates a work order.

For field descriptions, see the MaintainX Work Orders API reference.

Create a Work Order Comment

Creates a work order comment.

Work Order ID	Select or map the Work Order ID whose comment you want to create.
Content	Enter the comment to be posted.

Update a Work Order

Updates a work order.

Work Order ID	Select or map the Work Order ID whose details you want to update.

For field descriptions, see the MaintainX Work Orders API reference.

Update a Work Order Status

Updates a work order status.

Work Order ID	Select or map the Work Order ID whose status you want to update.
Status	Select the status of the work order. For example, open.

Get a Work Order

Retrieves a work order.

Work Order ID	Select or map the Work Order ID whose status you want to retrieve.

Work Requests

You can create work requests by using the following module.

Create a Work Request

Create a work request.

For field descriptions, see the MaintainX Work Requests API reference.

Other

You can call APIs using the following module.

Make an API Call

Performs an arbitrary authorized API call.

Note

For the list of available endpoints, refer to the MaintainX API documentation.

URL	Enter a path relative to https://api.getmaintainx.com. For example, /v1/assets.
Method	GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry.
Headers	Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String	Enter the request query string.
Body	Enter the body content for your API call.

Example of use - List Workroders

The following API call returns all work orders from your account.

URL: /v1/workorders

Method: GET

Matches of the search can be found in the module's Output under Bundle > Body > workOrders.

In our example 5 work orders were returned: