Permalink
Browse files

fix(docs): update flow event docs to match recent changes (#198) r=vl…

…adikoff
  • Loading branch information...
1 parent f23707f commit d6eb73d789246c9021a49607a69db988ba4d20b1 @philbooth philbooth committed with vladikoff Oct 5, 2016
Showing with 8 additions and 14 deletions.
  1. +8 −14 features/FxA-41-signin-funnel-metrics/README.md
@@ -80,16 +80,12 @@ in a successful flow:
|Name|Origin|Description|
|----|------|-----------|
-|`flow.begin`|content|User has landed on a page that allows them to log in or sign up.|
-|`flow.signup.engage`|content|User has interacted with the signup form at `/signup`.|
-|`flow.signin.engage`|content|User has interacted with the login form at `/signin`.|
-|`flow.force_auth.engage`|content|User has interacted with the login form at `/force_auth`.|
-|`flow.signup.submit`|content|User has submitted the signup form at `/signup`. It is a valid flow for this event to be followed by `account.login`, because the content server allows users to log in from `/signup`.|
-|`flow.signin.submit`|content|User has submitted the login form at `/signin`.|
-|`flow.force_auth.submit`|content|User has submitted the login form at `/force_auth`.|
+|`flow.${viewName}.begin`|content|User has landed on a page that allows them to sign in/up.|
+|`flow.${viewName}.engage`|content|User has interacted with the form on a page that allows them to sign in/up.|
+|`flow.${viewName}.submit`|content|User has submitted the form on a page that allows them to sign in/up.|
+|`flow.have-account`|content|User has clicked the "Already have an account?" link on `/signup`.|
|`account.login`|auth|User’s credentials are correct.|
|`account.created`|auth|Account has been created.|
-|`device.created`|auth|Device record has been created.|
|`email.sent`|auth|Confirmation email has been sent to the user.|
|`email.clicked`|auth|Request to the URL in the confirmation email has been received.|
|`account.confirmed`|auth|Login has been confirmed via email.|
@@ -101,12 +97,11 @@ in a successful flow:
For a typical successful Sync login flow,
the sequence of events would be:
-* `flow.begin`
+* `flow.signin.begin`
* `flow.signin.engage`
* `flow.signin.submit`
* `account.login`
* `email.sent`
-* `device.created`
* `email.clicked`
* `account.confirmed`
* `account.keyfetch`
@@ -116,12 +111,11 @@ the sequence of events would be:
For a typical successful Sync signup flow,
the sequence of events would be:
-* `flow.begin`
+* `flow.signup.begin`
* `flow.signup.engage`
* `flow.signup.submit`
* `account.created`
* `email.sent`
-* `device.created`
* `email.clicked`
* `account.verified`
* `account.keyfetch`
@@ -238,10 +232,10 @@ will carry the following properties:
|Property|Description|
|--------|-----------|
-|`event`|The event name, e.g. `flow.engage`|
+|`event`|The event name, e.g. `flow.signin.engage`|
|`time`|Unix timestamp for this event|
|`flow_id`|Unique identifier for a flow, randomly generated by the content server|
-|`flow_time`|Offset in milliseconds from the `time` property of the relevant `flow.begin` event|
+|`flow_time`|Offset in milliseconds from the `time` property of the relevant `flow.${viewName}.begin` event|
|`userAgent`|User agent string, parsed by the data pipeline and made available as the properties `useragentbrowser`, `useragentversion`, `useragentos`|
|`context`|Auth-broker context|
|`entrypoint`|Entry-point for the flow|

0 comments on commit d6eb73d

Please sign in to comment.