Orb Integration

Integrating Orb with Sphere enables seamless transaction data import. This guide provides step-by-step instructions on generating an API key in Orb and connecting it to Sphere for a smooth and secure integration. It also covers setting up a webhook connection between Sphere and Orb. Follow the steps below to get started.

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

1. 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. In the Sphere dashboard, go to the Integrations tab and click Connect on the Orb card.

1. Enter the API key generated in Step 4.

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