How WestFax Inbound Webhooks (Callbacks) Work


WestFax callbacks are asynchronous, out-of-band requests. When an event occurs — like a fax being received — WestFax calls a URL you specify, passing along relevant parameters. Your endpoint needs to be configured to receive these parameters via either GET or POST (WestFax supports both).

Setting the Callback URL


The callback URL uses templated placeholders that WestFax automatically replaces with real values. The format looks like this:

[get]http://yourweburl.com/{@jobid}?prod={@prodid}&dir={@dir}

WestFax replaces @jobid, @prodid, and @dir with the actual fax job ID, product ID, and direction (inbound/outbound). GET is implied by default — you can omit [get] or switch to [post] to use POST instead.

Key Callback Parameters

Based on the WestFax API, the values passed to your webhook include:

ParameterDescription
@jobidThe unique fax job ID
@prodidThe product/account ID
@dirDirection — Inbound or Outbound

Here is what we need to know.

  1. What is your service's webhook endpoint URL? 
  2. Do you require GET or POST?
  3. Are there any specific parameters or authentication headers your service expects?