Snapchat Conversions API Reference

Destination Info

• Supports Track calls

• Supports HIPAA mode

• Refer to this destination as Snapchat in the Integrations object

• Connection Modes:

	Client-side	Server-side
Web
Mobile
Server

This is a reference document for the Snapchat destination. For information on how to set up this integration, see the Snapchat Conversions API Quick Start Guide.

Events

When you send an event to the Snapchat Conversions API destination from Freshpaint, Freshpaint will create an event in the Snapchat event manager by hitting Snapchat's API.

Required Properties

Freshpaint property	Snapchat parameter	Type	Requirement	Description
event_name	event_name	string	Required	The Snapchat event name to track. See Snapchat's API documentation for the list of allowed event names. Note: If this property is absent, Freshpaint will attempt to use the name of the Freshpaint event. This will only work if the Freshpaint event name is one of the specific supported Snapchat names, so we recommend sending event name separately.
$sccid	sc_click_id	string	Required	The Snapchat click ID. Retrieved from the ScCid or sccid query parameter in the URL of your website.
$ip	client_ip_address	string	Required	IP address from device that sent the conversion event.
$user_agent	client_user_agent	string	Required	The user agent of the browser where the event occurred.
$current_url	event_source_url	string	Required	The URL of the page where the event took place. Note: In HIPAA Mode, the URL will be redacted by Freshpaint if this field is not added to the allowlist to remove any potential PHI in the URL. To send the complete URL to Snapchat, add the $current_url property to your HIPAA allowlist.
action_source	action_source	string	Required	Where the event took place. Accepted values are: WEB OFFLINE MOBILE_APP Note: Freshpaint will automatically set this value if it is not manually set on the event, based on what Freshpaint library is used to trigger the event (and defaulting to Web).
currency	currency	string	Required for PURCHASE events	This represents the currency associated with the value provided. Subset of standard ISO 4217 code supported.
value	value	string	Required for PURCHASE events	This numeric value is associated with the specific event.

User Data Properties

When you send user actions to Snapchat, Snapchat will attempt to match those actions to a particular Snapchat user. In most cases, you'll want to send additional user traits and Snapchat parameters to improve the number of the events that are matched to a Snapchat user. See Snapchat's documentation on all of the parameters that Snapchat Conversions API accepts.

Snapchat requires that a number of the user parameters to be hashed. Freshpaint will automatically hash these user values when sending them to Snapchat's API.

Snapchat also requires a number of normalization rules. The Freshpaint integration will automatically normalize most user data fields according to Snapchat's requirements. For more details, see the Snapchat API documentation linked above.

Freshpaint property	Snapchat parameter	Type	Requirement	Description
madid	madid	string	Recommended
email	em	string	Recommended	The email of the user.
phone	ph	string	Recommended	The phone number of the user.
first_name	fn	string	Optional	First name of the user.
last_name	ln	string	Optional	Last name of the user.
gender	ge	string	Optional	Gender of the user. Snapchat only accepts mf or f.
city	ct	string	Optional	The user's city.
state	st	string	Optional	The user's state.
zip	zp	string	Optional	The user's zip or postal code.
country	country	string	Optional	The user's country.
external_id	external_id	string	Optional	A unique ID such as a loyalty card ID, first party cookie identifier, or some other identifier.
sc_cookie1	sc_cookie1	string	Optional	If you are using the Pixel SDK, you can access a 1st party cookie by looking at the _scid value under your domain. Will increase your user match rate.

Hashed Fields

Snapchat expects the following fields to be hashed when sent to them. You should not hash these values when sending to Freshpaint. The Freshpaint integration will automatically normalize the real, readable values and then hash them before sending them to Snapchat.

If you are a HIPAA customer, it's important to understand that even though the user information is hashed before being sent to Snapchat, HHS guidance still considers this PII since it does not use a secret. Therefore, you must be extremely careful to avoid sending health data alongside this user information to avoid a HIPAA violation.

• email

• phone

• first_name

• last_name

• gender

• city

• state

• zip

• country

• external_id

App Data Properties

Freshpaint property	Snapchat parameter	Type	Requirement	Description
advertiser_tracking_enabled	advertiser_tracking_enabled	int	Optional	Set it to 1 or 0 to indicate an OPT_IN or OPT_OUT respectively for MOBILE_APP events.
extinfo	extinfo	Array of strings	Optional	Device object from app event. This parameter expects an array with comma separated values. See the Snapchat documentation for more details on this property.
app_id	app_id	string	Optional	The unique ID (app_id) assigned for a given application.

Custom Data Properties

The custom_data object can contain parameters for Dynamic Ads and Dynamic Travel Ads, along with any other custom parameters.

Freshpaint property	Snapchat parameter	Type	Requirement	Description
custom_fields	custom_fields	Object (string : string)	Optional	Object for additional custom fields.
status	status	string	Optional	Indicates the registration status of the customer. Suggested values to pass include: "new", "returning", or "reactivated."
event_tag	event_tag	string	Optional	Custom label for events. Examples: in-store, weekend sales, back-to-school campaign