Workflows

OnCreatedWorkflowCallback()

OnCreatedWorkflowCallback = (event: object) => void

Callback function called when a workflow is created.

Parameters

Parameter	Type
event	{ workflow: Workflow; }
event.workflow	Workflow

Returns

void

---

OnDeletedWorkflowCallback()

OnDeletedWorkflowCallback = (event: object) => void

Callback function called when a workflow is deleted.

Parameters

Parameter	Type
event	{ id: ID; }
event.id	ID

Returns

void

---

OnUpdatedWorkflowCallback()

OnUpdatedWorkflowCallback = (event: object) => void

Callback function called when a workflow is updated.

Parameters

Parameter	Type
event	{ workflow: Workflow; }
event.workflow	Workflow

Returns

void

---

Workflow

Workflow = object

A workflow

Properties

description

description: string

id

id: string

kind

kind: WorkflowKind

name

name: string

---

WorkflowKind

WorkflowKind = "Convert" | "Active" | "Passive"

The kind of workflow.

---

WorkflowSDK

WorkflowSDK = object

Utilities to interact with workflows.

Properties

getWorkflows()

getWorkflows: () => Workflow[]

Get all workflows.

Returns

Workflow[]

All workflows.

onCreatedWorkflow()

onCreatedWorkflow: (callback: OnCreatedWorkflowCallback) => ListenerHandle

Register a callback to be called when a workflow is created.

Parameters

Parameter	Type	Description
callback	OnCreatedWorkflowCallback	The callback to be called.

Returns

ListenerHandle

onDeletedWorkflow()

onDeletedWorkflow: (callback: OnDeletedWorkflowCallback) => ListenerHandle

Register a callback to be called when a workflow is deleted.

Parameters

Parameter	Type	Description
callback	OnDeletedWorkflowCallback	The callback to be called.

Returns

ListenerHandle

onUpdatedWorkflow()

onUpdatedWorkflow: (callback: OnUpdatedWorkflowCallback) => ListenerHandle

Register a callback to be called when a workflow is updated.

Parameters

Parameter	Type	Description
callback	OnUpdatedWorkflowCallback	The callback to be called.

Returns

ListenerHandle