Process

Workflow (process) configuration: metadata, copying, members, permissions, public forms, and translations.

Endpoints

Endpoint	Arguments	Returns
v2.process.copy	unknown	processId[]
v2.process.get	processId	object
v2.process.member.add	ObjectId, unknown	boolean
v2.process.member.list	ObjectId	object[]
v2.process.member.remove	ObjectId, unknown	boolean
v2.process.meta	options	object
v2.process.permissions.deny	ObjectId, unknown, unknown	boolean
v2.process.permissions.grant	ObjectId, unknown, unknown	unknown
v2.process.publicForm.create	options	object
v2.process.publicForm.update	options	object
v2.process.star	ObjectId	object
v2.process.translation.create	processId, unknown	object
v2.process.validateFunction	unknown, unknown	unknown
v2.process.validateFunctions	WorkspaceId	unknown

v2.process.copy

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (processId \| processId[], required): One or many processIds to copy

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.process.copy', [
  '507f1f77bcf86cd799439011', // One or many processIds to copy (required)
]);
console.log(result);

Returns

Array of processId.

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.process.get

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (processId, optional): workflowId

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.process.get', [
  '507f1f77bcf86cd799439011', // processId
]);
console.log(result);

Returns

Field	Type	Required	Description
coverImage	ObjectId	no
createNewLabel	string	no
description	string | string[]	no
defaultView	string	no
translations	Record<fi | en | sv, object>	no	Schema for process translations See below.
enableAddedField	boolean	no
enableAttachments	boolean	no
enableLinkedAnnouncements	boolean	no
enableMapLocation	boolean	no
enableMessenger	boolean	no
allowGuests	boolean	no
enableGuestEditing	boolean	no
enableModifiedField	boolean	no
enableOwnerField	boolean	no
enableBallTracking	boolean	no
enableOwnerTeamField	boolean	no
ownerTeamFieldTitle	string	no
enablePredefinedName	boolean	no
enablePreselectedTeam	boolean	no
enableUniqueName	boolean	no
enableUnlinkedMode	boolean	no
fieldsOrder	ObjectId[]	no
initPhaseDescription	string	no
locationRequired	boolean	no
name	string	no
nameColumnText	string	no
nameFieldPlaceHolderText	string	no
nameFunctionEnabled	boolean	no
nameFunctionVariables	Record<string, object | object[]>	no
nameFunction	string	no
nameEditable	boolean	no
order	integer	no
members	object[]	no	See below.
personInCharge	ObjectId	no
personInChargeLabel	string	no
phases	object	no
phasesOrder	ObjectId[]	no
phasesRemoved	ObjectId[]	no
predefinedNamePrefix	string	no
preselectedTeam	object	no	See below.
tags	ObjectId[]	no
allowMultipleTags	boolean	no
allowCustomTags	boolean	no
requireFileTag	boolean	no
defaultGroupByField	ObjectId	no
color	string	no
discussionPermissions	array	no
inviteActivityCreator	boolean	no
groupNames	string[]	no
enableActivityTagging	boolean	no
activityTaggingPhaseIds	any	no
autoPickPreselectedTeam	boolean	no	Determines if the sidenav automatically picks a team if no preselected team are set
key	string	no	Process key
_id	processId	yes	Process Id
uid	userId	yes	Process creator user id
cid	WorkspaceId	yes	Process network id
created	timestamp	yes	Timestamp of when the process was created
updated	timestamp	yes	Timestamp of when the process was updated
fields	Record<string, object>	yes	Process fields See below.
isStarred	boolean	yes	True when current client has starred the process
createdActivities	number	no	Amount of activities created in the process
publicForm	object	no	Process public form See below.
documentTemplates	Record<string, object>	no	Process Document Templates See below.

translations.* (object):

Field	Type	Required	Description
name	string	no
fields	Record<fieldId, object>	no	See below.
nameFieldPlaceHolderText	string	no
phases	Record<phaseId, object>	no	See below.
description	string	no
nameColumnText	string	no
predefinedNamePrefix	string	no
createNewLabel	string	no
personInChargeLabel	string	no
initPhaseDescription	string	no
ownerTeamFieldTitle	string	no

translations.*.fields.* (object):

Field	Type	Required	Description
label	string	no
unit	string	no
placeholder	string	no
description	string	no
defaultValue	string	no

translations.*.phases.* (object):

Field	Type	Required	Description
name	string	no
description	string	no
possibleNextPhaseSettings	Record<string, object>	no	See below.

translations.*.phases.*.possibleNextPhaseSettings.* (object):

Field	Type	Required	Description
text	string	no

members[] (object):

Field	Type	Required	Description
id	string	no	network_<networkId>, team_<teamId>, user_<userId>, group_<groupId>
info	object	no
permissions	(admin | own | ownteam | any | edit)[]	no

preselectedTeam (object):

Field	Type	Required	Description
account	ObjectId	yes	accountId
team	ObjectId	yes	teamId

fields.* (object):

Field	Type	Required	Description
editable	boolean	no	Enables editing for function fields
placeholder	string	no	Placeholder text for label
description	string	no	Description text for field
data	(ObjectId | string)[]	no	List of allowable values for predefined options or process ids for linked activities
unit	string	no	Unit - default to null (no unit)
defaultTo	boolean	no	Enable default to given value in defaultValue
defaultValue	string	no	Default value for field if defaultTo is enabled
function	string	no	Javascript function code
functionEnabled	boolean	no	Enable function
functionVariables	Record<string, object | object[]>	no
reminderEnabled	boolean	no	Enable reminder
modifier	object	no	field type modifiers See below.
key	string	no	Field Key
reminderSettings	object	no	See below.
collapsedByDefault	boolean	no	Hides fields under subheader if enabled
label	string	yes	Field label
required	boolean	no	Require field to be given - defaults to false Default: false.
type	string	yes	One of: activitylink, country, date, daterange, datetime, datetimerange, numeric, numericunit, teams, text, textarea, textunit, textpredefinedoptions, time, timerange, users, linkedfrom, subheader.
inviteToDiscussionOnChange	boolean	no	Only used for User fields. If true the user will be added to the activity discussion if they are not already in it. Default: false.
_id	ObjectId	yes
created	timestamp	no	Time (milliseconds since 1970-01-01 UTC)
updated	timestamp	no	Time (milliseconds since 1970-01-01 UTC)
uid	userId	no	userId

fields.*.modifier (object):

Field	Type	Required	Description
checkbox	boolean	no
file	boolean	no
link	boolean	no
activityFieldFilters	object[]	no	See below.
matchAllFieldFilters	boolean	no	Set true if all activityFieldFilters must match
quickAdd	object	no	See below.

fields.*.modifier.activityFieldFilters[] (object):

Field	Type	Required	Description
targetWorkflowId	processId	yes	workflowId
targetFieldId	fieldId	yes	fieldId
sourceFieldId	string	no

fields.*.modifier.quickAdd (object):

Field	Type	Required	Description
targetFieldId	fieldId	yes	fieldId
fieldIds	fieldId[]	no

fields.*.reminderSettings (object):

Field	Type	Required	Description
users	ObjectId[]	no	Users to Remind
teams	ObjectId[]	no	Teams to Remind
fields	ObjectId[]	no	User/Team Fields to Remind
phases	ObjectId[]	no	Phases where the reminder is active
activityOwner	boolean	yes	Should we remind the activity owner
activityOwnerTeam	boolean	yes	Should we remind the activity owner team
activityParticipants	boolean	yes	Should we remind the activity discussion participants
reminderText	string	no
fieldOffset	object	no	Offset to add to field dates for reminders See below.

fields.*.reminderSettings.fieldOffset (object):

Field	Type	Required	Description
milliseconds	number	yes	Milliseconds to add/subtract from offset
days	number	yes	Days to add/subtract from offset
months	number	yes	Months to add/subtract from offset
beforeOrAfter	before | after	yes
startOrEnd	start | end	no

publicForm (object):

Field	Type	Required	Description
key	string	yes	Public form key
creator	userId	yes	Public form creator id
team_account	object	yes	Public form team See below.
followers	string	yes	Public form followers
active	boolean	yes	Public form active state
enableMessaging	boolean	no
allowRead	boolean	yes	Allow listing activities in activity fields
theme	object	no	Theme information containing colors and logo for form See below.

publicForm.team_account (object):

Field	Type	Required	Description
account	ObjectId	yes	accountId
team	ObjectId	yes	teamId

publicForm.theme (object):

Field	Type	Required	Description
foregroundColor	string	yes	Hex color value
backgroundColor	string	yes	Hex color value
complementaryColor	string	yes	Hex color value
textColor	string	yes	Hex color value
headerColor	string	yes	Hex color value
logoId	fileId	no	fileId

documentTemplates.* (object):

Field	Type	Required	Description
templateId	ObjectId	no
name	string	no
order	number	no
fieldMap	object	no	See below.
opts	object	no	See below.

documentTemplates.*.fieldMap (object):

Field	Type	Required	Description
staticActivityIds	string	no
images	Record<string, object>	no	See below.
activityLinks	Record<string, object>	no	See below.
fields	Record<string, object>	no	See below.

documentTemplates.*.fieldMap.images.* (object):

Field	Type	Required	Description
value	string	no
description	string	no

documentTemplates.*.fieldMap.activityLinks.* (object):

Field	Type	Required	Description
label	string	no
process	string	no
field	string	no
description	string	no

documentTemplates.*.fieldMap.fields.* (object):

Field	Type	Required	Description
value	string	no
label	string	no
description	string	no

documentTemplates.*.opts (object):

Field	Type	Required	Description
formatFieldValue	boolean	no
thousandSeparator	string	no
decimalSeparator	string	no
toFixedDigits	string	no
toFixedIds	string	no
linkedActivitiesFilteredPhases	string	no
useRenderedActivity	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.process.member.add

Description

Add member to process.

Parameters

Argument 1 (ObjectId, required): Process Id

Argument 2 (string, required): Network / User / Team / Group

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.process.member.add', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
  'string', // Network / User / Team / Group (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.process.member.list

Description

List permissions

Parameters

Argument 1 (ObjectId, required): Process 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.process.member.list', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
]);
console.log(result);

Returns

Array of objects:

Field	Type	Required	Description
id	string	no	network_<networkId>, team_<teamId>, user_<userId>, group_<groupId>
info	object	no
permissions	(admin | own | ownteam | any | edit)[]	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.process.member.remove

Description

Remove member of process.

Parameters

Argument 1 (ObjectId, required): Process Id

Argument 2 (string, required): User / Team

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.process.member.remove', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
  'string', // User / Team (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.process.meta

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (object, optional):

Field	Type	Required	Description
process	ObjectId	yes	Process Id
search	string	no	Optional Search String

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.process.meta', [
  {
    process: '507f1f77bcf86cd799439011', // Process Id
  },
]);
console.log(result);

Returns

Record<string, object>

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.process.permissions.deny

Description

Deny permission to Process for User / Team.

Parameters

Argument 1 (ObjectId, required): Process Id

Argument 2 (string, required): User / Team

Argument 3 (admin` \| `any` \| `own` \| `ownteam, optional): Permission

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.process.permissions.deny', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
  'string', // User / Team (required)
  'admin', // Permission
]);
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.process.permissions.grant

Description

Grant permission to Process for User / Team.

Parameters

Argument 1 (ObjectId, required): Process Id

Argument 2 (string, required): User / Team

Argument 3 (admin` \| `any` \| `own` \| `ownteam, optional): Permission

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.process.permissions.grant', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
  'string', // User / Team (required)
  'admin', // Permission
]);
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.process.publicForm.create

Description

Generate process/dataset form key endpoint. If endpoint already exist, it will be replaced with new form key

Parameters

Argument 1 (object, required):

Field	Type	Required	Description
processId	ObjectId	yes	Process Id
creator	string	no	Creator (User Id)
team	string	no	Team Id
account	string	no	Account Id
followers	none | creator | team	no	Valid attributes are none, creator or team
active	boolean	no	true or false, defaults to true
enableMessaging	boolean	no	Enable public form user to anonymously take part in the discussion
theme	object	no	Theme information containing colors and logo for form See below.

theme (object):

Field	Type	Required	Description
foregroundColor	string	yes	Hex color value
backgroundColor	string	yes	Hex color value
complementaryColor	string	yes	Hex color value
textColor	string	yes	Hex color value
headerColor	string	yes	Hex color value
logoId	fileId	no	fileId

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.process.publicForm.create', [
  {
    processId: '507f1f77bcf86cd799439011', // Process Id
  },
]);
console.log(result);

Returns

Field	Type	Required	Description
key	string	yes	Public form key
creator	userId	yes	Public form creator id
team_account	object	yes	Public form team See below.
followers	string	yes	Public form followers
active	boolean	yes	Public form active state
enableMessaging	boolean	no
allowRead	boolean	yes	Allow listing activities in activity fields
theme	object	no	Theme information containing colors and logo for form See below.

team_account (object):

Field	Type	Required	Description
account	ObjectId	yes	accountId
team	ObjectId	yes	teamId

theme (object):

Field	Type	Required	Description
foregroundColor	string	yes	Hex color value
backgroundColor	string	yes	Hex color value
complementaryColor	string	yes	Hex color value
textColor	string	yes	Hex color value
headerColor	string	yes	Hex color value
logoId	fileId	no	fileId

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.process.publicForm.update

Description

Update process/dataset form key endpoint. Form key will not be replaced

Parameters

Argument 1 (object, required):

Field	Type	Required	Description
processId	ObjectId	yes	Process Id
creator	string	no	Creator (User Id)
team	string	no	Team Id
account	string	no	Account Id
followers	none | creator | team	no	Valid attributes are none, creator or team
active	boolean	no	true or false
allowRead	boolean	no	true or false
enableMessaging	boolean	no	true or false, enable public form user to anonymously take part in the discussion
theme	object	no	Theme information containing colors and logo for form See below.

theme (object):

Field	Type	Required	Description
foregroundColor	string	yes	Hex color value
backgroundColor	string	yes	Hex color value
complementaryColor	string	yes	Hex color value
textColor	string	yes	Hex color value
headerColor	string	yes	Hex color value
logoId	fileId	no	fileId

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.process.publicForm.update', [
  {
    processId: '507f1f77bcf86cd799439011', // Process Id
  },
]);
console.log(result);

Returns

Field	Type	Required	Description
key	string	yes	Public form key
creator	userId	yes	Public form creator id
team_account	object	yes	Public form team See below.
followers	string	yes	Public form followers
active	boolean	yes	Public form active state
enableMessaging	boolean	no
allowRead	boolean	yes	Allow listing activities in activity fields
theme	object	no	Theme information containing colors and logo for form See below.

team_account (object):

Field	Type	Required	Description
account	ObjectId	yes	accountId
team	ObjectId	yes	teamId

theme (object):

Field	Type	Required	Description
foregroundColor	string	yes	Hex color value
backgroundColor	string	yes	Hex color value
complementaryColor	string	yes	Hex color value
textColor	string	yes	Hex color value
headerColor	string	yes	Hex color value
logoId	fileId	no	fileId

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.process.star

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (ObjectId, 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.process.star', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
]);
console.log(result);

Returns

Field	Type	Required	Description
isStarred	boolean	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.process.translation.create

Description

Creates a new translation from the default network language

Parameters

Argument 1 (processId, required): workflowId

Argument 2 (fi` \| `en` \| `sv, required): ISO code of new language to be created

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.process.translation.create', [
  '507f1f77bcf86cd799439011', // processId (required)
  'fi', // ISO code of new language to be created (required)
]);
console.log(result);

Returns

Record<fi\|en\|sv, object>

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.process.validateFunction

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (string, required): Function Body

Argument 2 (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.process.validateFunction', [
  'string', // Function Body (required)
  ['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.process.validateFunctions

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.process.validateFunctions', [
  '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.