Salesforce Rest API Connector Example

The Salesforce REST Connector allows you to work with records in Salesforce, a web-based service that allows organizations to manage contact relationship management (CRM) data. You can use the Salesforce connector to create, query, retrieve, update, and delete records in your organization's Salesforce data. The connector uses the Salesforce REST API to interact with Salesforce.

What you'll build

This example explains how to use the Salesforce client to connect with the Salesforce instance and perform the following operations:

  • Create an account.

    The user sends the request payload that includes sObjects (any object that can be stored in the Lightning platform database), to create a new Account object in Salesforce. This request is sent to the integration runtime by invoking the Salesforce connector API.

  • Execute a SOQL query to retrieve the Account Name and ID in all the existing accounts.

    In this example use the Salesforce Object Query Language (SOQL) to search stored Salesforce data for specific information which is created under sObjects.

Using Salesforce Rest Connector

The user calls the Salesforce REST API. It invokes the create sequence and creates a new account in Salesforce. Then through the retrieve sequence, it displays all the existing account details to the user.

If you do not want to configure this yourself, you can simply get the project and run it.

Configure the connector in WSO2 Integration Studio

Connectors can be added to integration flows in WSO2 Integration Studio. Once added, the operations of the connector can be dragged onto your canvas and added to your sequences.

Import the connector

Follow these steps to set up the Integration Project and the Connector Exporter Project.

  1. Open WSO2 Integration Studio and create an Integration Project. Creating a new Integration Project

  2. Right-click the project that you created and click on Add or Remove Connector -> Add Connector. You will get directed to the WSO2 Connector Store.

  3. Search for the specific connector required for your integration scenario and download it to the workspace. Search Connector in the Connector Store

  4. Click Finish, and your Integration Project is ready. The downloaded connector is displayed on the side palette with its operations.

  5. You can drag and drop the operations to the design canvas and build your integration logic. Drag connector operations

  6. Right click on the created Integration Project and select New -> Rest API to create the REST API.

Add integration logic

First create an API, which will be where we configure the integration logic. Right click on the created Integration Project and select, New -> Rest API to create the REST API. Specify the API name as salesforcerest and API context as /salesforcerest.

Adding a Rest API

Configure a sequence for the create operation

Create the sequence needed to create Salesforce object. We will create two defined sequences called create.xml and retrieve.xml to create an account and retrieve data. Right click on the created Integration Project and select, -> New -> Sequence to create the Sequence.

Adding a Sequnce

Now follow the steps below to add configurations to the sequence.

  • Set up the created operation.

    1. Setup the create sequence configurations. In this operation we are going to create a sObjects in the Salesforce account. An SObject represents a specific table in the database that you can discretely query. It describes the individual metadata for the specified object. Please find the create operation parameters listed here.

      • sObjectName : Name of the sObject that you need to create in Salesforce.
      • fieldAndValue : The field and value you need to store in the created Salesforce sObject.

      While invoking the API, the above two parameters values come as a user input.

    2. Navigate into the Palette pane and select the graphical operations icons listed under Salesforce Connector section. Then drag and drop the create operation into the Design pane.

      Drag and drop create operations

    3. Create a connection from the properties window by clicking on the '+' icon

      In the popup window, the following parameters must be provided.

      • Connection Name - Unique name to identify the connection by.
      • Connection Type - Type of the connection that specifies the protocol to be used.
      • Access Token - The access token to authenticate your API calls.
      • API version - The version of the Salesforce API.
      • Host Name - Salesforce OAuth endpoint when issuing authentication requests in your application. For example,
      • Refresh Token - Value of the refresh token.
      • Refresh Token Endpoint - The endpoint of the refresh token.
      • Client Secret - Value of your client secret given when you registered your application with Salesforce.
      • Client Id - The consumer key of the connected application that you created.
      • API URL - The instance URL for your organization. For example,
      • Timeout - Timeout duration of the API request. This should be in milliseconds.
      • Username - The username for Salesforce.
      • Password - The password for Salesforce (need to append the password with security key).
      • Blocking - Indicates whether the connector needs to perform blocking invocations to Salesforce. This should be set to true or false.
    4. To get the input values in to the API we can use the property mediator. Navigate into the Palette pane and select the graphical mediators icons listed under Mediators section. Then drag and drop the Property mediators into the Design pane as shown bellow.

      Add property mediators

      The parameters available for configuring the Property mediator are as follows:

      Note: That the properties should be add to the pallet before create the operation.

    5. Add the property mediator to capture the sObjectName value.The sObjectName type can be used to retrieve the metadata for the Account object using the GET method, or create a new Account object using the POST method. In this example we are going to create a new Account object using the POST method.

      • name : sObjectName
      • expression : json-eval($.sObject)
      • type : STRING

      Add values to capture sObjectName value

    6. Add the property mediator to capture the fieldAndValue values. The fieldAndValue contains object fields and values that user need to store.

      • name : fieldAndValue
      • expression : json-eval($.fieldAndValue)
      • type : STRING

      Add values to capture fieldAndValue value

Configure a sequence for the retrieve operation

Create the sequence to retrieve the Salesforce objects created.

  1. Initialize the connector.

    You can use the generated tokens to initialize the connector. Please follow the steps given in 2.1 for setting up the init operation to the retrive.xml sequence.

  2. Set up the retrieve operation.

    1. To retrieve data from the created objects in the Salesforce account, you need to add the query operation to the retrieve sequence.

      • queryString : This variable contains specified SOQL query. In this sample this SOQL query executes to retrieve id and name from created Account. If the query results are too large, the response contains the first batch of results.
    2. Navigate into the Palette pane and select the graphical operations icons listed under Salesforce Connector section. Then drag and drop the query operations into the Design pane.

      Add query operation to retrive sequnce

    3. Select the query operation and add id, name from Account query to the properties section shown as bellow.

      Add query to the query operation in retrive sequnce

Configuring the API

  1. Configure the salesforcerest API using the created create and retrive sequences.

    Now you can select the API that we created initially. Navigate into the Palette pane and select the graphical operations icons listed under Defined Sequences section. Drag and drop the created create and retrive sequences to the Design pane.

    Drag and drop sequences to the Design view

  2. Get a response from the user.

    When you invoking the created API the request of the message is going through the create and retrive sequences. Finally pass to the the Respond mediator. In here the Respond Mediator stops the processing on the current message and sends the message back to the client as a response.

    1. Drag and drop respond mediator to the Design view.

      Add Respond mediator

    2. Once you have setup the sequences and API, you can see the salesforcerest API as shown below.

      API Design view

  3. Now you can switch into the Source view and check the XML configuration files of the created API and sequences.

    <?xml version="1.0" encoding="UTF-8"?>
    <sequence name="create" trace="disable" xmlns="">
        <property expression="json-eval($.sObject)" name="sObject" scope="default" type="STRING"/>
        <property expression="json-eval($.fieldAndValue)" name="fieldAndValue" scope="default" type="STRING"/>
    <?xml version="1.0" encoding="UTF-8"?>
    <sequence name="retrieve" trace="disable" xmlns="">
            <queryString>select id, name from Account</queryString>
    <?xml version="1.0" encoding="UTF-8"?>
    <api context="/salesforcerest" name="salesforcerest" xmlns="">
        <resource methods="POST">
                <sequence key="create"/>
                <sequence key="retrieve"/>

Get the project

You can download the ZIP file and extract the contents to get the project code.

Download ZIP


You may need to update the value of the access token and make other such changes before deploying and running this project.


Follow these steps to deploy the exported CApp in the integration runtime.

Deploying on Micro Integrator

You can copy the composite application to the <PRODUCT-HOME>/repository/deployment/server/carbonapps folder and start the server. Micro Integrator will be started and the composite application will be deployed.

You can further refer the application deployed through the CLI tool. See the instructions on managing integrations from the CLI.

Click here for instructions on deploying on WSO2 Enterprise Integrator 6
  1. You can copy the composite application to the <PRODUCT-HOME>/repository/deployment/server/carbonapps folder and start the server.

  2. WSO2 EI server starts and you can login to the Management Console https://localhost:9443/carbon/ URL. Provide login credentials. The default credentials will be admin/admin.

  3. You can see that the API is deployed under the API section.


Save a file called data.json with the following payload.

    "fieldAndValue": {
    "name": "Engineers",
    "description":"This Account belongs to WSO2"

Invoke the API as shown below using the curl command. Curl application can be downloaded from here.

curl -X POST -d @data.json http://localhost:8280/salesforcerest --header "Content-Type:application/json"

You will get a set of account names and the respective IDs as the output.

What's Next