eventType
, timestamp
and userId
are required.
timestamp
should be in ISO 8601 Format.
You can optionally pass additional fields within the user
object to tell us which account (customer) this user belongs to, if this is a child account who the parent that pays the bills is, and also the identifiers to link to the payment system. If all this info is passed, use of the /v3/account
and /v3/user
endpoints is optional.
metadata
allows the passing of more detailed information about the event (for example if the event was item_viewed
then which item could be passed here).
sessionId
is your session id, if tracked.
tags
allows you to pass multiple tags to tag this event (e.g. A/B testing).
eventId
allows you to assign your internal event id for tracking purposes.
If your are a B2C business, use the paymentId
and subscriptionId
on the user
object. If you are B2B, then use them on the account
object instead.
paymentId
is the identifier used in the your payment system (e.g. Stripe Customer Id)
subscriptionId
is the identifier used to identify subscriptions (e.g. Stripe Subscription Id)
For the account
object, if used the accountId
is required.
If you have multiple tiers of accounts, then use parentAccountId
to identify the immediate parent account of this account. Use billingAccountId
to identify which account has the billing relationship (e.g. is connected to Stripe), if it is different from both the accountId and parentId (if used).