

An example of a valid webhook URL is įor sent and received faxes, you can set global webhook URLs on your webhook settings page. This should be a valid URI with a http, https scheme that points to a destination that you control. The first thing we need to send you a webhook is a destination URL. Webhooks are triggered by events such as the completion of a fax, and transmit information about the state of that fax to you via HTTP(S).
Ifax error update#
Webhooks allow iFax to update you in real-time about the status of your faxes. Click here for more information.Ī detailed description of the fax status or error, if any.Ī numeric code that indicates a more accurate representation of the fax status or error, if any. Can be any of the following: ‘sending’, ‘delivered’, ‘canceled’, or ‘failed’.

The total number of pages in the fax that were successfully sent and received by the recipient. The total number of pages in the fax being sent. The total time spent (in seconds) from when the API call was made until the fax processing ended.Ī timestamp (in Unix time) indicating when the initial API call was made.Ī timestamp (in Unix time) indicating when the fax processing ended. The number (in E.164 format) that received the fax. The number (in E.164 format) the fax was sent from. This can be used to retrieve the fax’s status, cancel a fax or resend a failed fax. NameĪ unique ID generated for each fax sent through the API. Its properties are described in the table below. The fax object is a JSON object returned by the iFax API and represents a fax job in the system.
