Type alias InvokeParams

InvokeParams: {
    args?: {
        [key: string]: string;
    };
    config: SdkConfigOptions;
    globalVariables: VariablesResultSet;
    groupVariables: VariablesResultSet;
    points: ResultSet;
    sdk: IRunParams;
}

Object that is passed to the Hook Function as the only parameter

Type declaration

  • Optional args?: {
        [key: string]: string;
    }

    key/value strings that can be passed into the hook invocation when inovke from the Normal API

    • [key: string]: string
  • config: SdkConfigOptions

    Configuration options defined in the Application (e.g. endpoint urls, api secrets, etc.)

  • globalVariables: VariablesResultSet

    Variables passed into all invocations of this hook (scoped to hook)

  • groupVariables: VariablesResultSet

    Variables passed for this group (scoped to group - each group gets its own variable with this name)

  • points: ResultSet

    Points that are selected for this hook (or, points for a given group)

  • sdk: IRunParams

    a configured instance of the sdk

Settings

Member Visibility

Theme

Generated using TypeDoc