Skip to main content

Harvest

This connector captures data from Harvest into Flow collections.

It is available for use in the Flow web application. For local development or open-source workflows, ghcr.io/estuary/source-harvest:dev provides the latest version of the connector as a Docker image. You can also follow the link in your browser to see past image versions.

This connector is based on an open-source connector from a third party, with modifications for performance in the Flow system.

Supported data resources

The following data resources are supported through the Harvest APIs:

Prerequisites

Configuration

You configure connectors either in the Flow web app, or by directly editing the catalog specification file. See connectors to learn more about using connectors. The values and specification sample below provide configuration details specific to the Harvest source connector.

Properties

Endpoint

PropertyTitleDescriptionTypeRequired/Default
/account_idAccount IDHarvest account ID. Required for all Harvest requests in pair with Personal Access Token.stringRequired
/start_dateStart DateUTC date and time in the format 2021-01-25T00:00:00Z. Any data before this date will not be replicated.stringRequired
/end_dateEnd DateUTC date and time in the format 2021-01-25T00:00:00Z. Any data before this date will not be replicated.stringDefault

Bindings

PropertyTitleDescriptionTypeRequired/Default
/streamStreamResource of your Harvest project from which collections are captured.stringRequired
/syncModeSync ModeConnection method.stringRequired

Sample


captures:
${PREFIX}/${CAPTURE_NAME}:
endpoint:
connector:
image: ghcr.io/estuary/source-harvest:dev
config:
account_id: <account id>
start_date: 2017-01-25T00:00:00Z
end_date: 2020-01-25T00:00:00Z
bindings:
- resource:
stream: clients
syncMode: incremental
target: ${PREFIX}/clients
{...}