Server-Side API: Server Event Parameters

This page covers:


event_name

type: String | Required field

A Facebook pixel Standard Event or Custom Event name. This field is used to deduplicate events sent by both Facebook Pixel and Server-Side API. event_id is also used in the deduplication process.

For the same customer action, event from Facebook Pixel must match event_name from Server-Side API. If we find a match between events sent within 48 hours of each other, we only consider the first one. If a server and browser event arrive at approximately the same time (within 5 minutes of each other), we favor the browser event.

Learn about Deduplicate Pixel and Server-Side Events.

event_time

type: Int | Required field

A Unix timestamp in seconds indicating when the actual event occurred.

user_data

type: Object | Required field

A map that contains user data. See User Data Parameters for options. Also see Advanced Matching with the Pixel for comparable options available for data sent via Facebook pixel.

custom_data

type: Object | Optional field

A map that includes additional business data about the event. See Custom Data Parameters.

event_source_url

type: String | Optional field

The browser URL where the event happened.

opt_out

type: Boolean | Optional field

A flag that indicates we should not use this event for ads delivery optimization. If set to true, we only use the event for attribution.

event_id

type: String | Optional field

This ID can be any unique string chosen by the advertiser. event_id is used to deduplicate events sent by both Facebook Pixel and Server-Side API. event_name is also used in the deduplication process.

For deduplication, the eventID from Facebook pixel must match the event_id in the corresponding Server-Side API event. Learn about Deduplicate Pixel and Server-Side Events.