ReferencesWorkflow Kit

Using the workflow engine

The workflow Engine is used to run a given workflow instance within an Inngest Function:

src/inngest/workflow.ts

import { Engine, type Workflow } from "@inngest/workflow-kit";

import { inngest } from "./client";
import { actions } from "./actions";
import { loadWorkflowInstanceFromEvent } from "./loaders";

const workflowEngine = new Engine({
  actions: actionsWithHandlers,
  loader: (event) => {
    return loadWorkflowInstanceFromEvent(event);
  },
});

export default inngest.createFunction(
  { id: "blog-post-workflow" },
  { event: "blog-post.updated" },
  async ({ event, step }) => {
    // When `run` is called,
    //  the loader function is called with access to the event
    await workflowEngine.run({ event, step });
  }
);

Configure

  • Name
    actions
    Type
    EngineAction[]
    Required
    optional
    Description

    See the EngineAction[] reference.

  • Name
    loader
    Type
    function
    Required
    optional
    Description

    An async function receiving the event as unique argument and returning a valid Workflow instance object.

  • Name
    disableBuiltinActions
    Type
    boolean
    Required
    optional
    Description

    For selectively adding built-in actions, set this to true and expose the actions you want via the <Provider> availableActions prop.