Skip to main content

Iterable

This page contains the setup guide and reference information for the Iterable source connector.

Prerequisites

To set up the Iterable source connector, you'll need the Iterable Server-side API Key with standard permissions.

Set up the Iterable connector in Airbyte

  1. Log into your Airbyte Cloud account or navigate to the Airbyte Open Source dashboard.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select Iterable from the Source type dropdown.
  4. Enter the name for the Iterable connector.
  5. For API Key, enter the Iterable API key.
  6. For Start Date, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated.
  7. Click Set up source.

Supported sync modes

The Iterable source connector supports the following sync modes:

Supported Streams

Additional notes

List Users Stream when meet 500 - Generic Error will skip a broken slice and keep going with the next one. This is related to unexpected failures when trying to get users list for specific list ids. See #24968 issue for more details.

Reference

Config fields reference

Field
Type
Property name
string
api_key
string
start_date

Changelog

Expand to review
VersionDatePull RequestSubject
0.6.52024-08-1243899Update dependencies
0.6.42024-08-1043527Update dependencies
0.6.32024-08-0343142Update dependencies
0.6.22024-07-2742653Update dependencies
0.6.12024-07-2342449Fix OOM errors; bum CDK version
0.6.02024-07-2241983Fix OOM errors; update CDK to v3
0.5.112024-07-2042228Update dependencies
0.5.102024-07-1341684Update dependencies
0.5.92024-07-1041401Update dependencies
0.5.82024-07-0941293Update dependencies
0.5.72024-07-0640811Update dependencies
0.5.62024-06-2540362Update dependencies
0.5.52024-06-2240080Update dependencies
0.5.42024-06-1739382Refactor state handling for Python incremental streams
0.5.32024-06-0539142Updated the CDK version to 0.89.0 to fix OOM
0.5.22024-06-0439077[autopull] Upgrade base image to v1.2.1
0.5.12024-04-2436645Schema descriptions and CDK 0.80.0
0.5.02024-03-1836231Migrate connector to low-code
0.4.02024-03-1936267Pin airbyte-cdk version to ^0
0.3.02024-02-2035465Per-error reporting and continue sync on stream failures
0.2.22024-02-1235150Manage dependencies with Poetry.
0.2.12024-01-121234prepare for airbyte-lib
0.2.02023-09-2928457Added userId to email_bounce, email_click, email_complaint, email_open, email_send email_send_skip, email_subscribe, email_unsubscribe, events streams
0.1.312023-12-0633106Base image migration: remove Dockerfile and use the python-connector-base image
0.1.302023-07-1928457Fixed TypeError for StreamSlice in debug mode
0.1.292023-05-2426459Added requests reading timeout 300 seconds
0.1.282023-05-1226014Improve 500 handling for Events stream
0.1.272023-04-0624962UserList stream when meet 500 - Generic Error will skip a broken slice and keep going with the next one
0.1.262023-03-1023938Improve retry for 500 - Generic Error
0.1.252023-03-0723821Added retry for 500 - Generic Error, increased max attempts number to 6 to handle ChunkedEncodingError
0.1.242023-02-1422979Specified date formatting in specification
0.1.232023-01-2722011Set AvailabilityStrategy for streams explicitly to None
0.1.222022-11-3019913Replace pendulum.parse -> dateutil.parser.parse to avoid memory leak
0.1.212022-10-2718537Improve streams discovery
0.1.202022-10-2118292Better processing of 401 and 429 errors
0.1.192022-10-0517602Add check for stream permissions
0.1.182022-10-0417573Limit time range for SATs
0.1.172022-09-0216067added new events streams
0.1.162022-08-1515670Api key is passed via header
0.1.152021-12-068524Update connector fields title/description
0.1.142021-12-018380Update Events stream to use export/userEvents endpoint
0.1.132021-11-228091Adjust slice ranges for email streams
0.1.122021-11-097780Split EmailSend stream into slices to fix premature connection close error
0.1.112021-11-037619Bugfix type error while incrementally loading the Templates stream
0.1.102021-11-037591Optimize export streams memory consumption for large requests
0.1.92021-10-065915Enable campaign_metrics stream
0.1.82021-09-205915Add new streams: campaign_metrics, events
0.1.72021-09-206242Updated schema for: campaigns, lists, templates, metadata