Agentforce Connector 1.1 Reference | MuleSoft Documentation
# Agentforce Connector 1.1 Reference
This connector provides connectivity to the AI agents running in Salesforce’s Agentforce platform.
## Configurations
### Config
Default configuration
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Name for this configuration. Connectors reference the configuration with this name.  
**Connection** |  OAuth Client Credentials |  Connection types to provide to this configuration.  
**Read Timeout** |  Read timeout value.  
**Read Timeout Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  Time unit for the **Read Timeout** field.  
The identifier of this element used to reference it in other components  
**Expiration Policy** |  Expiration Policy |  Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate.  
#### Connection Types
##### OAuth Client Credentials
###### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Proxy Configuration** |  One of:
  * Default Http Proxy Config

|  Configures a proxy for outbound connections.  
**Max Connections** |  Maximum number of outbound connections to keep open at the same time.  
**Connection Timeout** |  Amount of time to wait when initially establishing the TCP connection between the connector and Salesforce Agent before throwing an exception if the connection fails.  
**Connection Timeout Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  Time unit for the **Connection Timeout** field.  
**Connection Idle Timeout** |  Number of units that a connection can remain idle before it is closed  
**Connection Idle Timeout Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  Time unit for the **Connection Idle Timeout** field.  
**TLS Configuration** |  Protocol to use for communication.  
**Reconnection** |  |  When the application is deployed, a connectivity test is performed on all connectors. If set to `true`, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
OAuth client ID as registered with the service provider.  
**Client Secret** |  OAuth client secret as registered with the service provider.  
The service provider’s token endpoint URL. |  `https://{salesforceorg}/services/oauth2/token`  
OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.  
**Object Store** |  Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.  
## Supported Operations
  * Continue Agent Conversation
  * End Agent Conversation
  * Start Agent Conversation
  * 

## Continue Agent Conversation
`<ms-agentforce:continue-agent-conversation>`
Surfaces the message from the MuleSoft application to the agent. The agent maintains the context of the conversation and provides a relevant response (or actions) according to the user’s input.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  Name of the configuration to use.  
**Session Id** |  Session ID returned with the **Start agent conversation** operation.  
**Message Sequence Number** |  Increase this number for each subsequent message in a session.  
**Output Mime Type** |  The MIME type of the payload that this operation outputs.  
**Output Encoding** |  Encoding of the payload that this operation outputs.  
**Config Ref** |  ConfigurationProvider |  Name of the configuration to use to execute this component.  
**Streaming Strategy** | 
  * Repeatable In-Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

|  Configures how Mule processes streams. Repeatable streams are the default behavior.  
**Read Timeout** |  Read timeout value.  
**Read Timeout Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  Time unit for the **Read Timeout** field.  
**Target Variable** |  Name of the variable that stores the operation’s output.  
**Target Value** |  Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.  
**Error Mappings** |  Array of Error Mapping |  Set of error mappings.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Retry strategy in case of connectivity errors.  
### For Configurations
### Throws
  * MS-AGENTFORCE:AGENT_METADATA_FAILURE
  * MS-AGENTFORCE:AGENT_OPERATIONS_FAILURE
  * MS-AGENTFORCE:CONNECTIVITY
  * MS-AGENTFORCE:RETRY_EXHAUSTED


## End Agent Conversation
`<ms-agentforce:end-agent-conversation>`
Use the **End agent conversation** operation to close the session after the agent responds.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  Name of the configuration to use.  
**Session Id** |  Session ID returned with the **Start agent conversation** operation.  
**Config Ref** |  ConfigurationProvider |  Name of the configuration to use to execute this component.  
**Streaming Strategy** | 
  * Repeatable In-Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

|  Configures how Mule processes streams. Repeatable streams are the default behavior.  
**Read Timeout** |  Read timeout value.  
**Read Timeout Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  Time unit for the **Read Timeout** field.  
**Target Variable** |  Name of the variable that stores the operation’s output.  
**Target Value** |  Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.  
**Error Mappings** |  Array of Error Mapping |  Set of error mappings.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Retry strategy in case of connectivity errors.  
### For Configurations
### Throws
  * MS-AGENTFORCE:AGENT_METADATA_FAILURE
  * MS-AGENTFORCE:AGENT_OPERATIONS_FAILURE
  * MS-AGENTFORCE:CONNECTIVITY
  * MS-AGENTFORCE:RETRY_EXHAUSTED


## Start Agent Conversation
`<ms-agentforce:start-agent-conversation>`
Establishes the connection between the app and the agent. This is the first step to enable an external application to interact with the AI agent.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  Name of the configuration to use.  
**Output Mime Type** |  MIME type of the payload that this operation outputs.  
**Output Encoding** |  The encoding of the payload that this operation outputs.  
**Config Ref** |  ConfigurationProvider |  Name of the configuration to use to execute this component.  
**Streaming Strategy** | 
  * Repeatable In-Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

|  Configures how Mule processes streams. Repeatable streams are the default behavior.  
**Agent List**  
**Read Timeout** |  Read timeout value.  
**Read Timeout Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  Time unit for the **Read Timeout** field.  
**Target Variable** |  Name of the variable that stores the operation’s output.  
**Target Value** |  Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.  
**Error Mappings** |  Array of Error Mapping |  Set of error mappings.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Retry strategy in case of connectivity errors.  
### Output
Attributes Type |  Invoke Agent Response Attributes  
---|---  
### For Configurations
### Throws
  * MS-AGENTFORCE:AGENT_METADATA_FAILURE
  * MS-AGENTFORCE:AGENT_OPERATIONS_FAILURE
  * MS-AGENTFORCE:CONNECTIVITY
  * MS-AGENTFORCE:RETRY_EXHAUSTED
|  Configures how Mule processes streams. Repeatable streams are the default behavior.  
**Agent List**  
**Read Timeout** |  Read timeout value.  
**Read Timeout Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  Time unit for the **Read Timeout** field.  
**Target Variable** |  Name of the variable that stores the operation’s output.  
**Target Value** |  Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.  
**Error Mappings** |  Array of Error Mapping |  Set of error mappings.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Retry strategy in case of connectivity errors.  
### Output
Attributes Type |  Invoke Agent Response Attributes  
---|---  
### For Configurations
### Throws
  * MS-AGENTFORCE:AGENT_METADATA_FAILURE
  * MS-AGENTFORCE:AGENT_OPERATIONS_FAILURE
  * MS-AGENTFORCE:CONNECTIVITY
  * MS-AGENTFORCE:RETRY_EXHAUSTED


## Unauthorize
`<ms-agentforce:unauthorize>`
Deletes all the access token information of a given resource owner ID so that it’s impossible to execute any operation for that user without doing the authorization dance again
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  Name of the configuration to use.  
**Config Ref** |  ConfigurationProvider |  Name of the configuration to use to execute this component.  
### For Configurations
## Types
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Enabled Protocols** |  Comma-separated list of protocols enabled for this context.  
**Enabled Cipher Suites** |  Comma-separated list of cipher suites enabled for this context.  
**Trust Store**  
**Revocation Check** | 
  * Standard Revocation Check
  * Custom Ocsp Responder

  
### Trust Store
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The location (which will be resolved relative to the current classpath and file system, if possible) of the truststore.  
Password that protects the truststore.  
Type of truststore.  
Encryption algorithm that the truststore uses.  
If `true`, Mule stops performing certificate validations. Setting this to `true` can make connections vulnerable to attacks.  
### Key Store
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Path to the keystore. Mule resolves the path relative to the current classpath and file system, if possible.  
Type of keystore to use.  
Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.  
**Key Password** |  Password used to protect the private key.  
Password used to protect the keystore.  
Encryption algorithm that the keystore uses.  
### Standard Revocation Check
Configures standard revocation checks for TLS certificates.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Only End Entities** |  Which elements to verify in the certificate chain:
  * `true` Verify only the last element in the certificate chain.
  * `false` Verify all elements in the certificate chain.

  
**Prefer Crls** |  How to check certificate validity:
  * `true` Check the Certification Revocation List (CRL) for certificate validity.
  * `false` Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

  
**No Fallback** |  Whether to use the secondary method to check certificate validity:
  * `true` Use the method that wasn’t specified in the **Prefer Crls** field (the secondary method) to check certificate validity.
  * `false` Do not use the secondary method to check certificate validity.

  
What to do if the revocation server can’t be reached or is busy:
  * `true` Avoid verification failure.
  * `false` Allow the verification to fail.

  
### Expiration Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Max Idle Time** |  A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration  
Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  A time unit that qualifies the maxIdleTime attribute  
### Custom Ocsp Responder
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
URL of the OCSP responder.  
**Cert Alias** |  Alias of the signing certificate for the OCSP response (must be in the truststore), if present.  
### Crl File
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Path to the CRL file.  
### Reconnection
Configures a reconnection strategy for an operation.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Fails Deployment** |  When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Reconnection strategy to use.  
### Reconnect
Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often to attempt to reconnect, in milliseconds.  
If `false`, the reconnection strategy runs in a separate, non-blocking thread.  
How many reconnection attempts the Mule app can make.  
### Reconnect Forever
Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often to attempt to reconnect, in milliseconds.  
If `false`, the reconnection strategy runs in a separate, non-blocking thread.  
### Invoke Agent Response Attributes
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Array of Message  
### Message
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Content Safe**  
**Feedback Id**  
### Repeatable In-Memory Stream
Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Initial Buffer Size** |  Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by **Buffer Size Increment** , with an upper limit of **Max Buffer Size**.  
**Buffer Size Increment** |  This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.  
**Max Buffer Size** |  Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a `STREAM_MAXIMUM_SIZE_EXCEEDED` error. A value of less than or equal to `0` means no limit.  
**Buffer Unit** |  Enumeration, one of: |  Unit for the **Initial Buffer Size** , **Buffer Size Increment** , and **Max Buffer Size** fields.  
### Repeatable File Store Stream
Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**In Memory Size** |  Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:
  * Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.
  * Configure a smaller buffer size to decrease memory load at the expense of response time.

  
**Buffer Unit** |  Enumeration, one of: |  Unit for the **In Memory Size** field.  
### Error Mapping
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Enumeration, one of:
  * REDELIVERY_EXHAUSTED
  * TRANSFORMATION
  * EXPRESSION
  * SECURITY
  * CLIENT_SECURITY
  * SERVER_SECURITY
  * ROUTING
  * CONNECTIVITY
  * RETRY_EXHAUSTED
  * TIMEOUT
**Buffer Unit** |  Enumeration, one of: |  Unit for the **In Memory Size** field.  
### Error Mapping
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Enumeration, one of:
  * REDELIVERY_EXHAUSTED
  * TRANSFORMATION
  * EXPRESSION
  * SECURITY
  * CLIENT_SECURITY
  * SERVER_SECURITY
  * ROUTING
  * CONNECTIVITY
  * RETRY_EXHAUSTED
  * TIMEOUT

  
### Default Http Proxy Config
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Non Proxy Hosts**  
## See Also
  * Agentforce Connector Overview