Trigger workflows with Retool Events
Learn how to build a workflow that uses Retool Events to send a notification when certain events occur within your organization.
You must be an admin to configure Retool Events. Access to the workflows triggered by Retool Events is determined by existing workflow permissions.
With Retool Events, organization admins can build workflows that run automatically in response to certain events in Retool. When an event is triggered, any associated workflows with pre-defined parameters are triggered.
You can even configure branding options to replace Retool's built-in email notifications with workflows that send custom transactional emails from your domain. When doing so, you should set up appropriate alerts as error handlers in your workflows.
Configure Retool Event workflows
Navigate to the Retool Events settings in your organization. From here, you can browse available events and add workflows that trigger in response to them.
| Event | Description |
|---|---|
| Password Reset Required | Triggered when a user requests their password reset. |
| User Invited | Triggered whenever a user is invited to your organization. |
| User Created | Triggered whenever a new user is added to your organization. Does not trigger on user invites or access requests, until the user accepts and/or is approved to join the organization. |
| User Requested Access | Triggered whenever a user requests access to your organization. |
| Source Control Deployment Completed | Triggered whenever a source control deployment is completed. |
Click Add a workflow to select or create a workflow that runs whenever the respective event is triggered. If you add a new workflow, Retool creates one uses a starter template for common use cases related to the event.
Reference event properties
Retool Event-triggered workflows display the related event in the Enabled triggers of the Start block. These triggers are only available when you add workflows from the Retool Events settings page.
Data for the event is made available from the Start block. You can reference this anywhere in the workflow using {{ startTrigger.data }}. This contains different properties depending on the event type.
Refer to the Retool Events reference to learn about the available properties for each event type.
Configure workflow actions
Many Retool lifecycle events are related to organization and user administration, so workflows triggered from Retool Events often involve sending emails. The User Invited template is pre-populated with a Resource query block using Retool Email, but you can configure this to use SendGrid or another email provider.
The sendUserInvite block of the User Invited Template sends an email to the user invited to Retool, using the invitedUserEmail parameter as the To address. The email's body also contains links to the inviteLink parameter. When you construct your email blocks and templates, ensure you use the provided parameters to direct your users to the correct actions.
Configure error handlers for failed events
To ensure workflows run as expected, you can configure error handlers. This enables you to perform additional actions, such as receive a notification, if an error occurs and the workflow could not complete successfully.