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.1.22024-05-2138545[autopull] base image + poetry + up_to_date
0.1.12023-02-1620960New Source: Railz