# mulesoft Agentforce Connector - Full Documentation

<!-- document id=ba2689fa67f4071f3b7a521cae3910b107daa9a101767a12b6a721368e575c38 url=/mulesoft/current/en-us/agentforce-connector/1.0/index.md -->

---
product: Agentforce Connector
version: 1.0
---

# Agentforce Connector 1.0

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Agentforce Connector provides MuleSoft developers with the ability to seamlessly integrate with AI
agents running in Salesforce’s Agentforce platform.

Agentforce Connector offers a group of capabilities that simplify agent integration in MuleSoft
applications.

Use this connector to:

- Build AI agents in a low-code environment.

- Authenticate with a Salesforce org and discover active agents.

- Start a new session with an AI agent application.

- Extend the power of Agentforce by surfacing prompts from external applications to AI agents
  running in Salesforce.

- Orchestrate new, innovative experiences for your customers, partners and employees.

For information about compatibility and fixed issues, see the Agentforce Connector release notes.

## Before You Begin

To use this connector, you must be familiar with:

- Anypoint Connectors

- Mule runtime engine (Mule)

- Elements and global elements in a Mule flow

- How to create a Mule app using Anypoint Code Builder or Anypoint Studio

Before creating an app, you must have:

- Java 8, 11, or 17

- Apache Maven

- Anypoint Platform

- Credentials to connect with your Salesforce org

- The latest versions of Anypoint Code Builder or Anypoint Studio

To configure the connector, you must create a Connected App in Salesforce. For more information, see
[Get Started with the Agent API](https://developer.salesforce.com/docs/ai/agentforce/guide/agent-api-get-started.html)
.

## Common Use Cases for the Connector

These are some common use cases for the connector:

- Customer Service

  Increase human agents' productivity by having AI agents complete time-consuming tasks such as
  reviewing case history, analyzing reported issues, and looking up other related information.

- Sales

  Improve sales team efficacy by accelerating prospect research, generating customized collateral,
  and preparing contracts.

- Marketing

  Support marketing teams by drafting social media copy, executing market research, and completing
  campaign analysis.

## Next Step

After you complete the prerequisites, you are ready to create an app and configure the connector
using [Anypoint Studio](https://docs.mulesoft.com/agentforce-connector/1.0/agentforce-connector-studio) or
[Anypoint Code Builder](https://docs.mulesoft.com/agentforce-connector/1.0/agentforce-connector-config-acb).

## See Also

- [Anypoint Connectors Overview](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Using Anypoint Code Builder to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-acb)

- [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Agentforce Connector Reference](https://docs.mulesoft.com/agentforce-connector/1.0/agentforce-connector-reference)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=3053a71c6bdc66657a46e4d77f113b427badcf53f1e2e63719db4b672d9ee361 url=/mulesoft/current/en-us/agentforce-connector/1.0/agentforce-connector-reference.md -->

---
product: Agentforce Connector
version: 1.0
---

# Agentforce Connector 1.0 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This connector provides connectivity to the AI agents running in Salesforce’s Agentforce platform.

## Configurations

---

### Config

Default configuration

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name for this configuration. Connectors reference the configuration with this name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p><a href="#Config_OauthClientCredentials">OAuth Client Credentials</a></p></div></div></td><td><div><div><p>The connection types to provide to this configuration.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>ID used to reference this configuration.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

#### Connection Types

##### OAuth Client Credentials

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#reconnection">Reconnection</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Client Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The OAuth client ID as registered with the service provider.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Client Secret</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The OAuth client secret as registered with the service provider.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Token Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The service provider’s token endpoint URL.</p></div></div></td><td><div><div><p><code>https://{salesforceorg}/services/oauth2/token</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Scopes</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Object Store</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Supported Operations

- [Continue Agent Conversation](#ContinueAgentConversation)

- [End Agent Conversation](#EndAgentConversation)

- [Start Agent Conversation](#StartAgentConversation)

- [Unauthorize](#Unauthorize)

## Operations

## Continue Agent Conversation

`<ms-agentforce:continue-agent-conversation>`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Message</strong></p></td><td><div><div><p>Any</p></div></div></td><td><div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Session Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Session ID returned with the <strong>Start agent conversation</strong> operation.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Message Sequence Number</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Increase this number for each subsequent message in a session.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Output Mime Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The MIME type of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Output Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encoding of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In-Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#InvokeAgentResponseAttributes">Invoke Agent Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Session Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Session ID returned with the <strong>Start agent conversation</strong> operation.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### 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>`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Output Mime Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>MIME type of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Output Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The encoding of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In-Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Agent List</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#InvokeAgentResponseAttributes">Invoke Agent Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

## Types

### Reconnection

Configures a reconnection strategy for an operation.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Reconnection strategy to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many
reconnection attempts the connector source or operation can make.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How many reconnection attempts the Mule app can make.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Invoke Agent Response Attributes

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Messages</strong></p></td><td><div><div><p>Array of <a href="#Message">Message</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Message

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Content Safe</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Feedback Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Plan Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reason</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by <strong>Buffer Size Increment</strong>, with an upper limit of <strong>Max Buffer Size</strong>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error. A value of less than or equal to <code>0</code> means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit for the <strong>Initial Buffer Size</strong>, <strong>Buffer Size Increment</strong>, and <strong>Max Buffer Size</strong> fields.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>In Memory Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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:</p></div><div><ul><li><p>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.</p></li><li><p>Configure a smaller buffer size to decrease memory load at the expense of response time.</p></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit for the <strong>In Memory Size</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Error Mapping

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Source</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ANY</p></li><li><p>REDELIVERY_EXHAUSTED</p></li><li><p>TRANSFORMATION</p></li><li><p>EXPRESSION</p></li><li><p>SECURITY</p></li><li><p>CLIENT_SECURITY</p></li><li><p>SERVER_SECURITY</p></li><li><p>ROUTING</p></li><li><p>CONNECTIVITY</p></li><li><p>RETRY_EXHAUSTED</p></li><li><p>TIMEOUT</p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

## See Also

- [Agentforce Connector Overview](https://docs.mulesoft.com/agentforce-connector/1.0/)

<!-- document id=bd4ffa72a1a3a68fe7e7a04f4d5329389913a8cd072c2b5e39db79a3250e840d url=/mulesoft/current/en-us/agentforce-connector/1.0/agentforce-connector-xml-maven.md -->

---
product: Agentforce Connector
version: 1.0
---

# Agentforce Connector 1.0 XML and Maven Support

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Code Builder
or Studio:

- If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Code
  Builder or Studio XML editor, or from a text editor, you can access the connector from your app by
  adding reference statements to both your XML Mule flow and the Apache Maven `pom.xml` file.

- If you add the connector in Anypoint Code Builder or Studio, the XML is automatically populated
  the code with the connector’s namespace and schema location and it also adds a dependency to the
  `pom.xml` file.

## Add a Namespace for the Connector

Paste the following code inside the `mule` tag of the header of your configuration XML:

```xml
http://www.mulesoft.org/schema/mule/ms-agentforce
http://www.mulesoft.org/schema/mule/ms-agentforce/current/mule-ms-agentforce.xsd
```

This example shows how the namespace statements are placed in the `<mule>` XML block:

```xml
<mule xmlns:ms-agentforce="http://www.mulesoft.org/schema/mule/ms-agentforce"
    xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
	http://www.mulesoft.org/schema/mule/core/current/mule.xsd
    http://www.mulesoft.org/schema/mule/http
	http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
    http://www.mulesoft.org/schema/mule/ms-agentforce
	http://www.mulesoft.org/schema/mule/ms-agentforce/current/mule-ms-agentforce.xsd">
```

## Add a POM File Dependency

The Apache Maven `pom.xml` file generated by Anypoint Code Builder and Studio contains dependencies
for a Mule app. If you code a Mule app manually, include this XML snippet in your `pom.xml` file to
enable access to this connector:

```xml
<dependency>
	<groupId>com.mulesoft.connectors</groupId>
	<artifactId>mule4-agentforce-connector</artifactId>
	<version>x.x.x</version>
	<classifier>mule-plugin</classifier>
</dependency>
```

Replace `x.x.x` with the version that corresponds to the connector you’re using.

To get the most up-to-date `pom.xml` file information:

1.  Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/).

2.  In Exchange, click **Login** and supply your Anypoint Platform username and password.

3.  In Exchange, search for `agentforce`.

4.  Select the connector.

5.  Click **Dependency Snippets** near the upper right of the screen.

## See Also

- [Agentforce Connector Overview](https://docs.mulesoft.com/agentforce-connector/1.0/)

- [Agentforce Connector Reference](https://docs.mulesoft.com/agentforce-connector/1.0/agentforce-connector-reference)

<!-- document id=3e87304b196dd734d37b6f33218a7fa24894952e31bed4f11304d60f24e074a3 url=/mulesoft/current/en-us/agentforce-connector/1.1/index.md -->

---
product: Agentforce Connector
version: 1.1
---

# Agentforce Connector 1.1

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Agentforce Connector provides MuleSoft developers with the ability to seamlessly integrate with AI
agents running in Salesforce’s Agentforce platform.

Agentforce Connector offers a group of capabilities that simplify agent integration in MuleSoft
applications.

Use this connector to:

- Build AI agents in a low-code environment.

- Authenticate with a Salesforce org and discover active agents.

- Start a new session with an AI agent application.

- Extend the power of Agentforce by surfacing prompts from external applications to AI agents
  running in Salesforce.

- Orchestrate new, innovative experiences for your customers, partners and employees.

For information about compatibility and fixed issues, see the Agentforce Connector release notes.

## Before You Begin

To use this connector, you must be familiar with:

- Anypoint Connectors

- Mule runtime engine (Mule)

- Elements and global elements in a Mule flow

- How to create a Mule app using Anypoint Code Builder or Anypoint Studio

Before creating an app, you must have:

- Java 8, 11, or 17

- Apache Maven

- Anypoint Platform

- Credentials to connect with your Salesforce org

- The latest versions of Anypoint Code Builder or Anypoint Studio

To configure the connector, you must create a Connected App in Salesforce. For more information, see
[Get Started with the Agent API](https://developer.salesforce.com/docs/ai/agentforce/guide/agent-api-get-started.html)
.

## Common Use Cases for the Connector

These are some common use cases for the connector:

- Customer Service

  Increase human agents' productivity by having AI agents complete time-consuming tasks such as
  reviewing case history, analyzing reported issues, and looking up other related information.

- Sales

  Improve sales team efficacy by accelerating prospect research, generating customized collateral,
  and preparing contracts.

- Marketing

  Support marketing teams by drafting social media copy, executing market research, and completing
  campaign analysis.

## Next Step

After you complete the prerequisites, you are ready to create an app and configure the connector
using [Anypoint Studio](https://docs.mulesoft.com/agentforce-connector/1.1/agentforce-connector-studio) or
[Anypoint Code Builder](https://docs.mulesoft.com/agentforce-connector/1.1/agentforce-connector-config-acb).

## See Also

- [Anypoint Connectors Overview](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Using Anypoint Code Builder to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-acb)

- [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Agentforce Connector Reference](https://docs.mulesoft.com/agentforce-connector/1.1/agentforce-connector-reference)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=96f16afe64b83ff8e3a237b4459adda730466bc884c3f8133b77f94b41ba4433 url=/mulesoft/current/en-us/agentforce-connector/1.1/agentforce-connector-reference.md -->

---
product: Agentforce Connector
version: 1.1
---

# Agentforce Connector 1.1 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This connector provides connectivity to the AI agents running in Salesforce’s Agentforce platform.

## Configurations

---

### Config

Default configuration

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name for this configuration. Connectors reference the configuration with this name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p><a href="#Config_OauthClientCredentials">OAuth Client Credentials</a></p></div></div></td><td><div><div><p>Connection types to provide to this configuration.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Read Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Read timeout value.</p></div></div></td><td><div><div><p>30</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Read Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The identifier of this element used to reference it in other components</p></div></div></td><td><div></div></td><td><div><div><p><strong>x</strong></p></div></div></td></tr><tr><td><p><strong>Expiration Policy</strong></p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Connection Types

##### OAuth Client Credentials

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Proxy Configuration</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#DefaultHttpProxyConfig">Default Http Proxy Config</a></p></li></ul></div></div></td><td><div><div><p>Configures a proxy for outbound connections.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Connections</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum number of outbound connections to keep open at the same time.</p></div></div></td><td><div><div><p>-1</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>30</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Connection Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Idle Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Number of units that a connection can remain idle before it is closed</p></div></div></td><td><div><div><p>30</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Idle Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Connection Idle Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>TLS Configuration</strong></p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td><div><div><p>Protocol to use for communication.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Client Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>OAuth client ID as registered with the service provider.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Client Secret</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>OAuth client secret as registered with the service provider.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Token Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The service provider’s token endpoint URL.</p></div></div></td><td><div><div><p><code>https://{salesforceorg}/services/oauth2/token</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Scopes</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Object Store</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Supported Operations

- [Continue Agent Conversation](#ContinueAgentConversation)

- [End Agent Conversation](#EndAgentConversation)

- [Start Agent Conversation](#StartAgentConversation)

- [Unauthorize](#Unauthorize)

## Operations

## 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Message</strong></p></td><td><div><div><p>Any</p></div></div></td><td><div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Session Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Session ID returned with the <strong>Start agent conversation</strong> operation.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Message Sequence Number</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Increase this number for each subsequent message in a session.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Output Mime Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The MIME type of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Output Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encoding of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In-Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Read timeout value.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Read Timeout</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#InvokeAgentResponseAttributes">Invoke Agent Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Session Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Session ID returned with the <strong>Start agent conversation</strong> operation.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p><strong>x</strong></p></div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In-Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Read timeout value.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Read Timeout</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Output Mime Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>MIME type of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Output Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The encoding of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In-Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Agent List</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Read Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Read timeout value.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Read Timeout</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#InvokeAgentResponseAttributes">Invoke Agent Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

## Types

### Tls

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Enabled Protocols</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of protocols enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enabled Cipher Suites</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of cipher suites enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Trust Store</strong></p></td><td><div><div><p><a href="#TrustStore">Trust Store</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p><a href="#KeyStore">Key Store</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Revocation Check</strong></p></td><td><div><div><ul><li><p><a href="#StandardRevocationCheck">Standard Revocation Check</a></p></li><li><p><a href="#CustomOcspResponder">Custom Ocsp Responder</a></p></li><li><p><a href="#CrlFile">Crl File</a></p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Trust Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The location (which will be resolved relative to the current classpath and file system, if possible) of the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password that protects the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encryption algorithm that the truststore uses.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Insecure</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>true</code>, Mule stops performing certificate validations. Setting this to <code>true</code> can make connections vulnerable to attacks.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Key Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the keystore. Mule resolves the path relative to the current classpath and file system, if possible.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of keystore to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the private key.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encryption algorithm that the keystore uses.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Standard Revocation Check

Configures standard revocation checks for TLS certificates.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Only End Entities</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Which elements to verify in the certificate chain:</p></div><div><ul><li><p><code>true</code></p><div><p>Verify only the last element in the certificate chain.</p></div></li><li><p><code>false</code></p><div><p>Verify all elements in the certificate chain.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Prefer Crls</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>How to check certificate validity:</p></div><div><ul><li><p><code>true</code></p><div><p>Check the Certification Revocation List (CRL) for certificate validity.</p></div></li><li><p><code>false</code></p><div><p>Use the Online Certificate Status Protocol (OCSP) to check certificate validity.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>No Fallback</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether to use the secondary method to check certificate validity:</p></div><div><ul><li><p><code>true</code></p><div><p>Use the method that wasn’t specified in the <strong>Prefer Crls</strong> field (the secondary method) to check certificate validity.</p></div></li><li><p><code>false</code></p><div><p>Do not use the secondary method to check certificate validity.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Soft Fail</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>What to do if the revocation server can’t be reached or is busy:</p></div><div><ul><li><p><code>true</code></p><div><p>Avoid verification failure.</p></div></li><li><p><code>false</code></p><div><p>Allow the verification to fail.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Expiration Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>A time unit that qualifies the maxIdleTime attribute</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Custom Ocsp Responder

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the OCSP responder.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Cert Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the signing certificate for the OCSP response (must be in the truststore), if present.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Crl File

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the CRL file.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnection

Configures a reconnection strategy for an operation.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Reconnection strategy to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many
reconnection attempts the connector source or operation can make.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How many reconnection attempts the Mule app can make.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Invoke Agent Response Attributes

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Messages</strong></p></td><td><div><div><p>Array of <a href="#Message">Message</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Message

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Content Safe</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Feedback Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Plan Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reason</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by <strong>Buffer Size Increment</strong>, with an upper limit of <strong>Max Buffer Size</strong>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error. A value of less than or equal to <code>0</code> means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit for the <strong>Initial Buffer Size</strong>, <strong>Buffer Size Increment</strong>, and <strong>Max Buffer Size</strong> fields.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>In Memory Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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:</p></div><div><ul><li><p>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.</p></li><li><p>Configure a smaller buffer size to decrease memory load at the expense of response time.</p></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit for the <strong>In Memory Size</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Error Mapping

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Source</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ANY</p></li><li><p>REDELIVERY_EXHAUSTED</p></li><li><p>TRANSFORMATION</p></li><li><p>EXPRESSION</p></li><li><p>SECURITY</p></li><li><p>CLIENT_SECURITY</p></li><li><p>SERVER_SECURITY</p></li><li><p>ROUTING</p></li><li><p>CONNECTIVITY</p></li><li><p>RETRY_EXHAUSTED</p></li><li><p>TIMEOUT</p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Default Http Proxy Config

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Non Proxy Hosts</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## See Also

- [Agentforce Connector Overview](https://docs.mulesoft.com/agentforce-connector/1.1/)

<!-- document id=e655add3895b5d6d6161e48085493d37a0940a375aaef14fb8d62c2168328376 url=/mulesoft/current/en-us/agentforce-connector/1.1/agentforce-connector-xml-maven.md -->

---
product: Agentforce Connector
version: 1.1
---

# Agentforce Connector 1.1 XML and Maven Support

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Code Builder
or Studio:

- If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Code
  Builder or Studio XML editor, or from a text editor, you can access the connector from your app by
  adding reference statements to both your XML Mule flow and the Apache Maven `pom.xml` file.

- If you add the connector in Anypoint Code Builder or Studio, the XML is automatically populated
  the code with the connector’s namespace and schema location and it also adds a dependency to the
  `pom.xml` file.

## Add a Namespace for the Connector

Paste the following code inside the `mule` tag of the header of your configuration XML:

```xml
http://www.mulesoft.org/schema/mule/ms-agentforce
http://www.mulesoft.org/schema/mule/ms-agentforce/current/mule-ms-agentforce.xsd
```

This example shows how the namespace statements are placed in the `<mule>` XML block:

```xml
<mule xmlns:ms-agentforce="http://www.mulesoft.org/schema/mule/ms-agentforce"
    xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
	http://www.mulesoft.org/schema/mule/core/current/mule.xsd
    http://www.mulesoft.org/schema/mule/http
	http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
    http://www.mulesoft.org/schema/mule/ms-agentforce
	http://www.mulesoft.org/schema/mule/ms-agentforce/current/mule-ms-agentforce.xsd">
```

## Add a POM File Dependency

The Apache Maven `pom.xml` file generated by Anypoint Code Builder and Studio contains dependencies
for a Mule app. If you code a Mule app manually, include this XML snippet in your `pom.xml` file to
enable access to this connector:

```xml
<dependency>
	<groupId>com.mulesoft.connectors</groupId>
	<artifactId>mule4-agentforce-connector</artifactId>
	<version>x.x.x</version>
	<classifier>mule-plugin</classifier>
</dependency>
```

Replace `x.x.x` with the version that corresponds to the connector you’re using.

To get the most up-to-date `pom.xml` file information:

1.  Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/).

2.  In Exchange, click **Login** and supply your Anypoint Platform username and password.

3.  In Exchange, search for `agentforce`.

4.  Select the connector.

5.  Click **Dependency Snippets** near the upper right of the screen.

## See Also

- [Agentforce Connector Overview](https://docs.mulesoft.com/agentforce-connector/1.1/)

- [Agentforce Connector Reference](https://docs.mulesoft.com/agentforce-connector/1.1/agentforce-connector-reference)

<!-- document id=f8a8a11a7246318553a47dd78ed008e6c187f846caa9ac0662f85f1375d1d0cd url=/mulesoft/current/en-us/agentforce-connector/1.2/index.md -->

---
product: Agentforce Connector
version: 1.2
---

# Agentforce Connector 1.2

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Agentforce Connector provides MuleSoft developers with the ability to seamlessly integrate with AI
agents running in Salesforce’s Agentforce platform.

Agentforce Connector offers a group of capabilities that simplify agent integration in MuleSoft
applications.

Use this connector to:

- Build AI agents in a low-code environment.

- Authenticate with a Salesforce org and discover active agents.

- Start a new session with an AI agent application.

- Extend the power of Agentforce by surfacing prompts from external applications to AI agents
  running in Salesforce.

- Orchestrate new, innovative experiences for your customers, partners and employees.

For information about compatibility and fixed issues, see the Agentforce Connector release notes.

## Before You Begin

To use this connector, you must be familiar with:

- Anypoint Connectors

- Mule runtime engine (Mule)

- Elements and global elements in a Mule flow

- How to create a Mule app using Anypoint Code Builder or Anypoint Studio

Before creating an app, you must have:

- Java 8, 11, or 17

- Apache Maven

- Anypoint Platform

- Credentials to connect with your Salesforce org

- The latest versions of Anypoint Code Builder or Anypoint Studio

To configure the connector, you must create a Connected App in Salesforce. For more information, see
[Get Started with the Agent API](https://developer.salesforce.com/docs/ai/agentforce/guide/agent-api-get-started.html)
.

## Common Use Cases for the Connector

These are some common use cases for the connector:

- Customer Service

  Increase human agents' productivity by having AI agents complete time-consuming tasks such as
  reviewing case history, analyzing reported issues, and looking up other related information.

- Sales

  Improve sales team efficacy by accelerating prospect research, generating customized collateral,
  and preparing contracts.

- Marketing

  Support marketing teams by drafting social media copy, executing market research, and completing
  campaign analysis.

## Next Step

After you complete the prerequisites, you are ready to create an app and configure the connector
using [Anypoint Studio](https://docs.mulesoft.com/agentforce-connector/1.2/agentforce-connector-studio) or
[Anypoint Code Builder](https://docs.mulesoft.com/agentforce-connector/1.2/agentforce-connector-config-acb).

## See Also

- [Anypoint Connectors Overview](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Using Anypoint Code Builder to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-acb)

- [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Agentforce Connector Reference](https://docs.mulesoft.com/agentforce-connector/1.2/agentforce-connector-reference)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=f9feb31c8df365e2367e93fbe1163f85fb80cf3de5da15fa058facd48892027c url=/mulesoft/current/en-us/agentforce-connector/1.2/agentforce-connector-reference.md -->

---
product: Agentforce Connector
version: 1.2
---

# Agentforce Connector 1.2 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This connector provides connectivity to the AI agents running in Salesforce’s Agentforce platform.

## Configurations

---

### Config

Default configuration

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name for this configuration. Connectors reference the configuration with this name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p><a href="#Config_OauthClientCredentials">OAuth Client Credentials</a></p></div></div></td><td><div><div><p>Connection types to provide to this configuration.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Read Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Read timeout value.</p></div></div></td><td><div><div><p>30</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Read Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The identifier of this element used to reference it in other components</p></div></div></td><td><div></div></td><td><div><div><p><strong>x</strong></p></div></div></td></tr><tr><td><p><strong>Expiration Policy</strong></p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Connection Types

##### OAuth Client Credentials

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Proxy Configuration</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#DefaultHttpProxyConfig">Default Http Proxy Config</a></p></li></ul></div></div></td><td><div><div><p>Configures a proxy for outbound connections.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Connections</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum number of outbound connections to keep open at the same time.</p></div></div></td><td><div><div><p>-1</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>30</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Connection Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Idle Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Number of units that a connection can remain idle before it is closed</p></div></div></td><td><div><div><p>30</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Idle Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Connection Idle Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>TLS Configuration</strong></p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td><div><div><p>Protocol to use for communication.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Client Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>OAuth client ID as registered with the service provider.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Client Secret</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>OAuth client secret as registered with the service provider.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Token Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The service provider’s token endpoint URL.</p></div></div></td><td><div><div><p><code>https://{salesforceorg}/services/oauth2/token</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Scopes</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Object Store</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Supported Operations

- [Continue Agent Conversation](#ContinueAgentConversation)

- [End Agent Conversation](#EndAgentConversation)

- [Start Agent Conversation](#StartAgentConversation)

- [Unauthorize](#Unauthorize)

## Operations

## 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Message</strong></p></td><td><div><div><p>Any</p></div></div></td><td><div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Session Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Session ID returned with the <strong>Start agent conversation</strong> operation.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Message Sequence Number</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Increase this number for each subsequent message in a session.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Output Mime Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The MIME type of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Output Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encoding of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In-Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Read timeout value.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Read Timeout</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#InvokeAgentResponseAttributes">Invoke Agent Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Session Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Session ID returned with the <strong>Start agent conversation</strong> operation.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Output Mime Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The MIME type of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Output Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encoding of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p><strong>x</strong></p></div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In-Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Read timeout value.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Read Timeout</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#InvokeAgentResponseAttributes">Invoke Agent Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Output Mime Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>MIME type of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Output Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The encoding of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In-Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Agent List</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Bypass User</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Bypasses current user’s permissions when the agent needs to access Data Cloud assets.</p></div></div></td><td><div><div><p>#[false]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Read timeout value.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Read Timeout</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#InvokeAgentResponseAttributes">Invoke Agent Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

## Types

### Tls

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Enabled Protocols</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of protocols enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enabled Cipher Suites</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of cipher suites enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Trust Store</strong></p></td><td><div><div><p><a href="#TrustStore">Trust Store</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p><a href="#KeyStore">Key Store</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Revocation Check</strong></p></td><td><div><div><ul><li><p><a href="#StandardRevocationCheck">Standard Revocation Check</a></p></li><li><p><a href="#CustomOcspResponder">Custom Ocsp Responder</a></p></li><li><p><a href="#CrlFile">Crl File</a></p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Trust Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The location (which will be resolved relative to the current classpath and file system, if possible) of the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password that protects the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encryption algorithm that the truststore uses.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Insecure</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>true</code>, Mule stops performing certificate validations. Setting this to <code>true</code> can make connections vulnerable to attacks.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Key Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the keystore. Mule resolves the path relative to the current classpath and file system, if possible.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of keystore to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the private key.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encryption algorithm that the keystore uses.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Standard Revocation Check

Configures standard revocation checks for TLS certificates.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Only End Entities</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Which elements to verify in the certificate chain:</p></div><div><ul><li><p><code>true</code></p><div><p>Verify only the last element in the certificate chain.</p></div></li><li><p><code>false</code></p><div><p>Verify all elements in the certificate chain.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Prefer Crls</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>How to check certificate validity:</p></div><div><ul><li><p><code>true</code></p><div><p>Check the Certification Revocation List (CRL) for certificate validity.</p></div></li><li><p><code>false</code></p><div><p>Use the Online Certificate Status Protocol (OCSP) to check certificate validity.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>No Fallback</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether to use the secondary method to check certificate validity:</p></div><div><ul><li><p><code>true</code></p><div><p>Use the method that wasn’t specified in the <strong>Prefer Crls</strong> field (the secondary method) to check certificate validity.</p></div></li><li><p><code>false</code></p><div><p>Do not use the secondary method to check certificate validity.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Soft Fail</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>What to do if the revocation server can’t be reached or is busy:</p></div><div><ul><li><p><code>true</code></p><div><p>Avoid verification failure.</p></div></li><li><p><code>false</code></p><div><p>Allow the verification to fail.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Expiration Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>A time unit that qualifies the maxIdleTime attribute</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Custom Ocsp Responder

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the OCSP responder.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Cert Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the signing certificate for the OCSP response (must be in the truststore), if present.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Crl File

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the CRL file.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnection

Configures a reconnection strategy for an operation.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Reconnection strategy to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many
reconnection attempts the connector source or operation can make.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How many reconnection attempts the Mule app can make.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Invoke Agent Response Attributes

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Messages</strong></p></td><td><div><div><p>Array of <a href="#Message">Message</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Message

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Collect</strong></p></td><td><div><div><p>Array of <a href="#Collect">Collect</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Content Safe</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Feedback Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Plan Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reason</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Collect

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Data</strong></p></td><td><div><div><p><a href="#CollectData">Collect Data</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Property</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Collect Data

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Property</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Value</strong></p></td><td><div><div><p>Array of <a href="#SearchResult">Search Result</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Search Result

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>S Object Info</strong></p></td><td><div><div><p><a href="#SObjectInfo">S Object Info</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Data</strong></p></td><td><div><div><p><a href="#RecordData">Record Data</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Record Type Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Title</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### S Object Info

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Api Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Label</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Record Data

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Id</strong></p></td><td><div><div><p><a href="#RecordField">Record Field</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Name</strong></p></td><td><div><div><p><a href="#RecordField">Record Field</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p><a href="#RecordField">Record Field</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Record Field

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Display Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by <strong>Buffer Size Increment</strong>, with an upper limit of <strong>Max Buffer Size</strong>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error. A value of less than or equal to <code>0</code> means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit for the <strong>Initial Buffer Size</strong>, <strong>Buffer Size Increment</strong>, and <strong>Max Buffer Size</strong> fields.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>In Memory Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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:</p></div><div><ul><li><p>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.</p></li><li><p>Configure a smaller buffer size to decrease memory load at the expense of response time.</p></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit for the <strong>In Memory Size</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Error Mapping

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Source</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ANY</p></li><li><p>REDELIVERY_EXHAUSTED</p></li><li><p>TRANSFORMATION</p></li><li><p>EXPRESSION</p></li><li><p>SECURITY</p></li><li><p>CLIENT_SECURITY</p></li><li><p>SERVER_SECURITY</p></li><li><p>ROUTING</p></li><li><p>CONNECTIVITY</p></li><li><p>RETRY_EXHAUSTED</p></li><li><p>TIMEOUT</p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Default Http Proxy Config

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Non Proxy Hosts</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## See Also

- [Agentforce Connector Overview](https://docs.mulesoft.com/agentforce-connector/1.2/)

<!-- document id=a66711efe6df83e8a0152a1ba3c65d37dac651e72a7cba584439979134b1679d url=/mulesoft/current/en-us/agentforce-connector/1.2/agentforce-connector-xml-maven.md -->

---
product: Agentforce Connector
version: 1.2
---

# Agentforce Connector 1.2 XML and Maven Support

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Code Builder
or Studio:

- If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Code
  Builder or Studio XML editor, or from a text editor, you can access the connector from your app by
  adding reference statements to both your XML Mule flow and the Apache Maven `pom.xml` file.

- If you add the connector in Anypoint Code Builder or Studio, the XML is automatically populated
  the code with the connector’s namespace and schema location and it also adds a dependency to the
  `pom.xml` file.

## Add a Namespace for the Connector

Paste the following code inside the `mule` tag of the header of your configuration XML:

```xml
http://www.mulesoft.org/schema/mule/ms-agentforce
http://www.mulesoft.org/schema/mule/ms-agentforce/current/mule-ms-agentforce.xsd
```

This example shows how the namespace statements are placed in the `<mule>` XML block:

```xml
<mule xmlns:ms-agentforce="http://www.mulesoft.org/schema/mule/ms-agentforce"
    xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
	http://www.mulesoft.org/schema/mule/core/current/mule.xsd
    http://www.mulesoft.org/schema/mule/http
	http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
    http://www.mulesoft.org/schema/mule/ms-agentforce
	http://www.mulesoft.org/schema/mule/ms-agentforce/current/mule-ms-agentforce.xsd">
```

## Add a POM File Dependency

The Apache Maven `pom.xml` file generated by Anypoint Code Builder and Studio contains dependencies
for a Mule app. If you code a Mule app manually, include this XML snippet in your `pom.xml` file to
enable access to this connector:

```xml
<dependency>
	<groupId>com.mulesoft.connectors</groupId>
	<artifactId>mule4-agentforce-connector</artifactId>
	<version>x.x.x</version>
	<classifier>mule-plugin</classifier>
</dependency>
```

Replace `x.x.x` with the version that corresponds to the connector you’re using.

To get the most up-to-date `pom.xml` file information:

1.  Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/).

2.  In Exchange, click **Login** and supply your Anypoint Platform username and password.

3.  In Exchange, search for `agentforce`.

4.  Select the connector.

5.  Click **Dependency Snippets** near the upper right of the screen.

## See Also

- [Agentforce Connector Overview](https://docs.mulesoft.com/agentforce-connector/1.2/)

- [Agentforce Connector Reference](https://docs.mulesoft.com/agentforce-connector/1.2/agentforce-connector-reference)

<!-- document id=54516775961f1785b595a518bf91c514ac5695b7d19d5597fb36bed70fe42197 url=/mulesoft/current/en-us/agentforce-connector/latest/index.md -->

---
product: Agentforce Connector
version: 1.3
is-latest-version: true
---

# Agentforce Connector 1.3

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Agentforce Connector provides MuleSoft developers with the ability to seamlessly integrate with AI
agents running in Salesforce’s Agentforce platform.

Agentforce Connector offers a group of capabilities that simplify agent integration in MuleSoft
applications.

Use this connector to:

- Build AI agents in a low-code environment.

- Authenticate with a Salesforce org and discover active agents.

- Start a new session with an AI agent application.

- Extend the power of Agentforce by surfacing prompts from external applications to AI agents
  running in Salesforce.

- Orchestrate new, innovative experiences for your customers, partners and employees.

For information about compatibility and fixed issues, see the Agentforce Connector release notes.

## Before You Begin

To use this connector, you must be familiar with:

- Anypoint Connectors

- Mule runtime engine (Mule)

- Elements and global elements in a Mule flow

- How to create a Mule app using Anypoint Code Builder or Anypoint Studio

Before creating an app, you must have:

- Java 8, 11, or 17

- Apache Maven

- Anypoint Platform

- Credentials to connect with your Salesforce org

- The latest versions of Anypoint Code Builder or Anypoint Studio

To configure the connector, you must create a Connected App in Salesforce. For more information, see
[Get Started with the Agent API](https://developer.salesforce.com/docs/ai/agentforce/guide/agent-api-get-started.html)
.

## Common Use Cases for the Connector

These are some common use cases for the connector:

- Customer Service

  Increase human agents' productivity by having AI agents complete time-consuming tasks such as
  reviewing case history, analyzing reported issues, and looking up other related information.

- Sales

  Improve sales team efficacy by accelerating prospect research, generating customized collateral,
  and preparing contracts.

- Marketing

  Support marketing teams by drafting social media copy, executing market research, and completing
  campaign analysis.

## Next Step

After you complete the prerequisites, you are ready to create an app and configure the connector
using [Anypoint Studio](https://docs.mulesoft.com/agentforce-connector/latest/agentforce-connector-studio) or
[Anypoint Code Builder](https://docs.mulesoft.com/agentforce-connector/latest/agentforce-connector-config-acb).

## See Also

- [Anypoint Connectors Overview](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Using Anypoint Code Builder to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-acb)

- [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Agentforce Connector Reference](https://docs.mulesoft.com/agentforce-connector/latest/agentforce-connector-reference)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=1e9996499ba0569df083b393bf9cefb032e00dd35e8193265a21cf54ffa248e4 url=/mulesoft/current/en-us/agentforce-connector/latest/agentforce-connector-reference.md -->

---
product: Agentforce Connector
version: 1.3
is-latest-version: true
---

# Agentforce Connector 1.3 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This connector provides connectivity to the AI agents running in Salesforce’s Agentforce platform.

## Configurations

---

### Config

Default configuration

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name for this configuration. Connectors reference the configuration with this name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p><a href="#Config_OauthClientCredentials">OAuth Client Credentials</a></p></div></div></td><td><div><div><p>Connection types to provide to this configuration.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Read Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Read timeout value.</p></div></div></td><td><div><div><p>30</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Read Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The identifier of this element used to reference it in other components</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Expiration Policy</strong></p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Connection Types

##### OAuth Client Credentials

Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more
information, refer to
[Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2),
[Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub),
or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth).

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Proxy Configuration</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#DefaultHttpProxyConfig">Default Http Proxy Config</a></p></li></ul></div></div></td><td><div><div><p>Configures a proxy for outbound connections.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Connections</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum number of outbound connections to keep open at the same time.</p></div></div></td><td><div><div><p>-1</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>30</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Connection Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Idle Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Number of units that a connection can remain idle before it is closed</p></div></div></td><td><div><div><p>30</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Idle Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Connection Idle Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>TLS Configuration</strong></p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td><div><div><p>Protocol to use for communication.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Client Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>OAuth client ID as registered with the service provider.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Client Secret</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>OAuth client secret as registered with the service provider.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Token Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The service provider’s token endpoint URL.</p></div></div></td><td><div><div><p><code>https://{salesforceorg}/services/oauth2/token</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Scopes</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Object Store</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Supported Operations

- [Continue Agent Conversation (Deprecated)](#ContinueAgentConversation)

- [End Agent Conversation](#EndAgentConversation)

- [Send Message (Sync)](#SendMessageSync)

- [Start Agent Conversation](#StartAgentConversation)

- [Unauthorize](#Unauthorize)

## Operations

## Continue Agent Conversation (Deprecated)

`<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. The
**Continue Agent Conversation** operation is now deprecated. Use the
[**Send Message (Sync)**](#SendMessageSync) operation instead.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Message</strong></p></td><td><div><div><p>Any</p></div></div></td><td><div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Session Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Session ID returned with the <strong>Start agent conversation</strong> operation.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Message Sequence Number</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Increase this number for each subsequent message in a session.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Output Mime Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The MIME type of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Output Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encoding of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In-Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Read timeout value.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Read Timeout</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#InvokeAgentResponseAttributes">Invoke Agent Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- MS-AGENTFORCE:AGENT\_API\_ERROR

- MS-AGENTFORCE:AGENT\_METADATA\_FAILURE

- MS-AGENTFORCE:AGENT\_OPERATIONS\_FAILURE

- MS-AGENTFORCE:CONNECTIVITY

- MS-AGENTFORCE:INVALID\_CONNECTION

- 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Session Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Session ID returned with the <strong>Start agent conversation</strong> operation.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Output Mime Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The MIME type of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Output Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encoding of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In-Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Read timeout value.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Read Timeout</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#InvokeAgentResponseAttributes">Invoke Agent Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- MS-AGENTFORCE:AGENT\_API\_ERROR

- MS-AGENTFORCE:AGENT\_METADATA\_FAILURE

- MS-AGENTFORCE:AGENT\_OPERATIONS\_FAILURE

- MS-AGENTFORCE:CONNECTIVITY

- MS-AGENTFORCE:INVALID\_CONNECTION

- MS-AGENTFORCE:RETRY\_EXHAUSTED

## Send Message (Sync)

`<ms-agentforce:send-message-sync>`

Sends a message to the agent and waits for a synchronous response.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Message</strong></p></td><td><div><div><p>Any</p></div></div></td><td><div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Session Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Session ID returned with the <strong>Start agent conversation</strong> operation.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Message Sequence Number</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Increase this number for each subsequent message in a session.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Agent Variables</strong></p></td><td><div><div><p>Array of <a href="#Variable">Variable</a></p></div></div></td><td><div><div><p>Array of custom and context agent variables.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Output Mime Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The MIME type of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Output Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encoding of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In-Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Read timeout value.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Read Timeout</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#AgentResponseMetadata">Agent Response Metadata</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- MS-AGENTFORCE:AGENT\_API\_ERROR

- MS-AGENTFORCE:AGENT\_METADATA\_FAILURE

- MS-AGENTFORCE:AGENT\_OPERATIONS\_FAILURE

- MS-AGENTFORCE:CONNECTIVITY

- MS-AGENTFORCE:INVALID\_CONNECTION

- 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Output Mime Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>MIME type of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Output Encoding</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The encoding of the payload that this operation outputs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In-Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Agent List</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Bypass User</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Bypasses current user’s permissions when the agent needs to access Data Cloud assets.</p></div></div></td><td><div><div><p>#[false]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Agent Variables</strong></p></td><td><div><div><p>Array of <a href="#Variable">Variable</a></p></div></div></td><td><div><div><p>Array of custom and context agent variables.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Read timeout value.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Read Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Read Timeout</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#InvokeAgentResponseAttributes">Invoke Agent Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- MS-AGENTFORCE:AGENT\_API\_ERROR

- MS-AGENTFORCE:AGENT\_METADATA\_FAILURE

- MS-AGENTFORCE:AGENT\_OPERATIONS\_FAILURE

- MS-AGENTFORCE:CONNECTIVITY

- MS-AGENTFORCE:INVALID\_CONNECTION

- 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

## Types

### Tls

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Enabled Protocols</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of protocols enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enabled Cipher Suites</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of cipher suites enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Trust Store</strong></p></td><td><div><div><p><a href="#TrustStore">Trust Store</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p><a href="#KeyStore">Key Store</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Revocation Check</strong></p></td><td><div><div><ul><li><p><a href="#StandardRevocationCheck">Standard Revocation Check</a></p></li><li><p><a href="#CustomOcspResponder">Custom Ocsp Responder</a></p></li><li><p><a href="#CrlFile">Crl File</a></p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Trust Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The location (which will be resolved relative to the current classpath and file system, if possible) of the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password that protects the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encryption algorithm that the truststore uses.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Insecure</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>true</code>, Mule stops performing certificate validations. Setting this to <code>true</code> can make connections vulnerable to attacks.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Key Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the keystore. Mule resolves the path relative to the current classpath and file system, if possible.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of keystore to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the private key.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encryption algorithm that the keystore uses.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Standard Revocation Check

Configures standard revocation checks for TLS certificates.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Only End Entities</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Which elements to verify in the certificate chain:</p></div><div><ul><li><p><code>true</code></p><div><p>Verify only the last element in the certificate chain.</p></div></li><li><p><code>false</code></p><div><p>Verify all elements in the certificate chain.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Prefer Crls</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>How to check certificate validity:</p></div><div><ul><li><p><code>true</code></p><div><p>Check the Certification Revocation List (CRL) for certificate validity.</p></div></li><li><p><code>false</code></p><div><p>Use the Online Certificate Status Protocol (OCSP) to check certificate validity.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>No Fallback</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether to use the secondary method to check certificate validity:</p></div><div><ul><li><p><code>true</code></p><div><p>Use the method that wasn’t specified in the <strong>Prefer Crls</strong> field (the secondary method) to check certificate validity.</p></div></li><li><p><code>false</code></p><div><p>Do not use the secondary method to check certificate validity.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Soft Fail</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>What to do if the revocation server can’t be reached or is busy:</p></div><div><ul><li><p><code>true</code></p><div><p>Avoid verification failure.</p></div></li><li><p><code>false</code></p><div><p>Allow the verification to fail.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Expiration Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>A time unit that qualifies the maxIdleTime attribute</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Custom Ocsp Responder

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the OCSP responder.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Cert Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the signing certificate for the OCSP response (must be in the truststore), if present.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Crl File

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the CRL file.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnection

Configures a reconnection strategy for an operation.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Reconnection strategy to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many
reconnection attempts the connector source or operation can make.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How many reconnection attempts the Mule app can make.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Invoke Agent Response Attributes

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Messages</strong></p></td><td><div><div><p>Array of <a href="#Message">Message</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Message

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Collect</strong></p></td><td><div><div><p>Array of <a href="#Collect">Collect</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Content Safe</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Feedback Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Plan Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reason</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Collect

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Data</strong></p></td><td><div><div><p><a href="#CollectData">Collect Data</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Property</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Collect Data

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Property</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Value</strong></p></td><td><div><div><p>Array of <a href="#SearchResult">Search Result</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Search Result

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>S Object Info</strong></p></td><td><div><div><p><a href="#SObjectInfo">S Object Info</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Data</strong></p></td><td><div><div><p><a href="#RecordData">Record Data</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Record Type Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Title</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### S Object Info

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Api Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Label</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Record Data

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Id</strong></p></td><td><div><div><p><a href="#RecordField">Record Field</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Name</strong></p></td><td><div><div><p><a href="#RecordField">Record Field</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p><a href="#RecordField">Record Field</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Record Field

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Display Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by <strong>Buffer Size Increment</strong>, with an upper limit of <strong>Max Buffer Size</strong>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error. A value of less than or equal to <code>0</code> means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit for the <strong>Initial Buffer Size</strong>, <strong>Buffer Size Increment</strong>, and <strong>Max Buffer Size</strong> fields.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>In Memory Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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:</p></div><div><ul><li><p>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.</p></li><li><p>Configure a smaller buffer size to decrease memory load at the expense of response time.</p></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit for the <strong>In Memory Size</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Error Mapping

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Source</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ANY</p></li><li><p>REDELIVERY_EXHAUSTED</p></li><li><p>TRANSFORMATION</p></li><li><p>EXPRESSION</p></li><li><p>SECURITY</p></li><li><p>CLIENT_SECURITY</p></li><li><p>SERVER_SECURITY</p></li><li><p>ROUTING</p></li><li><p>CONNECTIVITY</p></li><li><p>RETRY_EXHAUSTED</p></li><li><p>TIMEOUT</p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Agent Response Metadata

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Links</strong></p></td><td><div><div><p><a href="#Links">Links</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Messages Metadata</strong></p></td><td><div><div><p>Array of <a href="#MessageMetadata">Message Metadata</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Links

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>End</strong></p></td><td><div><div><p><a href="#Link">Link</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Messages</strong></p></td><td><div><div><p><a href="#Link">Link</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Self</strong></p></td><td><div><div><p><a href="#Link">Link</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Session</strong></p></td><td><div><div><p><a href="#Link">Link</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Link

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Href</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Message Metadata

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Expected</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Feedback Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Http Status</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Is Content Safe</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Metrics</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Plan Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Timestamp</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Trace Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Variable

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Value for this type.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Default Http Proxy Config

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Non Proxy Hosts</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## See Also

- [Agentforce Connector Overview](https://docs.mulesoft.com/agentforce-connector/latest/)

<!-- document id=a1e9bd5c281a5bf2b3a714e798ccf44120282a4d15804f0760eacd5413232ae3 url=/mulesoft/current/en-us/agentforce-connector/latest/agentforce-connector-xml-maven.md -->

---
product: Agentforce Connector
version: 1.3
is-latest-version: true
---

# Agentforce Connector 1.3 XML and Maven Support

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Code Builder
or Studio:

- If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Code
  Builder or Studio XML editor, or from a text editor, you can access the connector from your app by
  adding reference statements to both your XML Mule flow and the Apache Maven `pom.xml` file.

- If you add the connector in Anypoint Code Builder or Studio, the XML is automatically populated
  the code with the connector’s namespace and schema location and it also adds a dependency to the
  `pom.xml` file.

## Add a Namespace for the Connector

Paste the following code inside the `mule` tag of the header of your configuration XML:

```xml
http://www.mulesoft.org/schema/mule/ms-agentforce
http://www.mulesoft.org/schema/mule/ms-agentforce/current/mule-ms-agentforce.xsd
```

This example shows how the namespace statements are placed in the `<mule>` XML block:

```xml
<mule xmlns:ms-agentforce="http://www.mulesoft.org/schema/mule/ms-agentforce"
    xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
	http://www.mulesoft.org/schema/mule/core/current/mule.xsd
    http://www.mulesoft.org/schema/mule/http
	http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
    http://www.mulesoft.org/schema/mule/ms-agentforce
	http://www.mulesoft.org/schema/mule/ms-agentforce/current/mule-ms-agentforce.xsd">
```

## Add a POM File Dependency

The Apache Maven `pom.xml` file generated by Anypoint Code Builder and Studio contains dependencies
for a Mule app. If you code a Mule app manually, include this XML snippet in your `pom.xml` file to
enable access to this connector:

```xml
<dependency>
	<groupId>com.mulesoft.connectors</groupId>
	<artifactId>mule4-agentforce-connector</artifactId>
	<version>x.x.x</version>
	<classifier>mule-plugin</classifier>
</dependency>
```

Replace `x.x.x` with the version that corresponds to the connector you’re using.

To get the most up-to-date `pom.xml` file information:

1.  Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/).

2.  In Exchange, click **Login** and supply your Anypoint Platform username and password.

3.  In Exchange, search for `agentforce`.

4.  Select the connector.

5.  Click **Dependency Snippets** near the upper right of the screen.

## See Also

- [Agentforce Connector Overview](https://docs.mulesoft.com/agentforce-connector/latest/)

- [Agentforce Connector Reference](https://docs.mulesoft.com/agentforce-connector/latest/agentforce-connector-reference)

<!-- document id=c5ddbe6ad9b90325e8e68000846fc09dc86bb2ac1f9f3931e42ace93ea50aded url=/mulesoft/current/en-us/agentforce-connector/1.0/configuring-agent-operations.md -->

---
product: Agentforce Connector
version: 1.0
---

# Configuring Agent Operations for Agentforce Connector

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## Configure the Start Agent Conversation Operation

The **Start agent conversation** operation 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.

1.  Select the operation on the Anypoint Code Builder or Studio canvas.

2.  In the **General** properties tab for the operation, enter these values:

    - **Display Name**

      Display name for the operation.

    - **Connector Configuration**

      Select the associated configuration for the connector.

    - **Agent list**

      Select the agent to invoke. The list shows only agents that are currently active in the org.
      The connector filters out any agents that aren’t in the `active` state.

### Output

The operation returns a session ID for the interaction between the app and the agent. The session ID
is used as an input for the **Continue agent conversation** operation.

## Configure the Continue Agent Conversation Operation

The **Continue agent conversation** operation enables the surfacing of 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.

1.  Select the operation on the Anypoint Code Builder or Studio canvas.

2.  In the **General** properties tab for the operation, enter these values:

    - **Display Name**

      Display name for the operation.

    - **Connector Configuration**

      Select the associated configuration for the connector.

    - **Message**

      Enter plain text instructions to help the agent make decisions for different use cases.

    - **Session ID**

      Enter the session ID that was returned with the **Start agent conversation** operation. This
      is required to send the prompt defined in the **Message** field to the agent.

## Configure the End Agent Conversation Operation

Use the **End agent conversation** operation to close the session after the agent responds.

> [!NOTE] Sessions are closed automatically after three days of inactivity.

1.  Select the operation on the Anypoint Code Builder or Studio canvas.

2.  In the **General** properties tab for the operation, enter these values:

    - **Display Name**

      Display name for the operation.

    - **Connector Configuration**

      Select the associated configuration for the connector.

    - **Session ID**

      Enter the session ID that was returned with the **Start agent conversation** operation.

## See Also

- [Using Anypoint Code Builder to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-acb)

- [Using Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Agentforce Connector Reference](https://docs.mulesoft.com/agentforce-connector/1.0/agentforce-connector-reference)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=dfaac17e37eadd65fcd80172726634d59f96ff1c4928c53ebccdef1a3e0f2503 url=/mulesoft/current/en-us/agentforce-connector/1.1/configuring-agent-operations.md -->

---
product: Agentforce Connector
version: 1.1
---

# Configuring Agent Operations for Agentforce Connector 1.1

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## Configure the Start Agent Conversation Operation

The **Start agent conversation** operation 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.

1.  Select the operation on the Anypoint Code Builder or Studio canvas.

2.  In the **General** properties tab for the operation, enter these values:

    - **Display Name**

      Display name for the operation.

    - **Connector Configuration**

      Select the associated configuration for the connector.

    - **Agent list**

      Select the agent to invoke. The list shows only agents that are currently active in the org.
      The connector filters out any agents that aren’t in the `active` state.

### Output

The operation returns a session ID for the interaction between the app and the agent. The session ID
is used as an input for the **Continue agent conversation** operation.

## Configure the Continue Agent Conversation Operation

The **Continue agent conversation** operation 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.

1.  Select the operation on the Anypoint Code Builder or Studio canvas.

2.  In the **General** properties tab for the operation, enter these values:

    - **Display Name**

      Display name for the operation.

    - **Connector Configuration**

      Select the associated configuration for the connector.

    - **Message**

      Enter plain text instructions to help the agent make decisions for different use cases.

    - **Session ID**

      Enter the session ID that was returned with the **Start agent conversation** operation. This
      is required to send the prompt defined in the **Message** field to the agent.

## Configure the End Agent Conversation Operation

Use the **End agent conversation** operation to close the session after the agent responds.

> [!NOTE] Sessions are closed automatically after three days of inactivity.

1.  Select the operation on the Anypoint Code Builder or Studio canvas.

2.  In the **General** properties tab for the operation, enter these values:

    - **Display Name**

      Display name for the operation.

    - **Connector Configuration**

      Select the associated configuration for the connector.

    - **Session ID**

      Enter the session ID that was returned with the **Start agent conversation** operation.

## See Also

- [Using Anypoint Code Builder to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-acb)

- [Using Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Agentforce Connector Reference](https://docs.mulesoft.com/agentforce-connector/1.1/agentforce-connector-reference)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=fcfb48378320f51d2191c0c0494212c33d587659978d5715f28bd10c26cf3c4b url=/mulesoft/current/en-us/agentforce-connector/1.2/configuring-agent-operations.md -->

---
product: Agentforce Connector
version: 1.2
---

# Configuring Agent Operations for Agentforce Connector 1.2

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use these guidelines to configure the **Start agent conversation**, **Continue agent conversation**,
and **End agent conversation** operations for Agentforce Connector.

## Configure the Start Agent Conversation Operation

The **Start agent conversation** operation 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.

1.  Select the operation on the Anypoint Code Builder or Studio canvas.

2.  In the **General** properties tab for the operation, enter these values:

    - **Display Name**

      Display name for the operation.

    - **Connector Configuration**

      Select the associated configuration for the connector.

    - **Agent list**

      Select the agent to invoke. The list shows only agents that are currently active in the org.
      The connector filters out any agents that aren’t in the `active` state.

    - **Bypass User**

      Select whether to use the agent-assigned user instead of the logged-in user. Setting this to
      `True` allows the agent to use its own permissions to access the necessary Data Cloud assets.
      This enables the agent to answer the user’s query even if you lack direct access.

### Output

The operation returns a session ID for the interaction between the app and the agent. The session ID
is used as an input for the **Continue agent conversation** operation.

## Configure the Continue Agent Conversation Operation

The **Continue agent conversation** operation 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.

1.  Select the operation on the Anypoint Code Builder or Studio canvas.

2.  In the **General** properties tab for the operation, enter these values:

    - **Display Name**

      Display name for the operation.

    - **Connector Configuration**

      Select the associated configuration for the connector.

    - **Message**

      Enter plain text instructions to help the agent make decisions for different use cases.

    - **Session ID**

      Enter the session ID that was returned with the **Start agent conversation** operation. This
      is required to send the prompt defined in the **Message** field to the agent.

## Configure the End Agent Conversation Operation

Use the **End agent conversation** operation to close the session after the agent responds.

> [!NOTE] Sessions are closed automatically after three days of inactivity.

1.  Select the operation on the Anypoint Code Builder or Studio canvas.

2.  In the **General** properties tab for the operation, enter these values:

    - **Display Name**

      Display name for the operation.

    - **Connector Configuration**

      Select the associated configuration for the connector.

    - **Session ID**

      Enter the session ID that was returned with the **Start agent conversation** operation.

## See Also

- [Using Anypoint Code Builder to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-acb)

- [Using Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Agentforce Connector Reference](https://docs.mulesoft.com/agentforce-connector/1.2/agentforce-connector-reference)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=a487933b67b899ec1daab726e42c78d300671e4d6a093e045bf8b8758630af21 url=/mulesoft/current/en-us/agentforce-connector/latest/configuring-agent-operations.md -->

---
product: Agentforce Connector
version: 1.3
is-latest-version: true
---

# Configuring Agent Operations for Agentforce Connector 1.3

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Use these guidelines to configure the **Start agent conversation**, **Send Message (Sync)**,
**Continue agent conversation (Deprecated)**, and **End agent conversation** operations for
Agentforce Connector.

## Configure the Start Agent Conversation Operation

The **Start agent conversation** operation 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.

1.  Select the operation on the Anypoint Code Builder or Studio canvas.

2.  In the **General** properties tab for the operation, enter these values:

    - **Display Name**

      Display name for the operation.

    - **Connector Configuration**

      Select the associated configuration for the connector.

    - **Agent list**

      Select the agent to invoke. The list shows only agents that are currently active in the org.
      The connector filters out any agents that aren’t in the `active` state.

    - **Bypass User**

      Select whether to use the agent-assigned user instead of the logged-in user. Setting this to
      `True` allows the agent to use its own permissions to access the necessary Data Cloud assets.
      This enables the agent to answer the user’s query even if you lack direct access.

    - **Agent Variables**

      Provide an array of custom or context variables to pass runtime values to the agent. Match
      each variable name to the corresponding variable defined in Agent Builder.

### Output

The operation returns a session ID for the interaction between the app and the agent. The session ID
is used as an input for the **Continue agent conversation** operation.

## Configure the Send Message (Sync) Operation

The **Send Message (Sync)** operation sends a message from the MuleSoft application to the agent and
waits for a synchronous response. The agent maintains the context of the conversation and provides a
relevant response using a structured JSON payload that separates business data from metadata. This
operation replaces the deprecated [**Continue agent conversation**](#continue-agent) operation to
provide full access to all elements of the response payload.

1.  Select the operation on the Anypoint Code Builder or Studio canvas.

2.  In the **General** properties tab for the operation, enter these values:

    - **Display Name**

      Display name for the operation.

    - **Connector Configuration**

      Select the associated configuration for the connector.

    - **Message**

      Enter plain text instructions to help the agent make decisions for different use cases.

    - **Session ID**

      Enter the session ID that was returned with the **Start agent conversation** operation. This
      is required to send the prompt defined in the **Message** field to the agent.

    - **Message Sequence Number**

      Enter `1` for the first message in a session, and increment the value by `1` for each
      subsequent message to preserve message order.

    - **Agent Variables**

      Provide an array of custom or context variables to pass runtime values to the agent. Match
      each variable name to the corresponding variable defined in Agent Builder.

## Configure the Continue Agent Conversation Operation (Deprecated)

The **Continue agent conversation** operation 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. The **Continue Agent Conversation** operation is now
deprecated. Use the [**Send Message (Sync)**](#SendMessageSync) operation instead.

1.  Select the operation on the Anypoint Code Builder or Studio canvas.

2.  In the **General** properties tab for the operation, enter these values:

    - **Display Name**

      Display name for the operation.

    - **Connector Configuration**

      Select the associated configuration for the connector.

    - **Message**

      Enter plain text instructions to help the agent make decisions for different use cases.

    - **Session ID**

      Enter the session ID that was returned with the **Start agent conversation** operation. This
      is required to send the prompt defined in the **Message** field to the agent.

## Configure the End Agent Conversation Operation

Use the **End agent conversation** operation to close the session after the agent responds.

> [!NOTE] Sessions are closed automatically after three days of inactivity.

1.  Select the operation on the Anypoint Code Builder or Studio canvas.

2.  In the **General** properties tab for the operation, enter these values:

    - **Display Name**

      Display name for the operation.

    - **Connector Configuration**

      Select the associated configuration for the connector.

    - **Session ID**

      Enter the session ID that was returned with the **Start agent conversation** operation.

## See Also

- [Using Anypoint Code Builder to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-acb)

- [Using Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Agentforce Connector Reference](https://docs.mulesoft.com/agentforce-connector/latest/agentforce-connector-reference)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=97a06446a6d5a6c92c2cc57f4726e66a112013ef7abc32d59eb769f38a5e3ddf url=/mulesoft/current/en-us/agentforce-connector/1.0/agentforce-connector-config-acb.md -->

---
product: Agentforce Connector
version: 1.0
---

# Using Anypoint Code Builder to Configure Agentforce Connector

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Cloud IDE (Beta) is scheduled for retirement on August 31, 2026. August 30, 2026 is the last day you
can access Cloud IDE (Beta). Download your projects to work from Desktop IDE. Learn more in
[Migrate a Project from Cloud IDE to Desktop IDE](https://docs.mulesoft.com/anypoint-code-builder/int-import-mule-project#migrate-cloud-to-desktop).

To use Anypoint Code Builder to configure a connector or module, create a basic integration project
in Anypoint Code Builder, add connectors and other components to your Mule application to process
your business logic, and configure the attributes.

## Before You Begin

Before creating an integration project, you must:

- [Set up and access the Anypoint Code Builder web or desktop IDE](https://docs.mulesoft.com/anypoint-code-builder/start-acb)

- Have credentials to access the connector’s API

- Ensure that the Visual Studio Code Extension Pack for Java is installed.

To use this connector, you must be familiar with:

- The connector’s API

- Anypoint Connectors

- Mule runtime engine (Mule)

## Create a New Integration Project

To create a new integration project:

1.  In the activity bar of the IDE, click the
    ![Anypoint Code Builder icon](/mulesoft/current/en-us/connectors/_images/acb-icon-ms-logo.png) (**Anypoint Code
    Builder**) icon.

2.  From **Quick Actions**, click **Develop an Integration**:

    ![Develop an Integration link highlighted in the Getting started section](/mulesoft/current/en-us/anypoint-code-builder/_images/develop-integration-option-mat.png)

3.  Complete the following in the **Develop an Integration** form:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Attribute</th><th>Value</th></tr></thead><tbody><tr><td><div><div><p><strong>Project Name</strong></p></div></div></td><td><div><div><p>Unique name for your project.</p></div><div><p>This name is used as the title and name of the integration project file. For example, if the project name is "Salesforce Integration," the project file name is <code>salesforce-integration</code>.</p></div></div></td></tr><tr><td><div><div><p><strong>Project Location</strong></p></div></div></td><td><div><div><p>Your home directory or another directory you create. Click <strong>Browse</strong> to select a different directory for the integration project.</p></div><div><p>Don’t create the project within another project directory.</p></div><div><p>See <a href="https://docs.mulesoft.com/anypoint-code-builder/start-add-folders">Adding Folders to Your Home Directory</a>.</p></div></div></td></tr></tbody></table>

4.  Select the type of project to create by selecting either the **Empty Project** or **Template or
    Example** card.

5.  Select the **Mule runtime** and **Java Version** for your app.

6.  Click **Create Project**.

## Add Components to Your Project

Add components to your integration project to build a flow:

1.  In the **Explorer** view, open the XML file for your project, such as `my-project-name.xml`.

2.  Select **Build a Flow** from the start card to create an empty flow:

    ![Anypoint Code Builder canvas with starting cards with the options to start from scratch, build a flow, or build a subflow](/mulesoft/current/en-us/connectors/_images/acb-build-flow.png)

3.  Change the name of the flow:

    1.  Click **Flow**.

    2.  Click the edit icon.

        ![Arrow pointing to the flow name edit pencil icon](/mulesoft/current/en-us/connectors/_images/acb-change-flow-name.png)

    3.  Enter the flow name, and click the checkmark.

    4.  In the canvas UI, click the
        ![Add component icon](/mulesoft/current/en-us/anypoint-code-builder/_images/icon-plus.png) (**Add component**)
        icon.

    5.  In the **Add Component** panel, search for and select your component from the results. The
        following example shows the **Listener** component from the **HTTP** search results:

        ![Listener component highlighted in the Add Component section](/mulesoft/current/en-us/anypoint-code-builder/_images/main-tutorial-add-first-listener.png)

        The configuration XML file now includes the XML for the HTTP Listener into the `<flow/>`
        element, for example:

        ```XML
        <flow name="getFlights" >
          <http:listener path="" config-ref="" doc:name="Listener" doc:id="ojzfry" />
        </flow>
        ```

## Configure the Trigger For the Flow

A trigger (source) starts the flow when specified conditions are met. If a connector has its own
associated sources, you can use a connector-specific trigger to initiate the flow. Each connector
trigger has a unique configuration.

You can configure the following sources for this connector:

- **HTTP > Listener**

  Initiates a flow each time it receives a request on the configured host and port

- **Scheduler**

  Initiates a flow when a time-based condition is met

For example, to configure an HTTP Listener trigger, follow these steps:

1.  Click the **Listener** component on the canvas UI.

2.  (Optional) Click the edit icon to change the name of the **Listener** component.

3.  (Optional) If you created a configuration file for the connector, select it.

4.  In the **General** tab, in the **Path** field, enter the relative path for the path set in the
    HTTP configuration element. See
    [Configure Paths](https://docs.mulesoft.com/http-connector/latest/http-listener-ref#configure-paths).

5.  Select the **Advanced** tab to configure the following attributes:

    <table><colgroup><col> <col> <col></colgroup><thead><tr><th>Attribute</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p>Allowed methods</p></td><td><p>To allow all HTTP methods (default), do not define this attribute. To restrict certain methods, specify all allowed HTTP methods, for example, <code>GET, POST</code>, as a comma-separated list.</p></td><td><p>No</p></td></tr><tr><td><p>Response streaming mode</p></td><td><p>Whether to use streaming when the response is sent.</p></td><td><p>No</p></td></tr><tr><td><p>Output MIME type</p></td><td><p>MIME type of the payload that this component outputs.</p></td><td><p>No</p></td></tr><tr><td><p>Parameters</p></td><td><p>Appends a key-value pair for a reader property to the value of the Output MIME attribute. Multiple key-value pairs are allowed.</p></td><td><p>No</p></td></tr><tr><td><p>Output encoding</p></td><td><p>Encoding of the payload that this component outputs.</p></td><td><p>No</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><p>Configures the way data streams are consumed in Mule apps.</p></td><td><p>No</p></td></tr><tr><td><p>Primary node only</p></td><td><p>Select this option to execute the <strong>Listener</strong> trigger on the primary node only when running in a cluster.</p></td><td><p>No</p></td></tr><tr><td><p>Redelivery policy</p></td><td><p>Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.</p></td><td><p>No</p></td></tr><tr><td><p>Reconnection strategy</p></td><td><p>When an operation in a Mule application fails to connect to an external server, the default behavior is for the operation to fail immediately and return a connectivity error. You can modify the default behavior by configuring the reconnection strategy for the operation.</p></td><td><p>No</p></td></tr><tr><td><p>Response</p></td><td><p>See <a href="https://docs.mulesoft.com/http-connector/latest/http-documentation#HttpResponseAttributes">HTTP Response Attributes</a>.</p></td><td><p>No</p></td></tr><tr><td><p>Error Response</p></td><td><p>HTTP error response returns a status code for the error.</p></td><td><p>No</p></td></tr><tr><td><p>Body</p></td><td><p>Body of the error message.</p></td><td><p>No</p></td></tr><tr><td><p>Headers</p></td><td><p>Headers to include in the error message.</p></td><td><p>No</p></td></tr><tr><td><p>Status code</p></td><td><p>Status code of the error response, for example, <code>500</code>.</p></td><td><p>No</p></td></tr><tr><td><p>Reason phrase</p></td><td><p>Reason for the error, for example, <code>Gateway Timeout</code> or <code>Internal Server Error</code>.</p></td><td><p>No</p></td></tr></tbody></table>

## Add the Connector to Your Integration Project

1.  In the Explorer view, open the configuration XML file for your project, such as
    `my-project-name.xml`.

2.  Click the
    ![Show Mule graphical mode icon](/mulesoft/current/en-us/anypoint-code-builder/_images/icon-tree-view.png) (**Show
    Mule graphical mode**) icon in the activity bar to open the canvas UI if it doesn’t open
    automatically.

3.  Add the connector the same way you added other components from the canvas UI:

    1.  In the canvas UI, click the
        ![Add component icon](/mulesoft/current/en-us/anypoint-code-builder/_images/icon-plus.png) (**Add component**)
        icon.

    2.  In the **Add Component** panel, click **Connectors**.

4.  Click the
    ![Search in Exchange icon](/mulesoft/current/en-us/anypoint-code-builder/_images/icon-search-exchange.png)
    (**Search in Exchange**) toggle:

    ![Search in Exchange toggle](/mulesoft/current/en-us/anypoint-code-builder/_images/int-connector-search-exchange.png)

5.  Enter `agentforce` in the search box.

6.  Select the connector to add it to your project.

Adding a connector to an integration project doesn’t make that connector available to other projects
in your Anypoint Code Builder workspace.

## Add a Global Configuration

1.  In the configuration XML, place your cursor before the `<flow/>` element and type `agentforce`.

    Ensure that the cursor is not inside the `<flow/>` element.

2.  Select the `ms-agentforce:config` snippet:

    The snippet adds the following code:

    ```xml
    <ms-agentforce:config clientId="#[]" clientSecret="#[]" />
    ```

3.  Add the attributes to complete the configuration, for example:

    ```xml
    <ms-agentforce:config name="Agentforce_Config" doc:name="Agentforce Config" doc:id="e3428ee2-d4ee-47dc-ba7e-30073f69165e" >
    		<ms-agentforce:oauth-client-credentials-connection >
    		<ms-agentforce:oauth-client-credentials clientId="clientid" clientSecret="supersecret" />
    		</ms-agentforce:oauth-client-credentials-connection>
    </ms-agentforce:config>
    ```

    This example shows a flow named "Define\_Prompt" with two global elements defined
    (`http:listener-config` and `ms-agentforce:config`)

    ```xml
     <http:listener-config basePath="/path" name="HTTP-Listener-config">
        <http:listener-connection host="0.0.0.0" port="8081">
        </http:listener-connection>
      </http:listener-config>
      <ms-agentforce:config name="Agentforce_Config" doc:name="Agentforce Config" doc:id="e3428ee2-d4ee-47dc-ba7e-30073f69165e" >
    	   <ms-agentforce:oauth-client-credentials-connection >
    		   <ms-agentforce:oauth-client-credentials clientId="clientid" clientSecret="supersecret" />
    	   </ms-agentforce:oauth-client-credentials-connection>
    	</ms-agentforce:config>
      <flow name="Define_Prompt">
    ```

## Configure Additional Connector Fields

After you configure a global element for the connector, configure the other required fields. The
required fields vary depending on which connector actions you use.

For more information about configuring Agentforce Connector actions, see
[Configuring Agent Operations for Agentforce Connector](https://docs.mulesoft.com/agentforce-connector/1.0/configuring-agent-operations).

## See Also

- [Anypoint Connectors Overview](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Agentforce Connector Reference](https://docs.mulesoft.com/agentforce-connector/1.0/agentforce-connector-reference)

- [Configuring Agent Operations for Agentforce Connector](https://docs.mulesoft.com/agentforce-connector/1.0/configuring-agent-operations)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=221efc24b653d4da106f9b0d7d3f8ebb5df1142a3f1ea2f2a64bed842c16885a url=/mulesoft/current/en-us/agentforce-connector/1.1/agentforce-connector-config-acb.md -->

---
product: Agentforce Connector
version: 1.1
---

# Using Anypoint Code Builder to Configure Agentforce Connector 1.1

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Cloud IDE (Beta) is scheduled for retirement on August 31, 2026. August 30, 2026 is the last day you
can access Cloud IDE (Beta). Download your projects to work from Desktop IDE. Learn more in
[Migrate a Project from Cloud IDE to Desktop IDE](https://docs.mulesoft.com/anypoint-code-builder/int-import-mule-project#migrate-cloud-to-desktop).

To use Anypoint Code Builder to configure a connector or module, create a basic integration project
in Anypoint Code Builder, add connectors and other components to your Mule application to process
your business logic, and configure the attributes.

## Before You Begin

Before creating an integration project, you must:

- [Set up and access the Anypoint Code Builder web or desktop IDE](https://docs.mulesoft.com/anypoint-code-builder/start-acb)

- Have credentials to access the connector’s API

- Ensure that the Visual Studio Code Extension Pack for Java is installed.

To use this connector, you must be familiar with:

- The connector’s API

- Anypoint Connectors

- Mule runtime engine (Mule)

## Create a New Integration Project

To create a new integration project:

1.  In the activity bar of the IDE, click the
    ![Anypoint Code Builder icon](/mulesoft/current/en-us/connectors/_images/acb-icon-ms-logo.png) (**Anypoint Code
    Builder**) icon.

2.  From **Quick Actions**, click **Develop an Integration**:

    ![Develop an Integration link highlighted in the Getting started section](/mulesoft/current/en-us/anypoint-code-builder/_images/develop-integration-option-mat.png)

3.  Complete the following in the **Develop an Integration** form:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Attribute</th><th>Value</th></tr></thead><tbody><tr><td><div><div><p><strong>Project Name</strong></p></div></div></td><td><div><div><p>Unique name for your project.</p></div><div><p>This name is used as the title and name of the integration project file. For example, if the project name is "Salesforce Integration," the project file name is <code>salesforce-integration</code>.</p></div></div></td></tr><tr><td><div><div><p><strong>Project Location</strong></p></div></div></td><td><div><div><p>Your home directory or another directory you create. Click <strong>Browse</strong> to select a different directory for the integration project.</p></div><div><p>Don’t create the project within another project directory.</p></div><div><p>See <a href="https://docs.mulesoft.com/anypoint-code-builder/start-add-folders">Adding Folders to Your Home Directory</a>.</p></div></div></td></tr></tbody></table>

4.  Select the type of project to create by selecting either the **Empty Project** or **Template or
    Example** card.

5.  Select the **Mule runtime** and **Java Version** for your app.

6.  Click **Create Project**.

## Add Components to Your Project

Add components to your integration project to build a flow:

1.  In the **Explorer** view, open the XML file for your project, such as `my-project-name.xml`.

2.  Select **Build a Flow** from the start card to create an empty flow:

    ![Anypoint Code Builder canvas with starting cards with the options to start from scratch, build a flow, or build a subflow](/mulesoft/current/en-us/connectors/_images/acb-build-flow.png)

3.  Change the name of the flow:

    1.  Click **Flow**.

    2.  Click the edit icon.

        ![Arrow pointing to the flow name edit pencil icon](/mulesoft/current/en-us/connectors/_images/acb-change-flow-name.png)

    3.  Enter the flow name, and click the checkmark.

    4.  In the canvas UI, click the
        ![Add component icon](/mulesoft/current/en-us/anypoint-code-builder/_images/icon-plus.png) (**Add component**)
        icon.

    5.  In the **Add Component** panel, search for and select your component from the results. The
        following example shows the **Listener** component from the **HTTP** search results:

        ![Listener component highlighted in the Add Component section](/mulesoft/current/en-us/anypoint-code-builder/_images/main-tutorial-add-first-listener.png)

        The configuration XML file now includes the XML for the HTTP Listener into the `<flow/>`
        element, for example:

        ```XML
        <flow name="getFlights" >
          <http:listener path="" config-ref="" doc:name="Listener" doc:id="ojzfry" />
        </flow>
        ```

## Configure the Trigger For the Flow

A trigger (source) starts the flow when specified conditions are met. If a connector has its own
associated sources, you can use a connector-specific trigger to initiate the flow. Each connector
trigger has a unique configuration.

You can configure the following sources for this connector:

- **HTTP > Listener**

  Initiates a flow each time it receives a request on the configured host and port

- **Scheduler**

  Initiates a flow when a time-based condition is met

For example, to configure an HTTP Listener trigger, follow these steps:

1.  Click the **Listener** component on the canvas UI.

2.  (Optional) Click the edit icon to change the name of the **Listener** component.

3.  (Optional) If you created a configuration file for the connector, select it.

4.  In the **General** tab, in the **Path** field, enter the relative path for the path set in the
    HTTP configuration element. See
    [Configure Paths](https://docs.mulesoft.com/http-connector/latest/http-listener-ref#configure-paths).

5.  Select the **Advanced** tab to configure the following attributes:

    <table><colgroup><col> <col> <col></colgroup><thead><tr><th>Attribute</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p>Allowed methods</p></td><td><p>To allow all HTTP methods (default), do not define this attribute. To restrict certain methods, specify all allowed HTTP methods, for example, <code>GET, POST</code>, as a comma-separated list.</p></td><td><p>No</p></td></tr><tr><td><p>Response streaming mode</p></td><td><p>Whether to use streaming when the response is sent.</p></td><td><p>No</p></td></tr><tr><td><p>Output MIME type</p></td><td><p>MIME type of the payload that this component outputs.</p></td><td><p>No</p></td></tr><tr><td><p>Parameters</p></td><td><p>Appends a key-value pair for a reader property to the value of the Output MIME attribute. Multiple key-value pairs are allowed.</p></td><td><p>No</p></td></tr><tr><td><p>Output encoding</p></td><td><p>Encoding of the payload that this component outputs.</p></td><td><p>No</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><p>Configures the way data streams are consumed in Mule apps.</p></td><td><p>No</p></td></tr><tr><td><p>Primary node only</p></td><td><p>Select this option to execute the <strong>Listener</strong> trigger on the primary node only when running in a cluster.</p></td><td><p>No</p></td></tr><tr><td><p>Redelivery policy</p></td><td><p>Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.</p></td><td><p>No</p></td></tr><tr><td><p>Reconnection strategy</p></td><td><p>When an operation in a Mule application fails to connect to an external server, the default behavior is for the operation to fail immediately and return a connectivity error. You can modify the default behavior by configuring the reconnection strategy for the operation.</p></td><td><p>No</p></td></tr><tr><td><p>Response</p></td><td><p>See <a href="https://docs.mulesoft.com/http-connector/latest/http-documentation#HttpResponseAttributes">HTTP Response Attributes</a>.</p></td><td><p>No</p></td></tr><tr><td><p>Error Response</p></td><td><p>HTTP error response returns a status code for the error.</p></td><td><p>No</p></td></tr><tr><td><p>Body</p></td><td><p>Body of the error message.</p></td><td><p>No</p></td></tr><tr><td><p>Headers</p></td><td><p>Headers to include in the error message.</p></td><td><p>No</p></td></tr><tr><td><p>Status code</p></td><td><p>Status code of the error response, for example, <code>500</code>.</p></td><td><p>No</p></td></tr><tr><td><p>Reason phrase</p></td><td><p>Reason for the error, for example, <code>Gateway Timeout</code> or <code>Internal Server Error</code>.</p></td><td><p>No</p></td></tr></tbody></table>

## Add the Connector to Your Integration Project

1.  In the Explorer view, open the configuration XML file for your project, such as
    `my-project-name.xml`.

2.  Click the
    ![Show Mule graphical mode icon](/mulesoft/current/en-us/anypoint-code-builder/_images/icon-tree-view.png) (**Show
    Mule graphical mode**) icon in the activity bar to open the canvas UI if it doesn’t open
    automatically.

3.  Add the connector the same way you added other components from the canvas UI:

    1.  In the canvas UI, click the
        ![Add component icon](/mulesoft/current/en-us/anypoint-code-builder/_images/icon-plus.png) (**Add component**)
        icon.

    2.  In the **Add Component** panel, click **Connectors**.

4.  Click the
    ![Search in Exchange icon](/mulesoft/current/en-us/anypoint-code-builder/_images/icon-search-exchange.png)
    (**Search in Exchange**) toggle:

    ![Search in Exchange toggle](/mulesoft/current/en-us/anypoint-code-builder/_images/int-connector-search-exchange.png)

5.  Enter `agentforce` in the search box.

6.  Select the connector to add it to your project.

Adding a connector to an integration project doesn’t make that connector available to other projects
in your Anypoint Code Builder workspace.

## Add a Global Configuration

1.  In the configuration XML, place your cursor before the `<flow/>` element and type `agentforce`.

    Ensure that the cursor is not inside the `<flow/>` element.

2.  Select the `ms-agentforce:config` snippet:

    The snippet adds the following code:

    ```xml
    <ms-agentforce:config clientId="#[]" clientSecret="#[]" />
    ```

3.  Add the attributes to complete the configuration, for example:

    ```xml
    <ms-agentforce:config name="Agentforce_Config" doc:name="Agentforce Config" doc:id="e3428ee2-d4ee-47dc-ba7e-30073f69165e" >
    		<ms-agentforce:oauth-client-credentials-connection >
    		<ms-agentforce:oauth-client-credentials clientId="clientid" clientSecret="supersecret" />
    		</ms-agentforce:oauth-client-credentials-connection>
    </ms-agentforce:config>
    ```

    This example shows a flow named "Define\_Prompt" with two global elements defined
    (`http:listener-config` and `ms-agentforce:config`)

    ```xml
     <http:listener-config basePath="/path" name="HTTP-Listener-config">
        <http:listener-connection host="0.0.0.0" port="8081">
        </http:listener-connection>
      </http:listener-config>
      <ms-agentforce:config name="Agentforce_Config" doc:name="Agentforce Config" doc:id="e3428ee2-d4ee-47dc-ba7e-30073f69165e" >
    	   <ms-agentforce:oauth-client-credentials-connection >
    		   <ms-agentforce:oauth-client-credentials clientId="clientid" clientSecret="supersecret" />
    	   </ms-agentforce:oauth-client-credentials-connection>
    	</ms-agentforce:config>
      <flow name="Define_Prompt">
    ```

## Configure Additional Connector Fields

After you configure a global element for the connector, configure the other required fields. The
required fields vary depending on which connector actions you use.

For more information about configuring Agentforce Connector actions, see
[Configuring Agent Operations for Agentforce Connector 1.1](https://docs.mulesoft.com/agentforce-connector/1.1/configuring-agent-operations).

## See Also

- [Anypoint Connectors Overview](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Agentforce Connector Reference](https://docs.mulesoft.com/agentforce-connector/1.1/agentforce-connector-reference)

- [Configuring Agent Operations for Agentforce Connector 1.1](https://docs.mulesoft.com/agentforce-connector/1.1/configuring-agent-operations)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=ad9df966db2c6cf4382cb56ea00e036f782f33b2ed45ff27c8d4e404ba266742 url=/mulesoft/current/en-us/agentforce-connector/1.2/agentforce-connector-config-acb.md -->

---
product: Agentforce Connector
version: 1.2
---

# Using Anypoint Code Builder to Configure Agentforce Connector 1.2

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Cloud IDE (Beta) is scheduled for retirement on August 31, 2026. August 30, 2026 is the last day you
can access Cloud IDE (Beta). Download your projects to work from Desktop IDE. Learn more in
[Migrate a Project from Cloud IDE to Desktop IDE](https://docs.mulesoft.com/anypoint-code-builder/int-import-mule-project#migrate-cloud-to-desktop).

To use Anypoint Code Builder to configure a connector or module, create a basic integration project
in Anypoint Code Builder, add connectors and other components to your Mule application to process
your business logic, and configure the attributes.

## Before You Begin

Before creating an integration project, you must:

- [Set up and access the Anypoint Code Builder web or desktop IDE](https://docs.mulesoft.com/anypoint-code-builder/start-acb)

- Have credentials to access the connector’s API

- Ensure that the Visual Studio Code Extension Pack for Java is installed.

To use this connector, you must be familiar with:

- The connector’s API

- Anypoint Connectors

- Mule runtime engine (Mule)

## Create a New Integration Project

To create a new integration project:

1.  In the activity bar of the IDE, click the
    ![Anypoint Code Builder icon](/mulesoft/current/en-us/connectors/_images/acb-icon-ms-logo.png) (**Anypoint Code
    Builder**) icon.

2.  From **Quick Actions**, click **Develop an Integration**:

    ![Develop an Integration link highlighted in the Getting started section](/mulesoft/current/en-us/anypoint-code-builder/_images/develop-integration-option-mat.png)

3.  Complete the following in the **Develop an Integration** form:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Attribute</th><th>Value</th></tr></thead><tbody><tr><td><div><div><p><strong>Project Name</strong></p></div></div></td><td><div><div><p>Unique name for your project.</p></div><div><p>This name is used as the title and name of the integration project file. For example, if the project name is "Salesforce Integration," the project file name is <code>salesforce-integration</code>.</p></div></div></td></tr><tr><td><div><div><p><strong>Project Location</strong></p></div></div></td><td><div><div><p>Your home directory or another directory you create. Click <strong>Browse</strong> to select a different directory for the integration project.</p></div><div><p>Don’t create the project within another project directory.</p></div><div><p>See <a href="https://docs.mulesoft.com/anypoint-code-builder/start-add-folders">Adding Folders to Your Home Directory</a>.</p></div></div></td></tr></tbody></table>

4.  Select the type of project to create by selecting either the **Empty Project** or **Template or
    Example** card.

5.  Select the **Mule runtime** and **Java Version** for your app.

6.  Click **Create Project**.

## Add Components to Your Project

Add components to your integration project to build a flow:

1.  In the **Explorer** view, open the XML file for your project, such as `my-project-name.xml`.

2.  Select **Build a Flow** from the start card to create an empty flow:

    ![Anypoint Code Builder canvas with starting cards with the options to start from scratch, build a flow, or build a subflow](/mulesoft/current/en-us/connectors/_images/acb-build-flow.png)

3.  Change the name of the flow:

    1.  Click **Flow**.

    2.  Click the edit icon.

        ![Arrow pointing to the flow name edit pencil icon](/mulesoft/current/en-us/connectors/_images/acb-change-flow-name.png)

    3.  Enter the flow name, and click the checkmark.

    4.  In the canvas UI, click the
        ![Add component icon](/mulesoft/current/en-us/anypoint-code-builder/_images/icon-plus.png) (**Add component**)
        icon.

    5.  In the **Add Component** panel, search for and select your component from the results. The
        following example shows the **Listener** component from the **HTTP** search results:

        ![Listener component highlighted in the Add Component section](/mulesoft/current/en-us/anypoint-code-builder/_images/main-tutorial-add-first-listener.png)

        The configuration XML file now includes the XML for the HTTP Listener into the `<flow/>`
        element, for example:

        ```XML
        <flow name="getFlights" >
          <http:listener path="" config-ref="" doc:name="Listener" doc:id="ojzfry" />
        </flow>
        ```

## Configure the Trigger For the Flow

A trigger (source) starts the flow when specified conditions are met. If a connector has its own
associated sources, you can use a connector-specific trigger to initiate the flow. Each connector
trigger has a unique configuration.

You can configure the following sources for this connector:

- **HTTP > Listener**

  Initiates a flow each time it receives a request on the configured host and port

- **Scheduler**

  Initiates a flow when a time-based condition is met

For example, to configure an HTTP Listener trigger, follow these steps:

1.  Click the **Listener** component on the canvas UI.

2.  (Optional) Click the edit icon to change the name of the **Listener** component.

3.  (Optional) If you created a configuration file for the connector, select it.

4.  In the **General** tab, in the **Path** field, enter the relative path for the path set in the
    HTTP configuration element. See
    [Configure Paths](https://docs.mulesoft.com/http-connector/latest/http-listener-ref#configure-paths).

5.  Select the **Advanced** tab to configure the following attributes:

    <table><colgroup><col> <col> <col></colgroup><thead><tr><th>Attribute</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p>Allowed methods</p></td><td><p>To allow all HTTP methods (default), do not define this attribute. To restrict certain methods, specify all allowed HTTP methods, for example, <code>GET, POST</code>, as a comma-separated list.</p></td><td><p>No</p></td></tr><tr><td><p>Response streaming mode</p></td><td><p>Whether to use streaming when the response is sent.</p></td><td><p>No</p></td></tr><tr><td><p>Output MIME type</p></td><td><p>MIME type of the payload that this component outputs.</p></td><td><p>No</p></td></tr><tr><td><p>Parameters</p></td><td><p>Appends a key-value pair for a reader property to the value of the Output MIME attribute. Multiple key-value pairs are allowed.</p></td><td><p>No</p></td></tr><tr><td><p>Output encoding</p></td><td><p>Encoding of the payload that this component outputs.</p></td><td><p>No</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><p>Configures the way data streams are consumed in Mule apps.</p></td><td><p>No</p></td></tr><tr><td><p>Primary node only</p></td><td><p>Select this option to execute the <strong>Listener</strong> trigger on the primary node only when running in a cluster.</p></td><td><p>No</p></td></tr><tr><td><p>Redelivery policy</p></td><td><p>Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.</p></td><td><p>No</p></td></tr><tr><td><p>Reconnection strategy</p></td><td><p>When an operation in a Mule application fails to connect to an external server, the default behavior is for the operation to fail immediately and return a connectivity error. You can modify the default behavior by configuring the reconnection strategy for the operation.</p></td><td><p>No</p></td></tr><tr><td><p>Response</p></td><td><p>See <a href="https://docs.mulesoft.com/http-connector/latest/http-documentation#HttpResponseAttributes">HTTP Response Attributes</a>.</p></td><td><p>No</p></td></tr><tr><td><p>Error Response</p></td><td><p>HTTP error response returns a status code for the error.</p></td><td><p>No</p></td></tr><tr><td><p>Body</p></td><td><p>Body of the error message.</p></td><td><p>No</p></td></tr><tr><td><p>Headers</p></td><td><p>Headers to include in the error message.</p></td><td><p>No</p></td></tr><tr><td><p>Status code</p></td><td><p>Status code of the error response, for example, <code>500</code>.</p></td><td><p>No</p></td></tr><tr><td><p>Reason phrase</p></td><td><p>Reason for the error, for example, <code>Gateway Timeout</code> or <code>Internal Server Error</code>.</p></td><td><p>No</p></td></tr></tbody></table>

## Add the Connector to Your Integration Project

1.  In the Explorer view, open the configuration XML file for your project, such as
    `my-project-name.xml`.

2.  Click the
    ![Show Mule graphical mode icon](/mulesoft/current/en-us/anypoint-code-builder/_images/icon-tree-view.png) (**Show
    Mule graphical mode**) icon in the activity bar to open the canvas UI if it doesn’t open
    automatically.

3.  Add the connector the same way you added other components from the canvas UI:

    1.  In the canvas UI, click the
        ![Add component icon](/mulesoft/current/en-us/anypoint-code-builder/_images/icon-plus.png) (**Add component**)
        icon.

    2.  In the **Add Component** panel, click **Connectors**.

4.  Click the
    ![Search in Exchange icon](/mulesoft/current/en-us/anypoint-code-builder/_images/icon-search-exchange.png)
    (**Search in Exchange**) toggle:

    ![Search in Exchange toggle](/mulesoft/current/en-us/anypoint-code-builder/_images/int-connector-search-exchange.png)

5.  Enter `agentforce` in the search box.

6.  Select the connector to add it to your project.

Adding a connector to an integration project doesn’t make that connector available to other projects
in your Anypoint Code Builder workspace.

## Add a Global Configuration

1.  In the configuration XML, place your cursor before the `<flow/>` element and type `agentforce`.

    Ensure that the cursor is not inside the `<flow/>` element.

2.  Select the `ms-agentforce:config` snippet:

    The snippet adds the following code:

    ```xml
    <ms-agentforce:config clientId="#[]" clientSecret="#[]" />
    ```

3.  Add the attributes to complete the configuration, for example:

    ```xml
    <ms-agentforce:config name="Agentforce_Config" doc:name="Agentforce Config" doc:id="e3428ee2-d4ee-47dc-ba7e-30073f69165e" >
    		<ms-agentforce:oauth-client-credentials-connection >
    		<ms-agentforce:oauth-client-credentials clientId="clientid" clientSecret="supersecret" />
    		</ms-agentforce:oauth-client-credentials-connection>
    </ms-agentforce:config>
    ```

    This example shows a flow named "Define\_Prompt" with two global elements defined
    (`http:listener-config` and `ms-agentforce:config`)

    ```xml
     <http:listener-config basePath="/path" name="HTTP-Listener-config">
        <http:listener-connection host="0.0.0.0" port="8081">
        </http:listener-connection>
      </http:listener-config>
      <ms-agentforce:config name="Agentforce_Config" doc:name="Agentforce Config" doc:id="e3428ee2-d4ee-47dc-ba7e-30073f69165e" >
    	   <ms-agentforce:oauth-client-credentials-connection >
    		   <ms-agentforce:oauth-client-credentials clientId="clientid" clientSecret="supersecret" />
    	   </ms-agentforce:oauth-client-credentials-connection>
    	</ms-agentforce:config>
      <flow name="Define_Prompt">
    ```

## Configure Additional Connector Fields

After you configure a global element for the connector, configure the other required fields. The
required fields vary depending on which connector actions you use.

For more information about configuring Agentforce Connector actions, see
[Configuring Agent Operations for Agentforce Connector 1.2](https://docs.mulesoft.com/agentforce-connector/1.2/configuring-agent-operations).

## See Also

- [Anypoint Connectors Overview](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Agentforce Connector Reference](https://docs.mulesoft.com/agentforce-connector/1.2/agentforce-connector-reference)

- [Configuring Agent Operations for Agentforce Connector 1.2](https://docs.mulesoft.com/agentforce-connector/1.2/configuring-agent-operations)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=82a913fd610a99c097a3e35357a19d6c63b1dc45a85a050b70ad9cb435b9f196 url=/mulesoft/current/en-us/agentforce-connector/latest/agentforce-connector-config-acb.md -->

---
product: Agentforce Connector
version: 1.3
is-latest-version: true
---

# Using Anypoint Code Builder to Configure Agentforce Connector 1.3

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Cloud IDE (Beta) is scheduled for retirement on August 31, 2026. August 30, 2026 is the last day you
can access Cloud IDE (Beta). Download your projects to work from Desktop IDE. Learn more in
[Migrate a Project from Cloud IDE to Desktop IDE](https://docs.mulesoft.com/anypoint-code-builder/int-import-mule-project#migrate-cloud-to-desktop).

To use Anypoint Code Builder to configure a connector or module, create a basic integration project
in Anypoint Code Builder, add connectors and other components to your Mule application to process
your business logic, and configure the attributes.

## Before You Begin

Before creating an integration project, you must:

- [Set up and access the Anypoint Code Builder web or desktop IDE](https://docs.mulesoft.com/anypoint-code-builder/start-acb)

- Have credentials to access the connector’s API

- Ensure that the Visual Studio Code Extension Pack for Java is installed.

To use this connector, you must be familiar with:

- The connector’s API

- Anypoint Connectors

- Mule runtime engine (Mule)

## Create a New Integration Project

To create a new integration project:

1.  In the activity bar of the IDE, click the
    ![Anypoint Code Builder icon](/mulesoft/current/en-us/connectors/_images/acb-icon-ms-logo.png) (**Anypoint Code
    Builder**) icon.

2.  From **Quick Actions**, click **Develop an Integration**:

    ![Develop an Integration link highlighted in the Getting started section](/mulesoft/current/en-us/anypoint-code-builder/_images/develop-integration-option-mat.png)

3.  Complete the following in the **Develop an Integration** form:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Attribute</th><th>Value</th></tr></thead><tbody><tr><td><div><div><p><strong>Project Name</strong></p></div></div></td><td><div><div><p>Unique name for your project.</p></div><div><p>This name is used as the title and name of the integration project file. For example, if the project name is "Salesforce Integration," the project file name is <code>salesforce-integration</code>.</p></div></div></td></tr><tr><td><div><div><p><strong>Project Location</strong></p></div></div></td><td><div><div><p>Your home directory or another directory you create. Click <strong>Browse</strong> to select a different directory for the integration project.</p></div><div><p>Don’t create the project within another project directory.</p></div><div><p>See <a href="https://docs.mulesoft.com/anypoint-code-builder/start-add-folders">Adding Folders to Your Home Directory</a>.</p></div></div></td></tr></tbody></table>

4.  Select the type of project to create by selecting either the **Empty Project** or **Template or
    Example** card.

5.  Select the **Mule runtime** and **Java Version** for your app.

6.  Click **Create Project**.

## Add Components to Your Project

Add components to your integration project to build a flow:

1.  In the **Explorer** view, open the XML file for your project, such as `my-project-name.xml`.

2.  Select **Build a Flow** from the start card to create an empty flow:

    ![Anypoint Code Builder canvas with starting cards with the options to start from scratch, build a flow, or build a subflow](/mulesoft/current/en-us/connectors/_images/acb-build-flow.png)

3.  Change the name of the flow:

    1.  Click **Flow**.

    2.  Click the edit icon.

        ![Arrow pointing to the flow name edit pencil icon](/mulesoft/current/en-us/connectors/_images/acb-change-flow-name.png)

    3.  Enter the flow name, and click the checkmark.

    4.  In the canvas UI, click the
        ![Add component icon](/mulesoft/current/en-us/anypoint-code-builder/_images/icon-plus.png) (**Add component**)
        icon.

    5.  In the **Add Component** panel, search for and select your component from the results. The
        following example shows the **Listener** component from the **HTTP** search results:

        ![Listener component highlighted in the Add Component section](/mulesoft/current/en-us/anypoint-code-builder/_images/main-tutorial-add-first-listener.png)

        The configuration XML file now includes the XML for the HTTP Listener into the `<flow/>`
        element, for example:

        ```XML
        <flow name="getFlights" >
          <http:listener path="" config-ref="" doc:name="Listener" doc:id="ojzfry" />
        </flow>
        ```

## Configure the Trigger For the Flow

A trigger (source) starts the flow when specified conditions are met. If a connector has its own
associated sources, you can use a connector-specific trigger to initiate the flow. Each connector
trigger has a unique configuration.

You can configure the following sources for this connector:

- **HTTP > Listener**

  Initiates a flow each time it receives a request on the configured host and port

- **Scheduler**

  Initiates a flow when a time-based condition is met

For example, to configure an HTTP Listener trigger, follow these steps:

1.  Click the **Listener** component on the canvas UI.

2.  (Optional) Click the edit icon to change the name of the **Listener** component.

3.  (Optional) If you created a configuration file for the connector, select it.

4.  In the **General** tab, in the **Path** field, enter the relative path for the path set in the
    HTTP configuration element. See
    [Configure Paths](https://docs.mulesoft.com/http-connector/latest/http-listener-ref#configure-paths).

5.  Select the **Advanced** tab to configure the following attributes:

    <table><colgroup><col> <col> <col></colgroup><thead><tr><th>Attribute</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p>Allowed methods</p></td><td><p>To allow all HTTP methods (default), do not define this attribute. To restrict certain methods, specify all allowed HTTP methods, for example, <code>GET, POST</code>, as a comma-separated list.</p></td><td><p>No</p></td></tr><tr><td><p>Response streaming mode</p></td><td><p>Whether to use streaming when the response is sent.</p></td><td><p>No</p></td></tr><tr><td><p>Output MIME type</p></td><td><p>MIME type of the payload that this component outputs.</p></td><td><p>No</p></td></tr><tr><td><p>Parameters</p></td><td><p>Appends a key-value pair for a reader property to the value of the Output MIME attribute. Multiple key-value pairs are allowed.</p></td><td><p>No</p></td></tr><tr><td><p>Output encoding</p></td><td><p>Encoding of the payload that this component outputs.</p></td><td><p>No</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><p>Configures the way data streams are consumed in Mule apps.</p></td><td><p>No</p></td></tr><tr><td><p>Primary node only</p></td><td><p>Select this option to execute the <strong>Listener</strong> trigger on the primary node only when running in a cluster.</p></td><td><p>No</p></td></tr><tr><td><p>Redelivery policy</p></td><td><p>Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.</p></td><td><p>No</p></td></tr><tr><td><p>Reconnection strategy</p></td><td><p>When an operation in a Mule application fails to connect to an external server, the default behavior is for the operation to fail immediately and return a connectivity error. You can modify the default behavior by configuring the reconnection strategy for the operation.</p></td><td><p>No</p></td></tr><tr><td><p>Response</p></td><td><p>See <a href="https://docs.mulesoft.com/http-connector/latest/http-documentation#HttpResponseAttributes">HTTP Response Attributes</a>.</p></td><td><p>No</p></td></tr><tr><td><p>Error Response</p></td><td><p>HTTP error response returns a status code for the error.</p></td><td><p>No</p></td></tr><tr><td><p>Body</p></td><td><p>Body of the error message.</p></td><td><p>No</p></td></tr><tr><td><p>Headers</p></td><td><p>Headers to include in the error message.</p></td><td><p>No</p></td></tr><tr><td><p>Status code</p></td><td><p>Status code of the error response, for example, <code>500</code>.</p></td><td><p>No</p></td></tr><tr><td><p>Reason phrase</p></td><td><p>Reason for the error, for example, <code>Gateway Timeout</code> or <code>Internal Server Error</code>.</p></td><td><p>No</p></td></tr></tbody></table>

## Add the Connector to Your Integration Project

1.  In the Explorer view, open the configuration XML file for your project, such as
    `my-project-name.xml`.

2.  Click the
    ![Show Mule graphical mode icon](/mulesoft/current/en-us/anypoint-code-builder/_images/icon-tree-view.png) (**Show
    Mule graphical mode**) icon in the activity bar to open the canvas UI if it doesn’t open
    automatically.

3.  Add the connector the same way you added other components from the canvas UI:

    1.  In the canvas UI, click the
        ![Add component icon](/mulesoft/current/en-us/anypoint-code-builder/_images/icon-plus.png) (**Add component**)
        icon.

    2.  In the **Add Component** panel, click **Connectors**.

4.  Click the
    ![Search in Exchange icon](/mulesoft/current/en-us/anypoint-code-builder/_images/icon-search-exchange.png)
    (**Search in Exchange**) toggle:

    ![Search in Exchange toggle](/mulesoft/current/en-us/anypoint-code-builder/_images/int-connector-search-exchange.png)

5.  Enter `agentforce` in the search box.

6.  Select the connector to add it to your project.

Adding a connector to an integration project doesn’t make that connector available to other projects
in your Anypoint Code Builder workspace.

## Add a Global Configuration

1.  In the configuration XML, place your cursor before the `<flow/>` element and type `agentforce`.

    Ensure that the cursor is not inside the `<flow/>` element.

2.  Select the `ms-agentforce:config` snippet:

    The snippet adds the following code:

    ```xml
    <ms-agentforce:config clientId="#[]" clientSecret="#[]" />
    ```

3.  Add the attributes to complete the configuration, for example:

    ```xml
    <ms-agentforce:config name="Agentforce_Config" doc:name="Agentforce Config" doc:id="e3428ee2-d4ee-47dc-ba7e-30073f69165e" >
    		<ms-agentforce:oauth-client-credentials-connection >
    		<ms-agentforce:oauth-client-credentials clientId="clientid" clientSecret="supersecret" />
    		</ms-agentforce:oauth-client-credentials-connection>
    </ms-agentforce:config>
    ```

    This example shows a flow named "Define\_Prompt" with two global elements defined
    (`http:listener-config` and `ms-agentforce:config`)

    ```xml
     <http:listener-config basePath="/path" name="HTTP-Listener-config">
        <http:listener-connection host="0.0.0.0" port="8081">
        </http:listener-connection>
      </http:listener-config>
      <ms-agentforce:config name="Agentforce_Config" doc:name="Agentforce Config" doc:id="e3428ee2-d4ee-47dc-ba7e-30073f69165e" >
    	   <ms-agentforce:oauth-client-credentials-connection >
    		   <ms-agentforce:oauth-client-credentials clientId="clientid" clientSecret="supersecret" />
    	   </ms-agentforce:oauth-client-credentials-connection>
    	</ms-agentforce:config>
      <flow name="Define_Prompt">
    ```

## Configure Additional Connector Fields

After you configure a global element for the connector, configure the other required fields. The
required fields vary depending on which connector actions you use.

For more information about configuring Agentforce Connector actions, see
[Configuring Agent Operations for Agentforce Connector 1.3](https://docs.mulesoft.com/agentforce-connector/latest/configuring-agent-operations).

## See Also

- [Anypoint Connectors Overview](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Agentforce Connector Reference](https://docs.mulesoft.com/agentforce-connector/latest/agentforce-connector-reference)

- [Configuring Agent Operations for Agentforce Connector 1.3](https://docs.mulesoft.com/agentforce-connector/latest/configuring-agent-operations)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=c76a12f94083c99c738290fd614db9e56e8d4bb2baae72abf047af2b1464aa50 url=/mulesoft/current/en-us/agentforce-connector/1.0/agentforce-connector-studio.md -->

---
product: Agentforce Connector
version: 1.0
---

# Using Anypoint Studio to Configure Agentforce Connector 1.0

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and
configuration files.

To add and configure a connector in Studio:

1.  [Create a Mule project](#create-mule-project).

2.  [Add the connector to your Mule project](#add-connector-to-project).

3.  [Configure a source for the connector’s flow](#configure-source).

4.  [Add a connector operation to the flow](#add-connector-operation).

5.  [Configure a global element for the connector](#configure-global-element).

6.  [Configure the other connector fields](#configure-other-fields).

When you run the connector, you can view the app log to check for problems in real time, as
described in [View the App Log](#view-app-log).

If you are new to configuring connectors in Studio, see
[Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio).
If, after reading this topic, you need additional information about the connector fields, see the
[Agentforce Connector Reference](https://docs.mulesoft.com/agentforce-connector/1.0/agentforce-connector-reference).

## Create a Mule Project

In Studio, create a new Mule project in which to add and configure Anypoint Connector for Agentforce
(Agentforce Connector):

1.  In Studio, select **File > New > Mule Project**.

2.  Enter a name for your Mule project and click **Finish**.

## Add the Connector to Your Mule Project

Add Agentforce Connector to your Mule project to automatically populate the XML code with the
connector’s namespace and schema location and add the required dependencies to the project’s
`pom.xml` file:

1.  In **Mule Palette**, click **(X) Search in Exchange**.

2.  In **Add Dependencies to Project**, type `agentforce` in the search field.

3.  Click **Agentforce Connector** in **Available modules**.

4.  Click **Add**.

5.  Click **Finish**.

Adding a connector to a Mule project in Studio doesn’t make that connector available to other
projects in your Studio workspace.

## Configure a Source

A source initiates a flow when a specified condition is met. You can configure one of these sources
to use with Agentforce Connector:

- **HTTP > Listener**

  Initiates a flow each time it receives a request on the configured host and port

- **Scheduler**

  Initiates a flow when a time-based condition is met

For example, to configure an **HTTP > Listener** source, follow these steps:

1.  In **Mule Palette**, select **HTTP > Listener**.

2.  Drag **Listener** to the Studio canvas.

3.  On the **Listener** configuration screen, optionally change the value of the **Display Name**
    field.

4.  Specify a value for the **Path** field.

5.  Click the plus sign (**+**) next to the **Connector configuration** field to configure a global
    element that can be used by all instances of the **HTTP > Listener** source in the app.

6.  On the **General** tab, specify the connection information for the connector.

7.  On the **TLS** tab, optionally specify the TLS information for the connector.

8.  On the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

9.  Click **Test Connection** to confirm that Mule can connect with the specified server.

10. Click **OK**.

## Add a Connector Operation to the Flow

When you add a connector operation to your flow, you are specifying an action for that connector to
perform.

To add an operation for Agentforce Connector, follow these steps:

1.  In **Mule Palette**, select **Agentforce Connector** and then select the operation to add.

    ![Mule Palette in Studio with Agentforce connector selected and all of the connector’s operations listed](/mulesoft/current/en-us/agentforce-connector/1.0/_images/agentforce-operations.png)

2.  Drag the operation onto the Studio canvas, next to the source.

## Configure a Global Element for the Connector

When you configure a connector, configure a global element that all instances of that connector in
the app can use. Configuring a global element requires you to provide the authentication credentials
that the connector requires to access the target system.

You can reference a configuration file that contains ANT-style property placeholders (recommended),
or you can enter your authorization credentials in the global configuration properties. For
information about the benefits of using property placeholders and how to configure them, see
[Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview).

To configure the global element for Agentforce Connector, follow these steps:

1.  Select the operation in the Studio canvas.

2.  On the properties screen for the operation, click the Add (**+**) icon to access the global
    element configuration fields.

3.  In the **Global Elements Properties > General** tab, enter:

    - **Client Id**

      The OAuth public client ID as registered with the service provider.

    - **Client secret**

      The OAuth client secret that corresponds to the client ID.

    - **Token URL**

      Service provider’s token endpoint URL.

    - **Scopes**

      The OAuth scopes to request during the OAuth dance.

4.  Click **OK**.

## Configure Additional Connector Fields

After you configure a global element for the connector, configure the other required fields. The
required fields vary depending on which connector operation you use.

## View the App Log

To check for problems, you can view the app log as follows:

- If you’re running the app from Anypoint Platform, the app log output is visible on the Anypoint
  Studio console window.

- If you’re running the app using Mule from the command line, the app log output is visible in your
  operating system console.

Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the
app log in the default location `MULE_HOME/logs/<app-name>.log`. You can configure the location of
the log path in the app log file `log4j2.xml`.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Using Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Agentforce Connector Reference](https://docs.mulesoft.com/agentforce-connector/1.0/agentforce-connector-reference)

- [Configuring Agent Operations for Agentforce Connector](https://docs.mulesoft.com/agentforce-connector/1.0/configuring-agent-operations)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=63e3e1fdf7ea2a876ee58d6152ba16c406b27da8b3ea595ef965b6d7b01c4d04 url=/mulesoft/current/en-us/agentforce-connector/1.1/agentforce-connector-studio.md -->

---
product: Agentforce Connector
version: 1.1
---

# Using Anypoint Studio to Configure Agentforce Connector 1.1

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and
configuration files.

To add and configure a connector in Studio:

1.  [Create a Mule project](#create-mule-project).

2.  [Add the connector to your Mule project](#add-connector-to-project).

3.  [Configure a source for the connector’s flow](#configure-source).

4.  [Add a connector operation to the flow](#add-connector-operation).

5.  [Configure a global element for the connector](#configure-global-element).

6.  [Configure the other connector fields](#configure-other-fields).

When you run the connector, you can view the app log to check for problems in real time, as
described in [View the App Log](#view-app-log).

If you are new to configuring connectors in Studio, see
[Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio).
If, after reading this topic, you need additional information about the connector fields, see the
[Agentforce Connector Reference](https://docs.mulesoft.com/agentforce-connector/1.1/agentforce-connector-reference).

## Create a Mule Project

In Studio, create a new Mule project in which to add and configure Anypoint Connector for Agentforce
(Agentforce Connector):

1.  In Studio, select **File > New > Mule Project**.

2.  Enter a name for your Mule project and click **Finish**.

## Add the Connector to Your Mule Project

Add Agentforce Connector to your Mule project to automatically populate the XML code with the
connector’s namespace and schema location and add the required dependencies to the project’s
`pom.xml` file:

1.  In **Mule Palette**, click **(X) Search in Exchange**.

2.  In **Add Dependencies to Project**, type `agentforce` in the search field.

3.  Click **Agentforce Connector** in **Available modules**.

4.  Click **Add**.

5.  Click **Finish**.

Adding a connector to a Mule project in Studio doesn’t make that connector available to other
projects in your Studio workspace.

## Configure a Source

A source initiates a flow when a specified condition is met. You can configure one of these sources
to use with Agentforce Connector:

- **HTTP > Listener**

  Initiates a flow each time it receives a request on the configured host and port

- **Scheduler**

  Initiates a flow when a time-based condition is met

For example, to configure an **HTTP > Listener** source, follow these steps:

1.  In **Mule Palette**, select **HTTP > Listener**.

2.  Drag **Listener** to the Studio canvas.

3.  On the **Listener** configuration screen, optionally change the value of the **Display Name**
    field.

4.  Specify a value for the **Path** field.

5.  Click the plus sign (**+**) next to the **Connector configuration** field to configure a global
    element that can be used by all instances of the **HTTP > Listener** source in the app.

6.  On the **General** tab, specify the connection information for the connector.

7.  On the **TLS** tab, optionally specify the TLS information for the connector.

8.  On the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

9.  Click **Test Connection** to confirm that Mule can connect with the specified server.

10. Click **OK**.

## Add a Connector Operation to the Flow

When you add a connector operation to your flow, you are specifying an action for that connector to
perform.

To add an operation for Agentforce Connector, follow these steps:

1.  In **Mule Palette**, select **Agentforce Connector** and then select the operation to add.

    ![Mule Palette in Studio with Agentforce connector selected and all of the connector’s operations listed](/mulesoft/current/en-us/agentforce-connector/1.1/_images/agentforce-operations.png)

2.  Drag the operation onto the Studio canvas, next to the source.

## Configure a Global Element for the Connector

When you configure a connector, configure a global element that all instances of that connector in
the app can use. Configuring a global element requires you to provide the authentication credentials
that the connector requires to access the target system.

You can reference a configuration file that contains ANT-style property placeholders (recommended),
or you can enter your authorization credentials in the global configuration properties. For
information about the benefits of using property placeholders and how to configure them, see
[Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview).

To configure the global element for Agentforce Connector, follow these steps:

1.  Select the operation in the Studio canvas.

2.  On the properties screen for the operation, click the Add (**+**) icon to access the global
    element configuration fields.

3.  In the **Global Elements Properties > General** tab, enter:

    - **Client Id**

      The OAuth public client ID as registered with the service provider.

    - **Client secret**

      The OAuth client secret that corresponds to the client ID.

    - **Token URL**

      Service provider’s token endpoint URL.

    - **Scopes**

      The OAuth scopes to request during the OAuth dance.

4.  Click **OK**.

## Configure Additional Connector Fields

After you configure a global element for the connector, configure the other required fields. The
required fields vary depending on which connector operation you use.

## View the App Log

To check for problems, you can view the app log as follows:

- If you’re running the app from Anypoint Platform, the app log output is visible on the Anypoint
  Studio console window.

- If you’re running the app using Mule from the command line, the app log output is visible in your
  operating system console.

Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the
app log in the default location `MULE_HOME/logs/<app-name>.log`. You can configure the location of
the log path in the app log file `log4j2.xml`.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Using Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Agentforce Connector Reference](https://docs.mulesoft.com/agentforce-connector/1.1/agentforce-connector-reference)

- [Configuring Agent Operations for Agentforce Connector 1.1](https://docs.mulesoft.com/agentforce-connector/1.1/configuring-agent-operations)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=ca24bf7907ec20518cdad2891b6bef50a9deaf106ec2d1e39fb324f4fbd98717 url=/mulesoft/current/en-us/agentforce-connector/1.2/agentforce-connector-studio.md -->

---
product: Agentforce Connector
version: 1.2
---

# Using Anypoint Studio to Configure Agentforce Connector 1.2

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and
configuration files.

To add and configure a connector in Studio:

1.  [Create a Mule project](#create-mule-project).

2.  [Add the connector to your Mule project](#add-connector-to-project).

3.  [Configure a source for the connector’s flow](#configure-source).

4.  [Add a connector operation to the flow](#add-connector-operation).

5.  [Configure a global element for the connector](#configure-global-element).

6.  [Configure the other connector fields](#configure-other-fields).

When you run the connector, you can view the app log to check for problems in real time, as
described in [View the App Log](#view-app-log).

If you are new to configuring connectors in Studio, see
[Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio).
If, after reading this topic, you need additional information about the connector fields, see the
[Agentforce Connector Reference](https://docs.mulesoft.com/agentforce-connector/1.2/agentforce-connector-reference).

## Create a Mule Project

In Studio, create a new Mule project in which to add and configure Anypoint Connector for Agentforce
(Agentforce Connector):

1.  In Studio, select **File > New > Mule Project**.

2.  Enter a name for your Mule project and click **Finish**.

## Add the Connector to Your Mule Project

Add Agentforce Connector to your Mule project to automatically populate the XML code with the
connector’s namespace and schema location and add the required dependencies to the project’s
`pom.xml` file:

1.  In **Mule Palette**, click **(X) Search in Exchange**.

2.  In **Add Dependencies to Project**, type `agentforce` in the search field.

3.  Click **Agentforce Connector** in **Available modules**.

4.  Click **Add**.

5.  Click **Finish**.

Adding a connector to a Mule project in Studio doesn’t make that connector available to other
projects in your Studio workspace.

## Configure a Source

A source initiates a flow when a specified condition is met. You can configure one of these sources
to use with Agentforce Connector:

- **HTTP > Listener**

  Initiates a flow each time it receives a request on the configured host and port

- **Scheduler**

  Initiates a flow when a time-based condition is met

For example, to configure an **HTTP > Listener** source, follow these steps:

1.  In **Mule Palette**, select **HTTP > Listener**.

2.  Drag **Listener** to the Studio canvas.

3.  On the **Listener** configuration screen, optionally change the value of the **Display Name**
    field.

4.  Specify a value for the **Path** field.

5.  Click the plus sign (**+**) next to the **Connector configuration** field to configure a global
    element that can be used by all instances of the **HTTP > Listener** source in the app.

6.  On the **General** tab, specify the connection information for the connector.

7.  On the **TLS** tab, optionally specify the TLS information for the connector.

8.  On the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

9.  Click **Test Connection** to confirm that Mule can connect with the specified server.

10. Click **OK**.

## Add a Connector Operation to the Flow

When you add a connector operation to your flow, you are specifying an action for that connector to
perform.

To add an operation for Agentforce Connector, follow these steps:

1.  In **Mule Palette**, select **Agentforce Connector** and then select the operation to add.

    ![Mule Palette in Studio with Agentforce connector selected and all of the connector’s operations listed](/mulesoft/current/en-us/agentforce-connector/1.2/_images/agentforce-operations.png)

2.  Drag the operation onto the Studio canvas, next to the source.

## Configure a Global Element for the Connector

When you configure a connector, configure a global element that all instances of that connector in
the app can use. Configuring a global element requires you to provide the authentication credentials
that the connector requires to access the target system.

You can reference a configuration file that contains ANT-style property placeholders (recommended),
or you can enter your authorization credentials in the global configuration properties. For
information about the benefits of using property placeholders and how to configure them, see
[Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview).

To configure the global element for Agentforce Connector, follow these steps:

1.  Select the operation in the Studio canvas.

2.  On the properties screen for the operation, click the Add (**+**) icon to access the global
    element configuration fields.

3.  In the **Global Elements Properties > General** tab, enter:

    - **Client Id**

      The OAuth public client ID as registered with the service provider.

    - **Client secret**

      The OAuth client secret that corresponds to the client ID.

    - **Token URL**

      Service provider’s token endpoint URL.

    - **Scopes**

      The OAuth scopes to request during the OAuth dance.

4.  Click **OK**.

## Configure Additional Connector Fields

After you configure a global element for the connector, configure the other required fields. The
required fields vary depending on which connector operation you use.

## View the App Log

To check for problems, you can view the app log as follows:

- If you’re running the app from Anypoint Platform, the app log output is visible on the Anypoint
  Studio console window.

- If you’re running the app using Mule from the command line, the app log output is visible in your
  operating system console.

Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the
app log in the default location `MULE_HOME/logs/<app-name>.log`. You can configure the location of
the log path in the app log file `log4j2.xml`.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Using Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Agentforce Connector Reference](https://docs.mulesoft.com/agentforce-connector/1.2/agentforce-connector-reference)

- [Configuring Agent Operations for Agentforce Connector 1.2](https://docs.mulesoft.com/agentforce-connector/1.2/configuring-agent-operations)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=9fd3e3bda633806dfc16037ad5fb8648d8f08dbbc2de96bc68bd9ee3a2215965 url=/mulesoft/current/en-us/agentforce-connector/latest/agentforce-connector-studio.md -->

---
product: Agentforce Connector
version: 1.3
is-latest-version: true
---

# Using Anypoint Studio to Configure Agentforce Connector 1.3

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and
configuration files.

To add and configure a connector in Studio:

1.  [Create a Mule project](#create-mule-project).

2.  [Add the connector to your Mule project](#add-connector-to-project).

3.  [Configure a source for the connector’s flow](#configure-source).

4.  [Add a connector operation to the flow](#add-connector-operation).

5.  [Configure a global element for the connector](#configure-global-element).

6.  [Configure the other connector fields](#configure-other-fields).

When you run the connector, you can view the app log to check for problems in real time, as
described in [View the App Log](#view-app-log).

If you are new to configuring connectors in Studio, see
[Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio).
If, after reading this topic, you need additional information about the connector fields, see the
[Agentforce Connector Reference](https://docs.mulesoft.com/agentforce-connector/latest/agentforce-connector-reference).

## Create a Mule Project

In Studio, create a new Mule project in which to add and configure Anypoint Connector for Agentforce
(Agentforce Connector):

1.  In Studio, select **File > New > Mule Project**.

2.  Enter a name for your Mule project and click **Finish**.

## Add the Connector to Your Mule Project

Add Agentforce Connector to your Mule project to automatically populate the XML code with the
connector’s namespace and schema location and add the required dependencies to the project’s
`pom.xml` file:

1.  In **Mule Palette**, click **(X) Search in Exchange**.

2.  In **Add Dependencies to Project**, type `agentforce` in the search field.

3.  Click **Agentforce Connector** in **Available modules**.

4.  Click **Add**.

5.  Click **Finish**.

Adding a connector to a Mule project in Studio doesn’t make that connector available to other
projects in your Studio workspace.

## Configure a Source

A source initiates a flow when a specified condition is met. You can configure one of these sources
to use with Agentforce Connector:

- **HTTP > Listener**

  Initiates a flow each time it receives a request on the configured host and port

- **Scheduler**

  Initiates a flow when a time-based condition is met

For example, to configure an **HTTP > Listener** source, follow these steps:

1.  In **Mule Palette**, select **HTTP > Listener**.

2.  Drag **Listener** to the Studio canvas.

3.  On the **Listener** configuration screen, optionally change the value of the **Display Name**
    field.

4.  Specify a value for the **Path** field.

5.  Click the plus sign (**+**) next to the **Connector configuration** field to configure a global
    element that can be used by all instances of the **HTTP > Listener** source in the app.

6.  On the **General** tab, specify the connection information for the connector.

7.  On the **TLS** tab, optionally specify the TLS information for the connector.

8.  On the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

9.  Click **Test Connection** to confirm that Mule can connect with the specified server.

10. Click **OK**.

## Add a Connector Operation to the Flow

When you add a connector operation to your flow, you are specifying an action for that connector to
perform.

To add an operation for Agentforce Connector, follow these steps:

1.  In **Mule Palette**, select **Agentforce Connector** and then select the operation to add.

    ![Mule Palette in Studio with Agentforce connector selected and all of the connector’s operations listed](/mulesoft/current/en-us/agentforce-connector/latest/_images/agentforce-operations.png)

2.  Drag the operation onto the Studio canvas, next to the source.

## Configure a Global Element for the Connector

When you configure a connector, configure a global element that all instances of that connector in
the app can use. Configuring a global element requires you to provide the authentication credentials
that the connector requires to access the target system.

You can reference a configuration file that contains ANT-style property placeholders (recommended),
or you can enter your authorization credentials in the global configuration properties. For
information about the benefits of using property placeholders and how to configure them, see
[Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview).

To configure the global element for Agentforce Connector, follow these steps:

1.  Select the operation in the Studio canvas.

2.  On the properties screen for the operation, click the Add (**+**) icon to access the global
    element configuration fields.

3.  In the **Global Elements Properties > General** tab, enter:

    - **Client Id**

      The OAuth public client ID as registered with the service provider.

    - **Client secret**

      The OAuth client secret that corresponds to the client ID.

    - **Token URL**

      Service provider’s token endpoint URL.

    - **Scopes**

      The OAuth scopes to request during the OAuth dance.

4.  Click **OK**.

## Configure Additional Connector Fields

After you configure a global element for the connector, configure the other required fields. The
required fields vary depending on which connector operation you use.

## View the App Log

To check for problems, you can view the app log as follows:

- If you’re running the app from Anypoint Platform, the app log output is visible on the Anypoint
  Studio console window.

- If you’re running the app using Mule from the command line, the app log output is visible in your
  operating system console.

Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the
app log in the default location `MULE_HOME/logs/<app-name>.log`. You can configure the location of
the log path in the app log file `log4j2.xml`.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Using Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Agentforce Connector Reference](https://docs.mulesoft.com/agentforce-connector/latest/agentforce-connector-reference)

- [Configuring Agent Operations for Agentforce Connector 1.3](https://docs.mulesoft.com/agentforce-connector/latest/configuring-agent-operations)

- [Salesforce Help](https://help.salesforce.com)