ByteChef LogoByteChef

Approval

Approval component for manual intervention in workflows.

Categories: Helpers

Type: approval/v1


Actions

Request Approval

Name: requestApproval

Sends an approval request and waits for a human to approve or reject.

Properties

NameLabelTypeDescriptionRequired
formTitleForm TitleSTRINGThe title for the approval form. Displayed as the main heading.false
formDescriptionForm DescriptionSTRINGA description shown under the form title. Use \n or <br> for line breaks.false
inputsForm InputsARRAY
Items [{INTEGER(fieldType), STRING(fieldLabel), STRING(fieldName), STRING(fieldDescription), STRING(placeholder), STRING(defaultValue), STRING(defaultValue), [{STRING(label), STRING(value)}](fieldOptions), BOOLEAN(multipleChoice), INTEGER(minSelection), INTEGER(maxSelection), BOOLEAN(required)}]
Define the form input fields for the approval request.false

Example JSON Structure

{
  "label" : "Request Approval",
  "name" : "requestApproval",
  "parameters" : {
    "formTitle" : "",
    "formDescription" : "",
    "inputs" : [ {
      "fieldType" : 1,
      "fieldLabel" : "",
      "fieldName" : "",
      "fieldDescription" : "",
      "placeholder" : "",
      "defaultValue" : "",
      "fieldOptions" : [ {
        "label" : "",
        "value" : ""
      } ],
      "multipleChoice" : false,
      "minSelection" : 1,
      "maxSelection" : 1,
      "required" : false
    } ]
  },
  "type" : "approval/v1/requestApproval"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

How is this guide?

Last updated on

On this page