Fax Events
Receive FAX.STATUS lifecycle updates, including cancellation, and FAX.RECEIVED notifications for completed inbound faxes. Fax and these events are available only in Pinnacle's HIPAA cell.
Delivery is at least once. Verify PINNACLE-SIGNING-SECRET, return HTTP 200 to acknowledge receipt, and deduplicate retries using the stable event id. Do not assume webhook delivery order; fetch GET /fax/{id} when you need the latest state. Fetch the same endpoint for a one-hour signed document URL; webhook payloads never contain document URLs.
Header Parameters
PINNACLE-SIGNING-SECRETstringSecret for verifying the authenticity of the request. It starts with pss- and is unique to the webhook.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Fax webhook notification. FAX.STATUS reports lifecycle changes, and FAX.RECEIVED means an inbound fax is ready.
Webhooks intentionally omit mediaUrl. When fax.hasMedia is true, call the authenticated GET /fax/{fax.id} endpoint to receive a signed document URL that expires after one hour. Treat the URL as sensitive: do not log or store it, and request a new one after it expires.
idstringStable event ID. Deduplicate retries using this value.
typestring"FAX.STATUS""FAX.RECEIVED"