Glossary

App

An app refers to an application, service, or system integrated with or used on the Quickwork platform. It can perform trigger events or steps, or multiple logical operations to achieve its intended purpose. Visit the app directory page on the Quickwork website for a list of third-party apps supported for integration.

Access profile

As a client, you may have one or more access profiles assigned to you. An access profile has a unique API key that determines the usage of the API endpoint. There can be one or more access profiles for a single client, and they can access one or more API collections through the access profile.

Action

Action is a set of user-defined steps that perform a task in response to a trigger event. Each app has several actions that you can use. For example, if your journey is "Whenever a new task is created in your JIRA account, send its details via email using your Gmail account" then, "send its details via email" is the action.

API collections

An API collection is a set of endpoints that can be managed together. It has a specific path that is defined while creating an endpoint. The API collection path appends to the path prefix, for example, https://apim.quickwork.co/path_prefix/api_collection_path/v1. This structure organizes endpoints under a common path, simplifying management and access.

API endpoint

An API endpoint is the path to the action within the resource for which you want to create an API. It is the journey that you want to call upon hitting the endpoint. The API endpoint appends to the path prefix, for example, https://apim.quickwork.co/path_prefix/api_collection_path/v1/api_endpoint. This structure enables precise targeting and activation of specific functionalities within the API.

API endpoint host

The API endpoint host is the base path to which multiple endpoints are appended. The API endpoint host is https://apim.quickwork.co/. It is static in nature and pre-created by Quickwork. For a custom domain tailored to specific needs as an API endpoint host, you can reach out to the Quickwork support team.

API management

API management enables you to create collections and endpoints for APIs. These collections and endpoints facilitate the execution of callable journeys in the backend with a single click.

Audit logs

Audit logs provide a detailed record of activities within your Quickwork account, capturing interactions with journeys, folders, connections, and team activities. These logs include timestamps for each event, offering insights into the productivity and usage patterns of your resources. They are a valuable tool for monitoring and reviewing account activities to ensure compliance and operational integrity.

Business logic

Business logic is a feature that adds precision to a journey by adding filters between triggers and actions or between different actions. This ensures that the journey proceeds only when certain specified criteria are met, resulting in a more targeted and effective outcome. Quickwork currently supports five Business logic types-If Condition , Foreach Loop, If Else Condition, Stop Journey, and Try-catch.

Callable journey

A callable journey is a type of journey that is specifically designed to be triggered externally via an API call. Unlike standard journeys that might be triggered by events within apps or scheduled timings, callable journeys allow external systems to initiate workflows by sending a request to a predefined API endpoint. This makes them particularly useful for integrating workflows into custom applications or automating processes in response to events outside Quickwork.

Client

A client is a user for whom you want to create an API endpoint. The client offers an API key using which the API endpoint can be executed. A single client can have access to one or more API collections.

Connection

A connection links the Quickwork platform and the third-party app used in the journey. Creating a connection involves granting Quickwork permission to access information from third-party apps used in a journey, after which it performs the defined task on your behalf. For example, to use the Gmail app, you must log in to your Gmail account and allow Quickwork to access the necessary Gmail scopes with read/write permissions. Some apps require access tokens or API keys to establish a connection. Quickwork provides easy steps for each app in the connection window to help users connect their apps efficiently.

Connector

When creating a workflow or journey using apps, you can use a connector to interact with data, events, and resources across different apps, services, and systems without the need to code. In a connector or also called app, each operation can act as either a trigger that initiates a journey or an action that performs a particular task. While many connectors have both triggers and actions, some connectors offer only triggers, while others provide only actions.

The various operations related to Google Tasks through a connector include both triggers and actions that can be utilized within a journey:

Triggers

• Task completed: Activates when a specific task is marked as completed in Google Tasks.
• New task: Triggers when a new task is added to Google Tasks.

Actions

• List tasklist: Retrieves a complete list of all task lists available in Google Tasks.
• Find task: Searches for a specific task within Google Tasks.
• Update task: Allows for modifications to an existing task in Google Tasks.
• Delete task: Removes a specific task from Google Tasks.

Constants

Constants are customizable, user-defined parameters accessible across all journeys. They are structured as JSON-like name-value pairs, simplifying the process by eliminating repetitive manual inputs.

Content templates

Content templates offer a user-friendly approach to constructing semantic templates that integrate seamlessly with Logic-less Mustache templates. By creating a template, you can easily leverage content templates within your journeys, treating them as any other action.

Customized transaction table

The customized transaction table feature allows you to tailor how journey transactions are presented, focusing on key details for quick access. You can customise the transactions table in the form of key-value pairs, selecting up to five specific records from any trigger or action within the journey. Each record's input/output can be represented as a column paired with a value of your choice, displayed prominently on the History tab. This enhances visibility and efficiency by providing immediate access to critical transaction details.

Data pills

Data pills are elements of the app data tree representing each application’s output. They facilitate data transfer from one app to another in a journey.

Data tree output

Data tree output compiles all the output data pills from the configured trigger and actions. This includes identifiers, version numbers, date and time stamps, snippets, and other essential information. Data pills vary with each configured app and are intended for use as inputs in subsequent actions.

Databases by Quickwork

Databases by Quickwork is an in-house app that store custom data within rows and columns organized in collections. These collections serve as cross-reference tables, enabling frequent data lookups within a journey.

Data masking

Data masking is a security feature designed to protect confidential information within a journey. It allows you to hide sensitive input/output data at the action steps, ensuring that details such as IDs, SSNs, passwords, and email addresses are not stored or displayed in the transaction report or execution history. This feature is particularly useful when sensitive data trails need to be shielded from Quickwork administrators executing the journey.

Dashboard

The Dashboard is a centralized interface to access comprehensive insights and reports about your activities. It includes an analytics section with journey utilization reports, and audit logs which can be tailored to display information for a custom date range. You can monitor performance, review actions, analyze the efficiency of your workflows within specified periods, and get a detailed and customizable overview of system usage and interactions.

Folders

Folders are virtual locations for organizing multiple user-created journeys. Each folder can group related journeys under a unique name, and each journey's configuration details are saved within its respective folder.

Foreach

The Foreach loop in a workflow iterates over each element within a collection, such as records in a sheet or database, and performs specified actions for each entry. This loop ensures that every item in the dataset is processed, facilitating the bulk execution of tasks defined in a journey until all records are successfully parsed.

Input fields

Input fields form input elements within a trigger or action. They allow users to enter data in various formats, such as string, number, JSON, boolean, decimal, or date. Fields can be populated manually or dynamically using data pills.

History

The history feature provides a detailed view of the execution history of your journey, enabling you to track and review past activities and outcomes. This feature helps monitor the performance and effectiveness of automated workflows.

If condition

The If condition is a decision-making tool within workflows, allowing actions to proceed only when specified criteria are met. It evaluates the output from a trigger or preceding actions, ensuring that subsequent steps are executed only if the condition is satisfied. If the condition is not met, the actions within the If block are not executed. This feature can be used between trigger and actions or between different actions, depending on the workflow requirements.

Journey

A journey is an automated workflow consisting of logically connected steps designed to automate a task. For example, creating a new task in JIRA and sending its details via email using Gmail is a journey. Journeys can be simple or complex, depending on the use case and the apps involved.

Journey configuration manager

The journey configuration manage is the interface that facilitates the setup, adjustment, and execution of journeys. It allows users to define trigger, actions, and conditions, ensuring that each journey is tailored to meet specific automation needs and objectives efficiently.

Logger

The logger records the output of the trigger and actions during a journey's execution. This tool is essential for debugging because it provides visibility into the data flow between actions, allowing you to identify and address issues. It also enables backtracking to specific points in the journey, facilitating adjustments in inputs for improved results.

Path prefix

A path prefix is a user-defined unique identifier used to identify the account for which the API endpoint is to be created. It could be alphanumeric characters. The path prefix appends to the static API endpoint host, for example, https://apim.quickwork.co/path_prefix. This customization facilittes the identification and management of API endpoints specific to user accounts.

Scheduler by Quickwork

The Scheduler by Quickwork app functions as a customized timing mechanism, periodically checking for events at specified intervals -ranging from minutes to years - to trigger actions appropriately. This feature enables you to efficiently handle data arriving at specific times, acting like a tailored alarm system within the platform.

Step

Step refers to a segment within a journey that performs a specific function. Each step can be categorized as either a Simple Action or Business Logic depending on the complexity and the functionalities it involves.

Team

The team feature facilitates collaboration by allowing you to invite colleagues, partners, and customers to build journeys together and assign roles based on business needs.

Transaction

In Quickwork, an end-to-end journey is considered one transaction, regardless of its outcome or the number of steps involved. For example, fetching messages from Facebook Messenger and forwarding them to a Gmail account counts as one transaction. Transactional credits are allocated based on your plan.

Trigger

A trigger is an event or occurrence that initiates the execution of a journey. For example, if your journey is "Whenever a new task is created in your JIRA account, send its details via email using your Gmail account" then the first part, "Whenever a new task is created in your JIRA account," is the trigger. You can configure only one trigger for a journey.

Try-catch

The Try-catch functionality manages exceptions within automated workflows. It monitors for errors during the execution of actions in the Try block. If an error is detected, the Catch block is activated to handle the error, reporting it and halting further execution. This ensures that the journey can handle errors gracefully without disrupting the entire workflow.

Versions

Versions track the history of changes made to a journey, allowing you to view modifications and revert to specific versions if needed. Each time a change is made and successfully saved, a unique version ID is created, providing a reliable way to manage and backtrack changes without starting from scratch.

Workspace

A workspace is a collaborative environment where users can create, manage, and execute journeys. It provides a shared space for team members to collaborate on automation projects, streamline workflows, and share resources efficiently.