Skip to main content

Retool Events reference

Reference documentation for Retool Events.

Version: Cloud and 3.178 Edge

Use Retool Events to build workflows that run whenever certain events occur within your organization. Event payloads contain properties with information related to the event. You can reference these within Retool Event-related workflows to perform actions or send notifications automatically.

Password reset required​

A user must reset their password.

requestingUserEmail​

string

The email address for the password reset request.

string

The password reset URL.

Report app errors​

An error occurred within an app.

Source Control deployment completed​

Source Control has completed a deployment.

deploymentType​

string

The type of deployment performed.

status​

string

The deployment status.

targetCommit​

string

The abbreviated commit hash that was deployed.

User created​

A user was created.

userEmail​

string

The email address for the newly created user.

User invited​

A user was invited to join the organization.

invitedUserEmail​

string

The email address for the invited user.

inviteId​

number

The invitation ID.

string

The invitation URL.

User requested access​

A user requested access to join the organization.

requestingUserEmail​

string

The email address for the request.

Login attempted​

A user attempted to log in. This event runs after a user has been authenticated, but before they complete the login process.

active​

boolean

Whether the user is active.

createdAt​

string

The timestamp for when the user was created.

email​

string

The email address of the user.

firstName​

string

The first name of the user.

id​

string

The ID of the user.

isAdmin​

boolean

Whether the user is an admin.

lastActive​

string

The timestamp for when the user was last active.

lastName​

string

The last name of the user.

metadata​

object

Metadata for the login attempted event.

userType​

enum

The type of user.

Values
default
mobile
embed