Iterable
This connector captures data from Iterable into Flow collections.
It is available for use in the Flow web application. For local development or open-source workflows, ghcr.io/estuary/source-iterable: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 Iterable APIs:
- Campaigns
- Campaign Metrics
- Channels
- Email Bounce
- Email Click
- Email Complaint
- Email Open
- Email Send
- Email Send Skip
- Email Subscribe
- Email Unsubscribe
- Events
- Lists
- List Users
- Message Types
- Metadata
- Templates
- Users
- PushSend
- PushSendSkip
- PushOpen
- PushUninstall
- PushBounce
- WebPushSend
- WebPushClick
- WebPushSendSkip
- InAppSend
- InAppOpen
- InAppClick
- InAppClose
- InAppDelete
- InAppDelivery
- InAppSendSkip
- InboxSession
- InboxMessageImpression
- SmsSend
- SmsBounce
- SmsClick
- SmsReceived
- SmsSendSkip
- SmsUsageInfo
- Purchase
- CustomEvent
- HostedUnsubscribeClick
By default, each resource is mapped to a Flow collection through a separate binding.
Prerequisites
- To set up the Iterable source connector, you'll need the Iterable
Server-side
API Key withstandard
permissions.
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 Iterable source connector.
Properties
Endpoint
Property | Title | Description | Type | Required/Default |
---|---|---|---|---|
/apikey | API Key | The value of the Iterable API Key generated. | string | Required |
/start_date | Start Date | UTC date and time in the format 2021-01-25T00:00:00Z. Any data before this date will not be replicated. | string | Required |
Bindings
Property | Title | Description | Type | Required/Default |
---|---|---|---|---|
/stream | Stream | Resource of your Iterable project from which collections are captured. | string | Required |
/syncMode | Sync Mode | Connection method. | string | Required |
Sample
captures:
${PREFIX}/${CAPTURE_NAME}:
endpoint:
connector:
image: ghcr.io/estuary/source-iterable:dev
config:
apikey: <secret>
start_date: 2017-01-25T00:00:00Z
bindings:
- resource:
stream: purchase
syncMode: full_refresh
target: ${PREFIX}/purchase
{...}