Type alias ActionDefinition<Name, InputParamsSchema, Credential>

ActionDefinition<Name, InputParamsSchema, Credential>: {
    execute: ExecuteActionFunction<InputParamsSchema, Credential>;
    inputParamsSchema: InputParamsSchema;
    name: Name;
}

Describes a Connector Action.

Type Parameters

  • Name extends string

  • InputParamsSchema extends TObject

  • Credential extends AnyAppCredential

Type declaration

  • execute: ExecuteActionFunction<InputParamsSchema, Credential>

    Function which executes the Action.

  • inputParamsSchema: InputParamsSchema

    Type schema for the input params. Use the defineActionInputParamsSchema function to describe the types.

  • name: Name

    Name of the Action that will be displayed in UI.