Custom

Trigger a custom event

This action triggers a custom event, which should be defined on the page already. These events are a way to share workflows/actions between the different workflows of the page.

Custom event

Select the custom event to trigger.

Workflow parameters

These are the parameters defined at the Custom Event level.

Trigger a custom event when data changes

This action watches a thing for changes to a specific field, and then triggers a custom event workflow when it changes. This is a way of performing actions in response to things that users do. The custom event runs at most once for each call of this action. If the user leaves or refreshes the current page before the thing changes, the custom event will not run.

Custom event

Select the custom event to trigger when the thing changes.

Parameter

This is the thing to watch for changes. It must be the same type as the parameter of the custom event that will be triggered, and the thing will be sent to the custom workflow. In other words, if the custom event expects a user, this field must be a user, and the custom workflow runs with that user when it changes.

Field

This is the field we are watching for changes. For example, if the workflow thing is the 'Current user,' and the field is the 'Name,' then if someone changes the 'Current user's name' from Bob to Barbara, the custom event is triggered.

Schedule a custom event

This action runs the selected custom workflow at a set time in the future. If the user changes the page before the workflow is scheduled to run, it will not happen. Unlike 'Trigger a custom event,' workflows run by this action run independently from and possibly in parallel with the workflow that initiated it.

Custom event

This is the event that is triggered.

Workflow parameters

These are the parameters defined at the Custom Event level.

Delay

Enter the time in seconds to wait before running the custom workflow. Fractional times are accepted.

Trigger a custom event from a reusable element

This action triggers a custom event that belongs to a reusable element. These events are a way to share workflows/actions between the different pages and reusable elements of the app. Defining them in a reusable element is a way to build a library of workflows.

Reusable element

Choose the reusable element to use in the custom workflow.

Custom event

Choose the custom event to trigger. Only custom events from the selected reusable element will appear.

Workflow parameters

These are the parameters defined at the Custom Event level.

Schedule API Workflow

This action allows you to schedule the run of an API workflow at a later time. Use this action to send an email to a user a week after signing up or a reminder a week before an event they created.

This action uses the Bubble API Workflow. You can choose from API workflows with manually defined parameters. Schedule an API workflow within another API workflow. To avoid infinite loops, it cannot refer to itself. In this case, the subsequent calls are ignored.

Note: This action is available to users with a paid Bubble plan. Activate the API in the API section in the Settings Tab.

API Workflow

Select the API workflow to run. These are the workflows defined in the Backend workflows page found in the Application Menu above the Palette. If the workflow takes parameters, they are displayed in the Property Editor.

Scheduled date

Define the date for the workflow execution. Use the expression Composer to define a dynamic date.

Ignore privacy rules when running the workflow

A scheduled workflow runs in the context of the current user when it is scheduled. All privacy rules apply to that user. To bypass these rules and run as an admin user who has all rights to the data, check this box.

Warning: Because these are security and privacy options, use this feature with caution.

Workflow parameters

These are the parameters defined at the API Workflow level.

Schedule API Workflow on a list

This action allows you to schedule the run of an API workflow at a later time, on a list of things. This is useful to iterate on a list of things. Each workflow runs on a single item in the list and each counts as one workflow run.

Note: This action is available to users with a paid Bubble plan. Activate the API in the API section in the Settings Tab.

Type of things

Select the type of things to iterate on.

List to run on

Define the list to iterate on. It can be the result of a search, an API call, etc. Note: the list is defined and evaluated at scheduling time. In other words, if a thing matches the search constraints when the scheduling happens and subsequently gets modified in a way that it doesn't anymore, the API workflow will still run on it.

API Workflow

Select the API workflow to run. These are the workflows defined in the Backend workflows page found in the Application Menu above the Palette. If the workflow takes parameters, they are displayed in the Property Editor.

Scheduled date

Define the date for the workflow execution. Use the expression Composer to define a dynamic date.

Interval (seconds)

When you run an API workflow on a list of things, there must be a delay between each workflow. Enter the number of seconds to be applied. If left blank, Bubble will calculate the best interval in order to keep the system healthy.

Note: Entering a number below 5 seconds is not recommended.

Ignore privacy rules when running the workflow

A scheduled workflow runs in the context of the current user when it is scheduled. All privacy rules apply to that user. To bypass these rules and run as an admin user who has all rights to the data, check this box.

Warning: Because these are security and privacy options, use this feature with caution.

Workflow parameters

These are the parameters defined at the API Workflow level.

Cancel a scheduled API Workflow

This action cancels a scheduled workflow. The workflow is identified by the number returned by the scheduling action.

Scheduled API ID

Enter the ID, which will most likely be an expression, that contains the ID of the scheduled workflow to cancel.

Cancel a list of scheduled API Workflows

This action cancels a list of scheduled workflows. The workflows are identified by the number returned by the scheduling action.

List of scheduled API IDs

Define the expression that will return the dynamic list of IDs, which should be a list of texts.

Set/cancel a recurring event

This action schedules or cancels a recurring workflow on a thing. This is useful if you want to run something daily, monthly, etc. Only one recurring event can be used per database thing. A frequency of None cancels a recurring event.

Recurring event

Select the event to run periodically or cancel. These events should be defined in the API Workflow page found in the Application Menu above the Palette.

Workflow thing

Each recurring workflow should have a thing attached to it. This thing should be of the same type as the recurring event.

Frequency

Select the frequency to apply to the recurring workflow. Choose from None, Weekly, Monthly, Quarterly, and Yearly. A frequency of None cancels a recurring event.

Note: A Bubble Personal plan is required for monthly events. A Professional or Production plan is required for Daily events.

Start date

Select the date to start the recurring event. When running this action on a thing that has already been scheduled, the start date has to be after the original next run date. If not, it will be pushed back by another period.