Reference · built on requestConnectorField service & CMMS

Housecall Pro

Customers, jobs, appointments, estimates, and invoices from Housecall Pro through its v1 REST API and signed webhooks.

Request accessPricing ↗

About

Housecall Pro is scheduling, dispatch, estimating, and invoicing software for home service companies. Its public v1 API at https://api.housecallpro.com exposes customers and addresses, leads, estimates and their options, jobs with line items and appointments, job invoices, employees, tags, service zones, and the price book. Webhooks announce job, appointment, estimate, customer, lead, and invoice events, each signed with an Api-Signature header. The API is available to accounts on the MAX or XL plan.

Fibric reads jobs and appointments, listens for the signed events, and proposes schedule changes, dispatch changes, notes, and customer updates. A person in the office approves each one before it is written.

This is a reference listing. It documents what Fibric would read from Housecall Pro and what it could propose, based on the vendor's published interfaces. Fibric builds it under a managed deployment when you request it; selecting it here installs nothing.

Inputs

  • Jobs with work_status, schedule, assigned_employees, and appointments through GET /jobs, filtered by customer, employee, and scheduled window
  • Customers and their addresses, leads, and estimates with their options and approval status
  • Job invoices and invoices with balances, payments, and due dates
  • Employees, job types, tags, lead sources, service zones, and the price book (materials and services)
  • Webhook events for jobs (job.scheduled, job.on_my_way, job.started, job.completed, job.paid), appointments, estimates, customers, leads, and invoices
  • Schedule events through Get Events, and multi-location reads through the X-Company-Id header

Proposed actions

  • Target capability: propose a job schedule change through Update job schedule, or a technician change through Dispatch job to employees
  • Target capability: propose creating, updating, or deleting a job appointment
  • Target capability: propose a job note, tag, or attachment on the job record
  • Target capability: propose a new customer or a customer update, or a new lead
  • Target capability: propose approving or declining estimate options once the customer's answer is on record

Proposed actions are target capabilities. Every action runs propose-first and needs a validated deployment and the appropriate permissions.

What you can build

  • Tell the customer the technician is on the way

    A job.on_my_way event arrives with the assigned employee and arrival window. The operator drafts the message and proposes the send for approval.

    With ETA Notice

  • Rebook a discarded appointment

    job.appointment.appointment_discarded fires. The operator reads the job's window and service zone, finds an open slot, and proposes Create appointment plus Dispatch job to employees for the dispatcher.

    With Field Dispatch

  • Chase estimates that were sent and never answered

    estimate.sent events are matched against estimate.option.approval_status_changed. Unanswered estimates get a drafted follow-up the operator proposes for approval.

    With Abandoned Quote

  • Retry failed invoice payments

    invoice.payment.failed events are read with the invoice balance. The operator proposes the retry message and timing; a person approves before it goes out.

    With Payment Retry

Requirements

  • A Housecall Pro account on the MAX or XL plan, which can generate API keys
  • A webhook signing secret from the account, and webhooks configured for that account or for an approved OAuth application
  • An endpoint that recomputes the Api-Signature header as an HMAC-SHA256 of the Api-Timestamp, a dot, and the JSON payload
  • For OAuth 2.0: a client ID, client secret, and redirect URI issued by Housecall Pro after an email request
Authentication
An API key sent as Authorization: Token <key>, which any Housecall Pro account on the MAX or XL plan can generate; OAuth 2.0 authorization code tokens (Authorization: Bearer) are issued only to integration companies Housecall Pro approves.

Limits

  • Rate limits apply and are not published as numbers; a 429 carries a RateLimit-Reset header with the epoch time the limit resets
  • OAuth 2.0 is reserved for integration companies Housecall Pro approves; other integrations use per-account API keys
  • Employees, invoices, and schedule events are read-only in the v1 API
  • GET /jobs returns 10 jobs per page by default and pages through page and page_size

Access and pricing

Reference listing. Fibric builds the connector under a managed deployment when you request it. Your quote covers the build, capabilities, usage, and support.

Request Housecall Pro ↗

Questions and answers

Which plans include the Housecall Pro API?
The MAX and XL plans. Any account on those plans can generate API keys and use the v1 API at https://api.housecallpro.com. Third-party software companies can also apply to build an integration; those approved use OAuth 2.0 instead of keys.
How is a webhook signature checked?
Each event carries Api-Timestamp and Api-Signature headers. Concatenate the timestamp, a dot, and the JSON payload, compute an HMAC with SHA-256 using your signing secret, and compare it to Api-Signature. Every payload also includes event, company_id, and event_occurred_at.
What are the rate limits?
Housecall Pro does not publish a number. When the limit is exceeded, requests receive a 429 with a RateLimit-Reset header holding the epoch time the limit resets. Accounts that hit it regularly are asked to email apideveloper@housecallpro.com.
Ask about Housecall Pro

Ask about the capabilities and requirements in this listing.

For project-specific requirements, contact Fibric.

This connector listing is developed, published, and supported by Fibric. It describes integration with Housecall Pro through published interfaces. Third-party names and logos identify the systems an integration connects to; they are the property of their respective owners, who are not affiliated with Fibric and do not sponsor or endorse this listing. Trademark policy