Webhook Basic Playloads

Base Payload

  • hook_event: The type of hook being fired
  • call_direction: “inbound” or “outbound”, relative to Flex UC
  • timestamp: Gregorian timestamp of the event
  • account_id: ID of the account generating the event
  • request: SIP Request
  • to: SIP To
  • from: SIP From
  • call_id: SIP Call ID
  • other_leg_call_id: If bridged, the Call ID of the other leg
  • caller_id_name: Caller ID Name
  • caller_id_number: Caller ID Number
  • callee_id_name: Callee Name
  • callee_id_number: Callee Number

Most of these fields should be present on all payloads.

Hook Specific

  • channel_create
    • hook_event: channel_create
  • channel_answer
    • hook_event: channel_answer
  • channel_destroy
    • hook_event: channel_destroy
    • hangup_cause: SIP Hangup Cause (NORMAL_CLEARING, ORIGINATOR_CANCEL, etc)
    • hangup_code: SIP Hangup Code (404, 503, etc)
  • doc
    • hook_event: doc
    • action: doc_created, doc_updated, doc_deleted
    • type: user, vmbox, callflow, account, device, faxbox, media
Updated on August 18, 2020

Was this article helpful?

Related Articles