Orb - Ampersand

What’s supported

Supported actions

This connector supports:

Read Actions, including full historic backfill. Each scheduled read reads every record again.
Proxy Actions, using the base URL https://api.withorb.com.

Supported objects

The Orb connector supports reading from the following objects:

Example integration

To define an integration for Orb, create a manifest file that looks like this:

# amp.yaml
specVersion: 1.0.0
integrations:
  - name: orbIntegration
    displayName: My Orb Integration
    provider: orb
    read:
      objects:
        - objectName: subscriptions
          destination: myWebhook
    proxy:
      enabled: true

Before you get started

To connect Orb with Ampersand, you will need an Orb account.

Creating an API key for Orb

Log in to the Orb dashboard.
Go to the Developers section and click API Keys.
Create a new API key and give it a name. A key created while Test Mode is on only reaches Test Mode data, so create the key outside Test Mode to read production data.
Copy the key.

Using the connector

This connector uses API Key auth, which means that you do not need to set up a Provider App before getting started. (Provider apps are only required for providers that use OAuth2 Authorization Code grant type.) To start integrating with Orb:

Create a manifest file like the example above.
Deploy it using the amp CLI.
If you are using Read Actions, create a destination.
Embed the InstallIntegration UI component. The UI component will prompt the consumer for their API key.
Start using the connector!
- If your integration has Read Actions, you’ll start getting webhook messages.
- If your integration has Proxy Actions, you can start making Proxy API calls.

Notes

invoices includes invoices of every status: draft, issued, paid, synced and void. A draft invoice holds Orb’s last computed amounts, which may lag behind usage that Orb hasn’t processed yet.
metrics are Orb’s billable metrics, including archived ones.
Orb’s API paths start with its version, so Proxy calls include it, for example GET /v1/customers.

​What’s supported

​Supported actions

​Supported objects

​Example integration

​Before you get started

​Creating an API key for Orb

​Using the connector

​Notes