Module: Castle::Events

Defined in:

lib/castle/events.rb

Overview

list of events based on docs.castle.io/api_reference/#list-of-recognized-events

Constant Summary

LOGIN_SUCCEEDED =

Record when a user successfully logs in.

'$login.succeeded'

LOGIN_FAILED =

Record when a user failed to log in.

'$login.failed'

LOGOUT_SUCCEEDED =

Record when a user logs out.

'$logout.succeeded'

PROFILE_UPDATE_SUCCEEDED =

Record when a user updated their profile (including password, email, phone, etc).

'$profile_update.succeeded'

PROFILE_UPDATE_FAILED =

Record errors when updating profile.

'$profile_update.failed'

REGISTRATION_SUCCEEDED =

Capture account creation, both when a user signs up as well as when created manually by an administrator.

'$registration.succeeded'

REGISTRATION_FAILED =

Record when an account failed to be created.

'$registration.failed'

PASSWORD_RESET_SUCCEEDED =

The user completed all of the steps in the password reset process and the password was successfully reset.Password resets do not required knowledge of the current password.

'$password_reset.succeeded'

PASSWORD_RESET_FAILED =

Use to record when a user failed to reset their password.

'$password_reset.failed'

PASSWORD_RESET_REQUEST_SUCCCEEDED =

The user successfully requested a password reset.

'$password_reset_request.succeeded'

PASSWORD_RESET_REQUEST_FAILED =

The user failed to request a password reset.

'$password_reset_request.failed'

INCIDENT_MITIGATED =

User account has been reset.

'$incident.mitigated'

REVIEW_ESCALATED =

User confirmed malicious activity.

'$review.escalated'

REVIEW_RESOLVED =

User confirmed safe activity.

'$review.resolved'

CHALLENGE_REQUESTED =

Record when a user is prompted with additional verification, such as two-factor authentication or a captcha.

'$challenge.requested'

CHALLENGE_SUCCEEDED =

Record when additional verification was successful.

'$challenge.succeeded'

CHALLENGE_FAILED =

Record when additional verification failed.

'$challenge.failed'

TRANSACTION_ATTEMPTED =

Record when a user attempts an in-app transaction, such as a purchase or withdrawal.

'$transaction.attempted'

SESSION_EXTENDED =

Record when a user session is extended, or use any time you want to re-authenticate a user mid-session.

'$session.extended'