Salesloft

tap-salesloft (markestey variant)🥈

Sales Engagement Platform

The tap-salesloft extractor pulls data from Salesloft that can then be sent to a destination using a loader.

Alternate Implementations

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-salesloft extractor to your project using 
    meltano add
     : 
    2. meltano add extractor tap-salesloft --variant markestey
  2. Configure the tap-salesloft settings using 
    meltano config
     : 
    3. meltano config tap-salesloft set --interactive
  3. Test that extractor settings are valid using 
    meltano config
     : 
    4. meltano config tap-salesloft test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-salesloft may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

  • about
  • batch
  • catalog
  • discover
  • schema-flattening
  • state
  • stream-maps

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-salesloft settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can also list these settings using 

meltano config
with the list subcommand: 

meltano config tap-salesloft list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

API Base URL (api_base_url)

  • Environment variable: TAP_SALESLOFT_API_BASE_URL
  • Default Value: https://api.salesloft.com

The base url for the Salesloft API service


Configure this setting directly using the following Meltano command:

meltano config tap-salesloft set api_base_url [value]

API Key (api_key)

  • Environment variable: TAP_SALESLOFT_API_KEY

The key to authenticate with the API service


Configure this setting directly using the following Meltano command:

meltano config tap-salesloft set api_key [value]

Page Size (page_size)

  • Environment variable: TAP_SALESLOFT_PAGE_SIZE
  • Default Value: 100

The number of results to request per page. Must be in the range 1-100.


Configure this setting directly using the following Meltano command:

meltano config tap-salesloft set page_size [value]

Rate Target Pct (rate_target_pct)

  • Environment variable: TAP_SALESLOFT_RATE_TARGET_PCT
  • Default Value: 80

The percentage of the rate limit to consume. Must be in the range 1-100.


Configure this setting directly using the following Meltano command:

meltano config tap-salesloft set rate_target_pct [value]

Start Date (start_date)

  • Environment variable: TAP_SALESLOFT_START_DATE

The earliest record date to sync


Configure this setting directly using the following Meltano command:

meltano config tap-salesloft set start_date [value]

Stream Maps Config (stream_maps_config)

  • Environment variable: TAP_SALESLOFT_STREAM_MAPS_CONFIG

Inline stream maps config (see: https://sdk.meltano.com/en/latest/stream_maps.html)


Configure this setting directly using the following Meltano command:

meltano config tap-salesloft set stream_maps_config [value]

Stream Type Conformance (stream_type_conformance)

  • Environment variable: TAP_SALESLOFT_STREAM_TYPE_CONFORMANCE
  • Default Value: root_only

The level of type conformance to apply to streams (see: https://sdk.meltano.com/en/latest/classes/singer_sdk.Stream.html#singer_sdk.Stream.TYPE_CONFORMANCE_LEVEL). Defaults to 'root_only'. Must be one of: 'none', 'root_only', 'recursive'


Configure this setting directly using the following Meltano command:

meltano config tap-salesloft set stream_type_conformance [value]

User Agent (user_agent)

  • Environment variable: TAP_SALESLOFT_USER_AGENT
  • Default Value: tap-salesloft

The user-agent string provided on outgoing requests


Configure this setting directly using the following Meltano command:

meltano config tap-salesloft set user_agent [value]
Expand To Show SDK Settings

Batch Config Encoding Compression (batch_config.encoding.compression)

  • Environment variable: TAP_SALESLOFT_BATCH_CONFIG_ENCODING_COMPRESSION

Compression format to use for batch files.


Configure this setting directly using the following Meltano command:

meltano config tap-salesloft set batch_config encoding.compression [value]

Batch Config Encoding Format (batch_config.encoding.format)

  • Environment variable: TAP_SALESLOFT_BATCH_CONFIG_ENCODING_FORMAT

Format to use for batch files.


Configure this setting directly using the following Meltano command:

meltano config tap-salesloft set batch_config encoding.format [value]

Batch Config Storage Prefix (batch_config.storage.prefix)

  • Environment variable: TAP_SALESLOFT_BATCH_CONFIG_STORAGE_PREFIX

Prefix to use when writing batch files.


Configure this setting directly using the following Meltano command:

meltano config tap-salesloft set batch_config storage.prefix [value]

Batch Config Storage Root (batch_config.storage.root)

  • Environment variable: TAP_SALESLOFT_BATCH_CONFIG_STORAGE_ROOT

Root path to use when writing batch files.


Configure this setting directly using the following Meltano command:

meltano config tap-salesloft set batch_config storage.root [value]

Flattening Enabled (flattening_enabled)

  • Environment variable: TAP_SALESLOFT_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.


Configure this setting directly using the following Meltano command:

meltano config tap-salesloft set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

  • Environment variable: TAP_SALESLOFT_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-salesloft set flattening_max_depth [value]

Stream Map Config (stream_map_config)

  • Environment variable: TAP_SALESLOFT_STREAM_MAP_CONFIG

User-defined config values to be used within map expressions.


Configure this setting directly using the following Meltano command:

meltano config tap-salesloft set stream_map_config [value]

Stream Maps (stream_maps)

  • Environment variable: TAP_SALESLOFT_STREAM_MAPS

Inline stream maps (see: https://sdk.meltano.com/en/latest/stream_maps.html)


Configure this setting directly using the following Meltano command:

meltano config tap-salesloft set stream_maps [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-salesloft extractor to work, 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.

Install

meltano add extractor tap-salesloft --variant markestey

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK

Repo

https://github.com/MarkEstey/firehose-tap-salesloft
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • markestey

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

Keywords

  • meltano_sdk