Zapier Webhook API

Overview

The Luxury Referrals integration uses a single production HTTPS endpoint that manages Zapier webhook subscriptions and returns recent leads. It supports three actions — getRecentLeads, subscribeHook, and unsubscribeHook — and delivers new leads to subscribed Zapier URLs in real time. Every request is authenticated with the private workspace key found in your Luxury Referrals dashboard under Settings → Integrations.

Authentication

Every request must include the workspace API key. The Zapier integration sends it both as the zapierKey query parameter and the X-ZAPIER-KEY request header. Requests without a valid key return an error (see Error handling). The key is a secret and is entered as a masked password field in Zapier.

X-ZAPIER-KEY: YOUR_PRIVATE_WORKSPACE_KEY

Base endpoint

GET https://zapierwebhook-mi2dwlxrhq-uc.a.run.app
(Production endpoint, hosted on Google Cloud / Firebase Functions)

Request parameters

Actions

The endpoint multiplexes the following actions via the action parameter. All actions use GET.

Responses

Default (no action)

{
  "message": "Zapier Request Received",
  "user": "user_uid",
  "displayName": "User",
  "email": "user@example.com"
}

getRecentLeads

[
  {
    "email": "lead@example.com",
    "name": "Jordan Buyer",
    "phone": "+13055550142",
    "status": "not_contacted",
    "type": "buyer_lead",
    "full_address": "123 Main St, Miami, FL 33139",
    "address": "123 Main St",
    "city": "Miami",
    "state": "FL",
    "zip": "33139"
  }
]

subscribeHook

{
  "message": "Hook Url Saved",
  "hookUrl": "https://hooks.zapier.com/hooks/standard/..."
}

unsubscribeHook

{
  "message": "Hook Url Deleted",
  "hookUrl": "https://hooks.zapier.com/hooks/standard/..."
}

New Lead webhook (real-time delivery)

After a Zap subscribes with subscribeHook, each new lead in the workspace is delivered as an HTTP POST to the subscribed hookUrl with a JSON body. This is the payload the Zapier “New Lead” trigger receives.

POST {subscribed hookUrl}
Content-Type: application/json

{
  "email": "lead@example.com",
  "name": "Jordan Buyer",
  "phone": "+13055550142",
  "status": "not_contacted",
  "type": "buyer_lead",
  "full_address": "123 Main St, Miami, FL 33139",
  "address": "123 Main St",
  "city": "Miami",
  "state": "FL",
  "zip": "33139"
}

Lead fields

Both getRecentLeads and the New Lead webhook return the same lead object with these fields.

Error handling

If the key is missing or invalid, the API returns a JSON object with a descriptive message.

{
  "message": "Zapier Key Not Found"
}