Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.withampersand.com/llms.txt

Use this file to discover all available pages before exploring further.

​
What’s Supported

​
Supported Actions

This connector supports:

​
Supported Objects

ObjectReadWriteSubscribeNotes
customers✓ (incremental)✓✓
employees✓✓¹
estimates✓ (incremental)✓✓
events✓ (incremental)
jobs✓ (incremental)✓✓
job_fields/job_types✓✓
leads✓✓✓²
lead_sources✓✓
price_book/materials✓
price_book/material_categories✓ (incremental)✓
price_book/price_forms✓✓
price_book/services✓
service_zones✓
routes✓
tags✓✓
invoices✓✓
job.appointments✓³
¹ Subscribe only via otherEvents. In Housecall Pro’s webhook UI, this event appears as pro.created, but the actual payload uses employee.created. Example fragment: 
- objectName: employee
  destination: housecallProWebhook
  otherEvents:
    - employee.created
² Delete events for leads are not reliable due to Housecall Pro platform limitations. ³ Subscribe only via otherEvents. Standard events are not supported. Example fragment: 
- objectName: job.appointments
  destination: housecallProWebhook
  otherEvents:
    - job.appointment.scheduled
    - job.appointment.rescheduled
    - job.appointment.appointment_discarded
    - job.appointment.appointment_pros_assigned
    - job.appointment.appointment_pros_unassigned

​
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.
Housecall Pro 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 or Subscribe Actions, create a destination.
  • Embed the InstallIntegration UI component. The UI component will prompt the customer for an API key.
  • Start using the connector!

​
Set up Subscribe Actions

To receive subscribe events from Housecall Pro, the customer will enable webhooks in their Housecall Pro UI using a webhook URL you provide. The flow:
  1. Define the subscribe action in your amp.yaml and deploy it with the amp CLI.
  2. Generate a webhook URL for each customer in this format: 
    https://subscribe-webhook.withampersand.com/v1/projects/PROJECT_ID/integrations/INTEGRATION_ID/installations/INSTALLATION_ID
  3. Share the Housecall Pro customer guide with the customer and the webhook URL from Step 2. The customer will paste the webhook URL into the Housecall Pro UI and enable the events your integration subscribes to.