Housecall Pro

Beta feature. The Housecall Pro integration is currently in beta.

What does the Housecall Pro integration do?

Hatch offers a native integration with Housecall Pro that you can activate within the App Marketplace (located in your Hatch workspace). This integration syncs contact, lead, job, and estimate data from Housecall Pro to Hatch, and can also sync Hatch events to Housecall Pro. To get started, open the App Marketplace in your Hatch workspace and follow the setup instructions below.

How do you set up the integration?

Requirements

You will need the following to set up the integration:

Hatch account with manager privileges
Housecall Pro MAX account
Housecall Pro API Key

Setup Steps

The Housecall Pro integration authenticates with an API Key, and uses webhooks for real-time syncing. Setup happens in the Hatch App Marketplace, with two steps that require your Housecall Pro account: generating an API Key up front, and registering a webhook URL back in Housecall Pro after you install.

API access requires a Housecall Pro MAX plan. If you don’t see the API section in your Housecall Pro settings, confirm your plan level before proceeding.

The following is the set of steps required to activate the integration:

In Housecall Pro, generate your API Key.
1. Navigate to your Housecall Pro account and go to My Apps -> All Apps
2. Find and select API Key Management
3. Generate API Key
4. Name your API Key and provide it with Full access
In Hatch, open the App Marketplace.
Under the CRMs filter, click the Connect button for Housecall Pro.
Proceed through the setup until you reach the connection configuration screen.
When prompted, paste your Housecall Pro API Key into the API Key field and continue to authenticate.
1. If the key is rejected, re-copy it from Housecall Pro — a trailing space or an expired/regenerated key is the most common cause.
Object and Field selection — confirm the Housecall Pro objects and fields you’d like to sync into Hatch. For each object, once you finish selecting all fields to sync, select “Save” in the top right. Objects include:
1. Customers (synced as Contacts)
2. Leads (synced as Opportunities)
3. Jobs (synced as Job opportunities)
4. Estimates (synced as Estimate opportunities)
Click Finish to complete the installation.
1. If successfully activated, the integration will begin syncing your last 90 days of data.
Register the Webhook URL — the Webhook URL panel appears only after you click Finish and the integration installs, because the URL is unique to your completed installation. Once it appears:
1. Copy the Webhook URL shown in Hatch.
2. In Housecall Pro, go to My Apps → App Store → Webhooks.
3. Paste the copied Webhook URL and save.
4. In the webhooks section, ensure you check off all webhook events. For more information, please read this Housecall Pro help article.
5. This step is required. Without the webhook registered in Housecall Pro, new and updated records will not sync into Hatch after the initial 90-day backfill.

Please ensure all webhook events are enabled in Housecall Pro. Once complete, you can ignore the prompt in the configuration.

Configuration Options

These options can be set during the integration setup: Choose the Housecall Pro data that syncs to Hatch:

Choose which Housecall Pro objects the integration should sync: Customers, Leads, Jobs, Estimates. Each maps to a Hatch opportunity model (see “How is Housecall Pro data stored in Hatch?” below).
Field selection is not automatic. In order to access fields from Housecall Pro objects, you must enable them in the configuration.
A unique, per-installation Webhook URL is generated once you finish installing the integration. It does not appear until after install. This URL must be pasted into Housecall Pro’s Webhooks app (My Apps → App Store → Webhooks) to enable real-time syncing of created, updated, and deleted records, as well as appointment events (scheduled, rescheduled, discarded, and pro assigned/unassigned).

Push Events and Communications:

When enabled, Hatch events and communications are pushed to Housecall Pro as Customer notes. Because Housecall Pro stores notes as a single plain-text string on the Customer (there is no multi-note collection), Hatch appends each event to the Customer’s existing notes.
Only the Customer and Lead opportunity models are eligible for push communications. For a Lead, Hatch resolves the Lead’s underlying Customer and appends the note there.

When does Hatch sync data to/from Housecall Pro?

Housecall Pro → Hatch

Housecall Pro data can be sync’d to Hatch in the following scenarios. These options are configured during the integration setup (/integrations/crm-field-management-systems/housecall-pro#setup-steps).

Housecall Pro data syncs in real time. When a record is created, updated, or deleted in Housecall Pro, Housecall Pro sends a webhook to Hatch and the change syncs immediately — there is no polling interval. When the integration is first activated, Hatch backfills the last 90 days of data.

When a Customer record is created, updated, or deleted in Housecall Pro, Hatch syncs the Customer as a contact along with any associated data (see below for specific fields)
When a Lead record is created, updated, or deleted in Housecall Pro, Hatch syncs the Lead along with its inline customer data (see below for specific fields)
When a Job record is created, updated, or deleted in Housecall Pro, Hatch syncs the Job along with its associated Customer (see below for specific fields)
When a Job appointment is scheduled, rescheduled, discarded, or a pro is assigned/unassigned, Hatch receives the corresponding appointment event
When an Estimate record is created, updated, or deleted in Housecall Pro, Hatch syncs the Estimate along with its associated Customer (see below for specific fields)

Hatch → Housecall Pro

Hatch events and/or communications can be sync’d to Housecall Pro in the following scenarios. These options are configured during the integration setup.

When a Hatch campaign sends a text/email/voicemail to a contact, Hatch appends a Note for the event to the associated Housecall Pro Customer
When a contact calls or sends a text/email/voicemail to a Hatch workspace, Hatch appends a Note for the event to the associated Housecall Pro Customer
When a Hatch user calls or sends a text/email to a contact, Hatch appends a Note for the event to the associated Housecall Pro Customer
When events occur within a Hatch campaign, Hatch appends a Note for the event to the associated Housecall Pro Customer

Only the Customer and Lead opportunity models are eligible for push communications. For a Lead, Hatch resolves the Lead’s underlying Customer and appends the note there. Notes are plain text only. Housecall Pro enforces a 65,000-character limit on the Customer notes field.

How is Housecall Pro data stored in Hatch?

Opportunity Models

There are four types of Hatch opportunities that the Housecall Pro integration creates:

Contact Opportunity — Created from Housecall Pro Customer records. Housecall Pro has no account concept, so customers never carry account associations, and each customer produces one standalone opportunity.
Lead Opportunity — Created from Housecall Pro Lead records. A lead carries its customer inline (rather than through an association), so the opportunity’s contact info (email/phone/name) is derived from the lead’s own customer fields. Housecall Pro leads carry no created/updated timestamps, so those fall back to the record’s ingestion time in Hatch.
Job Opportunity — Created from Housecall Pro Job records. Each job produces one opportunity, deriving email/phone/name from the job’s associated Customer. A job with no associated contact is skipped.
Estimate Opportunity — Created from Housecall Pro Estimate records. Each estimate produces one opportunity, deriving email/phone/name from the estimate’s associated Customer. An estimate with no associated contact is skipped.

What Housecall Pro data is available in Hatch?

Selecting Object Resources

The Housecall Pro integration syncs three object types from Housecall Pro: Customers, Leads, Jobs. Unlike the granular per-resource object selector, the Housecall Pro integration automatically syncs the full set of native fields for each supported object rather than a curated subset. For every object, Hatch captures a minimal set of required fields (the fields Hatch needs to build a valid opportunity — id, name, email, phone, status, and timestamps) plus all remaining native Housecall Pro fields for that object, which are preserved in full on the opportunity’s details. The objects available with each opportunity model are:

Contact (Customer) — The Housecall Pro Customer record, including contact points and addresses. Required for any Housecall Pro campaign.
Lead — The Housecall Pro Lead record, including its inline customer, address, lead source, tags, and pipeline status.
Job — The Housecall Pro Job record, including work status, schedule, assigned employees, and its associated Customer.
Estimate — The Housecall Pro Estimate record, including work status, schedule, assigned employees, and its associated Customer.

Available Resource Fields

Contact opportunity (base object: Housecall Pro Customer):

Resource	Field Name	Data Type
Customer	contact:id	String
Customer	contact:first_name	String
Customer	contact:last_name	String
Customer	contact:email	String
Customer	contact:mobile_number	String
Customer	contact:home_number	String
Customer	contact:work_number	String
Customer	contact:company	String
Customer	contact:lead_source	String
Customer	contact:notifications_enabled	Boolean
Customer	contact:created_at	Date
Customer	contact:updated_at	Date
Address	contact:addresses:#:id	String
Address	contact:addresses:#:street	String
Address	contact:addresses:#:street_line_2	String
Address	contact:addresses:#:city	String
Address	contact:addresses:#:state	String
Address	contact:addresses:#:zip	String
Address	contact:addresses:#:country	String

Lead opportunity (base object: Housecall Pro Lead):

Resource	Field Name	Data Type
Lead	opportunity:id	String
Lead	opportunity:number	Number
Lead	opportunity:status	String
Lead	opportunity:pipeline_status	String
Lead	opportunity:lead_source	String
Lead	opportunity:company_name	String
Lead	opportunity:company_id	String
Lead	opportunity:lost_at	Date
Customer	opportunity:customer:id	String
Customer	opportunity:customer:first_name	String
Customer	opportunity:customer:last_name	String
Customer	opportunity:customer:email	String
Customer	opportunity:customer:mobile_number	String
Customer	opportunity:customer:home_number	String
Customer	opportunity:customer:work_number	String
Customer	opportunity:customer:company	String
Customer	opportunity:customer:lead_source	String
Customer	opportunity:customer:notifications_enabled	Boolean
Address	opportunity:address:id	String
Address	opportunity:address:street	String
Address	opportunity:address:street_line_2	String
Address	opportunity:address:city	String
Address	opportunity:address:state	String
Address	opportunity:address:zip	String
Assigned Employee	opportunity:assigned_employee:id	String
Assigned Employee	opportunity:assigned_employee:first_name	String
Assigned Employee	opportunity:assigned_employee:last_name	String
Assigned Employee	opportunity:assigned_employee:email	String
Assigned Employee	opportunity:assigned_employee:mobile_number	String
Assigned Employee	opportunity:assigned_employee:role	String
Assigned Employee	opportunity:assigned_employee:company_name	String
Assigned Employee	opportunity:assigned_employee:company_id	String
Employee Permissions	opportunity:assigned_employee:permissions:can_add_and_edit_job	Boolean
Employee Permissions	opportunity:assigned_employee:permissions:can_be_booked_online	Boolean
Employee Permissions	opportunity:assigned_employee:permissions:can_see_customers	Boolean
Employee Permissions	opportunity:assigned_employee:permissions:can_see_full_schedule	Boolean
Employee Permissions	opportunity:assigned_employee:permissions:is_point_of_contact	Boolean
Employee Permissions	opportunity:assigned_employee:permissions:is_admin	Boolean

Job opportunity (base object: Housecall Pro Job, plus its associated Customer)

Resource	Field Name	Data Type
Job	job:id	String
Job	job:invoice_number	String
Job	job:description	String
Job	job:work_status	String
Job	job:lead_source	String
Job	job:original_estimate_id	String
Job	job:company_name	String
Job	job:company_id	String
Job	job:total_amount	Number
Job	job:subtotal	Number
Job	job:outstanding_balance	Number
Job	job:recurrence_number	Number
Job	job:recurrence_rule	String
Job	job:created_at	Date
Job	job:updated_at	Date
Job	job:locked_at	Date
Job	job:canceled_at	Date
Job	job:deleted_at	Date
Customer	job:customer:id	String
Customer	job:customer:first_name	String
Customer	job:customer:last_name	String
Customer	job:customer:email	String
Customer	job:customer:mobile_number	String
Customer	job:customer:home_number	String
Customer	job:customer:work_number	String
Customer	job:customer:company	String
Customer	job:customer:company_name	String
Customer	job:customer:company_id	String
Customer	job:customer:lead_source	String
Customer	job:customer:notifications_enabled	Boolean

Estimate opportunity (base object: Housecall Pro Estimate, plus its associated Customer):

Resource	Field Name	Data Type
Estimate	estimate:id	String
Estimate	estimate:estimate_number	String
Estimate	estimate:work_status	String
Estimate	estimate:lead_source	String
Estimate	estimate:company_name	String
Estimate	estimate:company_id	String
Estimate	estimate:created_at	Date
Estimate	estimate:updated_at	Date
Customer	estimate:customer:id	String
Customer	estimate:customer:first_name	String
Customer	estimate:customer:last_name	String
Customer	estimate:customer:email	String
Customer	estimate:customer:mobile_number	String
Customer	estimate:customer:home_number	String
Customer	estimate:customer:work_number	String
Customer	estimate:customer:company	String
Customer	estimate:customer:company_name	String
Customer	estimate:customer:company_id	String
Customer	estimate:customer:lead_source	String
Customer	estimate:customer:notes	String
Customer	estimate:customer:notifications_enabled	Boolean
Customer	estimate:customer:created_at	Date
Customer	estimate:customer:updated_at	Date
Address	estimate:address:id	String
Address	estimate:address:type	String
Address	estimate:address:street	String
Address	estimate:address:street_line_2	String
Address	estimate:address:city	String
Address	estimate:address:state	String
Address	estimate:address:zip	String
Address	estimate:address:country	String
Work Timestamps	estimate:work_timestamps:on_my_way_at	Date
Work Timestamps	estimate:work_timestamps:started_at	Date
Work Timestamps	estimate:work_timestamps:completed_at	Date
Schedule	estimate:schedule:scheduled_start	Date
Schedule	estimate:schedule:scheduled_end	Date
Schedule	estimate:schedule:arrival_window	Number (minutes)
Appointments	estimate:schedule:appointments:#:id	String
Appointments	estimate:schedule:appointments:#:start_date	Date
Appointments	estimate:schedule:appointments:#:start_time	Date
Appointments	estimate:schedule:appointments:#:end_time	Date
Appointments	estimate:schedule:appointments:#:anytime	Boolean
Appointments	estimate:schedule:appointments:#:arrival_window_minutes	Number
Assigned Employees	estimate:assigned_employees:#:id	String
Assigned Employees	estimate:assigned_employees:#:first_name	String
Assigned Employees	estimate:assigned_employees:#:last_name	String
Assigned Employees	estimate:assigned_employees:#:email	String
Assigned Employees	estimate:assigned_employees:#:mobile_number	String
Assigned Employees	estimate:assigned_employees:#:role	String
Assigned Employees	estimate:assigned_employees:#:created_at	Date
Employee Permissions	estimate:assigned_employees:#:permissions:can_add_and_edit_job	Boolean
Employee Permissions	estimate:assigned_employees:#:permissions:can_be_booked_online	Boolean
Employee Permissions	estimate:assigned_employees:#:permissions:can_see_customers	Boolean
Employee Permissions	estimate:assigned_employees:#:permissions:can_see_full_schedule	Boolean
Employee Permissions	estimate:assigned_employees:#:permissions:is_point_of_contact	Boolean
Employee Permissions	estimate:assigned_employees:#:permissions:is_admin	Boolean
Job Type	estimate:estimate_fields:job_type_id	String
Business Unit	estimate:estimate_fields:business_unit_id	String
Options	estimate:options:#:id	String
Options	estimate:options:#:name	String
Options	estimate:options:#:option_number	String
Options	estimate:options:#:total_amount	Number
Options	estimate:options:#:approval_status	String
Options	estimate:options:#:status	String
Options	estimate:options:#:message_from_pro	String
Options	estimate:options:#:created_at	Date
Options	estimate:options:#:updated_at	Date

Standard Field Mapping

Hatch standard fields are mapped from Housecall Pro detail fields as detailed below. Contact Opportunity

The base object of this opportunity model is the Housecall Pro Customer. Therefore, (as an example) the id field would indicate the ID of the Housecall Pro Customer record.

In Contact opportunities, the following Hatch standard fields are mapped from Housecall Pro detail fields:

Hatch Standard Field	Housecall Pro Detail Field
Email	email
External ID	id
External Contact ID	id
External Contact Model	customer
External Opportunity Model	customer
External Created At	created_at
External Updated At	updated_at
First Name	first_name
Last Name	last_name
Phone	mobile_number

Lead Opportunity

The base object of this opportunity model is the Housecall Pro Lead. The lead carries its customer inline, so name/email/phone are mapped from the lead’s customer object.

In Lead opportunities, the following Hatch standard fields are mapped from Housecall Pro detail fields:

Hatch Standard Field	Housecall Pro Detail Field
Email	customer:email
External ID	id
External Contact ID	id
External Contact Model	lead
External Opportunity Model	lead
External Created At	The record’s Hatch ingestion time (Housecall Pro Leads carry no timestamp)
External Updated At	The record’s Hatch ingestion time (Housecall Pro Leads carry no timestamp)
First Name	customer:first_name
Last Name	customer:last_name
Phone	customer:mobile_number
Status	status

Job Opportunity

The base object of this opportunity model is the Housecall Pro Job. Therefore, (as an example) the id field would indicate the ID of the Housecall Pro Job record. Contact fields (name/email/phone) are derived from the job’s associated Customer.

In Job opportunities, the following Hatch standard fields are mapped from Housecall Pro detail fields:

Hatch Standard Field	Housecall Pro Detail Field
Email	The associated contact (Customer) email
External ID	id (the Job id)
External Contact ID	The associated contact (Customer) id
External Contact Model	customer
External Opportunity Model	job
External Created At	created_at
External Updated At	updated_at
First Name	The associated contact (Customer) first_name
Last Name	The associated contact (Customer) last_name
Phone	The associated contact (Customer) mobile_number
Status	work_status

Estimate Opportunity

The base object of this opportunity model is the Housecall Pro Estimate. Therefore, (as an example) the id field would indicate the ID of the Housecall Pro Estimate record. Contact fields (name/email/phone) are derived from the estimate’s associated Customer.

In Estimate opportunities, the following Hatch standard fields are mapped from Housecall Pro detail fields:

Hatch Standard Field	Housecall Pro Detail Field
Email	The associated contact (Customer) email
External ID	id (the Estimate id)
External Contact ID	The associated contact (Customer) id
External Contact Model	customer
External Opportunity Model	Estimate
External Created At	created_at
External Updated At	updated_at
First Name	The associated contact (Customer) first_name
Last Name	The associated contact (Customer) last_name
Phone	The associated contact (Customer) mobile_number
Status	work_status

Frequently Asked Questions

I enabled each object in the configuration, why am I not receiving new contacts?

Please ensure the webhook URL was copied correctly into Housecall Pro and all webhook events have been checked.

I enabled webhooks in Housecall Pro, why is Hatch still instructing me to add the webhooks

Once this step is complete, you can ignore this message!

General

Hatch API

Hatch Webhooks

Lead Sources

CRMs & Field Management Systems

Contractor Tools

What does the Housecall Pro integration do?

How do you set up the integration?

Requirements

Setup Steps

Configuration Options

When does Hatch sync data to/from Housecall Pro?

Housecall Pro → Hatch

Hatch → Housecall Pro

How is Housecall Pro data stored in Hatch?

Opportunity Models

What Housecall Pro data is available in Hatch?

Selecting Object Resources

Available Resource Fields

Contact opportunity (base object: Housecall Pro Customer):

Lead opportunity (base object: Housecall Pro Lead):

Job opportunity (base object: Housecall Pro Job, plus its associated Customer)

Estimate opportunity (base object: Housecall Pro Estimate, plus its associated Customer):

Standard Field Mapping

Frequently Asked Questions

​What does the Housecall Pro integration do?

​How do you set up the integration?

​Requirements

​Setup Steps

​Configuration Options

​When does Hatch sync data to/from Housecall Pro?

​Housecall Pro → Hatch

​Hatch → Housecall Pro

​How is Housecall Pro data stored in Hatch?

​Opportunity Models

​What Housecall Pro data is available in Hatch?

​Selecting Object Resources

​Available Resource Fields

Contact opportunity (base object: Housecall Pro Customer):

Lead opportunity (base object: Housecall Pro Lead):

Job opportunity (base object: Housecall Pro Job, plus its associated Customer)

Estimate opportunity (base object: Housecall Pro Estimate, plus its associated Customer):

​Standard Field Mapping

​Frequently Asked Questions

What does the Housecall Pro integration do?

How do you set up the integration?

Requirements

Setup Steps

Configuration Options

When does Hatch sync data to/from Housecall Pro?

Housecall Pro → Hatch

Hatch → Housecall Pro

How is Housecall Pro data stored in Hatch?

Opportunity Models

What Housecall Pro data is available in Hatch?

Selecting Object Resources

Available Resource Fields

Standard Field Mapping

Frequently Asked Questions