tap-keap - Meltano Hub

Keap

tap-keap (hotgluexyz variant)🥇

Small Business CRM & Automation

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

Getting Started

Prerequisites

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

Installation and configuration

Add the tap-keap extractor to your project using
```
meltano add
```
:

meltano add extractor tap-keap

Configure the tap-keap settings using

meltano config

:

meltano config tap-keap set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-keap test

Next steps

Follow the remaining steps of the Getting Started guide:

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

Capabilities

The current capabilities for tap-keap 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
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-keap 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:

access_token
client_id
client_secret
expires_in
start_date

Expand To Show SDK Settings

flattening_enabled
flattening_max_depth
stream_map_config
stream_maps

You can also list these settings using

meltano config

with the list subcommand:

meltano config tap-keap 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.

Access Token (access_token)

Environment variable: TAP_KEAP_ACCESS_TOKEN

Your Keap access token.

Configure this setting directly using the following Meltano command:

meltano config tap-keap set access_token [value]

Client ID (client_id)

Environment variable: TAP_KEAP_CLIENT_ID

Your Keap Client ID.

Configure this setting directly using the following Meltano command:

meltano config tap-keap set client_id [value]

Client Secret (client_secret)

Environment variable: TAP_KEAP_CLIENT_SECRET

Your Keap Client Secret.

Configure this setting directly using the following Meltano command:

meltano config tap-keap set client_secret [value]

Expires In (expires_in)

Environment variable: TAP_KEAP_EXPIRES_IN

The integer of how long until your Keap token expires.

Configure this setting directly using the following Meltano command:

meltano config tap-keap set expires_in [value]

Start Date (start_date)

Environment variable: TAP_KEAP_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.

Configure this setting directly using the following Meltano command:

meltano config tap-keap set start_date [value]

Expand To Show SDK Settings

Flattening Enabled (flattening_enabled)

Environment variable: TAP_KEAP_FLATTENING_ENABLED

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

Configure this setting directly using the following Meltano command:

meltano config tap-keap set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

Environment variable: TAP_KEAP_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-keap set flattening_max_depth [value]

Stream Map Config (stream_map_config)

Environment variable: TAP_KEAP_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-keap set stream_map_config [value]

Stream Maps (stream_maps)

Environment variable: TAP_KEAP_STREAM_MAPS

Config object for stream maps capability.

Configure this setting directly using the following Meltano command:

meltano config tap-keap 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-keap 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-keap

Maintenance Status

Repo

https://gitlab.com/hotglue/tap-keap

Maintainer

Keywords