Q: Walkthrough - Basic Structure & Terms

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

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

Product Roadmap

Accepted Answer

Click here to check out the product roadmap

May, 2020

Checklist data type
Mention in comments

April, 2020

Inline editing for data grid
Reports

February, 2020

Lookup Data type
Auto-number data type

January, 2020

Automation
Advance Permissions

December, 2019

Mass Update
Unique feature on Field

November, 2019

New Record Layout
Currency Data Type
New Datatypes: (Email, Website, Phone Number)

October, 2019

Calendar View

September, 2019

Cascaded List
Notification on Assigned To, Due Date

August, 2019

New Theme for Workiom
Support Linked List with External App
Support Zapier integration

July, 2019

Templates & Categories
New Data Grid view

June, 2019

Import from CSV file

May, 2019

Public Form View

April, 2019

Supporting On-premise database
Developed Mobile App

March, 2019

Clone App

February, 2019

[Computed Field](https://help.workiom.com/en/articles/3532928-computed-fie

Question 5

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 6

Integrations with Zapier

Accepted Answer

Follow the link below to integrate Workiom with other cloud apps on Zapier:

https://zapier.com/developer/public-invite/6124/6ba81397a6a38e9ea79cf1d8125f637c/

Frequently Read Articles

Browse All Categories