---
schema_version: "1"
id: 437d9e3cca37b0a6c109352b39bbdff56a1abf77262ebe07f4d2d787cf3d4baf
title: Salesforce Pub/Sub Connector 1.0 Reference
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/salesforce-pubsub-connector/1.0/salesforce-pubsub-connector-reference.md
canonical_url: https://docs.mulesoft.com/salesforce-pubsub-connector/1.0/salesforce-pubsub-connector-reference
source_site: docs.mulesoft.com
content_type: documentation
content_hash: bfea77d51cb5692855a6f1823fbd5008843a0063ad6c5bd0e0519178c379bbe5
description: MuleSoft Documentation Site
release: "1.0"
latest: false
---
---
product: Salesforce Pub/Sub Connector
version: 1.0
---

# Salesforce Pub/Sub Connector 1.0 Reference

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

Anypoint Connector for Salesforce Pub/Sub (Salesforce Pub/Sub Connector) enables you to connect to
the Pub/Sub API, which provides a single interface for publishing and subscribing to platform
events, including real-time event monitoring events and change data capture events.

## Configuration

Default Configuration for Salesforce Pub/Sub Connector.

<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>Name</p></td><td><p>String</p></td><td><p>Name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Connection</p></td><td><div><div><ul><li><p><a href="#PubsubConfig_Basic">Basic Authentication</a></p></li><li><p><a href="#PubsubConfig_ConfigWithOauth">OAuth v2.0</a></p></li><li><p><a href="#PubsubConfig_Jwt">OAuth JWT</a></p></li><li><p><a href="#PubsubConfig_OauthUserPass">OAuth Username Password</a></p></li><li><p><a href="#PubsubConfig_Saml">OAuth SAML</a></p></li></ul></div></div></td><td><p>Connection types for this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>ID used to reference this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.</p></td><td></td><td></td></tr></tbody></table>

### Basic Authentication Connection Type

Uses a username and a password for authentication.

<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>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to <code>0</code>.</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Time unit</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><p>Time unit for the <strong>Connection Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Login Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long the client waits to receive the answer for the login request before timing out. Values less than one millisecond are converted to <code>0</code>.</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Login Request Time unit</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><p>Time unit for the <strong>Login Request Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Proxy configuration</p></td><td><div><div><p><a href="#ProxyConfiguration">Proxy</a></p></div></div></td><td><p>Configures a proxy for outbound connections. The requests to the gRPC API (towards the gRPC host and gRPC port) are proxied through the proxy server configured using this field.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to initialize the session.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate the user.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Security Token</p></td><td><div><div><p>String</p></div></div></td><td><p>User’s security token. The security token can be omitted if your IP has been added to the allowlist on Salesforce.</p></td><td></td><td></td></tr><tr><td><p>Authorization URL</p></td><td><div><div><p>String</p></div></div></td><td><p>Web service URL responsible for user authentication. The URL for the endpoint that is configured to handle SOAP authentication requests.</p></td><td></td><td></td></tr><tr><td><p>TLS configuration</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><p>Configures TLS. If using the HTTPS protocol, you must configure TLS.</p></td><td></td><td></td></tr><tr><td><p>gRPC host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host in which the proxy requests are sent to the gRPC API (towards the gRPC host). The proxy requests to the gRPC host go through the proxy.</p></td><td><p><code>api.pubsub.salesforce.com</code></p></td><td></td></tr><tr><td><p>gRPC port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port in which the proxy requests are sent to the gRPC API (towards the gRPC port). The proxy requests to the gRPC port go through the proxy.</p></td><td><p><code>7443</code></p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>Configures a reconnection strategy to use when a connector operation fails to connect to an external server.</p></td><td></td><td></td></tr></tbody></table>

### OAuth v2.0 Connection Type

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

<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>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to <code>0</code>.</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Time unit</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><p>Time unit for the <strong>Connection Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Login Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long the client waits to receive the answer for the login request before timing out. Values less than one millisecond are converted to <code>0</code>.</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Login Request Time unit</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><p>Time unit for the <strong>Login Request Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Proxy configuration</p></td><td><div><div><p><a href="#ProxyConfiguration">Proxy</a></p></div></div></td><td><p>Configures a proxy for outbound connections. The requests to the gRPC API (towards the gRPC host and gRPC port) are proxied through the proxy server configured using this field.</p></td><td></td><td></td></tr><tr><td><p>Api Version</p></td><td><div><div><p>Number</p></div></div></td><td><p>API version used. Defaults to the latest API version supported by the connector.</p></td><td></td><td></td></tr><tr><td><p>TLS configuration</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><p>Configures TLS. If using the HTTPS protocol, you must configure TLS.</p></td><td></td><td></td></tr><tr><td><p>gRPC host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host in which the proxy requests are sent to the gRPC API (towards the gRPC host). The proxy requests to the gRPC host go through the proxy.</p></td><td><p><code>api.pubsub.salesforce.com</code></p></td><td></td></tr><tr><td><p>gRPC port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port in which the proxy requests are sent to the gRPC API (towards the gRPC port). The proxy requests to the gRPC port go through the proxy.</p></td><td><p><code>7443</code></p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>Configures a reconnection strategy to use when a connector operation fails to connect to an external server.</p></td><td></td><td></td></tr><tr><td><p>Consumer Key</p></td><td><div><div><p>String</p></div></div></td><td><p>OAuth consumer key, as registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Consumer Secret</p></td><td><div><div><p>String</p></div></div></td><td><p>OAuth consumer secret, as registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Authorization Url</p></td><td><div><div><p>String</p></div></div></td><td><p>URL of the service provider’s authorization endpoint.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/authorize</code></p></td><td></td></tr><tr><td><p>Access Token Url</p></td><td><div><div><p>String</p></div></div></td><td><p>URL of the service provider’s access token endpoint.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/token</code></p></td><td></td></tr><tr><td><p>Scopes</p></td><td><div><div><p>String</p></div></div></td><td><p>OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.</p></td><td></td><td></td></tr><tr><td><p>Resource Owner Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Resource owner ID to use with the authorization code grant type.</p></td><td></td><td></td></tr><tr><td><p>Before</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the flow to execute immediately before starting the OAuth dance.</p></td><td></td><td></td></tr><tr><td><p>After</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the flow to execute immediately after receiving an access token.</p></td><td></td><td></td></tr><tr><td><p>Listener Config</p></td><td><div><div><p>String</p></div></div></td><td><p>Configuration for the HTTP listener that listens for requests on the access token callback endpoint.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Callback Path</p></td><td><div><div><p>String</p></div></div></td><td><p>Path of the access token callback endpoint.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Authorize Path</p></td><td><div><div><p>String</p></div></div></td><td><p>Path of the local HTTP endpoint that triggers the OAuth dance.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>External Callback Url</p></td><td><div><div><p>String</p></div></div></td><td><p>URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL.</p></td><td></td><td></td></tr><tr><td><p>Object Store</p></td><td><div><div><p>String</p></div></div></td><td><p>Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.</p></td><td></td><td></td></tr></tbody></table>

### OAuth JWT Connection Type

Uses OAuth 2.0 with a JSON Web Token (JWT) request for user authentication.

<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>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to <code>0</code>.</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Time unit</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><p>Time unit for the <strong>Connection Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Login Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long the client waits to receive the answer for the login request before timing out. Values less than one millisecond are converted to <code>0</code>.</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Login Request Time unit</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><p>Time unit for the <strong>Login Request Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Proxy configuration</p></td><td><div><div><p><a href="#ProxyConfiguration">Proxy</a></p></div></div></td><td><p>Configures a proxy for outbound connections. The requests to the gRPC API (towards the gRPC host and gRPC port) are proxied through the proxy server configured using this field.</p></td><td></td><td></td></tr><tr><td><p>Api Version</p></td><td><div><div><p>Number</p></div></div></td><td><p>API version used. Defaults to the latest API version supported by the connector.</p></td><td></td><td></td></tr><tr><td><p>Consumer Key</p></td><td><div><div><p>String</p></div></div></td><td><p>Consumer key for the Salesforce connected app.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Key Store</p></td><td><div><div><p>String</p></div></div></td><td><p>Path to the keystore used to sign data during authentication.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Store Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password of the keystore.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Certificate Alias</p></td><td><div><div><p>String</p></div></div></td><td><p>Alias of the certificate.</p></td><td></td><td></td></tr><tr><td><p>Principal</p></td><td><div><div><p>String</p></div></div></td><td><p>Username of the desired Salesforce user to take action on behalf of.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Token Endpoint</p></td><td><div><div><p>String</p></div></div></td><td><p>URL pointing to the server responsible for providing the authentication token. According to Salesforce, the <strong>Token Endpoint</strong> field is <code>https://login.salesforce.com/services/oauth2/token</code> or <code>https://acme.force.com/customers/services/oauth2/token</code> (in which <code>\acme.force.com/customers</code> is your community URL) if implementing for a community.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/token</code></p></td><td></td></tr><tr><td><p>Audience Url</p></td><td><div><div><p>String</p></div></div></td><td><p>Audience identifies the authorization server as an intended audience. The authorization server must verify that the authorization server is an intended audience for the token. Use the authorization server’s URL for the audience value: <code>https://login.salesforce.com</code>, <code>https://test.salesforce.com</code>, or <code>https://community.force.com/customers</code> if implementing for a community.</p></td><td></td><td></td></tr><tr><td><p>TLS configuration</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><p>Configures TLS. If using the HTTPS protocol, you must configure TLS.</p></td><td></td><td></td></tr><tr><td><p>gRPC host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host in which the proxy requests are sent to the gRPC API (towards the gRPC host). The proxy requests to the gRPC host go through the proxy.</p></td><td><p><code>api.pubsub.salesforce.com</code></p></td><td></td></tr><tr><td><p>gRPC port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port in which the proxy requests are sent to the gRPC API (towards the gRPC port). The proxy requests to the gRPC port go through the proxy.</p></td><td><p><code>7443</code></p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>Configures a reconnection strategy to use when a connector operation fails to connect to an external server.</p></td><td></td><td></td></tr></tbody></table>

### OAuth Username Password Connection Type

Uses OAuth 2.0 with a username and a password for authentication.

<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>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to <code>0</code>.</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Time unit</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><p>Time unit for the <strong>Connection Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Login Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long the client waits to receive the answer for the login request before timing out. Values less than one millisecond are converted to <code>0</code>.</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Login Request Time unit</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><p>Time unit for the <strong>Login Request Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Proxy configuration</p></td><td><div><div><p><a href="#ProxyConfiguration">Proxy</a></p></div></div></td><td><p>Configures a proxy for outbound connections. The requests to the gRPC API (towards the gRPC host and gRPC port) are proxied through the proxy server configured using this field.</p></td><td></td><td></td></tr><tr><td><p>Api Version</p></td><td><div><div><p>Number</p></div></div></td><td><p>API version used. Defaults to the latest API version supported by the connector.</p></td><td></td><td></td></tr><tr><td><p>Consumer Key</p></td><td><div><div><p>String</p></div></div></td><td><p>Consumer key for the Salesforce connected app.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Consumer Secret</p></td><td><div><div><p>String</p></div></div></td><td><p>Your application’s client secret (consumer secret in Remote Access Detail).</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username used to initialize the session.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to authenticate the user.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Security Token</p></td><td><div><div><p>String</p></div></div></td><td><p>User’s security token. The security token can be omitted if your IP has been added to the allowlist on Salesforce.</p></td><td></td><td></td></tr><tr><td><p>Token Endpoint</p></td><td><div><div><p>String</p></div></div></td><td><p>URL pointing to the server responsible for providing the authentication token. According to Salesforce, the <strong>Token Endpoint</strong> field is <code>https://login.salesforce.com/services/oauth2/token</code> or <code>https://acme.force.com/customers/services/oauth2/token</code> (in which <code>\acme.force.com/customers</code> is your community URL) if implementing for a community.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/token</code></p></td><td></td></tr><tr><td><p>TLS configuration</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><p>Configures TLS. If using the HTTPS protocol, you must configure TLS.</p></td><td></td><td></td></tr><tr><td><p>gRPC host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host in which the proxy requests are sent to the gRPC API (towards the gRPC host). The proxy requests to the gRPC host go through the proxy.</p></td><td><p><code>api.pubsub.salesforce.com</code></p></td><td></td></tr><tr><td><p>gRPC port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port in which the proxy requests are sent to the gRPC API (towards the gRPC port). The proxy requests to the gRPC port go through the proxy.</p></td><td><p><code>7443</code></p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>Configures a reconnection strategy to use when a connector operation fails to connect to an external server.</p></td><td></td><td></td></tr></tbody></table>

### OAuth SAML Connection Type

Uses OAuth 2.0 with a signed SAML 2.0 assertion to request an access token.

<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>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to <code>0</code>.</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Time unit</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><p>Time unit for the <strong>Connection Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Login Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long the client waits to receive the answer for the login request before timing out. Values less than one millisecond are converted to <code>0</code>.</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Login Request Time unit</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><p>Time unit for the <strong>Login Request Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Proxy configuration</p></td><td><div><div><p><a href="#ProxyConfiguration">Proxy</a></p></div></div></td><td><p>Configures a proxy for outbound connections. The requests to the gRPC API (towards the gRPC host and gRPC port) are proxied through the proxy server configured using this field.</p></td><td></td><td></td></tr><tr><td><p>Api Version</p></td><td><div><div><p>Number</p></div></div></td><td><p>API version used. Defaults to the latest API version supported by the connector.</p></td><td></td><td></td></tr><tr><td><p>Consumer Key</p></td><td><div><div><p>String</p></div></div></td><td><p>Consumer key for the Salesforce connected app.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Key Store</p></td><td><div><div><p>String</p></div></div></td><td><p>Path to the keystore used to sign data during authentication.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Store Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password of the keystore.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Certificate Alias</p></td><td><div><div><p>String</p></div></div></td><td><p>Alias of the certificate.</p></td><td></td><td></td></tr><tr><td><p>Principal</p></td><td><div><div><p>String</p></div></div></td><td><p>Username of the desired Salesforce user to take action on behalf of.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Token Endpoint</p></td><td><div><div><p>String</p></div></div></td><td><p>URL pointing to the server responsible for providing the authentication token. According to Salesforce, the <strong>Token Endpoint</strong> field is <code>https://login.salesforce.com/services/oauth2/token</code> or <code>https://acme.force.com/customers/services/oauth2/token</code> (in which <code>\acme.force.com/customers</code> is your community URL) if implementing for a community.</p></td><td><p><code>https://login.salesforce.com/services/oauth2/token</code></p></td><td></td></tr><tr><td><p>TLS configuration</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><p>Configures TLS. If using the HTTPS protocol, you must configure TLS.</p></td><td></td><td></td></tr><tr><td><p>gRPC host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host in which the proxy requests are sent to the gRPC API (towards the gRPC host). The proxy requests to the gRPC host go through the proxy.</p></td><td><p><code>api.pubsub.salesforce.com</code></p></td><td></td></tr><tr><td><p>gRPC port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port in which the proxy requests are sent to the gRPC API (towards the gRPC port). The proxy requests to the gRPC port go through the proxy.</p></td><td><p><code>7443</code></p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>Configures a reconnection strategy to use when a connector operation fails to connect to an external server.</p></td><td></td><td></td></tr></tbody></table>

## Sources

- [Subscribe Channel Listener](#SubscribeChannelListener)

### Subscribe Channel Listener

`<salesforce-pub-sub:subscribe-channel-listener>`

Subscribes to a streaming channel. This source provides channel-related notification settings for
new events that occur after you subscribe.

> [!NOTE] A channel must be published to Salesforce before a subscription to the channel is created.

<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>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Channel Name</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the streaming channel to subscribe to.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Replay Option</p></td><td><div><div><p>One of:</p></div><div><ul><li><p>LATEST</p></li><li><p>EARLIEST</p></li><li><p>CUSTOM</p></li><li><p>REPLAY ID FROM OBJECT STORE</p></li></ul></div></div></td><td><div><div><p>Interface with the following implementations:</p></div><div><ul><li><p><code>Latest</code></p><div><p>Subscriber receives new events that are broadcast after the client subscribes.</p></div></li><li><p><code>Earliest</code></p><div><p>Subscriber receives all events, including past events that are within the retention window of the server and new events sent after subscription.</p></div></li><li><p><code>Custom replay id</code></p><div><p>Subscriber receives only events with a replay ID higher than the specified value.</p></div></li><li><p><code>Replay id from object store</code></p><div><p>Subscriber receives only events with a replay ID higher than the specified value in object store. If no value is found, it defaults to <code>Earliest</code>. Provide values for the <strong>Object Store Name</strong> and the <strong>Object Store Key</strong> fields to connect to the desired object store and retrieve the replay ID value. For more information on how to use <code>Replay id from object store</code>, refer to <a href="https://docs.mulesoft.com/salesforce-pubsub-connector/1.0/salesforce-pubsub-connector-studio#store-objectstore">Store the Replay ID in the Object Store</a>.</p></div></li></ul></div></div></td><td></td><td><p>x</p></td></tr><tr><td><p>Batch events size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Total number of events included in a server batch. Lower values indicate small memory footprint with more server calls, while higher values indicate bigger memory footprint with less API calls. A new batch of events is requested by the connector after the flow consumes the existing events. The maximum value is <code>100</code>.</p></td><td><p><code>100</code></p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Primary Node Only</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Determines whether to execute this source on only the primary node when running Mule instances in a cluster.</p></td><td><p><code>true</code></p></td><td></td></tr><tr><td><p>Streaming Strategy</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><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Redelivery Policy</p></td><td><div><div><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></div></div></td><td><p>Defines a policy for processing the redelivery of the same message.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</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><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></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>Any</p></div></div></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#PubsubConfig)

## Operations

- [Publish Event](#PublishEvent)

- [Unauthorize](#Unauthorize)

### Publish Event

`<salesforce-pub-sub:publish-event>`

Publishes the given list of events to the specified event topic. Only high-volume platform events,
including real-time event monitoring events and change data capture events, are allowed.

<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>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Topic</p></td><td><p>String</p></td><td><div><div><p>Name of the topic used for message publishing. You can select the topic name from the list of available topics. Sample topic formats:</p></div><div><ul><li><p>For a standard platform event: <code>/event/EventName</code>. For a custom platform event: <code>/event/EventName__e</code>. For example, for <code>Order_Event__e</code>, the topic is <code>/event/Order_Event__e</code>.</p></li><li><p>For a change data capture channel that captures events for all selected entities: <code>/data/ChangeEvents</code>. For a single-entity channel: <code>/data/{StandardObjectName}ChangeEvent</code>.</p></li></ul></div><div><p>For more information, refer to the Salesforce documentation.</p></div></div></td><td></td><td><p>x</p></td></tr><tr><td><p>Events</p></td><td><div><div><p>Array of Object</p></div></div></td><td><p>List of events to publish that match the schema of the current topic.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</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><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Object</p></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#PubsubConfig)

#### Throws

- MULE:ANY

- SALESFORCE-PUB-SUB:CONNECTIVITY

- SALESFORCE-PUB-SUB:INVALID\_INPUT

- SALESFORCE-PUB-SUB:RETRY\_EXHAUSTED

- SALESFORCE-PUB-SUB:SECURITY

- SALESFORCE-PUB-SUB:SERVER\_ERROR

### Unauthorize

`<salesforce-pub-sub:unauthorize>`

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

<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>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Resource Owner Id</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the resource owner for whom to invalidate access.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr></tbody></table>

#### Associated Configurations

- [Configuration](#PubsubConfig)

## Object Types

- [CRL File](#CrlFile)

- [Custom OCSP Responder](#CustomOcspResponder)

- [Custom Replay Id](#CustomReplayId)

- [Expiration Policy](#ExpirationPolicy)

- [Keystore](#KeyStore)

- [Proxy](#ProxyConfiguration)

- [Reconnect](#Reconnect)

- [Reconnect Forever](#ReconnectForever)

- [Reconnection](#Reconnection)

- [Redelivery Policy](#RedeliveryPolicy)

- [Redelivery Policy Message Identifier](#RedeliveryPolicyMessageIdentifier)

- [Repeatable File Store Stream](#RepeatableFileStoreStream)

- [Repeatable In Memory Stream](#RepeatableInMemoryStream)

- [Replay Id From Object Store](#ReplayIdFromObjectStore)

- [Standard Revocation Check](#StandardRevocationCheck)

- [TLS](#Tls)

- [Truststore](#TrustStore)

### CRL File

Specifies the location of the certification revocation list (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>

### Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

<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. If specified, the alias must be in the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Custom Replay Id

Configures a custom replay ID.

<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>Replay Id</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Subscriber receives all events after the event specified by its <strong>Replay Id</strong> value. The value is ignored if the replay option is set on <code>Earliest</code>, <code>Latest</code>, or <code>Replay id from object store</code>.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Expiration Policy

Configures an expiration policy strategy.

<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>Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it 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>Time unit for the <strong>Max Idle Time</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Keystore

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a
public certificate.

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

### Proxy

Configures a proxy for outbound connections.

<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><p>Host in which the proxy requests are sent.</p></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><p>Port in which the proxy requests are sent.</p></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><p>Username to authenticate against the proxy.</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 to authenticate against the proxy.</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>

### 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>Configures a reconnection strategy to use when a connector operation fails to connect to an external server.</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>

### Redelivery Policy

Configures the redelivery policy for executing requests that generate errors. You can add a
redelivery policy to any source in a flow.

<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 Redelivery Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum number of times that a redelivered request can be processed unsuccessfully before returning a <code>REDELIVERY_EXHAUSTED</code> error.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message Digest Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Secure hashing algorithm to use if the <strong>Use Secure Hash</strong> field is <code>true</code>. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s <code>hashCode()</code> returned.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message Identifier</strong></p></td><td><div><div><p><a href="#RedeliveryPolicyMessageIdentifier">Redelivery Policy Message Identifier</a></p></div></div></td><td><div><div><p>One or more expressions that determine if a message was redelivered. This property can be set only if the <strong>Use Secure Hash</strong> field is <code>false</code>.</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>ObjectStore</p></div></div></td><td><div><div><p>Configures the object store that stores the redelivery counter for each message.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Redelivery Policy Message Identifier

Configures how to identify a redelivered message and how to find out when the message was
redelivered.

<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>Use Secure Hash</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>true</code>, Mule uses a secure hash algorithm to identify a redelivered message.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Id Expression</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>One or more expressions that determine when a message was redelivered. You can set this property only if the <strong>Use Secure Hash</strong> field is <code>false</code>.</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>

### 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 In Memory Size value</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 <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> 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>Buffer Unit</strong> fields.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Replay Id From Object Store

Configures a replay ID from object 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>Os Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the object store from where to get the latest replay ID. The value is ignored if the replay option is set on <code>Earliest</code>, <code>Latest</code>, or <code>Custom replay id</code>.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Os Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the key that contains the latest replay ID. The value is ignored if the replay option is set on <code>Earliest</code>, <code>Latest</code>, or <code>Custom replay id</code>.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></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>

### TLS

Configures TLS to provide secure communications for the Mule app.

<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">Truststore</a></p></div></div></td><td><div><div><p>Configures the TLS truststore.</p></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">Keystore</a></p></div></div></td><td><div><div><p>Configures the TLS keystore.</p></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><p>Configures a revocation checking mechanism.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Truststore

Configures the truststore for 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>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the truststore. Mule resolves the path relative to the current classpath and file system.</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 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>

## See Also

- [Pub/Sub API Endpoints](https://developer.salesforce.com/docs/platform/pub-sub-api/guide/pub-sub-endpoints.html)

- [Use Pub/Sub API](https://developer.salesforce.com/docs/platform/pub-sub-api/guide/use-pub-sub-api.html)

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

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