Skip to main content

Iterate

This connector captures data from Iterate into Flow collections.

It is available for use in the Flow web application. For local development or open-source workflows, ghcr.io/estuary/source-iterate: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.

Supported data resources

The following data resources are supported through the Iterate API:

By default, each resource is mapped to a Flow collection through a separate binding.

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 Iterate source connector.

Properties

Endpoint

The properties in the table below reflect manual authentication using the CLI. In the Flow web app, you'll sign in directly and won't need the access token.

PropertyTitleDescriptionTypeRequired/Default
/credentials/access_tokenAccess TokenIterate Access token.stringRequired
/credentials/credentials_titleCredentialsName of the credentials setstringRequired, "Private App Credentials"

Bindings

PropertyTitleDescriptionTypeRequired/Default
/nameData resourceName of the data resource.stringRequired
/intervalIntervalInterval between data syncsstring

Sample

captures:
${PREFIX}/${CAPTURE_NAME}:
endpoint:
connector:
image: ghcr.io/estuary/source-iterate:dev
config:
credentials:
credentials_title: Private App Credentials
access_token: <secret>
bindings:
- resource:
name: surveys
target: ${PREFIX}/admins
- resource:
name: survey_responses
target: ${PREFIX}/companies