Human Approval Action

Documentation Index

Fetch the complete documentation index at: https://docs.hookpulse.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

​

Base URL

https://api.hookpulse.io

​

Example request

curl -X POST "https://api.hookpulse.io/v1/api/human_approval_action/" \
  -H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
  -H "x-brand-uuid: {{x-brand-uuid}}" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "approve",
    "execution_plan_uuid": "{{execution_plan_uuid}}"
  }'

​

Request body

​

Example response

​

Approve Response

{
  "success": true,
  "message": "Workflow approved and resumed"
}

​

Reject Response

{
  "success": true,
  "message": "Workflow rejected and skipped"
}

​

Response fields

​

Action Types

​

Workflow Behavior

​

Approve Action

• The workflow resumes execution and continues to the next step
• If delay_to_next_step is configured, the workflow waits for that duration before proceeding
• The workflow follows the on_success_next_step_identifier path if configured
• The execution status changes from "waiting_approval" to "active"

​

Reject Action

• The workflow skips the current step and moves to the failure path
• The workflow follows the on_fail_next_step_identifier path if configured
• If no failure path is configured, the workflow may stop or continue based on workflow settings
• The execution status changes from "waiting_approval" to the next appropriate status

​

Use Cases

• Approval Workflows: Approve or reject steps that require human decision
• Quality Control: Review and approve workflows before they proceed
• Compliance: Ensure workflows meet compliance requirements before continuing
• Error Handling: Reject workflows that need to be stopped or redirected
• Manual Intervention: Allow humans to control workflow execution at critical points

​

Examples

​

Approve a Workflow

{
  "action": "approve",
  "execution_plan_uuid": "{{execution_plan_uuid}}"
}

​

Reject a Workflow

{
  "action": "reject",
  "execution_plan_uuid": "{{execution_plan_uuid}}"
}

​

Important Notes

• Execution Plan UUID: Use the execution_plan_id from the Get All Pending Approvals endpoint
• Immediate Effect: Actions take effect immediately when processed
• One-Time Action: Each approval can only be acted upon once
• Workflow Continuation: After approval or rejection, the workflow continues automatically based on the configured paths

​

Related Documentation

• Human Approval Overview - Learn about human approval in workflows
• Get All Pending Approvals (Paginated) - View all pending approvals
• Add Workflow Step - Configure steps with human approval