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 with POST /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.
Billing: Request; paid actions are priced in credits (see GET /v1/messaging/prices) · Rate limit: 60/min
Request
- Base URL: https://apihub.co.il
- URL: https://apihub.co.il/v1/messaging/whatsapp/conversions
- Auth: HTTP bearer
Headers
Replay-safe: the same execution is returned instead of charging twice
Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…
Request body
Response
Completed
Changes
No recorded changes to this operation across all 2 revisions of this API.