Symptom
- You are creating an employee record in Successfactors using SFAPI User entity.
- Desired Behavior: New employee should receive the welcome message.
- Current Behavior : New employees do not get the welcome message once their information is added in Successfactors via SFAPI User entity using upsert/insert API operation.
Environment
SAP SuccessFactors - Integrations
Cause
sendWelcomeMessage parameter is not specified in the Upsert request.
or
sendWelcomeMessage parameter is set to "False" in the Upsert request.
Resolution
Please add the parameter called "sendWelcomeMessage" at the botom of the Upsert request xml.
The following example shows how to specify the sendWelcomeMessage option when UPSERTING using User entity.
<urn:upsert>
<urn:type>User</urn:type>
<!--1 or more repetitions:-->
<urn:sfobject>
<urn:type>User</urn:type>
<!--You may enter ANY elements at this point-->
<externalId>scolbert</externalId>
<status>ACTIVE</status>
<username>scolbert</username>
<firstName>Steven</firstName>
<lastName>Colbert</lastName>
<gender>M</gender>
<division>ACE Software</division>
<department>Sales</department>
<location>West</location>
<email>scolbert@123.com</email>
<hrExternalId>athompson</hrId>
<managerExternalId>cgrant</managerId>
<timeZone>US/Pacific</timeZone>
<password>pwd</password>
</urn:sfobject>
<!--1 or more repetitions:-->
<urn:processingParam>
<urn:name>sendWelcomeMessage</urn:name>
<urn:value>true</urn:value>
</urn:processingParam>
</urn:upsert>
This will trigger a welcome email to the newly created employee.
See Also
sendWelcomeMessage is only for user import via API. Please include this parameter in sfapi insert/upsert only and not in the login payload.
Given this parameter provided and user is newly created, you can expect the user to get a welcome email.
Keywords
welcome message doesn't work api upsert New employee upsert , KBA , LOD-SF-INT , Integrations , Problem