Workflow quickstart guide

The quickest way to see an end-to-end example is to follow this guide. It will help you set up your project and create your first workflow.

What you need

Link to this section

• A Kinde account with an application set up (sign up for free)
• A GitHub account to host your code (sign up for free)

Step 1: Create and clone the base template

Link to this section

1. Sign in to your GitHub account and navigate to the Kinde base workflow template
2. Select the green Use this template button, then select Create a new repository
3. Enter an easily identifiable name for your repository (e.g., “kinde-wf-base-template”)
4. Clone the repository to your local machine using your preferred method (e.g. Git CLI, GitHub Desktop, etc.)

The base template contains a basic workflow that writes Hello, world! to runtime logs when a user authenticates.

Step 2: Connect your Git repository

Link to this section

1. Sign in to your Kinde account and go to Settings > Git repo

2. Select Connect GitHub

3. Follow the instructions to connect your GitHub account to Kinde

4. Select the repository you just created, then select Next

5. Select the branch (e.g., “main”) and select Save

   Kinde will automatically sync the code and create a new workflow for you.

6. Go to Kinde home > Workflows to view your new workflow. You should see a new workflow called Workflow 1

   

7. Select the workflow to see the details and deployments

8. Select Runtime logs to view the logs for the workflow. This should currently be empty.

Step 3: Test your workflow

Link to this section

Assuming you have a Kinde application set up, you can test your workflow by signing in to your application. This will trigger the workflow and a new runtime log entry will be available to view.

1. Open Runtime logs for the workflow again (refresh the page if the list does not update).

2. Select the new log entry to see Hello world in the output (see sample below).

   Workflow sample output

   Post-authentication trigger fired
   Workflow found
   JavaScript execution started…
   Info Hello world
   🎉 Workflow completed in 0.7ms

You have successfully created your first Kinde workflow! You can now modify the workflow code to do whatever you like or add more workflows.

Next steps

Link to this section

• Explore the Kinde workflows documentation to learn more about how workflows work, the available triggers, and how to create more complex workflows.
• Dive into example workflows in the Kinde workflow examples GitHub repository.