Zapier and Make API

The Whappy apps on Zapier and Make use this API. You can call it yourself to subscribe any URL to Whappy’s events, or to add leads.

Base URL and authentication

https://api.whappy.ai/v1

Send your API key in the X-API-Key header on every request:

X-API-Key: your_api_key

Copy the key from Integrations → Zapier or Integrations → Make. Each key belongs to one Whappy account; every request acts on that account only. The two keys are separate: revoking one never stops the other. A subscription made with the Make key is recorded as Make’s; Whappy sends both the same events. A missing, wrong or revoked key answers 401:

{ "status": "error", "message": "Invalid API key" }

Check the key

POST /zap Answers 200 with an empty body (null) when the key is valid, 401 otherwise.

curl -X POST https://api.whappy.ai/v1/zap \
  -H "X-API-Key: your_api_key"

Event subscriptions

POST /zap/triggers

{
  "targetUrl": "https://hooks.zapier.com/hooks/catch/123456/abcdef/",
  "zap_type": "DEAD",
  "hours": 24
}

Field	Type	Required	Notes
`targetUrl`	string	yes	Where Whappy POSTs the event payload.
`zap_type`	string	yes	The event: see the table below.
`hours`	integer	for `DEAD`	Hours without a reply before the event fires. With several `DEAD` subscriptions, the shortest wait applies to all of them. A `DEAD` subscription without `hours` never fires.
`name`	string	for `SEND_DATA`	The trigger name. The campaign’s Send data step picks it under Trigger name.
`campaignName`	string	no	Stored, not applied yet: a `CLOSE` subscription receives every campaign’s closed conversations.

`zap_type`	Fires when
`CLOSE`	A conversation reaches its Close step.
`APPOINTMENT`	A lead books an appointment in the conversation (the funnel’s appointment step).
`DEAD`	A conversation has waited `hours` for the lead’s reply. Each lead fires once.
`SEND_DATA`	A conversation reaches a Send data step set to Zapier or Make with this trigger `name`.

Response 201:

{ "id": "484ab94b-c9aa-43de-a086-c8cba3976998", "status": "success", "message": "Webhook registered successfully" }

Keep the id to unsubscribe.

curl -X POST https://api.whappy.ai/v1/zap/triggers \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_api_key" \
  -d '{"targetUrl": "https://example.com/whappy/closed", "zap_type": "CLOSE"}'

List subscriptions

GET /zap/triggers returns the account’s active subscriptions (up to 100), Zapier’s and Make’s together. Each has _id, url, zap_type, name, campaign_id (the campaignName you sent), metadata (source: zapier or make, and hours), created_at and revoked.

Unsubscribe

DELETE /zap/triggers/{id}, with the id returned on subscribe.
DELETE /zap/triggers with the body { "targetUrl": "...", "zap_type": "CLOSE" }.

Both answer 200 with {"status": "success", "message": "Trigger removed"}, or with {"status": "already_removed", ...} when nothing matched.

Sample payload

GET /zap/sample/{name} returns a list with one sample event payload, to map fields before a real event happens. Every name returns the same sample, and the sample has no campaign_name.

Older per-event addresses

POST /zap/url/{name} with { "targetUrl": "...", "hours": 24 } stores one address for close, appointment or dead (hours for dead only), and DELETE /zap/url/{name} removes it. Whappy still sends events to these addresses, alongside the subscriptions. Use /zap/triggers for anything new: it supports several URLs per event and SEND_DATA.

Event payload

When the event happens, Whappy sends a POST with this JSON body to every subscribed URL. No extra headers are added beyond Content-Type: application/json. Any 2xx answer counts as delivered; a URL that fails stays subscribed.

{
  "lead_id": "f8e7d6c5-b4a3-9876-5432-1fedcba09876",
  "created_at": "2026-10-08T09:00:00+00:00",
  "campaign_name": "Spring offer",
  "phone": "+12025551234",
  "name": "John Doe",
  "lead_info_json": "{\"name\": \"John Doe\", \"budget\": \"5000\"}",
  "collected_info_json": "{\"Budget Range\": \"$5,000-$10,000\", \"Timeline\": \"3 months\"}",
  "appointment_json": "{\"datetime\": \"2026-10-09T14:30:00+00:00\", \"event_id\": \"sample_event_123\"}",
  "appointment": { "full_date": "2026-10-09T14:30:00+00:00" },
  "conversation_json": "[{\"sender\": \"ai\", \"message\": \"Hello! What budget do you have in mind?\", \"datetime\": \"2026-10-08T09:00:00+00:00\"}, {\"sender\": \"lead\", \"message\": \"Around $5,000.\", \"datetime\": \"2026-10-08T09:05:00+00:00\"}]"
}

Field	Type	Description
`lead_id`	string	Whappy’s id of the lead.
`created_at`	string	When the lead was created (ISO 8601).
`campaign_name`	string	The lead’s campaign.
`phone`	string	The lead’s number in international format. Empty for a lead with no phone number, such as an Instagram lead.
`name`	string	The lead’s name.
`lead_info_json`	string	What the lead arrived with (form fields, lead data), as a JSON object.
`collected_info_json`	string	What the AI collected in the conversation, keyed by the field’s name, as a JSON object.
`appointment_json`	string	`datetime` and `event_id` of the appointment, as a JSON object. Empty values when there is none.
`appointment.full_date`	string	The booked date and time (ISO 8601), or `""`.
`conversation_json`	string	The messages as a JSON list. `sender` is `ai`, `lead`, or `user` for a message your team sent from Chats.

In a SEND_DATA event sent to a Zapier subscription, the four *_json fields are readable text instead of JSON, for example {'Budget Range': '$5,000-$10,000'}. Do not parse them as JSON. Make subscriptions and every other event get JSON.

Parse the *_json fields before use:

app.post('/whappy/closed', (req, res) => {
  const payload = req.body;
  const collected = JSON.parse(payload.collected_info_json || '{}');
  const messages = JSON.parse(payload.conversation_json || '[]');
  console.log(payload.name, payload.campaign_name, collected, messages.length);
  res.sendStatus(200);
});

Create a lead

POST /lead

{
  "phone": "+393331234567",
  "name": "Anna",
  "email": "anna@example.com",
  "campaign_name": "Spring offer",
  "is_test": true,
  "lead_data": { "budget": "5000", "city": "Milan" }
}

Field	Type	Notes
`phone`	string	International format. A local number works when the account has a default country.
`name`	string	The lead’s name.
`email`	string	Optional.
`campaign_name`	string	Optional. The Whappy campaign. Unknown or empty: your account’s default routing decides.
`is_test`	boolean	Optional. Marks the lead as a test lead.
`lead_data`	object	Optional. Extra fields, stored with the lead; the AI and templates can read them.

The Create Lead action on Zapier and Make sends these fields. This is the same endpoint as the Webhook integration, which lists every field it accepts. Response 200:

{ "status": "success", "message": "Lead created successfully", "data": { "_id": "...", "name": "Anna", "phone": "+393331234567", "...": "..." } }

message says what happened:

Lead created successfully: a new lead.
Lead already exists; details merged: the same person was already in that campaign. Whappy keeps one lead and adds the new details.
Lead already exists; details merged and campaign restart requested: as above, and the conversation starts over because the campaign has Restart the campaign for a lead that comes back on.

Errors

Status	When	Body
`400`	The phone number cannot be read.	`{"detail": "Phone number '12' is not a valid number; add the international prefix (e.g. +48) or set a default country in Whappy settings"}`
`401`	Missing, wrong or revoked API key.	`{"status": "error", "message": "Invalid API key"}`
`409`	Create a lead: the campaign does not talk on WhatsApp. Test leads are not refused.	`{"detail": {"code": "campaign_not_on_whatsapp", "message": "This campaign does not talk on WhatsApp, so it cannot take people by phone number. ..."}}`
`422`	A required field is missing or has the wrong type.	`{"detail": [ ... ], "message": "zap_type: Field required"}`
`500`	Unexpected error on Whappy’s side; retry later.	`{"detail": "..."}`

Support

Write to team@whappy.ai with the request, the response and the time it happened. Never send the full API key.

Conversations

E-commerce

AI clients

CRM

Leads

Appointment Setting

Advertising

Base URL and authentication

Check the key

Event subscriptions

List subscriptions

Unsubscribe

Sample payload

Older per-event addresses

Event payload

Create a lead

Errors

Support

​Base URL and authentication

​Check the key

​Event subscriptions

​Subscribe

​List subscriptions

​Unsubscribe

​Sample payload

​Older per-event addresses

​Event payload

​Create a lead

​Errors

​Support

Base URL and authentication

Check the key

Event subscriptions

Subscribe

List subscriptions

Unsubscribe

Sample payload

Older per-event addresses

Event payload

Create a lead

Errors

Support