Why is sending only the $id when creating an Event not documented?

For what it’s worth, this sounds like a helpful feature with an obvious use case, and the documentation should reflect that a profile’s ID can also be used as an identifier. 

@jballo919 what did your request body look like? 

Something like this?

{
  "data": {
    "type": "event",
    "attributes": {
      "profile": {
        "id": "{klaviyoProfileId}"
      },
      "metric": {
        "name": "{event name}"
      }
    }
  }
}

Cheers,

Kevin.

 Ah sorry I should have used “External ID” as the keyword in my original post - I found that I can pass just an external identifier in the `$id` field of the `profile` part of the request body, and this will set the external ID on the profile.

Example request:

{
  "data": {
    "type": "event",
    "attributes": {
      "profile": {
        "$id": "{externalID}"
      },
      "metric": {
        "name": "{event name}"
      }
    }
  }
}

This will then create a new profile (with some Klaviyo Profile ID that gets set), and put the string I put in `$id` as the external ID of that profile.

Example:

In this example, I sent `$id` as `”c06b1996-d2fb-45a7-a834-8882a9f2f842”`

I also found that if I send this on an event where I send the email of an existing profile, this will reset the External ID on the profile matching that email.

It would be great if both of these are documented features of the API, so that I can confirm that I can build our integration with these assumptions in mind.

@KeviSunshine any update on this topic? Is this a feature of the API that is supposed to exist, and can it be added to the documentation?

Hey @jballo919,

I wish I could help you more but I am not affiliated with Klaviyo in any official capacity! I am just a fellow developer that uses Klaviyo a lot and sometimes hangs out on the forums!

Lets ping @David To on this one. He’s the community manager :)

My opinion is that this functionality is intentional and will continue to be supported. 

From my experience, Klaviyo doesn’t update their developer documentation very frequently and it’s often lacking options/examples/advanced scenarios.

Cheers,

Kevin.

Hi @jballo919 and @KeviSunshine!

Thanks for bringing this up! I’m going to check with Engineering to confirm this functionality and adjust the documentation if necessary, and then I’ll update the thread!

Best,
- Brian