Skip to main content

Orb

Overview

The Orb source supports both Full Refresh and Incremental syncs. For incremental syncs, this source will only read and output new records based on their created_at timestamp.

Output schema

This Source is capable of syncing the following core resources, each of which has a separate Stream. Note that all of the streams are incremental:

As a caveat, the Credits Ledger Entries must read all Customers for an incremental sync, but will only incrementally return new ledger entries for each customers.

Note on Incremental Syncs

The Orb API does not allow querying objects based on an updated_at time. Therefore, this connector uses the created_at field to query for new data since the last sync.

In order to capture data that has been updated after creation, please run a periodic Full Refresh.

Features

FeatureSupported?
Full Refresh SyncYes
Incremental - Append SyncYes
Incremental - Dedupe SyncYes
SSL connectionYes

Performance considerations

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

Getting started

Requirements

  • Orb Account
  • Orb API Key

Setup guide

Please reach out to the Orb team at team@withorb.com to request an Orb Account and API Key.

Changelog

VersionDatePull RequestSubject
0.1.22022-04-2011528Add cost basis to ledger entries, update expiration date, sync only committed entries
0.1.12022-03-0310839Support ledger entries with numeric properties + schema fixes
0.1.02022-02-01New Source: Orb
:---:---:---:---