This article is for Updox partners and developers using the Updox API.
What faxing webhooks are available?
Event | When it's sent |
inbound_fax | When Updox receives a fax |
outbound_fax | When a fax is sent from Updox, with the fax's status |
Inbound fax
Event
inbound_fax
When is it sent?
Updox sends this push notification to the partner when a fax is received by Updox.
Payload
json
{ "faxId": <long>, "accountId": "" }Payload fields
Field | Type | What it is |
faxId | long | The unique ID of the fax that was received |
accountId | string | The unique ID of the account |
Outbound fax
Event
outbound_fax
When is it sent?
Updox sends this push notification to the partner when a fax is sent from Updox. It includes the fax's current status.
Payload
json
{ "faxId": <long>, "accountId": "", "status": "" }Payload fields
Field | Type | What it is |
faxId | long | The unique ID of the fax being sent |
accountId | string | The unique ID of the account |
status | string | The fax's current status. See the status values below. |
Status values
Status |
|
|
|
|
|
Note: For partners set up before April 2024, the cancelled status is only available on request. To learn more about cancelling faxes, contact Partner Support.
Should I use the outbound_fax webhook or a callbackUrl?
You have two ways to get status updates for outbound faxes:
Option | How it works | Best for |
outbound_fax webhook ✅ Recommended | Updox sends status updates for all outbound faxes to your webhook. | Most partners. This is the preferred way to get outbound fax status updates. |
callbackUrl in the FaxOemSend API | You set a callbackUrl for each fax when you send it. Updox sends status changes for that fax to that URL. | Partners who need more control over callbacks fax by fax |