Skip to content

Workflow

Internal

These endpoints are internal to Hailer and not part of the supported public API.

Install workflow templates.

Endpoints

EndpointArgumentsReturns
v3.workflow.installworkspaceId: string, workflowSpec: WorkflowFrom[]unknown

v3.workflow.install

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

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

Argument 2 (any[], required): List of workflow templates

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('v3.workflow.install', [
  '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? }.

Hailer Developer Documentation