# Orb Integration

Integrating Orb with Sphere enables a.) seamless transaction data import and b.) live tax calculation within Orb invoices. &#x20;

This guide provides step-by-step instructions on generating an API key in Orb, linking it to Sphere for a secure integration, and setting up a webhook connection between the two platforms.&#x20;

It also covers configuring the Sphere Tax API within Orb to ensure accurate tax calculations.

### Part 1: Configure Data Synchronization from Orb to Sphere

**Note:** Ensure that the test mode flag is turned off in Orb and that you are in live mode.

1. In your Sphere account, click on the **Connect** button on the Orb tile.

<figure><img src="/files/7jWmvmeHqgXa9eT8zblE" alt=""><figcaption></figcaption></figure>

2. In another window, open your Orb dashboard and navigate to the **Developers** tab. Click **API Keys**.

<figure><img src="/files/FzjE7W3dXjtskyQkmBLh" alt=""><figcaption></figcaption></figure>

3. Click the **+ New API Key** button at the top.

<figure><img src="/files/Jqy8hXSOCXaRpD9mZk6B" alt=""><figcaption></figcaption></figure>

4. A modal will appear allowing you to enter the **key name** and a **description**. Once finished, click **Create**.

<figure><img src="/files/kUQ5Fyigq7jxOW1z8ngn" alt=""><figcaption></figcaption></figure>

5. A new key will be created. Be sure to save it, as you won’t be able to view it again.

<figure><img src="/files/mscMaJ5piqyLzBpp0gyv" alt=""><figcaption></figcaption></figure>

6. Go back to your Sphere account and enter the API key generated in Step 4. Ensure there are no extra spaces before or after the value.

<figure><img src="/files/Ypgy6uTjLEYaYc8yuKr4" alt=""><figcaption></figcaption></figure>

7. Click **Next** to complete the setup. A success message will confirm the connection. Next, you'll proceed with setting up the webhook. Copy the Orb Webhook URL.

<figure><img src="/files/1ZNAmhtTjmCbic6YS6II" alt=""><figcaption></figcaption></figure>

8. Return to the **Orb Dashboard**, go to the **Developers** tab, and click **Webhooks**.

<figure><img src="/files/msXNMNkRoK3nphkRHEAh" alt=""><figcaption></figcaption></figure>

9. Click the **+ Add endpoint** button.

<figure><img src="/files/GLKiCURVGwV1Jn7C7qA2" alt=""><figcaption></figcaption></figure>

10. A modal will appear, prompting you to enter the **Endpoint URL** you copied from **Sphere** (Orb Webhook URL) in Step 7. Click **Add Endpoint**.

<figure><img src="/files/GbLptIfQcE7ho8atGjgr" alt=""><figcaption></figcaption></figure>

11. You will see the **Endpoint URL** successfully added to the list. Click the URL that was just added.

<figure><img src="/files/l71r1NZYbK7hfpZeVcKl" alt=""><figcaption></figcaption></figure>

12. In the top right corner, expand the dropdown and click **View Signing Secret**.

<figure><img src="/files/u6XniGFbLH8OTgLt2guE" alt=""><figcaption></figcaption></figure>

13. Copy the **Signing Secret**. You will be pasting this value into **Sphere**.

<figure><img src="/files/qkDcceYVVCq3wMJuMyR9" alt=""><figcaption></figcaption></figure>

14. Go back to the **Sphere dashboard**. In the **Orb Webhook Secret** input field, paste the **Signing Secret** copied in Part 13, then click **Done**.

<figure><img src="/files/jtulWN3zVOJwVeCYMF85" alt=""><figcaption></figcaption></figure>

15. You’re all set! If the connection is successful, data will begin importing, and after some time, your products will appear in **Sphere**.

<figure><img src="/files/njkYrs8KmXQeIJzJDLXR" alt=""><figcaption></figcaption></figure>

### Part 2: Configure Sphere Tax API Key for Tax Calculation

1. Navigate to the settings in Orb and select the Integrations tab.

<figure><img src="/files/fjLfmwx0QIkzemdsmtQt" alt=""><figcaption></figcaption></figure>

2. Locate Sphere tax in the Taxes section and click **"Connect Sphere"**.

<figure><img src="/files/24C3kS7216nvEHdzO2fb" alt=""><figcaption></figcaption></figure>

3. In Sphere, click on "**Create a new API Key**" to generate the Sphere Tax API Key. Be sure to save the newly generated key, as it cannot be viewed again later.

<figure><img src="/files/aWVJ39LdNRcc545nTVZa" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/y2iQxy1KMRYG77acU2zp" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/n6zGarqOuDs81eeHHPGb" alt=""><figcaption></figcaption></figure>

4. Enter your Sphere Tax API Key into the text box and click **"Connect"**.&#x20;

<figure><img src="/files/fGxgzpPieYo2BnRNItA3" alt=""><figcaption></figcaption></figure>

5. After completing the setup, the connection status will be set to **Active**.

<figure><img src="/files/tQbZ6hMZRpDQe4N0zppl" alt=""><figcaption></figcaption></figure>

***

### Set up a connection between your Orb test account and Sphere

To integrate your Orb test environment with Sphere, begin by enabling **test mode** in your Orb account. You can do this by toggling the switch located at the top of the Orb dashboard.

**Note:** Before proceeding, please check with your Sphere representative to confirm that your Sphere test account is properly set up and aligned with your testing requirements.

Once test mode is activated:

* A **green notification bar** will appear across the top of the Orb dashboard, indicating that you are operating within the test environment.
* All data and operations within this mode will remain isolated from your live/production Orb environment, ensuring a safe testing experience.

After test mode is enabled, you can proceed to connect Sphere by following the same steps outlined above for production setup.

For more information on using Orb’s test mode and environment setup, please refer to the official [Orb documentation](https://docs.withorb.com/quickstart/introduction).

<figure><img src="/files/FKfim4ggmkT9j8PMOkA2" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/ZeOXcUz96idbUJLot0f8" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.getsphere.com/features/integrations/prebuilt-connectors/orb-integration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
