SAP SuccessFactors Component

SAP SuccessFactors is a human resources platform that provides cloud-based solutions to manage various HR functions such as business alignment, people performance, recruitment, and learning activities.

Component key: sap-successfactors

Description

SAP SuccessFactors is a human resources platform providing solutions to manage various business functions.

Use the SAP SuccessFactors component to manage Job Applications, Candidates, Onboarding information, and more.

API Documentation:

The component was built using the SAP SuccessFactors ODATA V2 API

Connections

API Key Authentication

Log into your instance as an administrator.
Go to Admin Center API Center OAuth Configuration for OData and choose Register Client Application. You can also access the tool by searching Manage OAuth2 Client Applications in Action Search.

Input	Notes	Example
API Key string / Required apiKey	Your OAuth2 Success Factors API Key	YzVjNzI4MTIsdryNmJkOTVkYWJmODBiZjdkYg
API Server string apiServer	Your SAP SuccessFactors api server, if you are not sure, please contact your SAP SuccessFactors administrator. If empty the sandbox environment will be used (sandbox.api.sap.com)	testing.successfactors.com
Audiences string / Required audiences	Audiences of the SAML assertion	www.successfactors.com
Certificate text / Required cert	Your Public Certificate for Success Factors OAuth2
Company ID string / Required companyId	SAP SuccessFactors Company ID
Issuer string / Required issuer	Issuer information of the SAML assertion	wwww.successfactors.com
Certificate Private Key text / Required privateKey	Your Private Certificate Key for Success Factors OAuth2
Protocol string / Required protocol	The SAP SuccessFactors protocol to use
User string / Required user	Enter the SAP SuccessFactors user ID that you use to access the APIs	sfadmin

Basic Authentication

Input	Notes	Example
API Server string apiServer	Your SAP SuccessFactors api server, if you are not sure, please contact your SAP SuccessFactors administrator. If empty the sandbox environment will be used (sandbox.api.sap.com)	testing.successfactors.com
Company ID string / Required companyId	SAP SuccessFactors Company ID
Password password / Required password	SAP SuccessFactors Password
Protocol string / Required protocol	The SAP SuccessFactors protocol to use
Username string / Required username	SAP SuccessFactors Username

Data Sources

Select Candidate

Select a Candidate from the dropdown list | key: selectCandidate | type: picklist

Input	Notes
Connection connection / Required connection

{
  "result": [
    {
      "label": "John Doe",
      "key": "1234"
    }
  ]
}

Select Job Application

Select a Job Application from the dropdown list | key: selectJobApplication | type: picklist

Input	Notes
Connection connection / Required connection

{
  "result": [
    {
      "label": "John Doe - Job Requisition #1234",
      "key": "1234"
    }
  ]
}

Select Job Requisition

Select a Job Requisition from the dropdown list | key: selectJobRequisition | type: picklist

Input	Notes
Connection connection / Required connection

{
  "result": [
    {
      "label": "1234 - 50070999",
      "key": "1234"
    }
  ]
}

Actions

Create a Record

Create a new record in component | key: createRecord

Input	Notes	Example
Additional Inputs code additionalInputs	Additional inputs to be passed to the action
Connection connection / Required connection
Record Type string / Required recordType	The type of record to create	Candidate

Create Candidate

Add a new entity to Candidate | key: createCandidate

Input	Notes	Example
Additional Inputs code additionalInputs	Additional inputs to be passed to the action
Connection connection / Required connection
Country string / Required country	The country where the candidate is located	United States
First Name string / Required firstName	The first name of the candidate	John
Last Name string / Required lastName	The last name of the candidate	Doe
Primary Email string / Required primaryEmail	The primary email address of the candidate	test@test.com

{
  "data": {
    "__metadata": {
      "uri": "https://api68sales.successfactors.com/odata/v2/Candidate(4181L)",
      "type": "SFOData.Candidate"
    },
    "candidateId": "4181",
    "lastName": "Langworthy",
    "firstName": "Nancy"
  }
}

Create Job Application

Add a new entity to JobApplication | key: createJobApplication

Input	Notes	Example
Additional Inputs code additionalInputs	Additional inputs to be passed to the action
Candidate ID string / Required candidateId	The ID of the candidate to create the job application for	1234-5678
Connection connection / Required connection
Job Requisition ID string / Required jobReqId	The ID of the job requisition to create the job application for	1234-5678

{
  "data": {
    "__metadata": {
      "uri": "https://api68sales.successfactors.com/odata/v2/JobApplication(388L)",
      "type": "SFOData.JobApplication"
    },
    "applicationId": "388",
    "lastName": "Test",
    "firstName": "Test",
    "status": "Open"
  }
}

Create Job Requisition

Add a new entity to JobRequisition | key: createJobRequisition

Input	Notes	Example
Additional Inputs code additionalInputs	The required fields for the selected template
Connection connection / Required connection
Template ID string / Required templateId	The ID of the job requisition template to use	1234-5678

Delete Job Requisition

Delete an entity from JobRequisition | key: deleteJobRequisition

Input	Notes	Example
Connection connection / Required connection
Job Requisition ID string / Required jobReqId	The ID of the job requisition to delete	1234-5678

Delete Record

Delete an existing record in component | key: deleteRecord

Input	Notes	Example
Connection connection / Required connection
Record Type string / Required recordType	The type of record to delete	Candidate
Record Type ID string / Required recordTypeId	The ID of the record to delete	1234-5678

Get Candidate

Get entity from Candidate by key | key: getCandidate

Input	Notes	Example
Select string $select	Select properties to be returned	Rating,ReleaseDate
Candidate ID string / Required candidateId	The ID of the candidate to retrieve	1234-5678
Connection connection / Required connection

{
  "data": {
    "__metadata": {
      "uri": "https://api68sales.successfactors.com/odata/v2/Candidate(4181L)",
      "type": "SFOData.Candidate"
    },
    "candidateId": "4181",
    "lastName": "Langworthy",
    "firstName": "Nancy"
  }
}

Get Job Application

Get entity from JobApplication by key | key: getJobApplication

Input	Notes	Example
Select string $select	Select properties to be returned	Rating,ReleaseDate
Connection connection / Required connection
Job Application ID string / Required jobApplicationId	The ID of the job application to retrieve	1234-5678

{
  "data": {
    "__metadata": {
      "uri": "https://api68sales.successfactors.com/odata/v2/JobApplication(388L)",
      "type": "SFOData.JobApplication"
    },
    "applicationId": "388",
    "lastName": "Test",
    "firstName": "Test",
    "status": "Open"
  }
}

Get Job Requisition

Get entity from JobRequisition by key | key: getJobRequisition

Input	Notes	Example
Select string $select	Select properties to be returned	Rating,ReleaseDate
Connection connection / Required connection
Job Requisition ID string / Required jobReqId	The ID of the job requisition to retrieve	1234-5678

Get Record

Retrieve a single record from component | key: getRecord

Input	Notes	Example
Select string $select	Select properties to be returned	Rating,ReleaseDate
Connection connection / Required connection
Record Type string / Required recordType	The type of record to create	Candidate
Record Type ID string / Required recordTypeId	The ID of the record type to retrieve	1234-5678

List Candidates

Get entities from Candidate | key: listCandidates

Input	Default	Notes	Example
Count boolean $count	false	Include count of items
Expand string $expand		Expand related entities	Orders($filter=Amount gt 100)
Filter string $filter		Filter items by property values	Price lt 10.00
Order By string $orderby		Order items by property values	userId desc
Search string $search		Search items by search phrases	NOT clothing
Select string $select		Select properties to be returned	Rating,ReleaseDate
Skip string $skip		The number of records to skip	20
Top string $top		The number of records to return	20
Connection connection / Required connection
Custom Query Params string Key Value List customQueryParams		Custom fields filter	key1=value1
Fetch All boolean fetchAll	false	If true will fetch all records, otherwise will use the other inputs to fetch the records

{
  "data": [
    {
      "__metadata": {
        "uri": "https://api68sales.successfactors.com/odata/v2/Candidate(4181L)",
        "type": "SFOData.Candidate"
      },
      "candidateId": "4181",
      "lastName": "Langworthy",
      "firstName": "Nancy"
    }
  ]
}

List Job Applications

Get entities from JobApplication | key: listJobApplications

Input	Default	Notes	Example
Count boolean $count	false	Include count of items
Expand string $expand		Expand related entities	Orders($filter=Amount gt 100)
Filter string $filter		Filter items by property values	Price lt 10.00
Order By string $orderby		Order items by property values	userId desc
Search string $search		Search items by search phrases	NOT clothing
Select string $select		Select properties to be returned	Rating,ReleaseDate
Skip string $skip		The number of records to skip	20
Top string $top		The number of records to return	20
Connection connection / Required connection
Custom Query Params string Key Value List customQueryParams		Custom fields filter	key1=value1
Fetch All boolean fetchAll	false	If true will fetch all records, otherwise will use the other inputs to fetch the records

{
  "data": [
    {
      "__metadata": {
        "uri": "https://api68sales.successfactors.com/odata/v2/JobApplication(388L)",
        "type": "SFOData.JobApplication"
      },
      "applicationId": "388",
      "lastName": "Test",
      "firstName": "Test",
      "status": "Open"
    }
  ]
}

List Job Requisitions

Get entities from JobRequisition | key: listJobRequisitions

Input	Default	Notes	Example
Count boolean $count	false	Include count of items
Expand string $expand		Expand related entities	Orders($filter=Amount gt 100)
Filter string $filter		Filter items by property values	Price lt 10.00
Order By string $orderby		Order items by property values	userId desc
Search string $search		Search items by search phrases	NOT clothing
Select string $select		Select properties to be returned	Rating,ReleaseDate
Skip string $skip		The number of records to skip	20
Top string $top		The number of records to return	20
Connection connection / Required connection
Custom Query Params string Key Value List customQueryParams		Custom fields filter	key1=value1
Fetch All boolean fetchAll	false	If true will fetch all records, otherwise will use the other inputs to fetch the records

{
  "data": [
    {
      "__metadata": {
        "uri": "https://api68sales.successfactors.com/odata/v2/JobRequisition(3040L)",
        "type": "SFOData.JobRequisition"
      },
      "jobReqId": "3040",
      "createdDateTime": "/Date(1673880833000+0000)/"
    }
  ]
}

List Records

Retrieve a list of records from component | key: listRecords

Input	Default	Notes	Example
Count boolean $count	false	Include count of items
Expand string $expand		Expand related entities	Orders($filter=Amount gt 100)
Filter string $filter		Filter items by property values	Price lt 10.00
Order By string $orderby		Order items by property values	userId desc
Search string $search		Search items by search phrases	NOT clothing
Select string $select		Select properties to be returned	Rating,ReleaseDate
Skip string $skip		The number of records to skip	20
Top string $top		The number of records to return	20
Connection connection / Required connection
Custom Query Params string Key Value List customQueryParams		Custom fields filter	key1=value1
Fetch All boolean fetchAll	false	If true will fetch all records, otherwise will use the other inputs to fetch the records
Record Type string / Required recordType		The type of record to create	Candidate

Raw Request

Send raw HTTP request to the SAP SuccessFactors API | key: rawRequest

Input	Default	Notes	Example
Connection connection / Required connection
Data string data		The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
File Data string Key Value List fileData		File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names string Key Value List fileDataFileNames		File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data string Key Value List formData		The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header string Key Value List headers		A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count string maxRetries	0	The maximum number of retries to attempt. Specify 0 for no retries.
Method string / Required method		The HTTP method to use.
Query Parameter string Key Value List queryParams		A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type string / Required responseType	json	The type of data you expect in the response. You can request json, text, or binary data.
Retry On All Errors boolean retryAllErrors	false	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.
Retry Delay (ms) string retryDelayMS	0	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.
Timeout string timeout		The maximum time that a client will await a response to its request	2000
URL string / Required url		Input the path only (/Candidate), The base URL is already included ({{ YOUR_API_SERVER_URL }}). For example, to connect to {{ YOUR_API_SERVER_URL }}/Candidate, only /Candidate is entered in this field	/Candidate
Use Exponential Backoff boolean useExponentialBackoff	false	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

Update Candidate

Update an entity in Candidate | key: updateCandidate

Input	Notes	Example
Additional Inputs code additionalInputs	Additional inputs to be passed to the action
Candidate ID string / Required candidateId	The ID of the candidate to retrieve	1234-5678
Connection connection / Required connection
Country string country	The country where the candidate is located	United States
First Name string firstName	The first name of the candidate	John
Last Name string lastName	The last name of the candidate	Doe
Primary Email string primaryEmail	The primary email address of the candidate	test@test.com

{
  "data": "Action completed successfully"
}

Update Job Application

Update an entity in JobApplication | key: updateJobApplication

Input	Notes	Example
Additional Inputs code additionalInputs	Additional inputs to be passed to the action
Candidate ID string candidateId	The ID of the candidate to update	1234-5678
Connection connection / Required connection
Job Application ID string / Required jobApplicationId	The ID of the job application to retrieve	1234-5678
Job Requisition ID string jobReqId	The ID of the job requisition to update	1234-5678

{
  "data": "Action completed successfully"
}

Update Job Requisition

Update an entity in JobRequisition | key: updateJobRequisition

Input	Notes	Example
Additional Inputs code additionalInputs	The template fields to update
Connection connection / Required connection
Job Requisition ID string / Required jobReqId	The ID of the job requisition to retrieve	1234-5678

{
  "data": "Action completed successfully"
}

Update Record

Update an existing record in component | key: updateRecord

Input	Notes	Example
Additional Inputs code additionalInputs	Additional inputs to be passed to the action
Connection connection / Required connection
Record Type string / Required recordType	The type of record to create	Candidate
Record Type ID string / Required recordTypeId	The ID of the record type to retrieve	1234-5678

{
  "data": "Action completed successfully"
}

SAP SuccessFactors is a human resources platform that provides cloud-based solutions to manage various HR functions such as business alignment, people performance, recruitment, and learning activities.

Description​

Connections​

API Key Authentication​

Basic Authentication​

Data Sources​

Select Candidate​

Select Job Application​

Select Job Requisition​

Actions​

Create a Record​

Create Candidate​

Create Job Application​

Create Job Requisition​

Delete Job Requisition​

Delete Record​

Get Candidate​

Get Job Application​

Get Job Requisition​

Get Record​

List Candidates​

List Job Applications​

List Job Requisitions​

List Records​

Raw Request​

Update Candidate​

Update Job Application​

Update Job Requisition​

Update Record​