Housecall Pro

Overview

This node integrates with the Housecall Pro API to create a new customer record in the system. It is useful for automating customer management workflows, such as adding new clients from form submissions, CRM systems, or other data sources directly into Housecall Pro without manual entry.

Typical scenarios include:

• Automatically creating customers when a new lead is captured.
• Syncing customer data from external databases or applications.
• Streamlining onboarding processes by programmatically adding customer details.

For example, after collecting customer information via a web form, this node can be used to add that customer to Housecall Pro, enabling further scheduling, invoicing, and communication within the platform.

Properties

Customer Details Fields Breakdown

• First Name: Customer's first name.
• Last Name: Customer's last name.
• Email: Customer's email address.
• Company: Customer's company name.
• Notifications Enabled: Whether the customer will receive notifications (true/false).
• Mobile Number: Customer's mobile phone number.
• Home Number: Customer's home phone number.
• Work Number: Customer's work phone number.
• Lead Source: Origin of the lead/customer.
• Notes: Additional notes about the customer.

Output

The node outputs JSON data representing the newly created customer object as returned by the Housecall Pro API. This typically includes the customer's unique ID, contact details, notification preferences, and any other metadata assigned by the API.

No binary data output is involved.

Dependencies

• Requires an active connection to the Housecall Pro API.
• Needs an API authentication token configured in n8n credentials to authorize requests.
• The base URL for API requests is https://api.housecallpro.com.
• The node sends HTTP POST requests with JSON payloads containing customer details.

Troubleshooting

• Missing Required Fields: The API requires at least one of these fields: first name, last name, email, mobile number, home number, or work number. Omitting all may cause validation errors.
• Authentication Errors: Ensure the API key credential is correctly set up and has sufficient permissions.
• Invalid Field Formats: Email addresses should be valid; phone numbers should follow expected formats to avoid rejection.
• API Rate Limits: Excessive requests might trigger rate limiting; implement retries or delays if needed.
• Network Issues: Verify network connectivity to api.housecallpro.com.

Common error messages:

• 400 Bad Request: Usually indicates missing or invalid input fields.
• 401 Unauthorized: Authentication failure due to invalid or missing API token.
• 429 Too Many Requests: Rate limit exceeded; wait before retrying.

Resolving these involves checking input data, verifying credentials, and respecting API usage limits.

Links and References

• Housecall Pro API Documentation
• n8n Documentation on HTTP Request Node (for understanding underlying request mechanics)