> ## Documentation Index
> Fetch the complete documentation index at: https://ampersand-24eb5c1a-quickstart-diataxis-tutorial.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-quickstart-diataxis-tutorial/R9mJt5uBMLlDUZQz/images/customer-guides/housecallPro/myapps.png?fit=max&auto=format&n=R9mJt5uBMLlDUZQz&q=85&s=2413437f2a03305b6fcaa8ed4320fa61" 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-quickstart-diataxis-tutorial/R9mJt5uBMLlDUZQz/images/customer-guides/housecallPro/appstore.png?fit=max&auto=format&n=R9mJt5uBMLlDUZQz&q=85&s=e81d585ab9726ef71ab88f5d024d7f3f" 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-quickstart-diataxis-tutorial/R9mJt5uBMLlDUZQz/images/customer-guides/housecallPro/apikey.png?fit=max&auto=format&n=R9mJt5uBMLlDUZQz&q=85&s=a693b21021312c1199ba802f10d80d2d" width="1720" height="898" data-path="images/customer-guides/housecallPro/apikey.png" />
4. Click **Generate API Key**.
   <img src="https://mintcdn.com/ampersand-24eb5c1a-quickstart-diataxis-tutorial/R9mJt5uBMLlDUZQz/images/customer-guides/housecallPro/generate.png?fit=max&auto=format&n=R9mJt5uBMLlDUZQz&q=85&s=1f72e62359061906538ef02cfcf96101" 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-quickstart-diataxis-tutorial/R9mJt5uBMLlDUZQz/images/customer-guides/housecallPro/new.png?fit=max&auto=format&n=R9mJt5uBMLlDUZQz&q=85&s=eb6d23c70cc9bac0e081c96926802aba" 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-quickstart-diataxis-tutorial/R9mJt5uBMLlDUZQz/images/customer-guides/housecallPro/copy.png?fit=max&auto=format&n=R9mJt5uBMLlDUZQz&q=85&s=a9e1dfa50f38ab0f8300671bb5f51f51" 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-quickstart-diataxis-tutorial/R9mJt5uBMLlDUZQz/images/customer-guides/housecallPro/myapps.png?fit=max&auto=format&n=R9mJt5uBMLlDUZQz&q=85&s=2413437f2a03305b6fcaa8ed4320fa61" 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-quickstart-diataxis-tutorial/R9mJt5uBMLlDUZQz/images/customer-guides/housecallPro/appstore.png?fit=max&auto=format&n=R9mJt5uBMLlDUZQz&q=85&s=e81d585ab9726ef71ab88f5d024d7f3f" 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-quickstart-diataxis-tutorial/R9mJt5uBMLlDUZQz/images/customer-guides/housecallPro/webhook.png?fit=max&auto=format&n=R9mJt5uBMLlDUZQz&q=85&s=3c977029bd8b41c16d77db09f185e6f3" 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-quickstart-diataxis-tutorial/R9mJt5uBMLlDUZQz/images/customer-guides/housecallPro/active.png?fit=max&auto=format&n=R9mJt5uBMLlDUZQz&q=85&s=7bc2628f6e2f6438ed553b7938e5cce0" 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-quickstart-diataxis-tutorial/R9mJt5uBMLlDUZQz/images/customer-guides/housecallPro/events.png?fit=max&auto=format&n=R9mJt5uBMLlDUZQz&q=85&s=95f6f7b846a61803864ad9d244bce62c" 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)
