Skip to main content

Event Types

When you are sending assess or track requests with a client library to Upollo you have the ability to send those requests with an event type. These event types, although not required, provide useful context that helps with analysis. See the upollo/userwatch-proto for full details.

The events currently supported are as follows:

General

Events relating to general user activity in your application.

EVENT_TYPE_HEARTBEAT

Track EVENT_TYPE_HEARTBEAT at regular intervals if no other events are sent. We recommend every 30 minutes.

EVENT_TYPE_LOGIN

Track EVENT_TYPE_LOGIN immediately before a login attempt. The login may still fail due to invalid credentials, and this is fine because the EVENT_TYPE_LOGIN_SUCCESS is for when the login is actually successful.

EVENT_TYPE_LOGIN_SUCCESS

Track EVENT_TYPE_LOGIN_SUCCESS immediately after a successful login. This does not include a token renewal

EVENT_TYPE_PAGE_VISIT

Track EVENT_TYPE_PAGE_VISIT after a page or screen is loaded.

EVENT_TYPE_REGISTER

Track EVENT_TYPE_REGISTER immediately before a customer a customer attempts to register an account.

EVENT_TYPE_REGISTER_SUCCESS

Track EVENT_TYPE_REGISTER_SUCCESS after the customer has successfully registered a new account.

Payments & purchases

Events relating to transactions for goods or services.

EVENT_TYPE_ADD_PAYMENT_METHOD

Track EVENT_TYPE_ADD_PAYMENT_METHOD immediately after the customer has successfully added a new payment method.

EVENT_TYPE_ATTEMPT_PURCHASE

Track EVENT_TYPE_ATTEMPT_PURCHASE immediately before a purchase attempt. You should track this event regardless of whether the purchase succeeds or fails. If the purchase succeeds, you should additionally track EVENT_TYPE_COMPLETE_PURCHASE.

EVENT_TYPE_ATTEMPT_REDEEM_OFFER

Track EVENT_TYPE_ATTEMPT_REDEEM_OFFER immediately before an attempt to redeem an offer. You should track this event regardless of whether the redemption succeeds or fails. If the redemption succeeds, you should additionally track EVENT_TYPE_REDEEMED_OFFER.

EVENT_TYPE_COMPLETE_PURCHASE

Track EVENT_TYPE_COMPLETE_PURCHASE immediately after a successful purchase.

EVENT_TYPE_END_SUBSCRIPTION

Track EVENT_TYPE_END_SUBSCRIPTION immediately after a subscription is ended.

EVENT_TYPE_REDEEMED_OFFER

Track EVENT_TYPE_REDEEMED_OFFER after the customer has successfully redeemed an offer.

EVENT_TYPE_START_SUBSCRIPTION

Track EVENT_TYPE_START_SUBSCRIPTION immediately after a subscription has started.

Other

EVENT_TYPE_INTERNAL

EVENT_TYPE_INTERNAL is used internally and you should not use it.

EVENT_TYPE_UNSPECIFIED

EVENT_TYPE_UNSPECIFIED is unspecified and you should not use it.

Upollo
Upollo logoUpollo
Copyright 2022