Connecting Broker Buddha (Forms Integration & API Test)

Connect Broker Buddha AI to Broker Buddha Classic to unlock seamless form management, automated document workflows, and real-time sync of your companies, contacts, applications, and forms between the two platforms. Once connected, you can also use the built-in API Test page to verify that each endpoint is returning the data you expect.

🖼️ [Image placeholder: Broker Buddha integration configuration page header with "Available" status badge.]

🔐 Who Can Use This

Only Account Owners and Billing Managers can connect, configure, or manage the Broker Buddha Classic integration. Standard Users will not see the Integrations tab in Settings.

🧭 Getting to the Broker Buddha Integration

1. Click your avatar (top right) and choose Settings.
2. Select the Integrations tab.
3. Click the Available sub-tab.
4. Under Other Systems, find the Broker Buddha card and click Configure.

🖼️ [Image placeholder: Integrations → Available tab highlighting the Broker Buddha card under "Other Systems" with the Configure button.]

⚙️ Configuring Broker Buddha Classic

Step 1 — Enter Your API Credentials

On the Configuration card, enter the following:

• API Endpoint (required) — Select the environment for your BB Classic API endpoint:
  • Production (api.brokerbuddha.com)  (default)
• API Key (required) — Your API key from the Broker Buddha Classic admin panel.

🖼️ [Image placeholder: Configuration card showing API Endpoint dropdown and API Key field.]

Step 2 — Test & Enable

1. Click Test Connection to verify your credentials before going live.
2. Once the test succeeds, click Enable Integration to activate.
3. Use Cancel to discard changes without saving.

🖼️ [Image placeholder: Action bar showing Cancel, Test Connection, and Enable Integration buttons.]

✨ Broker Buddha Features

Streamline your form management and document workflows with these capabilities:

• Automated form filling from your customer data
• Digital document generation and management
• Electronic signature integration
• Template library access and customization
• Real-time form status tracking
• Bulk document processing capabilities

🛠️ Setup Instructions

To connect your Broker Buddha Classic account, you'll need your API key:

1. Log into your Broker Buddha Classic admin panel.
2. Navigate to Settings → API Keys.
3. Generate a new API key or copy your existing one.
4. Enter your API key in the form on the BB AI configuration page.
5. Click Test Connection to verify your credentials.
6. Click Enable Integration to save and activate.

Helpful Links: Broker Buddha API Documentation and Contact Support (linked on the configuration page).

🖼️ [Image placeholder: Setup Instructions card showing the six-step checklist.]

🧪 Using the API Test Page

Once the integration is active, click API Test on the Broker Buddha card to open the Broker Buddha Classic API Test Page. Use this page to test BB Classic API endpoints and view responses in real-time.

Click Back to Config at the top right to return to the configuration page.

🖼️ [Image placeholder: API Test page header with "Back to Config" button.]

Connection Test

• Test Connection — Runs a basic connectivity check against the configured API endpoint.

Companies

List and retrieve company information:

• List Companies — Enter Page and Limit, then click Get Companies.
• Get Company by ID — Select a company ID, then click Get Company Details.

Contacts

List and retrieve contact information:

• List Contacts — Filter by All Companies, set Page and Limit, then click Get Contacts.
• Get Contact by ID — Select a contact ID, then click Get Contact Details.

Applications

List, retrieve, create, and update applications:

• List Applications — Filter by All Companies and All Contacts, set Page and Limit, then click Get Applications.
• Get Application by ID — Select an application ID, then click Get Application Details.
• Create Application — Choose a Company ID (required), then click Create Application.
• Update Application — Select an application ID, then click Update Application.

Forms

List and retrieve form information:

• List Forms — Enter Page and Limit, then click Get Forms.
• Get Form by ID — Select a form ID, then click Get Form Details.

API Responses

The right-hand API Responses panel shows request results and responses in real-time. When the page first loads you'll see:

"No API calls yet. Use the controls on the left to test endpoints."

As you run tests, each request and response will appear here so you can verify the output.

🖼️ [Image placeholder: API Test page split view — left panel showing endpoint controls (Companies, Contacts, Applications, Forms), right panel showing the API Responses log.]

💡 Best Practices

• 🧪 Always Test Connection first — It validates your API key against the selected endpoint without enabling the integration.
• 🔑 Store your API key securely — Treat it like a password. Anyone with the key can access your BB Classic data.
• 📄 Use the API Test page to troubleshoot — If something isn't syncing, hit List Companies or Test Connection to confirm the endpoint is reachable and returning data.
• 🧱 Start with a small Limit (e.g., 5 or 10) when listing Companies, Contacts, Applications, or Forms so responses stay easy to scan.
• 🔁 Regenerate your API key in BB Classic if you suspect it's been exposed — then update it on the BB AI configuration page and click Test Connection again.