3CX WebAPI & Webhook FAQ

3CX WebAPI & Webhook is installed on the 3CX server as a service (Windows) or daemon (Debian) and talks to the 3CX core at 127.0.0.1. Your CRM or any other system sends HTTP requests to the API from any IP address, and 3CX events (webhooks) can be sent to any address. See the API documentation and the Webhook documentation.

WebAPI significantly reduces the time needed to integrate 3CX with a CRM or Service Desk system. In our experience, an integration takes 1–2 weeks.

According to the official 3CX feature list, the 3CX API for call control (XAPI / Call API) is available only in the 3CX AI edition. 3CX WebAPI works with the Basic, PRO and AI editions and gives simple HTTP access with JSON responses.

Any system that can send HTTP requests. Our partners have built integrations with Creatio, Zendesk, Zoho, MS CRM, SAP CRM, Freshdesk and Odoo ERP. Ready-made solutions: Creatio 3CX Connector, 3CX Zendesk integration and the universal integration module for 3CX and any CRM.

Yes. The makecall method first calls the user's extension and then the customer's number. You can also answer, transfer, drop and record calls — see Call control.

The Webhook generator sends 3CX call events to your system in real time. The list of events and examples are in the Webhook documentation.

Yes. Download the Postman collection from the API documentation, set the 3CXFQDN and AccessKey variables and send requests.

The SQL module gives read access to the 3CX database through the API: call history (CDR), reports, missed calls, recordings and more. See SQL API.

3CX V18 and V20, editions Basic, PRO and AI, on Debian and Windows. 3CX ended support for V18 at the end of 2024, so we recommend V20.

Yes, if you manage the server yourself: your own server or a VPS (AWS, Azure, Google Cloud, DigitalOcean and others). WebAPI is installed as an additional service next to 3CX, so it cannot be installed on systems hosted by 3CX (Hosted by 3CX).

Download the installation script for Debian or Windows from the Quick start page and run it on the server where 3CX is installed and activated. Installation guides are on the same page.

Licenses are annual and priced by the number of simultaneous calls (SC). WebAPI starts at €199 per year for 8 SC; bundles with Webhook and SQL are also available. The WebAPI license must cover the same number of SC as your 3CX license: with fewer SC, requests to the 3CX core will fail. Support is included, taxes and VAT are not. See Pricing or buy by credit card.

Yes, 15 days. Use the universal trial code from the Quick start page or request a trial license on the 3CX WebAPI page.

Yes. We have no access to your 3CX unless you give it, and no data is sent outside your server except the events you send to your own systems with webhooks. API access is protected by access keys with four levels: get (read data), set (change settings), full (call control and extension management) and system (system parameters). Create a separate key for each integration and give it the lowest level it needs.

Keys are listed in the AuthKeys.csv file of the module, one key per line: key;email;name;access. After you edit the file, reload it with the csv.reread method.