Orb Integration

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

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.

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.

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

1. Click the + New API Key button at the top.

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

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

1. 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.

1. Click Save 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.

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

1. Click the + Add endpoint button.

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

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

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

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

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

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

Part 2: Configure Sphere Tax API Key for Tax Calculation

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

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

1. 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.

1. Enter your Sphere Tax API Key into the text box and click "Connect".

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