- Overview
- Configuration
Homebase
Automate user onboarding with Homebase-ADManager Plus integration
Homebase is a cloud-based workforce management software that helps organizations improve operational efficiency and reduce administrative burdens by streamlining employee scheduling, time tracking, payroll, and team communication. By integrating ADManager to Homebase, IT teams can synchronize employee data across Active Directory (AD) and Homebase, automating the user creation process. This integration ensures that a new user is created when a new employee record is added to Homebase and those changes are automatically reflected in AD and other connected platforms, reducing manual efforts and minimizing errors.
Automate user creation
Orchestrate workflows to automate user creation in AD when a new employee is added to Homebase, ensuring seamless onboarding. Similarly, when a user is created in AD, workflows can trigger the addition of that employee to Homebase, keeping both systems in sync.
Synchronize user changes
When user details like role, department, or contact information are updated in AD, they are automatically synced with Homebase, ensuring consistent and accurate user profiles across platforms.
Marketplace document: ADManager Plus - Homebase integration
Prerequisites
Provide the Bearer token to retrieve the desired information and perform tasks in Homebase. For more details, refer to the Homebase API references.
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 Homebase (outbound action): Ensure the account used for authorization has permission to perform the desired action.
Note: ADManager Plus comes with a preconfigured 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 the Homebase API documentation to configure under inbound/outbound webhooks to perform the required actions.Authorization configuration
- Log in to ADManager Plus and navigate to the Automation tab.
- In the left pane, under Configuration, click Application Integrations.
- Under Enterprise Applications, click Homebase.
- Toggle the Enable Homebase Integration button on.
- In the Homebase Configuration page, click Authorization.
- Perform the steps to generate B earer token in Homebase and paste the Bearer token in the Value field.
- Click Configure.
Inbound webhook configuration
Inbound webhook enables you to fetch user data from Homebase to ADManager Plus. The attribute mapping configured in this section can be selected as the data source during automation configuration.
To configure an inbound webhook for Homebase:
- Under Inbound Webhook, click Homebase Endpoint Configuration.
-
If you would like to use this preconfigured endpoint, replace {location_uuid} and {Employee Id} with that of your Homebase instance in the Endpoint URL field. However, 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 the Homebase API references. To learn how, click here.
Note:
- The API key value pair is preconfigured as a header for authenticating API requests as configured during a uthorization 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 the Homebase 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. After verifying if the requested parameters have been called to action, click Proceed.
Note:
- To fetch only specific parameters, refer to the Homebase API references to get the Parameters that must be configured.
- You can configure multiple endpoints for Homebase using the + Add API endpoint button. To learn how, click here.
- Click Data Source - LDAP Attribute Mapping to match endpoints and to map AD LDAP attributes with the respective attributes in Homebase.
-
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 attribute in Homebase.
- If you would like to create a new custom format for this, click Add New Format.
- Click Save.
Outbound webhook configuration
Outbound webhook enables you to send changes made in AD to Homebase, and carry out tasks in Homebase, all from ADManager Plus. The webhooks configured in this section can be included in Orchestration Templates, which can be used during event-driven and scheduled automations. They can also be applied directly to desired users to perform a sequence of actions on them (Management > Advanced Management > Orchestration).
To configure outbound webhooks for Homebase:
- Under Outbound Webhook, click Homebase 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 the Homebase 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 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.