Skip to main content

Orb source

This connector lets you authenticate to the Orb API and validate access. Extraction and available streams are still in development.

Setup​

Prerequisites​

  • An Orb account
  • An Orb API key with permission to read customers (used for connection validation)

Create an Orb API key​

  1. In Orb, generate an API key (see Orb’s documentation for the most up-to-date steps).
  2. Copy the key and store it securely.

Authentication​

This source uses Bearer token authentication via an Orb API key.

  • The connector sends requests to Orb with Authorization: Bearer <api_key>.
  • During connection testing/login, the connector validates credentials by calling:
    • GET https://api.withorb.com/v1/customers?limit=1

Configuration​

FieldTypeRequiredDescription
api_keystring✅Your Orb API key used to authenticate to the Orb API.

Streams​

No streams are currently exposed.

  • The connector’s catalog is currently empty.
  • Extraction is not yet available (the connector is still in development).