Thank you for your feedback.
Form temporarily unavailable. Please try again or contact to submit your comments.

Configure REST services for an HR management system

Log in to subscribe to topics and get notified when content changes.

Configure REST services for an HR management system

If you are using REST services with your integration, create or modify the appropriate HR web services to define the REST messages used to communicate with the third-party HR management system for the inbound integration.

Before you begin

Role required: sn_hr_integrations.admin

About this task

You can use REST messages to communicate with the third-party system. For example, the preconfigured First Advantage integration uses REST services, while the preconfigured SuccessFactors integration uses both SOAP and REST services. See Outbound REST web service for more information.


  1. Navigate to HR Integrations > HR Web Services > HR REST Services.
  2. Click New or open a record.
  3. Fill in the fields on the form.
    Table 1. REST Message form
    Field Description
    Name Name of the REST message.
    Description Description of the REST message.
    Endpoint Endpoint URL that the REST message is sent to.
    Note: Data that is transferred between the customer instance and the third-party system is secured through standard SSL. For a secure connection, provide an encrypted HTTPS link.
    Application This field is automatically set to Human Resources: Integrations.
    Accessible from This field is automatically set to This application scope only.
  4. Right-click the form header and click Save.
  5. In the Authentication related list, fill in the fields on the form.
    Field Description
    Authentication type Authentication type of the REST message.
    Note: If you are using REST services, set the value to Basic. Provide the credentials to use in the Basic auth profile field.
    Basic auth profile Credentials for the REST message. Click the Lookup icon to add or create your authentication credentials. This field appears when Basic is selected from Authentication type.
    Use mutual authentication Check box for enabling mutual authentication. If selected, provide the credentials to use for mutual authentication in the Mutual authentication profile field.
  6. Click Update.

    Under the HTTP Methods section, several default HTTP methods are automatically created using settings inherited from the REST message record. Subsequent changes to the REST message record are not applied to the HTTP methods automatically.

    You can create additional HTTP methods or modify the default HTTP methods to implement new behavior. See Define a REST message HTTP method for more information.