ballerinax/salesforce.soap Ballerina library



Salesforce SOAP API provides CRUD operations for SObjects and allows you to maintain passwords, perform searches, and much more.

This module supports Salesforce v48.0 SOAP API Enterprise WDSL.

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. https://<YOUR_INSTANCE><CONSUMER_KEY>&redirect_uri=<REDIRECT_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

  6. 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, update the .bal file as follows:

Step 1: Import connector

Import the ballerinax/salesforce.soap module into the Ballerina project.

import ballerinax/salesforce.soap;

Step 2: Create a new connector instance

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

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

oap:Client salesforce = new(sfConfig);

Step 3: Invoke connector operation

  1. Now you can use the operations available within the connector. Note that they are in the form of remote operations.
    Following is an example on how to convert lead using the connector.
public function main() returns error? {
  soap:ConvertedLead response = check soapClient->convertLead({leadId = "xxx", convertedStatus: "Closed - Converted"});
  1. Use bal run command to compile and run the Ballerina program.

You can find a sample here


import ballerinax/salesforce.soap;Copy


Released date: 3 months ago

Version: 8.0.0

License: Apache-2.0


Platform: java17

Ballerina version: 2201.8.4

GraalVM compatible: Yes

Pull count

Total: 94264

Current verison: 46

Weekly downloads

Source repository


Sales & CRM/Customer Relationship Management



Other versions

See more...