> ## Documentation Index
> Fetch the complete documentation index at: https://ampersand-24eb5c1a-jay-eng-4255-write-async-done-error.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-jay-eng-4255-write-async-done-error/bEEHm8w2cXjUodTW/images/customer-guides/housecallPro/myapps.png?fit=max&auto=format&n=bEEHm8w2cXjUodTW&q=85&s=edc30489ddb6bd6a6f39cf53f7fac7e2" 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-jay-eng-4255-write-async-done-error/bEEHm8w2cXjUodTW/images/customer-guides/housecallPro/appstore.png?fit=max&auto=format&n=bEEHm8w2cXjUodTW&q=85&s=84df67a902cc28645975ffa99e96ad99" 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-jay-eng-4255-write-async-done-error/bEEHm8w2cXjUodTW/images/customer-guides/housecallPro/apikey.png?fit=max&auto=format&n=bEEHm8w2cXjUodTW&q=85&s=27db07d362572afad6b3c7e41f6b77da" width="1720" height="898" data-path="images/customer-guides/housecallPro/apikey.png" />
4. Click **Generate API Key**.
   <img src="https://mintcdn.com/ampersand-24eb5c1a-jay-eng-4255-write-async-done-error/bEEHm8w2cXjUodTW/images/customer-guides/housecallPro/generate.png?fit=max&auto=format&n=bEEHm8w2cXjUodTW&q=85&s=413f0808933479c52827eebbc247a116" 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-jay-eng-4255-write-async-done-error/bEEHm8w2cXjUodTW/images/customer-guides/housecallPro/new.png?fit=max&auto=format&n=bEEHm8w2cXjUodTW&q=85&s=c5853c9b8740597609522f738e1b56c8" 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-jay-eng-4255-write-async-done-error/bEEHm8w2cXjUodTW/images/customer-guides/housecallPro/copy.png?fit=max&auto=format&n=bEEHm8w2cXjUodTW&q=85&s=85435266a01e374c8f752f4a3cb019a6" 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-jay-eng-4255-write-async-done-error/bEEHm8w2cXjUodTW/images/customer-guides/housecallPro/myapps.png?fit=max&auto=format&n=bEEHm8w2cXjUodTW&q=85&s=edc30489ddb6bd6a6f39cf53f7fac7e2" 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-jay-eng-4255-write-async-done-error/bEEHm8w2cXjUodTW/images/customer-guides/housecallPro/appstore.png?fit=max&auto=format&n=bEEHm8w2cXjUodTW&q=85&s=84df67a902cc28645975ffa99e96ad99" 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-jay-eng-4255-write-async-done-error/bEEHm8w2cXjUodTW/images/customer-guides/housecallPro/webhook.png?fit=max&auto=format&n=bEEHm8w2cXjUodTW&q=85&s=9da0ed21985455b32b4b41d16628e9fb" 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-jay-eng-4255-write-async-done-error/bEEHm8w2cXjUodTW/images/customer-guides/housecallPro/active.png?fit=max&auto=format&n=bEEHm8w2cXjUodTW&q=85&s=eeb9c844631fb85b6e2969efdb1dd91a" 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-jay-eng-4255-write-async-done-error/bEEHm8w2cXjUodTW/images/customer-guides/housecallPro/events.png?fit=max&auto=format&n=bEEHm8w2cXjUodTW&q=85&s=e19017d3cdd3061815926adf4434021d" 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)