1. CALL_ROUTED
| Event | CALL_ROUTED | |
| Description | Triggered when a new call is initiated and successfully routed by the Nexbro IP-PBX system. This event indicates that the call has entered the system, routing rules have been applied, and the call is being directed to its initial destination (such as an extension, queue, IVR, or gateway). | |
| Payload Example | ||
| Payload Parameter | Parameter Description | Example |
| event | The name of the webhook event. | CALL_ROUTED |
| call_uuid | A unique identifier for the call, used to track the entire call lifecycle | c63fe6f8-0f61-4896-87a2-adc05e06ac36 |
| call_session_uuid | A unique identifier for the specific call session, useful for correlating multiple related calls. | c63fe6f8-0f61-4896-87a2-adc05e06ac36 |
| caller_id_number | The caller’s number from which the call is originated. | 234 |
| destination_number | The number or extension to which the call is being routed (the callee). | 8556900900 |
| timestamp | The date and time when the event was triggered. | 2026-01-27 12:02:30 |
2. CALL_RINGING
| Event | CALL_RINGING | |
| Description | Triggered when the destination endpoint (extension, queue, or external number) starts ringing for an initiated call. This event indicates that the call has been successfully routed and is waiting to be answered by the callee. | |
| Payload Example | ||
| Payload Parameter | Parameter Description | Example |
| event | The name of the webhook event. | CALL_RINGING |
| call_uuid | A unique identifier for the call, used to track the entire call lifecycle | c63fe6f8-0f61-4896-87a2-adc05e06ac36 |
| call_session_uuid | A unique identifier for the specific call session, useful for correlating multiple related calls. | c63fe6f8-0f61-4896-87a2-adc05e06ac36 |
| caller_id_number | The caller’s number from which the call is originated. | 234 |
| destination_number | The number or extension that is ringing (the callee). | 8556900900 |
| timestamp | The date and time when the event was triggered. | 2026-01-27 12:02:30 |
3. CALL_ANSWER
| Event | CALL_ANSWER | |
| Description | Triggered when a ringing call is successfully answered by the destination party. This event indicates that the call has been connected and media flow has started between the caller and the callee. | |
| Payload Example | ||
| Payload Parameter | Parameter Description | Example |
| event | The name of the webhook event. | CALL_ANSWER |
| call_uuid | A unique identifier for the call, used to track the entire call lifecycle | c63fe6f8-0f61-4896-87a2-adc05e06ac36 |
| call_session_uuid | A unique identifier for the specific call session, useful for correlating multiple related calls. | c63fe6f8-0f61-4896-87a2-adc05e06ac36 |
| caller_id_number | The caller’s number from which the call is originated. | 234 |
| destination_number | The number or extension that answered the call (callee). | 8556900900 |
| timestamp | The date and time when the event was triggered. | 2026-01-27 12:02:30 |
4. CALL_HANGUP
| Event | CALL_HANGUP | |
| Description | Triggered when an active call is terminated by either the caller or the callee. This event indicates the end of the call lifecycle and can be used for call completion tracking, reporting, billing, or cleanup operations in external systems. | |
| Payload Example | ||
| Payload Parameter | Parameter Description | Example |
| event | The name of the webhook event. | CALL_HANGUP |
| call_uuid | A unique identifier for the call, used to track the entire call lifecycle | c63fe6f8-0f61-4896-87a2-adc05e06ac36 |
| call_session_uuid | A unique identifier for the specific call session, useful for correlating multiple related calls. | c63fe6f8-0f61-4896-87a2-adc05e06ac36 |
| caller_id_number | The caller’s number from which the call is originated. | 234 |
| destination_number | The number or extension involved in the call that was disconnected. | 8556900900 |
| timestamp | The date and time when the event was triggered. | 2026-01-27 12:02:30 |
5. CALL_INPUT
| Event | CALL_INPUT | |
| Description | Triggered when a caller presses one digit(s) during an active call (DTMF input). | |
| Payload Example | ||
| Payload Parameter | Parameter Description | Example |
| event | The name of the webhook event. | CALL_INPUT |
| call_uuid | A unique identifier for the call, used to track the call lifecycle | c63fe6f8-0f61-4896-87a2-adc05e06ac36 |
| call_session_uuid | A unique identifier for the specific call session, useful for correlating multiple related calls. | c63fe6f8-0f61-4896-87a2-adc05e06ac36 |
| caller_id_number | The phone number or extension of the caller who pressed the digits. | 234 |
| destination_number | The number or extension that received the call (callee). | 8556900900 |
| digit | The digits pressed by the caller during the call | |
| digit_duration | The duration (in milliseconds) for which each DTMF digit was pressed. | 2000 |
| timestamp | The date and time when the event was triggered. | 2026-01-27 12:02:30 |
6. CALL_HOLD
| Event | CALL_HOLD | |
| Description | Triggered when an active call is placed on hold by the caller. This event indicates that the media flow is temporarily paused, allowing the call to be resumed later. | |
| Payload Example | ||
| Payload Parameter | Parameter Description | Example |
| event | The name of the webhook event. | CALL_HOLD |
| call_uuid | A unique identifier for the call, used to track the call lifecycle | c63fe6f8-0f61-4896-87a2-adc05e06ac36 |
| call_session_uuid | A unique identifier for the specific call session, useful for correlating multiple related calls. | c63fe6f8-0f61-4896-87a2-adc05e06ac36 |
| caller_id_number | The phone number or extension of the caller. | 234 |
| destination_number | The number or extension that was put on hold. | 8556900900 |
| timestamp | The date and time when the event was triggered. | 2026-01-27 12:02:30 |
7. CALL_UNHOLD
| Event | CALL_UNHOLD | |
| Description | Triggered when a caller presses one digit(s) during an active call (DTMF input). This event is typically used in IVR menus or call flows to capture user input and determine the next action, such as routing the call, playing a message, or invoking an external system. | |
| Payload Example | ||
| Payload Parameter | Parameter Description | Example |
| event | The name of the webhook event. | CALL_UNHOLD |
| call_uuid | A unique identifier for the call, used to track the call lifecycle | c63fe6f8-0f61-4896-87a2-adc05e06ac36 |
| call_session_uuid | A unique identifier for the specific call session, useful for correlating multiple related calls. | c63fe6f8-0f61-4896-87a2-adc05e06ac36 |
| caller_id_number | The phone number or extension of the caller who pressed the digits. | 234 |
| destination_number | The number or extension that was resumed from hold. | 8556900900 |
| timestamp | The date and time when the event was triggered. | 2026-01-27 12:02:30 |
