ContextQMD
Back to Airbyte

Iterable

docs/integrations/sources/iterable.md

2.0.021.2 KB
Original Source

Iterable

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

Prerequisites

To set up the Iterable source connector, you need:

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

Performance and data retrieval

Incremental sync behavior

Streams that support incremental sync use the following approaches:

  • Users stream: Splits data retrieval into 90-day intervals to manage large data volumes efficiently. The stream uses the profileUpdatedAt field as the cursor for incremental syncs.
  • Event streams (Email, Push, SMS, In-App, Web Push, Inbox events): Use adaptive date range slicing to handle varying data volumes. The connector automatically adjusts slice sizes based on API response times and handles connection timeouts gracefully.
  • Templates stream: Supports incremental sync using the updatedAt field as the cursor.

Error handling

The List Users stream handles 500 - Generic Error responses gracefully by skipping the affected list and continuing to process remaining lists. This behavior prevents individual list errors from blocking the entire sync and is related to intermittent API failures when retrieving users for specific list IDs.

The connector implements retry logic with exponential backoff for rate limiting (HTTP 429) and server errors (HTTP 500-599), with up to 10 retries and delays ranging from 20 to 400 seconds.

Changelog

<details> <summary>Expand to review</summary>
VersionDatePull RequestSubject
0.6.542026-03-03TBDFilter duplicate records in export streams during incremental syncs
0.6.532025-10-2168545Update dependencies
0.6.522025-10-1467947Update dependencies
0.6.512025-10-1067602Fix array schema definitions
0.6.502025-10-0767361Update dependencies
0.6.492025-09-3066798Update dependencies
0.6.482025-09-0966107Update dependencies
0.6.472025-08-2365380Update dependencies
0.6.462025-08-1664970Update dependencies
0.6.452025-08-0964604Update dependencies
0.6.442025-08-0264284Update dependencies
0.6.432025-07-2663868Update dependencies
0.6.422025-07-1963451Update dependencies
0.6.412025-07-1263141Update dependencies
0.6.402025-07-0562665Update dependencies
0.6.392025-06-2862174Update dependencies
0.6.382025-06-2161814Update dependencies
0.6.372025-06-1461119Update dependencies
0.6.362025-05-2458772Update dependencies
0.6.352025-05-2260854Update dependencies and expected records
0.6.342025-04-1257737Update dependencies
0.6.332025-04-0557057Update dependencies
0.6.322025-03-2956655Update dependencies
0.6.312025-03-2256015Update dependencies
0.6.302025-03-0855510Update dependencies
0.6.292025-03-0154759Update dependencies
0.6.282025-02-2254287Update dependencies
0.6.272025-02-1553814Update dependencies
0.6.262025-02-0152726Update dependencies
0.6.252025-01-2552277Update dependencies
0.6.242025-01-1151163Update dependencies
0.6.232025-01-0450889Update dependencies
0.6.222024-12-2850608Update dependencies
0.6.212024-12-2150101Update dependencies
0.6.202024-12-1449211Starting with this version, the Docker image is now rootless. Please note that this and future versions will not be compatible with Airbyte versions earlier than 0.64
0.6.192024-12-1248993Update dependencies
0.6.182024-11-0448294Update dependencies
0.6.172024-10-2947803Update dependencies
0.6.162024-10-2847487Update dependencies
0.6.152024-10-2347057Update dependencies
0.6.142024-10-1246814Update dependencies
0.6.132024-10-0546399Update dependencies
0.6.122024-09-2846155Update dependencies
0.6.112024-09-2145828Update dependencies
0.6.102024-09-1445518Update dependencies
0.6.92024-09-0745221Update dependencies
0.6.82024-08-3145029Update dependencies
0.6.72024-08-2444636Update dependencies
0.6.62024-08-1744260Update dependencies
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-2930931Added 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
</details>