Document Analysis: Webhooks

Document Analysis

Inbound Fax Analysis

Event

 inbound_fax_with_analysis

Payload

{
  "faxId": "",
  "accountId": "",
  "analysisStatus": "",
  "eventAt": "" 
} 

Description

Push notification event to a partner that an intelligent fax analysis is ready. 

Payload Summary

  • faxId: the unique fax identifier

  • accountId: the unique account identifier 

  • analysisStatus: the status of the intelligent fax analysis for the specified faxId

    • in_progress

    • success

    • error

    • spam

  • eventAt: the timestamp of the intelligent fax analysis