Learn about the platform and their possible use cases.

Introduction


## Flows
**Flows** is a platform that allows you to create and manage your own workflows.
This means you can create a series of tasks that need to be completed and assign them to different user groups.
These workflows can be as simple as a single categorization task or as complex as you need.

With **Flows**, you can develop a workflow easily, intuitively, and quickly.
This is thanks to an interface with a complete set of tools that will allow you to configure your workflow entirely visually.

<img src="/assets/images/pipeline-short-example.jpg" alt="Pipeline example" />

## Main features
- Create workflows
- Assign tasks to users
- Track the progress of tasks
- Implement automated processes
- Integrate with other services


Here you will find a brief introduction to the platform.


# Pipelines

**Pipelines** are the representation of a workflow composed of different nodes that help us define the logic or flow through which our process will pass. Each node represents a specific action, condition, or operation, allowing you to build complex workflows in an intuitive and modular fashion.

Typically, pipelines consist of a **start**, **intermediate steps**, and an **end**. However, it's important to note that this isn't strictly linear; a pipeline can have multiple triggers to initiate tasks and multiple possible endings based on the conditions and logic you define.

<img src="/assets/images/pipeline-short-example.jpg" alt="Pipeline example" />

*An illustration of a pipeline with multiple triggers and endpoints.*

## Key Characteristics of Pipelines

- **Multiple Triggers**: Pipelines can begin through various events, providing flexibility in how processes are initiated. Examples include:
  - **File Creation Trigger**: The pipeline starts when a new file is created in a specific location.
  - **Webhook Call Trigger**: Initiated by an external webhook call, allowing integration with other services and applications.

- **Intermediate Steps**: These are the actions, conditions, automations, and integrations that occur between the start and end of the pipeline. They shape the workflow and determine the path based on specific criteria.

- **Multiple Endings**: Pipelines can conclude in different ways depending on the workflow's outcome. Possible endings include:
  - **Quality Approved End**: The process ends with a task being approved after meeting certain quality standards.
  - **Quality Rejected End**: The task doesn't meet the required standards and is rejected, triggering alternative actions.
  - **File Storage End**: Concludes by storing a file in a designated repository or database.

## Examples of What Can Be Achieved with Pipelines

- **Automated Approval Processes**: Start the pipeline when a user submits a form. The data goes through validation steps, and if approved, it ends by sending a confirmation email and updating the database.

- **Content Management Workflows**: Begin with the creation of a draft article. The pipeline moves the article through editing and review stages, ending with publication on the website or rejection with feedback.

- **Data Processing Tasks**: Initiate when new data is received via an API webhook. Process the data through transformation steps and conclude by storing the processed data or triggering alerts if anomalies are detected.

---

By leveraging pipelines, you can design and implement complex workflows that mirror real-world business processes. The ability to have multiple triggers and endpoints allows for greater flexibility and efficiency, ensuring that your workflows are both robust and adaptable to various scenarios.


Here you will understand what a pipeline is and how it works.

What is a pipeline?


# Understanding Nodes in Pipelines

In the context of **Flows**, a **node** is a fundamental unit within a pipeline that performs a specific function in your workflow. Nodes are the building blocks of your pipeline, allowing you to define the logic and actions that guide your process from start to finish. By connecting different types of nodes, you can create complex workflows that automate tasks, make decisions, and integrate with various systems.

## Types of Nodes

### Triggers

**Triggers** are events that initiate a task when they are executed or activated. They are the starting points of your pipeline, waiting for a specific event or condition to occur before the workflow begins.

- **Example**: A trigger can activate the pipeline when a new file is created in a folder or when a webhook receives data from an external source.

<img src="/assets/images/triggers.jpg" alt="Trigger types" width={200} />

### Actions

**Actions** are tasks that you can perform during the lifecycle of a workflow. They define the operations that occur as the workflow progresses through the pipeline.

- **Example**: Sending an email notification, updating a database record, or transforming data from one format to another.

<img src="/assets/images/actions.jpg" alt="Action types" width={200} />

### Conditions

**Conditions** allow your workflow to make decisions based on evaluated criteria. They enable the pipeline to take different routes depending on specific conditions you set.

- **Example**: If a form submission meets certain criteria, the workflow proceeds to approval; otherwise, it routes back for more information.

<img src="/assets/images/conditions.jpg" alt="Condition types" width={200} />

### Automatic

**Automatic** nodes are tools that help you automate processes within your workflow. They reduce the need for manual intervention, increasing efficiency and consistency.

- **Example**: Automatically assigning tasks to team members based on their availability or scheduling regular data backups.

<img src="/assets/images/automatic.jpg" alt="Automatic types" width={200} />

### Integrations

**Integrations** enable your workflow to interact with external platforms and services. Through integrations, you can perform actions on other systems or retrieve data from them, extending the capabilities of your pipeline.

- **Example**: Fetching customer data from a CRM, posting updates to a Slack channel, or sending data to a third-party analytics tool.

<img src="/assets/images/integrations.jpg" alt="Integration types" width={200} />

### Pipeline

The **Pipeline** nodes include tools that manage the flow and structure of your workflow. They help you define endpoints or incorporate sub-workflows within your main pipeline.

- **End Node**: Defines a possible end of the workflow. You can have multiple end nodes to represent different outcomes of your process.

  - **Example**: Concluding the workflow when a task is completed successfully or when it fails due to errors.

- **Sub-Workflow Node**: Allows you to nest another pipeline within your current workflow. This promotes modularity and reusability of common processes.

  - **Example**: Embedding an approval process pipeline within a larger project management workflow.

<img src="/assets/images/pipeline.jpg" alt="Pipeline types" width={200} />

---

By understanding and utilizing these different types of nodes, you can design intricate and efficient workflows tailored to your specific needs. Nodes empower you to:

- Initiate processes through various triggers.
- Perform a wide range of actions automatically.
- Make dynamic decisions with conditions.
- Integrate seamlessly with other platforms and services.
- Structure your workflows effectively using pipeline controls.

This modular approach enables you to build workflows that are not only powerful but also adaptable to changing business requirements.

Here you will understand what a node is and how it works.

What is a node?


# Platform Sections

## Feed Section

The **Feed** is where you can interact with others on the platform and view their posts. Here, you can create informative posts or general messages to share with your organization.

<img src="/assets/images/feed.jpg" alt="Feed section" />

## Directory

In the **Directory** section, you can view a diagram of all the people in your organization, including the organizational hierarchy in various visualization formats. This allows you to easily access details of each user within the organization.

<img src="/assets/images/directory.jpg" alt="directory section" />

## Communities

The **Communities** section hosts groups within your organization that enable you to interact with people who share similar tasks or questions on various topics, whether related to platform usage or not. Here, you can create informative posts or general messages to engage with community members.

<img src="/assets/images/communities.jpg" alt="communities section" />

{/* ## Ideas Corner

The **Ideas Corner** is dedicated to receiving feedback about the platform or the processes carried out in the organization. Users can submit ideas that can be voted on by others, and these ideas may be considered for future improvements.

<img src="/assets/images/ideas-corner.jpg" alt="ideas corner section" /> */}

## Pipelines

In the **Pipelines** section, you can find all the pipelines that have been created within the organization. Here, you can view the status of pipelines, monitor their current tasks, and modify them if necessary to ensure optimal workflow.

<img src="/assets/images/pipelines-section.jpg" alt="pipelines section" />

## Organization Files

The **Organization Files** section allows you to access all the files that have been uploaded to the platform. Currently, files can be uploaded to our own buckets (GCP). The purpose of this section is to provide a centralized location where all organizational files can be easily found and managed.

<img src="/assets/images/organization-files.jpg" alt="organization files section" />

## My Queues

In the **My Queues** section, you can see all the tasks that have been assigned to you on the platform. Here, you can monitor the status of these tasks, prioritize your workload, and update progress as needed.

<img src="/assets/images/my-queues.jpg" alt="my queues section" />

## Entities

The **Entities** section displays all the entities that have been created within the organization. Here, you can view the status of entities, manage their current tasks, and modify them if necessary to reflect changes in your organization's structure or processes.

<img src="/assets/images/entities.jpg" alt="entities section" />

## Settings

In the **Settings** section, you can access all the platform configurations and your personal profile settings. Here, you can:

- Modify organizational settings to tailor the platform to your organization's needs.
- Update your personal profile information and preferences.
- Adjust notification settings and privacy options.

# Profile Settings

The **Profile** section allows you to view and manage your personal information and account settings. It is divided into several subsections to help you easily navigate and update your details.

<img src="/assets/images/profile-section.jpg" alt="profile section" />

## My Details

In the **My Details** subsection, you can view and modify your personal information, including:

- **Name**: Your full name as it appears on your account.
- **Manager**: The name of your direct supervisor or manager.
- **Pronouns**: Your preferred pronouns.
- **Position**: Your job title or role within the organization.
- **Biography**: A brief personal bio to share more about yourself.
- **Tags**: Keywords or skills associated with you.
- **Start Date**: The date you joined the organization.
- **LinkedIn**: A link to your LinkedIn profile.
- **Dietary Restrictions**: Any dietary needs you may have, useful for event planning.

## Authentication

The **Authentication** subsection allows you to view and modify your authentication settings and manage your current authentication providers. Here you can:

- **View Authentication Methods**: See the methods you use to log in, such as email/password or third-party providers.
- **Add Authentication Providers**: Connect additional authentication providers for easier access.
- **Remove Authentication Providers**: Disconnect authentication methods you no longer wish to use.

## Email

In the **Email** subsection, you can view and update your email address associated with your account. This is important for:

- **Account Notifications**: Ensuring you receive important updates and communications.
- **Password Recovery**: Providing a way to reset your password if needed.

## Password

The **Password** subsection allows you to view and change your account password. Regularly updating your password enhances account security. Here you can:

- **Change Password**: Update your current password to a new one.
- **Password Requirements**: View the guidelines for creating a strong password.

---

By keeping your profile information up to date, you ensure effective communication within the organization and maintain the security of your account.

# Organization Settings

In the **Organization Settings** section, you can access and configure all the settings related to your organization. This includes managing members, roles, awards, and other general settings to tailor the platform to your organization's needs.

<img src="/assets/images/organization-section.jpg" alt="organization section section" />

## General

The **General** subsection provides an overview of your organization's basic information. Here, you can:

- **View Organization Details**: See the organization's name, description, and other essential information.
- **Edit Information**: Update the organization's details to keep information current.
- **Set Preferences**: Configure general settings that affect how the platform operates for your organization.

## Members

In the **Members** subsection, you can view and manage all the users within your organization. Features include:

- **View Member List**: See all registered members of your organization.
- **Add Members Individually**: Invite new users by entering their email addresses and sending invitations.
- **Bulk Add Members**: Upload a CSV file to add multiple users at once, streamlining the onboarding process.
- **Manage Member Roles**: Assign or change roles and permissions for each member.
- **Remove Members**: Deactivate or remove users who no longer need access to the platform.

## Pending Invites

The **Pending Invites** subsection allows you to view and manage all pending invitations sent to prospective members. Here, you can:

- **View Invitation Status**: Check which invitations are still pending acceptance.
- **Resend Invitations**: Send reminders to invitees who haven't responded.
- **Cancel Invitations**: Withdraw invitations if they are no longer needed.

## Open Roles

In the **Open Roles** subsection, you can view and manage all the open positions within your organization. This section enables you to:

- **List Open Positions**: Display all current job openings or roles that need to be filled.
- **Create New Roles**: Add descriptions and requirements for new positions.
- **Manage Applications**: Track and manage applications from interested candidates (if applicable).

## Awards

The **Awards** subsection introduces a gamification system to motivate and recognize users for their contributions and performance on the platform. Here, you can:

- **View Available Awards**: See all the awards that users can earn.
- **Assign Awards**: Recognize users by awarding them for their achievements.
- **Manage Awards**: Edit or remove existing awards as needed.

## Create Awards

In the **Create Awards** subsection, you can create new awards to further encourage engagement and performance. When creating an award, you need to provide:

- **Title**: The name of the award.
- **Description**: A brief explanation of what the award represents.
- **Image**: An icon or image associated with the award to make it visually appealing.

Creating custom awards allows you to tailor the recognition system to align with your organization's values and objectives.

---

By utilizing the **Organization Settings** section, you can effectively manage your organization's presence on the platform, ensuring that user roles, permissions, and motivational systems like awards are properly configured to support your team's success.


---

By familiarizing yourself with these sections, you can effectively navigate the platform, collaborate with team members, and optimize your workflow within your organization.



Here you will find information on the different sections of the platform.

Platform sections


# **Benchmarks in Queues**

Benchmarks represent a critical feature that ensures specific criteria are met before taskers can claim tasks from queues. These packets act as checkpoints, validations, or quality gates in a queue’s workflow.

This guide explains how benchmarks are created, edited, and utilized in the **Special Packets Dashboard** and their interaction with queue nodes.

---

## Overview of Benchmarks

**Benchmarks** are specialized packets that:
- Help verify tasker readiness before allowing them to claim tasks.
- Can be configured with different types, probabilities, and timelines.
- Are directly associated with queue nodes and pipelines to provide targeted validation logic.

### Core Features:
1. **Flexible Configuration:** Benchmarks can be configured with attributes like `type`, `startDate`, `endDate`, and more.
2. **Dual Association:** Benchmarks are linked to both pipelines and queue nodes for double-referencing.
3. **Tasker Interruption:** `Blocker` benchmarks pause tasker progress until resolved.
4. **Probabilistic Assignment:** "Mixed" benchmarks can appear based on predefined probabilities (e.g., 10%, 50%, etc.).

---

## Creating Benchmarks

The **Special Packets Dashboard** allows you to easily create benchmarks. Follow these steps:

### Steps to Create a Benchmark
1. Click the **Create New Benchmark** button in the dashboard.
2. Fill in the form with the following key fields:
   - **Name**: A unique identifier for the benchmark.
   - **Description**: A brief explanation of the benchmark.
   - **Type**: Choose from `goFirst`, `mixed-10`, `mixed-25`, `mixed-50`, etc., which define how and when the benchmark appears to taskers.
   - **Start and End Dates**: Specify the timeline for the benchmark to be active.
   - **Blocker**: Enable this option if the benchmark must block taskers until completed.

<img src="/assets/images/create-benchmark-docu.jpg" alt="Create Benchmark Form" />

---

## Editing Benchmarks

### Steps to Edit a Benchmark
1. Locate the benchmark in the **Current Benchmarks** table.
2. Click the **Edit** button next to the benchmark.
3. Modify any of the fields in the form, such as the description, type, or timeline.
4. Save the changes. The updated benchmark will be immediately reflected in the queue node.

---

## Benchmarks in Queue Nodes

Once created, benchmarks are automatically associated with the current queue node and pipeline. They are referenced using:
- **Queue Node Reference (`queuesRef`)**: Ensures the benchmark applies only to the current node.
- **Pipeline Reference (`pipelinesRefs`)**: Allows benchmarks to be used across multiple queues within the same pipeline.

---

## Using Benchmarks in Queues

In the queue file, benchmarks are used to influence the task assignment process:

1. **Tasker Interruption:** If a tasker encounters a `blocker` benchmark, they must complete it before claiming any tasks.
2. **Benchmark Assignment Logic:** Benchmarks of type `goFirst` or `mixed` are dynamically assigned to taskers based on probability or pre-assigned user roles.
3. **Validation Workflow:** Benchmarks ensure quality and readiness checks are performed before taskers can progress in the queue.

### Example Usage
- **Blocker Benchmarks:** Taskers cannot bypass the benchmark until approved.
- **Mixed Benchmarks:** A tasker has a 50% chance of receiving a specific benchmark packet before claiming the next task.

---

## Key Notes
- Ensure that `startDate` and `endDate` are valid to avoid benchmarks being active outside the intended timeline.
- Use `blocker` benchmarks for mandatory tasks or quality checks.
- Benchmarks with `mixed` probabilities should be carefully configured to balance tasker workload.

By following this guide, you can effectively manage benchmarks within the Special Packets Dashboard and integrate them seamlessly into your queue workflows.


Learn how benchmarks are created, edited, and integrated with queue nodes to enhance tasker workflows.

Managing Benchmarks in Special Packets Dashboard

Learn Flows through our video tutorials and guides

Video Tutorials


# Video Tutorials

## Introduction videos

<ul style={{ listStyleType: 'none', padding: 0 }}>
  <li>
    <a
      target="_blank"
      rel="noopener noreferrer"
      href="https://www.youtube.com/watch?v=1wTn4k8sv_0"
      style={{ color: '#0066cc', textDecoration: 'none' }}
    >
      Intro to Flows: Build Powerful Workflows Visually
    </a>
  </li>
  <li>
    <a
      target="_blank"
      rel="noopener noreferrer"
      href="https://www.youtube.com/watch?v=hI9BVNH-8wQ"
      style={{ color: '#0066cc', textDecoration: 'none' }}
    >
      What is a Pipeline in Flows? Visual Workflow Guide
    </a>
  </li>
  <li>
    <a
      target="_blank"
      rel="noopener noreferrer"
      href="https://www.youtube.com/watch?v=OgxOtGLpP-U"
      style={{ color: '#0066cc', textDecoration: 'none' }}
    >
      What Are Nodes in Flows? Understand Triggers, Actions & More
    </a>
  </li>
</ul>

## Core Features

<ul style={{ listStyleType: 'none', padding: 0 }}>
    <li>
        <a target="_blank" rel="noopener noreferrer"
        href="https://www.youtube.com/watch?v=CzzIdiYiz-0"
        style={{ color: '#0066cc', textDecoration: 'none' }}>
        How to Create an Entity in Flows — Define Your App's Data Structure
        </a>
    </li>

    <li>
    <a target="_blank" rel="noopener noreferrer"
        href="https://www.youtube.com/watch?v=dTlA1_KwuLQ"
        style={{ color: '#0066cc', textDecoration: 'none' }}
    >
        How to Create a Pipeline in Flows — Step-by-Step Workflow Builder
    </a>
    </li>

</ul>

## Pipeline Nodes types

<ul style={{ listStyleType: 'none', padding: 0 }}>

    <li>
    <a target="_blank" rel="noopener noreferrer"
        href="https://www.youtube.com/watch?v=y_R2VnNh5mM"
        style={{ color: '#0066cc', textDecoration: 'none' }}
    >
        Trigger Nodes in Flows — Start Your Workflows the Right Way
    </a>
    </li>

    <li>
    <a target="_blank" rel="noopener noreferrer"
        href="https://www.youtube.com/watch?v=qDYmcbswPy4"
        style={{ color: '#0066cc', textDecoration: 'none' }}
    >
        Pipeline Nodes in Flows — Forks and Finish Made Simple
    </a>
    </li>

    <li>
    <a target="_blank" rel="noopener noreferrer"
            href="https://www.youtube.com/watch?v=9jH8IO9FkRA"
            style={{ color: '#0066cc', textDecoration: 'none' }}
        >
            Condition Nodes in Flows — Make Smart Decisions with If & Split
        </a>
    </li>

    <li>
        <a target="_blank" rel="noopener noreferrer"
            href="https://www.youtube.com/watch?v=9JfySZEnstw"
            style={{ color: '#0066cc', textDecoration: 'none' }}
        >
            Automatic Nodes in Flows — AI, Smart Data Without Lifting a Finger
        </a>
    </li>


    <li>
        <a target="_blank" rel="noopener noreferrer"
            href="https://www.youtube.com/watch?v=8oDgIzJRHck"
            style={{ color: '#0066cc', textDecoration: 'none' }}
        >
            Action Nodes in Flows — Manual Tasks, Entity Updates, and Webhooks
        </a>
    </li>

</ul>

## How to use Flows

<ul style={{ listStyleType: 'none', padding: 0 }}>
  <li>
    <a
      target="_blank"
      rel="noopener noreferrer"
      href="https://www.youtube.com/watch?v=TPUQTMIKt5k"
      style={{ color: '#0066cc', textDecoration: 'none' }}
    >
      How to Add Members to an Organization in Flows — Step-by-Step Guide
    </a>
  </li>
</ul>


This section contains video tutorials to help you master Flows.

Let's learn about the most important Flows concepts!

Guides


## How to Create a Pipeline

Creating a pipeline in **Flows** allows you to define and manage your workflow processes efficiently. Follow the steps below to create a new pipeline:

### 1. Navigate to the Pipelines Section

First, go to the **Pipelines** section, which you can find on the left-hand navigation bar of the application interface.

### 2. Create a New Pipeline

Once you're in the Pipelines section, click on the **"Create Pipeline"** button. A modal window will appear, prompting you to provide the following information:

- **Name**: Enter a descriptive name for your pipeline.
- **Description**: Add a brief description to explain the purpose of the pipeline.
- **Active Status**: Indicate whether the pipeline is active or not by toggling the status option.

After filling in these details, confirm to create your new pipeline.

### 3. View Your Created Pipelines

Back in the Pipelines section, you'll see a list of all your created pipelines, including the one you just added. This list allows you to manage and access your pipelines easily.

### 4. Begin Structuring Your Pipeline

To start building the structure of your new pipeline:

- Locate the pipeline you just created in the list.
- Click on the **"Go to Pipeline"** button associated with it.

This action will take you to a workspace with a blank canvas, where you can add and configure the various nodes that will make up your pipeline.

### 5. Add Nodes to Your Pipeline

To add a node to your pipeline:

- Click on the **"Add New Node"** button located at the top right corner of the screen.
- A list of available node types will appear. These nodes represent different functions and actions within your workflow (e.g., Triggers, Actions, Conditions, Automation, Integrations, Pipeline controls).
- Select the node type you wish to add. For each node, you'll need to fill in the required fields or settings specific to that node type.
- After completing the necessary information, add the node to your pipeline.

### 6. Start with a Trigger Node

Since this is a new pipeline, you'll want to begin with a **Trigger** node, which initiates the workflow. To do this:

- Select a **Trigger** node from the list.
- Fill in the required fields, such as specifying the event that will activate the pipeline.
- Add the Trigger node to your pipeline.

*Note: You can update or modify the node's settings at any time later if needed.*

### 7. Continue Building Your Pipeline

With the Trigger node in place, you can continue adding other nodes to define the workflow logic:

- **Actions**: Define tasks to be performed during the workflow.
- **Conditions**: Set up decision points that direct the workflow based on specific criteria.
- **Automation**: Incorporate tools to automate repetitive processes.
- **Integrations**: Connect with external platforms to perform actions or retrieve data.
- **Pipeline Controls**: Use tools to define possible endpoints or nest sub-workflows within your pipeline.

### 8. Save and Activate Your Pipeline

Once you've added all the necessary nodes and configured your pipeline:

- Review the workflow to ensure all nodes are connected correctly.
- Save your pipeline.
- Activate it if you're ready to deploy the workflow.

---

By following these steps, you've successfully created and configured a new pipeline in **Flows**. Your pipeline is now ready to execute tasks based on the defined triggers and workflow logic.

*Remember that you can always return to your pipeline to make adjustments or updates as your processes evolve.*



This guide will show you how to create a small and simple pipeline in the platform.

How to create an pipeline


# How to Create an Entity

An **entity** is a type of object that represents a concept or item in your application. For example, an entity can represent a user, a product, a task, and so on.  
Entities form the foundation of your application, allowing you to store and retrieve data from the database effectively.

Creating entities enables you to define the data structures essential for your application's functionality. Follow the steps below to create a new entity.

## Steps to Create a New Entity

### 1. Navigate to the Organization Section

- Go to the **"Entities config"** option located on the left-hand navigation bar of the application's interface.

### 2. Add a New Entity

- Click on the **"Add New"** button to begin creating a new entity.

### 3. Complete the Entity Creation Form

A form will open, which you need to complete to define your new entity.

The form includes the following fields:

#### Entity Details

- **Key**: **(Required)** 
  The unique identifier for the entity.

- **Collection Path**: **(Required)**
  The path identifier to access the entity's collection in the database. By default, the value is `{{entityPath}}`. 

- **Description**:  
  A brief description of the entity's purpose or role within the application.

- **Singular Name**:  **(Required)**
  The singular form of the entity's name (e.g., "User", "Product").

- **Plural Name**:  **(Required)**
  The plural form of the entity's name (e.g., "Users", "Products").

#### Fields Configuration

Define the fields that your entity will have. Each field should include:

- **Key**:  **(Required)**
  The unique identifier for the field.

- **Label**:  **(Required)**
  The display name of the field in the user interface.

- **Description**:  
  A description of the field's purpose.

- **Field Type**:  **(Required)**
  The type of data the field will hold (e.g., text, number, date).

- **Field Format**:  **(Required)**
  Depending on the field type, you can select different formats to specify how the data should be presented or validated.

Additionally, for each field, you can set the following flags to modify the behavior of the fields within the entity:

- **Editable By**:  
  Specify who can edit the field. Options include:
  - All Users
  - Member
  - Admin
  - Owner
  - Nobody

- **Required For**:  
  Determine who is required to provide a value for this field.
  - All Users
  - Member
  - Admin
  - Owner
  - Nobody

- **Visible For**:  
  Set who can view the field.
  - All Users
  - Member
  - Admin
  - Owner
  - Nobody

- **Archived**:  
  Indicates whether the field is archived.
  - True
  - False

### 5. Pages

- **Pages**:  
  This field allows you to select the pages where the entity will be displayed and specify its label name on those pages.

#### Page Configuration

Here you will be able to set the type of page that you want to use to interact with the entities creation. 

You can choose between:
- List (View to show a list with the entities created and the option to create a new one)
- Import (View to import entities from a CSV file)

#### Configuration keys

- **Key**: **(Required)**
  The unique identifier for the page.
- **Title**: **(Required)**
  The display name of the page in the user interface.
-  **Page Type**: **(Required)**
  The type of page that you want to use to interact with the entities creation (List or Import).
-  **Show in menu**: 
  If you want to show the page in left side menu. **(Checkbox)**
- **Icon**: 
  The icon that you want to use to represent the page in the left side menu. (icons from heroicons.com)

#### Import view
<img src="/assets/images/import-view.jpg" alt="Import page" />

#### List view
<img src="/assets/images/list-view.jpg" alt="List page" />


### 6. Review the Entity Information

At the end of the form, you will see a section titled **"Form RAW Response"**, displaying the entity's information in JSON format. This allows you to review the raw data structure before finalizing.

### 7. Save or Cancel the Entity Creation

- **Cancel**:  
  Click **"Cancel"** if you wish to abort the creation of the entity.

- **Save**:  
  Click **"Save"** to create the entity with the specified configurations.

---

By following these steps, you will successfully create a new entity in your application, defining its structure and behavior according to your requirements.

This guide will show you how to create an entity in the platform

How to create an entity


# How to Create an Organization

Organizations in the platform help structure and manage users and their access to specific resources. When a user creates an organization, they automatically become its owner, and a profile is created to manage the members within that organization. Users who are not part of an organization must create or join one to gain access.

## Steps to Create an Organization

### 1. Navigate to the Sidebar Menu

- Click on the current organization name to display a dropdown menu.
- Select the **"New Organization"** option.

### 2. Create the Organization

- **Enter Organization Details**:
  - Provide a name for the organization in the designated field.

- **Submit**:
  - Click the **"Create Organization"** button.  
    This action will:
    - Add the organization to the database.
    - Link the current user as a member of the organization.
    - Create a **user profile** collection within the organization to track its members.

### 3. Token Modification

- After creating the organization:
  - The user's authentication token will be updated to include the organization ID, marking them as the **owner**.

### 4. Complete the Onboarding Process

- A modal will appear with steps to configure the organization's profile and settings.
- Follow the instructions in the modal to finalize the setup.

<img src="/assets/images/create-new-organization-01.jpg" alt="Create organization step 1" />
<img src="/assets/images/create-new-organization-02.jpg" alt="Create organization step 2" />


This guide explains how to create an organization within the platform.

How to Create an Organization


# How to Add Members to an Organization

## Steps to Add Users to an Organization

### 1. Access the Organization Members Section

- Navigate to the **"Organization"** section in the sidebar menu.
- Select the **"Members"** option.
- This will display a list of all the members within the organization.

### 2. Invite Users

- Click the **"Invite User"** button.

#### Complete the Invitation Form

- **Email Address**:  
  Enter the email address of the user you want to invite.
- **Manager**:  
  Select the user who will manage the invited user.
- **Access Level**:  
  Choose the access level for the invited user.  
  The available options are:
  - **Admin**: Full access to all organization resources.
  - **Member**: Limited access to specific resources.
- **Full Name**:  
  Enter the full name of the user you are inviting.
- **Position** (optional):  
  Specify the user's role or position within the organization.  
  You can add a new position if needed.
- **Start Date**:  
  Select the date the user will join the organization.

  You can add as many new members as needed.

### 3. Send the Invitation

- Click **"Add Members"**.  
  An email will be sent to the user with a link to join the organization.  
  The invited user will appear in the **Pending Invitations** list until they accept the invitation.

### 4. User Joins the Organization

- Once the user accepts the invitation:
  - They will be added to the organization.
  - Their profile will be included in the organization's **user profile collection**.

<img src="/assets/images/add-members-to-organization-01.jpg" alt="Add new member step 1" />
<img src="/assets/images/invite-members-form.jpg" alt="Add new member form" />

### 5. Invite Members in Bulk (for the Same Position)

- Click the **"Bulk Add Members"** button.
- Upload a CSV file with the required fields to add multiple users at once.

#### Expected Fields in the CSV:
- **email**
- **displayName**
- **role**
- **startDate**

<img src="/assets/images/bulk-invite-members.jpg" alt="Bulk add members" />

---

## Notes

- Users can belong to multiple organizations, but their permissions are scoped to the specific organization they are interacting with.
- When a user signs up, they do not automatically gain access to any organization unless explicitly invited or if they create one.

This guide explains how to add users to an organization within the platform.

How to Add Members to an Organization


# How to Set Up and Use Webhooks

Webhooks allow you to send real-time data from the platform to external systems when specific events occur. They are essential for automation and seamless integration with other tools.

<img src="/assets/images/webhooks-integration-docu.jpg" alt="Webhooks Integration" width={500} />

## Steps to Configure Webhooks

### 1. Navigate to the Webhooks Configuration Section

- In the **Settings** section of the sidebar, locate and select the **"Integrations"** option.
- Open the **Webhook** settings tab.

### 2. Configure Entity Events

- In the Integrations settings, you need to add a new integration:

  - Select integration provider **"Flows API webhook"**.
  - Configure events for:

    - **Packet events**: Select the packet events you want to track.
    - **Pipeline events**: Choose the pipeline events you want to track.
    - **Users events**: Select the user events you want to track.
    - **Entity events**: Choose the entity events you want to track.
    - **Packet comments events**: Select events to track when comments are added, updated, or deleted on packets.
    - **Projects events**: Choose the project events you want to track.
    - **Pipeline labels events**: Select events for pipeline label changes.
    - **Packet labels events**: Choose events for packet label changes.

    _(The events available for tracking are `created`, `updated`, and `deleted`.)_

Check the relevant boxes to enable the events you want the webhook to track.

### 3. Set the Webhook Secret

- In the **Secret** field, enter a secure string. This secret will be used to authenticate webhook requests sent to your specified URL.
  - **Example**: `12345678`

### 4. Save the Configuration

- Once all settings are adjusted, click the **"Save"** button to activate the webhook.

---

## Testing Webhook Integration

### 1. View the Form RAW Response

- After configuration, the platform provides a **Form RAW Response** JSON preview to help validate the setup.
- The JSON will include details such as:
  - `softRemoved`: Indicates if the event item was soft deleted.
  - `status`: Current status of the item.
  - `integrationProvider`: Metadata about the integration provider, including the path and segments.

### 2. Expected Webhook Payload

When an event you have subscribed to occurs, the platform will send a POST request to your specified webhook URL. The payload will be in JSON format and will contain detailed information about the event. Below is an example of the expected webhook payload:

```json
{
  "eventTimestamp": "ISO8601 Timestamp",
  "operationType": "created | updated | deleted",
  "entityPath": "string",
  "entityId": "string",
  "entityKey": "string",
  "collectionPath": "string",
  "organizationId": "string",
  "data": {
    "value": {
      "key": "string",
      "properties": {
        // Key-value pairs representing the entity's properties
      },
      "createTime": "ISO8601 Timestamp",
      "updateTime": "ISO8601 Timestamp"
    },
    "oldValue": {
      "key": "string",
      "properties": {
        // Previous state of the entity's properties
      },
      "createTime": "ISO8601 Timestamp",
      "updateTime": "ISO8601 Timestamp"
    },
    "updateMask": [
      // List of fields that were changed during an update
    ]
  }
}
```

# Payload Field Descriptions with Expected Types

- **eventTimestamp** _(string)_: The timestamp when the event was triggered (ISO 8601 format).
- **operationType** _(string)_: The type of operation that occurred (`created`, `updated`, or `deleted`).
- **entityPath** _(string)_: The full path to the entity within the platform's data hierarchy.
- **entityId** _(string)_: The unique identifier of the entity.
- **entityKey** _(string)_: A key representing the category or type of the entity.
- **collectionPath** _(string)_: The path to the collection containing the entity.
- **organizationId** _(string)_: The ID of the organization.
- **data** _(object)_: An object containing details about the entity's state.
  - **value** _(object)_: The current state of the entity after the operation.
    - **key** _(string)_: The unique key of the entity.
    - **properties** _(object)_: Key-value pairs of the entity's properties and metadata.
    - **createTime** _(string)_: The timestamp when the entity was created (ISO 8601 format).
    - **updateTime** _(string)_: The timestamp when the entity was last updated (ISO 8601 format).
  - **oldValue** _(object, optional)_: The previous state of the entity before the operation (only available for `updated` and `deleted` events).
    - **key** _(string)_: The unique key of the entity.
    - **properties** _(object)_: Key-value pairs of the entity's previous properties.
    - **createTime** _(string)_: The timestamp when the entity was created (ISO 8601 format).
    - **updateTime** _(string)_: The timestamp when the entity was last updated (ISO 8601 format).
  - **updateMask** _(array of strings, optional)_: An array listing the fields that were changed during an update operation.

## Packet Comments Events Payload

When you subscribe to packet comments events, the webhook payload will include specific information about the comment operation. The `entityPath` will follow the pattern `pipelinesPackets/{packetId}/comments/{commentId}`, and the payload will include:

```json
{
  "eventTimestamp": "(string) The timestamp when the event was triggered",
  "entityId": "(string) The unique identifier of the comment",
  "entityKey": "(string) The type of entity, in this case 'flows/comments'",
  "entityPath": "(string) The full path to the comment in the data hierarchy",
  "collectionPath": "(string) The path to the comments collection",
  "organizationId": "(string) The ID of the organization",
  "operationType": "(string) The type of operation - 'created', 'updated', or 'deleted'",
  "entityComments": "(array) Array of related comments",
  "organizationId": "(string) The ID of the organization",
  "data": {
    "value": {
      "key": "(string) The unique key/path of the comment",
      "properties": {
        "replies": "(array) Array of reply comments",
        "content": "(string) The comment text content",
        "parentCommentRef": "(string|null) Reference to parent comment if this is a reply",
        "softRemoved": "(boolean) Whether comment is soft deleted",
        "createdBy": "(string) Reference to the user who created the comment",
        "createdAt": "(string) ISO timestamp of comment creation"
      },
      "createTime": "(string) ISO timestamp when record was created",
      "updateTime": "(string) ISO timestamp when record was last updated"
    },
    "oldValue": "(object|null) Previous state for updates/deletes",
    "updateMask": "(array|null) Fields changed in update"
  }
}
```

This allows you to track all comment-related activities on packets and integrate them with your external systems.


This guide explains how to configure and use webhooks for integrating external systems with the platform.

How to Set Up and Use Webhooks


# How to Create a CVAT Benchmark for Auto QA Evaluation

## Steps to Create a CVAT Benchmark

### 1. Prerequisites

- You must have a project utilizing CVAT.
- A dataset is required for evaluating the project.

### 2. Open the Benchmark Management Modal

- Navigate to the section where benchmarks are managed.
- Click the **"Create New Benchmark"** button.

<img src="/assets/images/create-new-benchmark.jpg" alt="Create new benchmark" />

### 3. Fill in the Benchmark Details

- Provide the following details:
  - **Name**: Enter the benchmark's name.
  - **Description**: Add a short description of the benchmark.
  - **Type of Benchmark**: Specify the benchmark type.
  - **Blocking Benchmark**: Indicate whether this benchmark blocks taskers.
  - **Start Date/End Date**: Include these dates if applicable.
  - **Enabled**: Specify whether the benchmark is enabled or not.

### 4. Configure Input/Metadata/Output Fields

For this type of benchmark, only the **Metadata** field needs to be completed. Include information about:
- Labels available for the task.
- The image to be annotated.

#### Example of Expected Metadata

```json
{ "cvatPayload": "{"payload":{"name":"CVAT task","labels":[{"name":"building","color":"#0000FF","type":"any","attributes":[]},{"name":"roof","color":"#FF0000","type":"any","attributes":[]},{"name":"property","color":"#00FF00","type":"any","attributes":[]}], "images":["https://valid/image/url"]}" }
```


- Ensure that the task data has been previously created with high quality in the same or a similar pipeline.
- The labels and annotations should emulate a realistic CVAT task.

### 5. Select the Evaluation Procedure

- Choose **"CVAT Evaluation"** from the available options.
- This will enable the **Ground Truth Data** field. 

<img src="/assets/images/evaluation-procedure-dropdown.jpg" alt="Evaluation procedure dropdown" />

### 6. Fill in Ground Truth Data

- Retrieve the **Ground Truth Data** from the task with excellent quality.
- Use the information from `output.taskResult.annotations`. This object contains all polygon information created in the CVAT tool.

### 7. Define Evaluation Rules

- Add one or more rules to evaluate the task. These rules help verify whether the polygons created in the task meet expectations.

#### Rule Configuration

- **Condition Fact**: Choose what to evaluate, such as:
  - User's output
  - Intersection over union
  - Total matches
  - Score distribution
- **Path**: Use a placeholder like `"$."` if no specific path is needed.
- **Operator**: Select from operators such as `>`, `<`, `=`, or `!=`.
- **Value**: Enter the expected value for the rule.

#### Example Rule

```
{ "conditionFact": "Average score", "path": "$.", "operator": ">", "value": 0.8 }
```


This rule specifies that the **average score** for the task must be greater than `0.8` for the task to be considered correct.

---

## Notes

- It is crucial to use a task with high-quality data as the basis for creating benchmarks.
- Benchmarks provide a structured method to evaluate task performance based on specific criteria.

---

This guide explains how to create a CVAT benchmark within the platform.

How to create a CVAT benchmark

Learn about the different nodes available in the platform.

Nodes


# Triggers

<img src="/assets/images/triggers-docu.jpg" alt="Trigger nodes" width={200} />


## Entity created

This node will trigger a workflow when a new entity is created in the platform.

**Fields:**

- **Label**: The name of the trigger as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Packet Name**: The name of the packet associated with this trigger.
- **Packet Description**: A detailed description of the packet's purpose and contents.
- **Entity Path**: The path to the entity that will be monitored for creation events.
- **Add Special Data Mapping**: An option to include additional data mappings specific to this trigger.

## Entity updated

This node will trigger a workflow when an existing entity is updated in the platform.
**Fields:**

- **Label**: The name of the trigger as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Packet Name**: The name of the packet associated with this trigger.
- **Packet Description**: A detailed description of the packet's purpose and contents.
- **Entity Path**: The path to the entity that will be monitored for creation events.
- **Add Special Data Mapping**: An option to include additional data mappings specific to this trigger.

## Entity deleted

This node will trigger a workflow when an existing entity is deleted in the platform.

**Fields:**

- **Label**: The name of the trigger as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Packet Name**: The name of the packet associated with this trigger.
- **Packet Description**: A detailed description of the packet's purpose and contents.
- **Entity Path**: The path to the entity that will be monitored for creation events.
- **Add Special Data Mapping**: An option to include additional data mappings specific to this trigger.

## Fork started

Triggered when another pipeline has started a fork on this pipeline

**Fields:**

- **Label**: The name of the trigger as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.

## Pipeline finished

Triggers an event when the selected pipeline has finished an execution

**Fields:**

- **Label**: The name of the trigger as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.

## New file created

Triggers an event when a new file is added to the organization bucket

- **Label**: The name of the trigger as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Packet Name**: The name of the packet associated with this trigger.
- **Packet Description**: A detailed description of the packet's purpose and contents.
- **Folder to monitor**: The folder path to monitor for new files.
- **Entity Path**: The path to the entity that will be monitored for creation events.

## Webhook received

Triggers an event when the provided WebHook receives a POST request with some data.

**Fields:**

- **Label**: The name of the trigger as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **WebHook URL**: The URL of the WebHook to monitor for POST requests.

## Manual Trigger

Triggers a custom event, creating a packet on the fly. Useful for testing pipelines

**Fields:**

- **Label**: The name of the trigger as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Packet Name**: The name of the packet associated with this trigger.
- **Packet Description**: A detailed description of the packet's purpose and contents.
- **Metadata**: Metadata to set on the testing packet.
- **Input**: Input data to set on the testing packet.

Here you will find all the available triggers in the platform.

Triggers


# Conditions

<img src="/assets/images/conditions-docu.jpg" alt="Condition nodes" width={200} />


## If / Else condition

Evaluates the input data in an if / else condition: If the condition is met, then the "valid" output is used. If not, the "invalid" output is used.

**Fields:**

- **Label**: The name of the condition as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Conditions**: The conditions to evaluate.  
    - **All**: All conditions must be met.
    - **Any**: At least one condition must be met.
    - **Not**: None of the conditions must be met.
        - **Add condition property**: Add a new condition to evaluate.
            - **Condition fact**: The fact to evaluate. (input/metadata/Entity params/reveiews)
            - **Path**: The path to the fact to evaluate.
            - **Operator**: The operator to use in the evaluation.
            - **Value**: The value to compare with the fact.

## Switch conditions

Evaluates different cases and outputs the one that meets the conditions. If none of the cases meet the conditions, then the default output is used.

**Fields:**

- **Label**: The name of the condition as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Outputs**: The different outputs to evaluate.
    - **Output id**: The output to use when the condition is met.
    - **Label**: The label of the output.
    - **Color**: The color of the output.
    - **Conditions**: The conditions to evaluate.  
        - **All**: All conditions must be met.
        - **Any**: At least one condition must be met.
        - **Not**: None of the conditions must be met.
            - **Add condition property**: Add a new condition to evaluate.
                - **Condition fact**: The fact to evaluate. (input/metadata/Entity params/reveiews)
                - **Path**: The path to the fact to evaluate.
                - **Operator**: The operator to use in the evaluation.
                - **Value**: The value to compare with the fact.

## Split

Based on a sampling %, some tasks go to one way or the other. If the percentages do not add 100, then an output with the rest will be added automatically

**Fields:**

- **Label**: The name of the condition as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Outputs**: The different outputs to evaluate.
    - **Output id**: The output to use when the condition is met.
    - **Label**: The label of the output.
    - **Color**: The color of the output.
    - **Percentage**: The percentage of tasks that will go to this output.


Here you will find all the available conditions in the platform.

Conditions


# Actions

<img src="/assets/images/actions-docu.jpg" alt="Action nodes" width={200} />


## Manual Action

Stops the pipeline and waits for a manual action to continue the action will be set in the queue configuration.

**Fields:**

- **Label**: The name of the action as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Add special data mapping**: An option to include additional data mappings specific to this trigger. You will be able to map the data from the (input/metadata/entity params) to the (output/metadata).

*You can design the type of manual tasks to be performed by adding queues to the node after its creation.*

## Update Entity

Updates an entity with the specified data.

**Fields:**

- **Label**: The name of the action as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Update entity in the packet**: Checkbox to update the entity in the packet.
- **Add special data mapping**: (Mandatory) An option to map data from (input/metadata/entity params) to an entity subpath.

## Send to Webhook

Sends the received data to a specified URL.

**Fields:**

- **Label**: The name of the action as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Webhook URL**: The URL to send the data.

Here you will find all the available actions in the platform.

Actions


# Actions

<img src="/assets/images/automatic-docu.jpg" alt="Automatic nodes" width={200} />


## Scrape a received URL

Talk with the scrape wizard to configure the scraping of the received URLs


**Fields:**

- **Label**: The name of the automatic action as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Integration**: A list of integrations to use for the scraping.
- **URL**: A URL to scrape the data from. Can use placeholders like `{{input.url}}`.
- **API Endpoint URL**: The URL to the API endpoint service to scrape the data from.
- **Navigation steps**: A list of steps to navigate through the page.
    - **Click**: Click on a selector.
    - **Go to URL**: Go to a URL.
    - **Wait for load state**: Wait for a load state.
    - **Take a screenshot**: Take a screenshot.
    - **Fill input**: Fill an input indicating the selector and the value.

## Remap data

Allows you to remap the data from the packet

**Fields:**

- **Label**: The name of the automatic action as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Add special data mapping**: An option to include additional data mappings specific to this trigger. You will be able to map the data from the (input/metadata/entity params) to the (output/metadata).

## Run custom code

Runs custom code with the packet data

**Fields:**

- **Label**: The name of the automatic action as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Code**: The code to run. You can use placeholders like `{{input.url}}`.
    - You will be able to return data to the packet using the `return` statement like `return { output: {}, metadata: {} }`.

## Classify with LLM

Classifies the input data using the LLM model and returns the result in the corresponding exit

**Fields:**

- **Label**: The name of the automatic action as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Handles names**: The names of the handles to use for the classification.
    - **Handler ID**: The ID of the handler.
    - **Is Connectable**: If the handler is connectable.
    - **Label**: The label of the handler.
    - **Color**: The color of the handler.

## Ask an LLM

Answers a prompt using LLM models. It can also return structured data if needed.

**Fields:**

- **Label**: The name of the automatic action as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Integration**: A list of integrations to use for the scraping.
- **LLM**: The LLM model to use for the classification.
- **Prompt**: The prompt to answer. Can use placeholders like `{{input.url}}`.

## Analyze file with LLM

Get an answer with LLMs based on a prompt and an image. It can also return structured data if needed.

**Fields:**

- **Label**: The name of the automatic action as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Integration**: A list of integrations to use.
- **LLM**: The LLM model to use for the classification.
- **File**: Path in the packet input or metadata. It can be a reference to a URL or to a fileReference.
- **Prompt**: The prompt to answer. Can use placeholders like `{{input.url}}`.

Here you will find all the available automatic nodes in the platform.

Automatic


# Integrations

<img src="/assets/images/integrations-docu.jpg" alt="Integrations nodes" width={200} />


## MercadoLibre

Different actions that you can perform with the MercadoLibre API. You can get the products, the orders, and more


**Fields:**

- **Label**: The name of the integration as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Integration**: A list of integrations to use.
- **Method**: The method to use in the API call.
    - **Users**
        - **Get authenticated user**
        - **Get user by ID**
        - **Get user brands**
        - **Get user items**
    - **Sites**
        - **Search items by category**
        - **Search items by SKU**
        - **Search items**
    - **items**
        - **Get items**

## Tiendanube

Different actions that you can perform with Tiendanube's API. You can get/set products, sales, and more

**Fields:**

- **Label**: The name of the integration as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Integration**: A list of integrations to use.
- **Method**: The method to use in the API call.
    - **Products**
        - **Get all products**
        - **Get product by ID**
        - **Create a product**
        - **Update a product**

## LinkedIn

Send data to a LinkedIn webhook

**Fields:**

- **Label**: The name of the integration as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Integration**: A list of integrations to use.
- **Method**: The method to use in the API call.
    - **Send WebHook**
    - **Get user profile**

## News API

Fetch news articles and more!

**Fields:**

- **Label**: The name of the integration as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Integration**: A list of integrations to use.
- **Method**: The method to use in the API call.
    - **Topic**
        - **Get topic by URI**
    - **Event**
        - **Get articles by event URI**

## Google Sheets

Integrate your use case with Google Sheets

**Fields:**

- **Label**: The name of the integration as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Integration**: A list of integrations to use.
- **Method**: The method to use in the API call.
    - **Add row**
- **Sheet configuration**
    - **Sheet ID**: The ID of the sheet to use.
    - **Sheet name**: The name of the sheet in the spreadsheet.
    - **Row data**: The data to add to the row. Will be split by commas.

## Slack

Send messages to Slack channels

**Fields:**

- **Label**: The name of the integration as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Integration**: A list of integrations to use.
- **Method**: The method to use in the API call.
    - **Send message**
- **Slack configuration**
    - **Channel ID**: The ID of the Slack channel to send the message to.
    - **Message**: The message to be sent to the Slack channel

## AWS S3

Automate your file operations in S3 buckets

**Fields:**

- **Label**: The name of the integration as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Integration**: A list of integrations to use.
- **Method**: The method to use in the API call.
    - **Upload to S3**
- **AWS S3 configuration**
    - **Bucket**: The name of the bucket to upload the file to.
    - **File key**: The key (path) where the file will be stored in the bucket.
    - **File content**: The content to be uploaded to S3.

## GCP Storage

Automate your file operations in GCP Storage

**Fields:**

- **Label**: The name of the integration as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Integration**: A list of integrations to use.
- **Method**: The method to use in the API call.
    - **Upload to storage**
- **GCP Storage configuration**
    - **Bucket**: The name of the bucket to upload the file to.
    - **File name**: The name (path) where the file will be stored in the bucket.
    - **File content**: The content to be uploaded to GCP Storage
    - **Content type**: The MIME type of the file (e.g., text/plain, image/jpeg)

## AutoScraper

Automatically scrape and screenshot websites

**Fields:**

- **Label**: The name of the integration as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Integration**: A list of integrations to use.
- **Method**: The method to use in the API call.
    - **Submit screenshot**
- **URL**: The URL of the website to scrape and screenshot. Can use placeholders like `{{input.url}}`.
- **API endpoint URL**: Here you need to set the URL of the API endpoint service to scrape the data from.

## HTTP Request

Send an HTTP request

**Fields:**

- **Label**: The name of the integration as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Method**:
    - **GET**
    - **POST**
-  **URL**: The URL to send the request to. Can use placeholders like `{{input.url}}`.
- **Payload**: The payload to send in the request. Can use placeholders like `{{input.payload}}`.
- **Headers**: The headers to send in the request. Can use placeholders like `{{input.headers}}`.

## Serpapi

Perform searches using Serpapi, including Google Images and related content.

**Fields:**

- **Label**: The name of the integration as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Integration**: A list of integrations to use.
- **Method**: The method to use in the API call.
    - **Google images**
    - **Google search**
- **Serpapi configuration**
    - **Search Query**: The search query to be sent to Serpapi.
    - **Image search page number**: The page number for image results pagination (0-based index). Each page contains 100 images. Increment this value to fetch additional batches of 100 images. For example, use 0 for the first 100 images, 1 for the next 100, and so on.
    - **Language**: The language of the search results. (eg: en)
    - **Country**: The country of the search results. (eg: us)
    - **Limit**: The number of results to return. (eg: 10)

Here you will find all the available integrations in the platform.

Integrations


# Pipeline

<img src="/assets/images/pipeline-docu.jpg" alt="Pipeline nodes" width={200} />


## Fork node

Generates forks based on the packet data and the configuration of the node. Once all the forks are completed, then the packet is submitted.

**Fields:**

- **Label**: The name of the integration as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.
- **Forks**: Add the different forks that you want to generate.
    - **Fork name**: The name of the fork.
    - **Pipeline**: The pipeline to execute.
        - **Add special data mapping**: An option to include additional data mappings specific to this trigger. You will be able to map the data from the (input/metadata/entity params) to the (output/metadata).

## Finish

This finished the pipeline execution.

**Fields:**

- **Label**: The name of the integration as it will appear in the workflow editor.
- **Description**: A brief explanation of what is intendeed to do.

Here you will find all the available pipeline nodes in the platform.

Pipeline

Learn how to manage your billing information and view your invoices.

Billing


## Billing information

Comming soon...


Here you will find information on how to manage your subscription.


# API v1 Documentation: Documents Router

This guide provides a comprehensive overview of the Documents Router in API v1, which allows for managing documents within the platform. The router supports standard CRUD operations and provides flexibility through subhandlers and middleware.

---

## Authentication Details

To obtain the API key, follow these steps:

1. Go to the **"Integrations"** tab in the platform.
2. Create a new integration of the provider `integrationsProvider/api`.
3. Upon creation, you will receive the token.
4. Tokens can also be deleted or regenerated through this interface.

Make sure to securely store the token. Include it in the `Authorization` header for all requests.

**Example Authorization Header:**

```
Authorization: Bearer <API_KEY>
```

---

## API Overview

### Base Endpoint

`https://api.flows.synergyshock.com/v1/documents/{{documentPath}}`

### Available HTTP Methods

<table style={{ borderCollapse: 'collapse', width: '100%', border: '1px solid #ccc' }}>
  <thead>
    <tr style={{ backgroundColor: '#f9f9f9' }}>
      <th style={{ border: '1px solid #ccc', padding: '8px', textAlign: 'left' }}>Method</th>
      <th style={{ border: '1px solid #ccc', padding: '8px', textAlign: 'left' }}>Purpose</th>
      <th style={{ border: '1px solid #ccc', padding: '8px', textAlign: 'left' }}>
        Authentication Required
      </th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td style={{ border: '1px solid #ccc', padding: '8px' }}>
        <code>GET</code>
      </td>
      <td style={{ border: '1px solid #ccc', padding: '8px' }}>Retrieve document data</td>
      <td style={{ border: '1px solid #ccc', padding: '8px' }}>Yes</td>
    </tr>
    <tr>
      <td style={{ border: '1px solid #ccc', padding: '8px' }}>
        <code>POST</code>
      </td>
      <td style={{ border: '1px solid #ccc', padding: '8px' }}>Create a new document</td>
      <td style={{ border: '1px solid #ccc', padding: '8px' }}>Yes</td>
    </tr>
    <tr>
      <td style={{ border: '1px solid #ccc', padding: '8px' }}>
        <code>PATCH</code>
      </td>
      <td style={{ border: '1px solid #ccc', padding: '8px' }}>Update an existing document</td>
      <td style={{ border: '1px solid #ccc', padding: '8px' }}>Yes</td>
    </tr>
    <tr>
      <td style={{ border: '1px solid #ccc', padding: '8px' }}>
        <code>DELETE</code>
      </td>
      <td style={{ border: '1px solid #ccc', padding: '8px' }}>Remove a document</td>
      <td style={{ border: '1px solid #ccc', padding: '8px' }}>Yes</td>
    </tr>
  </tbody>
</table>

---

## Parameter Details

The `{{documentPath}}` is the way to locate a document in our platform. Examples include:

- `/organizations/{{organizationId}}/pipelinesProjects/{{projectId}}`
- `/organizations/{{organizationId}}/pipelinesLabels/{{pipelineLabelId}}`
- `/organizations/{{organizationId}}/pipelinesPacketsLabels/{{pipelinePacketLabelId}}`

---

## Route Handlers

### GET Handler

Retrieves the specified document's data.

**Request Example**:

```http
GET /api/v1/documents/organizations/iDx5yLKl1cCcq0lqiBw4/pipelinesProjects/s6v6DWIITYnZqTpT2SSe
Authorization: Bearer <API_KEY>
```

**Response Example**:

```json
{
  "entityId": "s6v6DWIITYnZqTpT2SSe",
  "entityKey": "pipelinesProjects",
  "entityPath": "organizations/iDx5yLKl1cCcq0lqiBw4/pipelinesProjects/s6v6DWIITYnZqTpT2SSe",
  "collectionPath": "organizations/iDx5yLKl1cCcq0lqiBw4/pipelinesProjects",
  "organizationId": "iDx5yLKl1cCcq0lqiBw4",
  "data": {
    "name": "The Drone Project",
    "softRemoved": false,
    "createdBy": "cw9RmVGT0Laajp9IslVFdBrCmy43",
    "createdAt": {
      "_seconds": 1733516420,
      "_nanoseconds": 494000000
    }
  }
}
```

### POST Handler

Creates a new document in the specified path.

**Request Example**:

```http
POST /api/v1/documents/organizations/iDx5yLKl1cCcq0lqiBw4/pipelinesProjects
Authorization: Bearer <API_KEY>
Content-Type: application/json

{
  "name": "New project created 01",
  "color": "#FAFAFA",
  "description": "test description"
}
```

**Response Example**:

```json
{
  "entityId": "ad0RmVGFRD0aajp9IslVFdBrCmy43",
  "entityKey": "pipelinesProjects",
  "entityPath": "organizations/iDx5yLKl1cCcq0lqiBw4/pipelinesProjects/ad0RmVGFRD0aajp9IslVFdBrCmy43",
  "collectionPath": "organizations/iDx5yLKl1cCcq0lqiBw4/pipelinesProjects",
  "organizationId": "iDx5yLKl1cCcq0lqiBw4",
  "data": {
    "name": "New project created 01",
    "description": "test description",
    "color": "#FAFAFA",
    "createdAt": {
      "_seconds": 1733832890,
      "_nanoseconds": 631000000
    },
    "updatedAt": {
      "_seconds": 1733832890,
      "_nanoseconds": 631000000
    },
    "softRemoved": false
  }
}
```

### PATCH Handler

Updates an existing document.

**Request Example**:

```http
PATCH /api/v1/documents/organizations/iDx5yLKl1cCcq0lqiBw4/pipelinesProjects/s6v6DWIITYnZqTpT2SSe
Authorization: Bearer <API_KEY>
Content-Type: application/json

{
  "name": "Updated project name"
}
```

**Response Example**:

```json
{
  "entityId": "s6v6DWIITYnZqTpT2SSe",
  "entityKey": "pipelinesProjects",
  "entityPath": "organizations/iDx5yLKl1cCcq0lqiBw4/pipelinesProjects/s6v6DWIITYnZqTpT2SSe",
  "collectionPath": "organizations/iDx5yLKl1cCcq0lqiBw4/pipelinesProjects",
  "organizationId": "iDx5yLKl1cCcq0lqiBw4",
  "data": {
    "name": "Updated project name",
    "updatedAt": {
      "_seconds": 1733832990,
      "_nanoseconds": 644000000
    }
  }
}
```

### DELETE Handler

Deletes a document at the specified path.

**Request Example**:

```http
DELETE /api/v1/documents/organizations/iDx5yLKl1cCcq0lqiBw4/pipelinesProjects/1
Authorization: Bearer <API_KEY>
```

**Response Example**:

```json
{
  "success": true
}
```

---

## Error Handling

<table style={{ borderCollapse: 'collapse', width: '100%', border: '1px solid #ccc' }}>
  <thead>
    <tr style={{ backgroundColor: '#f9f9f9' }}>
      <th style={{ border: '1px solid #ccc', padding: '8px', textAlign: 'left' }}>Error Code</th>
      <th style={{ border: '1px solid #ccc', padding: '8px', textAlign: 'left' }}>Description</th>
      <th style={{ border: '1px solid #ccc', padding: '8px', textAlign: 'left' }}>
        Possible Cause
      </th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td style={{ border: '1px solid #ccc', padding: '8px' }}>
        <code>401</code>
      </td>
      <td style={{ border: '1px solid #ccc', padding: '8px' }}>Unauthorized</td>
      <td style={{ border: '1px solid #ccc', padding: '8px' }}>Missing or invalid API token</td>
    </tr>
    <tr>
      <td style={{ border: '1px solid #ccc', padding: '8px' }}>
        <code>403</code>
      </td>
      <td style={{ border: '1px solid #ccc', padding: '8px' }}>Forbidden</td>
      <td style={{ border: '1px solid #ccc', padding: '8px' }}>Access to resource is denied</td>
    </tr>
    <tr>
      <td style={{ border: '1px solid #ccc', padding: '8px' }}>
        <code>404</code>
      </td>
      <td style={{ border: '1px solid #ccc', padding: '8px' }}>Document Not Found</td>
      <td style={{ border: '1px solid #ccc', padding: '8px' }}>
        Specified document does not exist
      </td>
    </tr>
    <tr>
      <td style={{ border: '1px solid #ccc', padding: '8px' }}>
        <code>500</code>
      </td>
      <td style={{ border: '1px solid #ccc', padding: '8px' }}>Internal Server Error</td>
      <td style={{ border: '1px solid #ccc', padding: '8px' }}>
        Unexpected error during processing
      </td>
    </tr>
  </tbody>
</table>

---


A guide for using the Documents Router in API v1.

API v1 Documentation for Documents Router

"use strict";
const {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];
function _createMdxContent(props) {
  const _components = {
    a: "a",
    h2: "h2",
    p: "p",
    span: "span",
    ...props.components
  };
  return _jsxs(_Fragment, {
    children: [_jsxs(_components.h2, {
      id: "billing-information",
      children: [_jsx(_components.a, {
        "aria-hidden": "true",
        tabIndex: "-1",
        href: "#billing-information",
        children: _jsx(_components.span, {
          className: "icon icon-link"
        })
      }), "Billing information"]
    }), "\n", _jsx(_components.p, {
      children: "Comming soon..."
    })]
  });
}
function MDXContent(props = {}) {
  const {wrapper: MDXLayout} = props.components || ({});
  return MDXLayout ? _jsx(MDXLayout, {
    ...props,
    children: _jsx(_createMdxContent, {
      ...props
    })
  }) : _createMdxContent(props);
}
return {
  default: MDXContent
};


Introduction

Video Tutorials

Guides

Nodes

Billing

API

Billing

Here you will find information on how to manage your subscription.

Billing information

Table of Contents