Publish Events to a Custom Data Destination
Updated: Feb 2, 2025
You can set up and send data from your data pipeline to a custom data destination, such as your own API. When you are setting up a custom destination, there are options you can update the event templates so that it matches the data format the endpoint is expecting.
Once setup is complete, your data pipeline will be able to send outbound events to this custom destination. Below is the list of parameters which are sent to the custom data destination.
Note: Custom data destinations that don’t respond within 5 seconds will timeout and may not receive data.
| Parameter | Description |
|---|---|
event_name | A standard event or custom event name. |
event_time | A Unix timestamp in seconds indicating when the actual event occurred. |
user_data | A map that contains customer information data. |
custom_data | A map that includes additional business data about the event. |
event_source_url | The browser URL where the event happened. The URL must begin with http:// or https:// and should match the verified domain. |
event_id | This ID can be any unique string chosen by the business. |
action_source | This field allows you to specify where your conversions occurred. The values you can send in the action_source field are as follows:
|
data_processing_options
array
| Processing options you would like to enable for a specific event. |
data_processing_options_country
integer
| Required, if you send LDU under data_processing_options.A country that you want to associate to this data processing option. Current accepted values are 1, for the United States of America, or 0, to request that we geolocate that event. |
data_processing_options_state
integer
| Required in some cases. (See note below for details.) A state that you want to associate to this data processing option. Current accepted values are 1000, for California, or 0, to request that we geolocate that event.
Note:
|
app_data | Required for app events Parameters for sharing app data and device information with the Conversions API. extinfo is a sub-parameter of app_data. |
extinfo
object
| Required for app events Extended device information, such as screen width and height. This parameter is an array and values are separated by commas. When using extinfo, all values are required and must be in the order indexed below. If a value is missing, fill with an empty string as a placeholder. Note:
|
↳ 0
string
| Required extinfo version Example: i2 |
↳ 1
string
| app package name Example: com.facebook.sdk.samples.hellofacebook |
↳ 2
string
| short version (int or string) Example: 1.0 |
↳ 3
string
| long version Example: 1.0 long |
↳ 4
string
| Required OS version Example: 13.4.1 |
↳ 5
string
| device model name Example: iPhone5,1 |
↳ 6
string
| locale Example: En_US |
↳ 7
string
| timezone abbreviation Example: PDT |
↳ 8
string
| carrier Example: AT&T |
↳ 9
int64
| screen width Example: 320 |
↳ 10
int64
| screen height Example: 568 |
↳ 11
string
| screen density Example: 2 |
↳ 12
int64
| CPU cores Example: 2 |
↳ 13
int64
| external storage size in GB Example: 13 |
↳ 14
int64
| free space on external storage in GB Example: 8 |
↳ 15
string
| device timezone Example: USA/New York |
referrer_url
string
| The inbound website that was immediately visited prior to the business page where the Meta Pixel fired. It is an HTTP referrer from JavaScript’s perspective. The referral_url is either the page the user was on before they visited the current page, or the iFrame. |