Send fax webhooks

This page documents the webhook format for sent faxes. See the webhooks introduction page for background information.

Event Types

For sent faxes, there are currently three event types:

• Fax Completed: This is a postflight webhook, triggered when the fax completes.
• Transmitting Page: This is an inflight webhook, triggered whenever a new page is being transmitted.
• Retry Scheduled: This is an inflight webhook, triggered when a retry has been scheduled for the fax.

Fax Completed Webhook Parameters

Name	Type	Description
fax	Fax Object	The job's fax object.
event_type	String	"fax_completed"

Transmitting Page Webhook Parameters

Name	Type	Description
fax	Fax Object	The job's fax object.
event_type	String	"transmitting_page"
page	Integer	The page that is currently being transmitted.
recipient_phone_number	String	The phone number to which the page is being transmitted, in E.164 format.

Retry Scheduled Webhook Parameters

Name	Type	Description
fax	Fax Object	The job's fax object.
event_type	String	"retry_scheduled"
retry_count	Integer	The number of times a retry has been scheduled for the recipient.
recipient_phone_number	String	The phone number to which the page is being transmitted, in E.164 format.