• Overview
  • Configuration

Related-apps

Payworks

Keep payroll processes smooth by syncing Payworks employee data with IT.

AD & HR syncPayroll

Overview

Payworks is a payroll and workforce management platform offering tools for employee records, time tracking, and benefits administration. Integrating Payworks with Active Directory using ADManager Plus allows organizations to automatically sync employee lifecycle changes from Payworks into AD. This ensures that as users are onboarded, updated, or offboarded in Payworks, their access in Active Directory is provisioned or revoked accordingly—eliminating manual effort and improving access governance.

 

Automated onboarding

Provision AD accounts when new employees are added in Payworks, ensuring access is granted on day one.

 

Role-based access updates

Reflect department, role, or status changes from Payworks in AD to keep user permissions current.

 

Compliance-aligned offboarding

Disable or remove AD accounts when employees are terminated in Payworks, ensuring secure and compliant offboarding.

 

How to configure Payworks integration in ADManager Plus

Prerequisites:

  • Payworks uses basic authentication credentials to authorize API request.
  • Authentication credentials required: Client ID as the username and secret key as the password.

Privileges:

  • To import users (Inbound action): Ensure the account used for authorization has permission to read all user accounts.
  • To perform any action or query in Payworks (Outbound Action): Ensure the account used for authorization has permission to perform the desired action.
Note: ADManager Plus comes with a pre-configured set of APIs that helps perform basic actions with the integration. If the action you require is not available, please gather the necessary API details from Payworks's API documentation to configure under inbound or outbound webhooks to perform the required actions.

Authorization configuration

  • Log in to ADManager Plus and navigate to Directory/Application Settings.
  • Go to Application Integrations, then search and select Payworks.
  • Toggle the Enable Payworks Integration button on.
  • In the Payworks Configuration page, click Authorization.
  • Enter the authentication credentials. Use client ID as the username and secret key as the password.
  • Click Configure.

Inbound webhook configuration

Inbound webhook enables you to fetch user data from Payworks to ADManager Plus. The attribute mapping configured in this section can be selected as the data source during automation configuration to perform the desired action on the list of users received from the API response. To configure an inbound webhook for Payworks:

  • Under Inbound Webhook, click Payworks Endpoint Configuration.
  • In the Endpoint Configuration tab, an endpoint, Payworks Get All Employees ENDPOINT, comes pre-configured with an Endpoint URL, API Method, Headers, and Parameters fields to fetch user accounts from Payworks. If you would like to use a new endpoint to import users, you can configure one using the + Add API endpoint button and filling in the required fields as per Payworks's API references. Click here to learn how. Note:
    • Authorization Header is preconfigured as a header for authenticating API requests as configured during Authorization Configuration.
    • Macros: You can add macros to your endpoint configuration to dynamically change it as per your requirement using the macro chooser component
    • Refer to Payworks's API references and configure additional headers and parameters, if required.
  • Once done, click Test & Save. A response window will display all the requested parameters that can be fetched using the API call. Click Proceed. Note:
    • Refer to Payworks's API references to know the Parameters that must be configured to fetch only specific parameters.
    • You can configure multiple endpoints for Payworks using the + Add API endpoint button. Click here to learn how.
  • Click Data Source - LDAP Attribute Mapping to match endpoints and to map AD LDAP attributes with the respective attributes in Payworks. ADManager Plus also lets you customize attribute format from Payworks
  • Click + Add New Configuration and perform the following:
    • Enter the Configuration Name and Description and select the Automation Category from the drop-down menu.
    • In the Select Endpoint field, select the desired endpoint and a Primary Key that is unique to a user (e.g. employeeIdentifier). Note: When multiple endpoints are configured, this attribute must hold the same value in all the endpoints.
    • In the Attribute Mapping field, select the attribute from the LDAP Attribute Name drop-down menu and map it with the respective column in Payworks.
    • If you would like to create a new custom format for this, click Mapping Attribute.
    • Click Save.
Note: The attribute mapping configured in this section can be selected as the data source during automation configuration to perform the desired action on the list of users received from the API response.

Outbound webhook configuration

Outbound webhook enables you to update the changes made in AD using ADManager Plus to Payworks or fetch or forward required details from Payworks and synchronize them with AD.To configure an outbound webhook for Payworks:

  • Under Outbound Webhook, click Payworks Webhook Configuration.
  • Click + Add Webhook.
  • Enter a name and description for this webhook.
  • Decide on the action that has to be performed and refer to Payworks's API references for the API details such as the URL, headers, parameters, and other requirements that will be needed.
  • Select the HTTP method that will enable you to perform the desired action on the endpoint from the drop-down menu.
  • Enter the endpoint URL.
  • Configure the Headers, Parameters, and Message Type in the appropriate format based on the API call that you would like to perform.
  • Click Test and Save.
  • A pop up window will then display a list of AD users and groups to test the configured API call. Select the desired user or group over which this API request has to be tested and click OK. This will make a real-time call to the endpoint URL, and the selected objects will be modified as per the configuration.
  • The webhook response and request details will then be displayed. Verify them for the expected API behavior and click Save.
Note: The webhooks configured in this section can be included in Orchestration Templates, which can be used in event-driven and scheduled automations. They can also be applied directly to desired users to perform a sequence of actions on them (under Management > Advanced Management > Orchestration).