Skip to documentation
NikoHealth integration

Create Order Note

Perform Create Order Note through NikoHealth.

View as Markdown
nikohealth_create_order_note
writenikohealth

Inputs

  • note_request
    expression
    Note Request

    Optional literal value or workflow expression.

  • order_id
    expression
    Order Id

    Optional literal value or workflow expression.

  • subject
    expression
    Subject

    Optional literal value or workflow expression.

  • description
    expression
    Description

    Optional literal value or workflow expression.

  • is_pinned
    boolean
    Is Pinned

    Optional true-or-false value.

    Default: false

  • idempotency_fingerprint
    expression
    Idempotency Fingerprint

    Optional literal value or workflow expression.

  • skip_if_empty
    boolean
    Skip If Empty

    Optional true-or-false value.

    Default: false

  • dry_run
    boolean
    Dry Run

    Optional true-or-false value.

    Default: false

Outputs

  • successSuccess
  • skippedSkipped
  • dry_runDry Run
  • idempotentIdempotent
  • order_idOrder Id
  • note_idNote Id
  • subjectSubject
  • note_textNote Text
  • messageMessage
  • errorError
  • error_typeError Type

Output schema completeness: best_effort_declared

Safety

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

Schemas

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

Input schema
{
  "type": "object",
  "properties": {
    "dry_run": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "subject": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "order_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "is_pinned": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "description": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "note_request": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "skip_if_empty": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "idempotency_fingerprint": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "dry_run": {},
    "message": {},
    "note_id": {},
    "skipped": {},
    "subject": {},
    "success": {},
    "order_id": {},
    "note_text": {},
    "error_type": {},
    "idempotent": {}
  },
  "additionalProperties": true
}
View all NikoHealth actions