Housecall Pro

What’s Supported

Supported Actions

This connector supports:

• Read Actions, including full historic backfill. Please note that incremental read is not supported for all objects.
• Write Actions.
• Proxy Actions, using the base URL https://api.housecallpro.com.

Supported Objects

The Housecall Pro connector supports the following objects.

• customers (read, write; incremental read supported)
• employees (read)
• estimates (read, write; incremental read supported)
• events (read; incremental read supported)
• jobs (read, write; incremental read supported)
• job_fields/job_types (read, write)
• leads (read, write)
• lead_sources (read, write)
• price_book/materials (write)
• price_book/material_categories (read, write; incremental read supported)
• price_book/price_forms (read, write)
• price_book/services (read)
• service_zones (read)
• routes (read)
• tags (read, write)
• invoices (read)

Example integration

For an example manifest file of a Housecall Pro integration, visit our samples repo on GitHub.

Before you get started

To use the Housecall Pro connector, you’ll need an API Key from your Housecall Pro account. Here’s how to get it:

1. Sign into your Housecall Pro account and go to App Store.
2. Find the API Key Management under My Apps, and click on it.
3. On the right-hand side, click Generate API Key.
4. Name your API Key.
5. Copy the API Key.

For more details, see the Housecall Pro Authentication documentation.

Using the connector

This connector uses API Key authentication, which means that you do not need to set up a Provider App before getting started. (Provider apps are only required for providers that use OAuth2 Authorization Code grant type.)

To integrate with Housecall Pro:

• Create a manifest file like the example.
• Deploy it using the amp CLI.
• If you are using Read Actions, create a destination.
• Embed the InstallIntegration UI component. The UI component will prompt the customer for an API key.
• Start using the connector!
  • If your integration has Read Actions, you’ll start getting webhook messages.
  • If your integration has Write Actions, you can start making API calls to our Write API.
  • If your integration has Proxy Actions, you can start making Proxy API calls.