Retool Events reference
Reference documentation for Retool Events.
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.
Learn more about setting up Retool Events.
Password reset required
A user must reset their password.
requestingUserEmail
The email address.
| Type | string |
| Format | Email Address |
| Configurability | Read-only |
| Default | null |
Examples
falsejenny@example.com
Source Control deployment completed
Source Control has completed a deployment.
deploymentType
The type of deployment performed.
| Type | string | ||||||
| Format | Plain Text | ||||||
| Configurability | Read-only | ||||||
| Allowed Values |
| ||||||
| Default | null |
status
The deployment status.
| Type | string | ||||||||||
| Format | Plain Text | ||||||||||
| Configurability | Read-only | ||||||||||
| Allowed Values |
| ||||||||||
| Default | null |
targetCommit
The full commit hash that was deployed.
| Type | string |
| Format | UUID |
| Configurability | Read-only |
| Default | null |
Examples
false"a1b2c3d4e5f67890123456789abcdef123456789"
User created
A user was created.
Examples
falsejenny@example.com
User invited
A user was invited to join the organization.
invitingUserEmail
The email address.
| Type | string |
| Format | Email Address |
| Configurability | Read-only |
| Default | null |
Examples
falsejenny@example.com
User requested access
A user requested access to join the organization.
requestingUserEmail
The email address.
| Type | string |
| Format | Email Address |
| Configurability | Read-only |
| Default | null |
Examples
falsejenny@example.com
Login attempted
A user attempted to log in. This event runs after a user has been authenticated, but before they complete the login process.
Examples
falsetrue
createdAt
The timestamp for when the user was created.
| Type | string |
| Format | Date and Time |
| Configurability | Read-only |
| Default | null |
Examples
false"2023-10-01T12:00:00Z"
Examples
falsejenny@example.com
Examples
false"Jenny"
Examples
false"user_366e154sdfg34b9bdeds32936"
falsebutton1
lastActive
The timestamp for when the user was last active.
| Type | string |
| Format | Date and Time |
| Configurability | Read-only |
| Default | null |
Examples
false"2023-10-01T12:00:00Z"
Examples
false"Appleseed"
userType
The type of user.
| Type | string | ||||||||
| Format | Plain Text | ||||||||
| Configurability | Read-only | ||||||||
| Allowed Values |
| ||||||||
| Default | null |