Skip to main content

​
About Mosyle

Mosyle is an Apple device management (MDM) platform for businesses and schools. The Serval integration connects to your Mosyle Business account using your Mosyle account email, password, and an API Access Token. Serval signs in to Mosyle on your behalf with those credentials, giving your workflows on-demand access to everything the Mosyle Business API exposes - devices, users, and groups. Serval only ever sends these credentials to one host for this integration: businessapi.mosyle.com. Authentication: Mosyle account email + password + API Access Token, entered in a credential form. There is no OAuth or sign-in redirect flow. Data sync: None. No Mosyle data is ingested or synced into Serval - workflows reach Mosyle on demand.

​
What the Mosyle integration enables

CapabilityDescription
Workflow API accessWorkflows can call any Mosyle Business API capability. Serval handles the Mosyle sign-in automatically on every request.
Device inventory and managementList and filter your managed Apple devices - Mac, iPhone and iPad, and Apple TV.
User and group operationsWork with Mosyle users and groups - anything the Mosyle Business API exposes is available on demand.
Connection health checksTwo built-in checks verify that your credentials work and that device management permissions are granted.
Anything the Mosyle Business API exposes can be accessed through Serval. The API reference lives inside your Mosyle Business console under Organization > API Integration.

​
Get your credentials

You need three things: an API Access Token from the Mosyle Business console, plus the email and password of a Mosyle user account that is allowed to use the API.
1

Log in to Mosyle Business

Sign in to your Mosyle Business console.
2

Open API Integration

Navigate to Organization > API Integration.
3

Enable the API integration profile

Turn on the API integration profile for your organization.
4

Copy the Access Token

Copy the Access Token shown after enabling - you will paste it into Serval.
5

Choose the account Serval will use

Have the email and password of a Mosyle user with API access ready. Serval signs in as this user on every request.
If your workflows touch devices, the account you choose must also have device management permissions in Mosyle. Without them, device operations (and the device health check) will fail even though the credentials are otherwise valid.
Serval signs in as this user account. If the password changes or the account is deactivated in Mosyle, the connection stops working until you update the credentials in Serval.

​
Connect in Serval

1

Open the Mosyle connect form

Add a new Mosyle connection from your Serval integrations page.
2

Enter your Email

Fill in Email (required) - your Mosyle account email.
3

Enter your Password

Fill in Password (required) - your Mosyle account password.
4

Enter your Access Token

Fill in Access Token (required) - the token from Organization > API Integration.
5

Submit the form

Click Submit. If installation fails, the form shows “Failed to install integration” (with details appended when available).
All three fields are required. Leaving any of them empty blocks the form with the inline error “This field is required”. There is no format checking beyond that, and Serval does not test the credentials when you save - a typo or stray space is accepted at save time and only surfaces when the health checks run or a workflow first calls Mosyle. Run the health checks right after connecting (see below).
After saving, all three values - including the email - are displayed masked: bullet characters plus the last 4 characters. When you edit the connection later, any field you leave untouched or blank keeps its previously saved value, so you can rotate a single credential (for example, just the Access Token) without re-entering the other two.

​
Verifying the connection

Two health checks run against your connection:
  • List Mosyle Users - signs in with your stored credentials and retrieves your Mosyle users to confirm the connection works end to end.
    • Success: “Successfully connected to Mosyle and retrieved users (count: [number])”
    • Failure: “Unable to connect to Mosyle. Please verify your email, password, and access token are correct.”
  • List Mosyle Devices - retrieves your managed Mac devices to confirm the credentials are valid and device management permissions are granted.
    • Success: “Successfully connected to Mosyle and retrieved devices (count: [number])”
    • Failure: “Unable to retrieve devices from Mosyle. Please verify your credentials and that device management permissions are granted.”
If List Mosyle Users passes but List Mosyle Devices fails, your email, password, and Access Token are fine - the Mosyle user Serval signs in as is missing device management permissions. Grant that user device management permissions in Mosyle, then re-run the check.

​
Gotchas and troubleshooting

Sign-in tokens are not cached. Every workflow request to Mosyle first triggers a fresh Mosyle sign-in with your stored credentials before the actual call is made. High-volume workflows therefore generate one Mosyle login per request, which can run into Mosyle’s rate limiting sooner than the request count alone suggests. If a busy workflow starts seeing Mosyle errors, spread its requests out over time.
Serval can only reach Mosyle’s Business API service (businessapi.mosyle.com). Mosyle for Education (school) accounts and other Mosyle services are not reachable from Serval workflows. Each connection is pinned to a single Mosyle Business account.
A note for whoever builds your workflows: the Mosyle Business API expects every operation - including simple lists of devices or users - to be submitted as a request with the operation described in the body, rather than a plain lookup. Serval pins requests to version 1 of the Mosyle Business API and fills in that version portion of the address automatically, so workflow builders do not need to include it.
Need help? Contact support@serval.com for assistance with your Mosyle integration.