Skip to main content

Railz

This source can sync data for the Railz API. This page guides you through the process of setting up the Railz source connector.

Prerequisites​

  • A Railz account with permission to access data from accounts you want to sync.
  • Railz Client ID and Secret key

Setup guide​

Step 1: Set up Railz​

Generate API key on the dashboard and take it's client_id and secret_key.

Step 2: Set up the source connector in Airbyte​

For Airbyte Cloud:

  1. Log into your Airbyte Cloud account;
  2. In the left navigation bar, click Sources. In the top-right corner, click + new source;
  3. On the source setup page, select Railz from the Source type dropdown and enter a name for this connector;
  4. Enter Client ID (client_id);
  5. Enter Secret key (secret_key);
  6. Enter Start date (optional);
  7. click Set up source.

For Airbyte Open Source:

  1. Go to local Airbyte page;
  2. In the left navigation bar, click Sources. In the top-right corner, click + new source;
  3. On the source setup page, select Railz from the Source type dropdown and enter a name for this connector;
  4. Enter Client ID (client_id);
  5. Enter Secret key (secret_key);
  6. Enter Start date;
  7. click Set up source.

Supported sync modes​

The Railz supports full refresh and incremental sync.

FeatureSupported?
Full Refresh SyncYes
Incremental SyncYes

Supported Streams​

Several output streams are available from this source:

If there are more endpoints you'd like Airbyte to support, please create an issue.

Performance considerations​

The Railz connector should gracefully handle Railz API limitations under normal usage. Please create an issue if you see any rate limit issues that are not automatically retried successfully.

Reference​

Config fields reference

Field
Type
Property name
string
client_id
string
secret_key
string
start_date

Changelog​

Expand to review
VersionDatePull RequestSubject
0.2.112025-05-2460560Update dependencies
0.2.102025-05-1060145Update dependencies
0.2.92025-05-0359502Update dependencies
0.2.82025-04-2759087Update dependencies
0.2.72025-04-1958477Update dependencies
0.2.62025-04-1257878Update dependencies
0.2.52025-04-0557324Update dependencies
0.2.42025-03-2956792Update dependencies
0.2.32025-03-2256177Update dependencies
0.2.22025-03-0853971Update dependencies
0.2.12025-02-2454164Remove stream_state interpolation from record filter
0.2.02025-02-0547244Migrate to manifest only format
0.1.262025-02-0152978Update dependencies
0.1.252025-01-2552519Update dependencies
0.1.242025-01-1851928Update dependencies
0.1.232025-01-1151318Update dependencies
0.1.222025-01-0450926Update dependencies
0.1.212024-12-2850699Update dependencies
0.1.202024-12-2150266Update dependencies
0.1.192024-12-1449067Starting 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.1.182024-10-2847114Update dependencies
0.1.172024-10-1246786Update dependencies
0.1.162024-10-0546462Update dependencies
0.1.152024-09-2846182Update dependencies
0.1.142024-09-2145811Update dependencies
0.1.132024-09-1445576Update dependencies
0.1.122024-09-0745317Update dependencies
0.1.112024-08-3145036Update dependencies
0.1.102024-08-2444649Update dependencies
0.1.92024-08-1744206Update dependencies
0.1.82024-08-1243801Update dependencies
0.1.72024-08-1043541Update dependencies
0.1.62024-08-0343288Update dependencies
0.1.52024-07-2742674Update dependencies
0.1.42024-07-2040029Update dependencies
0.1.32024-07-1942125Fix Python MRO bug
0.1.22024-05-2138545[autopull] base image + poetry + up_to_date
0.1.12023-02-1620960New Source: Railz