Skip to documentation
Brightree integration

Send CMN Electronic Fax

Perform Send CMN Electronic Fax through Brightree.

View as Markdown
brightree_send_cmn_electronic_fax
irreversiblebrightree

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": "Brightree",
  "params": {
    "confirm_send": false,
    "prepare_only": true
  },
  "handler": "brightree_send_cmn_electronic_fax"
}

Action contracts and connections · Run recovery

Inputs

  • run_date
    string
    Run Date

    Optional text value.

  • cmn_key
    expressionrequired
    Cmn Key

    Required literal value or workflow expression.

  • fax_target_cmn_key
    expression
    Fax Target Cmn Key

    Optional literal value or workflow expression.

  • cmn_form_key
    expressionrequired
    Cmn Form Key

    Required literal value or workflow expression.

  • comments
    textarea
    Comments

    Optional text value.

  • prepare_only
    boolean
    Prepare Only

    Optional true-or-false value.

    Default: true

  • cmn_expiration_date
    date
    Cmn Expiration Date

    Optional date in YYYY-MM-DD format.

  • confirm_send
    boolean
    Confirm Send

    Optional true-or-false value.

    Default: false

Outputs

  • successSuccess
  • submittedSubmitted
  • rejectedRejected
  • prepare_onlyPrepare Only
  • indeterminateIndeterminate
  • manual_review_requiredManual Review Required
  • retryableRetryable
  • idempotency_reusedIdempotency Reused
  • dispatch_statusDispatch Status
  • patient_dispositionPatient Disposition
  • outcome_categoryOutcome Category
  • cmn_keyCmn Key
  • fax_target_cmn_keyFax Target Cmn Key
  • cmn_form_keyCmn Form Key
  • fax_job_keyFax Job Key
  • include_cmn_cover_letterInclude Cmn Cover Letter
  • include_fax_cover_sheetInclude Fax Cover Sheet
  • recipient_name_presentRecipient Name Present
  • recipient_phone_presentRecipient Phone Present
  • recipient_fax_presentRecipient Fax Present
  • sender_fields_presentSender Fields Present
  • recipient_override_appliedRecipient Override Applied
  • fax_history_observedFax History Observed
  • fax_statusFax Status
  • fax_status_reasonFax Status Reason
  • messageMessage
  • errorError

Output schema completeness: best_effort_declared

Safety

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

Schemas

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

Input schema
{
  "type": "object",
  "required": [
    "cmn_key",
    "cmn_form_key"
  ],
  "properties": {
    "cmn_key": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "comments": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "textarea"
    },
    "run_date": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "string"
    },
    "cmn_form_key": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "confirm_send": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "prepare_only": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "fax_target_cmn_key": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "cmn_expiration_date": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "cmn_key": {},
    "message": {},
    "success": {},
    "rejected": {},
    "retryable": {},
    "submitted": {},
    "fax_status": {},
    "fax_job_key": {},
    "cmn_form_key": {},
    "prepare_only": {},
    "indeterminate": {},
    "dispatch_status": {},
    "outcome_category": {},
    "fax_status_reason": {},
    "fax_target_cmn_key": {},
    "idempotency_reused": {},
    "patient_disposition": {},
    "fax_history_observed": {},
    "recipient_fax_present": {},
    "sender_fields_present": {},
    "manual_review_required": {},
    "recipient_name_present": {},
    "include_fax_cover_sheet": {},
    "recipient_phone_present": {},
    "include_cmn_cover_letter": {},
    "recipient_override_applied": {}
  },
  "additionalProperties": true
}
View all Brightree actions