NikoHealth integration

Set Order Custom Fields

Perform Set Order Custom Fields through NikoHealth.

nikohealth_set_order_custom_fields

writenikohealth

Use in a workflow

Copy the discovered node config and fill its params from the input contract. Validate the complete graph before publishing. Integration results use {{node_id.default.field}}. Check business success before dependent writes; completion alone does not prove success.

{
  "_group": "NikoHealth",
  "params": {
    "dry_run": false,
    "fail_when_any_unset": false
  },
  "handler": "nikohealth_set_order_custom_fields"
}

Action contracts and connections · Run recovery

Inputs

order_id
expressionrequired
Order Id
Required literal value or workflow expression.
fields
repeatable_grouprequired
Fields
Required list of structured items.
- name
  selectrequireddynamic options
  Name
  Required selected identifier or value. Retrieve allowed values from the dynamic options endpoint.
- value
  selectrequireddynamic options
  Value
  Required selected identifier or value. Retrieve allowed values from the dynamic options endpoint.
fail_when_any_unset
boolean
Fail When Any Unset
Optional true-or-false value.
Default: false
dry_run
boolean
Dry Run
Optional true-or-false value.
Default: false

Outputs

successSuccess
entity_idEntity Id
changedChanged
fields_setFields Set
unchanged_fieldsUnchanged Fields
unset_fieldsUnset Fields
unset_countUnset Count
dry_runDry Run
confirmed_by_readbackConfirmed By Readback
failure_categoryFailure Category
errorError

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",
  "required": [
    "order_id",
    "fields"
  ],
  "properties": {
    "fields": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "name",
          "value"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "Required selected identifier or value. Retrieve allowed values from the dynamic options endpoint.",
            "x-dynamic-options": true,
            "x-workflow-field-type": "select"
          },
          "value": {
            "type": "string",
            "description": "Required selected identifier or value. Retrieve allowed values from the dynamic options endpoint.",
            "x-dynamic-options": true,
            "x-workflow-field-type": "select"
          }
        },
        "additionalProperties": false
      },
      "description": "Required list of structured items.",
      "x-workflow-field-type": "repeatable_group"
    },
    "dry_run": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "order_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "fail_when_any_unset": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "changed": {},
    "dry_run": {},
    "success": {},
    "entity_id": {},
    "fields_set": {},
    "unset_count": {},
    "unset_fields": {},
    "failure_category": {},
    "unchanged_fields": {},
    "confirmed_by_readback": {}
  },
  "additionalProperties": true
}

View all NikoHealth actions