This article outlines the main steps to Integrate SuccessFactors with Enboarder. The SuccessFactors integration utilizes SuccessFactors webhook feature and API. The current Integration supports the ‘Hired event’, when an employee is marked as hired and is moved to ‘hire’ stage.
High Level Flow
Using SAP’s Intelligent Services, you are able to configure a web-hook to call Enboarder’s API to receive and process the payload. The Enboarder API will validate the data, and launch a workflow in Enboarder.
Enboarder Integration Set up
Here are the steps for Integration:
- Login as an admin user, navigate to Settings → Integration → App centre
- Click on the tile SuccessFactors (or search if you can't see it) for which you want the integration setup.
Click on the SAP SuccessFactors tile
On the next screen, create basic authentication credentials. These will be required to configure the webhook within SuccessFactors.
Please note down the UserID, Secret and Webhook URL before clicking on “Integrate Now”, as these will be available one time only.
There are two options on this page:
- Manually Create ID - If you want to create your own credentials
- Auto-create ID - If you want to auto-generate these credentials
Click on the 'Copy secret' button to copy the secret if you have selected the 'Auto-create ID' option.
Make sure to note down the below 3 values:
- Webhook URL
Click on ‘Integrate now’. The tile will now show as integrated.
Configure New Hire Event in SAP Intelligent Services
In SuccessFactors, we need to set up an Intelligent Services New Hire Event to push data into Enboarder. When you add a new employee, the Intelligent Services event will trigger and data will be pushed to Enboarder.
- Login to SuccessFactors as an admin user.
Search for and select ‘Integration Center’ in the search box at the top right of the page.
On the next page, click on My 'Integrations'.
On the next screen, click on ‘Create’ at the top right of the page to create a new Integration. Then select ‘More Integration Types’.
On the next page, select the values, as shown below, and click on ‘Create’.
- Trigger Type - Intelligent Services
- Source Type - SuccessFactors
- Destination Type - Rest
- Format - JSON
On the next page, select the ‘Employee Hire’ event from the list and click ‘Select’.
On the next page, provide a name and description for this integration.
On the next tab, configure elements required for your payload by adding them one by one.
Click on the + sign and select ‘Insert Sibling Element’.
Add a label and description.
Click on the 3 line menu button and select ‘Change Association’. Associate the elements with the column on the right.
Add elements as shown in the table below, and click ‘Next’.
Note - Please use the labels as mentioned below. All are in lowercase. You can map these elements with any business object field. You may need help from your SuccessFactors support team to do the correct association of these fields.
Mapping Additional Managers if necessary
You can send additional managers into Enboarder if required. The convention to be used for the “Immutable Field Key” value of the label should be lower case manager label defined in Enboarder with spaces converted to “_” ( For example if the manager Label in Enboarder is Report To Manager, the value in "Column Heading Override XML Alias" should be report_to_manager). To define Mobile or Email for this manager user, the Key name convention should be the same as the manager label, however, suffixed with _mobile or _email. ( Example - report_to_manager_mobile).
On the next page, upload a JSON file (optional). You can skip this step by clicking 'Next'. This step helps in validating your JSON structure and elements which you have added in the previous steps. You can create a JSON file with a payload the way that you have designed in the previous steps, and see the view with sample data.
On the next page, add any desired filters (optional). For example (below), if you were wanting to filter employees by country CHE only, then you can add this filter.
On the final page, add detail for Enboarder’s URL and save it. Below are the values to be configured in ‘REST SERVER SETTINGS’:
- Connection Name - Any Unique Name. Eg - Enboarder-Webhook
- REST API URL - Please paste the webhook URL which you have noted from the Enboarder integration tile in the previous section.
- Authentication Type - Please select ‘Basic Authentication’
- User Name - The userid which you have noted from the Enboarder integration tile in the previous section.
- Password - The secret which you have noted from the Enboarder integration tile in the previous section.
- HTTP Method - POST
- Payload Format - JSON
You will see a summary as below:
Save the Integration, and it will now send a payload to Enboarder for future hire events.
You can investigate mapping issues very easily. The API response is available in Enboarder. Click into Settings -> Integrations -> Integration logs to view the complete payload. There will multiple rows. One will contain the complete response message, and the other will provide candidate information that was launched.
How to trigger a new hire event in SuccessFactors
The new hire event is triggered once an employee is created in SuccessFactors.
- Login in SuccessFactors, and click on the ‘Home’ tab and select ‘Organisation’ from the dropdown.
On the next screen, click on the ‘Add an employee’ icon.
On the next screen, add the required information. Select event reason as 'New Hire'
Make sure to add email or phone information, as this is required to launch the new hire in Enboarder.
Once all required information is completed, click on ‘Submit’ to trigger the new hire event.
Note - You will need to complete the 'Add new employee' workflow to trigger the hire event.