Close

tap-closeio from singer-io

Customer Relationship Management Platform

The tap-closeio extractor pulls data from Close 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:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

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

Next steps

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

Capabilities

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

  • catalog
  • discover
  • state

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

Settings

The tap-closeio 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 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.

Start Date (start_date)

  • Environment variable: TAP_CLOSEIO_START_DATE

The start_date is the date at which the tap will begin syncing data. Ie. if there is data in your Close.io account older than start_date, it will not be synced.

API Key (api_key)

  • Environment variable: TAP_CLOSEIO_API_KEY

Your Close.io API key. Login to your Close.io account, navigate to your account settings and "Your API Keys". Generate a New API Key, you'll need it for the next step.

Date Window (date_window)

  • Environment variable: TAP_CLOSEIO_DATE_WINDOW

The date_window is the window in the which API calls will take place. The default window size is 15 days.

User Agent (user_agent)

  • Environment variable: TAP_CLOSEIO_USER_AGENT

The user agent to send with requests.

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-closeio 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-closeio

Maintenance Status

  • Maintenance Status
  • Stars
  • Forks
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Stitch Data

PyPI Stats

  • PyPI Downloads
  • PyPI Package Version

Keywords

  • api