define and document the API structure

[jipiboily]

No description provided.

[GabLeRoux]

http://raml.org/ ?

[jipiboily]

For now, probably just something in the README, as it might change a lot before 0.1, and before 1.0...and possibly Apiary + Blueprint. At least, that's what I had in mind. I'll look at RAML though.

Thanks!

[jipiboily]

At first, I think...

What we take from the API:

{
  context: {}, // optionnal, but can have IP of the user, user agent, version of the library used, etc
  timestamp: 123, // when the event triggered
  userID: 'some-user-id',
  userTraits: {} // User traits, most are custom. Some are required, per integration
}

What we send to the integrations:

{
  context: {}, // optionnal, but can have IP of the user, user agent, version of the library used, etc
  timestamp: 123, // when the event triggered
  userID: 'some-user-id',
  receivedAt: 123, // when Forwardlytics received the event
  userTraits: {} // User traits, most are custom. Some are required, per integration
}

[jipiboily]

That being said, the context won't be there to start with, as it is more appropriate for frontend libraries.

[jipiboily]

Now documented lightly in the README and the code.