Salesforce Actions

Salesforce actions enable interactions with the Salesforce API.

All Salesforce actions must use the Salesforce connection instance, created by the login action.

Connection Setup

Establishes a connection to Salesforce using provided credentials.

Parameters:

username - Salesforce account username.
password - Salesforce account password.
token - Security token provided by Salesforce.
client_id (Optional)- Client ID for custom apps.
domain (Optional)- Salesforce domain.
organizationId (Optional)- Organization ID for multi-tenant access.

Return:

sf_connection - Salesforce connection instance for further API interactions.

Actions

query

Executes a SOQL query and retrieves data from Salesforce, handling pagination.

Parameters:

sf_connection - Salesforce instance provided by login.
query - SOQL query string to be executed.

Return:

result - List of all retrieved records.
total_size - Total number of records matching the query.

update

Updates or inserts a record in the Salesforce Contact object.

Parameters:

sf_connection - Salesforce instance provided by login.
id - Unique identifier of the record to be updated.
values - Dictionary containing the fields to be updated and their new values.

Return:

status - Response indicating the result of the upsert operation.

describe

Retrieves metadata for the Contact object or a specific Contact record layout.

Parameters:

sf_connection - Salesforce instance provided by login.
id (Optional)- ID of the specific Contact record for layout description.

Return:

items - List of dictionaries for each field, containing:
- label - Human-readable name of the field.
- name - API name of the field.
- type - Data type of the field (e.g., string, number).
- referenceTo - Related Salesforce objects, if applicable.

get_all_pages

Retrieve all records from a Salesforce SOQL query, handling pagination automatically.

Parameters:

sf_connection - Salesforce connection instance provided by login.
response - Initial response object returned from a SOQL query.
data - List that will be filled with all records collected across multiple pages.

Return:

data - Complete list of records from all pages of the query, where the "attributes" field has been removed.

Exceptions:

This action returns no Exception.