SIsinch
Notifications
Faxes

Fax completed

Triggered when the fax has been completed. The callback will contain information about the fax, such as the sender, the recipient, and the content of the fax. You must set the callback URL where you want the callback sent when you make a send fax request.

postWebhookfaxCompleted

Payload

event'INCOMING_FAX' | 'FAX_COMPLETED'

The different events that can trigger a webhook

eventTimestring date-time

Time of the event.

Example payload

{
  "fax": {
    "id": "01F3J0G1M4WQR6HGY6HCF6JA0K",
    "direction": "OUTBOUND",
    "from": "+15551235656",
    "to": "+15551235656",
    "contentUrl": [
      "https://www.google.com",
      "https://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"
    },
    "fromCountry": "US",
    "toCountry": "US",
    "projectId": "ae00f005-e392-44dc-b3f5-a657a2684dg3",
    "serviceId": "01GVRB50KEQFFE1SGMPFRNBG6J"
  },
  "files": [
    {
      "file": "{base64-encoded content}"
    }
  ]
}

Response

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

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.