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.product.uninstall	productId: string, workspaceId: string, scope?: { packageHash: string, created: number }	object
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

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?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

v2.network.create

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (string, optional):

Example

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?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

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

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?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

v2.network.get

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (ObjectId, required): Network ID

Example

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	See below.
settings	object	no	See below.
license	object	no	See below.
marketplace	object	no	See below.
propertyFields	object	no	See below.

members[] (object):

Field	Type	Required	Description
uid	ObjectId	yes
title	string	no
owner	boolean	no
admin	boolean	no
joined	timestamp	yes	Time (milliseconds since 1970-01-01 UTC)
fields	Record<string, any>	no
guest	boolean	no
inviter	boolean	no
customRole	roleId	no	Valid role id
customRoleName	string	no

settings (object):

Field	Type	Required	Description
isolatedTeams	boolean	no	Whether users can view only members of their team
defaultView	string	no
allowPublicCopy	boolean	no
functionFieldVersion	number	no
languages	(fi | en | sv)[]	no
color	string	no
disableVideoCalls	boolean	no

license (object):

Field	Type	Required	Description
type	string	no
activated	number	no
override	object	no
payment	object	no	See below.
tokens	object	no	See below.

license.payment (object):

Field	Type	Required	Description
customer_id	string	no
country_code	string	no
licensee	string	no
subscription	string	no
subscription_item	string	no
type	stripe	no
status	active | canceled	no

license.tokens (object):

Field	Type	Required	Description
balance	number	yes
lastUpdated	number	yes
autoReload	object	no	See below.

license.tokens.autoReload (object):

Field	Type	Required	Description
enabled	boolean	yes
triggerBalance	number	yes
targetBalance	number	yes
isProcessing	boolean	no

marketplace (object):

Field	Type	Required	Description
creatorPercent	number	yes

propertyFields (object):

Field	Type	Required	Description
users	Record<string, any>	no

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

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
teams	any	no	Stringified object id's
customRole	roleId	no	Valid role id
discussionIds	ObjectId[]	no

Example

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?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

v2.network.invite.list

Description

List invites in this network

Parameters

Argument 1 (ObjectId, required): Network ID

Example

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?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

v2.network.invite.remove

Description

Remove invitation

Parameters

Argument 1 (string, required): Invitation key

Example

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?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

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

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?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

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
teams	any	no
customRole	roleId	no	Valid role id
discussionIds	ObjectId[]	no
cid	WorkspaceId	no	Workspace id, defaults to current workspace

Example

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?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

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

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
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	See below.
payment	object	no	See below.
canceled	object	no	See below.
tokens	object	no	See below.

override (object):

Field	Type	Required	Description
filesTagging	boolean	no
functionFields	boolean	no
kanban	boolean	no
tableEdit	boolean	no
customRoles	boolean	no
restricted	boolean	no
insight	boolean	no
insightOnDisk	boolean	no	Enable on-disk SQLite for Insight report execution
dataExport	boolean	no
documentGenerator	boolean	no
groups	boolean	no
users	number	no
print	boolean	no
calendars	number	no
modules	number	no
activities	number	no
isolatedTeams	boolean	no	Whether users can view only members of their team
managedUsers	boolean	no	Determine if managed users is allow in network
tourIdentifier	string	no	Onboarding tour id used with Usetiful or similar tool for workspace specific tours
translations	boolean	no	Determine if translations are allow in network
indexedData	boolean	no	Enable the use of IndexedData (Typesense)
fastFunctions	boolean	no	Enable the use of Fast Functions evaluator
extendedFunctionFieldEvaluateAllMemory	boolean	no	Allow function-field evaluate-all operations to use a larger one-shot worker heap
activityRecovery	boolean	no	Enable activity recovery

payment (object):

Field	Type	Required	Description
customer_id	string	no
country_code	string	no
licensee	string	no
subscription	string	no
subscription_item	string	no
type	stripe	no
status	active | canceled	no

canceled (object):

Field	Type	Required	Description
type	premium	yes
time	timestamp	yes	Time (milliseconds since 1970-01-01 UTC)

tokens (object):

Field	Type	Required	Description
balance	number	yes
lastUpdated	timestamp	yes	Time (milliseconds since 1970-01-01 UTC)
autoReload	object	no	See below.
mcpFactor	number	no
videoCallFactor	number	no

tokens.autoReload (object):

Field	Type	Required	Description
enabled	boolean	yes
triggerBalance	number	no
targetBalance	number	no
isProcessing	boolean	no

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

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

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?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

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

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?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

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

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?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

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

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?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

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

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?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

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

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?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

v2.network.product.uninstall

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 remove it from

Argument 3 (Limit removal to a single install of this product. Omit to remove every install of it in the workspace (what cancelling the subscription does)., optional):

Field	Type	Required	Description
packageHash	ObjectId	yes
created	timestamp	yes	Time (milliseconds since 1970-01-01 UTC)

Example

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.uninstall', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
  '507f1f77bcf86cd799439011', // WorkspaceId (required)
  {
    packageHash: 'string',
    created: Date.now(), // Time (milliseconds since 1970-01-01 UTC)
  },
]);
console.log(result);

Returns

Field	Type	Required	Description
workflows	number	yes
insights	number	yes
teams	number	yes
keptTeams	object[]	yes	See below.

keptTeams[] (object):

Field	Type	Required	Description
name	string	yes
reason	string	yes

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

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

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?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

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

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?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

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
allowPublicCopy	boolean	no
functionFieldVersion	number	no
languages	(fi | en | sv)[]	no
localauth	boolean	no
disableVideoCalls	boolean	no

Example

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?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

v2.network.workflowTemplate

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (WorkspaceId, required): workspaceId (former networkId)

Example

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?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.