Automation
- Yashna Chhatwal (Unlicensed)
- Mayur Karwa
Automation is used to create your own workflow. It consists of multiple nodes.
Field Name | Business Purpose | Field type (with size) | Is it a required field? | Is it editable? | Is it Unique? | Specific validations for some field type
| REFERENCE OF OTHER BUILDING BLOCK |
|---|---|---|---|---|---|---|---|
id | Unique identifier for this zap | Integer | Yes | No | Yes | No | No |
title | Title of the zap | String | No | Yes | No | No | No |
description | Description of working of this template | String | No | Yes | No | No | No |
appInstallationId | Unique identifier for the app installation | Integer | Yes | Yes | No | No | No |
workspaceSlug | Unique identifier for this workspace | String | Yes | No | Yes | No | No |
state | If this automation is on or off | Enum[off,on,draft] | No | Yes | No | No | No |
refCode | Unique identifier webhook automation | String | No | No | No | No | No |
nodes | Nodes associated with this zap | Array[Node] | Yes | Yes | No | No | Yes(Node) |
createdById | User id who created the automation | Integer | Yes | No | No | No | No |
updatedById | User id who updated automation | Integer | Yes | Yes | No | No | No |
createdAt | When the node was created | Timestamp | Yes | No | No | No | No |
updatedAt | When the node was last updated | Timestamp | Yes | Yes | No | No | No |
Type of Nodes:
Action
Trigger
Filter
Formatter
Filed Name | Business Purpose | Field type (with size) | Is it a required field? | Is it editable? | Is it Unique? | Specific validations for some field type | REFERENCE OF OTHER BUILDING BLOCK |
|---|---|---|---|---|---|---|---|
nodes[].id | Unique identifier for this node | Integer | Yes | No | Yes | No | No |
nodes[].versionCode | The app version the action is associated | Short-text | Yes | Yes | No | Follow a pattern: 0.0.0 to 999.999.999 | No |
nodes[].typeOf | Type of node | Enum[trigger, action, filter, formatter] | Yes | No | No | No | trigger: indicates this node is a trigger |
nodes[].resourceSlug | If ‘typeOf’ key is read, resourceSlug is the key of trigger api else its is the key of action api | short-text | Yes | Yes | No | No | No |
nodes[].parentId | Id of an immediate predecessor of this node | integer | No | Yes | No | No | No |
nodes[].rootId | Id from which the zap initiates | integer | No | No | No | No | No |
nodes[].authId | Id of auth account | integer | No | No | No | No | Yes[Auth accounts] |
auth_id is null for template, filter, and formatter node.
JSON Object:
{
"id": 77599812,
"account_id": 6366334,
"title": null,
"description": null,
"state": "off",
"paused": true,
"nodes": [
{
"id": 77599812,
"selected_api": "ShopifyAPI",
"action": "new_order",
"type_of": "read",
"parent_id": null,
"root_id": null,
"auth_id": null
},
{
"id": 82000078,
"selected_api": "FilterAPI",
"action": "filter",
"type_of": "filter",
"parent_id": 81999677,
"root_id": 77599812,
"auth_id": null
},
{
"id": 81999677,
"selected_api": "ZapierFormatterDevAPI",
"action": "number_line_item",
"type_of": "write",
"parent_id": 81999115,
"root_id": 77599812,
"auth_id": null
},
{
"id": 81999115,
"selected_api": "ZapierFormatterDevAPI",
"action": "util_line_item",
"type_of": "write",
"parent_id": 77599812,
"root_id": 77599812,
"auth_id": null
},
{
"id": 77599813,
"selected_api": "EshopboxCLIAPI@1.0.1",
"action": "create_order",
"type_of": "write",
"parent_id": 82000078,
"root_id": 77599812,
"auth_id": null
}
],
"createdAt": "2020-04-10T07:33:09+00:00",
"updatedAt": "2020-04-10T07:33:09+00:00"
}