Track Customer Conversions (CAPI)

The Conversions API (CAPI) allows businesses to send data about key customer interactions and conversions from WhatsApp conversations to Meta for improved ad targeting and performance measurement.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
data
array of objects
required
length between 1 and 1000

Array of conversion events to track

data*
string
enum
required

Standard or custom event name

integer
required

Event timestamp in Unix epoch time

string
enum
required
Defaults to business_messaging

Source of the action

Allowed:
string
enum
required
Defaults to whatsapp

Messaging platform

Allowed:
user_data
object
required

User identification data (at least one field required)

custom_data
object

Additional event-specific data

Headers
string
required

Must be set to application/json to indicate JSON-formatted request body

Responses

{
    "status": "success",
    "message": "Request processed successfully",
    "data": {
        "events_received": 1,
        "fbtrace_id": "AvuDhHGXLFxN8VAnWuV4E8o"
    }
}

{
    "status": "failure",
    "message": "Meta API returned error",
    "data": {
        "error": {
            "message": "Invalid parameter",
            "type": "OAuthException",
            "code": 100,
            "error_subcode": 2804071,
            "error_user_title": "Missing CTWA clid",
            "error_user_msg": "Your event is missing a ctwa_clid parameter."
        }
    }
}

{
    "status": "failure",
    "message": "Invalid WABA ID",
    "data": null
}

{
    "status": "error",
    "message": "Internal server error. Please try again later.",
    "error_code": "INTERNAL_ERROR"
}
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json