Skip to main content
Salesforce Service Cloud logo
  • Category: crm
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 24
  • Triggers: 0
  • Slug: SALESFORCE_SERVICE_CLOUD
  • Version: 20261101_00

Tools

Slug: SALESFORCE_SERVICE_CLOUD_AGENT_SENSITIVE_DATA_RULE_TRIGGEREDNotifies Salesforce Live Agent that sensitive data rules were triggered in agent messages. Purpose: When an agent’s outgoing message contains sensitive data (SSN, credit card, email, etc.), call this action to apply configured masking or handling rules to protect customer privacy. Prerequisites: - Active Live Agent chat session with valid chat_id - Sensitive data rules configured in Salesforce Setup - Live Agent feature must be enabled in your Salesforce org Note: Salesforce Live Agent Chat is deprecated and retiring February 14, 2026. Migrate to Messaging for In-App and Web for continued support. Typical Flow: 1. Agent sends message containing sensitive data 2. System detects sensitive content matches a rule 3. Call this action with the chat_id and triggered rules 4. Salesforce applies masking/filtering per rule configuration

Input Parameters

array
required
One or more sensitive data rules to apply (e.g., to mask SSN, credit cards, or PII in agent messages)
string
required
Active Live Agent chat session ID obtained when the chat session was established
string
Live Agent API version (e.g., ‘61.0’ or ‘65.0’). If not provided, automatically extracted from connection base_url

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFORCE_SERVICE_CLOUD_CHASITOR_SNEAK_PEEKSend real-time typing indicator (sneak peek) to Live Agent during active chat session. Allows agents to see what visitors are typing before the message is sent. Requires an active Live Agent chat session with valid session_key and affinity token. The sequence number must increment with each request.

Input Parameters

string
required
The current in-progress message text that the visitor is typing. Send empty string when typing is cleared
string
required
Affinity token received from chat session initialization, used to route requests to the correct Live Agent server (X-LIVEAGENT-AFFINITY)
integer
required
Character position/cursor location in the message being typed. Typically starts at 0 for new message
integer
required
Incrementing sequence number for this request (X-LIVEAGENT-SEQUENCE). Must increment with each API call in the session, starting from 1
string
required
Salesforce API version header (X-LIVEAGENT-API-VERSION)
string
required
Unique session key for the active chat session (X-LIVEAGENT-SESSION-KEY)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFORCE_SERVICE_CLOUD_COMPOSITE_BATCHTool to execute multiple independent REST subrequests in one batch call. Use when bundling up to 25 independent operations to minimize round trips. Subrequests cannot reference each other.

Input Parameters

boolean
If true, stops processing on first subrequest error; subsequent subrequests return HTTP 412. Default false.
array
required
Array of up to 25 independent subrequests to execute in one call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFORCE_SERVICE_CLOUD_COMPOSITE_REQUESTExecute up to 25 dependent Salesforce REST subrequests in a single API call. Subrequests execute sequentially and can reference results from earlier requests using ’@{referenceId.field}’ syntax. Use this when operations depend on each other (e.g., create Account then create related Contact). For independent operations, use Composite Batch instead.

Input Parameters

boolean
If true, treat all subrequests as a single transaction; on first error roll back all prior successes
array
required
Ordered list of up to 25 subrequests to execute in sequence. Later requests can reference earlier results using ’@{referenceId.field}’ syntax.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFORCE_SERVICE_CLOUD_COMPOSITE_SOBJECT_TREECreate one or more nested sObject record trees in a single API call. Supports parent-child relationships up to 5 levels deep, with a maximum of 200 total records across all trees. Use this for bulk insertion of related records (e.g., Account with Contacts, or Orders with Line Items). Relationships must be Master-Detail or Lookup. Only supports INSERT operations, not upserts.

Input Parameters

array
required
List of sObject tree records to create. Each record must have ‘attributes’ (with ‘type’ and ‘referenceId’) and field values. Child records are specified using relationship name as key (e.g., ‘Contacts’). Maximum 200 total records across all trees, up to 5 levels deep.
string
required
Root sObject API name (e.g., ‘Account’, ‘Contact’, ‘Case’). All root records in the request must be of this type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFORCE_SERVICE_CLOUD_CREATE_CASE_RECORDTool to create or upsert a Salesforce Case record. Use when you need to add a new Case or update via external ID.

Input Parameters

string ("application/json" | "application/xml")
Desired response format; defaults to application/json
object
required
Map of Case field API names to values (e.g., Subject, Status, Origin)
string
Set to ‘1’ to pretty-print the response
string
API name of external ID field for upsert; provide with external_id_value
string
Value of external ID for upsert; provide with external_id_field
boolean
Set to True to apply active assignment rules on Case creation or upsert
string
Client and defaultNamespace options in format ‘client=<name>[, defaultNamespace=<ns>]‘

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFORCE_SERVICE_CLOUD_DELETE_CASE_RECORDTool to delete a Salesforce Case record. Use when you need to remove a case by its record ID.

Input Parameters

string
required
Salesforce Case record ID to delete (15-18 character string)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFORCE_SERVICE_CLOUD_DESCRIBE_S_OBJECTTool to retrieve metadata of any sObject. Use when you need to inspect field definitions, relationships, and supported features for objects like Account, Contact, Case, etc.

Input Parameters

string
required
API name of the sObject to describe, e.g., ‘Account’, ‘Contact’, ‘Case’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFORCE_SERVICE_CLOUD_END_CHAT_SESSIONEnd a Salesforce Live Agent chat session using its session key, API version, and affinity token. A success response does not necessarily confirm the session ended. DEPRECATED: Salesforce scheduled legacy Chat for retirement on February 14, 2026 and recommends migrating to Messaging for In-App and Web.

Input Parameters

string
required
Affinity token for session routing to the correct Live Agent server (X-LIVEAGENT-AFFINITY from SessionId GET response)
string
required
Salesforce Live Agent API version (e.g., ‘61.0’). Should match the version used to create the session.
string
required
The Live Agent session key obtained when creating the chat session (X-LIVEAGENT-SESSION-KEY from SessionId GET response)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFORCE_SERVICE_CLOUD_GENERATE_REQUEST_IDGenerate a UUIDv4 string to use as an Idempotency-Key header in Salesforce User Interface API requests. This prevents duplicate record creation when POST, PATCH, or DELETE requests are retried due to network failures or timeouts. The same key returns cached responses for 30 days, avoiding duplicate operations and saving server resources. Use this tool whenever you need to ensure idempotent behavior for Salesforce UI API operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFORCE_SERVICE_CLOUD_GENERATE_SIGNED_JWT_ASSERTIONTool to generate a signed JWT assertion for Salesforce JWT bearer OAuth flow. Use when you need to perform server-to-server authentication using a connected app’s certificate. Use before exchanging the assertion for an access token.

Input Parameters

string
Audience claim for the JWT, e.g., login URL or instance domain. Defaults to the instance domain derived from base_url metadata.
string
required
Salesforce username (subject) for whom to generate the JWT assertion.
string
Client (Consumer) ID of the Salesforce Connected App. If provided, overrides value from connection metadata.
integer
JWT lifetime in seconds from now.
string
RSA private key in PEM format used to sign the JWT. If generate_private_key is true, this value is ignored.
boolean
If true, generate a temporary RSA private key for signing (useful for testing when a PEM isn’t available).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFORCE_SERVICE_CLOUD_GET_CASE_RECORDRetrieve a Salesforce Case record by its ID. Returns Case details including status, priority, subject, description, owner, and timestamps. Useful for: - Looking up Case details by ID - Checking Case status and priority - Getting customer issue information - Retrieving Case metadata and relationships Requires a valid 15 or 18-character Salesforce Case ID. Optionally specify which fields to retrieve using the fields parameter; otherwise all accessible fields are returned.

Input Parameters

string
Comma-separated list of Case field API names to retrieve. If omitted, returns all accessible fields.
string
required
ID of the Case record to retrieve (15- or 18-character Salesforce ID)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFORCE_SERVICE_CLOUD_GET_CHAT_MESSAGESTool to long-poll for chat messages/events. Use after CreateChatSession to retrieve incoming chat events. Returns empty messages list when no new messages (HTTP 204). Call with ack from prior response to maintain sequence.

Input Parameters

integer
Sequencing token for polling; use -1 for the first request
string
required
Affinity token identifying the session on Chat servers
string
required
Salesforce API version for the request, e.g., ‘61.0’
string
required
Unique Chat session key

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFORCE_SERVICE_CLOUD_GET_LIVE_AGENT_API_VERSIONRetrieve the highest-numbered Salesforce REST API version available from the instance’s versions list, along with its root URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFORCE_SERVICE_CLOUD_LIST_EINSTEIN_BOTSList Einstein Bot definitions using the Salesforce Tooling API, returning IDs, labels, developer names and language settings from the first result page. An empty list can also indicate a request failure or forbidden access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFORCE_SERVICE_CLOUD_QUERY_ALL_SOQLTool to execute a SOQL query including deleted and archived records. Use when you need to fetch all rows including soft-deleted data in Salesforce.

Input Parameters

string
required
SOQL query string to execute, must end with ‘ALL ROWS’ to include deleted and archived records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFORCE_SERVICE_CLOUD_QUERY_SOQLTool to execute a SOQL query. Use when you need to retrieve records from Salesforce via SOQL.

Input Parameters

string
required
SOQL query string to execute.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFORCE_SERVICE_CLOUD_RECONNECT_CHAT_SESSIONReconnect a Live Agent chat session after its affinity token changes, using the session key and affinity token. After reconnecting, call ResyncChasitorState to restore the visitor’s chat context; a success response does not necessarily confirm reconnection. DEPRECATED: Salesforce scheduled legacy Chat for retirement on February 14, 2026 and recommends migrating to Messaging for In-App and Web.

Input Parameters

string
required
Affinity token from the chat session that identifies the server instance. Obtained from the initial chat session creation or SessionId response. Sent in X-LIVEAGENT-AFFINITY header.
string
Live Agent API version (e.g., ‘61.0’). If not provided, automatically derived from base_url.
string
required
Unique session key identifying the chat session. Obtained from the initial chat session creation. Sent in X-LIVEAGENT-SESSION-KEY header.
string
Client’s incrementing sequence number for request ordering. Use 1 for first reconnect attempt, then increment for subsequent operations. Sent in X-LIVEAGENT-SEQUENCE header.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFORCE_SERVICE_CLOUD_RESYNC_CHASITOR_STATEResynchronizes the chat visitor’s state after a session reconnection. This action is part of the Salesforce Live Agent chat session recovery workflow: 1. First, call ReconnectChatSession with the session_key and affinity_token 2. Then, call this action to restore the visitor’s chat state 3. Finally, resume normal chat operations (sending messages, getting messages, etc.) Prerequisites: - An active or recently disconnected Live Agent chat session - Valid session_key and affinity_token from the original session - Live Agent must be properly configured in the Salesforce org Note: The legacy Live Agent product is being phased out in favor of Messaging for In-App and Web. This action sends a POST request to /chat/rest/Chasitor/ChasitorResyncState with required Live Agent headers but no request body.

Input Parameters

string
Live Agent API version (e.g., ‘61.0’). If not provided, automatically extracted from the base_url.
string
required
Session key obtained from an active Live Agent chat session. This value is returned when initiating a chat session and must be preserved for reconnection scenarios.
string
required
Affinity token obtained from an active Live Agent chat session. This token routes the request to the correct server where the session state is maintained.
string
Salesforce organization ID of the chat visitor (not required by API; ignored for backwards compatibility).
string
Client’s incrementing sequence number for request ordering. Must increase with each request in the session. Start with 1 for the first request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFORCE_SERVICE_CLOUD_RETRIEVE_SALESFORCE_USERNAMEQueries Salesforce for a username using the user ID in connection metadata when available. Otherwise, it queries users associated with the organization owner; the returned username is not necessarily the authenticated user’s.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFORCE_SERVICE_CLOUD_SEND_CUSTOM_EVENTSend a custom event from a chat visitor to a Live Agent during an active chat session. Use this tool to trigger custom event handlers on the agent’s side, enabling custom interactions beyond standard chat messages. Custom events can be used for actions like form submissions, button clicks, page navigation, or any application-specific events that need to be communicated to the agent. Prerequisites: - An active Live Agent chat session must be established - Live Agent REST API must be configured and enabled in your Salesforce org - Valid session_key and affinity_token from session initialization Note: This endpoint requires Live Agent to be properly configured. The API typically returns 204 No Content on success.

Input Parameters

string
required
Custom event payload data as a string. Can be JSON-encoded for complex data structures.
string
required
Custom event type identifier used to match event listeners on the agent’s side. Should be a descriptive name.
integer
required
Sequence number for this Live Agent request. Must be incremented with each API call in the session.
string
Live Agent API version (e.g., ‘61.0’). If not specified, automatically extracted from base_url.
string
required
Session key from an active Live Agent chat session (obtained during session initialization).
string
required
Affinity token from an active Live Agent chat session (obtained during session initialization).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFORCE_SERVICE_CLOUD_SET_BREADCRUMBTool to set a breadcrumb URL for the visitor’s current page. Use after a visitor navigates to a new page during an active chat session.

Input Parameters

string
required
Salesforce organization ID (15 or 18 character ID)
string
required
The current location or URL of the visitor.
string
required
Live Agent session ID (sid) from an active chat session
string
required
LiveAgent Chat API version header, e.g., ‘61.0’
string
required
Live Agent deployment ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFORCE_SERVICE_CLOUD_UPLOAD_FILE_TO_S3Tool to upload a file to managed S3 storage. Use when you need to persist files externally.

Input Parameters

object
required
File to upload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SALESFORCE_SERVICE_CLOUD_VISITOR_SENSITIVE_DATA_RULETrigger sensitive data rules for a Live Agent chat visitor after sensitive content is detected, to support masking or handling. An empty success response does not confirm that the rules were applied. DEPRECATED: Salesforce scheduled legacy Chat for retirement on February 14, 2026 and recommends migrating to Messaging for In-App and Web.

Input Parameters

array
required
List of sensitive data rules to apply (at least one rule)
string
required
Affinity token header (X-LIVEAGENT-AFFINITY)
integer
required
Sequence number header (X-LIVEAGENT-SEQUENCE), increments with each call
string
required
Live Agent API version header (X-LIVEAGENT-API-VERSION)
string
required
Session key header (X-LIVEAGENT-SESSION-KEY)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not