Read Fax Details
Purpose: Read safe details for one eFax record without opening its document. Use when: Inspect a fax listed in the organization's connected eFax mailbox. Inputs: Required fax_id UUID string from List Received Faxes. Outputs: fax object with fax_id:string and nullable pages:integer, size:integer, image_downloaded:boolean, fax_status:string, completed_timestamp:string, direction:string; success:boolean, error:string|null, failure_category:null. The runner wraps successful output under default. No title or file bytes. Success: success=true, error=null, and fax.fax_id matches the requested ID. Failure: success=false with a safe error and no fax object; check the ID and mailbox access. Login and safe reads try transient errors up to three times with exponential backoff and jitter. Effects: Read-only in the current organization's mailbox; does not mark the fax read. Examples: {"fax_id":"00000000-0000-0000-0000-000000000001"} can return a fax object with fax_id="00000000-0000-0000-0000-000000000001", pages=3, success=true and error=null under default.
efax_read_faxUse 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": "eFax",
"params": {},
"handler": "efax_read_fax"
}Inputs
- Fax Id
fax_idtextrequiredRequired eFax fax UUID from List Received Faxes in this mailbox; not a local document ID.
Outputs
faxFaxsuccessSuccesserrorError
Output schema completeness: reviewed_partial
Safety
- External effect
- read
- Confirmation recommended
- No
- Retry safe
- Yes
- Dry run supported
- No
Schemas
These schemas are first-pass authoring guidance. Runtime validation remains authoritative.
Input schema
{
"type": "object",
"required": [
"fax_id"
],
"properties": {
"fax_id": {
"type": "string",
"format": "uuid",
"description": "Required eFax fax UUID from List Received Faxes in this mailbox; not a local document ID.",
"x-workflow-field-type": "text"
}
},
"additionalProperties": false
}Output schema
{
"type": "object",
"properties": {
"fax": {
"type": "object",
"additionalProperties": true
},
"error": {
"type": [
"string",
"null"
]
},
"success": {
"type": "boolean"
}
},
"additionalProperties": true
}