The tap-salesforce Singer tap pulls data from the Salesforce API 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

Password (password)

Security Token (security_token)

Your Salesforce Account access token

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

Client ID (client_id)

client_secret

refresh_token

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

Use Salesforce Sandbox

API Type (api_type)

select_fields_by_default

Select by default any new fields discovered in Salesforce objects

state_message_threshold

Generate a STATE message every N records

Maximum number of threads to use (max_workers)

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.