Housecall Pro

Interact with the Housecall Pro API

Overview

This node integrates with the Housecall Pro API to manage various resources related to service businesses, such as applications, customers, jobs, invoices, and more. Specifically, for the Application resource with the Create operation (which corresponds to enabling the application), it allows users to enable the Housecall Pro application for a company.

Common scenarios where this node is beneficial include automating the activation or management of the Housecall Pro application within workflows, such as onboarding new companies or toggling application availability programmatically.

For example, a workflow could automatically enable the Housecall Pro application for a newly registered company in your system by using this node’s Application Create (Enable) operation.

Properties

Name Meaning
Application Operation Routing Hidden property that maps operations to HTTP methods and API endpoints for the Application resource. For "Create" (enable), it uses POST on /application/enable.

Note: The provided input properties JSON only includes the hidden routing mapping for the Application resource operations. No additional user-facing input fields are defined for the Create operation under Application.

Output

The node outputs the JSON response returned by the Housecall Pro API after performing the requested operation. For the Application Create (Enable) operation, this typically includes confirmation details about the enabled application status.

The output structure is a standard JSON object representing the API response. There is no binary data output for this operation.

Dependencies

  • Requires an active connection to the Housecall Pro API.
  • Requires an API authentication token credential configured in n8n to authorize requests.
  • The base URL for API requests is https://api.housecallpro.com.
  • The node sends and expects JSON-formatted data.

Troubleshooting

  • Authentication errors: Ensure the API key or authentication token credential is correctly set up and has sufficient permissions.
  • Invalid endpoint or method: The operation must match one of the predefined routes; otherwise, the API will return an error.
  • Network issues: Verify network connectivity to api.housecallpro.com.
  • Missing required parameters: Although the Create operation for Application does not expose additional fields, other operations might require specific parameters.

If the node returns an error message from the API, check the exact HTTP status code and message for clues (e.g., 401 Unauthorized, 404 Not Found).

Links and References

Discussion