3CX Webhook documentation

We recommend using a free service (https://webhook.site/) to display the received webhook events. Specify the received URL in the TCXWebAPI.ini file. Restart the WebAPI service and track events.
POST Scheme (recommended)

Specify in the TCXWebAPI.ini file:

  • WEBHOOK_URL = for POST requests (default)
  • WEBHOOK_URL_2 = for POST requests (due to Users.csv)

  • RECORDING_FULL_INFO = 1 (1 for enable URL record final request)
  • WEBHOOK_POST_URL = POST request (URL record) (default)
  • WEBHOOK_POST_URL_2 = POST requests (due to Users.csv)

  • POST = 1 for POST scheme, 0 for GET scheme
  • WEBHOOK_URL_MONITOR = for a mirror (shadow) POST request
  • WEBHOOK_POST_URL_MONITOR = for a mirror (shadow) POST request (URL record)

3CX WebAPI will start generating POST webhooks according to the same time as the events
Examples for incoming successful call
Examples for incoming missed call
Examples for outgoing successful call
Examples for outgoing unsuccessful call
GET Scheme

Specify in the TCXWebAPI.ini file:

  • WEBHOOK_URL = for GET requests (default)
  • WEBHOOK_URL_2 = for GET requests (due to Users.csv)

  • RECORDING_FULL_INFO = 1 (1 for enable URL record final request)
  • WEBHOOK_POST_URL = POST request (URL record) (default)
  • WEBHOOK_POST_URL_2 = POST requests (due to Users.csv)

  • POST = 0 for GET scheme, 1 for POST scheme
  • WEBHOOK_URL_MONITOR = for a mirror (shadow) GET request
  • WEBHOOK_POST_URL_MONITOR = for a mirror (shadow) GET request (URL record)

3CX WebAPI will start generating GET webhooks according to the same time as the events
Incoming successful call
Incoming missed call
Outgoing successful call
Outgoing unsuccessful call

Screenshots