> ## Documentation Index
> Fetch the complete documentation index at: https://ampersand-24eb5c1a-odoo-deep.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Housecall Pro

## Checklist before you start

Confirm the following:

* You are a Housecall Pro **Admin** user.
* Your Housecall Pro account has a **MAX subscription**.

## 1. Generate your Housecall Pro API key

Follow these steps to generate your Housecall Pro API key.

1. Click the **My Apps** icon (3x3 grid) in the top-right corner.
   <img src="https://mintcdn.com/ampersand-24eb5c1a-odoo-deep/fwtaWPJ1ifWtcnE7/images/customer-guides/housecallPro/myapps.png?fit=max&auto=format&n=fwtaWPJ1ifWtcnE7&q=85&s=97b143949f541e93f337c9c1a8bfc828" width="1907" height="1017" data-path="images/customer-guides/housecallPro/myapps.png" />
2. Click **Go to App Store**.
   <img src="https://mintcdn.com/ampersand-24eb5c1a-odoo-deep/fwtaWPJ1ifWtcnE7/images/customer-guides/housecallPro/appstore.png?fit=max&auto=format&n=fwtaWPJ1ifWtcnE7&q=85&s=ec7007900722ac65329b3fbaac2d4b2d" width="2120" height="1129" data-path="images/customer-guides/housecallPro/appstore.png" />
3. Under **My Apps**, find and open the **API Key Management** app card.
   <img src="https://mintcdn.com/ampersand-24eb5c1a-odoo-deep/fwtaWPJ1ifWtcnE7/images/customer-guides/housecallPro/apikey.png?fit=max&auto=format&n=fwtaWPJ1ifWtcnE7&q=85&s=9c6df2be86d5f43a58a4df5866db3493" width="1720" height="898" data-path="images/customer-guides/housecallPro/apikey.png" />
4. Click **Generate API Key**.
   <img src="https://mintcdn.com/ampersand-24eb5c1a-odoo-deep/fwtaWPJ1ifWtcnE7/images/customer-guides/housecallPro/generate.png?fit=max&auto=format&n=fwtaWPJ1ifWtcnE7&q=85&s=9ed50a0f21f0f13cb0bfb45c42d44e73" width="1364" height="712" data-path="images/customer-guides/housecallPro/generate.png" />
5. Enter a descriptive name for the key.
   <img src="https://mintcdn.com/ampersand-24eb5c1a-odoo-deep/fwtaWPJ1ifWtcnE7/images/customer-guides/housecallPro/new.png?fit=max&auto=format&n=fwtaWPJ1ifWtcnE7&q=85&s=c8e7f1bdad115e04e78079f317c0d522" width="841" height="388" data-path="images/customer-guides/housecallPro/new.png" />
6. Copy the API key and store it securely.
   <img src="https://mintcdn.com/ampersand-24eb5c1a-odoo-deep/fwtaWPJ1ifWtcnE7/images/customer-guides/housecallPro/copy.png?fit=max&auto=format&n=fwtaWPJ1ifWtcnE7&q=85&s=71a59488b00048a107bc237e74349099" width="841" height="388" data-path="images/customer-guides/housecallPro/copy.png" />

## 2. Set up webhooks for real-time updates (Subscribe Actions)

Skip this section if your developer did not give you a webhook URL, or if you do not need real-time updates.

Follow these steps to set up webhooks in Housecall Pro.

1. Click the **My Apps** icon (3x3 grid) in the top-right corner.
   <img src="https://mintcdn.com/ampersand-24eb5c1a-odoo-deep/fwtaWPJ1ifWtcnE7/images/customer-guides/housecallPro/myapps.png?fit=max&auto=format&n=fwtaWPJ1ifWtcnE7&q=85&s=97b143949f541e93f337c9c1a8bfc828" width="1907" height="1017" data-path="images/customer-guides/housecallPro/myapps.png" />
2. Click **Go to App Store**.
   <img src="https://mintcdn.com/ampersand-24eb5c1a-odoo-deep/fwtaWPJ1ifWtcnE7/images/customer-guides/housecallPro/appstore.png?fit=max&auto=format&n=fwtaWPJ1ifWtcnE7&q=85&s=ec7007900722ac65329b3fbaac2d4b2d" width="2120" height="1129" data-path="images/customer-guides/housecallPro/appstore.png" />
3. Under **All apps**, find and open **Webhooks**.
   <img src="https://mintcdn.com/ampersand-24eb5c1a-odoo-deep/fwtaWPJ1ifWtcnE7/images/customer-guides/housecallPro/webhook.png?fit=max&auto=format&n=fwtaWPJ1ifWtcnE7&q=85&s=80e1b112300dc3421e79669dc922d2ca" width="2133" height="1136" data-path="images/customer-guides/housecallPro/webhook.png" />
4. Set Webhooks to **Active**, paste the link the developer gave you into the **Webhook URL** field, then click **Save**.
   <img src="https://mintcdn.com/ampersand-24eb5c1a-odoo-deep/fwtaWPJ1ifWtcnE7/images/customer-guides/housecallPro/active.png?fit=max&auto=format&n=fwtaWPJ1ifWtcnE7&q=85&s=f3807c9074849cd6a4449b2a51a33504" width="2123" height="1133" data-path="images/customer-guides/housecallPro/active.png" />
5. Enable the webhook events that you want to subscribe to, then click **Save**.
   <img src="https://mintcdn.com/ampersand-24eb5c1a-odoo-deep/fwtaWPJ1ifWtcnE7/images/customer-guides/housecallPro/events.png?fit=max&auto=format&n=fwtaWPJ1ifWtcnE7&q=85&s=e80835cf53b0a7bf63d6dd36b9518436" width="2127" height="1130" data-path="images/customer-guides/housecallPro/events.png" />
   <Note>
     **`pro.created`** in Housecall Pro means a new **employee**; the connected
     product may display it as **`employee.created`**.
   </Note>

## For official setup details, see:

* [Housecall Pro API Overview](https://help.housecallpro.com/en/articles/8505035-api-overview#h_3b0cd3e648)
* [Housecall Pro Webhooks Setup](https://help.housecallpro.com/en/articles/5683520-how-to-enable-webhooks)
