receive_fax

Receive a fax being delivered to this call. | Name | Type | Default | Description | |:|:|:--|:--| | receive_faxRequired | object | - | An empty object that accepts no parameters. | ## **Variables** Set by the method: - **receive_fax_document:** (out) URL of received document. - **receive_fax_identity:** (out) identity of this fax station. - **receive_fax_remote_identity:** (out) identity of the sending fax station. - **receive_fax_pages:** (out) number of pages received. - **receive_fax_result_code:** (out) fax status code. - **receive_fax_result_text:** (out) description of fax status code. - **receive_fax_result:** (out) success | failed. ## **Examples** ### Receive a fax and post a result to a webhook yaml andJson version: 1.0.0 sections: main: - receive_fax: {} - execute: dest: https://.ngrok-free.app In this example, when a fax is received, a POST request will be sent to the URL with all the fax related variables (like receive_fax_document) already set. Refer to the [execute](./execute.mdx) statements documentation for more details on this behavior.