run

nelkap.run<T extends WorkflowHandler>(
  workflow: T,
  payload?: Parameters<T>[0],
  options?: { tags?: string[] },
): Promise<{ runId: string }>

Parameters

WorkflowHandler

required

A workflow function passed to registerWorkflows.

Parameters<T>[0]

Any JSON value. The workflow gets it as its argument.

string[]

Tags to find the run by. Up to 10, each up to 128 characters.

string

The id of the new run.

Error	When
`Error`	The function wasn’t passed to `registerWorkflows`.
`NelkapError` `workflowNotFound`	The project has no enabled workflow with this name.
`NelkapError` `badRequest`	The payload or a tag breaks a rule above.

Any call can also get the errors listed in Errors.

const { runId } = await nelkap.run(onboardUser, 'user_42', { tags: ['beta'] });