Skip to main content

Paychex setup

Paychex connects through the unified HRIS connector. This page covers the Paychex-side configuration you complete first. Once it's done, add the connector in Mesh by following Connect your HR system.

You finish with two values:

ValueWhere it comes from
API keyThe integrated app you create in Paychex
Client secretShown alongside the API key when the app is saved

Before you start

You need administrator permissions in your company's Paychex instance, or a colleague who has them.

Third-party product

These steps reflect Axiad's current understanding of Paychex's configuration. Because Paychex is a third-party product, there may be variations between your experience and what this guide describes, depending on the version in use and recent updates.

If you find a significant difference, or anything that doesn't make sense, let us know through Axiad support.

Step 1 — Create an integrated app

  1. Sign in to Paychex and open Company Settings.

    The Paychex Company Settings menu

  2. Select Integrated apps.

    The Integrated apps section of Paychex company settings

  3. Select Create App.

    The Integrated apps page with the Create App button

  4. Enter an Application Name and Description. Choose something that identifies this as the Axiad Mesh connection, so a later administrator knows what it is for.

    The new-app form with name and description fields

Step 2 — Grant read-only scopes

  1. Set Company and worker APIs to Read only.

    The app scope selection with the company and worker APIs set to read only

  2. If you also want payroll information to reach Mesh, set Payroll and check APIs to Read only as well.

    If the payroll toggle isn't there

    Access to the payroll APIs is granted by Paychex rather than self-served. If you need payroll data and the toggle isn't shown, contact your Paychex account manager and ask for the Payroll and check APIs scope to be enabled for your integrated app.

    Mesh uses HR data for identity correlation and risk assessment, so company and worker access is the useful part. Add payroll only if you have a reason to — Mesh reads what the app can see, and nothing more.

  3. Accept the legal notice and the Paychex API license agreement, then select Save.

  4. Paychex shows the API key and Client secret. Copy both.

    The saved app showing its API key and client secret

Step 3 — Connect in Mesh

Follow Connect your HR system, choose Paychex in the connection window, and paste the API key and client secret from Step 2.

The connection window asking for the Paychex API key and client secret

After connecting

The connector appears in your connectors list with Health: Initializing while the first collection runs, then moves to Good. Access is read-only: Mesh does not write back to Paychex.

If it doesn't come online, see Troubleshoot HR connectors.

Troubleshooting

What you seeLikely causeFix
Authorization is rejectedThe API key and client secret were copied from different apps, or one was truncatedRe-open the integrated app in Paychex and copy both values again
People arrive but payroll fields are emptyThe app has company and worker scopes but not payrollAsk your Paychex account manager to enable the payroll scope, then reconnect
You can't create an integrated appThe account lacks administrator permissionsAsk a Paychex administrator to create the app and share the credentials