- Overview
- Configuration
Buddy Punch
Automate Buddy Punch account creation and time-tracking access updates.
Overview
Integrating Buddy Punch with Active Directory (AD) using ADManager Plus enables organizations to streamline workforce time tracking and attendance workflows through automated identity provisioning. This integration ensures that user access to Buddy Punch is consistently granted, updated, or removed based on AD changes, eliminating manual entry, reducing administrative overhead, and ensuring that only authorized employees can log their time or access scheduling tools.
Simplified onboarding
Automatically create Buddy Punch accounts when new users are added to AD, enabling employees to start tracking time from day one.
Real-time access sync
Adjust user permissions or team assignments in Buddy Punch instantly when corresponding changes are made in AD, ensuring accurate role-based visibility.
Secure offboarding
Instantly remove Buddy Punch access when a user is deactivated or deleted in AD, reducing risks associated with unauthorized time entries or lingering access.
How to integrate Buddy Punch with ADManager Plus
Prerequisites:
Buddy Punch uses OAuth 2.0 to authorize API requests. Please ensure to provide client_id, client_secret and Ocp-Apim-Subscription-Key with permissions to retrieve desired information and perform tasks in Buddy Punch. Refer to the Buddy Punch API references page for more details.
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 Buddy Punch (outbound action): Ensure the account used for authorization has permission to perform the desired action.
Authorization configuration
- Log in to ADManager Plus and navigate to Directory/Application Settings.
- Go to Application Integrations, search and select Buddy Punch.
- On the Buddy Punch Configuration page, toggle the Enable Buddy Punch Integration option on.
- Click Authorization.
- Enter the Client ID and Client Secret obtained from your registered OAuth application.
- Set Grant Type to Authorization code.
- Enter the Auth URL and Auth Token URL.
- Click Configure to complete the setup.
Inbound webhook configuration
The inbound webhook enables you to get user data from Buddy Punch to ADManager Plus and perform desired action available in Automation feature on them. To configure an inbound webhook for Buddy Punch:
- Under Inbound Webhook, click Buddy Punch Endpoint Configuration.
- On the Endpoint Configuration tab, an endpoint called Buddy Punch- List All Employees ENDPOINT comes preconfigured with the Endpoint URL, API Method, Headers, and Parameters fields filled out to fetch user accounts from Buddy Punch. If you would like to use this preconfigured endpoint, replace {Ocp-Apim-Subscription-Key} in the Headers field with your instance in the Endpoint URL field. However, if you would like to use a new endpoint to import users, you can configure one by clicking the + Add API Endpoint button and filling in the required fields according to Buddy Punch's API references. Click here to learn how. Note:
- The Authorization header is preconfigured as a header for authenticating API requests as configured during authorization configuration.
- You can add macros to your endpoint configuration to dynamically change it according to your requirements using the macro chooser component.
- Refer to Buddy Punch'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 Buddy Punch's API references to know the Parameters that must be configured to fetch specific parameters.
- You can configure multiple endpoints for Buddy Punch 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 Buddy Punch.
- 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 Buddy Punch.
- If you would like to create a new custom format for this, click Add New Format.
- Click Save.
Outbound webhook configuration
An outbound webhook enables you to send changes made in AD using ADManager Plus to Buddy Punch and carry out tasks in Buddy Punch—all from ADManager Plus.To configure an outbound webhook for Buddy Punch:
- Under Outbound Webhook, click Buddy Punch 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 Buddy Punch's API references for the API details, such as the URL, headers, parameters, and other requirements.
- 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 on which to test the configured API call. Select the desired user or group on 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 according to the configuration.
- The webhook response and request details will then be displayed. Verify them for the expected API behavior and click Save.