---
title: "Enquiry Webhook Setup"
slug: "webhook-setup"
updated: 2026-10-21T12:40:13Z
published: 2026-10-21T12:40:13Z
canonical: "support.carehome.co.uk/webhook-setup"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.carehome.co.uk/llms.txt
> Use this file to discover all available pages before exploring further.

# Enquiry Webhook Setup

Add a webhook in the Portal to start receiving enquiries in your own system, then send a test event to check it works.

> [!NOTE]
> **Who can use it:** enquiry webhooks are available to Enhanced and Platinum subscribers. If your subscription does not include them, the Webhooks page shows an Upgrade button instead of the form. See [Enquiry Webhooks Overview](https://support.carehome.co.uk/docs/webhooks-overview).

## Add a webhook

1. Log in to the Portal and go to **APIs & Integrations → Webhooks → Webhooks**.
2. In the **Add Webhook** form, fill in the fields below.
3. Select **Add Webhook**. The webhook appears in the table at the top of the page.

| Field | What to enter |
| --- | --- |
| Care Provider | If you manage a group, choose the group or one of its settings. A group webhook receives enquiries for every setting in the group. If you manage a single setting, this is filled in for you. |
| Webhook URL | The address on your system that will receive the enquiries. It must start with `https://`. |
| Contact Email | The email address of the person responsible for this webhook on your side. |
| Status | **Active** to start receiving enquiries now, or **Inactive** to set it up without receiving any yet. |
| Event Types | Choose **Yes** for each enquiry type you want. You must choose at least one. See [Enquiry Webhooks Overview](https://support.carehome.co.uk/docs/webhooks-overview) for what each type is. |

You can add more than one webhook, for example one per setting or one per enquiry type. If a setting has its own webhook for an enquiry type, that setting's enquiries of that type go to its own webhook instead of the group's.

## Your webhook's details

The table on the Webhooks page lists the webhooks for your setting or group, with these details:

| Column | What it means |
| --- | --- |
| Webhook URL ID | The webhook's ID. We send it in the `webhook-url-id` header of every request, so you can tell your webhooks apart. |
| Setting Name, Setting ID | The setting or group the webhook belongs to. |
| Webhook URL | Where we send the enquiries. |
| Secret | The secret key we create for the webhook. Your system needs it to check the signature on each request. Keep it private. See [Enquiry Webhook Request](https://support.carehome.co.uk/docs/webhook-request). |
| Contact Email | The person responsible for the webhook. |
| Event Type | The enquiry types the webhook receives. |
| Status | Active or Inactive. |

## Send a test event

1. In the webhooks table, select **Test** next to the webhook.
2. If you manage a group, choose which setting the test is for.
3. Choose the enquiry type to test and send it.

The test request is signed in the same way as a real one. Its type ends in `.test`, for example `care.create.test`, and it contains your setting's real name and postcode with made-up enquiry details.

Make sure your system does not treat test events as real enquiries. Test data is sample data only, so some fields can be formatted differently from a real enquiry. Use the example pages, such as the [Care enquiry example](https://support.carehome.co.uk/docs/webhooks-care-enquiry-example), for the format of real requests.

## Edit or pause a webhook

Select **Edit** next to a webhook to change its URL, contact email, status or enquiry types, then select **Edit Webhook**. Editing keeps the same secret key.

To stop receiving enquiries for a while, set the webhook to **Inactive**. Enquiries that arrive while a webhook is Inactive are not sent to it, and are not sent later when you make it Active again. You can still see them in the Portal and collect them with the [Enquiry API](https://support.carehome.co.uk/docs/enquiry-api-overview).

## Webhook logs

Go to **APIs & Integrations → Webhooks → Webhook Logs** to see each request we sent and whether your system accepted it. By default the page shows the last 30 days. You can filter by date, event ID, enquiry type, webhook and result, and download the results as a CSV file.

If a request failed, check that your URL is reachable from the internet, that it accepts `POST` requests and that it replies with a `2xx` status code within 15 seconds.