webhook

sashi · 2025-04-07T19:14:41+00:00

There was an error rendering this rich post.

what are the settings which need to be turned on to receive fax image through webhook?

Find more posts tagged with

Note:

If there are Accepted Answers, those will be shown by default. You can switch to 'All Replies' by selecting the tab below.

Accepted answers

All comments

LaurenceLabonté

[Enterprise Name] → Core Fax → Settings → Webhooks → Select existing webhook → Switch to tab "Notifications"

Make sure that "Include Image" is selected for the type of notification that is being tested

sashi

when I select the include image for inbound success the webhook is failing but when I uncheck the Include image, I am getting the metadata from the webhook.

LaurenceLabonté

It's probably a problem with your parsing of the request (or the framework you are using to handle the request). A failed webhook notification mean that we didn't received a 200 OK from the server, so more logging on your side might be needed to troubleshoot the issue.

If you need to further help, enter a support request with the TransactionID for this fax, and we can investigate more.

sashi

Hi, do we get the fax image as well in the webhook request or just the fax metadata as a JSON? what will be the parameter name of fax image if it is sent in the request?

LaurenceLabonté

The Webhook is an HTTP POST request with a content-type of multipart/form-data:
- The first part contains the fax metadata as a JSON
  - Content-Disposition: form-data; name="metadata" Content-Type: application/json; charset=UTF-8
- The second part contains the fax image if enabled (disabled by default).
  - Content-Disposition: form-data; name="attachment"; filename="file.pdf" Content-Type: application/pdf

sashi

Thanks, can content -type for attachment be tiff or only pdf?

sashi

Hello,

I have included the header @RequestHeader("XM-Signature-256") String signature. This signature will be sent to our application by corefax by computing with shared secret and json metadata. what is the algorithm used to computed this signature in corefax?

LaurenceLabonté

Per the administrator guide:

For authentication, OpenText Core Fax adds the header XM-Signature-256:
- The header contains the SHA256 digest of the JSON payload encoded in hexadecimal.
- The digest is computed using the shared secret configured in the Webhook destination.
- If the destination web app wants to authenticate the request, it must also compute the digest on the JSON payload using the shared secret and compare the result with the header XM-Signature-256. If the values differ, they can response with a 400 Bad Request or any preferred type of HTTP error.

Note: On May 15th, with the release of Core Fax 25.2, this will slightly change to be the digest of the concatenation of the URL and the JSON payload (compared to just the JSON payload for now)