API workflows

Using API workflows can be ideal and/or necessary in the following situations:

1. When you have long and complex workflows with a lot of actions

2. When you need to reuse the same workflow from different parts (pages/reusables) of the application

3. When you need to run a workflow on a list of things, e.i., loop through a list

4. When you need to schedule a workflow in the future (with the ability to cancel the workflow)

5. If you want your workflow to run asynchronously. API workflows run on the server side of the application, so any workflow on a standard Bubble page which schedules an API workflow won't need to wait for the entire (API) workflow to finish before moving on to the next step

6. If you want to create a webhook - or endpoint - into your Bubble application. This allows other applications to send and receive data from your Bubble app

For more information on API workflows, read AirDev's Bubble Development Guide and Bubble's Manual.

Our template comes with 15 API workflows:

• get_canvas_version - When you add [email protected] to your app as a collaborator, this API workflow will run to register your app with Canvas and save its template version ID.

• send_email - As noted in the quickstart guide, your app will not use Bubble’s native “send email” functionality, but instead use our own SendGrid API workflow that generates a nicely-formatted HTML email from the system. This API workflow is used throughout the app for all email workflows. As of April 6, 2020, this must be run with an email that is verified with Sendgrid due to updates to the SendGrid API.

• push - AirDev can "wrap" your Bubble web application into a native mobile using a service called GoNative. This workflow is used in the app to facilitate push notifications. This workflow creates a push token for the current user's account and device. It then links the push token to the user. This enables this user to receive push notifications to his current device.

• send_push_notifications - For wrapped Bubble apps, this workflow is used to send push notifications to a given user's device. Schedule this workflow anywhere you want to trigger a push notification.

Push notification example

• update_user_push_tokens - For wrapped Bubble apps, this workflow updates the user's push token.

• update_ios_badge - For wrapped Bubble apps, we use this workflow to update the user's iOS badge.

• update_usersnap - When you start a project with AirDev, we'll use this workflow to enable usersnap testing on your app so you can submit feedback in our client management portal.

• create_email_verification_request - This is API workflow is used when the App Owner has turned on email verification during sign up (where website object Email verification required? = yes). This workflow creates an email verification object that includes the User and Email fields. It is used in both the user sign up flow and when a user requests to change his email address from the account page.

• delete_email_verification - This API workflow is used to delete a user's email verification in the database. This workflow is used to delete the email verification 24 hours after its creation (to ensure that the email verification token expires after a day).

• send_verification_email - This API workflow is used to send an email verification link to the user. Users will need to click on the confirmation link in the email in order to verify their email. This workflow will only fire if the App Owner requires email verification during sign up.

• verify_email - This API workflow is used to verify a user's email and to update a user's email address (if they requested for an email change) on the verify page. Once a user's email is verified, this workflow will also mark that the user has completed the sign up process.

• The API Workflows for Email Templates are stored elsewhere.