Snap CAPI writes WEB where Meta writes website
Snapchat CAPI v3 event and validation routes with captured POST, JSON entity and envelope advice. Query-token authentication and existing legacy body unions are preserved. Account state and receiver acceptance remain contextual.
The v3 event and validation routes keep query-token authentication. Captured transport and missing-envelope advice preserve legacy body variants and unavailable evidence.
What this pack matches
Rules
Codes are stable. A finding in CI, MCP, or the playground lands on the same id.
| Field | Required | What it checks | Rule ids | Source |
|---|---|---|---|---|
access_token |
required | The events endpoint authenticates with an access token on the request. Fix: Send the Conversions API access token, and keep it out of anything client-side. | vendor.snapchat.param.access_token.missingvendor.snapchat.param.access_token.empty |
docs |
data |
optional | The vendor documents the JSON shape or value type of this field. Native JSON type: array. Minimum array items: 1. | vendor.snapchat.body.data.invalid |
docs |
data[] |
optional | The vendor documents the JSON shape or value type of this field. Native JSON type: object. | vendor.snapchat.body.data[].invalid |
docs |
event_name |
required | Snap documents a fixed set of event types, spelled in upper case with underscores. Body scope: ["data[]",""]. Native JSON type: string. Fix: Use one of the documented event types, such as `PAGE_VIEW` or `PURCHASE`. | vendor.snapchat.body.event_name.missingvendor.snapchat.body.event_name.emptyvendor.snapchat.body.event_name.invalid |
docs |
event_time |
required | It is the epoch timestamp of the conversion, and Snap only accepts events from the last 7 days. Body scope: ["data[]",""]. Native JSON type: integer. Fix: Send the epoch timestamp of the conversion, not of the moment you forwarded it. | vendor.snapchat.body.event_time.missingvendor.snapchat.body.event_time.emptyvendor.snapchat.body.event_time.invalid |
docs |
action_source |
required | It says where the event took place, and Snap accepts three values. Body scope: ["data[]",""]. Native JSON type: string. Fix: Use `WEB`, `OFFLINE`, or `MOBILE_APP`. Snap spells these in upper case, unlike Meta. | vendor.snapchat.body.action_source.missingvendor.snapchat.body.action_source.emptyvendor.snapchat.body.action_source.invalid |
docs |
event_source_url |
optional | It is the URL of the page the event happened on, and Snap requires it for web events. Body scope: ["data[]",""]. Native JSON type: string. Fix: Send the full page URL, including the scheme. | vendor.snapchat.body.event_source_url.emptyvendor.snapchat.body.event_source_url.invalid |
docs |
event_id |
optional | It is an advertiser-chosen identifier for deduplication against the Pixel. Snap documents it as recommended for unique events. An empty pair cannot collapse a web and CAPI pair. Body scope: ["data[]",""]. Native JSON type: string. Fix: Send the same `event_id` the Pixel used as `client_dedup_id`, or drop the empty pair. | vendor.snapchat.body.event_id.emptyvendor.snapchat.body.event_id.invalid |
docs |
user_data |
required | Snap matches the conversion on customer information, and the event needs at least one identifier. Body scope: ["data[]",""]. Native JSON type: object. Fix: Add a `user_data` object carrying a hashed email, hashed phone, mobile ad id, or IP and user agent pair. | vendor.snapchat.body.user_data.missingvendor.snapchat.body.user_data.invalid |
docs |
user_data.em |
optional | Email must be normalized and SHA-256 hashed before it is sent. Body scope: ["data[]",""]. Native JSON type: string or array. Fix: Trim and lowercase the address, hash it with SHA-256, and send the hex digest. | vendor.snapchat.body.user_data.em.emptyvendor.snapchat.body.user_data.em.invalid |
docs |
user_data.em[] |
optional | Every email in the list must be normalized and SHA-256 hashed. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.user_data.em[].emptyvendor.snapchat.body.user_data.em[].invalid |
docs |
user_data.ph |
optional | Phone must be normalized and SHA-256 hashed before it is sent. Body scope: ["data[]",""]. Native JSON type: string or array. | vendor.snapchat.body.user_data.ph.emptyvendor.snapchat.body.user_data.ph.invalid |
docs |
user_data.ph[] |
optional | Every phone number in the list must be normalized and SHA-256 hashed. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.user_data.ph[].emptyvendor.snapchat.body.user_data.ph[].invalid |
docs |
user_data.fn |
optional | First name must be SHA-256 hashed. Body scope: ["data[]",""]. Native JSON type: string or array. | vendor.snapchat.body.user_data.fn.emptyvendor.snapchat.body.user_data.fn.invalid |
docs |
user_data.ln |
optional | Last name must be SHA-256 hashed. Body scope: ["data[]",""]. Native JSON type: string or array. | vendor.snapchat.body.user_data.ln.emptyvendor.snapchat.body.user_data.ln.invalid |
docs |
user_data.ge |
optional | Gender must be SHA-256 hashed. Body scope: ["data[]",""]. Native JSON type: string or array. | vendor.snapchat.body.user_data.ge.emptyvendor.snapchat.body.user_data.ge.invalid |
docs |
user_data.ct |
optional | City must be SHA-256 hashed. Body scope: ["data[]",""]. Native JSON type: string or array. | vendor.snapchat.body.user_data.ct.emptyvendor.snapchat.body.user_data.ct.invalid |
docs |
user_data.st |
optional | State must be SHA-256 hashed. Body scope: ["data[]",""]. Native JSON type: string or array. | vendor.snapchat.body.user_data.st.emptyvendor.snapchat.body.user_data.st.invalid |
docs |
user_data.zp |
optional | Postal code must be SHA-256 hashed. Body scope: ["data[]",""]. Native JSON type: string or array. | vendor.snapchat.body.user_data.zp.emptyvendor.snapchat.body.user_data.zp.invalid |
docs |
user_data.country |
optional | Country must be SHA-256 hashed. Body scope: ["data[]",""]. Native JSON type: string or array. | vendor.snapchat.body.user_data.country.emptyvendor.snapchat.body.user_data.country.invalid |
docs |
user_data.client_ip_address |
optional | It is sent unhashed, and it must be the address of the browser rather than of your server. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.user_data.client_ip_address.emptyvendor.snapchat.body.user_data.client_ip_address.invalid |
docs |
user_data.client_user_agent |
optional | It is sent unhashed, and it must be the browser's user agent rather than your HTTP client's. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.user_data.client_user_agent.emptyvendor.snapchat.body.user_data.client_user_agent.invalid |
docs |
user_data.sc_click_id |
optional | It is the Snap click ID from the landing-page `ScCid` query. Snap documents it as unhashed. Body scope: ["data[]",""]. Native JSON type: string. Fix: Copy `ScCid` from the landing URL into `user_data.sc_click_id`, or drop the empty pair. | vendor.snapchat.body.user_data.sc_click_id.emptyvendor.snapchat.body.user_data.sc_click_id.invalid |
docs |
user_data.sc_cookie1 |
optional | It is the first-party `_scid` cookie. Snap documents it as unhashed and recommended for match rate. Body scope: ["data[]",""]. Native JSON type: string. Fix: Read `_scid` under your domain into `user_data.sc_cookie1`, or drop the empty pair. | vendor.snapchat.body.user_data.sc_cookie1.emptyvendor.snapchat.body.user_data.sc_cookie1.invalid |
docs |
user_data.madid |
optional | It is the mobile advertiser ID. Snap documents it as lowercase and unhashed. Body scope: ["data[]",""]. Native JSON type: string. Fix: Send the IDFA or GAID in lowercase, unhashed, or drop the empty pair. | vendor.snapchat.body.user_data.madid.emptyvendor.snapchat.body.user_data.madid.invalid |
docs |
user_data.idfv |
optional | It is the plain-text IDFV. Snap documents it as unhashed and recommended for app events. Body scope: ["data[]",""]. Native JSON type: string. Fix: Send the IDFV unhashed, or drop the empty pair. | vendor.snapchat.body.user_data.idfv.emptyvendor.snapchat.body.user_data.idfv.invalid |
docs |
custom_data.value |
optional | It is the monetary value of the event. Snap documents a float, required for PURCHASE, with no currency symbol. Body scope: ["data[]",""]. Native JSON type: number. Fix: Send the purchase total in `custom_data.value` as a number, such as `10`. | vendor.snapchat.body.custom_data.value.invalid |
docs |
custom_data.currency |
optional | It is the currency of `custom_data.value`. Snap documents a subset of ISO 4217, not every three-letter code. Body scope: ["data[]",""]. Native JSON type: string. Fix: Send a documented code such as `USD`. | vendor.snapchat.body.custom_data.currency.emptyvendor.snapchat.body.custom_data.currency.invalid |
docs |
custom_data.order_id |
optional | It is the order identifier. Snap documents it on the Dynamic Ads custom_data table. Body scope: ["data[]",""]. Native JSON type: string. Fix: Send the order id in `custom_data.order_id`, or drop the empty pair. | vendor.snapchat.body.custom_data.order_id.emptyvendor.snapchat.body.custom_data.order_id.invalid |
docs |
custom_data.content_type |
optional | It says what `content_ids` or `contents` represent. Snap documents `product` for a single item or `product_group` for a variant group. Body scope: ["data[]",""]. Native JSON type: string. Fix: Set `custom_data.content_type` to `product` or `product_group`. | vendor.snapchat.body.custom_data.content_type.emptyvendor.snapchat.body.custom_data.content_type.invalid |
docs |
custom_data.content_ids |
optional | It is a product or category identifier. Snap documents a single id, an array, or a comma-separated list. Body scope: ["data[]",""]. Native JSON type: string or array. Fix: Send a catalog id in `custom_data.content_ids`, or drop the empty pair. | vendor.snapchat.body.custom_data.content_ids.emptyvendor.snapchat.body.custom_data.content_ids.invalid |
docs |
custom_data.content_ids[] |
optional | Every id in the list is a product or category identifier. Body scope: ["data[]",""]. Native JSON type: string. Fix: Send catalog ids in `custom_data.content_ids`, or drop empty entries. | vendor.snapchat.body.custom_data.content_ids[].emptyvendor.snapchat.body.custom_data.content_ids[].invalid |
docs |
custom_data.num_items |
optional | It is the total number of items. Snap documents it as a string. Body scope: ["data[]",""]. Native JSON type: string or integer. Fix: Send a whole number in `custom_data.num_items`, such as `2`. | vendor.snapchat.body.custom_data.num_items.emptyvendor.snapchat.body.custom_data.num_items.invalid |
docs |
custom_data.contents[].id |
optional | It is the item id on a contents row. Snap documents `id` on each contents object. Body scope: ["data[]",""]. Native JSON type: string. Fix: Set `custom_data.contents[].id` to the catalog item ID, or drop the empty pair. | vendor.snapchat.body.custom_data.contents[].id.emptyvendor.snapchat.body.custom_data.contents[].id.invalid |
docs |
custom_data.contents[].quantity |
optional | It is the item count on a contents row. Snap's published example sends it as a number string. Body scope: ["data[]",""]. Evidence: vendor template. Native JSON type: string or number. Fix: Send `custom_data.contents[].quantity` as a number, such as `1`. | vendor.snapchat.body.custom_data.contents[].quantity.emptyvendor.snapchat.body.custom_data.contents[].quantity.invalid |
docs |
custom_data.contents[].item_price |
optional | It is the unit price of one item. Snap's published example sends `item_price` as a number string. Body scope: ["data[]",""]. Evidence: vendor template. Native JSON type: string or number. Fix: Send `custom_data.contents[].item_price` as a number, such as `5`. Put the order total in `custom_data.value`. | vendor.snapchat.body.custom_data.contents[].item_price.emptyvendor.snapchat.body.custom_data.contents[].item_price.invalid |
docs |
custom_data.content_name |
optional | It is the name of the page or product associated with the event. Snap documents it on the Dynamic Ads custom_data table. Body scope: ["data[]",""]. Native JSON type: string. Fix: Send the page or product name in `custom_data.content_name`, or drop the empty pair. | vendor.snapchat.body.custom_data.content_name.emptyvendor.snapchat.body.custom_data.content_name.invalid |
docs |
custom_data.content_category |
optional | It is an item or category. Snap documents a single category or an array. Body scope: ["data[]",""]. Native JSON type: string or array. Fix: Send a category in `custom_data.content_category`, or drop the empty pair. | vendor.snapchat.body.custom_data.content_category.emptyvendor.snapchat.body.custom_data.content_category.invalid |
docs |
custom_data.content_category[] |
optional | Every entry in the list is an item or category. Body scope: ["data[]",""]. Native JSON type: string. Fix: Send categories in `custom_data.content_category`, or drop empty entries. | vendor.snapchat.body.custom_data.content_category[].emptyvendor.snapchat.body.custom_data.content_category[].invalid |
docs |
custom_data.search_string |
optional | It is the text that was searched for. Snap documents it on the Dynamic Ads custom_data table. Body scope: ["data[]",""]. Native JSON type: string. Fix: Send the query in `custom_data.search_string`, or drop the empty pair. | vendor.snapchat.body.custom_data.search_string.emptyvendor.snapchat.body.custom_data.search_string.invalid |
docs |
custom_data.predicted_ltv |
optional | It is the predicted lifetime value of the conversion. Snap documents a float. Body scope: ["data[]",""]. Native JSON type: number. Fix: Send `custom_data.predicted_ltv` as a number, such as `120.5`. | vendor.snapchat.body.custom_data.predicted_ltv.invalid |
docs |
custom_data.checkin_date |
optional | It is the hotel check-in date in the hotel's time zone. Snap documents YYYYMMDD, YYYY-MM-DD, YYYY-MM-DDThh:mmTZD, and YYYY-MM-DDThh:mm:ssTZD. Body scope: ["data[]",""]. Native JSON type: string. Fix: Send a documented check-in date such as `20261015` or `2026-10-15`. | vendor.snapchat.body.custom_data.checkin_date.emptyvendor.snapchat.body.custom_data.checkin_date.invalid |
docs |
custom_data.origin_airport |
optional | It is the origin airport. Snap documents the official IATA code. Body scope: ["data[]",""]. Native JSON type: string. Fix: Send a three-letter IATA code such as `JFK`. | vendor.snapchat.body.custom_data.origin_airport.emptyvendor.snapchat.body.custom_data.origin_airport.invalid |
docs |
custom_data.destination_airport |
optional | It is the destination airport. Snap documents the IATA code. Body scope: ["data[]",""]. Native JSON type: string. Fix: Send a three-letter IATA code such as `CDG`. | vendor.snapchat.body.custom_data.destination_airport.emptyvendor.snapchat.body.custom_data.destination_airport.invalid |
docs |
custom_data.num_adults |
optional | It is the number of adults staying. Snap documents an integer on the Dynamic Travel Ads table. Body scope: ["data[]",""]. Native JSON type: integer. Fix: Send a whole number in `custom_data.num_adults`, such as `2`. | vendor.snapchat.body.custom_data.num_adults.emptyvendor.snapchat.body.custom_data.num_adults.invalid |
docs |
custom_data.num_children |
optional | It is the number of children staying. Snap documents an integer on the Dynamic Travel Ads table. Body scope: ["data[]",""]. Native JSON type: integer. Fix: Send a whole number in `custom_data.num_children`, such as `1`. | vendor.snapchat.body.custom_data.num_children.emptyvendor.snapchat.body.custom_data.num_children.invalid |
docs |
custom_data.num_infants |
optional | It is the number of infants staying. Snap documents an integer on the Dynamic Travel Ads table. Body scope: ["data[]",""]. Native JSON type: integer. Fix: Send a whole number in `custom_data.num_infants`, such as `0`. | vendor.snapchat.body.custom_data.num_infants.emptyvendor.snapchat.body.custom_data.num_infants.invalid |
docs |
root |
optional | Each event is a JSON object, rather than a scalar or list. Body scope: ["data[]",""]. Native JSON type: object. | vendor.snapchat.body.root.invalid |
docs |
custom_data |
optional | The vendor documents the JSON shape or value type of this field. Body scope: ["data[]",""]. Native JSON type: object. | vendor.snapchat.body.custom_data.invalid |
docs |
app_data |
optional | The vendor documents the JSON shape or value type of this field. Body scope: ["data[]",""]. Native JSON type: object. | vendor.snapchat.body.app_data.invalid |
docs |
user_data.fn[] |
optional | The vendor documents the JSON shape or value type of this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.user_data.fn[].emptyvendor.snapchat.body.user_data.fn[].invalid |
docs |
user_data.ln[] |
optional | The vendor documents the JSON shape or value type of this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.user_data.ln[].emptyvendor.snapchat.body.user_data.ln[].invalid |
docs |
user_data.ge[] |
optional | The vendor documents the JSON shape or value type of this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.user_data.ge[].emptyvendor.snapchat.body.user_data.ge[].invalid |
docs |
user_data.ct[] |
optional | The vendor documents the JSON shape or value type of this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.user_data.ct[].emptyvendor.snapchat.body.user_data.ct[].invalid |
docs |
user_data.st[] |
optional | The vendor documents the JSON shape or value type of this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.user_data.st[].emptyvendor.snapchat.body.user_data.st[].invalid |
docs |
user_data.zp[] |
optional | The vendor documents the JSON shape or value type of this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.user_data.zp[].emptyvendor.snapchat.body.user_data.zp[].invalid |
docs |
user_data.country[] |
optional | The vendor documents the JSON shape or value type of this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.user_data.country[].emptyvendor.snapchat.body.user_data.country[].invalid |
docs |
custom_data.contents |
optional | The vendor documents the JSON shape or value type of this field. Body scope: ["data[]",""]. Native JSON type: array. | vendor.snapchat.body.custom_data.contents.invalid |
docs |
custom_data.contents[] |
optional | The vendor documents the JSON shape or value type of this field. Body scope: ["data[]",""]. Native JSON type: object. | vendor.snapchat.body.custom_data.contents[].invalid |
docs |
app_data.advertiser_tracking_enabled |
optional | The vendor documents the JSON shape or value type of this field. Body scope: ["data[]",""]. Native JSON type: boolean or integer. | vendor.snapchat.body.app_data.advertiser_tracking_enabled.emptyvendor.snapchat.body.app_data.advertiser_tracking_enabled.invalid |
docs |
user_data.subscription_id |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.user_data.subscription_id.invalid |
docs |
user_data.lead_id |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.user_data.lead_id.invalid |
docs |
user_data.anon_id |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.user_data.anon_id.invalid |
docs |
user_data.download_id |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.user_data.download_id.invalid |
docs |
user_data.partner_id |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.user_data.partner_id.invalid |
docs |
custom_data.travel_end |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.custom_data.travel_end.invalid |
docs |
custom_data.travel_start |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.custom_data.travel_start.invalid |
docs |
custom_data.country |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.custom_data.country.invalid |
docs |
custom_data.city |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.custom_data.city.invalid |
docs |
custom_data.region |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.custom_data.region.invalid |
docs |
custom_data.neighborhood |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.custom_data.neighborhood.invalid |
docs |
custom_data.departing_departure_date |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.custom_data.departing_departure_date.invalid |
docs |
custom_data.departing_arrival_date |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.custom_data.departing_arrival_date.invalid |
docs |
custom_data.returning_departure_date |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.custom_data.returning_departure_date.invalid |
docs |
custom_data.returning_arrival_date |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.custom_data.returning_arrival_date.invalid |
docs |
custom_data.hotel_score |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.custom_data.hotel_score.invalid |
docs |
custom_data.postal_code |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.custom_data.postal_code.invalid |
docs |
custom_data.status |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.custom_data.status.invalid |
docs |
custom_data.event_tag |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.custom_data.event_tag.invalid |
docs |
custom_data.suggested_destinations |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string or array. | vendor.snapchat.body.custom_data.suggested_destinations.invalid |
docs |
custom_data.suggested_destinations[] |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.custom_data.suggested_destinations[].invalid |
docs |
custom_data.preferred_neighborhoods |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string or array. | vendor.snapchat.body.custom_data.preferred_neighborhoods.invalid |
docs |
custom_data.preferred_neighborhoods[] |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.custom_data.preferred_neighborhoods[].invalid |
docs |
custom_data.preferred_star_ratings |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string or array. | vendor.snapchat.body.custom_data.preferred_star_ratings.invalid |
docs |
custom_data.preferred_star_ratings[] |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.custom_data.preferred_star_ratings[].invalid |
docs |
custom_data.suggested_hotels |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string or array. | vendor.snapchat.body.custom_data.suggested_hotels.invalid |
docs |
custom_data.suggested_hotels[] |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.custom_data.suggested_hotels[].invalid |
docs |
custom_data.destination_ids |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string or array. | vendor.snapchat.body.custom_data.destination_ids.invalid |
docs |
custom_data.destination_ids[] |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.custom_data.destination_ids[].invalid |
docs |
integration |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.integration.invalid |
docs |
test_event_code |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.test_event_code.invalid |
docs |
custom_data.custom_fields |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: object. | vendor.snapchat.body.custom_data.custom_fields.invalid |
docs |
advertiser_tracking_enabled |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: boolean or integer. | vendor.snapchat.body.advertiser_tracking_enabled.emptyvendor.snapchat.body.advertiser_tracking_enabled.invalid |
docs |
data_processing_options |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: array. | vendor.snapchat.body.data_processing_options.invalid |
docs |
data_processing_options[] |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.data_processing_options[].emptyvendor.snapchat.body.data_processing_options[].invalid |
docs |
app_data.extinfo |
optional | The published vendor reference specifies this field. Body scope: ["data[]",""]. Native JSON type: array. Minimum array items: 16. Maximum array items: 16. | vendor.snapchat.body.app_data.extinfo.invalid |
docs |
raw_request |
optional | The vendor publishes this field in its v3 SDK schema. Body scope: ["data[]",""]. Evidence: vendor template. Native JSON type: string. | vendor.snapchat.body.raw_request.invalid |
docs |
asset_id |
optional | The vendor publishes this field in its v3 SDK schema. Body scope: ["data[]",""]. Evidence: vendor template. Native JSON type: string. | vendor.snapchat.body.asset_id.invalid |
docs |
request_id |
optional | The vendor publishes this field in its v3 SDK schema. Body scope: ["data[]",""]. Evidence: vendor template. Native JSON type: string. | vendor.snapchat.body.request_id.invalid |
docs |
user_data.mobile_ad_id |
optional | The vendor publishes this field in its v3 SDK schema. Body scope: ["data[]",""]. Evidence: vendor template. Native JSON type: string. | vendor.snapchat.body.user_data.mobile_ad_id.invalid |
docs |
custom_data.delivery_category |
optional | The vendor publishes this field in its v3 SDK schema. Body scope: ["data[]",""]. Evidence: vendor template. Native JSON type: string. | vendor.snapchat.body.custom_data.delivery_category.invalid |
docs |
custom_data.brands |
optional | The vendor publishes this field in its v3 SDK schema. Body scope: ["data[]",""]. Evidence: vendor template. Native JSON type: string. | vendor.snapchat.body.custom_data.brands.invalid |
docs |
custom_data.sign_up_method |
optional | The vendor publishes this field in its v3 SDK schema. Body scope: ["data[]",""]. Evidence: vendor template. Native JSON type: string. | vendor.snapchat.body.custom_data.sign_up_method.invalid |
docs |
custom_data.contents[].delivery_category |
optional | The vendor publishes this field in its v3 SDK schema. Body scope: ["data[]",""]. Evidence: vendor template. Native JSON type: string. | vendor.snapchat.body.custom_data.contents[].delivery_category.invalid |
docs |
custom_data.contents[].brand |
optional | The vendor publishes this field in its v3 SDK schema. Body scope: ["data[]",""]. Evidence: vendor template. Native JSON type: string. | vendor.snapchat.body.custom_data.contents[].brand.invalid |
docs |
app_data.app_id |
optional | App events require the Snap application ID, numeric for iOS and a human-readable identifier for Android. Body scope: ["data[]",""]. Evidence: vendor documented. Native JSON type: string. | vendor.snapchat.body.app_data.app_id.emptyvendor.snapchat.body.app_data.app_id.invalid |
docs |
app_data.campaign_ids |
optional | The vendor publishes this field in its v3 SDK schema. Body scope: ["data[]",""]. Evidence: vendor template. Native JSON type: string. | vendor.snapchat.body.app_data.campaign_ids.invalid |
docs |
app_data.install_referrer |
optional | The vendor publishes this field in its v3 SDK schema. Body scope: ["data[]",""]. Evidence: vendor template. Native JSON type: string. | vendor.snapchat.body.app_data.install_referrer.invalid |
docs |
app_data.installer_package |
optional | The vendor publishes this field in its v3 SDK schema. Body scope: ["data[]",""]. Evidence: vendor template. Native JSON type: string. | vendor.snapchat.body.app_data.installer_package.invalid |
docs |
app_data.windows_attribution_id |
optional | The vendor publishes this field in its v3 SDK schema. Body scope: ["data[]",""]. Evidence: vendor template. Native JSON type: string. | vendor.snapchat.body.app_data.windows_attribution_id.invalid |
docs |
opt_out |
optional | The vendor publishes this field in its v3 SDK schema. Body scope: ["data[]",""]. Evidence: vendor template. Native JSON type: boolean. | vendor.snapchat.body.opt_out.invalid |
docs |
app_data.url_schemes |
optional | The vendor publishes this field in its v3 SDK schema. Body scope: ["data[]",""]. Evidence: vendor template. Native JSON type: array. | vendor.snapchat.body.app_data.url_schemes.invalid |
docs |
app_data.url_schemes[] |
optional | The vendor publishes this field in its v3 SDK schema. Body scope: ["data[]",""]. Evidence: vendor template. Native JSON type: string. | vendor.snapchat.body.app_data.url_schemes[].invalid |
docs |
custom_data.custom_fields.* |
optional | The vendor publishes this field in its v3 SDK schema. Body scope: ["data[]",""]. Evidence: vendor template. Native JSON type: string. | vendor.snapchat.body.custom_data.custom_fields.*.invalid |
docs |
app_data.extinfo[0] |
optional | Ordered device slot 0 uses the published extinfo type. Empty strings are supported for missing optional device information. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.app_data.extinfo[0].emptyvendor.snapchat.body.app_data.extinfo[0].invalid |
docs |
app_data.extinfo[1] |
optional | Ordered device slot 1 uses the published extinfo type. Empty strings are supported for missing optional device information. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.app_data.extinfo[1].invalid |
docs |
app_data.extinfo[2] |
optional | Ordered device slot 2 uses the published extinfo type. Empty strings are supported for missing optional device information. Body scope: ["data[]",""]. Native JSON type: string or integer. | vendor.snapchat.body.app_data.extinfo[2].invalid |
docs |
app_data.extinfo[3] |
optional | Ordered device slot 3 uses the published extinfo type. Empty strings are supported for missing optional device information. Body scope: ["data[]",""]. Native JSON type: string or number. | vendor.snapchat.body.app_data.extinfo[3].invalid |
docs |
app_data.extinfo[4] |
optional | Ordered device slot 4 uses the published extinfo type. Empty strings are supported for missing optional device information. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.app_data.extinfo[4].invalid |
docs |
app_data.extinfo[5] |
optional | Ordered device slot 5 uses the published extinfo type. Empty strings are supported for missing optional device information. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.app_data.extinfo[5].invalid |
docs |
app_data.extinfo[6] |
optional | Ordered device slot 6 uses the published extinfo type. Empty strings are supported for missing optional device information. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.app_data.extinfo[6].invalid |
docs |
app_data.extinfo[7] |
optional | Ordered device slot 7 uses the published extinfo type. Empty strings are supported for missing optional device information. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.app_data.extinfo[7].invalid |
docs |
app_data.extinfo[8] |
optional | Ordered device slot 8 uses the published extinfo type. Empty strings are supported for missing optional device information. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.app_data.extinfo[8].invalid |
docs |
app_data.extinfo[9] |
optional | Ordered device slot 9 uses the published extinfo type. Empty strings are supported for missing optional device information. Body scope: ["data[]",""]. Native JSON type: string or integer. | vendor.snapchat.body.app_data.extinfo[9].emptyvendor.snapchat.body.app_data.extinfo[9].invalid |
docs |
app_data.extinfo[10] |
optional | Ordered device slot 10 uses the published extinfo type. Empty strings are supported for missing optional device information. Body scope: ["data[]",""]. Native JSON type: string or integer. | vendor.snapchat.body.app_data.extinfo[10].emptyvendor.snapchat.body.app_data.extinfo[10].invalid |
docs |
app_data.extinfo[11] |
optional | Ordered device slot 11 uses the published extinfo type. Empty strings are supported for missing optional device information. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.app_data.extinfo[11].invalid |
docs |
app_data.extinfo[12] |
optional | Ordered device slot 12 uses the published extinfo type. Empty strings are supported for missing optional device information. Body scope: ["data[]",""]. Native JSON type: string or integer. | vendor.snapchat.body.app_data.extinfo[12].emptyvendor.snapchat.body.app_data.extinfo[12].invalid |
docs |
app_data.extinfo[13] |
optional | Ordered device slot 13 uses the published extinfo type. Empty strings are supported for missing optional device information. Body scope: ["data[]",""]. Native JSON type: string or integer. | vendor.snapchat.body.app_data.extinfo[13].emptyvendor.snapchat.body.app_data.extinfo[13].invalid |
docs |
app_data.extinfo[14] |
optional | Ordered device slot 14 uses the published extinfo type. Empty strings are supported for missing optional device information. Body scope: ["data[]",""]. Native JSON type: string or integer. | vendor.snapchat.body.app_data.extinfo[14].emptyvendor.snapchat.body.app_data.extinfo[14].invalid |
docs |
app_data.extinfo[15] |
optional | Ordered device slot 15 uses the published extinfo type. Empty strings are supported for missing optional device information. Body scope: ["data[]",""]. Native JSON type: string. | vendor.snapchat.body.app_data.extinfo[15].invalid |
docs |
body.web_requires_source_url |
required | The event is marked `action_source: WEB` but carries no `event_source_url`, which Snap requires for website events. Body scope: ["data[]",""]. Fix: Send the URL of the page the event took place on. | vendor.snapchat.body.web_requires_source_url |
docs |
body.purchase_requires_value_and_currency |
required | A `PURCHASE` event is missing its value or currency. Snap documents `value` as required for PURCHASE, and currency rides with that value. Body scope: ["data[]",""]. Fix: Send `custom_data.value` and `custom_data.currency` on PURCHASE events. | vendor.snapchat.body.purchase_requires_value_and_currency |
docs |
body.value_requires_currency |
required | The event carries `custom_data.value` with no `custom_data.currency`. Snap documents currency as the ISO code that goes with the value. Body scope: ["data[]",""]. Fix: Add `custom_data.currency` as a three-letter code alongside the value. | vendor.snapchat.body.value_requires_currency |
docs |
body.unhashed_email |
required | A field carries what looks like a raw email address. Snap requires customer information to be normalized and SHA-256 hashed. Body scope: ["data[]",""]. Fix: Trim the address, lowercase it, hash it with SHA-256, and send the hex digest. | vendor.snapchat.body.unhashed_email |
docs |
body.hashed_plaintext_field |
required | This field looks like a SHA-256 digest, but Snap documents it as one of the parameters that is sent unhashed. Body scope: ["data[]",""]. Fix: Send the raw value. Hashing it makes the event unmatchable. | vendor.snapchat.body.hashed_plaintext_field |
docs |
body.app_requires_extinfo |
required | App events require the complete extinfo device array. Body scope: ["data[]",""]. | vendor.snapchat.body.app_requires_extinfo |
docs |
body.event_time_time_window |
required | The timestamp is outside the documented processing window. Body scope: ["data[]",""]. | vendor.snapchat.body.event_time_time_window |
docs |
body.ios_extinfo_app_id |
required | iOS app events use a numeric Snap app ID. Body scope: ["data[]",""]. | vendor.snapchat.body.ios_extinfo_app_id |
docs |
body.app_requires_app_id |
required | App events require the Snap application identifier. Body scope: ["data[]",""]. | vendor.snapchat.body.app_requires_app_id |
docs |
method |
required | The published conversion operation uses POST. Complete HTTP capture contract. Native JSON type: string. | vendor.snapchat.http.method.missingvendor.snapchat.http.method.emptyvendor.snapchat.http.method.invalid |
docs |
content_type |
recommended | The official producer sends application/json. MIME variations receive advice without inventing an exhaustive receiver contract. Complete HTTP capture contract. Presence diagnostic severity: warning. Native JSON type: string. | vendor.snapchat.http.content_type.missingvendor.snapchat.http.content_type.emptyvendor.snapchat.http.content_type.invalid |
docs |
body_encoding |
recommended | The published conversion profile sends a JSON entity. Unsupported compressed bodies and unavailable capture evidence remain unknown. Complete HTTP capture contract. Applies when {"kind":"all","conditions":[{"kind":"not","condition":{"kind":"value_in","param":"body_encoding","values":["unsupported"]}},{"kind":"any","conditions":[{"kind":"value_in","param":"body_encoding","values":["none"]},{"kind":"value_in","param":"content_type","values":["application/json"]}]}]}. Presence diagnostic severity: warning. | vendor.snapchat.http.body_encoding.missingvendor.snapchat.http.body_encoding.emptyvendor.snapchat.http.body_encoding.invalid |
docs |
url |
optional | The published conversion endpoint uses HTTPS. This is transport advice, without a receiver redirect claim. Complete HTTP capture contract. Presence diagnostic severity: warning. Native JSON type: string. | vendor.snapchat.http.url.emptyvendor.snapchat.http.url.invalid |
docs |
body |
optional | Parsed request body supplies the object guard. Existing body contracts retain supplied native type checks. Complete HTTP capture contract. | docs | |
body.data |
recommended | The v3 request envelope uses a root data array. A missing member on captured objects receives advice while legacy bare JSON retains its existing compatibility behavior. Complete HTTP capture contract. Applies when {"kind":"all","conditions":[{"kind":"json_type","param":"body","json_type":"object"},{"kind":"not","condition":{"kind":"exists","param":"body.data"}}]}. Presence diagnostic severity: warning. | vendor.snapchat.http.body.data.missing |
docs |
Validate a payload
pixellint validate request @request.json --rulepack vendor/snapchat
Try this failing payload in the playground. An example with a validation finding.
{
"url": "https://tr.snapchat.com/v3/synthetic-asset/events?access_token=synthetic-token",
"method": "GET",
"headers": {
"Content-Type": "application/json"
},
"body": "{\"data\":[{\"event_name\":\"PURCHASE\",\"event_time\":1770000000,\"action_source\":\"WEB\",\"event_source_url\":\"https://example.com/checkout/thank-you\",\"user_data\":{\"em\":[\"a85e9ca18f34935ab9b0381b25bfad2455444112b0149270fd88e3da172fe196\"],\"client_ip_address\":\"203.0.113.42\",\"client_user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)\"},\"custom_data\":{\"value\":129.99,\"currency\":\"USD\"}}]}"
}
cargo install pixellint
·
npm install pixellint