Appearance
Network
Workspaces (networks): creation, licensing, invites, copying, and marketplace products.
Endpoints
| Endpoint | Arguments | Returns |
|---|---|---|
v2.network.copy | WorkspaceId, unknown | HailerResult |
v2.network.create | unknown | HailerResult |
v2.network.fastFunctions.set | WorkspaceId, unknown | boolean |
v2.network.get | ObjectId | object |
v2.network.invite.edit | unknown, Update object containing at least one key to be updated. | boolean |
v2.network.invite.list | ObjectId | any[] |
v2.network.invite.remove | unknown | boolean |
v2.network.invite.resend | unknown, ObjectId | boolean |
v2.network.invite.send | options | unknown |
v2.network.license.get | - | object |
v2.network.product.create | options | unknown |
v2.network.product.get | ObjectId | unknown |
v2.network.product.getManifest | ObjectId | unknown |
v2.network.product.install | ObjectId, WorkspaceId | boolean |
v2.network.product.isProductInstalled | ObjectId, WorkspaceId | boolean |
v2.network.product.publishTemplate | options | unknown |
v2.network.publicCopy | options | HailerResult |
v2.network.restrictions | - | unknown |
v2.network.update | WorkspaceId, options | boolean |
v2.network.workflowTemplate | WorkspaceId | unknown |
v2.network.copy
Description
Creates a copy of the selected workspace. Will only work if you are the network owner and it is not restricted. All created fields and processes will have new Ids assigned to them.
Parameters
Argument 1 (WorkspaceId, required): workspaceId (former networkId)
Argument 2 (string, required):
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('v2.network.copy', [
'507f1f77bcf86cd799439011', // WorkspaceId (required)
'string', // argument 2 (required)
]);
console.log(result);Returns
HailerResult
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.network.create
Description
Undocumented
This endpoint has no description in the source yet.
Parameters
Argument 1 (string, optional):
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('v2.network.create', [
'string', // argument 1
]);
console.log(result);Returns
HailerResult
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.network.fastFunctions.set
Description
Enable or disable the Fast Functions evaluator for a workspace.
Only workspace admins and owners can change this setting.
Parameters
Argument 1 (WorkspaceId, required): Workspace ID
Argument 2 (boolean, required): Enable Fast Functions
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('v2.network.fastFunctions.set', [
'507f1f77bcf86cd799439011', // WorkspaceId (required)
false, // Enable Fast Functions (required)
]);
console.log(result);Returns
boolean
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.network.get
Description
Undocumented
This endpoint has no description in the source yet.
Parameters
Argument 1 (ObjectId, required): Network ID
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('v2.network.get', [
'507f1f77bcf86cd799439011', // ObjectId (required)
]);
console.log(result);Returns
| Field | Type | Required | Description |
|---|---|---|---|
_id | ObjectId | no | |
name | string | yes | |
uid | string | yes | |
created | timestamp | yes | Time (milliseconds since 1970-01-01 UTC) |
updated | timestamp | no | Time (milliseconds since 1970-01-01 UTC) |
members | object[] | yes | |
settings | object | no | |
license | object | no | |
marketplace | object | no | |
propertyFields | object | no |
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.network.invite.edit
Description
Edit invitations
Only teams, title and notes can be updated.
Passing nullto either title or notes results in delete operation for that field.
Parameters
Argument 1 (string, required): Invitation key
Argument 2 (Update object containing at least one key to be updated., required):
| Field | Type | Required | Description |
|---|---|---|---|
notes | string | no | Note, set to null to clear |
title | string | no | Title, set to null to clear |
role | user | admin | owner | guest | inviter | no | One of: user, admin, owner, guest, inviter. |
teams | any | no | Stringified object id's |
customRole | roleId | no | Valid role id |
discussionIds | ObjectId[] | no |
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('v2.network.invite.edit', [
'string', // Invitation key (required)
{
notes: 'string', // Note, set to null to clear
title: 'string', // Title, set to null to clear
},
]);
console.log(result);Returns
boolean
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.network.invite.list
Description
List invites in this network
Parameters
Argument 1 (ObjectId, required): Network ID
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('v2.network.invite.list', [
'507f1f77bcf86cd799439011', // ObjectId (required)
]);
console.log(result);Returns
Array of any.
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.network.invite.remove
Description
Remove invitation
Parameters
Argument 1 (string, required): Invitation key
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('v2.network.invite.remove', [
'string', // Invitation key (required)
]);
console.log(result);Returns
boolean
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.network.invite.resend
Description
Undocumented
This endpoint has no description in the source yet.
Parameters
Argument 1 (string, required):
Argument 2 (ObjectId, optional):
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('v2.network.invite.resend', [
'string', // argument 1 (required)
'string', // ObjectId
]);
console.log(result);Returns
boolean
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.network.invite.send
Description
Undocumented
This endpoint has no description in the source yet.
Parameters
Argument 1 (object, required):
| Field | Type | Required | Description |
|---|---|---|---|
name | string | no | |
title | string | no | |
notes | string | no | |
email | string | yes | |
brandId | ObjectId | no | |
role | user | admin | owner | guest | inviter | no | One of: user, admin, owner, guest, inviter. |
teams | any | no | |
customRole | roleId | no | Valid role id |
discussionIds | ObjectId[] | no | |
cid | WorkspaceId | no | Workspace id, defaults to current workspace |
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('v2.network.invite.send', [
{
email: 'string',
},
]);
console.log(result);Returns
Undocumented
The return value is not described in the source yet.
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.network.license.get
Description
Undocumented
This endpoint has no description in the source yet.
Parameters
Undocumented
This endpoint declares no argument schema in the source yet.
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('v2.network.license.get', []);
console.log(result);Returns
| Field | Type | Required | Description |
|---|---|---|---|
type | free | legacy | enterprise | premium | free-trial | no | One of: free, legacy, enterprise, premium, free-trial. |
activated | timestamp | no | Time (milliseconds since 1970-01-01 UTC) |
functionFields | boolean | no | |
users | number | no | |
calendars | number | no | |
modules | number | no | |
activities | number | no | |
indexedData | boolean | no | |
processes | number | no | |
datasets | number | no | |
override | object | no | |
payment | object | no | |
canceled | object | no | |
tokens | object | no |
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.network.product.create
Description
Undocumented
This endpoint has no description in the source yet.
Parameters
Argument 1 (object, optional):
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | Name of the version |
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('v2.network.product.create', [
{
name: 'string', // Name of the version
},
]);
console.log(result);Returns
Undocumented
The return value is not described in the source yet.
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.network.product.get
Description
Undocumented
This endpoint has no description in the source yet.
Parameters
Argument 1 (ObjectId, required): Target Id in Hailer market
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('v2.network.product.get', [
'507f1f77bcf86cd799439011', // ObjectId (required)
]);
console.log(result);Returns
Undocumented
The return value is not described in the source yet.
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.network.product.getManifest
Description
Undocumented
This endpoint has no description in the source yet.
Parameters
Argument 1 (ObjectId, required): Target Id in Hailer market
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('v2.network.product.getManifest', [
'507f1f77bcf86cd799439011', // ObjectId (required)
]);
console.log(result);Returns
Undocumented
The return value is not described in the source yet.
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.network.product.install
Description
Undocumented
This endpoint has no description in the source yet.
Parameters
Argument 1 (ObjectId, required): Product Id in Hailer market
Argument 2 (WorkspaceId, required): Workspace Id where it will be installed
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('v2.network.product.install', [
'507f1f77bcf86cd799439011', // ObjectId (required)
'507f1f77bcf86cd799439011', // WorkspaceId (required)
]);
console.log(result);Returns
boolean
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.network.product.isProductInstalled
Description
Undocumented
This endpoint has no description in the source yet.
Parameters
Argument 1 (ObjectId, required): Product Id in Hailer market
Argument 2 (WorkspaceId, required): Workspace Id to check installation in
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('v2.network.product.isProductInstalled', [
'507f1f77bcf86cd799439011', // ObjectId (required)
'507f1f77bcf86cd799439011', // WorkspaceId (required)
]);
console.log(result);Returns
boolean
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.network.product.publishTemplate
Description
Undocumented
This endpoint has no description in the source yet.
Parameters
Argument 1 (object, optional):
| Field | Type | Required | Description |
|---|---|---|---|
workspaceId | WorkspaceId | no | Workspace Id |
targetId | ObjectId | no | target Id |
version | string | yes | semver format (e.g., 1.0.0) |
versionDescription | string | yes | Description for template |
title | string | yes | Title for the template |
description | string | yes | Description for template |
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('v2.network.product.publishTemplate', [
{
version: 'string', // semver format (e.g., 1.0.0)
versionDescription: 'string', // Description for template
title: 'string', // Title for the template
description: 'string', // Description for template
},
]);
console.log(result);Returns
Undocumented
The return value is not described in the source yet.
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.network.publicCopy
Description
Undocumented
This endpoint has no description in the source yet.
Parameters
Argument 1 (object, required):
| Field | Type | Required | Description |
|---|---|---|---|
copyNetworkId | WorkspaceId | yes | workspaceId (former networkId) |
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('v2.network.publicCopy', [
{
copyNetworkId: '507f1f77bcf86cd799439011', // workspaceId (former networkId)
},
]);
console.log(result);Returns
HailerResult
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.network.restrictions
Description
Undocumented
This endpoint has no description in the source yet.
Parameters
Undocumented
This endpoint declares no argument schema in the source yet.
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('v2.network.restrictions', []);
console.log(result);Returns
Undocumented
The return value is not described in the source yet.
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.network.update
Description
Updates some workspace settings, such as badge color, default view and enabling/disabling copying for non-owner users. Will not work if you are not the owner or an admin.
Parameters
Argument 1 (WorkspaceId, optional): Network ID
Argument 2 (object, optional):
| Field | Type | Required | Description |
|---|---|---|---|
name | string | no | |
isolatedTeams | boolean | no | |
color | string | no | |
defaultView | activities | discussions | events | feed | no | One of: activities, discussions, events, feed. |
allowPublicCopy | boolean | no | |
functionFieldVersion | number | no | |
languages | fi | en | sv[] | no | |
localauth | boolean | no | |
disableVideoCalls | boolean | no |
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('v2.network.update', [
'507f1f77bcf86cd799439011', // WorkspaceId
{
name: 'string',
isolatedTeams: false,
},
]);
console.log(result);Returns
boolean
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.network.workflowTemplate
Description
Undocumented
This endpoint has no description in the source yet.
Parameters
Argument 1 (WorkspaceId, required): workspaceId (former networkId)
Example
javascript
const { Client } = require('@hailer/cli');
const client = await Client.create({
host: 'https://api.hailer.com',
username: 'you@example.com',
password: '••••••',
});
const result = await client.request('v2.network.workflowTemplate', [
'507f1f77bcf86cd799439011', // WorkspaceId (required)
]);
console.log(result);Returns
Undocumented
The return value is not described in the source yet.
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.