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
Website
​
Event Type Parameters
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.
Type: string
​
Type: int
Type: string
website
​
Customer Information Parameters
Include at least one customer information parameter for each event you want to send. Facebook will use this data for the purposes described in its Business Tools Terms, including ads attribution and ads delivery optimization.
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.
∙ Optional
Type: string | Must be hashed
∙ Optional
Type: string | Must be hashed
Custom Data Parameters
Select custom parameters you want to use for ads attribution or ads delivery optimization, or create a new custom parameter.
Delete field
​
∙ Optional
Type: string
Delete field
​
∙ Optional
Type: float
Attribution Data Parameters
Select attribution parameters you want to use for ads attribution or ads delivery optimization.
Delete field
​
∙ Optional
Type: float
Original Event Data Parameters
Select original event parameters you want to use for ads attribution or ads delivery optimization.
Delete field
​
∙ Optional
Type: string
Delete field
​
∙ Optional
Type: int
Generate Code
Get Code
{"data": [{"event_name": "Purchase","event_time": 1783673705,"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": 1783673705}}]}