Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: new connector source-iterate #1912

Merged
merged 1 commit into from
Jan 31, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions site/docs/reference/Connectors/capture-connectors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,9 @@ All Estuary connectors capture data in real time, as it appears in the source sy
- Iterable
- [Configuration](./iterable.md)
- Package - ghcr.io/estuary/source-iterable:dev
- Iterate
- [Configuration](./iterate.md)
- Package - ghcr.io/estuary/source-iterate:dev
- Jira
- [Configuration](./jira-native.md)
- Package - ghcr.io/estuary/source-jira-native:dev
Expand Down
66 changes: 66 additions & 0 deletions site/docs/reference/Connectors/capture-connectors/iterate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@

# 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`](https://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:

* [Surveys](https://iterate.docs.apiary.io/#reference/0//surveys)
* [Survey Responses](https://iterate.docs.apiary.io/#reference/0//surveys/{id}/responses)

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

## Prerequisites

* An Iterate [API access token](https://iterate.docs.apiary.io/#introduction/overview/authentication)

## Configuration

You configure connectors either in the Flow web app, or by directly editing the catalog specification file.
See [connectors](../../../concepts/connectors.md#using-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.

| Property | Title | Description | Type | Required/Default |
|---|---|---|---|---|
| **`/credentials/access_token`** | Access Token | Iterate Access token. | string | Required |
| **`/credentials/credentials_title`** | Credentials | Name of the credentials set | string | Required, `"Private App Credentials"` |


#### Bindings

| Property | Title | Description | Type | Required/Default |
|---|---|---|---|---|
| **`/name`** | Data resource | Name of the data resource. | string | Required |
| `/interval` | Interval | Interval between data syncs | string | |


### Sample

```yaml
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
```