How to connect PeopleHR integrated system

Find out how to set up PeopleHR on AirMason

Judith avatar
Written by Judith
Updated over a week ago

Setting up AirMason app on PeopleHR:

Complete the following steps to allow AirMason to read employees information from PeopleHR:

  1. Login to PeopleHR and go to Settings > Licenses and enable API License. If you're not able to enable it, please contact People HR Support to activate it.

  2. Then follow this guide for creating an API Key. While creating API Key make sure following Application Actions are enabled:
    - Get All employee Detail
    - Get Custom Screen Detail
    - Add New Custom Screen Transaction

  3. Then copy the generated API Key as we would be using it later.

Optional: If you also want to sync employees signature from AirMason to PeopleHR, please do the following:

  1. Go to Settings > Licenses and enable Logbook Designer. If you're not able to enable it, please contact People HR Support to activate it.

  2. Now we need to create a custom component in PeopleHR to store Handbook Signatures from AirMason. For this, go to Settings > Logbook, Click plus button to create a new Logbook. After filling out the form and saving it, check in use box, so it is published and is accessible.

  3. Then click on Add New Field button and add the following fields (case-sensitive) (Note: check in use box while creating these fields):
    - comment (Text)
    - ipAddress (Text)
    - signedVersionUrl (Text)
    - signedOn (Date)
    - handbookSignatureId (Text)

  4. Now we need to find the Logbook ID of this newly created Logbook. For that, go to https://api.peoplehr.net/pages/functional/ and select Employee Custom Screen in API Call checkbox and Get Custom screen Details in Action checkbox.

  5. Then paste the below code in textbox (above Get Response button)
    โ€‹{ "APIKey":"<API_KEY>", "Action": "GetCustomScreenDetail" }
    and replace <API_KEY> with your API Key (generated above)

  6. Then click on Get Response button, it will show you some data below the buttons. Try to find your logbook name and copy a ScreenId (this is your Logbook ID) value. In below screenshot, my newly created logbook name is Airmason Handbook Signatures and ScreenId value is 216637


Connecting PeopleHR app to AirMason:

  1. Now, login to airmason and go to Integrations page

  2. Select PeopleHR app from HRIS Platforms and click on Connect and set the following params:
    2.1. API Key as your API Key value from above
    2.2. Signature Module ID as ScreenId (Logbook ID) value (if you don't want to sync employees signature to PeopleHR then please leave this blank)


Testing PeopleHR integration:

  1. Now, login to airmason and go to Integrations page

  2. Select PeopleHR app from HRIS Platforms and click on Configure

  3. You should see a button named Sync Employees. Go ahead and click on it. It will bring your PeopleHR employees into AirMason

  4. Now go to Manage Organization > Employees (link) and you should see your PeopleHR employees being populated there.

Note: If this integration is setup then it will automatically run every 24 hours and will insert/update your PeopleHR employees into AirMason.

Did this answer your question?