Official Plugins (Kuzzle v2.x)
Workflows v1.x
2

This plugin is part of the Kuzzle Enterprise Plan. If you are interested, please contact us.

Action #

Copied to clipboard!
import { JSONObject, RequestPayload } from 'kuzzle';
export type Action = {
  /**
    * Action type
    */
  type: 'api' | 'task' | 'rule' | 'rule-group';
  /**
    * Request payload to execute
    * (`type=api`)
    */
  request?: RequestPayload;
  /**
    * Depends on the "type":
    *  - `type=task`: Task name to execute
    *  - `type=rule`: Rule ID to execute
    *  - `type=rule-group`: Group of rules to execute
    *
    */
  name?: string;
  /**
    * Task custom arguments
    * (`type=task`)
    */
  args?: JSONObject;
};