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​

call:live:progress​

Triggered when an ongoing call starts or gets updated.

Example
{
  "id": "it_w000001_1721984075.0",
  "pbx": "000000000001",
  "company": "it_w000001",
  "time": 1721984076400,
  "type": "call:live:progress",
  "integrationId": "pa67xt",
  "data": {
    "id": "it_w119417_1721984075.0",
    "pbx": "000000000001",
    "time": 1721984076338,
    "company": "it_w000001",
    "licenses": [
      "x-bees"
    ],
    "event": "call",
    "eventTrigger": "call.start",
    "start": "2024-07-26T08:54:36.337Z",
    "flows": [
      {
        "flowIndex": 0,
        "duration": 0,
        "connectTime": 0,
        "talkTime": 0,
        "waitTime": 0,
        "caller": {
          "type": "LOCAL",
          "phone": "230",
          "name": "John Doe",
          "email": "johndoe@example.com",
          "userId": "1236286",
          "userExtension": "230",
          "userDepartment": "Sales",
          "groupId": "1238467",
          "groupName": "Gamma",
          "userAgent": "x-bees Web 1.76.0.1000420 76c54617-c30a-4410-acd0-8d4657344284",
          "userDevice": "XBEES_WEB",
          "role": "AGENT",
          "license": "premium"
        },
        "destination": "+159255512345",
        "direction": "INTERNAL",
        "remotePhone": "+159255512345",
        "status": "HOLD"
      }
    ]
  }
}
Example
{
  "id": "it_w000001_1721914831.368",
  "pbx": "000000000001",
  "company": "it_w000001",
  "time": 1721914832032,
  "type": "call:live:progress",
  "integrationId": "pa67xt",
  "data": {
    "id": "it_w000001_1721914831.368",
    "pbx": "000000000001",
    "time": 1721914831953,
    "company": "it_w000001",
    "licenses": [
      "x-bees"
    ],
    "event": "call",
    "eventTrigger": "call.update",
    "start": "2024-07-25T13:40:31.753Z",
    "flows": [
      {
        "flowIndex": 0,
        "duration": 0,
        "connectTime": 0,
        "talkTime": 0,
        "waitTime": 252,
        "caller": {
          "type": "LOCAL",
          "phone": "230",
          "name": "John Doe",
          "email": "johndoe@example.com",
          "userId": "1236286",
          "userExtension": "230",
          "userDepartment": "Sales",
          "groupId": "1238467",
          "groupName": "Gamma",
          "userAgent": "x-bees Web 1.75.0.990867 21f92f6c-91fb-4a85-8fd9-2671a769f290",
          "userDevice": "XBEES_WEB",
          "role": "AGENT",
          "license": "premium"
        },
        "destination": "+159255512345",
        "direction": "INTERNAL",
        "trunkName": "SIPTRUNK",
        "trunkDirection": "outgoing",
        "tags": [
          "External"
        ],
        "remotePhone": "+159255512345",
        "status": "CONNECTING",
        "statusChangeDate": "2024-07-25T13:40:31.953Z"
      }
    ]
  }
}
Example
{
  "id": "it_w000001_1721914831.368",
  "pbx": "000000000001",
  "company": "it_w000001",
  "time": 1721914834620,
  "type": "call:live:progress",
  "integrationId": "pa67xt",
  "data": {
    "id": "it_w000001_1721914831.368",
    "pbx": "000000000001",
    "time": 1721914834555,
    "company": "it_w000001",
    "licenses": [
      "x-bees"
    ],
    "event": "call",
    "eventTrigger": "call.transcription",
    "start": "2024-07-25T13:40:31.753Z",
    "flows": [
      {
        "flowIndex": 0,
        "duration": 0,
        "connectTime": 324,
        "talkTime": 0,
        "waitTime": 252,
        "caller": {
          "type": "LOCAL",
          "phone": "230",
          "name": "John Doe",
          "email": "johndoe@example.com",
          "userId": "1236286",
          "userExtension": "230",
          "userDepartment": "Sales",
          "groupId": "1238467",
          "groupName": "Gamma",
          "userAgent": "x-bees Web 1.75.0.990867 21f92f6c-91fb-4a85-8fd9-2671a769f290",
          "userDevice": "XBEES_WEB",
          "role": "AGENT",
          "license": "premium"
        },
        "callee": {
          "type": "REMOTE",
          "phone": "+159255512345",
          "name": "+159255512345",
          "role": "CLIENT"
        },
        "destination": "+159255512345",
        "direction": "OUTBOUND",
        "trunkName": "SIPTRUNK",
        "trunkDirection": "outgoing",
        "tags": [
          "External"
        ],
        "recordings": [
          "2024.07.25-15.40.31-230-+159255512345[pbx]-3644f-0.wav"
        ],
        "recordingsData": [
          {
            "fileName": "2024.07.25-15.40.31-230-+159255512345[pbx]-3644f-0.wav",
            "start": 1721914832404,
            "end": 0,
            "owner": "SYSTEM"
          }
        ],
        "remotePhone": "+159255512345",
        "transcriptionStatus": "AVAILABLE",
        "transcriptionLanguage": "en-GB",
        "status": "TALKING",
        "statusChangeDate": "2024-07-25T13:40:32.253Z"
      }
    ]
  }
}

call:live:completed​

Triggered when a call ends.

Example
{
  "id": "it_w000001_1721914831.368",
  "pbx": "000000000001",
  "company": "it_w000001",
  "time": 1721914838621,
  "type": "call:live:completed",
  "integrationId": "pa67xt",
  "data": {
    "id": "it_w000001_1721914831.368",
    "pbx": "000000000001",
    "time": 1721914838558,
    "company": "it_w000001",
    "licenses": [
      "x-bees"
    ],
    "event": "call_complete",
    "flows": 1
  }
}

call:live:interrupted​

Triggered when a call ends due to an error.

Example
{
  "id": "it_w000001_1723649449.8",
  "pbx": "000000000001",
  "company": "it_w000001",
  "time": 1723656653217,
  "type": "call:live:interrupted",
  "integrationId": "pa67xt",
  "data": {
    "id": "it_w000001_1723649449.8",
    "pbx": "000000000001",
    "time": 1723656651089,
    "company": "it_w000001",
    "licenses": [
      "x-bees"
    ],
    "event": "call_interrupted",
    "flows": 2
  }
}

call:live:transcription​

Triggered when a new transcription segment for the call is available.

Example
{
  "id": "it_w000001_1721914831.368",
  "pbx": "000000000001",
  "company": "it_w000001",
  "time": 1721914838621,
  "type": "call:live:transcription",
  "integrationId": "pa67xt",
  "data": {
    "id": "it_w000001_1721914831.368",
    "pbx": "000000000001",
    "time": 1721914838559,
    "company": "it_w000001",
    "licenses": [
      "x-bees"
    ],
    "event": "call_transcription",
    "flowIndex": 0,
    "flowStartTime": 1721914831583,
    "callStartTime": 1721914831583,
    "chunk": {
      "id": "683f995c-9066-4b9c-8e2b-23344bbe1d4b",
      "time": 1721914834408,
      "text": "Well, this is impressive, if not unexpect",
      "speaker": "callee",
      "language": "en-GB",
      "isFinal": true,
      "start": 1721914832226,
      "end": 1721914837046
    },
    "participant": {
      "type": "REMOTE",
      "phone": "+159255512345",
      "name": "+159255512345",
      "role": "CLIENT"
    }
  }
}

call:start deprecated​

Triggered when a call starts.

Example
{
  "id": "it_w000001_1721914831.368",
  "pbx": "000000000001",
  "company": "it_w000001",
  "time": 1721914831821,
  "type": "call:start",
  "integrationId": "pa67xt",
  "data": {
    "caller": {
      "phone": "230",
      "name": "John Doe",
      "company": null,
      "email": "johndoe@example.com",
      "userId": "4516286",
      "userExtension": "230",
      "userDepartment": "Sales",
      "groupId": "4258467",
      "groupName": "Gamma",
      "userAgent": "x-bees Web 1.75.0.990867 21f92f6c-91fb-4a85-8fd9-2671a769f290",
      "userDevice": "XBEES_WEB",
      "type": "local",
      "role": "agent",
      "license": "premium"
    },
    "callee": [],
    "service": null,
    "destination": "+159255512345",
    "trunkName": null,
    "queueId": null,
    "queueName": null,
    "tags": [],
    "flags": [],
    "status": "hold",
    "endCause": null,
    "endCauseStr": null,
    "endBy": ""
  }
}

call:update deprecated​

Triggered when a call gets updated.

Example
{
  "id": "it_w000001_1721914831.368",
  "pbx": "000000000001",
  "company": "it_w000001",
  "time": 1721914834621,
  "type": "call:update",
  "integrationId": "pa67xt",
  "data": {
    "caller": {
      "phone": "230",
      "name": "John Doe",
      "company": null,
      "email": "johndoe@example.com",
      "userId": "4516286",
      "userExtension": "230",
      "userDepartment": "Sales",
      "groupId": "4258467",
      "groupName": "Gamma",
      "userAgent": "x-bees Web 1.75.0.990867 21f92f6c-91fb-4a85-8fd9-2671a769f290",
      "userDevice": "XBEES_WEB",
      "type": "local",
      "role": "agent",
      "license": "premium"
    },
    "callee": {
      "phone": "+159255512345",
      "name": "+159255512345",
      "company": null,
      "email": null,
      "userId": null,
      "userExtension": null,
      "userDepartment": null,
      "groupId": null,
      "groupName": null,
      "userAgent": null,
      "userDevice": null,
      "type": "remote",
      "role": "client"
    },
    "service": null,
    "destination": "+159255512345",
    "trunkName": "SIPTRUNK",
    "queueId": null,
    "queueName": null,
    "tags": [
      "External"
    ],
    "flags": [],
    "status": "talking",
    "endCause": null,
    "endCauseStr": null,
    "endBy": ""
  }
}

call:end deprecated​

Triggered when a call ends.

Example
{
  "id": "it_w000001_1721914831.368",
  "pbx": "000000000001",
  "company": "it_w000001",
  "time": 1721914841622,
  "type": "call:end",
  "integrationId": "pa67xt",
  "data": {
    "caller": {
      "phone": "230",
      "name": "John Doe",
      "company": null,
      "email": "johndoe@example.com",
      "userId": "4516286",
      "userExtension": "230",
      "userDepartment": "Sales",
      "groupId": "4258467",
      "groupName": "Gamma",
      "userAgent": "x-bees Web 1.75.0.990867 21f92f6c-91fb-4a85-8fd9-2671a769f290",
      "userDevice": "XBEES_WEB",
      "type": "local",
      "role": "agent",
      "license": "premium"
    },
    "callee": {
      "phone": "+159255512345",
      "name": "+159255512345",
      "company": null,
      "email": null,
      "userId": null,
      "userExtension": null,
      "userDepartment": null,
      "groupId": null,
      "groupName": null,
      "userAgent": null,
      "userDevice": null,
      "type": "remote",
      "role": "client"
    },
    "service": null,
    "destination": "+159255512345",
    "trunkName": "SIPTRUNK",
    "queueId": null,
    "queueName": null,
    "tags": [
      "External"
    ],
    "flags": [],
    "status": "",
    "endCause": "16",
    "endCauseStr": "Normal Clearing",
    "endBy": "caller"
  }
}