Enquiry webhooks send each new enquiry for your settings to your own system, such as a CRM, as soon as it arrives on carehome.co.uk.
Who can use it: enquiry webhooks are available to Enhanced and Platinum subscribers. You need a web address (URL) on your own system that can receive data, so you will need some technical knowledge or a developer. By using webhooks you agree to our webhooks terms of use.
How it works
- You add a webhook in the Portal: the HTTPS URL we should send to, a contact email address and the enquiry types you want. See Enquiry Webhook Setup.
- When someone sends one of your settings an enquiry of a type you chose, we send an HTTP
POSTrequest to your URL with the enquiry as JSON. This normally happens within a few seconds. - Your system checks the signature to confirm the request came from us, saves the enquiry and replies with a
2xxstatus code. - If your system does not reply with a
2xxcode within 15 seconds, we try again later.
Webhooks only send new enquiries. They do not send changes to an enquiry, or enquiries received before you added the webhook. To collect past enquiries, use the Enquiry API.
Enquiry types
When you add a webhook you choose which of these enquiry types it receives.
| Type | Sent when |
|---|---|
care.create | A care enquiry is sent to a setting. |
brochure.create | Someone requests a setting's brochure. |
tour.create | Someone requests an onsite or remote tour or consultation. |
call.create | A phone call to a setting's carehome.co.uk phone number is recorded as a care enquiry. |
general.create | A general enquiry is sent to a setting. |
job.create | Someone sends a setting a job enquiry. |
Each request also has a category that tells you more about where the enquiry came from. See Enquiry Webhook Categories.
Groups
You can add a webhook for a single setting or, if you manage a group, for the whole group. A group webhook receives enquiries for every setting in the group. 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.
Enquiries are only sent for settings with an Enhanced or Platinum subscription. In a group, this is checked for each setting.
Security
Every webhook has its own secret key, shown in the Portal. We use it to sign every request, and we send the signature in the webhook-signature header. Check the signature before you trust the data. See Enquiry Webhook Request for how.
Use an HTTPS URL that only your system knows, and keep your secret key private.
In this section
| Page | What it covers |
|---|---|
| Enquiry Webhook Setup | Adding, editing, testing and pausing a webhook in the Portal, and the webhook logs. |
| Enquiry Webhook Request | The headers and body we send, how to check the signature, how to reply, and retries. |
| Enquiry Webhook Categories | The categories in each request and which type each belongs to. |
| Example pages, starting with the Care enquiry example | An example request for each enquiry type, and the fields specific to each. All seven are listed in Enquiry Webhook Categories. |
Contact us
For help with webhooks, email integrations@carehome.co.uk or call 01488 684321.