Skip to main content
Contributor I
Jul 9, 2024 5:58 PM UTC
Solved

Klaviyo JS snippet method documentation?

Hello, I was hoping I could get some insight on the methods provided here:
https://developers.klaviyo.com/en/docs/introduction_to_the_klaviyo_object#supported-methods

 

 

I am mainly confused about the use case for `account` and `isIdentified`.

I found some more info here:

https://developers.klaviyo.com/en/docs/guide_to_setting_up_api_based_website_activity_events#website-activity

https://developers.klaviyo.com/en/docs/guide_to_integrating_a_platform_without_a_pre_built_klaviyo_integration#javascript-track-api-for-onsite-metrics

 

The latter links hints that the klaviyo js snippet is just a wrapper to the events api:
https://developers.klaviyo.com/en/reference/events_api_overview

 

However, when I try to find out more about what kind of events there are, there is not a formal definition. The only event information I can find is on those two pages. I am wondering if I missed a page for a listing of the available events and expected shapes? I could reverse all of this, but it would be easier if we had common event definitions in one page and when to use them.

This topic has been closed for replies.
KeviSunshine
Expert Problem Solver III
Jul 9, 2024 7:39 PM UTC

Hi @someconfuseddeveloper,

In general, Klaviyo events are completely arbitrary and the only structure is `eventProperties` (an arbitrary object of event properties that can be strings, bools, lists, or ints– or maybe objects in some situations).

However, for a lot of integrations (especially e-commerce integrations), there are pre-defined events that have pre-defined structures and hook into pre-defined flows (and other things of that nature). These integrations are creating standards on top of Klaviyo.

I do not have any e-commerce integrations and treat every event as an “arbitrary” event with an “arbitrary” structure.

 

Hope that helps!

Kevin.

3 replies

Contributor I
Jul 9, 2024 6:13 PM UTC

After reading this page:
https://developers.klaviyo.com/en/docs/custom_integration_faqs

 

It implies that all the events are completely arbitrary? Events are more a convention than a rule with specific shape?

KeviSunshine
Expert Problem Solver III
Expert Problem Solver III
Jul 9, 2024 7:39 PM UTC

Hi @someconfuseddeveloper,

In general, Klaviyo events are completely arbitrary and the only structure is `eventProperties` (an arbitrary object of event properties that can be strings, bools, lists, or ints– or maybe objects in some situations).

However, for a lot of integrations (especially e-commerce integrations), there are pre-defined events that have pre-defined structures and hook into pre-defined flows (and other things of that nature). These integrations are creating standards on top of Klaviyo.

I do not have any e-commerce integrations and treat every event as an “arbitrary” event with an “arbitrary” structure.

 

Hope that helps!

Kevin.

Contributor I
Jul 9, 2024 10:37 PM UTC

Thank you! That makes a lot of sense now!