ballerinax/salesforce Ballerina library



Salesforce Sales Cloud is one of the leading Customer Relationship Management(CRM) software, provided by Salesforce.Inc. Salesforce enable users to efficiently manage sales and customer relationships through its APIs, robust and secure databases, and analytics services. Sales cloud provides serveral API packages to make operations on sObjects and metadata, execute queries and searches, and listen to change events through API calls using REST, SOAP, and CometD protocols.

Ballerina Salesforce connector supports Salesforce v59.0 REST API, Salesforce v59.0 SOAP API, Salesforce v59.0 APEX REST API, Salesforce v59.0 BULK API, and Salesforce v59.0 BULK V2 API.

Setup guide

  1. Create a Salesforce account with the REST capability.

  2. Go to Setup --> Apps --> App Manager

    Setup Side Panel
  3. Create a New Connected App.

    Create Connected Apps Create Connected Apps
  4. After the creation user can get consumer key and secret through clicking on the Manage Consume Details button.

    Consumer Secrets
  5. Next step would be to get the token.

    • Log in to salesforce in your prefered browser and enter the following url.
  • Allow access if an alert pops up and the browser will be redirected to a Url like follows.<ENCODED_CODE>
  • The code can be obtained after decoding the encoded code

  1. Get Access and Refresh tokens
    • Following request can be sent to obtain the tokens.

      curl -X POST https://<YOUR_INSTANCE><CODE>&grant_type=authorization_code&client_id=<CONSUMER_KEY>&client_secret=<CONSUMER_SECRET>&redirect_uri=
    • Tokens can be obtained from the response.


To use the Salesforce connector in your Ballerina application, modify the .bal file as follows:

Step 1: Import connector

Import the ballerinax/salesforce package into the Ballerina project.

import ballerinax/salesforce;

Step 2: Create a new connector instance

Create a salesforce:ConnectionConfig with the obtained OAuth2 tokens and initialize the connector with it.

salesforce:ConnectionConfig config = {
    baseUrl: baseUrl,
    auth: {
        clientId: clientId,
        clientSecret: clientSecret,
        refreshToken: refreshToken,
        refreshUrl: refreshUrl

salesforce:Client salesforce = new(config);

Step 3: Invoke connector operation

  1. Now you can utilize the available operations. Note that they are in the form of remote operations.

Following is an example on how to create a record using the connector.

salesforce:CreationResponse response = check 
    salesforce->create("Account", {
                        "Name": "IT World",
                        "BillingCity": "New York"
  1. Use following command to compile and run the Ballerina program.
bal run


The salesforce connector provides practical examples illustrating usage in various scenarios. Explore these examples below, covering use cases like creating sObjects, retrieving records, and executing bulk operations.

  1. Salesforce REST API use cases - How to employ REST API of Salesforce to carryout varies tasks.

  2. Salesforce Bulk API use cases - How to employ Bulk API of Salesforce to execute Bulk jobs.

  3. Salesforce Bulk v2 API use cases - How to employ Bulk v2 API to execute an ingest job.

  4. Salesforce APEX REST API use cases - How to employ APEX REST API to create a case in Salesforce.


import ballerinax/salesforce;Copy


Released date: about 2 months ago

Version: 8.0.0

License: Apache-2.0


Platform: java17

Ballerina version: 2201.8.4

GraalVM compatible: Yes

Pull count

Total: 94174

Current verison: 29

Weekly downloads

Source repository


Sales & CRM/Customer Relationship Management



Other versions

See more...