# mulesoft Salesforce Pub/Sub Connector - Full Documentation

<!-- document id=4d44be9e22be9d59788288295fc2b531e288cfa638d23ed7b86e629e81ac4b6b url=/mulesoft/current/en-us/salesforce-pubsub-connector/1.0/index.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.0
---

# Salesforce Pub/Sub Connector

> 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. This connector
complements Anypoint Connector for Salesforce (Salesforce Connector) and provides additional ways to
interface with Salesforce’s ecosystem. The Salesforce Pub/Sub API enables you to publish and
subscribe to events and request schemas and topic information with one API.

For information about compatibility and fixed issues, refer to the Salesforce Pub/Sub Connector
Release Notes.

## Before You Begin

To use this connector, you must be familiar with:

- The Salesforce Pub/Sub Connector’s API

- Anypoint Connectors

- Mule runtime engine (Mule)

- Elements and global elements in a Mule flow

- How to create a Mule app using Anypoint Studio

Before creating an app, you must have:

- Credentials to access the Salesforce Pub/Sub target resource

- Anypoint Platform

- Anypoint Studio or Anypoint Code Builder

## Common Use Cases For the Connector

These are some common use cases for Salesforce Pub/Sub Connector:

- Subscribe to event monitoring real-time events

- Subscribe to a standard or high volume platform event, such as `AppointmentSchedulingEvent`

- Publish a platform event (high volume only) back into Salesforce to restrict a user’s profile when
  they log in to Salesforce after working hours

- Subscribe to change data capture events and syn order data in an external inventory system

For examples of these use cases, refer to
[Salesforce Pub/Sub Connector Examples](https://docs.mulesoft.com/salesforce-pubsub-connector/1.0/salesforce-pubsub-connector-examples).

## Connection Types

Salesforce Pub/Sub connections use the following authentication types:

- Basic Authentication  
  Uses a username and a password for authentication

- OAuth v2.0  
  Delegates user authentication to the service hosting the user account

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

- OAuth Username Password  
  Uses OAuth 2.0 with a username and a password for authentication

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

For information about configuring authentication types, refer to
[Configure a Global Element for the Connector](https://docs.mulesoft.com/salesforce-pubsub-connector/1.0/salesforce-pubsub-connector-studio#configure-global-element).

## 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/salesforce-pubsub-connector/1.0/salesforce-pubsub-connector-studio).

## See Also

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

- [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange)

- [Salesforce Pub/Sub Connector Reference](https://docs.mulesoft.com/salesforce-pubsub-connector/1.0/salesforce-pubsub-connector-reference)

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

<!-- document id=fa2a3080a0fbbb89d67ecd4d7bc4a6674fef0d889f910e309fc4e93056168738 url=/mulesoft/current/en-us/salesforce-pubsub-connector/1.0/salesforce-pubsub-connector-message-tracking-example.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.0
---

# Salesforce Pub/Sub Connector 1.0 - Tracking Salesforce Platform Events Example

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

One way to use Salesforce Pub/Sub Connector is to track whether a Salesforce platform event is
received from MuleSoft and processed. You can keep track of processed messages using a combination
of Salesforce and Mule runtime engine (Mule).

For a detailed example of one approach to message tracking, see
[Keeping Track of the Processed and Received Messages](/mulesoft/current/en-us/salesforce-pubsub-connector/1.0/_attachments/salesforce-pubsub-whitepaper.pdf).

## Replay ID and MuleSoft Object Store

To implement message tracking, it’s important to understand the core concepts of the Salesforce
Streaming API, the Replay ID attribute, and MuleSoft object store.

### Replay ID

On the Salesforce Event Bus, each published event message is assigned an opaque ID, which is
contained in the Replay (`replay_id`) attribute. The system populates the Replay ID field value when
the event message is delivered to subscribers and refers to the position of the event message within
the event stream.

The event stream has a message durability of 72 hours for high-volume platform events so, using the
Replay ID, it’s possible to receive event messages from the event stream that fall within that
period. The MuleSoft subscriber must carefully track the processed Replay IDs to ensure it doesn’t
miss or duplicate process events in case of downtime or restart (either intentional or
unintentional).

To enable advanced Replay ID tracking to ensure that the event message is received and processed
correctly, you are given control over the replay behavior with the Salesforce Pub/Sub Connector in
the connector configuration UI.

This example configuration uses the **Replay id from object store** option for the **Replay option**
property and specifies a dedicated object store in the **Object Store Name** field:

![Subscribe channel listener General properties configuration panel](/mulesoft/current/en-us/salesforce-pubsub-connector/1.0/_images/pubsub-channel-listener-config.png)

The following table shows the Replay ID options:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Replay Option</th><th>Description</th><th>Usage</th></tr></thead><tbody><tr><td><p><code>Custom replay id</code></p></td><td><p>The Subscriber receives all stored events after the event specified by its replay ID value, and new events.</p></td><td><p>Catch up on missed events after a certain event message, for example, after a connection failure. To subscribe with a specific replay ID, save the replay ID of the event message to retrieve stored events after, and then use it when you resubscribe.</p></td></tr><tr><td><p><code>Latest</code></p></td><td><p>If no replay option is specified, this is the default. The Subscriber receives new events that are broadcast after the client subscribes.</p></td><td><p>It is best to subscribe with the <code>Latest</code> option to receive new event messages. To get earlier event messages, don’t use this option.</p></td></tr><tr><td><p><code>Earliest</code></p></td><td><p>The Subscriber receives all events, including past events that are within the 72-hour retention window.</p></td><td><p>Catch up on missed events and retrieve all stored events, for example, after a connection failure. Using this option can slow performance if a large number of event messages are stored.</p></td></tr><tr><td><p><code>Replay id from object store</code></p></td><td><p>The 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.</p></td><td><p>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></td></tr></tbody></table>

### MuleSoft Object Store

Mule runtime engine (Mule) uses object stores to persist data for later retrieval. Mule uses object
stores in various filters, routers, and other message processors that store states between messages.

For CloudHub deployments, the free Object Store v2 limits usage to 10 transactions per second (TPS)
per application. The premium add-on for Object Store v2 increases the limit to 100 TPS per
application.

## Example of Tracking Messages

One of the challenges of the Salesforce-provided event-based integration is knowing whether a
particular message is received and processed by the subscriber. To achieve this goal, additional
logic is required.

For details about the implementation logic for one approach to message tracking, see
[Keeping Track of the Processed and Received Messages](/mulesoft/current/en-us/salesforce-pubsub-connector/1.0/_attachments/salesforce-pubsub-whitepaper.pdf).

## Batch Event Size

A key feature of Salesforce Pub/Sub Connector is that it allows you to control the number of
messages received and processed in a given period of time using the **Batch event size**
(`BatcheventSize`) attribute of the **Subscribe Channel Listener** operation to specify the total
number of events included in a server batch.

### Batch Event Size Example

In a test case, 500 records were created in Salesforce using Apex code. After all the processing
completed in Salesforce, the "delta" time between creating the log entry during record creation and
the log entry from the confirmation message was analyzed and MuleSoft worker statistics were
reviewed.

In summary:

- Using `BatcheventSize=1` vs the maximum value of 100 triples the time until Salesforce records the
  processing, which is still in the area of milliseconds.

- A CloudHub 0.1 vCore worker is sufficient to handle the load. There is no performance improvement
  when using a 0.2 core worker.

For more details about this test case, see
[BatcheventSize - How Does it Work?](/mulesoft/current/en-us/salesforce-pubsub-connector/1.0/_attachments/salesforce-pubsub-whitepaper.pdf).

## See Also

- [Have my Published Salesforce Platform Events Been Received by My Mule App?](/mulesoft/current/en-us/salesforce-pubsub-connector/1.0/_attachments/salesforce-pubsub-whitepaper.pdf)

- [Event Message Durability](https://developer.salesforce.com/docs/platform/pub-sub-api/guide/event-message-durability.html)

- [Pub/Sub API and the Expanded Event Bus](https://developer.salesforce.com/docs/platform/pub-sub-api/guide/expanded-event-bus.html)

<!-- document id=1b6c033aa41f818c7f5862826ed9898dd205e8e878eec463b14e458f3916aab2 url=/mulesoft/current/en-us/salesforce-pubsub-connector/1.0/salesforce-pubsub-connector-xml-maven.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.0
---

# Salesforce Pub/Sub 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 Studio:

- If you manually code a Mule runtime engine (Mule) app in XML (either from the Anypoint 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 Studio, Studio automatically populates the XML 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/salesforce-pub-sub
http://www.mulesoft.org/schema/mule/salesforce-pub-sub/current/mule-salesforce-pub-sub.xsd
```

This example shows how the namespace statements are placed in the XML:

```xml
<mule xmlns:$2="http://www.mulesoft.org/schema/mule/$2"
	xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns:file="http://www.mulesoft.org/schema/mule/file"
	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/file
	http://www.mulesoft.org/schema/mule/file/current/mule-file.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/ee/core
	http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
	http://www.mulesoft.org/schema/mule/$2
	http://www.mulesoft.org/schema/mule/$2/current/mule-$2.xsd">
```

## Add a POM File Dependency

The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
When 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-salesforce-pubsub-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

Replace `<version>` with the version that corresponds to the connector you are using.

To obtain 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 `Salesforce Pub/Sub`.

4.  Select the connector.

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

## Next Step

After completing your namespace and `pom.xml` file, you can try the
[Examples](https://docs.mulesoft.com/salesforce-pubsub-connector/1.0/salesforce-pubsub-connector-examples).

## See Also

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

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

<!-- document id=78f3c47b5c508591ef3186915563e9eff4e8c296f90367c37f2441aae6cb49d7 url=/mulesoft/current/en-us/salesforce-pubsub-connector/1.0/salesforce-pubsub-connector-examples.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.0
---

# Salesforce Pub/Sub Connector 1.0 Examples

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

The following examples show several Mule flows for Salesforce Pub/Sub Connector:

- [Publish an Event](#publish-an-event)

- [Subscribe to a Channel](#subscribe-to-a-channel)

## Configure a Connection

To secure connections, you must specify the connection field values. To do this:

- [Create a configuration file for a connection.](#create-config-file)

- [Configure the connection global elements.](#configure-conn)

- [Configure a global element for the properties file.](#configure-global)

### Create a Configuration File for a Connection

Create a configuration file that includes properties for a connection:

1.  Create a file named `mule-app.properties` in the `/src/main/resources/` folder.

2.  In the `mule-app.properties` file, create a set of properties for the connection, similar to the
    ones that follow, replacing the bracketed text (including the brackets) with the correct values
    for your configuration:

    m4-config.username=<username within Salesforce Pub/Sub system> m4-config.password=<password for
    the username within Salesforce Pub/Sub system> m4-config.securityToken=<security token within
    Salesforce Pub/Sub system> m4-config.url=<endpoint representing your development environment>

    The properties used vary depending on the selected connection configuration.

For more information about creating a properties file, refer to
[Configuring Property Placeholders](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-to-configure).

### Configure the Connection Global Elements

Configure global elements for connection:

1.  Create a new Mule project.

2.  In the **Mule Palette** view, click **Search in Exchange** and enter `Salesforce Pub/Sub`.

3.  Add **Salesforce Pub/Sub Connector** to the **Selected modules** section and click **Finish**.

4.  Click the **Global Elements** tab and click **Create**.

5.  Select **Connector Configuration > Salesforce Pub/Sub Config** and click **OK**.

6.  Enter the values to configure either Basic Authentication, OAuth v2.0, OAuth JWT, OAuth Username
    Password, or OAuth SAML.

7.  Click the **Test Connection** button to ensure there is connectivity with the Salesforce Pub/Sub
    API. A successful message should pop up.

8.  Click **OK**.

9.  Open the HTTPS Listener config in **Global Element Configuration**.

10. Click the **TLS** tab and select **TLS Configuration > Edit inline**.

11. Specify the **Key Store Configuration** with the generated keystore details to enable HTTPS on
    this configuration.

12. Click **OK**.

### Configure a Global Element for the Properties File

Configure a global element for the `mule-app.properties` file so that Mule knows where to find it:

1.  Click the **Global Elements** tab and click **Create**.

2.  In the **Choose Global Type** dialog, select **Configuration properties** and click **OK**.

3.  In the **File** field, enter `mule.app.properties`.

4.  Click **OK**.

## Publish an Event

This example Mule flow publishes an event and uses the following operations:

- **HTTP Listener**  
  Accepts data from HTTP requests.

- **Transform Message**  
  Outputs the data in Java.

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

  Enter the following values:

  <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Topic</strong></p></td><td><div><div><p>Name of the topic used for message publishing, for example, <code>/event/gRPCMunitTestDoNotDelete__e</code></p></div></div></td></tr><tr><td><p><strong>Job Id</strong></p></td><td><div><div><p><code>payload</code></p></div></div></td></tr></tbody></table>

![Studio flow for the Publish event operation](/mulesoft/current/en-us/salesforce-pubsub-connector/1.0/_images/publish-an-event.png)

### XML for This Example

Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	  xmlns:http="http://www.mulesoft.org/schema/mule/http" xmlns:salesforce-pub-sub="http://www.mulesoft.org/schema/mule/salesforce-pub-sub" 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/salesforce-pub-sub http://www.mulesoft.org/schema/mule/salesforce-pub-sub/current/mule-salesforce-pub-sub.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/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">

	<configuration-properties file="mule-app.properties"/>

	<salesforce-pub-sub:pubsub-config name="Salesforce_PubSub_Config" >
		<salesforce-pub-sub:basic-connection username="${m4-config.username}" password="${m4-config.password}" securityToken="${m4-config.securityToken}" url="${m4-config.url}"/>
	</salesforce-pub-sub:pubsub-config>

	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="3805c5f1-0f01-476a-a619-a03f34dadfdd" >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
<flow name="mule-salesforce-pubsub-connector-publish-event-demo" doc:id="9e2df8f5-1b47-4a76-ac62-941c989cd93b" >
  <http:listener doc:name="Listener" doc:id="6e06a214-3112-40ef-8720-f730121aa5e0" config-ref="HTTP_Listener_config" path="/publish-event"/>
  <ee:transform>
    <ee:message>
      <ee:set-payload><![CDATA[%dw 2.0
        output application/java
        ---
        [{
          CreatedDate: 12334455,
          CreatedById: "123",
          Desc__c: "Something"
        },{
          CreatedDate: 12334456,
          CreatedById: "1234",
          Desc__c: "Something2"
        }
        ]]]>
      </ee:set-payload>
    </ee:message>
  </ee:transform>

  <salesforce-pub-sub:publish-event config-ref="Salesforce_PubSub_Config" topic="/event/gRPCMunitTestDoNotDelete__e"/>
</flow>
</mule>
```

## Subscribe to a Channel

This example Mule flow subscribes to a channel and uses the following operations:

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

  Enter the following values:

  <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Channel name</strong></p></td><td><div><div><p>Name of the streaming channel to subscribe to, for example, <code>/event/gRPCMunitTestDoNotDelete__e</code></p></div></div></td></tr><tr><td><p><strong>Replay option</strong></p></td><td><div><div><p>One of the given implementations, for example, <code>Earliest</code>. For more information on how to use <code>Replay id from object store</code> in <strong>Replay option</strong>, 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></div></td></tr><tr><td><p><strong>Batch events size</strong></p></td><td><div><div><p>Total number of events included in a server batch. Lower values indicate small memory footprint with more server calls, while bigger values indicate bigger memory footprint with fewer API calls. A new batch of events is requested by the connector after the flow consumes the existing events, for example, <code>1000</code></p></div></div></td></tr></tbody></table>

- **Logger**  
  Shows the HTTP response from the **Subscribe channel listener** source

![Studio flow for the Subscribe channel listener source](/mulesoft/current/en-us/salesforce-pubsub-connector/1.0/_images/subscribe-to-a-channel.png)

### XML for This Example

Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	  xmlns:http="http://www.mulesoft.org/schema/mule/http" xmlns:salesforce-pub-sub="http://www.mulesoft.org/schema/mule/salesforce-pub-sub" 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/salesforce-pub-sub http://www.mulesoft.org/schema/mule/salesforce-pub-sub/current/mule-salesforce-pub-sub.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/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">

	<configuration-properties file="mule-app.properties"/>

	<salesforce-pub-sub:pubsub-config name="Salesforce_PubSub_Config" >
		<salesforce-pub-sub:basic-connection username="${m4-config.username}" password="${m4-config.password}" securityToken="${m4-config.securityToken}" url="${m4-config.url}"/>
	</salesforce-pub-sub:pubsub-config>

	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="3805c5f1-0f01-476a-a619-a03f34dadfdd" >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>

	<flow name="mule-salesforce-pubsub-connector-subscribe-channel-demo" doc:id="4faf2bf8-e2af-43bc-bba8-d336761800dd" >
		<salesforce-pub-sub:subscribe-channel-listener channelName="/event/gRPCMunitTestDoNotDelete__e" config-ref="Salesforce_PubSub_Config" eventBatchSize="1000">
			<salesforce-pub-sub:replay-option >
				<salesforce-pub-sub:earliest />
			</salesforce-pub-sub:replay-option>
		</salesforce-pub-sub:subscribe-channel-listener>
		<logger level="INFO" doc:name="Logger" doc:id="21652e14-de84-4752-a9b9-871dc346befb" message="#[payload]"/>
	</flow>
</mule>
```

## See Also

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

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

<!-- document id=437d9e3cca37b0a6c109352b39bbdff56a1abf77262ebe07f4d2d787cf3d4baf url=/mulesoft/current/en-us/salesforce-pubsub-connector/1.0/salesforce-pubsub-connector-reference.md -->

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

<!-- document id=a5b614fd446fb56181ef670fe439c2c15a1f3add8918c5e694bcf1f277e3cb1b url=/mulesoft/current/en-us/salesforce-pubsub-connector/1.1/index.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.1
---

# Salesforce Pub/Sub Connector 1.1

> 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. This connector
complements Anypoint Connector for Salesforce (Salesforce Connector) and provides additional ways to
interface with Salesforce’s ecosystem. The Salesforce Pub/Sub API enables you to publish and
subscribe to events and request schemas and topic information with one API.

For information about compatibility and fixed issues, refer to the Salesforce Pub/Sub Connector
Release Notes.

## Before You Begin

To use this connector, you must be familiar with:

- The Salesforce Pub/Sub Connector’s API

- Anypoint Connectors

- Mule runtime engine (Mule)

- Elements and global elements in a Mule flow

- How to create a Mule app using Anypoint Studio

Before creating an app, you must have:

- Credentials to access the Salesforce Pub/Sub target resource

- Anypoint Platform

- Anypoint Studio or Anypoint Code Builder

## Common Use Cases For the Connector

These are some common use cases for Salesforce Pub/Sub Connector:

- Subscribe to event monitoring real-time events

- Subscribe to a standard or high volume platform event, such as `AppointmentSchedulingEvent`

- Publish a platform event (high volume only) back into Salesforce to restrict a user’s profile when
  they log in to Salesforce after working hours

- Subscribe to change data capture events and syn order data in an external inventory system

For examples of these use cases, refer to
[Salesforce Pub/Sub Connector Examples](https://docs.mulesoft.com/salesforce-pubsub-connector/1.1/salesforce-pubsub-connector-examples).

## Connection Types

Salesforce Pub/Sub connections use the following authentication types:

- Basic Authentication  
  Uses a username and a password for authentication

- OAuth v2.0  
  Delegates user authentication to the service hosting the user account

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

- OAuth Username Password  
  Uses OAuth 2.0 with a username and a password for authentication

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

For information about configuring authentication types, refer to
[Configure a Global Element for the Connector](https://docs.mulesoft.com/salesforce-pubsub-connector/1.1/salesforce-pubsub-connector-studio#configure-global-element).

## 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/salesforce-pubsub-connector/1.1/salesforce-pubsub-connector-studio).

## See Also

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

- [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange)

- [Salesforce Pub/Sub Connector Reference](https://docs.mulesoft.com/salesforce-pubsub-connector/1.1/salesforce-pubsub-connector-reference)

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

<!-- document id=2946b58398db9ce892fcecc82332926772f55ad1e87bdcbf1a2dd3492b1e2468 url=/mulesoft/current/en-us/salesforce-pubsub-connector/1.1/salesforce-pubsub-connector-message-tracking-example.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.1
---

# Salesforce Pub/Sub Connector 1.1 - Tracking Salesforce Platform Events Example

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

One way to use Salesforce Pub/Sub Connector is to track whether a Salesforce platform event is
received from MuleSoft and processed. You can keep track of processed messages using a combination
of Salesforce and Mule runtime engine (Mule).

For a detailed example of one approach to message tracking, see
[Keeping Track of the Processed and Received Messages](/mulesoft/current/en-us/salesforce-pubsub-connector/1.1/_attachments/salesforce-pubsub-whitepaper.pdf).

## Replay ID and MuleSoft Object Store

To implement message tracking, it’s important to understand the core concepts of the Salesforce
Streaming API, the Replay ID attribute, and MuleSoft object store.

### Replay ID

On the Salesforce Event Bus, each published event message is assigned an opaque ID, which is
contained in the Replay (`replay_id`) attribute. The system populates the Replay ID field value when
the event message is delivered to subscribers and refers to the position of the event message within
the event stream.

The event stream has a message durability of 72 hours for high-volume platform events so, using the
Replay ID, it’s possible to receive event messages from the event stream that fall within that
period. The MuleSoft subscriber must carefully track the processed Replay IDs to ensure it doesn’t
miss or duplicate process events in case of downtime or restart (either intentional or
unintentional).

To enable advanced Replay ID tracking to ensure that the event message is received and processed
correctly, you are given control over the replay behavior with the Salesforce Pub/Sub Connector in
the connector configuration UI.

This example configuration uses the **Replay id from object store** option for the **Replay option**
property and specifies a dedicated object store in the **Object Store Name** field:

![Subscribe channel listener General properties configuration panel](/mulesoft/current/en-us/salesforce-pubsub-connector/1.1/_images/pubsub-channel-listener-config.png)

The following table shows the Replay ID options:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Replay Option</th><th>Description</th><th>Usage</th></tr></thead><tbody><tr><td><p><code>Custom replay id</code></p></td><td><p>The Subscriber receives all stored events after the event specified by its replay ID value, and new events.</p></td><td><p>Catch up on missed events after a certain event message, for example, after a connection failure. To subscribe with a specific replay ID, save the replay ID of the event message to retrieve stored events after, and then use it when you resubscribe.</p></td></tr><tr><td><p><code>Latest</code></p></td><td><p>If no replay option is specified, this is the default. The Subscriber receives new events that are broadcast after the client subscribes.</p></td><td><p>It is best to subscribe with the <code>Latest</code> option to receive new event messages. To get earlier event messages, don’t use this option.</p></td></tr><tr><td><p><code>Earliest</code></p></td><td><p>The Subscriber receives all events, including past events that are within the 72-hour retention window.</p></td><td><p>Catch up on missed events and retrieve all stored events, for example, after a connection failure. Using this option can slow performance if a large number of event messages are stored.</p></td></tr><tr><td><p><code>Replay id from object store</code></p></td><td><p>The 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.</p></td><td><p>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.1/salesforce-pubsub-connector-studio#store-objectstore">Store the Replay ID in the Object Store</a>.</p></td></tr></tbody></table>

### MuleSoft Object Store

Mule runtime engine (Mule) uses object stores to persist data for later retrieval. Mule uses object
stores in various filters, routers, and other message processors that store states between messages.

For CloudHub deployments, the free Object Store v2 limits usage to 10 transactions per second (TPS)
per application. The premium add-on for Object Store v2 increases the limit to 100 TPS per
application.

## Example of Tracking Messages

One of the challenges of the Salesforce-provided event-based integration is knowing whether a
particular message is received and processed by the subscriber. To achieve this goal, additional
logic is required.

For details about the implementation logic for one approach to message tracking, see
[Keeping Track of the Processed and Received Messages](/mulesoft/current/en-us/salesforce-pubsub-connector/1.1/_attachments/salesforce-pubsub-whitepaper.pdf).

## Batch Event Size

A key feature of Salesforce Pub/Sub Connector is that it allows you to control the number of
messages received and processed in a given period of time using the **Batch event size**
(`BatcheventSize`) attribute of the **Subscribe Channel Listener** operation to specify the total
number of events included in a server batch.

### Batch Event Size Example

In a test case, 500 records were created in Salesforce using Apex code. After all the processing
completed in Salesforce, the "delta" time between creating the log entry during record creation and
the log entry from the confirmation message was analyzed and MuleSoft worker statistics were
reviewed.

In summary:

- Using `BatcheventSize=1` vs the maximum value of 100 triples the time until Salesforce records the
  processing, which is still in the area of milliseconds.

- A CloudHub 0.1 vCore worker is sufficient to handle the load. There is no performance improvement
  when using a 0.2 core worker.

For more details about this test case, see
[BatcheventSize - How Does it Work?](/mulesoft/current/en-us/salesforce-pubsub-connector/1.1/_attachments/salesforce-pubsub-whitepaper.pdf).

## See Also

- [Have my Published Salesforce Platform Events Been Received by My Mule App?](/mulesoft/current/en-us/salesforce-pubsub-connector/1.1/_attachments/salesforce-pubsub-whitepaper.pdf)

- [Event Message Durability](https://developer.salesforce.com/docs/platform/pub-sub-api/guide/event-message-durability.html)

- [Pub/Sub API and the Expanded Event Bus](https://developer.salesforce.com/docs/platform/pub-sub-api/guide/expanded-event-bus.html)

<!-- document id=1820330447c21ada8ec295831cdc9a7be4f44a093c3be352db3b1c9dbb410561 url=/mulesoft/current/en-us/salesforce-pubsub-connector/1.1/salesforce-pubsub-connector-xml-maven.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.1
---

# Salesforce Pub/Sub 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 Studio:

- If you manually code a Mule runtime engine (Mule) app in XML (either from the Anypoint 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 Studio, Studio automatically populates the XML 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/salesforce-pub-sub
http://www.mulesoft.org/schema/mule/salesforce-pub-sub/current/mule-salesforce-pub-sub.xsd
```

This example shows how the namespace statements are placed in the XML:

```xml
<mule xmlns:$2="http://www.mulesoft.org/schema/mule/$2"
	xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns:file="http://www.mulesoft.org/schema/mule/file"
	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/file
	http://www.mulesoft.org/schema/mule/file/current/mule-file.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/ee/core
	http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
	http://www.mulesoft.org/schema/mule/$2
	http://www.mulesoft.org/schema/mule/$2/current/mule-$2.xsd">
```

## Add a POM File Dependency

The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
When 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-salesforce-pubsub-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

Replace `<version>` with the version that corresponds to the connector you are using.

To obtain 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 `Salesforce Pub/Sub`.

4.  Select the connector.

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

## Next Step

After completing your namespace and `pom.xml` file, you can try the
[Examples](https://docs.mulesoft.com/salesforce-pubsub-connector/1.1/salesforce-pubsub-connector-examples).

## See Also

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

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

<!-- document id=09fa379c8f9ff9c43e42b7a59e05b0f876ce69fdbe133623400cb32ac47812ba url=/mulesoft/current/en-us/salesforce-pubsub-connector/1.1/salesforce-pubsub-connector-examples.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.1
---

# Salesforce Pub/Sub Connector 1.1 Examples

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

The following examples show several Mule flows for Salesforce Pub/Sub Connector:

- [Publish an Event](#publish-an-event)

- [Configure Publish Request Timeout](#publish-request)

- [Subscribe to a Channel](#subscribe-to-a-channel)

## Configure a Connection

To secure connections, you must specify the connection field values. To do this:

- [Create a configuration file for a connection.](#create-config-file)

- [Configure the connection global elements.](#configure-conn)

- [Configure a global element for the properties file.](#configure-global)

### Create a Configuration File for a Connection

Create a configuration file that includes properties for a connection:

1.  Create a file named `mule-app.properties` in the `/src/main/resources/` folder.

2.  In the `mule-app.properties` file, create a set of properties for the connection, similar to the
    ones that follow, replacing the bracketed text (including the brackets) with the correct values
    for your configuration:

    m4-config.username=<username within Salesforce Pub/Sub system> m4-config.password=<password for
    the username within Salesforce Pub/Sub system> m4-config.securityToken=<security token within
    Salesforce Pub/Sub system> m4-config.url=<endpoint representing your development environment>

    The properties used vary depending on the selected connection configuration.

For more information about creating a properties file, refer to
[Configuring Property Placeholders](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-to-configure).

### Configure the Connection Global Elements

Configure global elements for connection:

1.  Create a new Mule project.

2.  In the **Mule Palette** view, click **Search in Exchange** and enter `Salesforce Pub/Sub`.

3.  Add **Salesforce Pub/Sub Connector** to the **Selected modules** section and click **Finish**.

4.  Click the **Global Elements** tab and click **Create**.

5.  Select **Connector Configuration > Salesforce Pub/Sub Config** and click **OK**.

6.  Enter the values to configure either Basic Authentication, OAuth v2.0, OAuth JWT, OAuth Username
    Password, or OAuth SAML.

7.  Click the **Test Connection** button to ensure there is connectivity with the Salesforce Pub/Sub
    API. A successful message should pop up.

8.  Click **OK**.

9.  Open the HTTPS Listener config in **Global Element Configuration**.

10. Click the **TLS** tab and select **TLS Configuration > Edit inline**.

11. Specify the **Key Store Configuration** with the generated keystore details to enable HTTPS on
    this configuration.

12. Click **OK**.

### Configure a Global Element for the Properties File

Configure a global element for the `mule-app.properties` file so that Mule knows where to find it:

1.  Click the **Global Elements** tab and click **Create**.

2.  In the **Choose Global Type** dialog, select **Configuration properties** and click **OK**.

3.  In the **File** field, enter `mule.app.properties`.

4.  Click **OK**.

## Publish an Event

This example Mule flow publishes an event and uses the following operations:

- **HTTP Listener**  
  Accepts data from HTTP requests.

- **Transform Message**  
  Outputs the data in Java.

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

  Enter the following values:

  <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Topic</strong></p></td><td><div><div><p>Name of the topic used for message publishing, for example, <code>/event/gRPCMunitTestDoNotDelete__e</code></p></div></div></td></tr><tr><td><p><strong>Job Id</strong></p></td><td><div><div><p><code>payload</code></p></div></div></td></tr></tbody></table>

![Studio flow for the Publish event operation](/mulesoft/current/en-us/salesforce-pubsub-connector/1.1/_images/publish-an-event.png)

### XML for This Example

Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	  xmlns:http="http://www.mulesoft.org/schema/mule/http" xmlns:salesforce-pub-sub="http://www.mulesoft.org/schema/mule/salesforce-pub-sub" 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/salesforce-pub-sub http://www.mulesoft.org/schema/mule/salesforce-pub-sub/current/mule-salesforce-pub-sub.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/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">

	<configuration-properties file="mule-app.properties"/>

	<salesforce-pub-sub:pubsub-config name="Salesforce_PubSub_Config" >
		<salesforce-pub-sub:basic-connection username="${m4-config.username}" password="${m4-config.password}" securityToken="${m4-config.securityToken}" url="${m4-config.url}"/>
	</salesforce-pub-sub:pubsub-config>

	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="3805c5f1-0f01-476a-a619-a03f34dadfdd" >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
<flow name="mule-salesforce-pubsub-connector-publish-event-demo" doc:id="9e2df8f5-1b47-4a76-ac62-941c989cd93b" >
  <http:listener doc:name="Listener" doc:id="6e06a214-3112-40ef-8720-f730121aa5e0" config-ref="HTTP_Listener_config" path="/publish-event"/>
  <ee:transform>
    <ee:message>
      <ee:set-payload><![CDATA[%dw 2.0
        output application/java
        ---
        [{
          CreatedDate: 12334455,
          CreatedById: "123",
          Desc__c: "Something"
        },{
          CreatedDate: 12334456,
          CreatedById: "1234",
          Desc__c: "Something2"
        }
        ]]]>
      </ee:set-payload>
    </ee:message>
  </ee:transform>

  <salesforce-pub-sub:publish-event config-ref="Salesforce_PubSub_Config" topic="/event/gRPCMunitTestDoNotDelete__e"/>
</flow>
</mule>
```

## Configure Publish Request Timeout

This example shows how to configure the **Publish Request Timeout** and **Publish Request Time
Unit** parameters to control the timeout behavior for publish operations. This is useful when you
want to ensure that publish requests don’t wait indefinitely and have specific timeout requirements.
This example Mule flow configures timeout settings.

The key timeout configuration parameters are:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Publish Request Timeout</strong></p></td><td><div><div><p><code>60</code> (60 units of time before timeout)</p></div></div></td></tr><tr><td><p><strong>Publish Request Time Unit</strong></p></td><td><div><div><p><code>SECONDS</code> (timeout unit specification)</p></div></div></td></tr></tbody></table>

![Global element properties window for the Publish event operation with timeout configuration](/mulesoft/current/en-us/salesforce-pubsub-connector/1.1/_images/salesforce-pub-publish-timeout.png)

### XML for This Example

Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:scripting="http://www.mulesoft.org/schema/mule/scripting"
	xmlns:tls="http://www.mulesoft.org/schema/mule/tls" xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns:os="http://www.mulesoft.org/schema/mule/os"
	xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core" xmlns:salesforce-pub-sub="http://www.mulesoft.org/schema/mule/salesforce-pub-sub" 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/scripting http://www.mulesoft.org/schema/mule/scripting/current/mule-scripting.xsd http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/salesforce-pub-sub http://www.mulesoft.org/schema/mule/salesforce-pub-sub/current/mule-salesforce-pub-sub.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/os http://www.mulesoft.org/schema/mule/os/current/mule-os.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/tls http://www.mulesoft.org/schema/mule/tls/current/mule-tls.xsd">
	<salesforce-pub-sub:pubsub-config name="insecureSalesforce_PubSub_Config" doc:name="Salesforce PubSub Config"  >
		<salesforce-pub-sub:oauth-user-pass-connection consumerKey="&lt;CONSUMER_KEY&gt;" consumerSecret="&lt;CONSUMER_SECRET&gt;" username="&lt;USERNAME&gt;" password="&lt;USERNAME&gt;" securityToken="&lt;SECURITY_TOKEN&gt;" tokenEndpoint="&lt;TOKEN_ENDPOINT&gt;" host="&lt;GRPC_HOST&gt;" port="0000" publishRequestTimeout="60" >
		</salesforce-pub-sub:oauth-user-pass-connection>
	</salesforce-pub-sub:pubsub-config>

	<os:object-store name="replayObjectStore" doc:name="Object store"  entryTtlUnit="DAYS" expirationIntervalUnit="DAYS" entryTtl="1"/>


	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config"  >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
	<flow name="ytaoka-salesforce-pubsublistenerFlow1"  initialState="started">
		<http:listener doc:name="Listener"  config-ref="HTTP_Listener_config" path="/publish"/>

	 <logger level="INFO" doc:name="Logger"  message="Before Publish" />
		<salesforce-pub-sub:publish-event config-ref="insecureSalesforce_PubSub_Config" topic="/event/gRPCMunitTestDoNotDelete__e">
        </salesforce-pub-sub:publish-event>
		<logger level="INFO" doc:name="Logger"  message="After Publish"/>
	</flow>
</mule>
```

## Subscribe to a Channel

This example Mule flow subscribes to a channel and uses the following operations:

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

  Enter the following values:

  <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Channel name</strong></p></td><td><div><div><p>Name of the streaming channel to subscribe to, for example, <code>/event/gRPCMunitTestDoNotDelete__e</code></p></div></div></td></tr><tr><td><p><strong>Replay option</strong></p></td><td><div><div><p>One of the given implementations, for example, <code>Earliest</code>. For more information on how to use <code>Replay id from object store</code> in <strong>Replay option</strong>, refer to <a href="https://docs.mulesoft.com/salesforce-pubsub-connector/1.1/salesforce-pubsub-connector-studio#store-objectstore">Store the Replay ID in the Object Store</a>.</p></div></div></td></tr><tr><td><p><strong>Batch events size</strong></p></td><td><div><div><p>Total number of events included in a server batch. Lower values indicate small memory footprint with more server calls, while bigger values indicate bigger memory footprint with fewer API calls. A new batch of events is requested by the connector after the flow consumes the existing events, for example, <code>1000</code></p></div></div></td></tr></tbody></table>

- **Logger**  
  Shows the HTTP response from the **Subscribe channel listener** source

![Studio flow for the Subscribe channel listener source](/mulesoft/current/en-us/salesforce-pubsub-connector/1.1/_images/subscribe-to-a-channel.png)

### XML for This Example

Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	  xmlns:http="http://www.mulesoft.org/schema/mule/http" xmlns:salesforce-pub-sub="http://www.mulesoft.org/schema/mule/salesforce-pub-sub" 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/salesforce-pub-sub http://www.mulesoft.org/schema/mule/salesforce-pub-sub/current/mule-salesforce-pub-sub.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/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">

	<configuration-properties file="mule-app.properties"/>

	<salesforce-pub-sub:pubsub-config name="Salesforce_PubSub_Config" >
		<salesforce-pub-sub:basic-connection username="${m4-config.username}" password="${m4-config.password}" securityToken="${m4-config.securityToken}" url="${m4-config.url}"/>
	</salesforce-pub-sub:pubsub-config>

	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="3805c5f1-0f01-476a-a619-a03f34dadfdd" >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>

	<flow name="mule-salesforce-pubsub-connector-subscribe-channel-demo" doc:id="4faf2bf8-e2af-43bc-bba8-d336761800dd" >
		<salesforce-pub-sub:subscribe-channel-listener channelName="/event/gRPCMunitTestDoNotDelete__e" config-ref="Salesforce_PubSub_Config" eventBatchSize="1000">
			<salesforce-pub-sub:replay-option >
				<salesforce-pub-sub:earliest />
			</salesforce-pub-sub:replay-option>
		</salesforce-pub-sub:subscribe-channel-listener>
		<logger level="INFO" doc:name="Logger" doc:id="21652e14-de84-4752-a9b9-871dc346befb" message="#[payload]"/>
	</flow>
</mule>
```

## See Also

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

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

<!-- document id=2074ac4c9a9577fef71500bc5ca4baaa2f48c7cba8bf69f78ee119b0ca63f17c url=/mulesoft/current/en-us/salesforce-pubsub-connector/1.1/salesforce-pubsub-connector-reference.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.1
---

# Salesforce Pub/Sub Connector 1.1 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>Publish Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time the client waits for a publish request to complete before timing out. Values less than one millisecond are converted to 0 (no deadline).</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Publish 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>Publish Request Timeout</strong> field.</p></td><td><p><code>SECONDS</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>Publish Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time the client waits for a publish request to complete before timing out. Values less than one millisecond are converted to 0 (no deadline).</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Publish 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>Publish Request Timeout</strong> field.</p></td><td><p><code>SECONDS</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>Publish Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time the client waits for a publish request to complete before timing out. Values less than one millisecond are converted to 0 (no deadline).</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Publish 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>Publish Request Timeout</strong> field.</p></td><td><p><code>SECONDS</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>Publish Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time the client waits for a publish request to complete before timing out. Values less than one millisecond are converted to 0 (no deadline).</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Publish 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>Publish Request Timeout</strong> field.</p></td><td><p><code>SECONDS</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>Publish Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time the client waits for a publish request to complete before timing out. Values less than one millisecond are converted to 0 (no deadline).</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Publish 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>Publish Request Timeout</strong> field.</p></td><td><p><code>SECONDS</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.1/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)

<!-- document id=cf75f9ed9bdb955b6d8a005e84ebd46f39d6b9fdcc835f8c1bbcfc0240c6b33a url=/mulesoft/current/en-us/salesforce-pubsub-connector/1.2/index.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.2
---

# Salesforce Pub/Sub Connector 1.2

> 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. This connector
complements Anypoint Connector for Salesforce (Salesforce Connector) and provides additional ways to
interface with Salesforce’s ecosystem. The Salesforce Pub/Sub API enables you to publish and
subscribe to events and request schemas and topic information with one API.

For information about compatibility and fixed issues, refer to the Salesforce Pub/Sub Connector
Release Notes.

## Before You Begin

To use this connector, you must be familiar with:

- The Salesforce Pub/Sub Connector’s API

- Anypoint Connectors

- Mule runtime engine (Mule)

- Elements and global elements in a Mule flow

- How to create a Mule app using Anypoint Studio

Before creating an app, you must have:

- Credentials to access the Salesforce Pub/Sub target resource

- Anypoint Platform

- Anypoint Studio or Anypoint Code Builder

## Common Use Cases For the Connector

These are some common use cases for Salesforce Pub/Sub Connector:

- Subscribe to event monitoring real-time events

- Subscribe to a standard or high volume platform event, such as `AppointmentSchedulingEvent`

- Publish a platform event (high volume only) back into Salesforce to restrict a user’s profile when
  they log in to Salesforce after working hours

- Subscribe to change data capture events and syn order data in an external inventory system

For examples of these use cases, refer to
[Salesforce Pub/Sub Connector Examples](https://docs.mulesoft.com/salesforce-pubsub-connector/1.2/salesforce-pubsub-connector-examples).

## Connection Types

Salesforce Pub/Sub connections use the following authentication types:

- Basic Authentication  
  Uses a username and a password for authentication

> [!NOTE] The `Basic Authentication` connection type is only supported for Salesforce API v64.0 and
> earlier versions.

- OAuth v2.0  
  Delegates user authentication to the service hosting the user account

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

- OAuth Username Password  
  Uses OAuth 2.0 with a username and a password for authentication

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

For information about configuring authentication types, refer to
[Configure a Global Element for the Connector](https://docs.mulesoft.com/salesforce-pubsub-connector/1.2/salesforce-pubsub-connector-studio#configure-global-element).

## 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/salesforce-pubsub-connector/1.2/salesforce-pubsub-connector-studio).

## See Also

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

- [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange)

- [Salesforce Pub/Sub Connector Reference](https://docs.mulesoft.com/salesforce-pubsub-connector/1.2/salesforce-pubsub-connector-reference)

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

<!-- document id=36752e930578c06a6275d07d1366868abf2e4129d11b0785fa1b834b1f9dccc8 url=/mulesoft/current/en-us/salesforce-pubsub-connector/1.2/salesforce-pubsub-connector-message-tracking-example.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.2
---

# Salesforce Pub/Sub Connector 1.2 - Tracking Salesforce Platform Events Example

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

One way to use Salesforce Pub/Sub Connector is to track whether a Salesforce platform event is
received from MuleSoft and processed. You can keep track of processed messages using a combination
of Salesforce and Mule runtime engine (Mule).

For a detailed example of one approach to message tracking, see
[Keeping Track of the Processed and Received Messages](/mulesoft/current/en-us/salesforce-pubsub-connector/1.2/_attachments/salesforce-pubsub-whitepaper.pdf).

## Replay ID and MuleSoft Object Store

To implement message tracking, it’s important to understand the core concepts of the Salesforce
Streaming API, the Replay ID attribute, and MuleSoft object store.

### Replay ID

On the Salesforce Event Bus, each published event message is assigned an opaque ID, which is
contained in the Replay (`replay_id`) attribute. The system populates the Replay ID field value when
the event message is delivered to subscribers and refers to the position of the event message within
the event stream.

The event stream has a message durability of 72 hours for high-volume platform events so, using the
Replay ID, it’s possible to receive event messages from the event stream that fall within that
period. The MuleSoft subscriber must carefully track the processed Replay IDs to ensure it doesn’t
miss or duplicate process events in case of downtime or restart (either intentional or
unintentional).

To enable advanced Replay ID tracking to ensure that the event message is received and processed
correctly, you are given control over the replay behavior with the Salesforce Pub/Sub Connector in
the connector configuration UI.

This example configuration uses the **Replay id from object store** option for the **Replay option**
property and specifies a dedicated object store in the **Object Store Name** field:

![Subscribe channel listener General properties configuration panel](/mulesoft/current/en-us/salesforce-pubsub-connector/1.2/_images/pubsub-channel-listener-config.png)

The following table shows the Replay ID options:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Replay Option</th><th>Description</th><th>Usage</th></tr></thead><tbody><tr><td><p><code>Custom replay id</code></p></td><td><p>The Subscriber receives all stored events after the event specified by its replay ID value, and new events.</p></td><td><p>Catch up on missed events after a certain event message, for example, after a connection failure. To subscribe with a specific replay ID, save the replay ID of the event message to retrieve stored events after, and then use it when you resubscribe.</p></td></tr><tr><td><p><code>Latest</code></p></td><td><p>If no replay option is specified, this is the default. The Subscriber receives new events that are broadcast after the client subscribes.</p></td><td><p>It is best to subscribe with the <code>Latest</code> option to receive new event messages. To get earlier event messages, don’t use this option.</p></td></tr><tr><td><p><code>Earliest</code></p></td><td><p>The Subscriber receives all events, including past events that are within the 72-hour retention window.</p></td><td><p>Catch up on missed events and retrieve all stored events, for example, after a connection failure. Using this option can slow performance if a large number of event messages are stored.</p></td></tr><tr><td><p><code>Replay id from object store</code></p></td><td><p>The 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.</p></td><td><p>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.2/salesforce-pubsub-connector-studio#store-objectstore">Store the Replay ID in the Object Store</a>.</p></td></tr></tbody></table>

### MuleSoft Object Store

Mule runtime engine (Mule) uses object stores to persist data for later retrieval. Mule uses object
stores in various filters, routers, and other message processors that store states between messages.

For CloudHub deployments, the free Object Store v2 limits usage to 10 transactions per second (TPS)
per application. The premium add-on for Object Store v2 increases the limit to 100 TPS per
application.

## Example of Tracking Messages

One of the challenges of the Salesforce-provided event-based integration is knowing whether a
particular message is received and processed by the subscriber. To achieve this goal, additional
logic is required.

For details about the implementation logic for one approach to message tracking, see
[Keeping Track of the Processed and Received Messages](/mulesoft/current/en-us/salesforce-pubsub-connector/1.2/_attachments/salesforce-pubsub-whitepaper.pdf).

## Batch Event Size

A key feature of Salesforce Pub/Sub Connector is that it allows you to control the number of
messages received and processed in a given period of time using the **Batch event size**
(`BatcheventSize`) attribute of the **Subscribe Channel Listener** operation to specify the total
number of events included in a server batch.

### Batch Event Size Example

In a test case, 500 records were created in Salesforce using Apex code. After all the processing
completed in Salesforce, the "delta" time between creating the log entry during record creation and
the log entry from the confirmation message was analyzed and MuleSoft worker statistics were
reviewed.

In summary:

- Using `BatcheventSize=1` vs the maximum value of 100 triples the time until Salesforce records the
  processing, which is still in the area of milliseconds.

- A CloudHub 0.1 vCore worker is sufficient to handle the load. There is no performance improvement
  when using a 0.2 core worker.

For more details about this test case, see
[BatcheventSize - How Does it Work?](/mulesoft/current/en-us/salesforce-pubsub-connector/1.2/_attachments/salesforce-pubsub-whitepaper.pdf).

## See Also

- [Have my Published Salesforce Platform Events Been Received by My Mule App?](/mulesoft/current/en-us/salesforce-pubsub-connector/1.2/_attachments/salesforce-pubsub-whitepaper.pdf)

- [Event Message Durability](https://developer.salesforce.com/docs/platform/pub-sub-api/guide/event-message-durability.html)

- [Pub/Sub API and the Expanded Event Bus](https://developer.salesforce.com/docs/platform/pub-sub-api/guide/expanded-event-bus.html)

<!-- document id=d48b8e6cad1dfc1eb2302a4116f8c5310b3d8a82b7f9defa87718eb8875707ea url=/mulesoft/current/en-us/salesforce-pubsub-connector/1.2/salesforce-pubsub-connector-xml-maven.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.2
---

# Salesforce Pub/Sub 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 Studio:

- If you manually code a Mule runtime engine (Mule) app in XML (either from the Anypoint 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 Studio, Studio automatically populates the XML 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/salesforce-pub-sub
http://www.mulesoft.org/schema/mule/salesforce-pub-sub/current/mule-salesforce-pub-sub.xsd
```

This example shows how the namespace statements are placed in the XML:

```xml
<mule xmlns:$2="http://www.mulesoft.org/schema/mule/$2"
	xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns:file="http://www.mulesoft.org/schema/mule/file"
	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/file
	http://www.mulesoft.org/schema/mule/file/current/mule-file.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/ee/core
	http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
	http://www.mulesoft.org/schema/mule/$2
	http://www.mulesoft.org/schema/mule/$2/current/mule-$2.xsd">
```

## Add a POM File Dependency

The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
When 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-salesforce-pubsub-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

Replace `<version>` with the version that corresponds to the connector you are using.

To obtain 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 `Salesforce Pub/Sub`.

4.  Select the connector.

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

## Next Step

After completing your namespace and `pom.xml` file, you can try the
[Examples](https://docs.mulesoft.com/salesforce-pubsub-connector/1.2/salesforce-pubsub-connector-examples).

## See Also

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

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

<!-- document id=8ca9c71175b37bfa0d5c25d1eb99c1036989df0b02ea233acd4d3bc02ff741f9 url=/mulesoft/current/en-us/salesforce-pubsub-connector/1.2/salesforce-pubsub-connector-examples.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.2
---

# Salesforce Pub/Sub Connector 1.2 Examples

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

The following examples show several Mule flows for Salesforce Pub/Sub Connector:

- [Publish an Event](#publish-an-event)

- [Configure Publish Request Timeout](#publish-request)

- [Subscribe to a Channel](#subscribe-to-a-channel)

## Configure a Connection

To secure connections, you must specify the connection field values. To do this:

- [Create a configuration file for a connection.](#create-config-file)

- [Configure the connection global elements.](#configure-conn)

- [Configure a global element for the properties file.](#configure-global)

### Create a Configuration File for a Connection

Create a configuration file that includes properties for a connection:

1.  Create a file named `mule-app.properties` in the `/src/main/resources/` folder.

2.  In the `mule-app.properties` file, create a set of properties for the connection, similar to the
    ones that follow, replacing the bracketed text (including the brackets) with the correct values
    for your configuration:

    m4-config.username=<username within Salesforce Pub/Sub system> m4-config.password=<password for
    the username within Salesforce Pub/Sub system> m4-config.securityToken=<security token within
    Salesforce Pub/Sub system> m4-config.url=<endpoint representing your development environment>

    The properties used vary depending on the selected connection configuration.

For more information about creating a properties file, refer to
[Configuring Property Placeholders](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-to-configure).

### Configure the Connection Global Elements

Configure global elements for connection:

1.  Create a new Mule project.

2.  In the **Mule Palette** view, click **Search in Exchange** and enter `Salesforce Pub/Sub`.

3.  Add **Salesforce Pub/Sub Connector** to the **Selected modules** section and click **Finish**.

4.  Click the **Global Elements** tab and click **Create**.

5.  Select **Connector Configuration > Salesforce Pub/Sub Config** and click **OK**.

6.  Enter the values to configure either Basic Authentication, OAuth v2.0, OAuth JWT, OAuth Username
    Password, or OAuth SAML. Note that the `Basic Authentication` connection type is only supported
    for Salesforce API v64.0 and earlier versions.

7.  Click the **Test Connection** button to ensure there is connectivity with the Salesforce Pub/Sub
    API. A successful message should pop up.

8.  Click **OK**.

9.  Open the HTTPS Listener config in **Global Element Configuration**.

10. Click the **TLS** tab and select **TLS Configuration > Edit inline**.

11. Specify the **Key Store Configuration** with the generated keystore details to enable HTTPS on
    this configuration.

12. Click **OK**.

### Configure a Global Element for the Properties File

Configure a global element for the `mule-app.properties` file so that Mule knows where to find it:

1.  Click the **Global Elements** tab and click **Create**.

2.  In the **Choose Global Type** dialog, select **Configuration properties** and click **OK**.

3.  In the **File** field, enter `mule.app.properties`.

4.  Click **OK**.

## Publish an Event

This example Mule flow publishes an event and uses the following operations:

- **HTTP Listener**  
  Accepts data from HTTP requests.

- **Transform Message**  
  Outputs the data in Java.

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

  Enter the following values:

  <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Topic</strong></p></td><td><div><div><p>Name of the topic used for message publishing, for example, <code>/event/gRPCMunitTestDoNotDelete__e</code></p></div></div></td></tr><tr><td><p><strong>Job Id</strong></p></td><td><div><div><p><code>payload</code></p></div></div></td></tr></tbody></table>

![Studio flow for the Publish event operation](/mulesoft/current/en-us/salesforce-pubsub-connector/1.2/_images/publish-an-event.png)

### XML for This Example

Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	  xmlns:http="http://www.mulesoft.org/schema/mule/http" xmlns:salesforce-pub-sub="http://www.mulesoft.org/schema/mule/salesforce-pub-sub" 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/salesforce-pub-sub http://www.mulesoft.org/schema/mule/salesforce-pub-sub/current/mule-salesforce-pub-sub.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/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">

	<configuration-properties file="mule-app.properties"/>

	<salesforce-pub-sub:pubsub-config name="Salesforce_PubSub_Config" >
		<salesforce-pub-sub:basic-connection username="${m4-config.username}" password="${m4-config.password}" securityToken="${m4-config.securityToken}" url="${m4-config.url}"/>
	</salesforce-pub-sub:pubsub-config>

	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="3805c5f1-0f01-476a-a619-a03f34dadfdd" >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
<flow name="mule-salesforce-pubsub-connector-publish-event-demo" doc:id="9e2df8f5-1b47-4a76-ac62-941c989cd93b" >
  <http:listener doc:name="Listener" doc:id="6e06a214-3112-40ef-8720-f730121aa5e0" config-ref="HTTP_Listener_config" path="/publish-event"/>
  <ee:transform>
    <ee:message>
      <ee:set-payload><![CDATA[%dw 2.0
        output application/java
        ---
        [{
          CreatedDate: 12334455,
          CreatedById: "123",
          Desc__c: "Something"
        },{
          CreatedDate: 12334456,
          CreatedById: "1234",
          Desc__c: "Something2"
        }
        ]]]>
      </ee:set-payload>
    </ee:message>
  </ee:transform>

  <salesforce-pub-sub:publish-event config-ref="Salesforce_PubSub_Config" topic="/event/gRPCMunitTestDoNotDelete__e"/>
</flow>
</mule>
```

## Configure Publish Request Timeout

This example shows how to configure the **Publish Request Timeout** and **Publish Request Time
Unit** parameters to control the timeout behavior for publish operations. This is useful when you
want to ensure that publish requests don’t wait indefinitely and have specific timeout requirements.
This example Mule flow configures timeout settings.

The key timeout configuration parameters are:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Publish Request Timeout</strong></p></td><td><div><div><p><code>60</code> (60 units of time before timeout)</p></div></div></td></tr><tr><td><p><strong>Publish Request Time Unit</strong></p></td><td><div><div><p><code>SECONDS</code> (timeout unit specification)</p></div></div></td></tr></tbody></table>

![Global element properties window for the Publish event operation with timeout configuration](/mulesoft/current/en-us/salesforce-pubsub-connector/1.2/_images/salesforce-pub-publish-timeout.png)

### XML for This Example

Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:scripting="http://www.mulesoft.org/schema/mule/scripting"
	xmlns:tls="http://www.mulesoft.org/schema/mule/tls" xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns:os="http://www.mulesoft.org/schema/mule/os"
	xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core" xmlns:salesforce-pub-sub="http://www.mulesoft.org/schema/mule/salesforce-pub-sub" 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/scripting http://www.mulesoft.org/schema/mule/scripting/current/mule-scripting.xsd http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/salesforce-pub-sub http://www.mulesoft.org/schema/mule/salesforce-pub-sub/current/mule-salesforce-pub-sub.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/os http://www.mulesoft.org/schema/mule/os/current/mule-os.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/tls http://www.mulesoft.org/schema/mule/tls/current/mule-tls.xsd">
	<salesforce-pub-sub:pubsub-config name="insecureSalesforce_PubSub_Config" doc:name="Salesforce PubSub Config"  >
		<salesforce-pub-sub:oauth-user-pass-connection consumerKey="&lt;CONSUMER_KEY&gt;" consumerSecret="&lt;CONSUMER_SECRET&gt;" username="&lt;USERNAME&gt;" password="&lt;USERNAME&gt;" securityToken="&lt;SECURITY_TOKEN&gt;" tokenEndpoint="&lt;TOKEN_ENDPOINT&gt;" host="&lt;GRPC_HOST&gt;" port="0000" publishRequestTimeout="60" >
		</salesforce-pub-sub:oauth-user-pass-connection>
	</salesforce-pub-sub:pubsub-config>

	<os:object-store name="replayObjectStore" doc:name="Object store"  entryTtlUnit="DAYS" expirationIntervalUnit="DAYS" entryTtl="1"/>


	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config"  >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
	<flow name="ytaoka-salesforce-pubsublistenerFlow1"  initialState="started">
		<http:listener doc:name="Listener"  config-ref="HTTP_Listener_config" path="/publish"/>

	 <logger level="INFO" doc:name="Logger"  message="Before Publish" />
		<salesforce-pub-sub:publish-event config-ref="insecureSalesforce_PubSub_Config" topic="/event/gRPCMunitTestDoNotDelete__e">
        </salesforce-pub-sub:publish-event>
		<logger level="INFO" doc:name="Logger"  message="After Publish"/>
	</flow>
</mule>
```

## Subscribe to a Channel

This example Mule flow subscribes to a channel and uses the following operations:

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

  Enter the following values:

  <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Channel name</strong></p></td><td><div><div><p>Name of the streaming channel to subscribe to, for example, <code>/event/gRPCMunitTestDoNotDelete__e</code></p></div></div></td></tr><tr><td><p><strong>Replay option</strong></p></td><td><div><div><p>One of the given implementations, for example, <code>Earliest</code>. For more information on how to use <code>Replay id from object store</code> in <strong>Replay option</strong>, refer to <a href="https://docs.mulesoft.com/salesforce-pubsub-connector/1.2/salesforce-pubsub-connector-studio#store-objectstore">Store the Replay ID in the Object Store</a>.</p></div></div></td></tr><tr><td><p><strong>Batch events size</strong></p></td><td><div><div><p>Total number of events included in a server batch. Lower values indicate small memory footprint with more server calls, while bigger values indicate bigger memory footprint with fewer API calls. A new batch of events is requested by the connector after the flow consumes the existing events, for example, <code>1000</code></p></div></div></td></tr></tbody></table>

- **Logger**  
  Shows the HTTP response from the **Subscribe channel listener** source

![Studio flow for the Subscribe channel listener source](/mulesoft/current/en-us/salesforce-pubsub-connector/1.2/_images/subscribe-to-a-channel.png)

### XML for This Example

Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	  xmlns:http="http://www.mulesoft.org/schema/mule/http" xmlns:salesforce-pub-sub="http://www.mulesoft.org/schema/mule/salesforce-pub-sub" 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/salesforce-pub-sub http://www.mulesoft.org/schema/mule/salesforce-pub-sub/current/mule-salesforce-pub-sub.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/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">

	<configuration-properties file="mule-app.properties"/>

	<salesforce-pub-sub:pubsub-config name="Salesforce_PubSub_Config" >
		<salesforce-pub-sub:basic-connection username="${m4-config.username}" password="${m4-config.password}" securityToken="${m4-config.securityToken}" url="${m4-config.url}"/>
	</salesforce-pub-sub:pubsub-config>

	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="3805c5f1-0f01-476a-a619-a03f34dadfdd" >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>

	<flow name="mule-salesforce-pubsub-connector-subscribe-channel-demo" doc:id="4faf2bf8-e2af-43bc-bba8-d336761800dd" >
		<salesforce-pub-sub:subscribe-channel-listener channelName="/event/gRPCMunitTestDoNotDelete__e" config-ref="Salesforce_PubSub_Config" eventBatchSize="1000">
			<salesforce-pub-sub:replay-option >
				<salesforce-pub-sub:earliest />
			</salesforce-pub-sub:replay-option>
		</salesforce-pub-sub:subscribe-channel-listener>
		<logger level="INFO" doc:name="Logger" doc:id="21652e14-de84-4752-a9b9-871dc346befb" message="#[payload]"/>
	</flow>
</mule>
```

## See Also

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

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

<!-- document id=395b22543009e44bb296f1464911860d9e4de321b885be4faa7099409c6a9e32 url=/mulesoft/current/en-us/salesforce-pubsub-connector/1.2/salesforce-pubsub-connector-reference.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.2
---

# Salesforce Pub/Sub Connector 1.2 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. Note that the <code>Basic Authentication</code> connection type is only supported for Salesforce API v64.0 and earlier versions.</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. Note that the `Basic Authentication` connection
type is only supported for Salesforce API v64.0 and earlier versions.

<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>Publish Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time the client waits for a publish request to complete before timing out. Values less than one millisecond are converted to 0 (no deadline).</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Publish 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>Publish Request Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies how often the inactivity watchdog scheduler checks each subscriber for activity. If the scheduler detects no activity on a subscriber’s channel since the previous check, it triggers a controlled resubscription so that the subscriber can continue receiving events. Values less than or equal to 0, including blank entries, disable the inactivity watchdog.</p></td><td></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler 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>Inactivity Watchdog Scheduler Frequency</strong> field.</p></td><td><p><code>SECONDS</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>

> [!NOTE] The Inactivity Watchdog Scheduler is a safety mechanism that detects subscribers that stop
> receiving events, for example after an unexpected gRPC stream closure, and triggers a controlled
> resubscription so event delivery can resume without restarting the Mule app. Configure the
> inactivity watchdog when subscribers in your environment occasionally stop receiving events even
> though the connection appears healthy.
>
> The Inactivity Watchdog Scheduler runs only when both **Inactivity Watchdog Scheduler Frequency**
> and **Inactivity Watchdog Scheduler Time Unit** are set. Leaving either field unset disables the
> scheduler. Set the frequency based on how often you expect to receive events. If you expect
> frequent events, a short frequency such as 5 minutes is appropriate. For lower-volume event
> streams, set a longer interval to avoid unnecessary resubscriptions.

### 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>Publish Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time the client waits for a publish request to complete before timing out. Values less than one millisecond are converted to 0 (no deadline).</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Publish 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>Publish Request Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies how often the inactivity watchdog scheduler checks each subscriber for activity. If the scheduler detects no activity on a subscriber’s channel since the previous check, it triggers a controlled resubscription so that the subscriber can continue receiving events. Values less than or equal to 0, including blank entries, disable the inactivity watchdog.</p></td><td></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler 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>Inactivity Watchdog Scheduler Frequency</strong> field.</p></td><td><p><code>SECONDS</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>

> [!NOTE] The Inactivity Watchdog Scheduler is a safety mechanism that detects subscribers that stop
> receiving events, for example after an unexpected gRPC stream closure, and triggers a controlled
> resubscription so event delivery can resume without restarting the Mule app. Configure the
> inactivity watchdog when subscribers in your environment occasionally stop receiving events even
> though the connection appears healthy.
>
> The Inactivity Watchdog Scheduler runs only when both **Inactivity Watchdog Scheduler Frequency**
> and **Inactivity Watchdog Scheduler Time Unit** are set. Leaving either field unset disables the
> scheduler. Set the frequency based on how often you expect to receive events. If you expect
> frequent events, a short frequency such as 5 minutes is appropriate. For lower-volume event
> streams, set a longer interval to avoid unnecessary resubscriptions.

### 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>Publish Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time the client waits for a publish request to complete before timing out. Values less than one millisecond are converted to 0 (no deadline).</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Publish 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>Publish Request Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies how often the inactivity watchdog scheduler checks each subscriber for activity. If the scheduler detects no activity on a subscriber’s channel since the previous check, it triggers a controlled resubscription so that the subscriber can continue receiving events. Values less than or equal to 0, including blank entries, disable the inactivity watchdog.</p></td><td></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler 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>Inactivity Watchdog Scheduler Frequency</strong> field.</p></td><td><p><code>SECONDS</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>

> [!NOTE] The Inactivity Watchdog Scheduler is a safety mechanism that detects subscribers that stop
> receiving events, for example after an unexpected gRPC stream closure, and triggers a controlled
> resubscription so event delivery can resume without restarting the Mule app. Configure the
> inactivity watchdog when subscribers in your environment occasionally stop receiving events even
> though the connection appears healthy.
>
> The Inactivity Watchdog Scheduler runs only when both **Inactivity Watchdog Scheduler Frequency**
> and **Inactivity Watchdog Scheduler Time Unit** are set. Leaving either field unset disables the
> scheduler. Set the frequency based on how often you expect to receive events. If you expect
> frequent events, a short frequency such as 5 minutes is appropriate. For lower-volume event
> streams, set a longer interval to avoid unnecessary resubscriptions.

### 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>Publish Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time the client waits for a publish request to complete before timing out. Values less than one millisecond are converted to 0 (no deadline).</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Publish 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>Publish Request Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies how often the inactivity watchdog scheduler checks each subscriber for activity. If the scheduler detects no activity on a subscriber’s channel since the previous check, it triggers a controlled resubscription so that the subscriber can continue receiving events. Values less than or equal to 0, including blank entries, disable the inactivity watchdog.</p></td><td></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler 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>Inactivity Watchdog Scheduler Frequency</strong> field.</p></td><td><p><code>SECONDS</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>

> [!NOTE] The Inactivity Watchdog Scheduler is a safety mechanism that detects subscribers that stop
> receiving events, for example after an unexpected gRPC stream closure, and triggers a controlled
> resubscription so event delivery can resume without restarting the Mule app. Configure the
> inactivity watchdog when subscribers in your environment occasionally stop receiving events even
> though the connection appears healthy.
>
> The Inactivity Watchdog Scheduler runs only when both **Inactivity Watchdog Scheduler Frequency**
> and **Inactivity Watchdog Scheduler Time Unit** are set. Leaving either field unset disables the
> scheduler. Set the frequency based on how often you expect to receive events. If you expect
> frequent events, a short frequency such as 5 minutes is appropriate. For lower-volume event
> streams, set a longer interval to avoid unnecessary resubscriptions.

### 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>Publish Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time the client waits for a publish request to complete before timing out. Values less than one millisecond are converted to 0 (no deadline).</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Publish 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>Publish Request Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies how often the inactivity watchdog scheduler checks each subscriber for activity. If the scheduler detects no activity on a subscriber’s channel since the previous check, it triggers a controlled resubscription so that the subscriber can continue receiving events. Values less than or equal to 0, including blank entries, disable the inactivity watchdog.</p></td><td></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler 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>Inactivity Watchdog Scheduler Frequency</strong> field.</p></td><td><p><code>SECONDS</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>

> [!NOTE] The Inactivity Watchdog Scheduler is a safety mechanism that detects subscribers that stop
> receiving events, for example after an unexpected gRPC stream closure, and triggers a controlled
> resubscription so event delivery can resume without restarting the Mule app. Configure the
> inactivity watchdog when subscribers in your environment occasionally stop receiving events even
> though the connection appears healthy.
>
> The Inactivity Watchdog Scheduler runs only when both **Inactivity Watchdog Scheduler Frequency**
> and **Inactivity Watchdog Scheduler Time Unit** are set. Leaving either field unset disables the
> scheduler. Set the frequency based on how often you expect to receive events. If you expect
> frequent events, a short frequency such as 5 minutes is appropriate. For lower-volume event
> streams, set a longer interval to avoid unnecessary resubscriptions.

## 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.
>
> - When using OAuth 2.0 authentication, the source isn’t initialized during the initial application
>   startup. You must complete the OAuth authorization process and then restart the application to
>   successfully initialize the source and begin receiving events.

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

<!-- document id=849e6085e6d880ee282bd866c4a325b75d47a4c2dc0cba6e10072c6230ade7e7 url=/mulesoft/current/en-us/salesforce-pubsub-connector/1.3/index.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.3
---

# Salesforce Pub/Sub Connector 1.3

> 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. This connector
complements Anypoint Connector for Salesforce (Salesforce Connector) and provides additional ways to
interface with Salesforce’s ecosystem. The Salesforce Pub/Sub API enables you to publish and
subscribe to events and request schemas and topic information with one API.

For information about compatibility and fixed issues, refer to the Salesforce Pub/Sub Connector
Release Notes.

## Before You Begin

To use this connector, you must be familiar with:

- The Salesforce Pub/Sub Connector’s API

- Anypoint Connectors

- Mule runtime engine (Mule)

- Elements and global elements in a Mule flow

- How to create a Mule app using Anypoint Studio

Before creating an app, you must have:

- Credentials to access the Salesforce Pub/Sub target resource

- Anypoint Platform

- Anypoint Studio or Anypoint Code Builder

## Common Use Cases For the Connector

These are some common use cases for Salesforce Pub/Sub Connector:

- Subscribe to event monitoring real-time events

- Subscribe to a standard or high volume platform event, such as `AppointmentSchedulingEvent`

- Publish a platform event (high volume only) back into Salesforce to restrict a user’s profile when
  they log in to Salesforce after working hours

- Subscribe to change data capture events and syn order data in an external inventory system

For examples of these use cases, refer to
[Salesforce Pub/Sub Connector Examples](https://docs.mulesoft.com/salesforce-pubsub-connector/1.3/salesforce-pubsub-connector-examples).

## Connection Types

Salesforce Pub/Sub connections use the following authentication types:

- Basic Authentication  
  Uses a username and a password for authentication

> [!NOTE] The `Basic Authentication` connection type is only supported for Salesforce API v64.0 and
> earlier versions.

- OAuth v2.0  
  Delegates user authentication to the service hosting the user account

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

- OAuth Username Password  
  Uses OAuth 2.0 with a username and a password for authentication

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

For information about configuring authentication types, refer to
[Configure a Global Element for the Connector](https://docs.mulesoft.com/salesforce-pubsub-connector/1.3/salesforce-pubsub-connector-studio#configure-global-element).

## 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/salesforce-pubsub-connector/1.3/salesforce-pubsub-connector-studio).

## See Also

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

- [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange)

- [Salesforce Pub/Sub Connector Reference](https://docs.mulesoft.com/salesforce-pubsub-connector/1.3/salesforce-pubsub-connector-reference)

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

<!-- document id=cd4d7605b9232fb45225170c80d152712a72a6d5f5f95a465255a6ce81954be0 url=/mulesoft/current/en-us/salesforce-pubsub-connector/1.3/salesforce-pubsub-connector-message-tracking-example.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.3
---

# Salesforce Pub/Sub Connector 1.3 - Tracking Salesforce Platform Events Example

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

One way to use Salesforce Pub/Sub Connector is to track whether a Salesforce platform event is
received from MuleSoft and processed. You can keep track of processed messages using a combination
of Salesforce and Mule runtime engine (Mule).

For a detailed example of one approach to message tracking, see
[Keeping Track of the Processed and Received Messages](/mulesoft/current/en-us/salesforce-pubsub-connector/1.3/_attachments/salesforce-pubsub-whitepaper.pdf).

## Replay ID and MuleSoft Object Store

To implement message tracking, it’s important to understand the core concepts of the Salesforce
Streaming API, the Replay ID attribute, and MuleSoft object store.

### Replay ID

On the Salesforce Event Bus, each published event message is assigned an opaque ID, which is
contained in the Replay (`replay_id`) attribute. The system populates the Replay ID field value when
the event message is delivered to subscribers and refers to the position of the event message within
the event stream.

The event stream has a message durability of 72 hours for high-volume platform events so, using the
Replay ID, it’s possible to receive event messages from the event stream that fall within that
period. The MuleSoft subscriber must carefully track the processed Replay IDs to ensure it doesn’t
miss or duplicate process events in case of downtime or restart (either intentional or
unintentional).

To enable advanced Replay ID tracking to ensure that the event message is received and processed
correctly, you are given control over the replay behavior with the Salesforce Pub/Sub Connector in
the connector configuration UI.

This example configuration uses the **Replay id from object store** option for the **Replay option**
property and specifies a dedicated object store in the **Object Store Name** field:

![Subscribe channel listener General properties configuration panel](/mulesoft/current/en-us/salesforce-pubsub-connector/1.3/_images/pubsub-channel-listener-config.png)

The following table shows the Replay ID options:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Replay Option</th><th>Description</th><th>Usage</th></tr></thead><tbody><tr><td><p><code>Custom replay id</code></p></td><td><p>The Subscriber receives all stored events after the event specified by its replay ID value, and new events.</p></td><td><p>Catch up on missed events after a certain event message, for example, after a connection failure. To subscribe with a specific replay ID, save the replay ID of the event message to retrieve stored events after, and then use it when you resubscribe.</p></td></tr><tr><td><p><code>Latest</code></p></td><td><p>If no replay option is specified, this is the default. The Subscriber receives new events that are broadcast after the client subscribes.</p></td><td><p>It is best to subscribe with the <code>Latest</code> option to receive new event messages. To get earlier event messages, don’t use this option.</p></td></tr><tr><td><p><code>Earliest</code></p></td><td><p>The Subscriber receives all events, including past events that are within the 72-hour retention window.</p></td><td><p>Catch up on missed events and retrieve all stored events, for example, after a connection failure. Using this option can slow performance if a large number of event messages are stored.</p></td></tr><tr><td><p><code>Replay id from object store</code></p></td><td><p>The 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.</p></td><td><p>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.3/salesforce-pubsub-connector-studio#store-objectstore">Store the Replay ID in the Object Store</a>.</p></td></tr></tbody></table>

### MuleSoft Object Store

Mule runtime engine (Mule) uses object stores to persist data for later retrieval. Mule uses object
stores in various filters, routers, and other message processors that store states between messages.

For CloudHub deployments, the free Object Store v2 limits usage to 10 transactions per second (TPS)
per application. The premium add-on for Object Store v2 increases the limit to 100 TPS per
application.

## Example of Tracking Messages

One of the challenges of the Salesforce-provided event-based integration is knowing whether a
particular message is received and processed by the subscriber. To achieve this goal, additional
logic is required.

For details about the implementation logic for one approach to message tracking, see
[Keeping Track of the Processed and Received Messages](/mulesoft/current/en-us/salesforce-pubsub-connector/1.3/_attachments/salesforce-pubsub-whitepaper.pdf).

## Batch Event Size

A key feature of Salesforce Pub/Sub Connector is that it allows you to control the number of
messages received and processed in a given period of time using the **Batch event size**
(`BatcheventSize`) attribute of the **Subscribe Channel Listener** operation to specify the total
number of events included in a server batch.

### Batch Event Size Example

In a test case, 500 records were created in Salesforce using Apex code. After all the processing
completed in Salesforce, the "delta" time between creating the log entry during record creation and
the log entry from the confirmation message was analyzed and MuleSoft worker statistics were
reviewed.

In summary:

- Using `BatcheventSize=1` vs the maximum value of 100 triples the time until Salesforce records the
  processing, which is still in the area of milliseconds.

- A CloudHub 0.1 vCore worker is sufficient to handle the load. There is no performance improvement
  when using a 0.2 core worker.

For more details about this test case, see
[BatcheventSize - How Does it Work?](/mulesoft/current/en-us/salesforce-pubsub-connector/1.3/_attachments/salesforce-pubsub-whitepaper.pdf).

## See Also

- [Have my Published Salesforce Platform Events Been Received by My Mule App?](/mulesoft/current/en-us/salesforce-pubsub-connector/1.3/_attachments/salesforce-pubsub-whitepaper.pdf)

- [Event Message Durability](https://developer.salesforce.com/docs/platform/pub-sub-api/guide/event-message-durability.html)

- [Pub/Sub API and the Expanded Event Bus](https://developer.salesforce.com/docs/platform/pub-sub-api/guide/expanded-event-bus.html)

<!-- document id=135c3105c28426765b8803a8cca18290c67c27c44aeada055183a018e14ff26c url=/mulesoft/current/en-us/salesforce-pubsub-connector/1.3/salesforce-pubsub-connector-xml-maven.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.3
---

# Salesforce Pub/Sub 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 Studio:

- If you manually code a Mule runtime engine (Mule) app in XML (either from the Anypoint 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 Studio, Studio automatically populates the XML 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/salesforce-pub-sub
http://www.mulesoft.org/schema/mule/salesforce-pub-sub/current/mule-salesforce-pub-sub.xsd
```

This example shows how the namespace statements are placed in the XML:

```xml
<mule xmlns:$2="http://www.mulesoft.org/schema/mule/$2"
	xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns:file="http://www.mulesoft.org/schema/mule/file"
	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/file
	http://www.mulesoft.org/schema/mule/file/current/mule-file.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/ee/core
	http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
	http://www.mulesoft.org/schema/mule/$2
	http://www.mulesoft.org/schema/mule/$2/current/mule-$2.xsd">
```

## Add a POM File Dependency

The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
When 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-salesforce-pubsub-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

Replace `<version>` with the version that corresponds to the connector you are using.

To obtain 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 `Salesforce Pub/Sub`.

4.  Select the connector.

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

## Next Step

After completing your namespace and `pom.xml` file, you can try the
[Examples](https://docs.mulesoft.com/salesforce-pubsub-connector/1.3/salesforce-pubsub-connector-examples).

## See Also

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

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

<!-- document id=7575b05e9445bbcc56e1ee40262fc51d7c95add3b22b6ecd6587514ad7d5b5f8 url=/mulesoft/current/en-us/salesforce-pubsub-connector/1.3/salesforce-pubsub-connector-examples.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.3
---

# Salesforce Pub/Sub Connector 1.3 Examples

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

The following examples show several Mule flows for Salesforce Pub/Sub Connector:

- [Publish an Event](#publish-an-event)

- [Configure Publish Request Timeout](#publish-request)

- [Subscribe to a Channel](#subscribe-to-a-channel)

## Configure a Connection

To secure connections, you must specify the connection field values. To do this:

- [Create a configuration file for a connection.](#create-config-file)

- [Configure the connection global elements.](#configure-conn)

- [Configure a global element for the properties file.](#configure-global)

### Create a Configuration File for a Connection

Create a configuration file that includes properties for a connection:

1.  Create a file named `mule-app.properties` in the `/src/main/resources/` folder.

2.  In the `mule-app.properties` file, create a set of properties for the connection, similar to the
    ones that follow, replacing the bracketed text (including the brackets) with the correct values
    for your configuration:

    m4-config.username=<username within Salesforce Pub/Sub system> m4-config.password=<password for
    the username within Salesforce Pub/Sub system> m4-config.securityToken=<security token within
    Salesforce Pub/Sub system> m4-config.url=<endpoint representing your development environment>

    The properties used vary depending on the selected connection configuration.

For more information about creating a properties file, refer to
[Configuring Property Placeholders](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-to-configure).

### Configure the Connection Global Elements

Configure global elements for connection:

1.  Create a new Mule project.

2.  In the **Mule Palette** view, click **Search in Exchange** and enter `Salesforce Pub/Sub`.

3.  Add **Salesforce Pub/Sub Connector** to the **Selected modules** section and click **Finish**.

4.  Click the **Global Elements** tab and click **Create**.

5.  Select **Connector Configuration > Salesforce Pub/Sub Config** and click **OK**.

6.  Enter the values to configure either Basic Authentication, OAuth v2.0, OAuth JWT, OAuth Username
    Password, or OAuth SAML. Note that the `Basic Authentication` connection type is only supported
    for Salesforce API v64.0 and earlier versions.

7.  Click the **Test Connection** button to ensure there is connectivity with the Salesforce Pub/Sub
    API. A successful message should pop up.

8.  Click **OK**.

9.  Open the HTTPS Listener config in **Global Element Configuration**.

10. Click the **TLS** tab and select **TLS Configuration > Edit inline**.

11. Specify the **Key Store Configuration** with the generated keystore details to enable HTTPS on
    this configuration.

12. Click **OK**.

### Configure a Global Element for the Properties File

Configure a global element for the `mule-app.properties` file so that Mule knows where to find it:

1.  Click the **Global Elements** tab and click **Create**.

2.  In the **Choose Global Type** dialog, select **Configuration properties** and click **OK**.

3.  In the **File** field, enter `mule.app.properties`.

4.  Click **OK**.

## Publish an Event

This example Mule flow publishes an event and uses the following operations:

- **HTTP Listener**  
  Accepts data from HTTP requests.

- **Transform Message**  
  Outputs the data in Java.

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

  Enter the following values:

  <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Topic</strong></p></td><td><div><div><p>Name of the topic used for message publishing, for example, <code>/event/gRPCMunitTestDoNotDelete__e</code></p></div></div></td></tr><tr><td><p><strong>Job Id</strong></p></td><td><div><div><p><code>payload</code></p></div></div></td></tr></tbody></table>

![Studio flow for the Publish event operation](/mulesoft/current/en-us/salesforce-pubsub-connector/1.3/_images/publish-an-event.png)

### XML for This Example

Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	  xmlns:http="http://www.mulesoft.org/schema/mule/http" xmlns:salesforce-pub-sub="http://www.mulesoft.org/schema/mule/salesforce-pub-sub" 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/salesforce-pub-sub http://www.mulesoft.org/schema/mule/salesforce-pub-sub/current/mule-salesforce-pub-sub.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/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">

	<configuration-properties file="mule-app.properties"/>

	<salesforce-pub-sub:pubsub-config name="Salesforce_PubSub_Config" >
		<salesforce-pub-sub:basic-connection username="${m4-config.username}" password="${m4-config.password}" securityToken="${m4-config.securityToken}" url="${m4-config.url}"/>
	</salesforce-pub-sub:pubsub-config>

	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="3805c5f1-0f01-476a-a619-a03f34dadfdd" >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
<flow name="mule-salesforce-pubsub-connector-publish-event-demo" doc:id="9e2df8f5-1b47-4a76-ac62-941c989cd93b" >
  <http:listener doc:name="Listener" doc:id="6e06a214-3112-40ef-8720-f730121aa5e0" config-ref="HTTP_Listener_config" path="/publish-event"/>
  <ee:transform>
    <ee:message>
      <ee:set-payload><![CDATA[%dw 2.0
        output application/java
        ---
        [{
          CreatedDate: 12334455,
          CreatedById: "123",
          Desc__c: "Something"
        },{
          CreatedDate: 12334456,
          CreatedById: "1234",
          Desc__c: "Something2"
        }
        ]]]>
      </ee:set-payload>
    </ee:message>
  </ee:transform>

  <salesforce-pub-sub:publish-event config-ref="Salesforce_PubSub_Config" topic="/event/gRPCMunitTestDoNotDelete__e"/>
</flow>
</mule>
```

## Configure Publish Request Timeout

This example shows how to configure the **Publish Request Timeout** and **Publish Request Time
Unit** parameters to control the timeout behavior for publish operations. This is useful when you
want to ensure that publish requests don’t wait indefinitely and have specific timeout requirements.
This example Mule flow configures timeout settings.

The key timeout configuration parameters are:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Publish Request Timeout</strong></p></td><td><div><div><p><code>60</code> (60 units of time before timeout)</p></div></div></td></tr><tr><td><p><strong>Publish Request Time Unit</strong></p></td><td><div><div><p><code>SECONDS</code> (timeout unit specification)</p></div></div></td></tr></tbody></table>

![Global element properties window for the Publish event operation with timeout configuration](/mulesoft/current/en-us/salesforce-pubsub-connector/1.3/_images/salesforce-pub-publish-timeout.png)

### XML for This Example

Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:scripting="http://www.mulesoft.org/schema/mule/scripting"
	xmlns:tls="http://www.mulesoft.org/schema/mule/tls" xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns:os="http://www.mulesoft.org/schema/mule/os"
	xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core" xmlns:salesforce-pub-sub="http://www.mulesoft.org/schema/mule/salesforce-pub-sub" 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/scripting http://www.mulesoft.org/schema/mule/scripting/current/mule-scripting.xsd http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/salesforce-pub-sub http://www.mulesoft.org/schema/mule/salesforce-pub-sub/current/mule-salesforce-pub-sub.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/os http://www.mulesoft.org/schema/mule/os/current/mule-os.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/tls http://www.mulesoft.org/schema/mule/tls/current/mule-tls.xsd">
	<salesforce-pub-sub:pubsub-config name="insecureSalesforce_PubSub_Config" doc:name="Salesforce PubSub Config"  >
		<salesforce-pub-sub:oauth-user-pass-connection consumerKey="&lt;CONSUMER_KEY&gt;" consumerSecret="&lt;CONSUMER_SECRET&gt;" username="&lt;USERNAME&gt;" password="&lt;USERNAME&gt;" securityToken="&lt;SECURITY_TOKEN&gt;" tokenEndpoint="&lt;TOKEN_ENDPOINT&gt;" host="&lt;GRPC_HOST&gt;" port="0000" publishRequestTimeout="60" >
		</salesforce-pub-sub:oauth-user-pass-connection>
	</salesforce-pub-sub:pubsub-config>

	<os:object-store name="replayObjectStore" doc:name="Object store"  entryTtlUnit="DAYS" expirationIntervalUnit="DAYS" entryTtl="1"/>


	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config"  >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
	<flow name="ytaoka-salesforce-pubsublistenerFlow1"  initialState="started">
		<http:listener doc:name="Listener"  config-ref="HTTP_Listener_config" path="/publish"/>

	 <logger level="INFO" doc:name="Logger"  message="Before Publish" />
		<salesforce-pub-sub:publish-event config-ref="insecureSalesforce_PubSub_Config" topic="/event/gRPCMunitTestDoNotDelete__e">
        </salesforce-pub-sub:publish-event>
		<logger level="INFO" doc:name="Logger"  message="After Publish"/>
	</flow>
</mule>
```

## Subscribe to a Channel

This example Mule flow subscribes to a channel and uses the following operations:

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

  Enter the following values:

  <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Channel name</strong></p></td><td><div><div><p>Name of the streaming channel to subscribe to, for example, <code>/event/gRPCMunitTestDoNotDelete__e</code></p></div></div></td></tr><tr><td><p><strong>Replay option</strong></p></td><td><div><div><p>One of the given implementations, for example, <code>Earliest</code>. For more information on how to use <code>Replay id from object store</code> in <strong>Replay option</strong>, refer to <a href="https://docs.mulesoft.com/salesforce-pubsub-connector/1.3/salesforce-pubsub-connector-studio#store-objectstore">Store the Replay ID in the Object Store</a>.</p></div></div></td></tr><tr><td><p><strong>Batch events size</strong></p></td><td><div><div><p>Total number of events included in a server batch. Lower values indicate small memory footprint with more server calls, while bigger values indicate bigger memory footprint with fewer API calls. A new batch of events is requested by the connector after the flow consumes the existing events, for example, <code>1000</code></p></div></div></td></tr></tbody></table>

- **Logger**  
  Shows the HTTP response from the **Subscribe channel listener** source

![Studio flow for the Subscribe channel listener source](/mulesoft/current/en-us/salesforce-pubsub-connector/1.3/_images/subscribe-to-a-channel.png)

### XML for This Example

Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	  xmlns:http="http://www.mulesoft.org/schema/mule/http" xmlns:salesforce-pub-sub="http://www.mulesoft.org/schema/mule/salesforce-pub-sub" 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/salesforce-pub-sub http://www.mulesoft.org/schema/mule/salesforce-pub-sub/current/mule-salesforce-pub-sub.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/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">

	<configuration-properties file="mule-app.properties"/>

	<salesforce-pub-sub:pubsub-config name="Salesforce_PubSub_Config" >
		<salesforce-pub-sub:basic-connection username="${m4-config.username}" password="${m4-config.password}" securityToken="${m4-config.securityToken}" url="${m4-config.url}"/>
	</salesforce-pub-sub:pubsub-config>

	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="3805c5f1-0f01-476a-a619-a03f34dadfdd" >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>

	<flow name="mule-salesforce-pubsub-connector-subscribe-channel-demo" doc:id="4faf2bf8-e2af-43bc-bba8-d336761800dd" >
		<salesforce-pub-sub:subscribe-channel-listener channelName="/event/gRPCMunitTestDoNotDelete__e" config-ref="Salesforce_PubSub_Config" eventBatchSize="1000">
			<salesforce-pub-sub:replay-option >
				<salesforce-pub-sub:earliest />
			</salesforce-pub-sub:replay-option>
		</salesforce-pub-sub:subscribe-channel-listener>
		<logger level="INFO" doc:name="Logger" doc:id="21652e14-de84-4752-a9b9-871dc346befb" message="#[payload]"/>
	</flow>
</mule>
```

## See Also

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

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

<!-- document id=33aa7f7f130be10543fec5d872a50f134f07d57d011fbb02cd923fd50ccd8417 url=/mulesoft/current/en-us/salesforce-pubsub-connector/1.3/salesforce-pubsub-connector-reference.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.3
---

# Salesforce Pub/Sub Connector 1.3 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. Note that the <code>Basic Authentication</code> connection type is only supported for Salesforce API v64.0 and earlier versions.</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. Note that the `Basic Authentication` connection
type is only supported for Salesforce API v64.0 and earlier versions.

<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>30</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>60</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>Publish Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time the client waits for a publish request to complete before timing out. Values less than one millisecond are converted to 0 (no deadline).</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Publish 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>Publish Request Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies how often the inactivity watchdog scheduler checks each subscriber for activity. If the scheduler detects no activity on a subscriber’s channel since the previous check, it triggers a controlled resubscription so that the subscriber can continue receiving events. Values less than or equal to 0, including blank entries, disable the inactivity watchdog.</p></td><td></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler 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>Inactivity Watchdog Scheduler Frequency</strong> field.</p></td><td><p><code>SECONDS</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>

> [!NOTE] The Inactivity Watchdog Scheduler is a safety mechanism that detects subscribers that stop
> receiving events, for example after an unexpected gRPC stream closure, and triggers a controlled
> resubscription so event delivery can resume without restarting the Mule app. Configure the
> inactivity watchdog when subscribers in your environment occasionally stop receiving events even
> though the connection appears healthy.
>
> The Inactivity Watchdog Scheduler runs only when both **Inactivity Watchdog Scheduler Frequency**
> and **Inactivity Watchdog Scheduler Time Unit** are set. Leaving either field unset disables the
> scheduler. Set the frequency based on how often you expect to receive events. If you expect
> frequent events, a short frequency such as 5 minutes is appropriate. For lower-volume event
> streams, set a longer interval to avoid unnecessary resubscriptions.

### 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>30</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>60</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>Publish Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time the client waits for a publish request to complete before timing out. Values less than one millisecond are converted to 0 (no deadline).</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Publish 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>Publish Request Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies how often the inactivity watchdog scheduler checks each subscriber for activity. If the scheduler detects no activity on a subscriber’s channel since the previous check, it triggers a controlled resubscription so that the subscriber can continue receiving events. Values less than or equal to 0, including blank entries, disable the inactivity watchdog.</p></td><td></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler 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>Inactivity Watchdog Scheduler Frequency</strong> field.</p></td><td><p><code>SECONDS</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>

> [!NOTE] The Inactivity Watchdog Scheduler is a safety mechanism that detects subscribers that stop
> receiving events, for example after an unexpected gRPC stream closure, and triggers a controlled
> resubscription so event delivery can resume without restarting the Mule app. Configure the
> inactivity watchdog when subscribers in your environment occasionally stop receiving events even
> though the connection appears healthy.
>
> The Inactivity Watchdog Scheduler runs only when both **Inactivity Watchdog Scheduler Frequency**
> and **Inactivity Watchdog Scheduler Time Unit** are set. Leaving either field unset disables the
> scheduler. Set the frequency based on how often you expect to receive events. If you expect
> frequent events, a short frequency such as 5 minutes is appropriate. For lower-volume event
> streams, set a longer interval to avoid unnecessary resubscriptions.

### 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>30</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>60</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>Publish Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time the client waits for a publish request to complete before timing out. Values less than one millisecond are converted to 0 (no deadline).</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Publish 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>Publish Request Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies how often the inactivity watchdog scheduler checks each subscriber for activity. If the scheduler detects no activity on a subscriber’s channel since the previous check, it triggers a controlled resubscription so that the subscriber can continue receiving events. Values less than or equal to 0, including blank entries, disable the inactivity watchdog.</p></td><td></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler 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>Inactivity Watchdog Scheduler Frequency</strong> field.</p></td><td><p><code>SECONDS</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>

> [!NOTE] The Inactivity Watchdog Scheduler is a safety mechanism that detects subscribers that stop
> receiving events, for example after an unexpected gRPC stream closure, and triggers a controlled
> resubscription so event delivery can resume without restarting the Mule app. Configure the
> inactivity watchdog when subscribers in your environment occasionally stop receiving events even
> though the connection appears healthy.
>
> The Inactivity Watchdog Scheduler runs only when both **Inactivity Watchdog Scheduler Frequency**
> and **Inactivity Watchdog Scheduler Time Unit** are set. Leaving either field unset disables the
> scheduler. Set the frequency based on how often you expect to receive events. If you expect
> frequent events, a short frequency such as 5 minutes is appropriate. For lower-volume event
> streams, set a longer interval to avoid unnecessary resubscriptions.

### 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>30</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>60</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>Publish Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time the client waits for a publish request to complete before timing out. Values less than one millisecond are converted to 0 (no deadline).</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Publish 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>Publish Request Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies how often the inactivity watchdog scheduler checks each subscriber for activity. If the scheduler detects no activity on a subscriber’s channel since the previous check, it triggers a controlled resubscription so that the subscriber can continue receiving events. Values less than or equal to 0, including blank entries, disable the inactivity watchdog.</p></td><td></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler 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>Inactivity Watchdog Scheduler Frequency</strong> field.</p></td><td><p><code>SECONDS</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>

> [!NOTE] The Inactivity Watchdog Scheduler is a safety mechanism that detects subscribers that stop
> receiving events, for example after an unexpected gRPC stream closure, and triggers a controlled
> resubscription so event delivery can resume without restarting the Mule app. Configure the
> inactivity watchdog when subscribers in your environment occasionally stop receiving events even
> though the connection appears healthy.
>
> The Inactivity Watchdog Scheduler runs only when both **Inactivity Watchdog Scheduler Frequency**
> and **Inactivity Watchdog Scheduler Time Unit** are set. Leaving either field unset disables the
> scheduler. Set the frequency based on how often you expect to receive events. If you expect
> frequent events, a short frequency such as 5 minutes is appropriate. For lower-volume event
> streams, set a longer interval to avoid unnecessary resubscriptions.

### 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>30</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>60</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>Publish Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time the client waits for a publish request to complete before timing out. Values less than one millisecond are converted to 0 (no deadline).</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Publish 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>Publish Request Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies how often the inactivity watchdog scheduler checks each subscriber for activity. If the scheduler detects no activity on a subscriber’s channel since the previous check, it triggers a controlled resubscription so that the subscriber can continue receiving events. Values less than or equal to 0, including blank entries, disable the inactivity watchdog.</p></td><td></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler 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>Inactivity Watchdog Scheduler Frequency</strong> field.</p></td><td><p><code>SECONDS</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>

> [!NOTE] The Inactivity Watchdog Scheduler is a safety mechanism that detects subscribers that stop
> receiving events, for example after an unexpected gRPC stream closure, and triggers a controlled
> resubscription so event delivery can resume without restarting the Mule app. Configure the
> inactivity watchdog when subscribers in your environment occasionally stop receiving events even
> though the connection appears healthy.
>
> The Inactivity Watchdog Scheduler runs only when both **Inactivity Watchdog Scheduler Frequency**
> and **Inactivity Watchdog Scheduler Time Unit** are set. Leaving either field unset disables the
> scheduler. Set the frequency based on how often you expect to receive events. If you expect
> frequent events, a short frequency such as 5 minutes is appropriate. For lower-volume event
> streams, set a longer interval to avoid unnecessary resubscriptions.

## 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.
>
> - When using OAuth 2.0 authentication, the source isn’t initialized during the initial application
>   startup. You must complete the OAuth authorization process and then restart the application to
>   successfully initialize the source and begin receiving events.

<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.3/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>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Maps error types thrown by this operation to custom error types.</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>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)

- [Error Mapping](#ErrorMapping)

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

### Error Mapping

Maps source error types to custom error types 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>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><p>Source error type to map.</p></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><p>Custom error type to map the source error to.</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)

<!-- document id=d6528a7b206055a703bd4d28911e72aa288f9e0356390ebb99b966eabf38712d url=/mulesoft/current/en-us/salesforce-pubsub-connector/latest/index.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.4
is-latest-version: true
---

# Salesforce Pub/Sub Connector 1.4

> 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. This connector
complements Anypoint Connector for Salesforce (Salesforce Connector) and provides additional ways to
interface with Salesforce’s ecosystem. The Salesforce Pub/Sub API enables you to publish and
subscribe to events and request schemas and topic information with one API.

For information about compatibility and fixed issues, refer to the Salesforce Pub/Sub Connector
Release Notes.

## Before You Begin

To use this connector, you must be familiar with:

- The Salesforce Pub/Sub Connector’s API

- Anypoint Connectors

- Mule runtime engine (Mule)

- Elements and global elements in a Mule flow

- How to create a Mule app using Anypoint Studio

Before creating an app, you must have:

- Credentials to access the Salesforce Pub/Sub target resource

- Anypoint Platform

- Anypoint Studio or Anypoint Code Builder

## Common Use Cases For the Connector

These are some common use cases for Salesforce Pub/Sub Connector:

- Subscribe to event monitoring real-time events

- Subscribe to a standard or high volume platform event, such as `AppointmentSchedulingEvent`

- Publish a platform event (high volume only) back into Salesforce to restrict a user’s profile when
  they log in to Salesforce after working hours

- Subscribe to change data capture events and syn order data in an external inventory system

For examples of these use cases, refer to
[Salesforce Pub/Sub Connector Examples](https://docs.mulesoft.com/salesforce-pubsub-connector/latest/salesforce-pubsub-connector-examples).

## Connection Types

Salesforce Pub/Sub connections use the following authentication types:

- Basic Authentication  
  Uses a username and a password for authentication

> [!NOTE] The `Basic Authentication` connection type is only supported for Salesforce API v64.0 and
> earlier versions.

- OAuth v2.0  
  Delegates user authentication to the service hosting the user account

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

- OAuth Client Credentials  
  Uses OAuth 2.0 with the client credentials grant type for authentication

- OAuth Username Password  
  Uses OAuth 2.0 with a username and a password for authentication

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

For information about configuring authentication types, refer to
[Configure a Global Element for the Connector](https://docs.mulesoft.com/salesforce-pubsub-connector/latest/salesforce-pubsub-connector-studio#configure-global-element).

## 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/salesforce-pubsub-connector/latest/salesforce-pubsub-connector-studio).

## See Also

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

- [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange)

- [Salesforce Pub/Sub Connector Reference](https://docs.mulesoft.com/salesforce-pubsub-connector/latest/salesforce-pubsub-connector-reference)

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

<!-- document id=fa5cd7775f40c6269a1de26fe0436188913bd1760eccf6120b760884a893062a url=/mulesoft/current/en-us/salesforce-pubsub-connector/latest/salesforce-pubsub-connector-message-tracking-example.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.4
is-latest-version: true
---

# Salesforce Pub/Sub Connector 1.4 - Tracking Salesforce Platform Events Example

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

One way to use Salesforce Pub/Sub Connector is to track whether a Salesforce platform event is
received from MuleSoft and processed. You can keep track of processed messages using a combination
of Salesforce and Mule runtime engine (Mule).

For a detailed example of one approach to message tracking, see
[Keeping Track of the Processed and Received Messages](/mulesoft/current/en-us/salesforce-pubsub-connector/latest/_attachments/salesforce-pubsub-whitepaper.pdf).

## Replay ID and MuleSoft Object Store

To implement message tracking, it’s important to understand the core concepts of the Salesforce
Streaming API, the Replay ID attribute, and MuleSoft object store.

### Replay ID

On the Salesforce Event Bus, each published event message is assigned an opaque ID, which is
contained in the Replay (`replay_id`) attribute. The system populates the Replay ID field value when
the event message is delivered to subscribers and refers to the position of the event message within
the event stream.

The event stream has a message durability of 72 hours for high-volume platform events so, using the
Replay ID, it’s possible to receive event messages from the event stream that fall within that
period. The MuleSoft subscriber must carefully track the processed Replay IDs to ensure it doesn’t
miss or duplicate process events in case of downtime or restart (either intentional or
unintentional).

To enable advanced Replay ID tracking to ensure that the event message is received and processed
correctly, you are given control over the replay behavior with the Salesforce Pub/Sub Connector in
the connector configuration UI.

This example configuration uses the **Replay id from object store** option for the **Replay option**
property and specifies a dedicated object store in the **Object Store Name** field:

![Subscribe channel listener General properties configuration panel](/mulesoft/current/en-us/salesforce-pubsub-connector/latest/_images/pubsub-channel-listener-config.png)

The following table shows the Replay ID options:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Replay Option</th><th>Description</th><th>Usage</th></tr></thead><tbody><tr><td><p><code>Custom replay id</code></p></td><td><p>The Subscriber receives all stored events after the event specified by its replay ID value, and new events.</p></td><td><p>Catch up on missed events after a certain event message, for example, after a connection failure. To subscribe with a specific replay ID, save the replay ID of the event message to retrieve stored events after, and then use it when you resubscribe.</p></td></tr><tr><td><p><code>Latest</code></p></td><td><p>If no replay option is specified, this is the default. The Subscriber receives new events that are broadcast after the client subscribes.</p></td><td><p>It is best to subscribe with the <code>Latest</code> option to receive new event messages. To get earlier event messages, don’t use this option.</p></td></tr><tr><td><p><code>Earliest</code></p></td><td><p>The Subscriber receives all events, including past events that are within the 72-hour retention window.</p></td><td><p>Catch up on missed events and retrieve all stored events, for example, after a connection failure. Using this option can slow performance if a large number of event messages are stored.</p></td></tr><tr><td><p><code>Replay id from object store</code></p></td><td><p>The 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.</p></td><td><p>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/latest/salesforce-pubsub-connector-studio#store-objectstore">Store the Replay ID in the Object Store</a>.</p></td></tr></tbody></table>

### MuleSoft Object Store

Mule runtime engine (Mule) uses object stores to persist data for later retrieval. Mule uses object
stores in various filters, routers, and other message processors that store states between messages.

For CloudHub deployments, the free Object Store v2 limits usage to 10 transactions per second (TPS)
per application. The premium add-on for Object Store v2 increases the limit to 100 TPS per
application.

## Example of Tracking Messages

One of the challenges of the Salesforce-provided event-based integration is knowing whether a
particular message is received and processed by the subscriber. To achieve this goal, additional
logic is required.

For details about the implementation logic for one approach to message tracking, see
[Keeping Track of the Processed and Received Messages](/mulesoft/current/en-us/salesforce-pubsub-connector/latest/_attachments/salesforce-pubsub-whitepaper.pdf).

## Batch Event Size

A key feature of Salesforce Pub/Sub Connector is that it allows you to control the number of
messages received and processed in a given period of time using the **Batch event size**
(`BatcheventSize`) attribute of the **Subscribe Channel Listener** operation to specify the total
number of events included in a server batch.

### Batch Event Size Example

In a test case, 500 records were created in Salesforce using Apex code. After all the processing
completed in Salesforce, the "delta" time between creating the log entry during record creation and
the log entry from the confirmation message was analyzed and MuleSoft worker statistics were
reviewed.

In summary:

- Using `BatcheventSize=1` vs the maximum value of 100 triples the time until Salesforce records the
  processing, which is still in the area of milliseconds.

- A CloudHub 0.1 vCore worker is sufficient to handle the load. There is no performance improvement
  when using a 0.2 core worker.

For more details about this test case, see
[BatcheventSize - How Does it Work?](/mulesoft/current/en-us/salesforce-pubsub-connector/latest/_attachments/salesforce-pubsub-whitepaper.pdf).

## See Also

- [Have my Published Salesforce Platform Events Been Received by My Mule App?](/mulesoft/current/en-us/salesforce-pubsub-connector/latest/_attachments/salesforce-pubsub-whitepaper.pdf)

- [Event Message Durability](https://developer.salesforce.com/docs/platform/pub-sub-api/guide/event-message-durability.html)

- [Pub/Sub API and the Expanded Event Bus](https://developer.salesforce.com/docs/platform/pub-sub-api/guide/expanded-event-bus.html)

<!-- document id=f043bffdecca255f7e18e9062942e7a72d5982a92cfc27ab62fe53c3d8afad34 url=/mulesoft/current/en-us/salesforce-pubsub-connector/latest/salesforce-pubsub-connector-xml-maven.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.4
is-latest-version: true
---

# Salesforce Pub/Sub Connector 1.4 - 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 Studio:

- If you manually code a Mule runtime engine (Mule) app in XML (either from the Anypoint 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 Studio, Studio automatically populates the XML 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/salesforce-pub-sub
http://www.mulesoft.org/schema/mule/salesforce-pub-sub/current/mule-salesforce-pub-sub.xsd
```

This example shows how the namespace statements are placed in the XML:

```xml
<mule xmlns:$2="http://www.mulesoft.org/schema/mule/$2"
	xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns:file="http://www.mulesoft.org/schema/mule/file"
	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/file
	http://www.mulesoft.org/schema/mule/file/current/mule-file.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/ee/core
	http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
	http://www.mulesoft.org/schema/mule/$2
	http://www.mulesoft.org/schema/mule/$2/current/mule-$2.xsd">
```

## Add a POM File Dependency

The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
When 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-salesforce-pubsub-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

Replace `<version>` with the version that corresponds to the connector you are using.

To obtain 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 `Salesforce Pub/Sub`.

4.  Select the connector.

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

## Next Step

After completing your namespace and `pom.xml` file, you can try the
[Examples](https://docs.mulesoft.com/salesforce-pubsub-connector/latest/salesforce-pubsub-connector-examples).

## See Also

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

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

<!-- document id=115d8a07d7ec3a1e6819e7f57a69f5f318684e27bef5a1e1fb5c38cacf6382ba url=/mulesoft/current/en-us/salesforce-pubsub-connector/latest/salesforce-pubsub-connector-examples.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.4
is-latest-version: true
---

# Salesforce Pub/Sub Connector 1.4 Examples

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

The following examples show several Mule flows for Salesforce Pub/Sub Connector:

- [Publish an Event](#publish-an-event)

- [Configure Publish Request Timeout](#publish-request)

- [Subscribe to a Channel](#subscribe-to-a-channel)

## Configure a Connection

To secure connections, you must specify the connection field values. To do this:

- [Create a configuration file for a connection.](#create-config-file)

- [Configure the connection global elements.](#configure-conn)

- [Configure a global element for the properties file.](#configure-global)

### Create a Configuration File for a Connection

Create a configuration file that includes properties for a connection:

1.  Create a file named `mule-app.properties` in the `/src/main/resources/` folder.

2.  In the `mule-app.properties` file, create a set of properties for the connection, similar to the
    ones that follow, replacing the bracketed text (including the brackets) with the correct values
    for your configuration:

    m4-config.username=<username within Salesforce Pub/Sub system> m4-config.password=<password for
    the username within Salesforce Pub/Sub system> m4-config.securityToken=<security token within
    Salesforce Pub/Sub system> m4-config.url=<endpoint representing your development environment>

    The properties used vary depending on the selected connection configuration.

For more information about creating a properties file, refer to
[Configuring Property Placeholders](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-to-configure).

### Configure the Connection Global Elements

Configure global elements for connection:

1.  Create a new Mule project.

2.  In the **Mule Palette** view, click **Search in Exchange** and enter `Salesforce Pub/Sub`.

3.  Add **Salesforce Pub/Sub Connector** to the **Selected modules** section and click **Finish**.

4.  Click the **Global Elements** tab and click **Create**.

5.  Select **Connector Configuration > Salesforce Pub/Sub Config** and click **OK**.

6.  Enter the values to configure either Basic Authentication, OAuth v2.0, OAuth JWT, OAuth Client
    Credentials, OAuth Username Password, or OAuth SAML. Note that the `Basic Authentication`
    connection type is only supported for Salesforce API v64.0 and earlier versions.

7.  Click the **Test Connection** button to ensure there is connectivity with the Salesforce Pub/Sub
    API. A successful message should pop up.

8.  Click **OK**.

9.  Open the HTTPS Listener config in **Global Element Configuration**.

10. Click the **TLS** tab and select **TLS Configuration > Edit inline**.

11. Specify the **Key Store Configuration** with the generated keystore details to enable HTTPS on
    this configuration.

12. Click **OK**.

### Configure a Global Element for the Properties File

Configure a global element for the `mule-app.properties` file so that Mule knows where to find it:

1.  Click the **Global Elements** tab and click **Create**.

2.  In the **Choose Global Type** dialog, select **Configuration properties** and click **OK**.

3.  In the **File** field, enter `mule.app.properties`.

4.  Click **OK**.

## Publish an Event

This example Mule flow publishes an event and uses the following operations:

- **HTTP Listener**  
  Accepts data from HTTP requests.

- **Transform Message**  
  Outputs the data in Java.

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

  Enter the following values:

  <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Topic</strong></p></td><td><div><div><p>Name of the topic used for message publishing, for example, <code>/event/gRPCMunitTestDoNotDelete__e</code></p></div></div></td></tr><tr><td><p><strong>Job Id</strong></p></td><td><div><div><p><code>payload</code></p></div></div></td></tr></tbody></table>

![Studio flow for the Publish event operation](/mulesoft/current/en-us/salesforce-pubsub-connector/latest/_images/publish-an-event.png)

### XML for This Example

Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	  xmlns:http="http://www.mulesoft.org/schema/mule/http" xmlns:salesforce-pub-sub="http://www.mulesoft.org/schema/mule/salesforce-pub-sub" 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/salesforce-pub-sub http://www.mulesoft.org/schema/mule/salesforce-pub-sub/current/mule-salesforce-pub-sub.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/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">

	<configuration-properties file="mule-app.properties"/>

	<salesforce-pub-sub:pubsub-config name="Salesforce_PubSub_Config" >
		<salesforce-pub-sub:basic-connection username="${m4-config.username}" password="${m4-config.password}" securityToken="${m4-config.securityToken}" url="${m4-config.url}"/>
	</salesforce-pub-sub:pubsub-config>

	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="3805c5f1-0f01-476a-a619-a03f34dadfdd" >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
<flow name="mule-salesforce-pubsub-connector-publish-event-demo" doc:id="9e2df8f5-1b47-4a76-ac62-941c989cd93b" >
  <http:listener doc:name="Listener" doc:id="6e06a214-3112-40ef-8720-f730121aa5e0" config-ref="HTTP_Listener_config" path="/publish-event"/>
  <ee:transform>
    <ee:message>
      <ee:set-payload><![CDATA[%dw 2.0
        output application/java
        ---
        [{
          CreatedDate: 12334455,
          CreatedById: "123",
          Desc__c: "Something"
        },{
          CreatedDate: 12334456,
          CreatedById: "1234",
          Desc__c: "Something2"
        }
        ]]]>
      </ee:set-payload>
    </ee:message>
  </ee:transform>

  <salesforce-pub-sub:publish-event config-ref="Salesforce_PubSub_Config" topic="/event/gRPCMunitTestDoNotDelete__e"/>
</flow>
</mule>
```

## Configure Publish Request Timeout

This example shows how to configure the **Publish Request Timeout** and **Publish Request Time
Unit** parameters to control the timeout behavior for publish operations. This is useful when you
want to ensure that publish requests don’t wait indefinitely and have specific timeout requirements.
This example Mule flow configures timeout settings.

The key timeout configuration parameters are:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Publish Request Timeout</strong></p></td><td><div><div><p><code>60</code> (60 units of time before timeout)</p></div></div></td></tr><tr><td><p><strong>Publish Request Time Unit</strong></p></td><td><div><div><p><code>SECONDS</code> (timeout unit specification)</p></div></div></td></tr></tbody></table>

![Global element properties window for the Publish event operation with timeout configuration](/mulesoft/current/en-us/salesforce-pubsub-connector/latest/_images/salesforce-pub-publish-timeout.png)

### XML for This Example

Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:scripting="http://www.mulesoft.org/schema/mule/scripting"
	xmlns:tls="http://www.mulesoft.org/schema/mule/tls" xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns:os="http://www.mulesoft.org/schema/mule/os"
	xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core" xmlns:salesforce-pub-sub="http://www.mulesoft.org/schema/mule/salesforce-pub-sub" 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/scripting http://www.mulesoft.org/schema/mule/scripting/current/mule-scripting.xsd http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/salesforce-pub-sub http://www.mulesoft.org/schema/mule/salesforce-pub-sub/current/mule-salesforce-pub-sub.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/os http://www.mulesoft.org/schema/mule/os/current/mule-os.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/tls http://www.mulesoft.org/schema/mule/tls/current/mule-tls.xsd">
	<salesforce-pub-sub:pubsub-config name="insecureSalesforce_PubSub_Config" doc:name="Salesforce PubSub Config"  >
		<salesforce-pub-sub:oauth-user-pass-connection consumerKey="&lt;CONSUMER_KEY&gt;" consumerSecret="&lt;CONSUMER_SECRET&gt;" username="&lt;USERNAME&gt;" password="&lt;USERNAME&gt;" securityToken="&lt;SECURITY_TOKEN&gt;" tokenEndpoint="&lt;TOKEN_ENDPOINT&gt;" host="&lt;GRPC_HOST&gt;" port="0000" publishRequestTimeout="60" >
		</salesforce-pub-sub:oauth-user-pass-connection>
	</salesforce-pub-sub:pubsub-config>

	<os:object-store name="replayObjectStore" doc:name="Object store"  entryTtlUnit="DAYS" expirationIntervalUnit="DAYS" entryTtl="1"/>


	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config"  >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
	<flow name="ytaoka-salesforce-pubsublistenerFlow1"  initialState="started">
		<http:listener doc:name="Listener"  config-ref="HTTP_Listener_config" path="/publish"/>

	 <logger level="INFO" doc:name="Logger"  message="Before Publish" />
		<salesforce-pub-sub:publish-event config-ref="insecureSalesforce_PubSub_Config" topic="/event/gRPCMunitTestDoNotDelete__e">
        </salesforce-pub-sub:publish-event>
		<logger level="INFO" doc:name="Logger"  message="After Publish"/>
	</flow>
</mule>
```

## Subscribe to a Channel

This example Mule flow subscribes to a channel and uses the following operations:

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

  Enter the following values:

  <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p><strong>Channel name</strong></p></td><td><div><div><p>Name of the streaming channel to subscribe to, for example, <code>/event/gRPCMunitTestDoNotDelete__e</code></p></div></div></td></tr><tr><td><p><strong>Replay option</strong></p></td><td><div><div><p>One of the given implementations, for example, <code>Earliest</code>. For more information on how to use <code>Replay id from object store</code> in <strong>Replay option</strong>, refer to <a href="https://docs.mulesoft.com/salesforce-pubsub-connector/latest/salesforce-pubsub-connector-studio#store-objectstore">Store the Replay ID in the Object Store</a>.</p></div></div></td></tr><tr><td><p><strong>Batch events size</strong></p></td><td><div><div><p>Total number of events included in a server batch. Lower values indicate small memory footprint with more server calls, while bigger values indicate bigger memory footprint with fewer API calls. A new batch of events is requested by the connector after the flow consumes the existing events, for example, <code>1000</code></p></div></div></td></tr></tbody></table>

- **Logger**  
  Shows the HTTP response from the **Subscribe channel listener** source

![Studio flow for the Subscribe channel listener source](/mulesoft/current/en-us/salesforce-pubsub-connector/latest/_images/subscribe-to-a-channel.png)

### XML for This Example

Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	  xmlns:http="http://www.mulesoft.org/schema/mule/http" xmlns:salesforce-pub-sub="http://www.mulesoft.org/schema/mule/salesforce-pub-sub" 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/salesforce-pub-sub http://www.mulesoft.org/schema/mule/salesforce-pub-sub/current/mule-salesforce-pub-sub.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/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">

	<configuration-properties file="mule-app.properties"/>

	<salesforce-pub-sub:pubsub-config name="Salesforce_PubSub_Config" >
		<salesforce-pub-sub:basic-connection username="${m4-config.username}" password="${m4-config.password}" securityToken="${m4-config.securityToken}" url="${m4-config.url}"/>
	</salesforce-pub-sub:pubsub-config>

	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="3805c5f1-0f01-476a-a619-a03f34dadfdd" >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>

	<flow name="mule-salesforce-pubsub-connector-subscribe-channel-demo" doc:id="4faf2bf8-e2af-43bc-bba8-d336761800dd" >
		<salesforce-pub-sub:subscribe-channel-listener channelName="/event/gRPCMunitTestDoNotDelete__e" config-ref="Salesforce_PubSub_Config" eventBatchSize="1000">
			<salesforce-pub-sub:replay-option >
				<salesforce-pub-sub:earliest />
			</salesforce-pub-sub:replay-option>
		</salesforce-pub-sub:subscribe-channel-listener>
		<logger level="INFO" doc:name="Logger" doc:id="21652e14-de84-4752-a9b9-871dc346befb" message="#[payload]"/>
	</flow>
</mule>
```

## See Also

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

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

<!-- document id=0a7c8261ed30145a597203518a0e482496c164b848f1d6a4392d05ef40aea83b url=/mulesoft/current/en-us/salesforce-pubsub-connector/latest/salesforce-pubsub-connector-reference.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.4
is-latest-version: true
---

# Salesforce Pub/Sub Connector 1.4 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_OauthClientCredentials">OAuth Client Credentials</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. Note that the <code>Basic Authentication</code> connection type is only supported for Salesforce API v64.0 and earlier versions.</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. Note that the `Basic Authentication` connection
type is only supported for Salesforce API v64.0 and earlier versions.

<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>30</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>60</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>Publish Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time the client waits for a publish request to complete before timing out. Values less than one millisecond are converted to 0 (no deadline).</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Publish 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>Publish Request Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies how often the inactivity watchdog scheduler checks each subscriber for activity. If the scheduler detects no activity on a subscriber’s channel since the previous check, it triggers a controlled resubscription so that the subscriber can continue receiving events. Values less than or equal to 0, including blank entries, disable the inactivity watchdog.</p></td><td></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler 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>Inactivity Watchdog Scheduler Frequency</strong> field.</p></td><td><p><code>SECONDS</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>

> [!NOTE] The Inactivity Watchdog Scheduler is a safety mechanism that detects subscribers that stop
> receiving events, for example after an unexpected gRPC stream closure, and triggers a controlled
> resubscription so event delivery can resume without restarting the Mule app. Configure the
> inactivity watchdog when subscribers in your environment occasionally stop receiving events even
> though the connection appears healthy.
>
> The Inactivity Watchdog Scheduler runs only when both **Inactivity Watchdog Scheduler Frequency**
> and **Inactivity Watchdog Scheduler Time Unit** are set. Leaving either field unset disables the
> scheduler. Set the frequency based on how often you expect to receive events. If you expect
> frequent events, a short frequency such as 5 minutes is appropriate. For lower-volume event
> streams, set a longer interval to avoid unnecessary resubscriptions.

### 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>30</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>60</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>Publish Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time the client waits for a publish request to complete before timing out. Values less than one millisecond are converted to 0 (no deadline).</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Publish 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>Publish Request Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies how often the inactivity watchdog scheduler checks each subscriber for activity. If the scheduler detects no activity on a subscriber’s channel since the previous check, it triggers a controlled resubscription so that the subscriber can continue receiving events. Values less than or equal to 0, including blank entries, disable the inactivity watchdog.</p></td><td></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler 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>Inactivity Watchdog Scheduler Frequency</strong> field.</p></td><td><p><code>SECONDS</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>

> [!NOTE] The Inactivity Watchdog Scheduler is a safety mechanism that detects subscribers that stop
> receiving events, for example after an unexpected gRPC stream closure, and triggers a controlled
> resubscription so event delivery can resume without restarting the Mule app. Configure the
> inactivity watchdog when subscribers in your environment occasionally stop receiving events even
> though the connection appears healthy.
>
> The Inactivity Watchdog Scheduler runs only when both **Inactivity Watchdog Scheduler Frequency**
> and **Inactivity Watchdog Scheduler Time Unit** are set. Leaving either field unset disables the
> scheduler. Set the frequency based on how often you expect to receive events. If you expect
> frequent events, a short frequency such as 5 minutes is appropriate. For lower-volume event
> streams, set a longer interval to avoid unnecessary resubscriptions.

### OAuth JWT 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).

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>30</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>60</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>Publish Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time the client waits for a publish request to complete before timing out. Values less than one millisecond are converted to 0 (no deadline).</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Publish 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>Publish Request Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies how often the inactivity watchdog scheduler checks each subscriber for activity. If the scheduler detects no activity on a subscriber’s channel since the previous check, it triggers a controlled resubscription so that the subscriber can continue receiving events. Values less than or equal to 0, including blank entries, disable the inactivity watchdog.</p></td><td></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler 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>Inactivity Watchdog Scheduler Frequency</strong> field.</p></td><td><p><code>SECONDS</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>

> [!NOTE] The Inactivity Watchdog Scheduler is a safety mechanism that detects subscribers that stop
> receiving events, for example after an unexpected gRPC stream closure, and triggers a controlled
> resubscription so event delivery can resume without restarting the Mule app. Configure the
> inactivity watchdog when subscribers in your environment occasionally stop receiving events even
> though the connection appears healthy.
>
> The Inactivity Watchdog Scheduler runs only when both **Inactivity Watchdog Scheduler Frequency**
> and **Inactivity Watchdog Scheduler Time Unit** are set. Leaving either field unset disables the
> scheduler. Set the frequency based on how often you expect to receive events. If you expect
> frequent events, a short frequency such as 5 minutes is appropriate. For lower-volume event
> streams, set a longer interval to avoid unnecessary resubscriptions.

### OAuth Client Credentials 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).

Uses OAuth 2.0 with the client credentials grant type for authentication. The token lifecycle is
delegated to Mule runtime, which performs the client credentials token exchange, caches the access
token, and refreshes it on expiry. The connected app must be configured in Salesforce to enable the
Client Credentials flow with an execution-as user, and the token endpoint must be the org’s
My-Domain endpoint.

<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>30</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>60</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>Publish Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time the client waits for a publish request to complete before timing out. Values less than one millisecond are converted to 0 (no deadline).</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Publish 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>Publish Request Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies how often the inactivity watchdog scheduler checks each subscriber for activity. If the scheduler detects no activity on a subscriber’s channel since the previous check, it triggers a controlled resubscription so that the subscriber can continue receiving events. Values less than or equal to 0, including blank entries, disable the inactivity watchdog.</p></td><td></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler 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>Inactivity Watchdog Scheduler Frequency</strong> field.</p></td><td><p><code>SECONDS</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>Client Id</p></td><td><div><div><p>String</p></div></div></td><td><p>OAuth client ID, as registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Client Secret</p></td><td><div><div><p>String</p></div></div></td><td><p>OAuth client secret, as registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Token Url</p></td><td><div><div><p>String</p></div></div></td><td><p>URL of the service provider’s 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>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>

> [!NOTE] The Inactivity Watchdog Scheduler is a safety mechanism that detects subscribers that stop
> receiving events, for example after an unexpected gRPC stream closure, and triggers a controlled
> resubscription so event delivery can resume without restarting the Mule app. Configure the
> inactivity watchdog when subscribers in your environment occasionally stop receiving events even
> though the connection appears healthy.
>
> The Inactivity Watchdog Scheduler runs only when both **Inactivity Watchdog Scheduler Frequency**
> and **Inactivity Watchdog Scheduler Time Unit** are set. Leaving either field unset disables the
> scheduler. Set the frequency based on how often you expect to receive events. If you expect
> frequent events, a short frequency such as 5 minutes is appropriate. For lower-volume event
> streams, set a longer interval to avoid unnecessary resubscriptions.

### 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>30</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>60</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>Publish Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time the client waits for a publish request to complete before timing out. Values less than one millisecond are converted to 0 (no deadline).</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Publish 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>Publish Request Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies how often the inactivity watchdog scheduler checks each subscriber for activity. If the scheduler detects no activity on a subscriber’s channel since the previous check, it triggers a controlled resubscription so that the subscriber can continue receiving events. Values less than or equal to 0, including blank entries, disable the inactivity watchdog.</p></td><td></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler 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>Inactivity Watchdog Scheduler Frequency</strong> field.</p></td><td><p><code>SECONDS</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>

> [!NOTE] The Inactivity Watchdog Scheduler is a safety mechanism that detects subscribers that stop
> receiving events, for example after an unexpected gRPC stream closure, and triggers a controlled
> resubscription so event delivery can resume without restarting the Mule app. Configure the
> inactivity watchdog when subscribers in your environment occasionally stop receiving events even
> though the connection appears healthy.
>
> The Inactivity Watchdog Scheduler runs only when both **Inactivity Watchdog Scheduler Frequency**
> and **Inactivity Watchdog Scheduler Time Unit** are set. Leaving either field unset disables the
> scheduler. Set the frequency based on how often you expect to receive events. If you expect
> frequent events, a short frequency such as 5 minutes is appropriate. For lower-volume event
> streams, set a longer interval to avoid unnecessary resubscriptions.

### OAuth SAML 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).

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>30</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>60</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>Publish Request Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the amount of time the client waits for a publish request to complete before timing out. Values less than one millisecond are converted to 0 (no deadline).</p></td><td><p><code>0</code></p></td><td></td></tr><tr><td><p>Publish 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>Publish Request Timeout</strong> field.</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies how often the inactivity watchdog scheduler checks each subscriber for activity. If the scheduler detects no activity on a subscriber’s channel since the previous check, it triggers a controlled resubscription so that the subscriber can continue receiving events. Values less than or equal to 0, including blank entries, disable the inactivity watchdog.</p></td><td></td><td></td></tr><tr><td><p>Inactivity Watchdog Scheduler 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>Inactivity Watchdog Scheduler Frequency</strong> field.</p></td><td><p><code>SECONDS</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>

> [!NOTE] The Inactivity Watchdog Scheduler is a safety mechanism that detects subscribers that stop
> receiving events, for example after an unexpected gRPC stream closure, and triggers a controlled
> resubscription so event delivery can resume without restarting the Mule app. Configure the
> inactivity watchdog when subscribers in your environment occasionally stop receiving events even
> though the connection appears healthy.
>
> The Inactivity Watchdog Scheduler runs only when both **Inactivity Watchdog Scheduler Frequency**
> and **Inactivity Watchdog Scheduler Time Unit** are set. Leaving either field unset disables the
> scheduler. Set the frequency based on how often you expect to receive events. If you expect
> frequent events, a short frequency such as 5 minutes is appropriate. For lower-volume event
> streams, set a longer interval to avoid unnecessary resubscriptions.

## 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.
>
> - When using OAuth 2.0 authentication, the source isn’t initialized during the initial application
>   startup. You must complete the OAuth authorization process and then restart the application to
>   successfully initialize the source and begin receiving events.

<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/latest/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>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Maps error types thrown by this operation to custom error types.</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>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)

- [Error Mapping](#ErrorMapping)

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

### Error Mapping

Maps source error types to custom error types 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>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><p>Source error type to map.</p></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><p>Custom error type to map the source error to.</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)

<!-- document id=69a053d9d3b5de9a015f4c3bacd790cdcea71693b21447e0b1569e3d30756d87 url=/mulesoft/current/en-us/salesforce-pubsub-connector/1.0/salesforce-pubsub-connector-studio.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.0
---

# Using Anypoint Studio to Configure Salesforce Pub/Sub 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, refer to
[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, refer to
the [Salesforce Pub/Sub Connector Reference](https://docs.mulesoft.com/salesforce-pubsub-connector/1.0/salesforce-pubsub-connector-reference).

## Create a Mule Project

In Studio, create a new Mule project in which to add and configure the 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 Salesforce Pub/Sub 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 `Salesforce Pub/Sub` in the search field.

3.  Click <Salesforce Pub/Sub> in **Available modules**.

4.  Click **Add**.

5.  Click **Finish**.

Adding a connector to a Mule project in Studio does not 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 Salesforce Pub/Sub Connector:

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

- 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 a **Subscribe channel listener** source, follow these steps:

1.  In the **Mule Palette** view, select **Subscribe channel listener**.

2.  Drag **Subscribe channel listener** to the Studio canvas.

3.  Optionally change the value of the **Display Name** field.

4.  Select a **Channel Name** from the dropdown field.

5.  Select a **Replay Option** from the four types available:

    - `Latest`

      Subscriber receives new events that are broadcast after the client subscribes.

    - `Earliest`

      Subscriber receives all events, including past events that are within the retention window of
      the server and new events sent after subscription.

    - `Custom replay id`

      Subscriber receives only events with a replay ID higher than the specified value.

    - `Replay id from object store`

      Subscriber receives only events with a replay ID higher than the specified value in object
      store. If no value is found, it defaults to `Earliest`. Provide values for the **Object Store
      Name** and the **Object Store Key** fields to connect to the desired object store and retrieve
      the replay ID value. For more information on how to use `Replay id from object store`, refer
      to [Store the Replay ID in the Object Store](#store-objectstore).

6.  Optionally, specify a value for the **Batch events size** field.

7.  Click the plus sign (**+**) next to the **Connector configuration** field to configure a global
    element that can be used by all instances of the **Subscribe channel listener** source in the
    app.

8.  In the **Security** tab, optionally specify the TLS information for the connector.

9.  In the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

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

11. Click **OK**.

### Store the Replay ID in the Object Store

To use the `Replay id from object store` option for the **Subscribe channel listener** source, you
must first save the replay ID value in the object store:

1.  Add the **Subscribe channel listener** source, as described in
    [Configure a Source](#configure-source), to the Studio flow.

2.  In the **Mule Palette** view, select **Store** from **Object Store Connector**.

3.  Drag **Store** to the Studio canvas.

4.  Optionally change the value of the **Display Name** field.

5.  Add a value for the **Key** field, such as replay ID. This is the key that is used later, when
    retrieving the replay ID from the object store.

6.  Set a value for the **Value** field. This is the replay ID value that you want to store. In this
    example, it is `payload.replayId`.

7.  Optionally, change the default values for the **Fail if present** and **Fail on null value**
    fields. The value for **Fail if present** must always be `false` as you must use the same key to
    store a new value for the replay ID.

8.  Click the plus sign (**+**) next to the **Object store** field to configure the object store.
    This is the object store in which the replay ID value is stored and from where the source
    retrieves the replay ID value.

9.  The values declared here for the **Object store** and **Key** fields are the same values that
    are used for the `Replay id from object store` option on the source.

## 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 Salesforce Pub/Sub Connector, follow these steps:

1.  In **Mule Palette**, select **Salesforce Pub/Sub** and then select the desired operation.

2.  Drag the operation onto the Studio canvas, next to the input 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 Salesforce Pub/Sub system. Salesforce Pub/Sub
Connector supports Basic Authentication, OAuth v2.0, OAuth JWT, OAuth Username Password, and OAuth
SAML.

To configure the global element for Salesforce Pub/Sub Connector, follow these steps:

1.  Select the operation in the Studio canvas.

2.  In the **General** configuration screen for the operation, click the **Add** icon to access the
    global element configuration fields.

3.  In the **General** tab, in **Connection**, select the authentication method to configure:

    - [Basic Authentication](#basic-authentication)

    - [OAuth v2.0](#oauth2)

    - [OAuth JWT](#oauth-jwt)

    - [OAuth Username Password](#oauth-username-password)

    - [OAuth SAML](#oauth-saml)

    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, refer to
    [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview).

4.  In the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

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

6.  Click **OK**.

### Basic Authentication

Enter the following information in the **General** tab of the **Global Element Properties** screen
to configure Basic Authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>Basic Authentication</strong>.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring Basic Authentication:

![Basic Authentication selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/1.0/_images/basic-authentication.png)

### OAuth v2.0

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

Enter the following information on the **General** tab of the global element configuration screen to
configure OAuth v2.0 authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>OAuth v2.0</strong>.</p></div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>Enter the OAuth consumer key, as registered with the service provider.</p></div></div></td></tr><tr><td><p><strong>Consumer Secret</strong></p></td><td><div><div><p>Enter the OAuth consumer secret, as registered with the service provider.</p></div></div></td></tr><tr><td><p><strong>Listener Config</strong></p></td><td><div><div><p>Enter the configuration for the HTTP listener that listens for requests on the access token callback endpoint.</p></div></div></td></tr><tr><td><p><strong>Callback Path</strong></p></td><td><div><div><p>Enter the path of the access token callback endpoint.</p></div></div></td></tr><tr><td><p><strong>Authorize Path</strong></p></td><td><div><div><p>Enter the path of the local HTTP endpoint that triggers the OAuth dance.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring OAuth v2.0 authentication:

![OAuth v2.0 selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/1.0/_images/oauth2.png)

### OAuth JWT

Enter the following information on the **General** tab of the global element configuration screen to
configure OAuth JWT authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>OAuth JWT</strong>.</p></div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>Enter the consumer key for the Salesforce connected app.</p></div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p>Enter the path to the keystore used to sign data during authentication.</p></div></div></td></tr><tr><td><p><strong>Store Password</strong></p></td><td><div><div><p>Enter the password of the keystore.</p></div></div></td></tr><tr><td><p><strong>Principal</strong></p></td><td><div><div><p>Enter the username of the desired Salesforce user to take action on behalf of.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring OAuth JWT authentication:

![OAuth JWT selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/1.0/_images/oauth-jwt.png)

### OAuth Username Password

Enter the following information on the **General** tab of the global element configuration screen to
configure OAuth Username Password authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>OAuth Username Password</strong>.</p></div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>Enter the consumer key for the Salesforce connected app.</p></div></div></td></tr><tr><td><p><strong>Consumer Secret</strong></p></td><td><div><div><p>Enter your application’s client secret (consumer secret in Remote Access Detail).</p></div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>Enter the username used to initialize the session.</p></div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>Enter the password used to authenticate the user.</p></div></div></td></tr><tr><td><p><strong>Principal</strong></p></td><td><div><div><p>Enter the username of the desired Salesforce user to take action on behalf of.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring OAuth Username Password authentication:

![OAuth Username Password is selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/1.0/_images/oauth-username-password.png)

### OAuth SAML

Enter the following information on the **General** tab of the global element configuration screen to
configure OAuth SAML authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>OAuth SAML</strong>.</p></div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>Enter the consumer key for the Salesforce connected app.</p></div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p>Enter the path to the keystore used to sign data during authentication.</p></div></div></td></tr><tr><td><p><strong>Store Password</strong></p></td><td><div><div><p>Enter the password of the keystore.</p></div></div></td></tr><tr><td><p><strong>Principal</strong></p></td><td><div><div><p>Enter the username of the desired Salesforce user to take action on behalf of.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring OAuth SAML authentication:

![OAuth SAML selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/1.0/_images/oauth-saml.png)

## Configure Additional Connector Fields

After you configure a global element for Salesforce Pub/Sub Connector, configure the other required
fields for the connector. 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 goes to the Anypoint Studio
  console window.

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

Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also access 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 Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Salesforce Pub/Sub Connector Reference](https://docs.mulesoft.com/salesforce-pubsub-connector/1.0/salesforce-pubsub-connector-reference)

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

<!-- document id=f53aebc17c460a616249d867ef5427051c24cd45140980d062dac4e67a3b2d8c url=/mulesoft/current/en-us/salesforce-pubsub-connector/1.1/salesforce-pubsub-connector-studio.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.1
---

# Using Anypoint Studio to Configure Salesforce Pub/Sub 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, refer to
[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, refer to
the [Salesforce Pub/Sub Connector Reference](https://docs.mulesoft.com/salesforce-pubsub-connector/1.1/salesforce-pubsub-connector-reference).

## Create a Mule Project

In Studio, create a new Mule project in which to add and configure the 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 Salesforce Pub/Sub 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 `Salesforce Pub/Sub` in the search field.

3.  Click <Salesforce Pub/Sub> in **Available modules**.

4.  Click **Add**.

5.  Click **Finish**.

Adding a connector to a Mule project in Studio does not 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 Salesforce Pub/Sub Connector:

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

- 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 a **Subscribe channel listener** source, follow these steps:

1.  In the **Mule Palette** view, select **Subscribe channel listener**.

2.  Drag **Subscribe channel listener** to the Studio canvas.

3.  Optionally change the value of the **Display Name** field.

4.  Select a **Channel Name** from the dropdown field.

5.  Select a **Replay Option** from the four types available:

    - `Latest`

      Subscriber receives new events that are broadcast after the client subscribes.

    - `Earliest`

      Subscriber receives all events, including past events that are within the retention window of
      the server and new events sent after subscription.

    - `Custom replay id`

      Subscriber receives only events with a replay ID higher than the specified value.

    - `Replay id from object store`

      Subscriber receives only events with a replay ID higher than the specified value in object
      store. If no value is found, it defaults to `Earliest`. Provide values for the **Object Store
      Name** and the **Object Store Key** fields to connect to the desired object store and retrieve
      the replay ID value. For more information on how to use `Replay id from object store`, refer
      to [Store the Replay ID in the Object Store](#store-objectstore).

6.  Optionally, specify a value for the **Batch events size** field.

7.  Click the plus sign (**+**) next to the **Connector configuration** field to configure a global
    element that can be used by all instances of the **Subscribe channel listener** source in the
    app.

8.  In the **Security** tab, optionally specify the TLS information for the connector.

9.  In the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

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

11. Click **OK**.

### Store the Replay ID in the Object Store

To use the `Replay id from object store` option for the **Subscribe channel listener** source, you
must first save the replay ID value in the object store:

1.  Add the **Subscribe channel listener** source, as described in
    [Configure a Source](#configure-source), to the Studio flow.

2.  In the **Mule Palette** view, select **Store** from **Object Store Connector**.

3.  Drag **Store** to the Studio canvas.

4.  Optionally change the value of the **Display Name** field.

5.  Add a value for the **Key** field, such as replay ID. This is the key that is used later, when
    retrieving the replay ID from the object store.

6.  Set a value for the **Value** field. This is the replay ID value that you want to store. In this
    example, it is `payload.replayId`.

7.  Optionally, change the default values for the **Fail if present** and **Fail on null value**
    fields. The value for **Fail if present** must always be `false` as you must use the same key to
    store a new value for the replay ID.

8.  Click the plus sign (**+**) next to the **Object store** field to configure the object store.
    This is the object store in which the replay ID value is stored and from where the source
    retrieves the replay ID value.

9.  The values declared here for the **Object store** and **Key** fields are the same values that
    are used for the `Replay id from object store` option on the source.

## 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 Salesforce Pub/Sub Connector, follow these steps:

1.  In **Mule Palette**, select **Salesforce Pub/Sub** and then select the desired operation.

2.  Drag the operation onto the Studio canvas, next to the input 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 Salesforce Pub/Sub system. Salesforce Pub/Sub
Connector supports Basic Authentication, OAuth v2.0, OAuth JWT, OAuth Username Password, and OAuth
SAML.

To configure the global element for Salesforce Pub/Sub Connector, follow these steps:

1.  Select the operation in the Studio canvas.

2.  In the **General** configuration screen for the operation, click the **Add** icon to access the
    global element configuration fields.

3.  In the **General** tab, in **Connection**, select the authentication method to configure:

    - [Basic Authentication](#basic-authentication)

    - [OAuth v2.0](#oauth2)

    - [OAuth JWT](#oauth-jwt)

    - [OAuth Username Password](#oauth-username-password)

    - [OAuth SAML](#oauth-saml)

    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, refer to
    [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview).

4.  In the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

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

6.  Click **OK**.

### Basic Authentication

Enter the following information in the **General** tab of the **Global Element Properties** screen
to configure Basic Authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>Basic Authentication</strong>.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring Basic Authentication:

![Basic Authentication selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/1.1/_images/basic-authentication.png)

### OAuth v2.0

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

Enter the following information on the **General** tab of the global element configuration screen to
configure OAuth v2.0 authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>OAuth v2.0</strong>.</p></div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>Enter the OAuth consumer key, as registered with the service provider.</p></div></div></td></tr><tr><td><p><strong>Consumer Secret</strong></p></td><td><div><div><p>Enter the OAuth consumer secret, as registered with the service provider.</p></div></div></td></tr><tr><td><p><strong>Listener Config</strong></p></td><td><div><div><p>Enter the configuration for the HTTP listener that listens for requests on the access token callback endpoint.</p></div></div></td></tr><tr><td><p><strong>Callback Path</strong></p></td><td><div><div><p>Enter the path of the access token callback endpoint.</p></div></div></td></tr><tr><td><p><strong>Authorize Path</strong></p></td><td><div><div><p>Enter the path of the local HTTP endpoint that triggers the OAuth dance.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring OAuth v2.0 authentication:

![OAuth v2.0 selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/1.1/_images/oauth2.png)

### OAuth JWT

Enter the following information on the **General** tab of the global element configuration screen to
configure OAuth JWT authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>OAuth JWT</strong>.</p></div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>Enter the consumer key for the Salesforce connected app.</p></div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p>Enter the path to the keystore used to sign data during authentication.</p></div></div></td></tr><tr><td><p><strong>Store Password</strong></p></td><td><div><div><p>Enter the password of the keystore.</p></div></div></td></tr><tr><td><p><strong>Principal</strong></p></td><td><div><div><p>Enter the username of the desired Salesforce user to take action on behalf of.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring OAuth JWT authentication:

![OAuth JWT selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/1.1/_images/oauth-jwt.png)

### OAuth Username Password

Enter the following information on the **General** tab of the global element configuration screen to
configure OAuth Username Password authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>OAuth Username Password</strong>.</p></div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>Enter the consumer key for the Salesforce connected app.</p></div></div></td></tr><tr><td><p><strong>Consumer Secret</strong></p></td><td><div><div><p>Enter your application’s client secret (consumer secret in Remote Access Detail).</p></div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>Enter the username used to initialize the session.</p></div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>Enter the password used to authenticate the user.</p></div></div></td></tr><tr><td><p><strong>Principal</strong></p></td><td><div><div><p>Enter the username of the desired Salesforce user to take action on behalf of.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring OAuth Username Password authentication:

![OAuth Username Password is selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/1.1/_images/oauth-username-password.png)

### OAuth SAML

Enter the following information on the **General** tab of the global element configuration screen to
configure OAuth SAML authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>OAuth SAML</strong>.</p></div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>Enter the consumer key for the Salesforce connected app.</p></div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p>Enter the path to the keystore used to sign data during authentication.</p></div></div></td></tr><tr><td><p><strong>Store Password</strong></p></td><td><div><div><p>Enter the password of the keystore.</p></div></div></td></tr><tr><td><p><strong>Principal</strong></p></td><td><div><div><p>Enter the username of the desired Salesforce user to take action on behalf of.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring OAuth SAML authentication:

![OAuth SAML selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/1.1/_images/oauth-saml.png)

## Configure Additional Connector Fields

After you configure a global element for Salesforce Pub/Sub Connector, configure the other required
fields for the connector. 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 goes to the Anypoint Studio
  console window.

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

Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also access 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 Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Salesforce Pub/Sub Connector Reference](https://docs.mulesoft.com/salesforce-pubsub-connector/1.1/salesforce-pubsub-connector-reference)

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

<!-- document id=06c0dbbe604f7800d07bf98896d26790bcca7b20dd4c3e411680588c80f02826 url=/mulesoft/current/en-us/salesforce-pubsub-connector/1.2/salesforce-pubsub-connector-studio.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.2
---

# Using Anypoint Studio to Configure Salesforce Pub/Sub 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, refer to
[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, refer to
the [Salesforce Pub/Sub Connector Reference](https://docs.mulesoft.com/salesforce-pubsub-connector/1.2/salesforce-pubsub-connector-reference).

## Create a Mule Project

In Studio, create a new Mule project in which to add and configure the 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 Salesforce Pub/Sub 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 `Salesforce Pub/Sub` in the search field.

3.  Click <Salesforce Pub/Sub> in **Available modules**.

4.  Click **Add**.

5.  Click **Finish**.

Adding a connector to a Mule project in Studio does not 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 Salesforce Pub/Sub Connector:

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

- 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 a **Subscribe channel listener** source, follow these steps:

1.  In the **Mule Palette** view, select **Subscribe channel listener**.

2.  Drag **Subscribe channel listener** to the Studio canvas.

3.  Optionally change the value of the **Display Name** field.

4.  Select a **Channel Name** from the dropdown field.

5.  Select a **Replay Option** from the four types available:

    - `Latest`

      Subscriber receives new events that are broadcast after the client subscribes.

    - `Earliest`

      Subscriber receives all events, including past events that are within the retention window of
      the server and new events sent after subscription.

    - `Custom replay id`

      Subscriber receives only events with a replay ID higher than the specified value.

    - `Replay id from object store`

      Subscriber receives only events with a replay ID higher than the specified value in object
      store. If no value is found, it defaults to `Earliest`. Provide values for the **Object Store
      Name** and the **Object Store Key** fields to connect to the desired object store and retrieve
      the replay ID value. For more information on how to use `Replay id from object store`, refer
      to [Store the Replay ID in the Object Store](#store-objectstore).

6.  Optionally, specify a value for the **Batch events size** field.

7.  Click the plus sign (**+**) next to the **Connector configuration** field to configure a global
    element that can be used by all instances of the **Subscribe channel listener** source in the
    app.

8.  In the **Security** tab, optionally specify the TLS information for the connector.

9.  In the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

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

11. Click **OK**.

### Store the Replay ID in the Object Store

To use the `Replay id from object store` option for the **Subscribe channel listener** source, you
must first save the replay ID value in the object store:

1.  Add the **Subscribe channel listener** source, as described in
    [Configure a Source](#configure-source), to the Studio flow.

2.  In the **Mule Palette** view, select **Store** from **Object Store Connector**.

3.  Drag **Store** to the Studio canvas.

4.  Optionally change the value of the **Display Name** field.

5.  Add a value for the **Key** field, such as replay ID. This is the key that is used later, when
    retrieving the replay ID from the object store.

6.  Set a value for the **Value** field. This is the replay ID value that you want to store. In this
    example, it is `payload.replayId`.

7.  Optionally, change the default values for the **Fail if present** and **Fail on null value**
    fields. The value for **Fail if present** must always be `false` as you must use the same key to
    store a new value for the replay ID.

8.  Click the plus sign (**+**) next to the **Object store** field to configure the object store.
    This is the object store in which the replay ID value is stored and from where the source
    retrieves the replay ID value.

9.  The values declared here for the **Object store** and **Key** fields are the same values that
    are used for the `Replay id from object store` option on the source.

## 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 Salesforce Pub/Sub Connector, follow these steps:

1.  In **Mule Palette**, select **Salesforce Pub/Sub** and then select the desired operation.

2.  Drag the operation onto the Studio canvas, next to the input 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 Salesforce Pub/Sub system. Salesforce Pub/Sub
Connector supports Basic Authentication, OAuth v2.0, OAuth JWT, OAuth Username Password, and OAuth
SAML.

> [!NOTE] The `Basic Authentication` connection type is only supported for Salesforce API v64.0 and
> earlier versions.

To configure the global element for Salesforce Pub/Sub Connector, follow these steps:

1.  Select the operation in the Studio canvas.

2.  In the **General** configuration screen for the operation, click the **Add** icon to access the
    global element configuration fields.

3.  In the **General** tab, in **Connection**, select the authentication method to configure:

    - [Basic Authentication](#basic-authentication)

    - [OAuth v2.0](#oauth2)

    - [OAuth JWT](#oauth-jwt)

    - [OAuth Username Password](#oauth-username-password)

    - [OAuth SAML](#oauth-saml)

    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, refer to
    [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview).

4.  In the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

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

6.  Click **OK**.

### Basic Authentication

Enter the following information in the **General** tab of the **Global Element Properties** screen
to configure Basic Authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>Basic Authentication</strong>.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring Basic Authentication:

![Basic Authentication selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/1.2/_images/basic-authentication.png)

### OAuth v2.0

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

Enter the following information on the **General** tab of the global element configuration screen to
configure OAuth v2.0 authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>OAuth v2.0</strong>.</p></div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>Enter the OAuth consumer key, as registered with the service provider.</p></div></div></td></tr><tr><td><p><strong>Consumer Secret</strong></p></td><td><div><div><p>Enter the OAuth consumer secret, as registered with the service provider.</p></div></div></td></tr><tr><td><p><strong>Listener Config</strong></p></td><td><div><div><p>Enter the configuration for the HTTP listener that listens for requests on the access token callback endpoint.</p></div></div></td></tr><tr><td><p><strong>Callback Path</strong></p></td><td><div><div><p>Enter the path of the access token callback endpoint.</p></div></div></td></tr><tr><td><p><strong>Authorize Path</strong></p></td><td><div><div><p>Enter the path of the local HTTP endpoint that triggers the OAuth dance.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring OAuth v2.0 authentication:

![OAuth v2.0 selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/1.2/_images/oauth2.png)

### OAuth JWT

Enter the following information on the **General** tab of the global element configuration screen to
configure OAuth JWT authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>OAuth JWT</strong>.</p></div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>Enter the consumer key for the Salesforce connected app.</p></div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p>Enter the path to the keystore used to sign data during authentication.</p></div></div></td></tr><tr><td><p><strong>Store Password</strong></p></td><td><div><div><p>Enter the password of the keystore.</p></div></div></td></tr><tr><td><p><strong>Principal</strong></p></td><td><div><div><p>Enter the username of the desired Salesforce user to take action on behalf of.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring OAuth JWT authentication:

![OAuth JWT selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/1.2/_images/oauth-jwt.png)

### OAuth Username Password

Enter the following information on the **General** tab of the global element configuration screen to
configure OAuth Username Password authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>OAuth Username Password</strong>.</p></div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>Enter the consumer key for the Salesforce connected app.</p></div></div></td></tr><tr><td><p><strong>Consumer Secret</strong></p></td><td><div><div><p>Enter your application’s client secret (consumer secret in Remote Access Detail).</p></div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>Enter the username used to initialize the session.</p></div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>Enter the password used to authenticate the user.</p></div></div></td></tr><tr><td><p><strong>Principal</strong></p></td><td><div><div><p>Enter the username of the desired Salesforce user to take action on behalf of.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring OAuth Username Password authentication:

![OAuth Username Password is selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/1.2/_images/oauth-username-password.png)

### OAuth SAML

Enter the following information on the **General** tab of the global element configuration screen to
configure OAuth SAML authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>OAuth SAML</strong>.</p></div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>Enter the consumer key for the Salesforce connected app.</p></div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p>Enter the path to the keystore used to sign data during authentication.</p></div></div></td></tr><tr><td><p><strong>Store Password</strong></p></td><td><div><div><p>Enter the password of the keystore.</p></div></div></td></tr><tr><td><p><strong>Principal</strong></p></td><td><div><div><p>Enter the username of the desired Salesforce user to take action on behalf of.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring OAuth SAML authentication:

![OAuth SAML selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/1.2/_images/oauth-saml.png)

## Configure Additional Connector Fields

After you configure a global element for Salesforce Pub/Sub Connector, configure the other required
fields for the connector. 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 goes to the Anypoint Studio
  console window.

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

Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also access 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 Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Salesforce Pub/Sub Connector Reference](https://docs.mulesoft.com/salesforce-pubsub-connector/1.2/salesforce-pubsub-connector-reference)

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

<!-- document id=49aec7e86c54332d146577a43a3b450f5b5027fd95f9a85bad4f3e1853bdf011 url=/mulesoft/current/en-us/salesforce-pubsub-connector/1.3/salesforce-pubsub-connector-studio.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.3
---

# Using Anypoint Studio to Configure Salesforce Pub/Sub 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, refer to
[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, refer to
the [Salesforce Pub/Sub Connector Reference](https://docs.mulesoft.com/salesforce-pubsub-connector/1.3/salesforce-pubsub-connector-reference).

## Create a Mule Project

In Studio, create a new Mule project in which to add and configure the 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 Salesforce Pub/Sub 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 `Salesforce Pub/Sub` in the search field.

3.  Click <Salesforce Pub/Sub> in **Available modules**.

4.  Click **Add**.

5.  Click **Finish**.

Adding a connector to a Mule project in Studio does not 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 Salesforce Pub/Sub Connector:

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

- 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 a **Subscribe channel listener** source, follow these steps:

1.  In the **Mule Palette** view, select **Subscribe channel listener**.

2.  Drag **Subscribe channel listener** to the Studio canvas.

3.  Optionally change the value of the **Display Name** field.

4.  Select a **Channel Name** from the dropdown field.

5.  Select a **Replay Option** from the four types available:

    - `Latest`

      Subscriber receives new events that are broadcast after the client subscribes.

    - `Earliest`

      Subscriber receives all events, including past events that are within the retention window of
      the server and new events sent after subscription.

    - `Custom replay id`

      Subscriber receives only events with a replay ID higher than the specified value.

    - `Replay id from object store`

      Subscriber receives only events with a replay ID higher than the specified value in object
      store. If no value is found, it defaults to `Earliest`. Provide values for the **Object Store
      Name** and the **Object Store Key** fields to connect to the desired object store and retrieve
      the replay ID value. For more information on how to use `Replay id from object store`, refer
      to [Store the Replay ID in the Object Store](#store-objectstore).

6.  Optionally, specify a value for the **Batch events size** field.

7.  Click the plus sign (**+**) next to the **Connector configuration** field to configure a global
    element that can be used by all instances of the **Subscribe channel listener** source in the
    app.

8.  In the **Security** tab, optionally specify the TLS information for the connector.

9.  In the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

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

11. Click **OK**.

### Store the Replay ID in the Object Store

To use the `Replay id from object store` option for the **Subscribe channel listener** source, you
must first save the replay ID value in the object store:

1.  Add the **Subscribe channel listener** source, as described in
    [Configure a Source](#configure-source), to the Studio flow.

2.  In the **Mule Palette** view, select **Store** from **Object Store Connector**.

3.  Drag **Store** to the Studio canvas.

4.  Optionally change the value of the **Display Name** field.

5.  Add a value for the **Key** field, such as replay ID. This is the key that is used later, when
    retrieving the replay ID from the object store.

6.  Set a value for the **Value** field. This is the replay ID value that you want to store. In this
    example, it is `payload.replayId`.

7.  Optionally, change the default values for the **Fail if present** and **Fail on null value**
    fields. The value for **Fail if present** must always be `false` as you must use the same key to
    store a new value for the replay ID.

8.  Click the plus sign (**+**) next to the **Object store** field to configure the object store.
    This is the object store in which the replay ID value is stored and from where the source
    retrieves the replay ID value.

9.  The values declared here for the **Object store** and **Key** fields are the same values that
    are used for the `Replay id from object store` option on the source.

## 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 Salesforce Pub/Sub Connector, follow these steps:

1.  In **Mule Palette**, select **Salesforce Pub/Sub** and then select the desired operation.

2.  Drag the operation onto the Studio canvas, next to the input 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 Salesforce Pub/Sub system. Salesforce Pub/Sub
Connector supports Basic Authentication, OAuth v2.0, OAuth JWT, OAuth Username Password, and OAuth
SAML.

> [!NOTE] The `Basic Authentication` connection type is only supported for Salesforce API v64.0 and
> earlier versions.

To configure the global element for Salesforce Pub/Sub Connector, follow these steps:

1.  Select the operation in the Studio canvas.

2.  In the **General** configuration screen for the operation, click the **Add** icon to access the
    global element configuration fields.

3.  In the **General** tab, in **Connection**, select the authentication method to configure:

    - [Basic Authentication](#basic-authentication)

    - [OAuth v2.0](#oauth2)

    - [OAuth JWT](#oauth-jwt)

    - [OAuth Username Password](#oauth-username-password)

    - [OAuth SAML](#oauth-saml)

    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, refer to
    [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview).

4.  In the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

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

6.  Click **OK**.

### Basic Authentication

Enter the following information in the **General** tab of the **Global Element Properties** screen
to configure Basic Authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>Basic Authentication</strong>.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring Basic Authentication:

![Basic Authentication selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/1.3/_images/basic-authentication.png)

### OAuth v2.0

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

Enter the following information on the **General** tab of the global element configuration screen to
configure OAuth v2.0 authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>OAuth v2.0</strong>.</p></div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>Enter the OAuth consumer key, as registered with the service provider.</p></div></div></td></tr><tr><td><p><strong>Consumer Secret</strong></p></td><td><div><div><p>Enter the OAuth consumer secret, as registered with the service provider.</p></div></div></td></tr><tr><td><p><strong>Listener Config</strong></p></td><td><div><div><p>Enter the configuration for the HTTP listener that listens for requests on the access token callback endpoint.</p></div></div></td></tr><tr><td><p><strong>Callback Path</strong></p></td><td><div><div><p>Enter the path of the access token callback endpoint.</p></div></div></td></tr><tr><td><p><strong>Authorize Path</strong></p></td><td><div><div><p>Enter the path of the local HTTP endpoint that triggers the OAuth dance.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring OAuth v2.0 authentication:

![OAuth v2.0 selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/1.3/_images/oauth2.png)

### OAuth JWT

Enter the following information on the **General** tab of the global element configuration screen to
configure OAuth JWT authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>OAuth JWT</strong>.</p></div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>Enter the consumer key for the Salesforce connected app.</p></div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p>Enter the path to the keystore used to sign data during authentication.</p></div></div></td></tr><tr><td><p><strong>Store Password</strong></p></td><td><div><div><p>Enter the password of the keystore.</p></div></div></td></tr><tr><td><p><strong>Principal</strong></p></td><td><div><div><p>Enter the username of the desired Salesforce user to take action on behalf of.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring OAuth JWT authentication:

![OAuth JWT selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/1.3/_images/oauth-jwt.png)

### OAuth Username Password

Enter the following information on the **General** tab of the global element configuration screen to
configure OAuth Username Password authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>OAuth Username Password</strong>.</p></div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>Enter the consumer key for the Salesforce connected app.</p></div></div></td></tr><tr><td><p><strong>Consumer Secret</strong></p></td><td><div><div><p>Enter your application’s client secret (consumer secret in Remote Access Detail).</p></div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>Enter the username used to initialize the session.</p></div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>Enter the password used to authenticate the user.</p></div></div></td></tr><tr><td><p><strong>Principal</strong></p></td><td><div><div><p>Enter the username of the desired Salesforce user to take action on behalf of.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring OAuth Username Password authentication:

![OAuth Username Password is selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/1.3/_images/oauth-username-password.png)

### OAuth SAML

Enter the following information on the **General** tab of the global element configuration screen to
configure OAuth SAML authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>OAuth SAML</strong>.</p></div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>Enter the consumer key for the Salesforce connected app.</p></div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p>Enter the path to the keystore used to sign data during authentication.</p></div></div></td></tr><tr><td><p><strong>Store Password</strong></p></td><td><div><div><p>Enter the password of the keystore.</p></div></div></td></tr><tr><td><p><strong>Principal</strong></p></td><td><div><div><p>Enter the username of the desired Salesforce user to take action on behalf of.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring OAuth SAML authentication:

![OAuth SAML selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/1.3/_images/oauth-saml.png)

## Configure Additional Connector Fields

After you configure a global element for Salesforce Pub/Sub Connector, configure the other required
fields for the connector. 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 goes to the Anypoint Studio
  console window.

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

Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also access 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 Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Salesforce Pub/Sub Connector Reference](https://docs.mulesoft.com/salesforce-pubsub-connector/1.3/salesforce-pubsub-connector-reference)

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

<!-- document id=86aa83d99011d8b7200b8df58c0647aa580175ac6d2b47a1e369273cf84f23ff url=/mulesoft/current/en-us/salesforce-pubsub-connector/latest/salesforce-pubsub-connector-studio.md -->

---
product: Salesforce Pub/Sub Connector
version: 1.4
is-latest-version: true
---

# Using Anypoint Studio to Configure Salesforce Pub/Sub Connector 1.4

> 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, refer to
[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, refer to
the [Salesforce Pub/Sub Connector Reference](https://docs.mulesoft.com/salesforce-pubsub-connector/latest/salesforce-pubsub-connector-reference).

## Create a Mule Project

In Studio, create a new Mule project in which to add and configure the 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 Salesforce Pub/Sub 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 `Salesforce Pub/Sub` in the search field.

3.  Click <Salesforce Pub/Sub> in **Available modules**.

4.  Click **Add**.

5.  Click **Finish**.

Adding a connector to a Mule project in Studio does not 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 Salesforce Pub/Sub Connector:

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

- 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 a **Subscribe channel listener** source, follow these steps:

1.  In the **Mule Palette** view, select **Subscribe channel listener**.

2.  Drag **Subscribe channel listener** to the Studio canvas.

3.  Optionally change the value of the **Display Name** field.

4.  Select a **Channel Name** from the dropdown field.

5.  Select a **Replay Option** from the four types available:

    - `Latest`

      Subscriber receives new events that are broadcast after the client subscribes.

    - `Earliest`

      Subscriber receives all events, including past events that are within the retention window of
      the server and new events sent after subscription.

    - `Custom replay id`

      Subscriber receives only events with a replay ID higher than the specified value.

    - `Replay id from object store`

      Subscriber receives only events with a replay ID higher than the specified value in object
      store. If no value is found, it defaults to `Earliest`. Provide values for the **Object Store
      Name** and the **Object Store Key** fields to connect to the desired object store and retrieve
      the replay ID value. For more information on how to use `Replay id from object store`, refer
      to [Store the Replay ID in the Object Store](#store-objectstore).

6.  Optionally, specify a value for the **Batch events size** field.

7.  Click the plus sign (**+**) next to the **Connector configuration** field to configure a global
    element that can be used by all instances of the **Subscribe channel listener** source in the
    app.

8.  In the **Security** tab, optionally specify the TLS information for the connector.

9.  In the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

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

11. Click **OK**.

### Store the Replay ID in the Object Store

To use the `Replay id from object store` option for the **Subscribe channel listener** source, you
must first save the replay ID value in the object store:

1.  Add the **Subscribe channel listener** source, as described in
    [Configure a Source](#configure-source), to the Studio flow.

2.  In the **Mule Palette** view, select **Store** from **Object Store Connector**.

3.  Drag **Store** to the Studio canvas.

4.  Optionally change the value of the **Display Name** field.

5.  Add a value for the **Key** field, such as replay ID. This is the key that is used later, when
    retrieving the replay ID from the object store.

6.  Set a value for the **Value** field. This is the replay ID value that you want to store. In this
    example, it is `payload.replayId`.

7.  Optionally, change the default values for the **Fail if present** and **Fail on null value**
    fields. The value for **Fail if present** must always be `false` as you must use the same key to
    store a new value for the replay ID.

8.  Click the plus sign (**+**) next to the **Object store** field to configure the object store.
    This is the object store in which the replay ID value is stored and from where the source
    retrieves the replay ID value.

9.  The values declared here for the **Object store** and **Key** fields are the same values that
    are used for the `Replay id from object store` option on the source.

## 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 Salesforce Pub/Sub Connector, follow these steps:

1.  In **Mule Palette**, select **Salesforce Pub/Sub** and then select the desired operation.

2.  Drag the operation onto the Studio canvas, next to the input 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 Salesforce Pub/Sub system. Salesforce Pub/Sub
Connector supports Basic Authentication, OAuth v2.0, OAuth JWT, OAuth Client Credentials, OAuth
Username Password, and OAuth SAML.

> [!NOTE] The `Basic Authentication` connection type is only supported for Salesforce API v64.0 and
> earlier versions.

To configure the global element for Salesforce Pub/Sub Connector, follow these steps:

1.  Select the operation in the Studio canvas.

2.  In the **General** configuration screen for the operation, click the **Add** icon to access the
    global element configuration fields.

3.  In the **General** tab, in **Connection**, select the authentication method to configure:

    - [Basic Authentication](#basic-authentication)

    - [OAuth v2.0](#oauth2)

    - [OAuth JWT](#oauth-jwt)

    - [OAuth Client Credentials](#oauth-client-credentials)

    - [OAuth Username Password](#oauth-username-password)

    - [OAuth SAML](#oauth-saml)

    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, refer to
    [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview).

4.  In the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

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

6.  Click **OK**.

### Basic Authentication

Enter the following information in the **General** tab of the **Global Element Properties** screen
to configure Basic Authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>Basic Authentication</strong>.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring Basic Authentication:

![Basic Authentication selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/latest/_images/basic-authentication.png)

### OAuth v2.0

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

Enter the following information on the **General** tab of the global element configuration screen to
configure OAuth v2.0 authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>OAuth v2.0</strong>.</p></div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>Enter the OAuth consumer key, as registered with the service provider.</p></div></div></td></tr><tr><td><p><strong>Consumer Secret</strong></p></td><td><div><div><p>Enter the OAuth consumer secret, as registered with the service provider.</p></div></div></td></tr><tr><td><p><strong>Listener Config</strong></p></td><td><div><div><p>Enter the configuration for the HTTP listener that listens for requests on the access token callback endpoint.</p></div></div></td></tr><tr><td><p><strong>Callback Path</strong></p></td><td><div><div><p>Enter the path of the access token callback endpoint.</p></div></div></td></tr><tr><td><p><strong>Authorize Path</strong></p></td><td><div><div><p>Enter the path of the local HTTP endpoint that triggers the OAuth dance.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring OAuth v2.0 authentication:

![OAuth v2.0 selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/latest/_images/oauth2.png)

### OAuth JWT

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

Enter the following information on the **General** tab of the global element configuration screen to
configure OAuth JWT authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>OAuth JWT</strong>.</p></div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>Enter the consumer key for the Salesforce connected app.</p></div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p>Enter the path to the keystore used to sign data during authentication.</p></div></div></td></tr><tr><td><p><strong>Store Password</strong></p></td><td><div><div><p>Enter the password of the keystore.</p></div></div></td></tr><tr><td><p><strong>Principal</strong></p></td><td><div><div><p>Enter the username of the desired Salesforce user to take action on behalf of.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring OAuth JWT authentication:

![OAuth JWT selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/latest/_images/oauth-jwt.png)

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

Enter the following information on the **General** tab of the global element configuration screen to
configure OAuth Client Credentials authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>OAuth Client Credentials</strong>.</p></div></div></td></tr><tr><td><p><strong>Client Id</strong></p></td><td><div><div><p>Enter the OAuth client ID, as registered with the service provider.</p></div></div></td></tr><tr><td><p><strong>Client Secret</strong></p></td><td><div><div><p>Enter the OAuth client secret, as registered with the service provider.</p></div></div></td></tr><tr><td><p><strong>Token Url</strong></p></td><td><div><div><p>Enter the URL of the service provider’s token endpoint. The token endpoint must be the org’s My-Domain endpoint.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring OAuth Client Credentials authentication:

![OAuth Client Credentials selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/latest/_images/oauth-client-credentials.png)

### OAuth Username Password

Enter the following information on the **General** tab of the global element configuration screen to
configure OAuth Username Password authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>OAuth Username Password</strong>.</p></div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>Enter the consumer key for the Salesforce connected app.</p></div></div></td></tr><tr><td><p><strong>Consumer Secret</strong></p></td><td><div><div><p>Enter your application’s client secret (consumer secret in Remote Access Detail).</p></div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>Enter the username used to initialize the session.</p></div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>Enter the password used to authenticate the user.</p></div></div></td></tr><tr><td><p><strong>Principal</strong></p></td><td><div><div><p>Enter the username of the desired Salesforce user to take action on behalf of.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring OAuth Username Password authentication:

![OAuth Username Password is selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/latest/_images/oauth-username-password.png)

### OAuth SAML

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

Enter the following information on the **General** tab of the global element configuration screen to
configure OAuth SAML authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>OAuth SAML</strong>.</p></div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>Enter the consumer key for the Salesforce connected app.</p></div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p>Enter the path to the keystore used to sign data during authentication.</p></div></div></td></tr><tr><td><p><strong>Store Password</strong></p></td><td><div><div><p>Enter the password of the keystore.</p></div></div></td></tr><tr><td><p><strong>Principal</strong></p></td><td><div><div><p>Enter the username of the desired Salesforce user to take action on behalf of.</p></div></div></td></tr></tbody></table>

The following image shows an example of configuring OAuth SAML authentication:

![OAuth SAML selected in the Connection section and authentication fields completed in the General tab](/mulesoft/current/en-us/salesforce-pubsub-connector/latest/_images/oauth-saml.png)

## Configure Additional Connector Fields

After you configure a global element for Salesforce Pub/Sub Connector, configure the other required
fields for the connector. 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 goes to the Anypoint Studio
  console window.

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

Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also access 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 Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Salesforce Pub/Sub Connector Reference](https://docs.mulesoft.com/salesforce-pubsub-connector/latest/salesforce-pubsub-connector-reference)

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