Webhooks

Webhooks

What is a Webhook?

webhook allows your phone system to send real-time data or notifications to an external application (usually your own server or a third-party platform). It acts as a trigger: when a specific event occurs—such as an incoming call, voicemail, or missed call—the system sends that event’s data to the designated URL, enabling seamless integration with tools like CRMs, ticketing systems, or analytics dashboards.

Example: You could use a webhook to send call data to your CRM every time a new call comes in, automatically creating a contact log or support ticket.



Creating a New Webhook


1. From the main menu on the left, navigate to: "UC Admin" "Settings & Security" "Webhooks"



2. Select “+ Add Webhook” in the upper-right corner.



3. Complete the form with the following required information:
  1. Assigned Account (if applicable): Select the account this webhook belongs to. This field only appears if you have not already selected an account from the main dropdown at the top right of the page.
  2. Label: Enter a name used for internal identification (e.g. "Call Notifications to CRM").
  3. Destination URL: Enter the full URL where data should be sent (e.g., https://yourcrm.com/api/call-events).
  4. Method: Choose the HTTP method:
    1. POST – Sends the data in the body of the request.
    2. GET – Appends the data to the URL as query parameters.



4. Select the “Add” in the lower-right to save and activate the webhook.

5. Once the webhook is created, you’ll be redirected to a page where you can further customize it (see next section).



Managing Existing Webhooks



1. From the main menu on the left, navigate to: "UC Admin"  "Settings & Security"  "Webhooks"



2. Click on the Account Name, or use the Account dropdown (top right) to filter and ensure you're viewing webhooks tied to the appropriate account.



3. From the list of webhooks, select the webhook name, or the three vertical dots to the right of the webhook and select Edit.



4. You'll have access to several configuration tabs on the Edit page.
  1. On the left side of the Edit page, you can customize:
    1. Label: Change the name used to identify the webhook.
    2. Description & Notes: Add or update internal details for documentation or clarification.
    3. Events: Select specific system events that should trigger this webhook.
      1. Leave this field empty to allow the webhook to listen to all available events.
      2. Use the dropdown to choose only the events you want to trigger the webhook (e.g., call started, call ended, voicemail received).



  1. On the right side of the Edit page, you can:
    1. Add a new destination: Provide a new URL where event data will be sent.
    2. Edit an existing destination: Update the destination URL or method (POST/GET).
    3. Delete a destination: Remove any no-longer-needed endpoints.



Idea
Tip: If your webhook sends data to multiple systems (e.g., CRM + Helpdesk), you can assign multiple destinations to a single webhook for broader coverage.

AlertBe sure to click “Update” at the bottom of the screen to save your changes before navigating away.  

    • Related Articles

    • Webhooks (Real-Time Events)

      Webhooks are useful for receiving events from the phone system, in real-time, in the form of a POSTed data to your own API. Please note, some webhooks are JSON and some are URLENCODED. --- SMS / MMS Messages (JSON) Setup: Call Routing > Inbound > ...
    • eFax (V2)

      Sending a Fax: REQUEST: POST https://pbx.primevox.net/api/fax_send.php NOTE: All parameters are Case Sensitive and must be in the BODY of the POST, URLENCODED. auth is the string of text in the phone system's Advanced menu. It looks like a lot of ...
    • Page Groups

      What is a Page Group? Page Groups allow you to broadcast one-way or two-way audio messages to multiple devices simultaneously. They are commonly used for in-office announcements, department-wide paging, or emergency alerts. Example: A receptionist ...
    • Dial-by-Name Directories

      What Is a Dial-by-Name Directory? A Dial-by-Name Directory allows callers to search for and connect with users by entering the first few letters of their name using a phone keypad. This is especially useful in larger organizations where remembering ...
    • IVR Menus

      What is an IVR Menu? An IVR (Interactive Voice Response) Menu is an automated phone system that allows callers to interact with your organization through voice prompts and keypad inputs. It helps route calls efficiently by guiding callers to the ...