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

conference:live:progress

Triggered when an ongoing conference starts or gets updated.

Example

{
  "id": "codeea87-3d59-4d1d-80be-fc4f0260_1721905148868",
  "company": "it_w000001",
  "time": 1721905149199,
  "type": "conference:live:progress",
  "integrationId": "h6bush",
  "data": {
    "id": "codeea87-3d59-4d1d-80be-fc4f0260_1721905148868",
    "time": 1721905149125,
    "company": "it_w000001",
    "event": "conference",
    "start": "2024-07-25T10:59:09.124Z",
    "subject": "Status & Priorities",
    "participants": [
      {
        "type": "XBS",
        "jid": "jid1@stage.conference-xmpp.wildix.com/909fc4fe",
        "name": "John Doe",
        "email": "johndoe@example.com",
        "department": "Sales",
        "company": "it_w000001",
        "pbxSerial": "000000000001",
        "pbxExtension": "25111",
        "pbxGroupId": "4258467",
        "xbsId": "jDo1hnOE337x",
        "license": "premium"
      }
    ]
  }
}

conference:live:join

Triggered when a user joins the conference.

Example

{
  "id": "53ffd896-a0e6-4d0b-bd9c-8e869500-1724154386297",
  "company": "it_w000001",
  "time": 1724154459276,
  "type": "conference:live:join",
  "integrationId": "acmr8w",
  "data": {
    "id": "53ffd896-a0e6-4d0b-bd9c-8e869591-11_1724154386297",
    "time": 1724154459176,
    "company": "it_w000001",
    "event": "conference_join",
    "participant": {
      "type": "XBS",
      "jid": "1cm5lbfxa777@conference-xmpp.wildix.com/7cr9KQyub123",
      "name": "John Doe",
      "email": "johndoe@example.com",
      "department": "Sales",
      "company": "it_w000001",
      "pbxSerial": "000000000001",
      "pbxExtension": "230",
      "pbxGroupId": "4238467",
      "xbsId": "1cm5lbfxANnj",
      "license": "premium"
    }
  }
}

conference:live:leave

Triggered when a user leaves the conference.

Example

{
  "id": "53ffd896-a0e6-4d0b-bd9c-8e869500_1724154386297",
  "company": "it_w000001",
  "time": 1724154454373,
  "type": "conference:live:leave",
  "integrationId": "acmr8w",
  "data": {
    "id": "53ffd896-a0e6-4d0b-bd9c-8e869591-11_1724154386297",
    "time": 1724154454173,
    "company": "it_w000001",
    "event": "conference_leave",
    "participant": {
      "type": "XBS",
      "jid": "1cm5lbfxa777@conference-xmpp.wildix.com/b434e123",
      "name": "John Doe",
      "email": "johndoe@example.com",
      "department": "Sales",
      "company": "it_w000001",
      "pbxSerial": "000000000001",
      "pbxExtension": "230",
      "pbxGroupId": "4238467",
      "xbsId": "1cm5lbfxANnj",
      "license": "premium"
    }
  }
}

conference:live:completed

Triggered when a conference ends.

Example

{
  "id": "codeea87-3d59-4d1d-80be-fc4f0260_1721905354869",
  "company": "it_w000001",
  "time": 1721905376354,
  "type": "conference:live:completed",
  "integrationId": "h6bush",
  "data": {
    "id": "codeea87-3d59-4d1d-80be-fc4f0260_1721905354869",
    "time": 1721905376293,
    "company": "it_w000001",
    "event": "conference_complete",
    "room": "codeea87-3d59-4d1d-80be-fc4f0260"
  }
}

conference:live:interrupted

Triggered when a conference ends due to an error.

Example

"TODO"

conference:live:transcription

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

Example

{
  "id": "codeea87-3d59-4d1d-80be-fc4f0260_1721905148868",
  "company": "it_w000001",
  "time": 1721905243757,
  "type": "conference:live:transcription",
  "integrationId": "h6bush",
  "data": {
    "id": "codeea87-3d59-4d1d-80be-fc4f0260_1721905148868",
    "time": 1721905243695,
    "company": "it_w000001",
    "event": "conference_transcription",
    "conferenceStartTime": 1721905148879,
    "transcriptionStartTime": 1721905242041,
    "chunk": {
      "id": "1234b65d-f2c3-4684-8123-0d16e1d642c7",
      "jid": "jid1@conference-xmpp.wildix.com/f3114d96",
      "text": "Great news.",
      "language": "en-US",
      "isFinal": true,
      "time": 1721905242029,
      "start": 1721905240075,
      "end": 1721905242385,
      "sentiment": "NEUTRAL"
    },
    "participant": {
      "type": "XBS",
      "jid": "jid2@conference-xmpp.wildix.com/f3114d96",
      "name": "John Doe",
      "email": "johndoe@example.com",
      "department": "Sales",
      "company": "it_w000001",
      "pbxSerial": "000000000001",
      "pbxExtension": "230",
      "pbxGroupId": "1238467",
      "xbsId": "jDo1hnOE337x",
      "license": "premium"
    }
  }
}