Skip to main content
Solved

Payload for server-side add-to-cart and product-view events

  • September 30, 2024
  • 2 replies
  • 78 views

Forum|alt.badge.img

Hello,

 

I have been reading the documentation, specifically of the create event endpoint (https://developers.klaviyo.com/en/reference/create_event) but i'm a bit confused.

For example, if i'm sending an add to cart event, i assume i'd have to send a product id, quantity and price field, yet I can't find documentation on any of those fields. We are working on a shopify integration and have access to all of this data, we just don't know the proper format that the klaviyo API expects.

Is there a page in the documentation that I am missing, or will we have to reverse-engineer the Shopify klaviyo app to figure out the payloads?

Best answer by Maxbuzz

Hello @TrackBee 

You can pass additional any additional info in the event. here is an exmaple:

"type": "event",
    "attributes": {
      "properties": {
        "newKey": "New Value",
        "newKey-1": "New Value"
      },

}

 

Regarding the metric, If you are creating your own metric for Viewed Product, Ordered Product then keep in mind that out of the box metrics won’t be updated.

Another limitation is that you can only update one metric in a call.

View original

2 replies

Forum|alt.badge.img
  • Author
  • Contributor II
  • 4 replies
  • September 30, 2024

And I also have a small, somewhat related follow-up question:

 

When we send these events, we would like the custom metric be called something like "Viewed Product - TrackBee" or "Placed Order - TrackBee” (so following Klaviyo's own naming scheme, followed by our company name). Will this cause any problems? On this page https://developers.klaviyo.com/en/docs/guide_to_integrating_a_platform_without_a_pre_built_klaviyo_integration it mentions that naming them incorrectly will cause some things to not work, but it's unclear if the name has to exactly be "Viewed Product" or if it only needs to start with that. For example I've seen Elevar (a different tracking SAAS) also name their Klaviyo metrics "Viewed Product - Elevar SS".


Forum|alt.badge.img+31
  • Partner
  • 252 replies
  • Answer
  • October 1, 2024

Hello @TrackBee 

You can pass additional any additional info in the event. here is an exmaple:

"type": "event",
    "attributes": {
      "properties": {
        "newKey": "New Value",
        "newKey-1": "New Value"
      },

}

 

Regarding the metric, If you are creating your own metric for Viewed Product, Ordered Product then keep in mind that out of the box metrics won’t be updated.

Another limitation is that you can only update one metric in a call.