Skip to content

SendWhatsAppConversionRequest.md

Latest commit

 

History

History
37 lines (25 loc) · 2.98 KB

SendWhatsAppConversionRequest.md

File metadata and controls

37 lines (25 loc) · 2.98 KB
Raw

SendWhatsAppConversionRequest

In addition to the required list, at least one of conversationId or phoneE164 must be supplied (used to resolve the originating CTWA conversation). The route enforces this at the Zod boundary; OpenAPI's required cannot express OR-required cleanly.

Properties

Name Type Description Notes
accountId String WhatsApp SocialAccount ID.
eventName EventNameEnum Live-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.
eventTime BigDecimal 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. [optional]
eventId String Stable dedup key. Reuse to suppress duplicate events (Meta dedupes against pixel events with the same id).
conversationId String Zernio 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). [optional]
phoneE164 String Contact 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. [optional]
value BigDecimal Conversion value (e.g. order total). [optional]
currency String ISO 4217 currency code (e.g. `USD`). [optional]
contentIds List<String> Optional product / content identifiers. [optional]
email String User email. Normalized + SHA-256 hashed before sending to Meta. [optional]
externalId String Stable customer identifier. Lowercased + SHA-256 hashed before sending to Meta. [optional]
testCode String Meta `test_event_code` passthrough. Routes the event to the Test Events tab in Events Manager instead of the production dataset, useful for development. [optional]

Enum: EventNameEnum

Name Value
LEAD_SUBMITTED "LeadSubmitted"
PURCHASE "Purchase"
ADD_TO_CART "AddToCart"
INITIATE_CHECKOUT "InitiateCheckout"
VIEW_CONTENT "ViewContent"