Appearance
Payload Helper
Updated: Jan 25, 2023
Fill out the required and recommended data parameter fields to see how your payload should be structured when it's sent to Facebook from your server.
Web, app, and physical store events shared using the Conversions API require specific parameters. The list of required parameters is available here.
Selected product
selectedProduct
Website
Event type parameters
The fields event_name, event_time and action_source
are required for all events, while event_id is recommended for deduplication. Additionally, the fields client_user_agent and event_source_url are required for website events.
event_name
Type: string
event_time
Type: int
action_source
Type: string
website
Add Event Type Parameters
Customer information parameters
Include at least one customer information parameter for each event that you want to send. Facebook will use this data for the purposes described in its Business tools terms, including ads attribution and ads delivery optimisation.
All customer information parameters should be hashed as SHA256, except for client IP address, client user agent, click ID and browser ID. Any other customer information parameters that are not hashed are automatically rejected by Facebook.
Delete field
Email address (em)∙ Optional
Type: string | Must be hashed
Close
Normalise
Hash
Delete field
Phone number (ph)∙ Optional
Type: string | Must be hashed
Normalise
Hash
Add Customer Information Parameters
Custom data parameters
Select the custom parameters you want to use for ads attribution or ads delivery optimisation, or create a new custom parameter.
Delete field
currency∙ Optional
Type: string
Close
Delete field
value∙ Optional
Type: float
Add Custom Data Parameters
Attribution data parameters
Select attribution parameters that you want to use for ads attribution or ads delivery optimisation.
Delete field
attribution_share∙ Optional
Type: float
Add attribution data parameters
Original event data parameters
Select original event parameters that you want to use for ads attribution or ads delivery optimisation.
Delete field
event_name∙ Optional
Type: string
Close
Delete field
event_time∙ Optional
Type: int
Add original event data parameters
Generate code
Get code
`{
"data": [
{
"event_name": "Purchase",
"event_time": 1782985892,
"action_source": "website",
"user_data": {
"em": [
"7b17fb0bd173f625b58636fb796407c22b3d16fc78302d79f0fd30c2fc2fc068"
],
"ph": [
null
]
},
"attribution_data": {
"attribution_share": "0.3"
},
"custom_data": {
"currency": "USD",
"value": "142.52"
},
"original_event_data": {
"event_name": "Purchase",
"event_time": 1782985892
}
}
]
}`
You can add multiple values to most customer information parameters.
No errors were found.
Test this payload
Send to test events