New Feature: We're Updating our Fax Webhooks

17, Feb 2021

New Features: We're updating our fax webhooks

Page Count Webhook Updates

At Telnyx we’re all about transparency. That’s why we’re adding a helpful new feature to our Fax API.

As our fax customers know, we bill our fax product by the page but, until now, we haven’t included the page number in the fax resources or the webhook that gets delivered to the user. We recognize that this could make it unnecessarily difficult to reconcile invoices and organize internal billing for our customers.

With that said, we’ll soon be introducing a page_count parameter on both the fax resources and the inbound and outbound webhooks. We hope this will help users to keep track of their fax invoicing and billing.

The new webhooks with the page count field will look like:

Inbound Webhook Example

{
  "data": {
   "event_type": "fax.media.processing.started",
   "id": "ebe6b30f-69fc-4f5d-8e2b-d0705ad53c77",
   "occurred_at": "2021-02-11T10:30:52.578108Z",
   "payload": {
    "connection_id": "1453742805816968295",
    "direction": "inbound",
    "fax_id": "359c0d23-fe39-49f1-8814-f7490197a576",
    "from": " 13122010119",
    "page_count": 2,
    "status": "media.processing",
    "to": " 13127283148",
    "user_id": "9fd26e62-38b3-4fa3-87df-5a9a2c62037e"
    },
   "record_type": "event"
   },
  "meta": {
   "attempt": 1,
   "delivered_to": "insertLocalHost/test/callback/status"  
   }
}

Outbound Webhook Example

{
  "data": {
  "event_type": "fax.delivered",
  "id": "053a9845-f56e-4a11-877e-f9799fda8a8c",
  "occurred_at": "2021-02-11T10:30:52.463128Z",
  "payload": {
    "call_duration_secs": 30,
    "connection_id": "1453742805816968295",
    "direction": "outbound",
    "fax_id": "b8278a9b-a112-4152-bb7e-d6610b0d20f3",
    "from": " 13122010119",
    "original_media_url": "insert URL",
    "page_count": 2,
    "status": "delivered",
    "to": " 13127283148",
    "user_id": "9fd26e62-38b3-4fa3-87df-5a9a2c62037e"
   },
  "record_type": "event"
   },
  "meta": {
  "attempt": 1,
  "delivered_to": "local host/test/callback/status"
   }
}

This change will be made effective on February 19th, 2021.

You can stay up to date with any changes to our Fax API by keeping an eye on the docs on our developer center.

As always, if you have any questions feel free to reach out to our support team- they’re on call 24/7/365.