https://github.com/singer-io/tap-hubspot
https://github.com/singer-io/tap-hubspot
singer tap
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/singer-io/tap-hubspot
- Owner: singer-io
- License: agpl-3.0
- Created: 2017-01-24T21:45:11.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-10-24T09:52:32.000Z (over 1 year ago)
- Last Synced: 2024-10-25T07:44:07.649Z (over 1 year ago)
- Topics: singer, tap
- Language: Python
- Size: 697 KB
- Stars: 51
- Watchers: 18
- Forks: 95
- Open Issues: 48
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# tap-hubspot
This is a [Singer](https://singer.io) tap that produces JSON-formatted data following the [Singer spec](https://github.com/singer-io/getting-started/blob/master/SPEC.md).
This tap:
- Pulls raw data from HubSpot's [REST API](http://developers.hubspot.com/docs/overview)
- Extracts the following resources from HubSpot
- [Campaigns](http://developers.hubspot.com/docs/methods/email/get_campaign_data)
- [Companies](http://developers.hubspot.com/docs/methods/companies/get_company)
- [Contacts](https://developers.hubspot.com/docs/methods/contacts/get_contacts)
- [Contact Lists](http://developers.hubspot.com/docs/methods/lists/get_lists)
- [Deals](http://developers.hubspot.com/docs/methods/deals/get_deals_modified)
- [Deal Pipelines](https://developers.hubspot.com/docs/methods/deal-pipelines/get-all-deal-pipelines)
- [Email Events](http://developers.hubspot.com/docs/methods/email/get_events)
- [Engagements](https://developers.hubspot.com/docs/methods/engagements/get-all-engagements)
- [Forms](http://developers.hubspot.com/docs/methods/forms/v2/get_forms)
- [Keywords](http://developers.hubspot.com/docs/methods/keywords/get_keywords)
- [Owners](https://developers.hubspot.com/docs/api/crm/owners)
- [Subscription Changes](http://developers.hubspot.com/docs/methods/email/get_subscriptions_timeline)
- [Workflows](http://developers.hubspot.com/docs/methods/workflows/v3/get_workflows)
- [Tickets](https://developers.hubspot.com/docs/api/crm/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](https://developers.hubspot.com/docs/methods/oauth2/oauth2-overview) 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](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:
```bash
› 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](https://developers.hubspot.com/apps/api_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