Guide to UTMSimple’s Facebook CAPI Integration
A Developer's Guide to UTMSimple’s Facebook CAPI Integration
In a world of increasing data privacy measures, ad blockers, and cookie restrictions, server-side tracking has become essential for accurate marketing attribution. UTMSimple’s Facebook Conversion API (CAPI) integration is designed to make this powerful technology accessible and seamless.
While we offer simple one-click setups for popular platforms, this guide is for developers and teams who need a custom integration. We'll cover how our system works behind the scenes (without the technical jargon) and show you exactly how to send event data to your unique endpoint.
How It Works: Intelligent Event Processing
At its core, our Facebook CAPI integration acts as a smart and secure bridge between your systems and Facebook.
- You send event data from your application or CRM to a unique webhook URL provided by UTMSimple.
- Our system intelligently processes the data. It's built to automatically recognize and parse webhooks from major platforms. It correctly formats the data required by Facebook.
- We securely forward the event to the Facebook Conversions API, ensuring accurate, real-time tracking.
This process ensures that conversion events are reliably tracked, providing you with the data you need to optimize your campaigns while respecting user privacy.
Step 1: Get Your Unique Webhook Endpoint
Once you subscribe to the Facebook CAPI product on the UTMSimple website, you will be assigned a unique webhook URL. This is your personal endpoint for sending all server-side events.
You can find this endpoint in your UTMSimple dashboard. Treat this URL as a secure credential; it is the key that connects your system to ours.
Step 2: Send Your Event Data
This is where the magic happens. Our system is designed for maximum flexibility, whether you use a popular CRM or a fully custom-built platform.
Seamless Integration with Leading CRMs
Our webhook endpoint is pre-configured to understand the specific data formats from many of the tools you already use. We currently have native support for parsing events from:
- GoHighLevel
- HubSpot
- ClickFunnels (both Classic and v2)
- Kajabi
If you use one of these platforms, you can simply point their webhook notifications to your UTMSimple endpoint, and our system will handle the complex task of translating that data for Facebook CAPI.
Building a Custom Payload
If you're integrating with a different CRM or a custom application, you can send a POST
request with a standard JSON payload. Our system will extract the relevant details and forward them to Facebook. For best results, structure your payload with the following key fields.
Essential Payload Fields:
-
Event Information
-
event_name
: The Facebook standard event you're tracking (e.g.,Purchase
,Lead
,CompleteRegistration
). -
event_source_url
: The URL where the event occurred.
-
-
User Data (for matching)
-
email
&phone
: Hashed user identifiers are critical for matching conversions. -
client_ip_address
&client_user_agent
: Helps Facebook attribute the event correctly. -
fbp
: The Facebook browser ID cookie (_fbp
), if available.
-
-
Conversion and Attribution Data
-
value
¤cy
: The monetary value and currency of the conversion. -
utm_params
: Any UTM parameters (utm_source
,utm_medium
, etc.) associated with the user session. Our system will automatically capture these and pass them to Facebook as custom properties for deeper insights.
-
Sample Custom Payload: Here is an example of a well-formed JSON payload for a custom integration:
{
"event_name": "Lead",
"user_data": {
"email": "test@example.com",
"phone": "15551234567",
"client_ip_address": "123.123.123.123",
"client_user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36",
"fbp": "fb.1.1558571054389.1098115397"
},
"event_source_url": "https://yourwebsite.com/contact",
"utm_params": {
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "spring_sale"
}
}
By leveraging UTMSimple's Facebook CAPI integration, you gain a reliable, secure, and powerful way to handle server-side event tracking, ensuring you never miss a conversion.
Further Documentation
For more in-depth technical details and advanced use cases, please visit our official documentation.
Documentation Link: docs.utmsimple.com