• Please contact us to enable webhooks on your account
• Once enabled, webhook settings can be found within the Channel tab of the editor for both Page and Plugin channels:
  

• Example response body:

{  
"vox": {    
  "id":1733234,
  "summary_text": "Vox received from Alice via Webhook test at 08:58 (UTC) on 03/09/2021",
  "send_time": "2021-09-03T08:58:26.146Z",
  "contact_email": "alicewebhook@telbee.io",
  "contact_phone": "",
  "channel_name": "Webhook test",
  "channel_public_name": "Webhook test",
  "duration": 3,
  "vox_context": null,
  "channel_id": 8838,
  "recording_url":"https://api-dev.telbee.io/rails/active_storage/blobs/eyJfcmFpbHMdjKyHIoVzc2FnZSI6IkJBaHBBaFpOIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--589003589351091741b1a56914c3856dbc2ad27b/Fri%20Sep%2003%202021%2009-58-23%20GMT+0100%20(British%20Summer%20Time)",   "direction": "vox_in",
  "channel_status": "active",
  "transcription_state": "transcribed",
  "vox_no": 4,
  "sending_user": null,
  "contact_name": "Alice",
  "contact_id": 78214,
  "actual_transcription": "I'm testing the webhook channel now.",
  "transcription_language": "en-US",
  "conversation_inbox_url": "https://app.telbee.io/inbox?token=QUQ7MCGJrRipk5gwSmgeT8S8",
  "sending_user_id": null  
  }
}

• Notes on fields:

• id: Unique id of vox (immutable)
• ‍summary_text: Summary message, eg for use in activity feeds
• ‍send_time: Date and time vox sent
• vox_no: Index in conversation (at time vox sent). If 1, then this is a new conversation
• duration: Length of vox in seconds
• ‍direction: "vox_in" for inbound voxes sent by end users. "vox_out" for outbound voxes sent by telbee users
• recording_url: URL of mp3 of vox
• conversation_inbox_url: Deep link directly to this conversation in the inbox
• transcription_state: "transcribed" if vox transcribed automatically (if channel set to do so and duration more than 2 seconds), or "not_transcribed" if not
• transcription_language: Language code used for transcription (as per channel setting)
• actual_transcription: Transcription text if transcribed automatically
• ‍vox_context: Any additional content sent with vox, as HTML
• contact_id: Unique id of contact (immutable)
• contact_name: Name of end user sending or receiving vox (if available, as at time of vox)
• contact_email: Email address of end user sending or receiving vox (if available, as at time of vox)
• contact_phone:  Phone number of end user sending or receiving vox (if available, as at time of vox)
• ‍sending_user_id: Unique id of sending user (immutable, outbound voxes only)
• sending_user: Name of sending user (at time vox sent, outbound voxes only)
• channel_id: Unique id of channel through which vox sent (immutable)
• channel_name: Internal name of channel through which vox sent (as at time of vox)
• channel_public_name:  Public name of channel through which vox sent (as at time of vox)
• channel_status: "active" or "inactive" (as at time of vox - outbound voxes and inbound replies in existing conversations can still be sent while a channel is inactive, but new conversations cannot be started)