Send WhatsApp conversion event
Forward a WhatsApp Business Messaging conversion event (LeadSubmitted,
Purchase, AddToCart, InitiateCheckout, ViewContent) to Meta's
Conversions API with action_source = business_messaging and
messaging_channel = whatsapp. The endpoint looks up the originating
CTWA click ID (ctwa_clid) captured on the first inbound message of
the conversation and replays it on every event so Meta can attribute
the conversion back to the Click-to-WhatsApp ad that drove the chat.
Configuration prerequisite on the WhatsApp account metadata:
metaCapiDatasetId: the Meta dataset ID linked to the WABA. Provision one withPOST /v1/whatsapp/dataset.
The WABA ID (already set automatically at connect time) is forwarded as
user_data.whatsapp_business_account_id, which is the per-channel
attribution identifier Meta requires for WhatsApp events. No Facebook
Page ID is needed (that field is the Messenger-branch identifier).
Identify the conversation by either conversationId (preferred) or
phoneE164 (digits only, no +). At least one is required. If the
conversation has no captured ctwa_clid, the request returns 422
because there is nothing to attribute.
Token and dataset coupling: the WhatsApp account's accessToken must
have access to the configured metaCapiDatasetId. By default a WABA's
system-user token is scoped to the WABA's own Business Manager and
cannot post to a pixel owned by a different Business; Meta returns
code 100 in that case. Either share the dataset with the WhatsApp
app's Business in BM, or use a dataset already in the same Business
as the WABA.
API key authentication - use your Zernio API key as a Bearer token
In: header
WhatsApp SocialAccount ID.
1 <= lengthLive-verified allowlist of event names accepted by Meta's
CAPI for Business Messaging (Graph API v25.0). Other
standard pixel events including Lead,
CompleteRegistration, Subscribe, Schedule, Contact,
StartTrial, AddPaymentInfo, Search, and
SubmitApplication are rejected with subcode 2804066
("Messaging Event Invalid Event Type") on
action_source = business_messaging events. Custom event
names are also rejected.
Use LeadSubmitted (NOT Lead) for lead-style conversions.
"LeadSubmitted" | "Purchase" | "AddToCart" | "InitiateCheckout" | "ViewContent"Unix seconds. Defaults to the time of the request when omitted. Meta's attribution window is 7 days from click; events older than that lose attribution.
Stable dedup key. Reuse to suppress duplicate events (Meta dedupes against pixel events with the same id).
1 <= lengthZernio Conversation _id (preferred lookup). The
conversation must have a captured ctwa_clid in metadata
(set automatically by the WhatsApp webhook on the first
inbound message after a CTWA ad click).
1 <= lengthContact phone number, digits only with no '+'. When used
in lieu of conversationId, the handler resolves to the
most recent CTWA-attributed conversation for this phone
on the supplied account.
1 <= lengthConversion value (e.g. order total).
ISO 4217 currency code (e.g. USD).
3 <= length <= 3Optional product / content identifiers.
User email. Normalized + SHA-256 hashed before sending to Meta.
emailStable customer identifier. Lowercased + SHA-256 hashed before sending to Meta.
Meta test_event_code passthrough. Routes the event to
the Test Events tab in Events Manager instead of the
production dataset, useful for development.
Response Body
application/json
application/json
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.whatsapp.sendWhatsAppConversion({ body: { accountId: 'account_abc123', eventName: 'LeadSubmitted', eventId: 'event_abc123', },});console.log(data);{
"platform": "metaads",
"eventsReceived": 0,
"eventsFailed": 0,
"failures": [
{
"eventIndex": 0,
"eventId": "string",
"message": "string",
"code": "string"
}
],
"traceId": "string"
}{
"error": "Unauthorized"
}List recent WhatsApp conversion events GET
Returns the most recent conversion events sent through `POST /v1/whatsapp/conversions` for the given WhatsApp account. Sourced from delivery logs (Axiom `late` dataset), so the visible window is bounded by log retention (about 30 days). Useful for rendering a "recent activity" panel on the conversions setup tab without standing up a parallel persistence layer. Per-event payload mirrors the structured log we write on every successful send: `eventName`, `conversationId`, `eventsReceived`, `eventsFailed`, `traceId`, `durationMs`, and the wall-clock `timestamp`.
Unblock users DELETE
Unblock one or more previously blocked WhatsApp users on this number. Up to 1,000 users per request; per-user failures are reported in `failed` without failing the rest of the batch.