packages/fxa-shared/metrics/glean/fxa-backend-metrics.yaml

---
# Schema
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0

event:
  name:
    type: string
    description: |
      The name of the event
    lifetime: ping
    send_in_pings:
      - accounts-events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction

  reason:
    description: additional context-dependent (on event.name) info, e.g. the cause of an error
    type: string
    lifetime: ping
    send_in_pings:
      - accounts-events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
      - https://mozilla-hub.atlassian.net/browse/FXA-7271
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction

account:
  user_id:
    type: string
    description: |
      The firefox/mozilla account id
    lifetime: application
    send_in_pings:
      - accounts-events
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - interaction
    no_lint:
      - COMMON_PREFIX
  user_id_sha256:
    type: string
    description: |
      A hex string of a sha256 hash of the account's uid
    lifetime: application
    send_in_pings:
      - accounts-events
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - interaction
  password_reset:
    type: event
    description: |
      Forgot Password Complete
      Successful completion of the forgot password funnel.
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
  delete_complete:
    type: event
    description: |
      Account successfully deleted
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-10037
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
  delete_task_handled:
    type: event
    description: |
      An account was deleted from FxA.
    lifetime: ping
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-10497
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - technical
    extra_keys:
      reason:
        description: |
          The reason for the deletion.
        type: string


relying_party:
  service:
    type: string
    description: |
      The service name of the relying party
    lifetime: application
    send_in_pings:
      - accounts-events
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - technical

  oauth_client_id:
    type: string
    description: |
      The client id of the relying party
    lifetime: application
    send_in_pings:
      - accounts-events
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - technical

  form_view:
    type: event
    description: |
      The Relying Party is using a button or a form with an input for an email
      address to take the user to FxA.  The RP has displayed the form to the
      user.
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-10061
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - interaction
    extra_keys:
      type:
        description: the type of form the RP showed the user
        type: string

session:
  flow_id:
    type: string
    description: an ID generated by FxA for its flow metrics
    lifetime: application
    send_in_pings:
      - accounts-events
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction

  device_type:
    type: string
    description: one of 'mobile', 'tablet', or ''
    lifetime: application
    send_in_pings:
      - accounts-events
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - technical

  entrypoint:
    type: string
    description: Entrypoint to the service
    lifetime: application
    send_in_pings:
      - accounts-events
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction

  entrypoint_experiment:
    type: string
    description: Identifier for the experiment the user is part of at the entrypoint
    lifetime: application
    send_in_pings:
      - accounts-events
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction

  entrypoint_variation:
    type: string
    description: Identifier for the experiment variation the user is part of at the entrypoint
    lifetime: application
    send_in_pings:
      - accounts-events
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction

utm:
  campaign:
    description: |
      A marketing campaign.  For example, if a user signs into FxA from selecting a
      Mozilla VPN plan on Mozilla VPN's product site, then the value of this metric could
      be 'vpn-product-page'.  The value has a max length of 128 characters with the
      alphanumeric characters, _ (underscore), forward slash (/), . (period), %
      (percentage sign), and - (hyphen) in the allowed set of characters.  The
      special value of 'page+referral+-+not+part+of+a+campaign' is also allowed.
    type: string
    lifetime: application
    send_in_pings:
      - accounts-events
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction

  content:
    description: |
      The content on which the user acted.  For example, if the user clicked on the
      (previously available) "Get started here" link in "Looking for Firefox Sync? Get
      started here", then the value for this metric would be 'fx-sync-get-started'.
      The value has a max length of 128 characters with the alphanumeric characters,
      _ (underscore), forward slash (/), . (period), % (percentage sign), and - (hyphen)
      in the allowed set of characters.
    type: string
    lifetime: application
    send_in_pings:
      - accounts-events
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction

  medium:
    description: |
      The "medium" on which the user acted.  For example, if the user clicked on a
      link in an email, then the value of this metric would be 'email'.  The value
      has a max length of 128 characters with the alphanumeric characters, _
      (underscore), forward slash (/), . (period), % (percentage sign), and -
      (hyphen) in the allowed set of characters.
    type: string
    lifetime: application
    send_in_pings:
      - accounts-events
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction

  source:
    description: |
      The source from where the user started.  For example, if the user clicked on a
      link on the Mozilla accounts web site, this value could be 'fx-website'.  The
      value has a max length of 128 characters with the alphanumeric characters, _
      (underscore), forward slash (/), . (period), % (percentage sign), and -
      (hyphen) in the allowed set of characters.
    type: string
    lifetime: application
    send_in_pings:
      - accounts-events
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction

  term:
    description: |
      This metric is similar to the `utm.source`; it is used in the Firefox
      browser.  For example, if the user started from about:welcome, then the value
      could be 'aboutwelcome-default-screen'.  The value has a max length of 128
      characters with the alphanumeric characters, _ (underscore), forward slash (/),
      . (period), % (percentage sign), and - (hyphen) in the allowed set of
      characters.
    type: string
    lifetime: application
    send_in_pings:
      - accounts-events
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction

access_token:
  checked:
    type: event
    description: |
      An OAuth access token was verified.
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
    extra_keys:
      scopes:
        description: The scopes of the access token
        type: string
  created:
    type: event
    description: |
      An OAuth access token was created.
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
    extra_keys:
      reason:
        description: additional context-dependent info, e.g. the cause of an error
        type: string
login:
  backup_code_success:
    type: event
    description: |
      Login Backup Code Success
      Event that indicates the user successfully authenticated via backup codes.
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
  complete:
    type: event
    description: |
      Login Complete
      Event that indicates the login process is complete.
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
  email_confirmation_sent:
    type: event
    description: |
      Login Email Sent
      Event that indicates an email was sent to confirm email.
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
  email_confirmation_success:
    type: event
    description: |
      Login Email Confirmed (BE)
      Event that indicates a user successfully confirmed their email for the login
      flow by entering the code sent in the confirmation email.
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
  submit_backend_error:
    type: event
    description: |
      Login Submission Failure (Server)
      Event that indicates an attempt to login by clicking "Sign in" on the login
      page was not successful. Ideally we would have additional data on why the
      login failed. We might expect most reasons to be "Incorrect password".
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
    extra_keys:
      reason:
        description: additional context-dependent info, e.g. the cause of an error
        type: string
  success:
    type: event
    description: |
      Login Submission Success
      Event that indicates an attempt to login by clicking "Sign in" on the login
      page was successful.
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
  totp_code_failure:
    type: event
    description: |
      The user failed to enter a correct TOTP for 2FA.
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
  totp_code_success:
    type: event
    description: |
      Login 2FA Success (BE)
      Event that indicates a user successfully authenticated via 2FA.
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
password_reset:
  create_new_success:
    type: event
    description: |
      Create New Password Success (BE)
      A new password was successfully created'
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
  email_sent:
    type: event
    description: |
      Forgot Password Email Link Sent
      Link to reset password sent to the FxA email address'
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
  recovery_key_create_success:
    type: event
    description: |
      Forgot Password w/ Recovery Key Create New Password Success (BE)
      User successfully submits the form to create a new password'
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
  recovery_key_success:
    type: event
    description: |
      Forgot Password Confirm Recovery Key Success
      Successful recovery key input for the forgot password flow'
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
  email_confirmation_sent:
    type: event
    description: |
      One-Time-Password to initiate the password reset process sent to the FxA
      email address
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-9486
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1896950
    expires: never
    data_sensitivity:
      - interaction
  email_confirmation_success:
    type: event
    description: |
      One-Time-Password to initiate the password reset process was successfully
      verified
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-9486
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1896950
    expires: never
    data_sensitivity:
      - interaction
  two_factor_success:
    type: event
    description: |
      User successfully verified their two factor authentication code before password reset
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-9994
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1896950
    expires: never
    data_sensitivity:
      - interaction
  recovery_code_success:
    type: event
    description: |
      User successfully verified their recovery code before password reset
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-9994
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1896950
    expires: never
    data_sensitivity:
      - interaction
reg:
  acc_created:
    type: event
    description: |
      Registration Submission Success
      Event that indicates registration was successful.
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
  acc_verified:
    type: event
    description: |
      Registration Email Confirmed
      Event that indicates a user successfully entered and submitted the email confirmation
      code from the confirmation email.
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
  complete:
    type: event
    description: |
      Confirmation of Registration Successful (BE)
      Event that indicates a new account was successfully registered.
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
  email_sent:
    type: event
    description: |
      Registration Email Sent
      Event that indicates a registration email was sent in order to get email confirmation.
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
  submit_error:
    type: event
    description: |
      Registration Submission Failure (Server)
      Event that indicates an attempt to submit a registration (clicking "Create
      account") was not successful. Ideally we would have additional data including
      reasons why the submission failed. We might expect most failed reasons to
      be "Incorrect password".
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-7265
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
    extra_keys:
      reason:
        description: additional context-dependent info, e.g. the cause of an error
        type: string
third_party_auth:
  google_login_complete:
    type: event
    description: |
      A user successfully logged in with Google OAuth and a Mozilla is also created if one
      was not already.
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-9815
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
    extra_keys:
      linking:
        description: |
          Indicates the initial linking of the Mozilla account and the third-party account.
        type: boolean
  apple_login_complete:
    type: event
    description: |
      A user successfully logged in with Apple OAuth and a Mozilla account is also created if one
      was not already.
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-9817
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
    extra_keys:
      linking:
        description: |
          Indicates the initial linking of the Mozilla account and the third-party account.
        type: boolean
  google_reg_complete:
    type: event
    description: |
      User completes registration with their Google account.
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-9816
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
  apple_reg_complete:
    type: event
    description: |
      User completes registration with their Apple account.
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-9818
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction
  set_password_complete:
    type: event
    description: |
      Password for third party user was successfully created
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-9988
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1844121
    expires: never
    data_sensitivity:
      - interaction

two_factor_auth:
  code_complete:
    type: event
    description: |
      User successfully submitted a backup authentication code to complete two factor auth setup.
    lifetime: ping
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-9587
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - interaction
  replace_code_complete:
    type: event
    description: |
      Event that indicates the user successfully replaced their two-step authentication codes
    lifetime: ping
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-11087
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - interaction

two_step_auth_phone_code:
  sent:
    type: event
    description: |
      6 digit code is successfully sent to the phone number provided
    lifetime: ping
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-10355
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - interaction
  send_error:
    type: event
    description: |
      Event that indicates that there was an error in sending the code to the phone
    lifetime: ping
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-10356
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - interaction
  complete:
    type: event
    description: |
      User successfully entered and submitted an authentication code
    lifetime: ping
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-10355
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - interaction

two_step_auth_remove:
  success:
    type: event
    description: |
      Event that indicates the user successfully remove two-step authentication
    lifetime: ping
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-10360
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - interaction

inactive_account_deletion:
  status_checked:
    type: event
    description: |
      The active status of an account was checked.
    lifetime: ping
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-10571
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - technical

  first_email_task_request:
    type: event
    description: |
      An attempt to insert the first-email task into the cloud task queue.
    lifetime: ping
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-10571
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - technical

  first_email_task_enqueued:
    type: event
    description: |
      The first-email task was successfully added to the cloud task queue.
    lifetime: ping
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-10571
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - technical

  first_email_task_rejected:
    type: event
    description: |
      The first-email task was not added the cloud task queue.
    lifetime: ping
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-10571
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - technical
    extra_keys:
      error_code:
        description: |
          The error code returned by the Cloud Tasks client.
        type: string

  first_email_skipped:
    type: event
    description: |
      The first email notification was skipped.
    lifetime: ping
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-10573
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - technical
    extra_keys:
      reason:
        description: |
          The reason the email was skipped.
        type: string

  second_email_task_request:
    type: event
    description: |
      An attempt to insert the second-email task into the cloud task queue.
    lifetime: ping
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-10573
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - technical

  second_email_task_enqueued:
    type: event
    description: |
      The second-email task was successfully added to the cloud task queue.
    lifetime: ping
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-10573
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - technical

  second_email_task_rejected:
    type: event
    description: |
      The second-email task was not added the cloud task queue.
    lifetime: ping
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-10573
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - technical
    extra_keys:
      error_code:
        description: |
          The error code returned by the Cloud Tasks client.
        type: string

  second_email_skipped:
    type: event
    description: |
      The second email notification was skipped.
    lifetime: ping
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-10574
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - technical
    extra_keys:
      reason:
        description: |
          The reason the email was skipped.
        type: string

  final_email_task_request:
    type: event
    description: |
      An attempt to insert the final-email task into the cloud task queue.
    lifetime: ping
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-10942
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - technical

  final_email_task_enqueued:
    type: event
    description: |
      The final-email task was successfully added to the cloud task queue.
    lifetime: ping
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-10942
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - technical

  final_email_task_rejected:
    type: event
    description: |
      The final-email task was not added the cloud task queue.
    lifetime: ping
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-10942
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - technical
    extra_keys:
      error_code:
        description: |
          The error code returned by the Cloud Tasks client.
        type: string

  final_email_skipped:
    type: event
    description: |
      The final email notification was skipped.
    lifetime: ping
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-10942
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - technical
    extra_keys:
      reason:
        description: |
          The reason the email was skipped.
        type: string
  deletion_scheduled:
    type: event
    description: |
      The cloud task to delete the account was scheduled.
    lifetime: ping
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-11071
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - technical

  deletion_skipped:
    type: event
    description: |
      The scheduled deletion of an inactive account was skipped.
    lifetime: ping
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-10999
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - technical
    extra_keys:
      reason:
        description: |
          The reason the deletion was skipped.
        type: string

two_step_auth_phone_remove:
  success:
    type: event
    description: |
      Event that indicates the user successfully remove their phone recovery option
    lifetime: ping
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-10358
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - interaction

email_delivery:
  success:
    type: event
    description: |
      Event that indicates the email was successfully delivered to the user.
    lifetime: ping
    send_in_pings:
      - events
    notification_emails:
      - vzare@mozilla.com
      - fxa-staff@mozilla.com
    bugs:
      - https://mozilla-hub.atlassian.net/browse/FXA-11197
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1830504
    expires: never
    data_sensitivity:
      - technical
    extra_keys:
      reason:
        description: |
          The email template that was delivered.
        type: string