Standard API SuccessFactors
Support avatar
Written by Support
Updated over a week ago

If you currently use SuccessFactors as your record of employee profile data, we recommend that you leverage our SuccessFactors API Integration solution. Our solution will synchronize your Communic8 recipient data with your SuccessFactors instance and avoid the need for manual updates within Communic8.

Please note:

  • Standard integration is an add-on feature and an additional cost applies

  • You will need to provide a technical contact who is responsible for the management of your SuccessFactors instance, and this contact will be required to complete some configuration steps within SuccessFactors to enable integration from your side

More About our Solution

We provide a standardised SuccessFactors Employee Profile integration which is a full employee file for all active employees. The standard fields in SuccessFactors map to the recipient profile fields in Communic8. Ultimately, the integration serves to synchronize the following object data from SF to the client Communic8 instance:

  • SF Employee Fields to Communic8 Contact

  • SF Department to Communic8 Organization

We have the ability to integrate with custom fields as well; please note the fields in Communic8 will remain the same and the Email address is the unique identifier between SuccessFactors and Communic8.

Design Features

  • The API is a full employee file for all active employees. If a recipient with the same email address exists in Communic8, the record will be updated with the information from SuccessFactors, e.g. employee movement to a new location/department, new mobile number.

  • If an employee record from SuccessFactors has an email address that does not exist in Communic8, a new recipient record will be created.

  • Records created or updated by the API will be flagged as an "SAP/SF" record (also recognisable in the DB by the SF username which is sent in the API)

  • Records flagged as SAP/SF that are not updated in the latest synchronisation will be marked as inactive in Communic8 (inactive employees are excluded in the API). Communication cannot be sent to inactive recipients.

  • Integration does not create or update recipient groups. Recipient groups are designed to be created based on specific communication segmentation designed by the customer. The customer will need to establish a process to maintain these groupings.

  • Employees who change their email address in SuccessFactors will have a new recipient record created in Communic8. The old recipient record using the old email address will need to be manually inactivated by an administrator user. Communications assigned to inactive accounts are not accessible. If your intention is to not create a new Communic8 user, a Communic8 administrator must change the email in Communic8 prior to the next synchronization to match the record in SuccessFactors.

Implementation Process

If you choose to leverage our SuccessFactors API Integration solution, please complete the following 4 steps as outlined below.

Step 1: Raise a Support Request

  • Raise a support request by emailing support@communic8.com and provide the following information:

    • In the Subject field of the support email, include the following text: “Request for SuccessFactors integration”

    • In the body of the email, include the following information:

      • Provide the ​name​ and ​email address ​of your technical contact who has the proper authority to manage your SuccessFactors instance.

      • Furthermore, provide your desired g​o-live date for switching on integration

  • Once we’ve received the support request with the proper information provided, we will send your technical contact our instruction document which outlines the steps they must complete before we can complete the integration process.

  • We would request that future support-related communications in relation to this request remain within the same email thread.

Step 2: Complete Steps Outlined in the Instruction Document

  • As outlined within the documentation we provided your technical contact, they are responsible for completing the following steps:

    • Determining the client SF instance D​ata Center number​ and ​Company ID​ information

    • Create an A​PI user​ and ​password​ and​ login exception

    • Permission the API user by creating an ​Integration Security Group​ and ​Integration Security Role​ and ​assign​ the new API user

    • Send information​ to the Communic8 support team via the support email

  • After your technical contact has completed the tasks above in step 2 and has provided Communic8 with the requested information, we will complete the technical work required to eventually activate your SuccessFactors integration solution.

  • Once we have completed our work, we will notify you via the support email communication thread.

Step 3: Test Integration

  • Depending on your current instance lifecycle (brand new instance or existing customer with live data), testing will proceed based on one of two approaches:

    1. If you are a new customer with a new Communic8 instance, you will be responsible for validating your SuccessFactors integration as follows:

      • Step 1: We will activate your SuccessFactors integration

      • Step 2: Communic8 will notify you via the support email that your solution is active and ready for testing

      • Step 3: After a period of approximately 24 hours, Communic8 will provide you with a report which provides the following information:

        • # of new records created in Communic8

        • # of records updated in Communic8

        • any SuccessFactors records that failed to be created in Communic8 due to insufficient data

      • Step 4: Using the report, please validate that your data looks correct and notify Communic8 via the support email that you sign off on test validation. If there are any failed “creates” as reported or other inconsistencies or bugs, please update the support ticket as appropriate and we will work with you to resolve any issues.

      • Step 5 (optional): After testing validates the solution, you have the option to have your Communic8 recipient data deleted and integration deactivated until your desired activation date and time has been reached. For example, you might want to wait to activate your integration if you need additional time to prepare your SuccessFactors data. Otherwise, it is assumed that your integration is active in your production environment.

    2. If you are an existing customer with Communic8 recipient data already in existence:

      • Communic8 will run a series of tests against your API to validate your integration solution

      • Once we are confident that your solution is operating as expected, we will notify you that we are ready to proceed with activation and production validation (see Step 4 below)

Step 4: Switch on Integration

  • Depending on your current instance lifecycle (brand new instance or existing customer with live data), activation of your integration solution will proceed based on one of two approaches:

    1. If you are a new customer with a new Communic8 instance, and in Step 3 you elected to have your Communic8 recipient data removed until your activation date:

      • After Step 3 testing is complete and you’re confident that the integration solution is working as expected, notify Communic8 via the support email that you agree to activate the integration solution in your production instance based on your previously elected activation date and time. If this has changed, please advise in the support email

      • Your Communic8 SuccessFactors integration will be activated in your production environment based on your activation date and time

      • Communic8 will notify you via the support email that your solution is active

    2. If you are an existing customer with Communic8 recipient data already in existence, further production validation is required after activation:

      • Step 1: After a period of approximately 24 hours, Communic8 will provide you with a report which provides the following information:

        • # of new records created in Communic8

        • # of records updated in Communic8

        • any SuccessFactors records that failed to be created in Communic8 due to insufficient data

      • Step 2: Using the report, please validate that your data looks correct and notify Communic8 via support email. If there are any failed “creates” as reported, please review your SuccessFactors instance information and update the support ticket as appropriate and we will work with you to resolve any issues in a timely fashion.

If you have any issues, questions or need direct support from one of our technical staff, please raise a support email. We can arrange a video conference directly with your technical staff to further assist you.

Important: Getting your recipients into Communic8 is important, but now that you have them here you need to take care of them. If you're like us and want to be extra sure that all the beautiful campaigns that you've worked so hard on land in your recipient's inbox, read the "Recommendations on maintaining high delivery" support article. When you're ready, this article provides a 5-step plan which will most certainly improve your campaign email delivery.

Did this answer your question?