How inbound fax webhooks work
Request a webhook setup or change and learn how your application retrieves incoming faxes.
An inbound fax webhook is a notification WestFax sends to your application when a new fax arrives. It lets your application know that a fax is available so it can retrieve the fax’s details and document.
Request a setup or change
An account administrator must request a new webhook setup or a change to an existing webhook URL.
If you’re already speaking with WestFax Support, the administrator can reply in the current conversation. Otherwise, they can email support@westfax.com.
Please include:
- The affected fax number or numbers.
- Whether you need a new setup or a change to an existing setup.
- Your application’s webhook URL—the address WestFax should notify.
- Whether your application expects a GET or POST request. Your developer can provide this information.
We’ll review the request and help with the next step.
What WestFax includes in the notification
For the callback setup described here, WestFax fills in these values when it calls your configured URL:
- {@jobId}: The fax’s unique ID.
- {@prodId}: Your product ID.
- {@dir}: Whether the fax is inbound or outbound.
You don’t need to know the fax’s job ID ahead of time. WestFax provides it with the notification.
What your application does next
Your developer configures your application to:
- Receive the notification and capture the identifiers.
- Call Fax_GetFaxDescriptionsUsingIds to retrieve details such as the fax’s date, page count, and status.
- Call Fax_GetFaxDocuments if the application needs to retrieve the fax document.
Your developer can find the available calls and requirements in the WestFax API reference.
If you need help with a setup request or an existing webhook, let us know what you’re trying to accomplish and we’ll help you with the next step.