Home Integrations
🔌

Integrations

Alagu
By Alagu and 2 others
• 6 articles

Integrating SAP Successfactors with Peoplebox

Overview This integration pulls employee and organizational data from SAP SuccessFactors using OData v2 APIs. The integration relies on two endpoints: 1. EmpEmployment API 2. User API API Endpoints Used All API calls should be made against your company-specific SuccessFactors base URL: https://<your-successfactors-api-host>/odata/v2/ 1. EmpEmployment API GET /odata/v2/EmpEmployment Full Query Used: <https://apiXX.sapsf.com/odata/v2/EmpEmployment> ?$expand=userNav/manager,jobInfoNav/departmentNav &$select= userNav/userId, userNav/firstName, userNav/lastName, userNav/email, userNav/title, userNav/hireDate, userNav/department, userNav/manager/userId, userNav/manager/email, jobInfoNav/departmentNav/externalCode, empJobRelationshipNav/relationshipNav/externalCode, empJobRelationshipNav/relUserNav/email Purpose - Primary employee data source - Department mapping via departmentNav.externalCode - Employee relationship mapping via empJobRelationshipNav/relationshipNav 2. User API GET /odata/v2/User Full Query Used <https://apiXX.sapsf.com/odata/v2/User> ?$select= userId, firstName, title, hireDate, lastName, email, department, division, manager &$expand=manager Purpose - Manager hierarchy mapping Permissions Ensure the API user configured in SuccessFactors has the following permissions: Required Permissions: - Employee Central API (OData) - Read access to: - Employee Employment (EmpEmployment) - User entity (User) - Job Information - Department data - Permission to access: - Manager relationships IP Whitelisting (Optional) In case you have enabled IP whitelisting in your SuccessFactors instance, you must whitelist Peoplebox servers to allow secure access. Steps 1. Go to Admin Center. 2. Navigate to: Manage OAuth2 Client Applications (if OAuth used) OR API Center / Integration Settings 1. Locate Allowed IP Addresses / IP Restriction Settings. 2. Add your Peoplebox server IP to the whitelist. Contact Peoplebox support to obtain the latest list of static IPs. Notes - Ensure no wildcard blocking rules override these entries. - If using VPN or proxy restrictions, allow outbound access to `apiXX.sapsf.com Client Application Setup Step 1: Create a client 1. Log in to your SAP SuccessFactors account as an administrator. 2. Go to Admin Center and navigate to API Center > OAuth Configuration for OData. 3. Select Register Client Application. 4. Fill in the following details on the application registration page: • Company: Your organization’s name. • Application Name: Assign a unique identifier for your OAuth client. • Application URL: Provide a URL that can direct users to additional details about the application. This is primarily for 3-legged OAuth, which isn’t currently supported. • X-509 Certificate: Upload the certificate that aligns with the private and public keys used in the OAuth 2.0 process. Details on how to generate certificate 5. Click Register to save your application. 6. Once registered, you can view the generated API key by selecting the View option in the application list. Step 2: Share Required Details After completing the client application setup, share the following details with support@peoplebox.ai to enable the integration: - Client ID: The API key created during the client application registration. - Client Secret: The private key content (from the .pem file) generated during the setup. - API Server: The URL for your account’s API server. [List of API server URLs here]. - Company ID: This can be found by clicking your profile picture in SAP SuccessFactors and selecting Show version information. Look for the “Company ID” in the popup. - Username: Your username, shown in parentheses beside your profile image. Once you provide these details, the Peoplebox team will set up the connection for you. 🎉

Last updated on Mar 24, 2026

Salesforce Integration

Salesforce Integration In this article: - Introduction to Salesforce integration. - Enabling the Salesforce integration. - Configuring the Salesforce connection - Connection the Salesforce connection to an OKR. - More Details Introduction to Salesforce integration https://www.youtube.com/watch?v=1HQXNoHnGng Integrating Salesforce with Peoplebox allows you to link your OKRs directly with data you have in Salesforce. Say, for example, you have an opportunity and you want to track progress, by implementing a Salesforce integration, you can save yourself the hassle of repeatedly going back and forth between your CRM and Peoplebox to update your progress: This makes for a powerful setup as it ensures that the OKR process is not waiting on manual check-ins and progress is updated real-time on Peoplebox. Enabling the Salesforce integration Anyone with access to Peoplebox can enable this integration. Here’s how it can be done: - Edit a Key result (KR) you want to integrate Salesforce with. - In the Edit KR drawer under the Progress Section, you will have an option to Enable the integration. If a connection has been made previously or if the integration has been enabled already, you will have the option to Edit the enabled integration. • This integration can also be disabled by unchecking the Automatic Updates From option. Configuring the Salesforce connection - After enabling the integration, the first step is to configure a Salesforce connection. - In the Connect to Salesforce drawer, click on the Connect to Salesforce button. - A new tab will open where you will need to login into your Salesforce account to continue with. - Once you are logged in, you will be redirected to a permissions selection page. These permissions are mandatory for Peoplebox to keep accurate track of data derived from Salesforce. - After this step, you will be taken to Specify Input Fields tab. - You can update the name of the connection by going back to the Authorize tab. Connecting the Salesforce connection to an OKR Once you have configured the connection, the next step is to start linking OKRs to the data derived from Salesforce. - Enter a valid SoQL query in the SoQL input field. - Note that this query should only return a single numeric value. Otherwise, you might see an error. - You can Verify your input by clicking the button below. - SoQL Queries to try: - SELECT COUNT(Id) FROM Account - SELECT SUM(ExpectedRevenue) FROM Opportunity More Details - The value you link will be automatically updated in every 24 hours. If you want to do a manual update you can do so by clicking the Salesforce icon on the listing and the Goal details page, and then clicking the Sync now button.

Last updated on Mar 04, 2025

Integrate MySQL For Automatic Goal Progress Updates

https://www.youtube.com/watch?v=-wwBy_9ltds 1. Select Goal To Integrate On the goals page, select a goal that you want to integrate with. Select Goal To Integrate 2. Open Goal Editing Click "Edit Goal" Open Goal Editing 3. Set Progress Tracking To Auto Update Go to track progress. Change the track progress type to auto update from external data source. Set Progress Tracking To Auto Update 4. Connect To External Data Source Click on connect to external data source. Connect To External Data Source 5. Choose Auto Update Option Click "Auto update from a Data Source" to enable automatic progress updates. Choose Auto Update Option 6. Select MySQL Data Source Select the MySQL as the data source. Select MySQL Data Source 7. Authorize MySQL Connection Click "Authorize" for authorizing the MySQL connection. Authorize MySQL Connection 8. Fill Connection Details To authorize the connection to MySQL server, you have to fill in the details shown over here, like - Connection Name - Click "MYSQL_PPL". - MySQL host port - Username - Password - Database. Fill Connection Details 9. Enter MySQL Credentials MySQL host port. Username, password and database. Enter MySQL Credentials 10. Save Settings And Enter Query Once it's done, you can save the settings and enter the MySQL Query over here. Save Settings And Enter Query 11. Verify Input Data Click "Verify your input". Verify Input Data 12. Confirm Progress Display Click on "Verify your inputs". Confirm Progress Display 13. Save Goal Changes Save the changes to the goal. Save Goal Changes 14. Auto Update Progress From MySQL Now the progress of your goal is getting updated from MySQL. Auto Update Progress From MySQL Please add a description Powered by guidde

Last updated on Oct 17, 2025

Zoho People HRIS Integration with Peoplebox

This guide walks you through connecting your Zoho People account to Peoplebox, enabling employee data to stay automatically synchronized between the two systems. 1. Overview The Zoho People integration allows Peoplebox to pull your employee directory directly from Zoho People. Once connected, Peoplebox periodically syncs employee profiles, keeping headcount, reporting structures, departments, and other employee attributes up to date without the need for manual CSV uploads. The integration reads data from a Zoho People form/view that exposes employee records (the API name is provided during setup, for example, peoplebox_view). This is a one-directional integration, meaning data flows from Zoho People to Peoplebox only. Peoplebox does not write back to or modify any data in Zoho People. 2. Data synced from Zoho People Peoplebox syncs the following employee attributes from Zoho People: - Employee ID - Full Name - Email - Job Title (Designation) - Department - Manager (Reporting Manager) - Date of Joining - Date of Exit - Gender - Employment Type - Phone Number (Work Phone) - Location (Work Location) These fields are automatically updated during each sync to help keep employee records in Peoplebox accurate and up to date. Note: Employees without an email address are not synced, as email is used as the primary identifier for matching employee records between Zoho People and Peoplebox. 3. Prerequisites Before setting up the Zoho People integration, ensure the following requirements are met: - You have admin access to your Zoho People account, which is required to authorize the integration through Zoho's consent screen. - You have a Zoho People form/view that contains the employee records to be synced, and you know its API name (for example, peoplebox_view). - All active employees have a valid email address populated in Zoho People, as email is used to match employee records during the sync process. 4. How You Connect Zoho People uses OAuth 2.0 for authentication. The integration is configured by the Peoplebox team on the backend, and there is currently no self-serve setup available within the app. Authorization is granted to Peoplebox's registered Zoho application, allowing Peoplebox to securely access employee data and automatically refresh authentication tokens for ongoing syncs. The setup process is as follows: - The Peoplebox team shares a Zoho authorization link with you. - You log in to Zoho People using an administrator account and approve the requested access. - Zoho redirects the authorization back to Peoplebox, where the connection is securely established. - The Peoplebox team configures the Zoho form/view to be used for syncing employee data and sets up the required field mappings. - An initial employee sync is performed, after which the account is included in the regular scheduled sync process. Note: Once the integration is connected, no further action is required from your side. Peoplebox automatically manages token refreshes and continues syncing data on a scheduled basis. 5. What You Provide Since the integration setup is handled by the Peoplebox team, only a few details are required from your side: - Zoho admin approval: Approve the Zoho authorization link shared by the Peoplebox team. This grants Peoplebox read access to employee data using the required permissions. - Form/View API name: Share the API name of the Zoho People form or view that contains the employee records to be synced (for example, peoplebox_view). Note: You do not need to generate or share any access tokens manually. The required tokens are securely generated when the authorization request is approved. 6. How Sync Works - Sync Frequency: Employee data is synced automatically once daily (around 00:30 UTC) for all active and trial accounts. - Directory Coverage: Employee records are fetched in batches to ensure the complete directory is synced, including support for large organizations. - Employee Matching: Employees are matched using their email address or employee ID. - New Employees: Employees found in Zoho People but not in Peoplebox are automatically added during the next sync. - Employee Updates: Changes made in Zoho People, such as updates to job title, department, manager, or phone number, are reflected in Peoplebox after the next sync. - Department Sync: Departments are automatically matched or created based on the department values received from Zoho People. - Employee Exits: If an employee previously synced from Zoho People is no longer present in the latest Zoho data, Peoplebox marks the employee with an exit date and deactivates the profile to keep active headcount accurate. - Audit Logs: Each sync is logged for auditing purposes, including a snapshot of the imported data and a summary of records that were added, updated, or failed during the sync process. 7. Frequently Asked Questions - Will existing employees in Peoplebox be affected? Ans: The sync updates employee records that match by email address or employee ID. New employees found in Zoho People are added automatically, while existing employee records are updated with the latest information from Zoho People. - What happens if an employee does not have an email address in Zoho People? Ans: Employees without an email address are skipped during the sync process. To ensure all employees are synced correctly, make sure every active employee has a valid email address in Zoho People. - Does Peoplebox write any data back to Zoho People? Ans: No. The integration is read-only from Zoho People's perspective. Data flows only from Zoho People to Peoplebox. - Do I need to re-authorize the integration periodically? Ans: No. Peoplebox automatically refreshes access tokens as needed. Re-authorization is only required if the authorization is revoked or expires on the Zoho People side. - Can I trigger a manual sync? Ans: Yes. If you need a sync outside the regular schedule, please contact Peoplebox Support. - Is our Zoho People data secure? Ans: Yes. Connection credentials are stored securely, and authentication tokens are managed automatically as part of the integration process. - What happens if the integration authorization is revoked or expires? Ans: If the integration authorization is revoked, expired, or otherwise becomes invalid, please contact your Peoplebox account manager or Peoplebox Support to re-authorize the connection. Syncing will resume once the connection has been re-established.

Last updated on Jun 22, 2026

Keka HRIS Integration with Peoplebox

This guide walks you through connecting your Keka account to Peoplebox, enabling employee data to stay automatically synchronized between the two systems. 1. Overview The Keka integration allows Peoplebox to pull your employee directory directly from Keka. Once connected, Peoplebox periodically syncs employee profiles, keeping headcount, reporting structures, departments, and other employee attributes up to date without the need for manual CSV uploads. 2. Data synced from Keka Peoplebox syncs the following employee attributes from Keka: - Employee ID (Employee Number) - Full Name (Display Name) - Email (Work Email) - Job Title - Department - Business Unit - Manager - Date of Joining - Date of Exit - Gender - Employment Type - Location - Phone Number - Profile Picture These fields are automatically updated during each sync to help keep employee records in Peoplebox accurate and up to date. Note: Employees without a valid work email address are not synced, as email is required to identify and match employee records. 3. Prerequisites Before setting up the Keka integration, ensure the following requirements are met: - You have admin access to your Keka account. - The Keka API feature is enabled for your organization. If you are unsure, please contact Keka Support. - You have generated the required API credentials from the Keka Developer/API settings, including: - Client ID (client_id) - Client Secret (client_secret) - API Key (api_key) 4. Getting Your Keka API Credentials To connect Keka with Peoplebox, you will need to collect the required API credentials from your Keka account. - Log in to your Keka admin portal. - Navigate to Settings → Integrations → API Access (or Developer Settings, depending on your Keka version). - Generate or copy the following credentials: - Client ID - Client Secret - API Key - Note down your Keka domain name, which is the subdomain in your Keka URL. For example, if your URL is yourcompany.keka.com, the domain name is yourcompany. Note: Keka access tokens expire every 24 hours. Peoplebox automatically refreshes the access token before each sync, so no additional action is required after the integration is configured. 5. Setup Steps (Peoplebox Admin) Share the following details with your Peoplebox account manager or Peoplebox Support to complete the integration setup: - Client ID (client_id) – OAuth Client ID generated in Keka. - Client Secret (client_secret) – OAuth Client Secret generated in Keka. - API Key (api_key) – API Key generated in Keka. - Keka Domain Name (keka_domain_name) – Your Keka subdomain (for example, yourcompany from yourcompany.keka.com). - Admin Email ID (admin_email_id) – The email address of the Keka administrator authorizing the integration. Once these details are shared, the Peoplebox team will configure the integration and trigger an initial employee sync. 6. How Sync Works - Sync Frequency: Peoplebox syncs employee data from Keka on a scheduled basis (by default, once daily). - Directory Coverage: Employee records are fetched in batches to ensure the complete directory is synced, including support for large organizations. - New Employees: Employees added in Keka are automatically created in Peoplebox during the next sync. - Employee Updates: Changes made in Keka, such as updates to job title, department, manager, or other employee details, are reflected in Peoplebox after the next sync. - Employee Exits: When an employee's status is marked as Relieved and the exit process is Completed in Keka, the employee is marked as inactive in Peoplebox, and the exit date is synced accordingly. 7. Field Mapping Details Some fields in Keka use internal values that are mapped to user-friendly values in Peoplebox during the sync process. Gender: Keka stores gender as a numeric value. These values are mapped in Peoplebox as follows: - 1 → Male - 2 → Female - 3 → Non-binary Employment Type: Keka stores employment type as a numeric value. These values are mapped in Peoplebox as follows: - 1 → Permanent - 2 → Contract Department and Business Unit: Keka uses a Groups structure to organize employees. During the sync: - Group Type 1 is mapped to Business Unit. - Group Type 2 is mapped to Department. 8. Frequently Asked Questions - Will existing employees in Peoplebox be affected? Ans: The sync updates employee records that match by email address. New employees found in Keka are added automatically, while existing employee records are updated with the latest information from Keka. - What happens if an employee does not have a work email address in Keka? Ans: Employees without a work email address are skipped during the sync process. To ensure all employees are synced correctly, make sure every active employee has a valid email address in Keka. - Can I trigger a manual sync? Ans: Yes. If you need a sync outside the regular schedule, please contact Peoplebox Support. - Is our Keka data secure? Ans: Yes. Integration credentials are stored securely, and API access tokens are generated as needed during the sync process rather than being stored long-term. - What happens if my Keka API credentials change? Ans: If your Keka API credentials are updated or revoked, please contact your Peoplebox account manager or Peoplebox Support to provide the new credentials. Syncing will resume once the updated credentials have been configured.

Last updated on Jun 22, 2026

BambooHR HRIS Integration with Peoplebox

This guide is for customers integrating BambooHR with Peoplebox. Since this integration is configured by the Peoplebox team and does not have a self-serve setup, our team will complete the backend configuration for you. This document outlines the setup requirements, the employee data that gets synced, the sync schedule, and what you can expect once the integration is live. 1. Overview Peoplebox syncs employee data from BambooHR using BambooHR's Custom Reports API. Once the integration is configured, employee information is automatically synchronized with Peoplebox every day. BambooHR acts as the system of record, ensuring employee details, reporting hierarchy, and departments remain up to date. Share the following with your Peoplebox contact before setup begins: 2. BambooHR API Key Generate an API key in BambooHR: 1. Log in to BambooHR as an admin. 2. Click your name in the top-right corner. 3. Select API Keys. 4. Click Add New Key. 5. Give it a name (for example, Peoplebox Integration). 6. Copy the generated API key. Important: The API key is sensitive. Share it securely (for example, via a password manager link or encrypted message). Do not send it in plain email. 3. BambooHR Company Domain Provide your BambooHR company subdomain. - Example: If your BambooHR URL is: https://acme.bamboohr.com - Your company domain is: acme 4. Field Mapping Peoplebox needs to know which BambooHR field names correspond to each Peoplebox attribute. Below is the standard mapping. If your BambooHR instance uses different field names (common for custom fields), let your Peoplebox contact know which BambooHR field should be used for each attribute. - Employee ID → employeeNumber - Work email → workEmail (Note: Employees without a work email are skipped) - Full name → fullName1 - Hire date → hireDate (Must be in YYYY-MM-DD format in BambooHR) - Termination date → terminationDate (Automatically cleared for Active employees) - Gender → gender (not_specified is treated as blank) - Manager email → supervisorEmail (Used to build the reporting hierarchy) - Department → department(Creates the department automatically if it does not exist) - Job title → jobTitle - Location → division - Employment type → employmentHistoryStatus - Phone number → (Optional) Specify the BambooHR field name to be used. 5. Profile Pictures (Optional) Peoplebox can import employee profile photos from BambooHR. If you want this enabled, let your Peoplebox contact know. Note: Enabling profile picture sync adds one extra API call per active employee during each sync. 6. What Gets Synced Each daily sync performs the following actions: - Creates new Peoplebox employees for anyone added to BambooHR since the last sync. - Updates existing employees if their BambooHR data has changed (name, title, department, manager, etc.). - Deactivates employees who are no longer returned by BambooHR (their date_of_exit is set to today's date in Peoplebox). - Builds the org chart using the supervisorEmail field. - Creates departments automatically if they do not already exist in Peoplebox. 7. What Is Not Synced The BambooHR integration does not sync: - Custom BambooHR fields that are not included in the field_mapping. - Team or group memberships (managed separately in Peoplebox). - Department hierarchies (departments are synced as flat names only). 8. Sync Schedule The BambooHR integration sync runs automatically with the following schedule: - Frequency: Once per day. - Time: Approximately 12:30 AM UTC. - Trigger: Automatically triggered via the scheduler. 9. How Active vs. Inactive Employees Are Handled Peoplebox uses the BambooHR status field to determine employee activity. - If the BambooHR status is Active: - The employee remains active in Peoplebox. - The termination date is ignored, even if it contains a value or is blank. - If the BambooHR status is Inactive and a valid termination date (YYYY-MM-DD) is available: - The employee is set to inactive in Peoplebox using the termination date from BambooHR. - If the BambooHR status is Inactive but the termination date is missing or invalid: - The employee is set to inactive in Peoplebox using today's date as the termination date. - If the employee is not returned in the BambooHR sync results: - The employee's date_of_exit is set to today's date in Peoplebox and they are treated as terminated. 10. How the Manager Hierarchy Is Built Peoplebox uses the supervisorEmail field to link each employee to their manager. For manager relationships to be created: - The manager must also exist as an employee in Peoplebox. - The manager must be included in the BambooHR sync results. If a manager is not included in the sync, the reporting relationship is not created. 11. Checklist Before Go-Live Before enabling the integration, ensure that: - BambooHR API key has been generated and shared securely. - BambooHR company domain has been confirmed. - Field mapping has been reviewed. - Custom field names have been shared, if applicable. - Employee filters have been finalized (or confirmed that all employees should be synced). - Profile picture sync preference has been confirmed. - The Peoplebox team has completed the backend configuration. - An initial manual sync has been triggered, and the results have been reviewed. 12. Troubleshooting - An employee is missing from Peoplebox after sync? Ans: Check the following, 1. Ensure the employee has a work email in BambooHR. Employees without an email are always skipped. 2. Verify that an active filter is not excluding the employee (for example, based on employment type). 3. Confirm the employee's BambooHR status is Active and they are not marked as terminated. - An employee shows as inactive, but they are still at the company? Ans: Possible reasons include, 1. The employee's BambooHR status is set to Inactive. 2. The employee no longer appears in the BambooHR custom report results (for example, due to a filter change). If an employee is not returned by the sync, Peoplebox automatically deactivates them. Review the configured filter rules. - Manager relationships are missing or incorrect? Ans: Verify that, 1. The supervisorEmail field contains the manager's work email (not a personal email). 2. The manager is also included in the BambooHR sync results. 3. The manager is not excluded by any configured filters. If the manager is filtered out, the reporting relationship cannot be created. - The sync has not run recently? Ans: The sync runs automatically once every day at approximately 12:30 AM UTC. If you need an immediate update, contact the Peoplebox team to trigger a manual sync. 13. Frequently Asked Questions - Can we choose which employees to sync? Ans: Yes. Filters let you include or exclude employees based on any BambooHR field, including employment type, department, location, termination date, and more. Share your criteria with the Peoplebox team during setup, and they will configure the filters before the first sync. - What happens if we have employees in Peoplebox who are not in BambooHR? Ans: Employees created manually in Peoplebox (not originating from BambooHR) are untouched. The sync only manages employees whose employee_source is bamboo_hr. If you want all employees to be managed by the sync going forward, the Peoplebox team can migrate existing records. - Will the integration overwrite changes we make manually in Peoplebox? Ans: Yes. For fields that are part of the sync, BambooHR is the system of record. If you update a synced field in Peoplebox but the BambooHR record still has the previous value, the next sync will overwrite it. - How do we update the field mapping or filters after go-live? Ans: Contact the Peoplebox team. There is no self-serve UI for this integration, so all configuration changes are made on the backend. Changes take effect from the next scheduled sync. - Can we sync employees from multiple BambooHR accounts? Ans: No. Each Peoplebox account can be connected to only one BambooHR configuration. If your organization uses multiple BambooHR instances, contact the Peoplebox team to discuss available options. - What BambooHR permissions does the API key need? Ans: The API key inherits the permissions of the BambooHR user who created it. At a minimum, that user should have read access to the employee fields being synced (such as name, email, job title, department, and manager). If profile pictures are enabled, the user must also have read access to employee photos. We recommend using a dedicated read-only integration user. - How soon after setup will the first sync happen? Ans: After the integration is configured, the Peoplebox team will trigger a manual sync so you can review the results before the automated daily sync begins. - What happens if BambooHR is down or the API returns an error? Ans: The sync fails silently for that day, and no data is deleted or modified in Peoplebox. The next scheduled sync will automatically attempt again the following day. Contact the Peoplebox team if you need to confirm whether a sync completed successfully.

Last updated on Jul 14, 2026