The tap-salesforce Singer tap pulls data from Salesforce that can then be sent to a destination using a Singer target.

Alternative variants #

Multiple variants of tap-salesforce are available. This document describes the default meltano variant, which is recommended for new users.

Alternative variants are:

Standalone usage #

Install the package using pip:

pip install git+https://gitlab.com/meltano/tap-salesforce.git

For additional instructions, refer to the README in the repository.

Usage with Meltano #

Install Meltano, create your Meltano project, and add the tap to your project as an extractor:

meltano add extractor tap-salesforce

For additional instructions, refer to the Meltano-specific documentation for tap-salesforce.

Capabilities #

Settings #

username (username) #

The username (or email address) used to sign in to your Salesforce account.

Password (password) #

The password used to sign in to your Salesforce account.

Security Token (security_token) #

Your Salesforce Account access token

See https://hub.meltano.com/extractors/salesforce.html#salesforce-setup.

Client ID (client_id) #

Salesforce client ID. See https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_understanding_web_server_oauth_flow.html.

Client Secret (client_secret) #

Salesforce client secret. See https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_understanding_web_server_oauth_flow.html.

Refresh Token (refresh_token) #

Salesforce refresh token. See https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_understanding_web_server_oauth_flow.html.

Start Date (start_date) #

Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.

Is Sandbox (is_sandbox) #

  • Default: false

Use Salesforce Sandbox

API Type (api_type) #

  • Default: REST

Used to switch the behavior of the tap between using Salesforce’s “REST” and “BULK” APIs.

Select Fields By Default (select_fields_by_default) #

  • Default: true

Select by default any new fields discovered in Salesforce objects

State Message Threshold (state_message_threshold) #

  • Default: 1000

Generate a STATE message every N records

Maximum number of threads to use (max_workers) #

  • Default: 8

Maximum number of threads to use.

Looking for help? #

If you're having trouble getting tap-salesforce to work by itself or with Meltano, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the #plugins-general channel.

Found an issue on this page? #

This page is generated from a YAML file that you can contribute changes to! It is also validated against a JSON Schema used for taps and targets.


Edit this page on GitLab!