In this article

Overview

The Salesforce Subscriber Snap is a Read-type Snap that provides the functionality to subscribe to Salesforce Platform and CDC events for a given standard and custom Salesforce object.

Refer the Salesforce Platform Event Allocations and Subscribe to change events documents before configuring this Snap.

Supported Salesforce Events

Platform events: User-defined read/write events. These events end with "_e".
CDC events: Read-only events created when the Salesforce objects (standard or custom) change. These events end with "ChangeEvent" or "_ChangeEvent".

Prerequisites

Ensure that Change Data Capture is enabled for the target entities. To do so log in to your Salesforce instance and go to Setup → App Setup → Develop → Change Data Capture.
Ensure that Field Tracking is enabled for the selected entities.
Account must have valid access permissions.

Limitations and Known Issues

For a Salesforce (Platform Events) Subscriber Snap, retry attempts are not logged, and currently retries are attempted only for authentication errors.
Salesforce imposes a limit on the number of subscriptions. See Change Data Capture Allocations for details.
Supports only Platform and CDC events.

Support for Ultra Pipelines

Works in Ultra Pipelines.

Snap Views

Type	Format	Number of Views	Examples of Upstream and Downstream Snaps	Description
Input	Document	Min:0 Max:1	JSON Parser Mapper	A stream of documents that contain data to be published on a Salesforce object
Output	Document	Min:1 Max:1	JSON Formatter Mapper	A stream of documents with Map data that contain the individual records published on the given Salesforce object and/or `original` fields.

Snap Settings

Field	Field Type	Description
Label*	String	Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline. Default value: Salesforce Subscriber Example: Salesforce Subscriber
Service Version*	String/Expression	Specify the version number of the Salesforce service that you want to connect to. Salesforce platform event is supported in version 44.0 or later. Default value: 44.0 Example: 44.0
Events*	String/Expression	The Salesforce Platform Event or CDC Event. This is a suggestible field that lists the Platform Events and CDC events available to you. Example: Printer_Event__e AccountChangeEvent Default value: None
Replay ID*	Integer/Expression	Specify the position of an event in the event stream. The Snap supports the following IDs: -2: Receives events from the earliest event position in the stream. -1: Receives events from the latest event position in the stream. A specific positive value ID: Receives events after the specified positive ID value. If you stop a Pipeline execution, the Replay ID is lost and the Snap restarts from the position you input here. The Snap automatically sets the Replay ID value to -2 when: the specified Replay ID is invalid or outside the retention window. the CreatedDate of the most recent event received by Snap is outside the 72-hour retention window. Default Value: -2 Example: 20
Message Count*	Integer/Expression	Specify the number of messages required to read and complete the Pipeline execution. If the value is set to -1, the Snap waits indefinitely and reads messages whenever available until you manually stop the Pipeline execution. Default Value: -1 Example: 2
Pass Through	Checkbox	Select this checkbox to pass the input document the output view under the key 'original'. If you deselect this checkbox, the input document will not be passed and there is no "original" key in the output document. Default Value: Selected
Advanced Properties	Use this field set to configure Http Long Polling. Click + to add Properties and Values. Enter each property and value in a separate row. This field set contains the following fields: Properties Values
Properties	String	Enter the property. Default Value: N/A Example: maxNetworkDelay, maxBufferSize
Values	String	Enter the value for the property. Default Value: N/A Example: 10
Snap Execution	Dropdown list	Select one of the three modes in which the Snap executes. Available options are: Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime. Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data. Disabled: Disables the Snap and all Snaps that are downstream from it.

The field labels for this Snap are updated to title case. If you have existing Pipelines that include the field names in the error messages, you must update those Pipelines to use the new field labels.

Example

This example Pipeline demonstrates how the Salesforce Subscriber Snap processes platform events.

The following Salesforce Subscriber Snap shows how the Snap is configured and how the Salesforce object's records are read.

You can see that the Replay ID is -2. So the Snaps reads messages from the beginning. And the Snap reads only 3 messages as the Message count is set to 3.The Snap processes the events and the output preview is as follows:

Download this Pipeline.

Downloads

Important steps to successfully reuse Pipelines

Download and import the Pipeline into SnapLogic.
Configure Snap accounts as applicable.
Provide Pipeline parameters as applicable.

	File	Modified
Labels No labels Preview View	File Example_Pipeline_Salesforce_Subscriber_Event_Platform.slp	Mar 10, 2022 by Subhajit Sengupta

Snap Pack History

Click to view/expand

Release	Snap Pack Version	Date	Type	Updates
4.29	main15993	14 May 2022	Stable	Upgraded with the latest SnapLogic Platform release.
4.28 Patch	428patches14355	24 Feb 2022	Latest	Fixed an issue with Salesforce Snaps where the Service Version could not be retrieved from SFDC due to a blocked URL, failing the Snap execution.
4.28	main14627	12 Feb 2022	Stable	Upgraded with the latest SnapLogic Platform release.
4.27 Patch	427patches14079	27 Jan 2022	Latest	Fixed an issue with the Salesforce Subscriber Snap where the Snap was unable to re-subscribe to a topic if it did not receive any message for 72 hours —stopped and displayed an error message. With this fix, the Snap automatically sets the Replay ID value to -2 when: the specified Replay ID is invalid or outside the retention window. the most recently received Replay ID for an event is outside the 72-hour retention window.
4.27 Patch	427patches13944	05 Jan 2022	Latest	Fixed an issue with Salesforce accounts, where an account password containing special characters and an empty security token was not properly encoded and the account was not validated.
4.27 Patch	427patches13789	23 Dec 2021	Latest	Fixed the following issues with Salesforce Snaps: High memory use due to leaked resources. Hung Pipelines due to blocked threads.
4.27	main12833	13 Nov 2021	Stable	Added Salesforce Mutual Authentication Account to Salesforce Snap Pack that provides an additional layer of security while authentication. Both the client and server authenticate themselves using Client Certificate Authentication. This account is not supported for Salesforce Subscriber and Salesforce Publisher Snaps. Extended the support of Salesforce OAuth2 Account to all the Salesforce Snaps in addition to the Salesforce Bulk Snaps. Revised the name of Salesforce Attachment Download to Salesforce Download Snap. Enhanced this Snap with a new field File Type to support download of attachments from Salesforce by passing Content Data ID in addition to the Attachment ID. Updated the default Salesforce API Service Version to 52.0 for the following Snaps: Salesforce Download Salesforce Batch Create Salesforce Create Salesforce Delete Salesforce Lookup Salesforce Read Salesforce Update Salesforce Upsert Salesforce Wave Analytics Enhanced the following Snaps to support Pipeline parameters only for expression fields, while the input data parameters are not supported for expression fields. Salesforce Bulk Create Salesforce Bulk Delete Salesforce Bulk Upsert Salesforce Bulk Update Salesforce Bulk Query Salesforce Create Salesforce Delete Salesforce SOQL Salesforce Update Salesforce Upsert Salesforce Lookup Salesforce Publisher
4.26 Patch	426patches12054	04 Oct 2021	Latest	Enhanced the Salesforce Subscriber Snap with improved resilience to network failures and fixed an issue with duplicate documents.
4.26	main11181	14 Aug 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.25 Patch	425patches10182	15 Jul 2021	Latest	Fixed an issue with the Salesforce Read Snap where the retry fields do not work as expected when a Pipeline has more than ten Snaps.
4.25 Patch	425patches9609	28 Jun 2021	Latest	Enhanced the Salesforce Read Snap to allow you to add an optional second output view that exposes the schema of the target object as the output document. The output view of the Snap has a minimum of one output and a maximum of two outputs.
4.25	main9554	08 May 2021	Stable	Enhanced the Salesforce Upsert Snap to support CSV payload using the new field Bulk Content Type in Bulk API mode as Salesforce API has recently been supporting CSV payload as well. Earlier, this Snap supported only XML data type; you can now select CSV content type from the Bulk Content Type drop-down list. The default content type is set to XML to preserve backward compatibility. This enhancement also addresses the null values issue during Bulk API mode. Enhanced the Snaps in the Salesforce Snap Pack by updating the field labels to title case. If you have existing Pipelines using Salesforce Snaps that include the field names in the error messages, you must update those Pipelines to use the new field labels.
4.24 Patch	424patches9024	05 Apr 2021	Latest	Fixes an issue in Salesforce Bulk Upsert, Salesforce Bulk Update, and Salesforce Bulk Create Snaps that fail to process Related object and Related external ID values by modifying the input schema that formats the CSV data. Fixes the Jetty dependency issue in the Salesforce Subscriber Snap by upgrading Salesforce EMP Connector.
4.24 Patch	424paches8569	08 Mar 2021	Latest	Fixes an issue in Salesforce Bulk Upsert, Salesforce Bulk Update, and Salesforce Bulk Create Snaps that fail to process Related object and Related external ID values by modifying the input schema that formats the CSV data. Potential Breaking Change This Salesforce Snap patch contains an issue affecting the Salesforce Subscriber and Salesforce Publisher Snaps. If you do not use these Snaps in your Pipelines, then you can use this patch version. Else, we recommend you to not use this patch version as Pipelines will fail. We will fix this issue soon in an upcoming patch.
4.24	main8556	13 Feb 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.23 Patch	423patches7888	29 Dec 2020	Latest	Fixed the the following Snaps to ensure that they maintain lineage when using in Ultra Pipelines. This fix does not affect the bulk action Snaps in this Snap Pack that produce more than one output document for each input document. Salesforce Create Salesforce Delete Salesforce Update Salesforce Upsert Salesforce Subscriber Salesforce Publisher
4.23	main7430	14 Nov 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.22	main6403	12 Sep 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.21 Patch	salesforce8829	12 May 2020	Latest	Fixed the Salesforce Create, Update, Bulk Create, Bulk Update, and Bulk Upsert Snaps, enabling you to upload files containing duplicate values across multiple fields.
4.21	snapsmrc542	09 May 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.20 Patch	salesforce8814	21 Apr 2020	Latest	Fixed the Salesforce Create, Update, Bulk Create, Bulk Update, and Bulk Upsert Snaps, enabling you to upload files containing duplicate values across multiple fields.
4.20 Patch	salesforce8797	13 Apr 2020	Latest	Fixed the Salesforce Subscriber Snap wherein the Salesforce Subscriber and Mapper Snap combination generates Null output for Array object type.
4.20	snapsmrc535	08 Feb 2020	Stable	Added the Salesforce Bulk Query Snap, which enables you to perform bulk SOQL queries on Salesforce.
4.19	snaprsmrc528	14 Nov 2019	Stable	Introduced an account type Salesforce.com OAuth2 and the following Snaps that support the Bulk API v2.0: Salesforce Bulk Create: Adds new Salesforce records. Salesforce Bulk Update: Updates Salesforce records. Salesforce Bulk Upsert: Updates or inserts Salesforce records. Salesforce Bulk Delete: Deletes Salesforce records.
4.18 Patch	salesforce7832	11 Sep 2019	Latest	Enhanced the Salesforce Subscriber Snap to capture Change Data Capture (CDC) events.
4.18	snapsmrc523	10 Aug 2019	Stable	Upgraded with the latest SnapLogic Platform release.
4.17 Patch	salesforce7474	15 Jul 2019	Latest	Added Order by clause and Limit clause properties to the Salesforce Reader Snap to fix an issue wherein the Snap throws an error while fetching records.
4.17	ALL7402	11 Jun 2019	Latest	Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.
4.17	snapsmrc515	11 Jun 2019	Latest	Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.
4.16 Patch	salesforce6889	01 Mar 2019	Latest	Added two new properties, Number of retries and Retry interval, to the Salesforce Read, SOQL, Publisher, and Subscriber Snaps. These properties let you handle retry attempts and intervals in case of a network failure.
4.16	snapsmrc508	16 Feb 2019	Stable	Added two new Snaps: Salesforce Publisher: Publish Salesforce platform event records to a given event custom `sObject` (Salesforce Object). Salesforce Subscriber: Subscribe to Salesforce platform event records for a given event custom `sObject`.
4.15 Patch	salesforce6405	02 Jan 2019	Latest	Fixed an issue with resource leak in PK Chunking in Salesforce Read and SOQL Snaps.
4.15 Patch	salesforce6349	06 Dec 2019	Latest	Fixed an issue with the Salesforce SOQL Snap timing out while waiting for a connection from the pool.
4.15	snapsmrc500	15 Dec 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.14 Patch	salesforce5670	13 Aug 2018	Latest	Fixed the Salesforce SOQL Snap that fails to execute if the parameter values of a SOQL query expression contain the WHERE clause.
4.14	snapsmrc490	11 Aug 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.13	snapsmrc486	12 May 2018	Stable	Fixed an issue where the Salesforce Read Snap fails to download the PK-Chunking CSV file due to network failure or running out of disk space. Fixed an issue where theSalesforce Lookup Snap does not match the datatype with the Bulk API; for instance, boolean data returns string. Fixed an issue where the Salesforce SOQL Snap does not preview data in pipelines. Fixed an issue where PK Chunking files are not deleted from the temp directory.
4.12 Patch	salesforce4839	14 Mar 2018	Latest	Fixed a defect that occurs when downstream Snaps are slow in processing documents downloaded from SFDC.
4.12 Patch	salesforce4773	06 Mar 2018	Latest	Added a new option in Advanced properties - "Validate record count downloaded in Bulk API" that compares the number of records processed vs downloaded and routes output to Error View (if Error View is enabled) if there is a mismatch.
4.12	snapsmrc480	17 Feb 2018	Stable	Updated Salesforce SOQL and Lookup Snaps to ensure that they are consistent with SnapLogic guidelines of writing Snap data exceptions to error views and continuing to process next documents vs. hard stopping. Enhanced the Salesforce read operations for the Read, SOQL, and SOSL Snaps to display the original Salesforce error cause, reason, and resolution.
4.11 Patch	salesforce4299	08 Dec 2017	Latest	Fixed an issue wherein the Salesforce SOQL Snap did not get an input stream from the next records URL. Fixed an issue with the Salesforce SOQL Snap querying deleted records using Bulk API.
4.11	snapsmrc465	11 Nov 2017	Stable	Polling timeout property's default value increased to 3000 from 300 for Salesforce Lookup, Salesforce Poller, Salesforce Read, and Salesforce SOQL Snaps.
4.10 Patch	salesforce4005	13 Oct 2017	Latest	Salesforce Poller Snap: Includes the success field in the output.
4.10	snapsmrc414	12 Aug 2017	Stable	Upgraded with the latest SnapLogic Platform release.
4.9.0 Patch	salesforce3218	12 Jul 2017	Latest	Fixed the error in PK Chunking when a downstream Snap is blocking the pipeline
4.9.0 Patch	salesforce3247	11 Jul 2017	Latest	Addressed an issue withSalesforce Poller Snap causing JSON Formatter to throw ConcurrentModificationException.
4.9.0 Patch	salesforce3225	05 Jul 2017	Latest	Addressed a null pointer exception in the Salesforce Update Snap. This exception was present in both salesforce3082 and salesforce3122.
4.9	snapsmrc405	13 May 2017	Stable	Updated the Salesforce Create, Batch Create, Delete, Poller, Update and Upsert Snaps with Pass through property.
4.8.0 Patch	salesforce2884	13 Apr 2017	Latest	Addressed an issue with inconsistent behavior between Preview and Execution. Addressed an issue with Salesforce SOQL Snap failing to download PK-Chunking.
4.8	snapsmrc398	11 Feb 2017	Stable	Updated the Salesforce Lookup Snap with Correlation ID property. This property is an ID field name which the Snap uses to correlate input document to the output record when users want to pass through input data to the output view. Updated the Salesforce Read Snap with Output field limit and Output field offset properties. Output field limit is the number of fields to return in the order of Salesforce describe object field index. Output field offset defines a starting field index for the output fields. Info tab added to accounts.
4.7.0 Patch	salesforce2284	13 Dec 2016	Latest	Added log to troubleshoot a deploy issue.
4.7.0 Patch	salesforce2255	09 Dec 2016	Latest	Addressed SFDC SOQL Snap routing to the error view & validate PK Chunking record numbers.
4.7.0 Patch	salesforce2244	07 Dec 2016	Latest	Addressed possible leak with threads waiting to download PK Chunking responses.
4.7.0 Patch	salesforce2218	30 Nov 2016	Latest	SFDC SOQL Snap route to the error view & validate PK Chuning record numbers.
4.7.0 Patch	salesforce2209	23 Nov 2016	Latest	SOQL Snap now correctly routes to the error view & validates PK Chunking record numbers.
4.7	snapsmrc382	23 Nov 2016	Stable	Updated the Salesforce SOQL, Read, & Lookup Snaps with Match data type field. Updated the Salesforce Upsert, Update, Create and Delete Snaps with 'Standardize error output' field.
4.6.0 Patch	salesforce1931	13 Sep 2016	Latest	Implemented a new property "Match data type in XML" Implemented a new global.properties entry "SFDC_SESSION_TIMEOUT_MINUTES" so that users can reduce the frequency of logins.
4.6	snapsmrc362	13 Aug 2016	Stable	Doc Enhancement: Examples added to Salesforce Snap documentation. Resolved an issue in Salesforce Snaps that prevented extraction of access tokens.
4.5.1	salesforce1633	18 May 2016	Stable	Salesforce Read Snap is updated to support Output fields and Where clause specifications. For more information, see Salesforce Read. Salesforce Read & SOQL Snaps are updated to support JSON representation of Bulk API result data and a parsing issue encountered (in Bulk API mode) has been rectified. Fixed errors around upload and output preview for Salesforce Wave Analytics Snap.
4.5	snapsmrc344	NA	Latest	Pass through and Ignore empty results added to Salesforce SOQL, Read and SOSL Snaps. Resolved an issue in Salesforce Batch Create Snap to appropriately create multiple records in REST API.
4.4.1		18 Mar 2016	Stable	Resolved an issue with Connection pool times out with Salesforce Snaps. Salesforce Lookup: Resolve a 'The session ID or OAuth token used has expired or is invalid' exception when running in an Ultra Task.
4.4		13 Feb 2016	Stable	Resolved an issue with Salesforce Query returning inconsistent result sets.
4.3.2		15 Jan 2016	Stable	SalesForce Lookup Snap: Implemented Pass-through on no lookup match property Resolved an issue with Salesforce Upsert Snap failing with an error 'not valid for the type xsd:double'. Resolved an issue with Salesforce SOQL Snap returning fewer results than SFDC returns. Performance improvements made to Salesforce Read/SOQL Snaps with Bulk API in PK Chunking mode.
4.3		NA		NEW! Salesforce Batch Create added in this release. Salesforce Wave ID field suggestions now include upstream schema. Resolved an issue in Salesforce Lookup Snap failing to generate an output schema if more than 50 records are found.
4.22		NA		NEW! Salesforce Batch Create added in this release. Resolved an issue with Salesforce Wave analytics throwing an error when metadata contained a hash symbol in number format. Resolved an issue the failing to validate the account if the password contained a colon (:). Salesforce Snaps now default to the latest Salesforce API version. Create/Update/Upsert Snaps did not support related object mappings.
		15 May 2015		Salesforce Upsert - intermittently throws ViewChannelException since document was send to the closed output view Salesforce Delete not using passthrough platform service
		02 May 2015		Salesforce Account: added custom login URL (for support of CipherCloud) Salesforce Read: various updates for errors and performance improvements for > 1m rows being retrieved in Bulk API Salesforce Write in Bulk API: enhanced batching support
		20 Dec 2014		NEW! Salesforce Wave Analytics added in this release. Salesforce Upsert: External ID field is now suggestible. Salesforce Read & Salesforce SOQL now accept 200 as a batch size. Snaps with a Polling timeout property no longer have a maximum timeout limit.
		08 Oct 2014		Addressed the following issues: Salesforce Account: Could not login to Salesforce, Endpoint Exception Error message is displayed. Salesforce Analytics null pointer Salesforce Attachment: NPE is displayed for Invalid Account.
		30 Jul 2014		The account settings for Salesforce.com now gives you the choice of either entering a token or entering an IP while list address range. If you need to create a token, you will need a non-admin user to generate the token for SnapLogic. The Security Token is no longer required for Salesforce.com accounts.