mirror of
https://github.com/ToolJet/ToolJet
synced 2026-04-21 13:37:28 +00:00
[docs]: Add Self Hosted Tag in Workflows (#13692)
This commit is contained in:
Pratik Agrawal
GitHub
parent
e4228489b7
commit
8a7dc03e8a
34 changed files with 300 additions and 41 deletions
|
|
@ -3,6 +3,14 @@ id: logs
|
|||
title: Logs
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Once you execute the workflow by clicking on the **Run** button, the logs panel will reflect the execution details of each node. Logs let you easily track the order of execution and check whether the execution of individual nodes is successful. You can click on the top bar of the logs panel to expand or minimize it.
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: nodes
|
|||
title: Types of Nodes
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Nodes are a graphical representation of each process in a workflow. Each node in the workflow passes over the result to the next node. Every new workflow will have two nodes - **Start Trigger** and **Result**. The **Start Trigger** node triggers the workflow to run. Once the workflow execution is completed, the resulting data is stored in the **Result** node type.
|
||||
|
||||
Apart from the default **Start Trigger** and **Result** nodes, there are an array of nodes that you can add to the canvas. They can be broadly divided into four types - **JavaScript**, **If condition**, **Data sources** and **REST API**. Let's take a closer look at each node.
|
||||
|
|
|
|||
|
|
@ -3,17 +3,13 @@ id: overview
|
|||
title: Overview
|
||||
---
|
||||
|
||||
<div className="badge badge--primary heading-badge">
|
||||
<img
|
||||
src="/img/badge-icons/premium.svg"
|
||||
alt="Icon"
|
||||
width="16"
|
||||
height="16"
|
||||
/>
|
||||
<span>Paid feature</span>
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
</div>
|
||||
|
||||
ToolJet Workflows is a visual, node-based platform tailored for data-centric automation tasks. With its intuitive design, users can create detailed queries across diverse data sources, manage conditional flows, and execute custom JavaScript code while making the processes presentable and easy to manage.
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: permissions
|
|||
title: Permissions
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Permissions in **ToolJet Workflows** provide a structured approach to access control, ensuring precise management of who can view, edit, or execute workflows. The below table gives a detailed summary of permissions in context of ToolJet Workflows.
|
||||
|
||||
| User Group | Workflows Dashboard Access | Create/Edit Workflows | Execute Workflows | Using Workflows in ToolJet App Builder | Enable/Disable Workflows |
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: results
|
|||
title: Configuring Results
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Users have the flexibility to customize the results returned by workflows. The **Result** node enables configuration of your output through JavaScript code.
|
||||
|
||||
## Return Data from a Single Node
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: workflow-triggers
|
|||
title: Triggers
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Triggers can be used to execute a workflow. Currently, ToolJet supports two types of triggers: [Webhooks](#webhooks) and [Manual](#manual).
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: logs
|
|||
title: Logs
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Once you execute the workflow by clicking on the **Run** button, the logs panel will reflect the execution details of each node. Logs let you easily track the order of execution and check whether the execution of individual nodes is successful. You can click on the top bar of the logs panel to expand or minimize it.
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: nodes
|
|||
title: Types of Nodes
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Nodes are graphical representations of each process in a workflow. Each node can access the data from the nodes that were executed earlier. Every workflow contains key node types that help orchestrate the flow of data and logic.
|
||||
|
||||
## Start Trigger Node
|
||||
|
|
|
|||
|
|
@ -3,9 +3,13 @@ id: overview
|
|||
title: Overview
|
||||
---
|
||||
|
||||
<div className='badge badge--primary heading-badge' style={{marginBottom:'10px'}}>Available on: Paid plans</div>
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<br/>
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
## Introduction
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: permissions
|
|||
title: Permissions
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Permissions in **ToolJet Workflows** provide a structured approach to access control, ensuring precise management of who can view, edit, or execute workflows. The below table gives a detailed summary of permissions in context of ToolJet Workflows.
|
||||
|
||||
| User Group | Workflows Dashboard Access | Create/Edit Workflows | Execute Workflows | Using Workflows in Tooljet App Builder | Enable/Disable Workflows |
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: results
|
|||
title: Configuring Response
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Users have the flexibility to customize the response returned by workflows. The **Response** node enables configuration of your output through JavaScript code. Each workflow can have multiple response nodes.
|
||||
|
||||
## Return Data from a Single Node
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: trigger-workflow-from-app
|
|||
title: Trigger Workflows Within ToolJet
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
This guide will show you how to set up a workflow and trigger it from a ToolJet application.
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: trigger-using-webhook
|
|||
title: Trigger Workflows Using Webhooks
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
This guide demonstrates how to trigger workflows using webhooks.
|
||||
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: workflow-triggers
|
|||
title: Triggers
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Triggers can be used to execute a workflow. Currently, ToolJet supports two types of triggers: [Webhooks](#webhooks) and [Manual](#manual).
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,36 @@
|
|||
---
|
||||
id: import-export
|
||||
title: Import or Export Workflows
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
ToolJet supports exporting workflows as JSON files and importing them into any ToolJet workspace.
|
||||
|
||||
## Exporting Workflows
|
||||
|
||||
To export a workflow from your ToolJet workspace:
|
||||
1. Navigate to the **Workflows** tab from the dashboard.
|
||||
2. Click on the kebab menu (three vertical dots) at the top-right corner of the workflow you want to export.
|
||||
3. Select **Export Workflow** from the menu. A `.json` file containing the workflow configuration will be downloaded to your system.
|
||||
<img style={{marginTop:'15px'}} className="screenshot-full img-full" src="/img/workflows/import-export/export.png" alt="Navigate to Workflow Section" />
|
||||
|
||||
This file can later be imported into any ToolJet workspace to replicate the same workflow setup.
|
||||
|
||||
## Importing Workflows
|
||||
|
||||
To import a workflow from your ToolJet workspace:
|
||||
1. Navigate to the **Workflows** tab from the dashboard.
|
||||
2. Click on the kebab menu (three vertical dots) next to the **Create new workflow** button and select **Import from device**.
|
||||
<img style={{marginTop:'15px'}} className="screenshot-full img-full" src="/img/workflows/import-export/import.png" alt="Navigate to Workflow Section" />
|
||||
3. Choose the `.json` file of the workflow you want to import from your local system.
|
||||
4. Click **Import workflow** button to complete the import process.
|
||||
<img style={{marginTop:'15px'}} className="screenshot-full img-s" src="/img/workflows/import-export/import-modal.png" alt="Navigate to Workflow Section" />
|
||||
|
||||
Once imported, the workflow will appear in your workspace and can be edited or triggered like any other workflow.
|
||||
|
|
@ -3,6 +3,16 @@ id: trigger-workflow-from-app
|
|||
title: Trigger Workflows Within ToolJet
|
||||
---
|
||||
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
This guide will show you how to set up a workflow and trigger it from a ToolJet application.
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: trigger-workflow-using-scheduler
|
|||
title: Trigger Workflows Using Scheduler
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
ToolJet allows workflows to be triggered automatically at regular intervals or at specific scheduled times. Users can also specify the timezone to ensure that schedules align with local time.
|
||||
|
||||
## Running Workflow at Schedule Intervals
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: trigger-using-webhook
|
|||
title: Trigger Workflows Using Webhooks
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
This guide demonstrates how to trigger workflows using webhooks.
|
||||
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: logs
|
|||
title: Logs
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Once you execute the workflow by clicking on the **Run** button, the logs panel will reflect the execution details of each node. Logs let you easily track the order of execution and check whether the execution of individual nodes is successful. You can click on the top bar of the logs panel to expand or minimize it.
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: nodes
|
|||
title: Types of Nodes
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Nodes are graphical representations of each process in a workflow. Each node can access the data from the nodes that were executed earlier. Every workflow contains key node types that help orchestrate the flow of data and logic.
|
||||
|
||||
## Start Trigger Node
|
||||
|
|
|
|||
|
|
@ -3,17 +3,13 @@ id: overview
|
|||
title: Overview
|
||||
---
|
||||
|
||||
<div className="badge badge--primary heading-badge">
|
||||
<img
|
||||
src="/img/badge-icons/premium.svg"
|
||||
alt="Icon"
|
||||
width="16"
|
||||
height="16"
|
||||
/>
|
||||
<span>Paid feature</span>
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
</div>
|
||||
|
||||
ToolJet Workflows enable users to create complex, data-centric automations using a visual, node-based interface. It extends ToolJet's capabilities beyond building user interfaces, allowing developers and business users to automate processes, integrate data from various sources, and execute custom logic without writing extensive code.
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: permissions
|
|||
title: Permissions
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Permissions in **ToolJet Workflows** provide a structured approach to access control, ensuring precise management of who can view, edit, or execute workflows. The below table gives a detailed summary of permissions in context of ToolJet Workflows.
|
||||
|
||||
| Permission | Admins | Builders | End Users | Custom Groups |
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: results
|
|||
title: Configuring Response
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Users have the flexibility to customize the response returned by workflows. The **Response** node enables configuration of your output through JavaScript code. Each workflow can have multiple response nodes.
|
||||
|
||||
## Return Data from a Single Node
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: workflow-triggers
|
|||
title: Triggers
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Triggers can be used to execute a workflow. Currently, ToolJet supports three types of triggers: webhooks, scheduled triggers, and manual triggers.
|
||||
|
||||
<img className="screenshot-full img-full" src="/img/workflows/triggers/triggers.png" alt="Triggers" />
|
||||
|
|
@ -12,21 +20,22 @@ Triggers can be used to execute a workflow. Currently, ToolJet supports three ty
|
|||
A webhook trigger allows you to run the workflow when a webhook is received. You can configure the webhook trigger from the Triggers tab. The webhook URL is unique for each workflow.
|
||||
|
||||
#### Creating a Webhook Trigger
|
||||
|
||||
- Click on the **Triggers** option in the left panel to open the Triggers tab.
|
||||
<img className="screenshot-full img-full img-full" src="/img/workflows/triggers/triggerbutton.png" alt="Triggers" />
|
||||
<img className="screenshot-full img-full" style={{ marginTop: '15px' }} src="/img/workflows/triggers/triggerbutton.png" alt="Triggers" />
|
||||
- Click on the **Webhooks** option.
|
||||
<img className="screenshot-full img-full" src="/img/workflows/triggers/webhooks.png" alt="Triggers" />
|
||||
<img className="screenshot-full img-full" style={{ marginTop: '15px' }} src="/img/workflows/triggers/webhooks.png" alt="Triggers" />
|
||||
- By default, the webhook trigger is disabled. Toggle the switch to **enable** the webhook trigger.
|
||||
<img className="screenshot-full img-full" src="/img/workflows/triggers/enable.png" alt="Triggers" />
|
||||
<img className="screenshot-full img-full" style={{ marginTop: '15px' }} src="/img/workflows/triggers/enable.png" alt="Triggers" />
|
||||
- Once enabled, you can choose the **Environment** to modify the webhook endpoint URL to be copied for that specific environment. For example, if you choose the **Production** environment, you can `Copy URL` or `Copy as cURL` which can then be used to trigger for **Production** environment accordingly.
|
||||
<img className="screenshot-full img-full" src="/img/workflows/triggers/env.png" alt="Triggers" />
|
||||
<img className="screenshot-full img-full" style={{ marginTop: '15px' }} src="/img/workflows/triggers/env.png" alt="Triggers" />
|
||||
- Find the API endpoint URL in the **Endpoint** field. You can use this URL to send a POST request to trigger the workflow. You can also click on the **Copy** button to copy the URL to the clipboard. You can either select `Copy URL` or `Copy as cURL` from the dropdown menu. The `Copy as cURL` option copies the URL as a cURL command which will include details such as the `API token` and `Environment`. An example of the Endpoint URL is as follows:
|
||||
```
|
||||
http://{TOOLJET_HOST}/api/v2/webhooks/workflows/:id/trigger
|
||||
```
|
||||
<img className="screenshot-full img-full" src="/img/workflows/triggers/copy.png" alt="Triggers" />
|
||||
<img className="screenshot-full img-full" style={{ marginTop: '15px' }} src="/img/workflows/triggers/copy.png" alt="Triggers" />
|
||||
- The API token is used to authenticate the request. You can find the API token in the **API Token** field. You can also click on the **Copy** button to copy the API token to the clipboard.
|
||||
<img className="screenshot-full img-full" src="/img/workflows/triggers/token.png" alt="Triggers" />
|
||||
<img className="screenshot-full img-full" style={{ marginTop: '15px' }} src="/img/workflows/triggers/token.png" alt="Triggers" />
|
||||
:::info
|
||||
Currently, authentication is mandatory for webhooks. Use a bearer token in the `Authorization` header for authentication. <br/>
|
||||
**Format:**
|
||||
|
|
@ -39,7 +48,7 @@ A webhook trigger allows you to run the workflow when a webhook is received. You
|
|||
"name": "string",
|
||||
"age": "number"
|
||||
```
|
||||
<img className="screenshot-full img-full" src="/img/workflows/triggers/params.png" alt="Triggers" />
|
||||
<img className="screenshot-full img-full" style={{ marginTop: '15px' }} src="/img/workflows/triggers/params.png" alt="Triggers" />
|
||||
- The **Test JSON parameters** field can be used to test the webhook trigger. You can enter the parameter values in the **Test JSON parameters** field and click on the **Run** button to test the webhook trigger. The workflow will be executed with the parameter values specified in the **Test JSON parameters** field.
|
||||
```json
|
||||
{
|
||||
|
|
@ -47,8 +56,12 @@ A webhook trigger allows you to run the workflow when a webhook is received. You
|
|||
"age": 30
|
||||
}
|
||||
```
|
||||
These parameters can be accessed in the workflow using the `startTrigger.params`.
|
||||
<img className="screenshot-full img-full" src="/img/workflows/triggers/test.png" alt="Triggers" />
|
||||
|
||||
### Accessing Webhook Parameters
|
||||
|
||||
These parameters can be accessed in the workflow using the `startTrigger.params.<parameter-name>`.
|
||||
|
||||
<img className="screenshot-full img-full" src="/img/workflows/triggers/test.png" alt="Triggers" />
|
||||
|
||||
### Async Workflow Query Execution
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: import-export
|
|||
title: Import or Export Workflows
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
ToolJet supports exporting workflows as JSON files and importing them into any ToolJet workspace.
|
||||
|
||||
## Exporting Workflows
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: trigger-workflow-from-app
|
|||
title: Trigger Workflows Within ToolJet
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
This guide will show you how to set up a workflow and trigger it from a ToolJet application.
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: trigger-using-webhook
|
|||
title: Trigger Workflows Using Webhooks
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
This guide demonstrates how to trigger workflows using webhooks.
|
||||
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: logs
|
|||
title: Logs
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Once you execute the workflow by clicking on the **Run** button, the logs panel will reflect the execution details of each node. Logs let you easily track the order of execution and check whether the execution of individual nodes is successful. You can click on the top bar of the logs panel to expand or minimize it.
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: nodes
|
|||
title: Types of Nodes
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Nodes are graphical representations of each process in a workflow. Each node can access the data from the nodes that were executed earlier. Every workflow contains key node types that help orchestrate the flow of data and logic.
|
||||
|
||||
## Start Trigger Node
|
||||
|
|
|
|||
|
|
@ -4,15 +4,6 @@ title: Overview
|
|||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
<div className="badge badge--primary heading-badge">
|
||||
<img
|
||||
src="/img/badge-icons/premium.svg"
|
||||
alt="Icon"
|
||||
width="16"
|
||||
height="16"
|
||||
/>
|
||||
<span>Paid feature</span>
|
||||
</div>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: permissions
|
|||
title: Permissions
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Permissions in **ToolJet Workflows** provide a structured approach to access control, ensuring precise management of who can view, edit, or execute workflows. The below table gives a detailed summary of permissions in context of ToolJet Workflows.
|
||||
|
||||
| User Group | Workflows Dashboard Access | Create/Edit Workflows | Execute Workflows | Using Workflows in Tooljet App Builder | Enable/Disable Workflows |
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: results
|
|||
title: Configuring Response
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Users have the flexibility to customize the response returned by workflows. The **Response** node enables configuration of your output through JavaScript code. Each workflow can have multiple response nodes.
|
||||
|
||||
## Return Data from a Single Node
|
||||
|
|
|
|||
|
|
@ -3,6 +3,14 @@ id: workflow-triggers
|
|||
title: Triggers
|
||||
---
|
||||
|
||||
<div style={{display:'flex',justifyContent:"start",alignItems:"center",gap:"8px"}}>
|
||||
|
||||
<div className="badge badge--self-hosted heading-badge" >
|
||||
<span>Self Hosted</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Triggers can be used to execute a workflow. Currently, ToolJet supports three types of triggers: webhooks, scheduled triggers, and manual triggers.
|
||||
|
||||
<img className="screenshot-full img-full" src="/img/workflows/triggers/triggers.png" alt="Triggers" />
|
||||
|
|
@ -47,8 +55,12 @@ A webhook trigger allows you to run the workflow when a webhook is received. You
|
|||
"age": 30
|
||||
}
|
||||
```
|
||||
These parameters can be accessed in the workflow using the `startTrigger.params`.
|
||||
<img className="screenshot-full img-full" src="/img/workflows/triggers/test.png" alt="Triggers" />
|
||||
|
||||
### Accessing Webhook Parameters
|
||||
|
||||
These parameters can be accessed in the workflow using the `startTrigger.params.<parameter-name>`.
|
||||
|
||||
<img className="screenshot-full img-full" src="/img/workflows/triggers/test.png" alt="Triggers" />
|
||||
|
||||
### Async Workflow Query Execution
|
||||
|
||||
|
|
|
|||
|
|
@ -475,7 +475,8 @@
|
|||
"items": [
|
||||
"workflows/how-to/trigger-using-webhook",
|
||||
"workflows/how-to/trigger-workflow-from-app",
|
||||
"workflows/how-to/trigger-workflow-using-scheduler"
|
||||
"workflows/how-to/trigger-workflow-using-scheduler",
|
||||
"workflows/how-to/import-export"
|
||||
]
|
||||
}
|
||||
]
|
||||
|
|
|
|||
Loading…
Reference in a new issue