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, and more. Specifically, for the Application resource with the Create Address operation (which is actually under the "customers" resource in this implementation), it allows creating a new address associated with a specific customer.

A common use case is when you want to programmatically add an address to a customer's profile in Housecall Pro, for example, when onboarding a new client or updating their contact information automatically from another system.

Practical example: After collecting customer details via a form, you can use this node to create the customer record and then add one or multiple addresses to that customer without manual entry in the Housecall Pro dashboard.

Properties

Name Meaning
Resource The type of entity to interact with (e.g., Application, Customer, Job).
Operation The action to perform on the selected resource. For Application resource, options include enabling, disabling, or getting the application. For Customers resource, includes creating addresses.
Customer ID The unique identifier of the customer to whom the address will be added.
Address Details Collection of fields describing the address to create: street, street line 2, city, state, zip, country (default "USA").

Note: Although the user requested the "Application" resource and "Create Address" operation, the actual "Create Address" operation is implemented under the "customers" resource with operation value "post-customer-customer_id-addresses".

Output

The node outputs JSON data representing the response from the Housecall Pro API after performing the requested operation. For creating an address, the output JSON contains the newly created address details including all submitted fields and any additional metadata returned by the API.

No binary data output is involved in this operation.

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 credential in n8n is necessary for successful requests.

Troubleshooting

  • Invalid Customer ID: If the provided customer ID does not exist, the API will return an error. Verify the customer ID before attempting to create an address.
  • Missing Required Fields: Ensure that at least the minimal required address fields (such as street and city) are provided; otherwise, the API may reject the request.
  • Authentication Errors: If the API key is invalid or missing, authentication errors will occur. Confirm that the API credential is correctly set up in n8n.
  • API Rate Limits: Excessive requests might lead to rate limiting by the Housecall Pro API. Implement retries or backoff strategies if needed.

Links and References

Discussion