Housecall Pro

Interact with the Housecall Pro API

Overview

The node interacts with the Housecall Pro API to manage customer data and application status. Specifically, for the Customer resource and Disable Application operation, it disables the application for a company via an API call.

This node is useful in automation workflows where you need to programmatically disable a company's application access, for example:

  • Automatically disabling access when a subscription expires.
  • Temporarily suspending a company's application usage based on certain triggers.
  • Integrating with other systems to control application availability without manual intervention.

Properties

Name Meaning
Customer Operation Routing Hidden property defining HTTP methods and endpoints for various customer-related actions. For customers, it includes operations like get, create, update, and address management.
Additional Fields (for Customers) Optional filters and pagination parameters for listing customers, such as search query, page number, items per page, sort attribute, and sort direction.
Customer ID The unique identifier of a customer, used for retrieving or updating specific customer data.
Update Fields Collection of fields to update customer attributes like first name, last name, email, company, notification preferences, and phone numbers.
Customer Details Collection of details required to create a new customer, including names, contact info, company, lead source, and notes.
Address Details Collection of address information for creating a new customer address, including street, city, state, zip, and country.

For the Disable Application operation specifically (under the Application resource), no additional input properties are required beyond selecting the operation itself.

Output

The node outputs JSON data representing the response from the Housecall Pro API after performing the requested operation. For the Disable Application operation, this typically includes confirmation of the application's disabled status or any relevant metadata returned by the API.

If binary data were involved (not in this case), it would be included in the output's binary field, but this operation deals solely with JSON responses.

Dependencies

  • Requires an API key credential for authenticating with the Housecall Pro API.
  • The base URL for API requests is https://api.housecallpro.com.
  • Proper configuration of the API authentication token in n8n credentials is necessary.

Troubleshooting

  • Authentication errors: Ensure the API key credential is correctly configured and has sufficient permissions.
  • Invalid customer ID: When specifying a customer ID, verify it exists and is correctly formatted.
  • API rate limits: The Housecall Pro API may limit request rates; handle retries or backoff accordingly.
  • Operation not allowed: Disabling the application might require specific account privileges; check user permissions.
  • Network issues: Confirm network connectivity to the Housecall Pro API endpoint.

Common error messages will generally come from the API response and should be inspected in the node's output for details.

Links and References

Discussion