Connecting your SugarAI workspace

Connecting SugarAI requires an admin step inside your SugarAI instance before entering credentials in getsignals. This takes about five minutes and only needs to be done once.

Written By Kevin Lawrie

Last updated 16 days ago

Step 1: Register the API platform in SugarAI

Before connecting, a SugarAI admin needs to register getsignals as an API platform in your SugarAI instance.

  1. Log in to SugarAI as an admin.

  2. Go to Admin then Configure API Platforms.

  3. Add custom_getsignals (exact spelling, lowercase, with underscore).

  4. Click Add then Save.

If this step is skipped, the connection will fail.

💡 Tip: Use a dedicated integration user with API access rather than a personal admin login. This keeps the connection stable if admin credentials change.

Step 2: Connect in getsignals

  1. Go to Integrations in the left sidebar.

  2. Find SugarAI and click Enable Integration. You land on the Sync Hub.

  3. From the Connection tab.

  4. Enter your credentials:

Input

What to enter

Instance URL

Your SugarAI instance URL, e.g. https://yourcompany.sugarai.com

API username

The username of your integration user, e.g. integration@yourcompany.com

API password

The API password for that user

  1. Click Connect SugarAI.

On success you'll see a Connected badge and a confirmation toast.

Advanced OAuth settings (optional)

If your SugarAI instance uses custom OAuth keys, expand the Advanced OAuth Key section:

Input

Default

OAuth Client ID

sugar

OAuth Client Secret

Leave empty for default

Find custom values in your SugarAI instance under Admin then OAuth Keys. Most instances do not need to change these.

After connecting

The Connection tab shows three buttons when connected:

  • Verify connection: confirms credentials are still valid and shows the connected username

  • Update credentials: re-enter credentials if your password changes

  • Disconnect: removes the integration from getsignals

After connecting, go to the Matching Settings tab next. Syncs cannot run until at least one LinkedIn match field is configured.

Disconnecting

Click Disconnect on the Connection tab. This removes the integration from getsignals. Your SugarAI records and notes are not affected. The custom_getsignals API platform registration in SugarAI can be left in place for reconnecting later.