latestOpenAPI 3.1.0MIT2026-08-103050171.2 KB

ebcbb377ee0f

Faxes

Notifications

Incoming fax event

This webhook is triggered when a fax is received on a Sinch number associated with a service. The webhook will contain information about the fax, such as the sender, the recipient, and the content of the fax. You set the callback URL for incoming fax events on the service, either through the dashboard or using the service API.

Example payloads

Multipart/form-data request payloads are encoded as forms with a content type of JSON and the actual fax content as a 'file' application/pdf attachment.

Application/json request payloads are a JSON object with the file encoded as a base64 string as part of the JSON object.

postWebhookincomingFax

Payload

event'INCOMING_FAX' | 'FAX_COMPLETED'

The different events that can trigger a webhook

eventTimestring date-time

Time of the event.

filestring

The base64 encoded file.

fileTypestring

The file type of the attached file.

Example payload

{
  "fax": {
    "id": "01F3J0G1M4WQR6HGY6HCF6JA0K",
    "direction": "OUTBOUND",
    "from": "+15551235656",
    "to": "+15551235656",
    "contentUrl": [
      "www.google.com",
      "www.sinch.com"
    ],
    "price": {
      "currencyCode": "USD",
      "amount": "0.0040"
    },
    "pagesSentSuccessfully": 3,
    "labels": {
      "use-case": "fraudPrevention",
      "costCenter": "sales"
    },
    "callbackUrl": "https://www.my-website.com/callback",
    "coverPageData": {
      "toName": "Acme Corp"
    },
    "projectId": "ae00f005-e392-44dc-b3f5-a657a2684dg3",
    "serviceId": "01GVRB50KEQFFE1SGMPFRNBG6J"
  },
  "file": "{base64_encodedData}",
  "fileType": "PDF"
}

Response

Returns a 200 OK response if the webhook was received successfully.