Meta documentation
Conversions API for Business Messaging.
When to use it
Place it at the point in the flow where the conversion happens. Common cases:- Purchase or payment confirmation
- Qualified lead registration
- Appointment or demo scheduling
- Subscription or trial start
Requirements
- WhatsApp channel connected through WhatsApp Cloud API (sandbox and other providers are not supported).
- Conversations that come from a Click-to-WhatsApp ad. The click ID must be stored in the conversation memory. See Meta Ads to learn how it is stored.
- Conversion reporting turned on for the channel (it is off by default). To turn it on, open the WhatsApp channel settings and use the Meta Conversions (CAPI) switch.
Configuration
General
Available events:
AddPaymentInfo, AddToCart, AddToWishlist, CompleteRegistration, Contact, CustomizeProduct, Donate, FindLocation, InitiateCheckout, Lead, Purchase, Schedule, Search, StartTrial, SubmitApplication, Subscribe and ViewContent.
Meta only requires currency and value for the
Purchase event. For all other events they are optional, but if you fill in the value it must be valid.Advanced
The event is sent through the project’s WhatsApp Cloud API channel and signed as JELOU.
Outputs
The node has no default output: connect both outputs to control what happens in each case.
Node status
The node shows Ready to report when the configuration is complete and Setup incomplete when something is missing. These are the most common errors:- The Click-to-WhatsApp ID is empty.
- The event is
Purchaseand the currency or value is missing. - A row of additional parameters has only the key or only the value.