Housecall Pro Connector setup guide

Overview

The Housecall Pro Connector enables your TradeVulcan platform to securely connect with your Housecall Pro account using MAX API-key access. This connector is currently designed for testing purposes before app-specific sync workflows become available. It provides a foundational integration for future capabilities such as account mapping and workflow triggers.

Setup Prerequisites

• Obtain your Housecall Pro MAX API key from your Housecall Pro account settings.
• Have your preferred API Base URL ready (typically the production or sandbox endpoint from Housecall Pro).
• Ensure your TradeVulcan account has the connector.housecallpro feature flag enabled for access.
• Review the Housecall Pro API documentation for MAX API (see Housecall Pro Docs).
• Decide if you will use testing mode (sandbox) or production data.

Step-by-step Setup

1. Enable the Connector Feature Flag
   Navigate to your TradeVulcan admin console and enable the feature flag connector.housecallpro. This is mandatory to activate the Housecall Pro Connector.
2. Access Connector Settings
   Go to the Connectors section and select Housecall Pro Connector from the list.
3. Fill in Required Fields
   Complete the following settings:
   • Account label: Assign a descriptive name to identify this Housecall Pro account connection.
   • API base URL: Enter the Housecall Pro API base URL (for production or sandbox environment).
   • API key: Enter your secure MAX API key from Housecall Pro.
   • Testing mode: Optionally enable sandbox mode to test without affecting live data.
4. Save Connector Setup
   Click "Save" to persist your configuration.
5. Verify Connection
   Use the built-in test functionality or manual API calls to confirm the connector can access your Housecall Pro account successfully.

Features

• Basic API-key authentication testing against Housecall Pro MAX API endpoints.
• Sandbox mode to test without impacting real data.
• Foundation for incorporating advanced sync workflows and account mapping in upcoming updates.

Verification

After configuration, perform these steps to verify your setup:

• Check connector status is active with no error messages.
• Run API connectivity tests available in TradeVulcan or use external API tools with your credentials.
• Review logs for successful authentication and data retrieval attempts.
• Consult your Housecall Pro account to verify that requested information aligns with connector expectations.

Troubleshooting

• Invalid API Key: Double-check that your API key is correctly entered and active in Housecall Pro.
• Incorrect Base URL: Confirm you are using the correct API endpoint URL matching sandbox or production.
• Feature Flag Disabled: Ensure the connector.housecallpro feature flag is enabled in TradeVulcan.
• Sandbox Mode Issues: If testing, verify you have real sandbox credentials and that your Housecall Pro account is in test mode.
• Connectivity Errors: Check network/firewall settings allowing TradeVulcan service to reach Housecall Pro APIs.
• API Limits: Refer to Housecall Pro API documentation for any rate limits or access restrictions.

Support Handoff Notes

When escalating to implementation or support teams, please provide:

• Connector account label and environment (sandbox vs production)
• API base URL and partial API key (keep full keys confidential)
• Description of verification steps and errors encountered
• Relevant TradeVulcan connector logs or error messages
• Confirmation of feature flag status in TradeVulcan
• Any recent changes to Housecall Pro account or API credentials

These details help expedite diagnosis and resolution.

Additional Resources

For detailed API references and support articles, visit the official Housecall Pro documentation: https://docs.housecallpro.com/