> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ampersand.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Orb

## What's supported

### Supported actions

This connector supports:

* [Read Actions](https://docs.ampersand.ai/read-actions.md), including full historic backfill. Each scheduled read reads every record again.
* [Proxy Actions](https://docs.ampersand.ai/proxy-actions.md), using the base URL `https://api.withorb.com`.

### Supported objects

The Orb connector supports reading from the following objects:

* [customers](https://docs.withorb.com/api-reference/customer/list-customers)
* [invoices](https://docs.withorb.com/api-reference/invoice/list-invoices)
* [metrics](https://docs.withorb.com/api-reference/metric/list-metrics)
* [subscriptions](https://docs.withorb.com/api-reference/subscription/list-subscriptions)

### Example integration

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

```YAML theme={"dark"}
# 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](https://www.withorb.com).

### Creating an API key for Orb

1. Log in to the Orb dashboard.
2. Go to the **Developers** section and click **API Keys**.
3. 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.
4. 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](#example-integration).
* Deploy it using the [amp CLI](https://docs.ampersand.ai/cli/overview.md).
* If you are using Read Actions, create a [destination](https://docs.ampersand.ai/destinations).
* Embed the [InstallIntegration](https://docs.ampersand.ai/embeddable-ui-components.md#install-integration) UI component. The UI component will prompt the consumer for their API key.
* Start using the connector!
  * If your integration has [Read Actions](https://docs.ampersand.ai/read-actions.md), you'll start getting webhook messages.
  * If your integration has [Proxy Actions](https://docs.ampersand.ai/proxy-actions.md), 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`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.