> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Salesforce Service Cloud

> Salesforce Service Cloud is a customer service platform providing case management, knowledge base, omnichannel support, and service automation to deliver exceptional customer experiences

![Salesforce Service Cloud logo](https://mintcdn.com/composio-preview/YYC5iurbUCUzEs77/images/toolkits/salesforce_service_cloud.svg?fit=max\&auto=format\&n=YYC5iurbUCUzEs77\&q=85\&s=4e50703b9f13ea05ba50b89accc46d48)

* **Category:** crm
* **Auth:** OAUTH2
* **Composio-managed OAuth available?** No
* **Tools:** 24
* **Triggers:** 0
* **Slug:** `SALESFORCE_SERVICE_CLOUD`
* **Version:** 20261101\_00

## Tools

> [accordion] Agent Sensitive Data Rule Triggered
>
> **Slug:** `SALESFORCE_SERVICE_CLOUD_AGENT_SENSITIVE_DATA_RULE_TRIGGERED`
>
> Notifies 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
>
> **rules** `array` *required*
>
> One or more sensitive data rules to apply (e.g., to mask SSN, credit cards, or PII in agent messages)
>
> **chat\_id** `string` *required*
>
> Active Live Agent chat session ID obtained when the chat session was established
>
> **api\_version** `string`
>
> Live Agent API version (e.g., '61.0' or '65.0'). If not provided, automatically extracted from connection base\_url
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Chasitor Sneak Peek
>
> **Slug:** `SALESFORCE_SERVICE_CLOUD_CHASITOR_SNEAK_PEEK`
>
> Send 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
>
> **text** `string` *required*
>
> The current in-progress message text that the visitor is typing. Send empty string when typing is cleared
>
> **affinity** `string` *required*
>
> Affinity token received from chat session initialization, used to route requests to the correct Live Agent server (X-LIVEAGENT-AFFINITY)
>
> **position** `integer` *required*
>
> Character position/cursor location in the message being typed. Typically starts at 0 for new message
>
> **sequence** `integer` *required*
>
> Incrementing sequence number for this request (X-LIVEAGENT-SEQUENCE). Must increment with each API call in the session, starting from 1
>
> **api\_version** `string` *required*
>
> Salesforce API version header (X-LIVEAGENT-API-VERSION)
>
> **session\_key** `string` *required*
>
> Unique session key for the active chat session (X-LIVEAGENT-SESSION-KEY)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Composite Batch
>
> **Slug:** `SALESFORCE_SERVICE_CLOUD_COMPOSITE_BATCH`
>
> Tool 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
>
> **haltOnError** `boolean`
>
> If true, stops processing on first subrequest error; subsequent subrequests return HTTP 412. Default false.
>
> **batchRequests** `array` *required*
>
> Array of up to 25 independent subrequests to execute in one call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Composite Request
>
> **Slug:** `SALESFORCE_SERVICE_CLOUD_COMPOSITE_REQUEST`
>
> Execute 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
>
> **allOrNone** `boolean`
>
> If true, treat all subrequests as a single transaction; on first error roll back all prior successes
>
> **compositeRequest** `array` *required*
>
> Ordered list of up to 25 subrequests to execute in sequence. Later requests can reference earlier results using '@\{referenceId.field}' syntax.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Composite SObject Tree
>
> **Slug:** `SALESFORCE_SERVICE_CLOUD_COMPOSITE_SOBJECT_TREE`
>
> Create 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
>
> **records** `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.
>
> **objectApiName** `string` *required*
>
> Root sObject API name (e.g., 'Account', 'Contact', 'Case'). All root records in the request must be of this type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Case Record
>
> **Slug:** `SALESFORCE_SERVICE_CLOUD_CREATE_CASE_RECORD`
>
> Tool to create or upsert a Salesforce Case record. Use when you need to add a new Case or update via external ID.
>
> #### Input Parameters
>
> **accept** `string ("application/json" | "application/xml")`
>
> Desired response format; defaults to application/json
>
> **case\_fields** `object` *required*
>
> Map of Case field API names to values (e.g., Subject, Status, Origin)
>
> **x\_pretty\_print** `string`
>
> Set to '1' to pretty-print the response
>
> **external\_id\_field** `string`
>
> API name of external ID field for upsert; provide with external\_id\_value
>
> **external\_id\_value** `string`
>
> Value of external ID for upsert; provide with external\_id\_field
>
> **sforce\_auto\_assign** `boolean`
>
> Set to True to apply active assignment rules on Case creation or upsert
>
> **sforce\_call\_options** `string`
>
> Client and defaultNamespace options in format 'client=\<name>\[, defaultNamespace=\<ns>]'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Case Record
>
> **Slug:** `SALESFORCE_SERVICE_CLOUD_DELETE_CASE_RECORD`
>
> Tool to delete a Salesforce Case record. Use when you need to remove a case by its record ID.
>
> #### Input Parameters
>
> **case\_id** `string` *required*
>
> Salesforce Case record ID to delete (15-18 character string)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Describe SObject
>
> **Slug:** `SALESFORCE_SERVICE_CLOUD_DESCRIBE_S_OBJECT`
>
> Tool 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
>
> **sObjectName** `string` *required*
>
> API name of the sObject to describe, e.g., 'Account', 'Contact', 'Case'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] End Chat Session
>
> **Slug:** `SALESFORCE_SERVICE_CLOUD_END_CHAT_SESSION`
>
> End 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
>
> **affinity** `string` *required*
>
> Affinity token for session routing to the correct Live Agent server (X-LIVEAGENT-AFFINITY from SessionId GET response)
>
> **api\_version** `string` *required*
>
> Salesforce Live Agent API version (e.g., '61.0'). Should match the version used to create the session.
>
> **session\_key** `string` *required*
>
> The Live Agent session key obtained when creating the chat session (X-LIVEAGENT-SESSION-KEY from SessionId GET response)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Request ID
>
> **Slug:** `SALESFORCE_SERVICE_CLOUD_GENERATE_REQUEST_ID`
>
> Generate 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Signed JWT Assertion
>
> **Slug:** `SALESFORCE_SERVICE_CLOUD_GENERATE_SIGNED_JWT_ASSERTION`
>
> Tool 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
>
> **audience** `string`
>
> Audience claim for the JWT, e.g., login URL or instance domain. Defaults to the instance domain derived from base\_url metadata.
>
> **username** `string` *required*
>
> Salesforce username (subject) for whom to generate the JWT assertion.
>
> **client\_id** `string`
>
> Client (Consumer) ID of the Salesforce Connected App. If provided, overrides value from connection metadata.
>
> **expiration** `integer`
>
> JWT lifetime in seconds from now.
>
> **private\_key** `string`
>
> RSA private key in PEM format used to sign the JWT. If generate\_private\_key is true, this value is ignored.
>
> **generate\_private\_key** `boolean`
>
> If true, generate a temporary RSA private key for signing (useful for testing when a PEM isn't available).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Case Record
>
> **Slug:** `SALESFORCE_SERVICE_CLOUD_GET_CASE_RECORD`
>
> Retrieve 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
>
> **fields** `string`
>
> Comma-separated list of Case field API names to retrieve. If omitted, returns all accessible fields.
>
> **case\_id** `string` *required*
>
> ID of the Case record to retrieve (15- or 18-character Salesforce ID)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Chat Messages
>
> **Slug:** `SALESFORCE_SERVICE_CLOUD_GET_CHAT_MESSAGES`
>
> Tool 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
>
> **ack** `integer`
>
> Sequencing token for polling; use -1 for the first request
>
> **affinity** `string` *required*
>
> Affinity token identifying the session on Chat servers
>
> **api\_version** `string` *required*
>
> Salesforce API version for the request, e.g., '61.0'
>
> **session\_key** `string` *required*
>
> Unique Chat session key
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Live Agent API Version
>
> **Slug:** `SALESFORCE_SERVICE_CLOUD_GET_LIVE_AGENT_API_VERSION`
>
> Retrieve the highest-numbered Salesforce REST API version available from the instance's versions list, along with its root URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Einstein Bots
>
> **Slug:** `SALESFORCE_SERVICE_CLOUD_LIST_EINSTEIN_BOTS`
>
> List 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Query All SOQL
>
> **Slug:** `SALESFORCE_SERVICE_CLOUD_QUERY_ALL_SOQL`
>
> Tool 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
>
> **q** `string` *required*
>
> SOQL query string to execute, must end with 'ALL ROWS' to include deleted and archived records.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Query SOQL
>
> **Slug:** `SALESFORCE_SERVICE_CLOUD_QUERY_SOQL`
>
> Tool to execute a SOQL query. Use when you need to retrieve records from Salesforce via SOQL.
>
> #### Input Parameters
>
> **soql\_query** `string` *required*
>
> SOQL query string to execute.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Reconnect Chat Session
>
> **Slug:** `SALESFORCE_SERVICE_CLOUD_RECONNECT_CHAT_SESSION`
>
> Reconnect 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
>
> **affinity** `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.
>
> **api\_version** `string`
>
> Live Agent API version (e.g., '61.0'). If not provided, automatically derived from base\_url.
>
> **session\_key** `string` *required*
>
> Unique session key identifying the chat session. Obtained from the initial chat session creation. Sent in X-LIVEAGENT-SESSION-KEY header.
>
> **X-LIVEAGENT-SEQUENCE** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resync Chasitor State
>
> **Slug:** `SALESFORCE_SERVICE_CLOUD_RESYNC_CHASITOR_STATE`
>
> Resynchronizes 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
>
> **api\_version** `string`
>
> Live Agent API version (e.g., '61.0'). If not provided, automatically extracted from the base\_url.
>
> **session\_key** `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.
>
> **affinity\_token** `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.
>
> **organization\_id** `string`
>
> Salesforce organization ID of the chat visitor (not required by API; ignored for backwards compatibility).
>
> **X-LIVEAGENT-SEQUENCE** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve Salesforce Username
>
> **Slug:** `SALESFORCE_SERVICE_CLOUD_RETRIEVE_SALESFORCE_USERNAME`
>
> Queries 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Custom Event
>
> **Slug:** `SALESFORCE_SERVICE_CLOUD_SEND_CUSTOM_EVENT`
>
> Send 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
>
> **data** `string` *required*
>
> Custom event payload data as a string. Can be JSON-encoded for complex data structures.
>
> **type** `string` *required*
>
> Custom event type identifier used to match event listeners on the agent's side. Should be a descriptive name.
>
> **sequence** `integer` *required*
>
> Sequence number for this Live Agent request. Must be incremented with each API call in the session.
>
> **api\_version** `string`
>
> Live Agent API version (e.g., '61.0'). If not specified, automatically extracted from base\_url.
>
> **session\_key** `string` *required*
>
> Session key from an active Live Agent chat session (obtained during session initialization).
>
> **affinity\_token** `string` *required*
>
> Affinity token from an active Live Agent chat session (obtained during session initialization).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Breadcrumb
>
> **Slug:** `SALESFORCE_SERVICE_CLOUD_SET_BREADCRUMB`
>
> Tool 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
>
> **org\_id** `string` *required*
>
> Salesforce organization ID (15 or 18 character ID)
>
> **location** `string` *required*
>
> The current location or URL of the visitor.
>
> **session\_id** `string` *required*
>
> Live Agent session ID (sid) from an active chat session
>
> **api\_version** `string` *required*
>
> LiveAgent Chat API version header, e.g., '61.0'
>
> **deployment\_id** `string` *required*
>
> Live Agent deployment ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload File to S3
>
> **Slug:** `SALESFORCE_SERVICE_CLOUD_UPLOAD_FILE_TO_S3`
>
> Tool to upload a file to managed S3 storage. Use when you need to persist files externally.
>
> #### Input Parameters
>
> **file** `object` *required*
>
> File to upload.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Visitor Sensitive Data Rule Triggered
>
> **Slug:** `SALESFORCE_SERVICE_CLOUD_VISITOR_SENSITIVE_DATA_RULE`
>
> Trigger 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
>
> **rules** `array` *required*
>
> List of sensitive data rules to apply (at least one rule)
>
> **affinity** `string` *required*
>
> Affinity token header (X-LIVEAGENT-AFFINITY)
>
> **sequence** `integer` *required*
>
> Sequence number header (X-LIVEAGENT-SEQUENCE), increments with each call
>
> **api\_version** `string` *required*
>
> Live Agent API version header (X-LIVEAGENT-API-VERSION)
>
> **session\_key** `string` *required*
>
> Session key header (X-LIVEAGENT-SESSION-KEY)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
