Tap for Close.io
Python
Switch branches/tags
Nothing to show

README.md

tap-close-io

This is a Singer tap that produces JSON-formatted data following the Singer spec.

This tap:

  • Pulls raw data from Close.io's REST API
  • Extracts the following resources from Close.io:
  • Outputs the schema for each resource
  • Incrementally pulls data based on the input state

Quick start

  1. Install

    > pip install tap-closeio
  2. Get 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.

  3. Create the config file

    Create a JSON file called config.json containing the api key you just generated.

    {"api_key": "your-api-token"}
  4. [Optional] Create the initial state file

    You can provide JSON file that contains a date for the API endpoints to force the application to only fetch data newer than those dates. If you omit the file it will fetch all Close.io data

    {"activities": "2017-01-17T20:32:05Z",
     "leads": "2017-01-17T20:32:05Z"}
  5. Run the application

    tap-closeio can be run with:

    tap-closeio --config config.json [--state state.json]

Copyright © 2017 Stitch