Webhooks

Webhooks are a powerful way to receive real-time notifications about events in the Voxtelesys Fax API. By configuring a webhook endpoint, your application can automatically respond to key events such as the successful delivery of an outbound fax or the receipt of an inbound fax. This eliminates the need for polling and allows for seamless integration into your workflows.

For a general overview of how webhooks work, refer to the Webhooks overview.

Fax Webhooks

For the Fax API, webhooks are triggered in the following scenarios:

• Receiving a Fax: A webhook is sent once the fax has been fully received, and the fax is available for download via provided URL.
• Sending a Fax: A webhook is sent upon the completion of the fax transmission, regardless of whether it was successful or failed.

Fax Webhook Payload

The following data will be posted via HTTP request to your configured webhook endpoint.

Property	Type	Required	Description
type	string	true	Callback type. Always fax.
id	string	true	ID of fax.
direction	string	true	Direction of fax.
to	string	true	Recipient of fax.
from	string	true	Sender of fax.
status	string	true	A descriptive status for the fax.
time	string	true	Timestamp of fax.
pages	string	true	The number of pages associated with fax.
duration	string	true	The duration of the fax, in seconds.
url	string	false	Public URL of file used to send fax.
links	string	false	Object containing related data.
links[].media	string	false	Linked media, if applicable.
error	string	false	Object containing error information, if applicable.
error.code	string	false	Error code.
error.description	string	false	Error description.

Configuration

To enable webhooks for your faxing application, you must configure a Fax Profile within the Voxtelesys Portal. This involves specifying the HTTP Event Type and providing the URL of your webhook endpoint.

Steps to Configure a Fax Profile:

1. Log in to the Voxtelesys Portal.
2. Navigate to the Fax Profiles section.
3. Create a new Fax Profile or edit an existing one.
4. Set the Event Type to HTTP.
5. Enter the URL of your webhook endpoint in the designated field.
6. Save the profile to apply the changes.

Note: Ensure that your webhook endpoint is publicly accessible and supports HTTPS for secure communication. Additionally, your endpoint should be capable of handling the payload structure described in the Fax Webhook Payload section.