Skip to documentation
NikoHealth integration

Download Intake Item

Perform Download Intake Item through NikoHealth.

View as Markdown
genhealth_download_intake_item
write

Inputs

  • source_type
    selectrequired
    Source Type

    Required selected identifier or value.

    Options: User Document ("user_doc"), Fax Inbox ("fax")

  • item
    expressionrequired
    Item

    Required literal value or workflow expression.

  • job_id
    expression
    Job Id

    Optional literal value or workflow expression.

  • workflow_id
    expression
    Workflow Id

    Optional literal value or workflow expression.

Outputs

  • successSuccess
  • document_idDocument Id
  • was_existingWas Existing
  • downloadedDownloaded
  • skip_reasonSkip Reason
  • ext_idExt Id
  • errorError

Output schema completeness: best_effort_declared

Safety

External effect
write
Confirmation recommended
No
Retry safe
No
Dry run supported
No

Schemas

These schemas are first-pass authoring guidance. Runtime validation remains authoritative.

Input schema
{
  "type": "object",
  "required": [
    "source_type",
    "item"
  ],
  "properties": {
    "item": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "job_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "source_type": {
      "enum": [
        "user_doc",
        "fax"
      ],
      "type": "string",
      "description": "Required selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "workflow_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "ext_id": {},
    "success": {},
    "downloaded": {},
    "document_id": {},
    "skip_reason": {},
    "was_existing": {}
  },
  "additionalProperties": true
}
View all NikoHealth actions