Skip to main content

Webhooks

By using webhooks, you can tightly integrate your server application with Wildix. The platform supports two kinds of webhooks: HTTP and AWS SQS.

HTTP webhooks follow the common set of rules:

  • Webhook should be reachable from the public internet. Tunneling services like Ngrok are supported
  • Webhook should accept HTTP POST requests with JSON payload
  • Webhook should respond with response codes from 200 to 299
  • Webhook should respond as fast as possible. The exact time given for the response varies between webhook types
  • Webhook should be ready to accept the same call multiple times: in case of network or remote server failure Wildix Service could retry the request

Events​

presence:user​

Triggered when a user changes their presence status.

Example
{
  "id": "it_w000001_230",
  "pbx": "000000000001",
  "company": "it_w000001",
  "time": 1721832358745,
  "type": "presence:user",
  "integrationId": "79qvia",
  "data": {
    "extension": "230",
    "email": "johndoe@example.com",
    "sourceId": "",
    "status": "dnd",
    "until": "2024-07-24T21:59:00Z",
    "message": "Meeting",
    "location": {
      "address": "",
      "lat": "",
      "lng": ""
    }
  }
}

presence:telephony​

Triggered when a user changes their "On the call" status.

Example
{
  "id": "it_w000001_1721832323019_230",
  "pbx": "000000000001",
  "company": "it_w000001",
  "time": 1721832323420,
  "type": "presence:telephony",
  "integrationId": "79qvia",
  "data": {
    "extension": "230",
    "email": "johndoe@example.com",
    "sourceId": "",
    "status": "talking"
  }
}

presence:conference​

Triggered when a user joins or leaves a conference, updating their presence status.

Example
{
  "id": "it_w000001_230",
  "pbx": "000000000001",
  "company": "it_w000001",
  "time": 1721832379338,
  "type": "presence:conference",
  "integrationId": "79qvia",
  "data": {
    "extension": "230",
    "isJoined": true,
    "isLeaved": false,
    "participant": {
      "type": "XBS",
      "jid": "jid@conference-xmpp.wildix.com/f3114d96",
      "name": "John Doe",
      "email": "johndoe@example.com",
      "department": "Sales",
      "company": "it_w000001",
      "pbxSerial": "000000000001",
      "pbxExtension": "230",
      "pbxGroupId": "4258467",
      "xbsId": "jDo1hnOE337x",
      "license": "premium"
    }
  }
}