Question 1

Walkthrough - Basic Structure & Terms

Accepted Answer

${youtube}Learn the basic structure of Workiom in 4 mins

Question 2

Workiom API Guide

Accepted Answer

You will learn how to authenticate, get list meta-data, and get and create records. It is meant as a limited general guide that will be improved and expanded with time. For more formal and comprehensive documentation.

Resources:

swagger spec available on: https://api.workiom.com/swagger/.
The API endpoint is available at https://api.workiom.com.

Authentication

All APIs in Workiom needs an API Key to pass it in the header. You can grab your API Key from User Settings

Then pass it through the header using the name "X-Api-Key"

Sample

curl -X GET "https://api.workiom.com/api/services/app/Apps/GetAll" -H "accept: text/plain" -H "X-Api-Key: {Your API Key}"

Get List Meta Data

Most actions you might want to take on a list will probably require getting the list’s meta-data first. The meta-data response will contain a lot of useful information like the list’s fields and views along with their IDs.

GET /api/services/app/Lists/Get
Content-Type "application/json"
HeadersAuthorization Bearer \*your-access-token\*
Parameters
id: string
expand: array[string] (any combination of: “Fields”, “Views”, “Filters”)

Response

``` { "appId": "string", "fields": [ { "name": "string", "description": "string", "dataType": 0, "sum

Question 3

Field & Data Types

Accepted Answer

Fields are properties of a List’s Records, the Name of a Product or the Phone-Number of a Contact, or the Date of an Appointment.

You can add, remove or edit the fields on a list by clicking on 'Field' menu. The first 4 fields you see there are the System Fields; Creator, Creation Date, Last Modifier, Last Modified Date. These are hidden by default, If you think they would be useful in your use case, make them visible by clicking on the switch button.

The rest of them are the custom fields in your list. You can make the fields visible or hidden for the current view, add a new field from the end of the list, edit or delete fields by clicking on 3 dots next to them.

You can add a new field either from the 'Field' menu or directly from the table if you are on a table view.

Workiom supports many Field Types, like Text, Numbers, Dates, File Attachments, and much more! But don’t worry, you can learn more about them later. Workiom supports the following Field Types:

Text:

The Text Field is the most basic and versatile of Field Types. It can accept any text input.

Usage Examples:Contact Name, Contact, Job Title, Delivery, Address, Product Description
Special Options:

Multi-Line: This options turns one-line Text Field inputs in

Question 4

Workiom Webhooks

Accepted Answer

Webhooks are one way that apps can send automated messages or information to other services. It's how Workiom tells your accounting app when your invoice is ready, how you can send a notification on Slack when a feedback record is added through forms.

How to use Webhooks?

There are some APIs in Workiom to use them for webhooks.

Resources:

The API endpoint is available at https://api.workiom.com.
A full example about how Can you Integrate Workiom API with Pabbly Workflow,
Event Type:

Set: eventType: 0; (When Record created)eventType: 1; (When Record Updated)

Workiom APIs:

1. Create Subscription

curl -X POST "https://api.workiom.com/api/services/app/WebhookSubscription/AddSubscription" -H "accept: text/plain" -H "Content-Type: application/json-patch+json" -H -H "X-API-KEY={UP6tlj+kHsBCgkUcK/2xd1dB7NACAf64UU1WNsn7niYTjILq29+7/7h5rrAl1zyNGoO3uI1O8MeibOThuy5gk8gmMIVd308n1UhVQXWlGLg=}" -d "{ "appId":"{You can find it from your tenant url}", "listId":"{You can find it from your tenant url}", "name":"{Give a name }", "isActive":true, "webHook":"{The URL that will be triggered}", "eventType":0, "id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}"

2. Get All Subscriptions

/api/services/app/WebhookSubscription/GetAllSubscriptions

Sample

``` curl -X GET "https://api.workiom.com/api/services/app/WebhookSubscripti

Question 5

Different ways to use Workiom

Accepted Answer

Workiom offers a flexible workspace that can be customised according to the needs of various teams and companies. There are 6 main functions of Workiom:

Unified Workspace: Get your teams, processes, and data to unite. Manage it all in one connected workspace! No more silos and isolated data.
Data Organisation: Arrange your data they way you need, create new structures, new viewing options. Workiom is part spreadsheet and part relational database, all with advanced viewing and filtering options.
Task and Project Management: Task management is an integral part of every workflow you have and Workiom allows you to manage tasks connected to your data, projects, customers, processes, products, orders…
Automated Workflows: Save time and money, focus on meaningful work only, and delegate repetitive tasks to the machine. Create "If This Then That" conditions to create workflows, to link different processes or to create email/notification actions.
Team Collaboration: Bring everyone together, and streamline workflows towards collective success. Workiom helps orchestrate your team to a perfect tune. Make online collaboration joyful with features like advanced access permissions, smart notification system, activity log, commenting and mentioning..
Tracking and Reporting Performance: Create reports and dashboards based on your data. Always stay up-to-date with the current status and bring tra

Question 6

Automation

Accepted Answer

Getting Started with Automation

Q: Walkthrough - Basic Structure & Terms

<p>${youtube}<a href="NkrGUeIK63s">Learn the basic structure of Workiom in 4 mins</a></p>

Setting the rules has been never done easier and more elegant. The new section in your Workiom, the Automation design page, lets you play with cards to create a flow chart, your new rule. Simple and fun, like a board game.

To start a new automation task, just click on the Automation button as explained below:

The automation consists of:

a Trigger — it is the rule that causes the workflow process to start.
a Condition — it specifies an additional condition to trigger the workflow.
an Action (Task) — it is the actual task to be performed if the workflow is triggered and the condition is met.

Let's dig a bit into details.
Triggers. There are three types of them.

Record Created — triggers the automation when a record is created in a list.
Value Changed — works when a specific field in a record gets changed.
Time Trigger — sets action when a record's time value is reached (like an approaching deadline).

Conditions. This card is optional. Use it when you need to specify any formula expression. That's where our easy-to-operate Workiom's formula language comes in handy.

This

Frequently Read Articles

Browse All Categories