Contact Us 1-800-596-4880
  1. Homepage
  2. Agentforce Connector (1.0)

  3. Agentforce Connector Reference

All Connectors

Agentforce Connector 1.0 Reference

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

Configurations

Config

Default configuration

Parameters

Name Type Description Default Value Required

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

OAuth Client Credentials

The connection types to provide to this configuration.

x

Name

String

ID used to reference this configuration.

x

Connection Types

OAuth Client Credentials
Parameters
Name Type Description Default Value Required

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Client Id

String

The OAuth client ID as registered with the service provider.

x

Client Secret

String

The OAuth client secret as registered with the service provider.

x

Token Url

String

The service provider’s token endpoint URL.

https://{salesforceorg}/services/oauth2/token

Scopes

String

OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.

Object Store

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

Supported Operations

Operations

Continue Agent Conversation

<ms-agentforce:continue-agent-conversation>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Message

Any

#[payload]

Session Id

String

Session ID returned with the Start agent conversation operation.

x

Message Sequence Number

Number

Increase this number for each subsequent message in a session.

x

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

For Configurations

Throws

  • MS-AGENTFORCE:AGENT_METADATA_FAILURE

  • MS-AGENTFORCE:AGENT_OPERATIONS_FAILURE

  • MS-AGENTFORCE:CONNECTIVITY

  • MS-AGENTFORCE:RETRY_EXHAUSTED

End Agent Conversation

<ms-agentforce:end-agent-conversation>

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

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Session Id

String

Session ID returned with the Start agent conversation operation.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

For Configurations

Throws

  • MS-AGENTFORCE:AGENT_METADATA_FAILURE

  • MS-AGENTFORCE:AGENT_OPERATIONS_FAILURE

  • MS-AGENTFORCE:CONNECTIVITY

  • MS-AGENTFORCE:RETRY_EXHAUSTED

Start Agent Conversation

<ms-agentforce:start-agent-conversation>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Output Mime Type

String

MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Agent List

String

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Invoke Agent Response Attributes

For Configurations

Throws

  • MS-AGENTFORCE:AGENT_METADATA_FAILURE

  • MS-AGENTFORCE:AGENT_OPERATIONS_FAILURE

  • MS-AGENTFORCE:CONNECTIVITY

  • MS-AGENTFORCE:RETRY_EXHAUSTED

Unauthorize

<ms-agentforce:unauthorize>

Deletes all the access token information of a given resource owner ID so that it’s impossible to execute any operation for that user without doing the authorization dance again

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

For Configurations

Types

Reconnection

Configures a reconnection strategy for an operation.

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

Reconnection strategy to use.

Reconnect

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

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Count

Number

How many reconnection attempts the Mule app can make.

Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Invoke Agent Response Attributes

Field Type Description Default Value Required

Messages

Array of Message

Message

Field Type Description Default Value Required

Content Safe

Boolean

Feedback Id

String

Id

String

Message

String

Plan Id

String

Reason

String

Type

String

Repeatable In-Memory Stream

Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.

Field Type Description Default Value Required

Initial Buffer Size

Number

Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max Buffer Size.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

Number

Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a STREAM_MAXIMUM_SIZE_EXCEEDED error. A value of less than or equal to 0 means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the Initial Buffer Size, Buffer Size Increment, and Max Buffer Size fields.

Repeatable File Store Stream

Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.

Field Type Description Default Value Required

In Memory Size

Number

Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:

  • Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.

  • Configure a smaller buffer size to decrease memory load at the expense of response time.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

Error Mapping

Field Type Description Default Value Required

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

Target

String

x

See Also

Back to top
View on GitHub