Faxing: Webhooks



Faxing

Inbound Fax

Event


 inbound_fax



Payload

1{
2  "faxId": <long>,
3  "accountId": ""
4}

Description


Push notification event to partner when a fax was received by Updox.

Payload Summary


  • faxId: the unique identifier of the fax being received

  • accountId: the unique identifier of the account


Outbound Fax

The FaxOemSend Public API allows a “on-the-fly” callbackUrl to be specified for status changes events in the OEM fax being sent.  Using the outbound_fax webhook is the preferred way to get outbound fax status updates. Using the per call callback approach does give you more granularity and control over the callbacks on a fax by fax basis if needed.

NOTE: For partners implemented before April 2024, the status of “cancelled” is only applicable upon partner request.  For more information on cancelling faxes, please contact Partner Support.

Event


outbound_fax
Payload
 
1{
2  "faxId": <long>,
3  "accountId": "",
4  "status": ""
5}


Description


Push notification event to partner when a fax was sent from Updox to partner

Payload Summary


  • faxId: the unique identifier of the fax being sent

  • accountId: the unique identifier of the account

  • status: current state of fax

    • busy

    • cancelled

    • failure

    • received

    • success