tap-hubspot

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

This tap:

• Pulls raw data from HubSpot's REST API
• Extracts the following resources from HubSpot
  • Campaigns
  • Companies
  • Contacts
  • Contact Lists
  • Deals
  • Deal Pipelines
  • Email Events
  • Engagements
  • Forms
  • Keywords
  • Owners
  • Subscription Changes
  • Workflows
  • Tickets
• Outputs the schema for each resource
• Incrementally pulls data based on the input state

Configuration

This tap requires a config.json which specifies details regarding OAuth 2.0 authentication, a cutoff date for syncing historical data, an optional parameter request_timeout for which request should wait to get the response and an optional flag which controls collection of anonymous usage metrics. See config.sample.json for an example. You may specify an API key instead of OAuth parameters for development purposes, as detailed below.

To run tap-hubspot with the configuration file, use this command:

› tap-hubspot -c my-config.json

API Key Authentication (for development)

As an alternative to OAuth 2.0 authentication during development, you may specify an API key (HAPIKEY) to authenticate with the HubSpot API. This should be used only for low-volume development work, as the HubSpot API Usage Guidelines specify that integrations should use OAuth for authentication.

To use an API key, include a hapikey configuration variable in your config.json and set it to the value of your HubSpot API key. Any OAuth authentication parameters in your config.json will be ignored if this key is present!

---

Copyright © 2017 Stitch

Generating and uploading distribution archives

› python3 -m build

This command should generate 2 files in directory dist :

dist/
  example_package-0.0.1-py3-none-any.whl
  example_package-0.0.1.tar.gz

To upload package execute :

› python3 -m twine upload dist/*

• Set your username to __token__
• Set your password to the token value, including the pypi- prefix (found in s3://consolidation-pipeline/pypi/singer-cv-pypi-token)

Catalogue configuration

Is it necessary to add parameter "selected" : true in metadata of a stream/field :

Object	metadata general selected	metadata field selected
campaigns	true	false
companies	true	false
contact_lists	true	false
contacts_by_company	true	false
contacts	true	false
deal_pipelines	true	false
deals	true	true (properties)
email_events	true	false
engagements	true	false
forms	true	false
owners	true	false
subscription_changes	true	false
tickets	true	true (properties)
workflows	true	false