Creating workflows for Mosyle assets – Oomnitza Documentation

Let Oomnitza be your single source of truth!

You'll get complete visibility of your assets as data from Mosyle is automatically transformed into consumable information and actionable insights.

Connect Oomnitza and Mosyle in minutes

Get the information and insights that you need to reduce costs and the time that you spend on administration tasks such as:

Configurable dashboards and list views of key information
Configurable reports to share information with your colleagues and management
Configurable asset workflows that you can easily create to automate tasks such as:
- Workflows for updating, shutting down, restarting, and wiping Mosyle assets.
- Workflows for assigning and unassigning Mosyle assets.
- Workflows for retrieving and deleting custom variables.

Let Oomnitza be your single source of truth!

You'll get visibility of your devices as data from Mosyle is automatically transformed into consumable information and actionable insights.

Before you start

Please note that the Oomnitza integration with Mosyle has updated its authorization process. For integrations created from October 9, 2023, onwards, Session authentication is required instead of the previously supported basic authentication.

When adding workflows, select the Session Based alternatives.

For details on adding Session-based credentials to Oomnitza, see Adding your Mosyle credentials to Oomnitza.

We recommend that you also create the extended integration for Mosyle assets. You can use the asset integration to retrieve the Device ID and Serial Number which will be required for creating asset workflows.

For the Assign Assets and Unassign Assets workflows, it is recommended that you also create the extended integration for Mosyle users in advance, as you will need to supply the Mosyle User ID to run these workflows.

Creating workflows

Create asset workflows

To create an asset workflow, you must complete these steps:

Click Configuration > Workflows
Click Add (+) and select Assets from the list.
Drag and drop the API block onto the Sandbox.
Click Edit on the API block and enter Mosyle in the search field.
Select a preset:
To choose a preset, click the forward arrow (>).
Select the Session Based credentials that you created in Adding your Mosyle credentials to Oomnitza.
Supply your Mosyle Access Token.
Configure the API Block following the preset instructions below, and save your changes.
Edit the Begin Block and add rules to trigger the workflow. For example, if you set the Actions to New you can trigger a workflow every time a new asset is created. Refer to Using the Begin block.
Connect the Blocks.
Save, validate, and activate your workflow.

Using the Mosyle Update Asset Session Based preset

The Mosyle Update Asset Session Based preset updates a Mosyle asset, by Serial Number. You can configure the message payload by selecting Advanced Mode.

In the API block window, click the Advanced Mode button located in the upper right of the window.
Select the Body tab. You will notice that the Mosyle Serial Number is referenced in the property {{serial_number}}. Following the mapping steps in Creating an asset integration so that this property exists in Oomnitza and is populated with information before you run this workflow. Alternatively, replace the property with the serial number and surround with double quotation marks: for example "serialnumber": "123456". For additional fields that can be used in the request payload refer to the below table.
Select the Response tab. You can map the entire response by placing {{response}} in the Response field and mapping it to a custom long text Oomnitza field, such as API Response. For information on creating custom fields, see Creating Custom Fields in Oomnitza.

Table: Fields that can be used in the request body in Oomnitza.

Key	Type	Required	Description
serialnumber or deviceudid	string	Required	Serial number or the Device UDID
asset_tag	array[string]	Optional	Asset tag
tags	array[string]	Optional	Tags
device_name	string	Optional	Device name
notes	string	Optional	Notes
lockmessage	string	Optional	The message that you want to display when device is locked

Using the Mosyle Shutdown Asset Session Based preset

The Mosyle Shutdown Asset Session Based preset enables you to shut down a Mosyle device, by Device ID. You can configure the message payload by selecting Advanced Mode.

In the API block window, click the Advanced Mode button located in the upper right of the window.
Select the Body tab. You will notice that the Mosyle Device ID is referenced in the property {{mosyle_device_id}}. Following the mapping steps in Creating an asset integration so that this value exists in Oomnitza and is populated with information before you run this workflow. Alternatively, replace the property with the Device ID.
Select the Response tab. You can map the entire response by placing {{response}} in the Response field and mapping it to a custom long text Oomnitza field, such as API Response. For information on creating custom fields, see Creating Custom Fields in Oomnitza.

Using the Mosyle Wipe Asset Session Based preset

The Mosyle Wipe Asset Session Based preset enables you to wipe a Mosyle device, by Device ID. You can configure this preset in the same manner as the Using the Mosyle Shutdown Assets preset.

Using the Mosyle Restart Asset Session Based preset

The Mosyle Restart Asset Session Based preset enables you to restart a Mosyle device, by User ID. You can configure this preset in the same manner as the Using the Mosyle Shutdown Assets preset.

Using the Mosyle Assign Asset to User Session Based preset

The Mosyle Assign Asset Session Based preset enables you to assign an asset to a user, using the Mosyle User ID and Serial Number. You can configure the message payload by selecting Advanced Mode.

In the API block window, click the Advanced Mode button located in the upper right of the window.
Select the Body tab. You will notice that the Mosyle User ID and Device Serial Number are referenced in the properties {{mosyle_user_id}}and {{serial_number}}respectively. It is recommended that you create the user and asset integration prior to this step so that these properties exist in Oomnitza and are populated with information before you run this workflow. For additional fields that can be used in the request payload refer to the below table.
Select the Response tab. You can map the entire response by placing {{response}} in the Response field and mapping it to a custom long text Oomnitza field, such as API Response. For information on creating custom fields, see Creating Custom Fields in Oomnitza.

Using the Mosyle Unassign Asset Session Based preset

The Mosyle Unassign Assets Session Based preset unassigns a Mosyle Device, and changes the status to "limbo". You can configure the message payload by selecting Advanced Mode.

In the API block window, click the Advanced Mode button located in the upper right of the window.
Select the Body tab. You will notice that the Mosyle Device ID is referenced in the property {{mosyle_device_id}}. Following the mapping steps in Creating an asset integration so that this value exists in Oomnitza and is populated with information before you run this workflow. Alternatively, replace the property with the Device ID.
Select the Response tab. You can map the entire response by placing {{response}} in the Response field and mapping it to a custom long text Oomnitza field, such as API Response. For information on creating custom fields, see Creating Custom Fields in Oomnitza.

Using the Mosyle Create Asset Custom Variable Session Based preset

The Mosyle Create Asset Custom Variable Session Based preset enables you to create a custom variable. When you select this preset you need to supply the Name and Value of the variable. You can configure the message payload by selecting Advanced Mode.

In the API block window, click the Advanced Mode button located in the upper right of the window.
Select the Body tab. The request body contains the values required to create the new variable.
Select the Response tab. You can map the entire response by placing {{response}} in the Response field and mapping it to a custom long text Oomnitza field, such as API Response. For information on creating custom fields, see Creating Custom Fields in Oomnitza.

Using the Mosyle Delete Asset Custom Variable Session Based preset

The Mosyle Delete Asset Custom Variable Session Based preset deletes a Mosyle custom variable, by Name. When you select this preset you need to supply the Name of the variable you want to delete. You can configure the message payload by selecting Advanced Mode.

In the API block window, click the Advanced Mode button located in the upper right of the window.
Select the Body tab. The request body contains the name of the custom variable, which is required to delete it.
Select the Response tab. You can map the entire response by placing {{response}} in the Response field and mapping it to a custom long text Oomnitza field, such as API Response. For information on creating custom fields, see Creating Custom Fields in Oomnitza.

Using the Mosyle Asset Lost Mode Session Based preset

The Mosyle Asset Lost Mode Session Based preset enables you to retrieve a lost asset, by Device ID. When you select this preset you need to supply the following information:

Operation: Select an operation. You can choose from either{{enable}}, {{disable}},{{play_sound}}or {{request_location}}.
Message: Enter a custom message, which will be displayed on the screen of the lost device.

You can configure the message payload by selecting Advanced Mode.

In the API block window, click the Advanced Mode button located in the upper right of the window.
Select the Body tab. You will notice that the Mosyle Device ID is referenced in the property {{mosyle_device_id}}. Following the mapping steps in Creating an asset integration so that this value exists in Oomnitza and is populated with information before you run this workflow. Alternatively, replace the property with the Device ID. If you wish, you can also add an optional phone number to the body that will display a phone number on the screen along with the message, for example: "phone_number":"123-456".
Select the Response tab. You can map the entire response by placing {{response}} in the Response field and mapping it to a custom long text Oomnitza field, such as API Response. For information on creating custom fields, see Creating Custom Fields in Oomnitza.

Using the Mosyle Device Details with Device ID Session Based preset

The Mosyle Device Details with Device ID Session Based preset enables you to retrieve device details, by Device ID. When you select this preset you need to supply the Operating system. This can be either{{mac}}, {{ios}},or {{tvos}}.