Add a Custom Hook to a Step Using QuickStart

Note: Custom hooks are deprecated. Use interceptors instead.

Before you begin

You need:

  • a custom hook module

About this task

After creating a custom hook module, you must refer to it from a custom hook node in an existing step. To create a step,


  1. Navigate to the settings of the flow you want.

    QuickStart Flows - Manage Flows table - Click flow name

    1. In QuickStart's navigation bar, click Flows.
    2. In the Manage Flows table, search for the row containing the flow.
      Tip: To make your search easier, you can sort the table by one of the columns.
    3. Click the flow's name.
  2. In the flow sequence, click the summary box of the step to configure.

    The step detail panel is displayed below the flow sequence panel.
  3. In the step detail panel, click the vertical ellipsis (⋮), and then choose Edit Settings from the dropdown.
  4. Configure the custom hook.
    1. Expand the Advanced Settings section for additional fields.
    2. To add a custom hook, also expand the Custom Hook section.
    3. Configure the custom hook fields.
      Name Description
      Custom Hook: Module The path to your custom hook module.
      Custom Hook: Parameters Parameters, as key-value pairs, to pass to your custom hook module.
      Custom Hook: User The user account to use to run the module. The default is the user running the flow; e.g., flow-operator.
      Custom Hook: RunBefore For a pre-step hook, set to true. For a post-step hook, set to false.
  5. Click Save.

What to do next

Run your flow locally to test it. When ready, deploy your flows and custom modules to your MarkLogic Server.