Overview

The Bushel Connection Service enables Users to opt-in to sharing their data in Bushel with external integrations. This document describes the User’s experience as they register and manage which accounts are subscribed to a 3rd party integration. The Connection Service user interface is mobile-responsive, allowing Users to manage their subscriptions from any device including desktop computers and mobile phones. For information on integrating your service with the Bushel’s Connection Service, see Getting Started.

Connection Registration Flow

After being directed to the connection service from the external integration’s website, the User is first authenticated in Bushel’s system. If not already logged in to Bushel, the User is prompted to login with their Bushel credentials.

Once authenticated, the User is presented with a list of all accounts they have access to across all companies within Bushel’s network.

Account selection screen

The User may select one or more of their accounts to be included in the data feed sent to the external integration.

Once the account selections are made, the User is prompted to confirm their choices.

Account confirmation screen

After the User confirms their selections, the Subscriptions are updated in Bushel and updated data will begin flowing to the integration. The User is presented with a confirmation screen allowing them to return to the Integration’s application.

Confirmation Screen

Managing Connections

Users can manage their existing connections by revisiting the Connection Service link provided by the integration. The process is identical to the initial registration:

  1. The User authenticates.

  2. The User is presented with their current account selections.

  3. The User can select new accounts or deselect existing ones.

  4. The User confirms the changes.

  5. The subscriptions are updated, and the User is redirected back to the integration.

Error Handling

Users may encounter the following states during the connection process:

  • No Accounts Found: If the authenticated User does not have access to any accounts within the Bushel network, they will see a "No Accounts" message.

  • Authentication Error: If there is an issue with the User’s session or the provided consumerJWT is invalid/expired, an authentication error is displayed.

  • Connection Error: If an error occurs while saving the account selections (e.g., network issues), a modal error message will appear, prompting the User to try again.