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
chat:channel:created
Triggered when a new chat channel is created. You can use the WebhookChatChannelCreatedEvent provided by @wildix/xbees-conversations-client for TypeScript definitions.
Example
{
"id": "12345678-abcd-1234-efgh-1234567890ab",
"type": "chat:channel:created",
"company": "demo_company_12345",
"time": 1719842806700,
"integrationId": "demo_integration_01",
"data": {
"channel": {
"channelId": "demo_channel_001",
"channelType": "group",
"memberCount": 3,
"subject": "Demo Subject",
"description": "This is a demo description.",
"access": "private",
"company": "demo_company_12345",
"service": "demo_service",
"serviceTitle": "Demo Service Title",
"broadcast": false,
"external": true,
"createdAt": "2024-07-01T14:06:43.386258Z",
"updatedAt": "2024-07-01T14:06:43.386258Z"
},
"members": [
{
"id": "demo_member_01",
"createdAt": "2024-07-01T14:06:43.389522Z",
"role": "member"
},
{
"id": "demo_member_02",
"createdAt": "2024-07-01T14:06:43.389522Z",
"role": "member"
}
],
"users": [
{
"id": "demo_user_01",
"name": "John Doe",
"email": "john.doe@example.com",
"picture": "https://example.com/avatar1.png",
"company": "demo_company_12345",
"bot": false,
"pbxExtension": "1001",
"pbxSerial": "demo_serial_001",
"pbxUserId": "user_001",
"createdAt": "2022-12-27T22:58:32.370401Z",
"updatedAt": "2022-12-27T22:58:32.370401Z"
},
{
"id": "demo_user_02",
"name": "Jane Smith",
"email": "jane.smith@example.com",
"locale": "en",
"timeZone": "Europe/London",
"company": "demo_company_54321",
"bot": false,
"pbxDomain": "example.com",
"pbxPort": "443",
"pbxExtension": "1002",
"pbxSerial": "demo_serial_002",
"pbxUserId": "user_002",
"createdAt": "2022-06-06T13:52:46.29224Z",
"updatedAt": "2022-12-24T12:22:48.951455Z"
}
]
}
}
chat:channel:updated
Triggered when a chat channel is updated.
Example
{
"id": "abc12345-6789-1234-defg-56789hijklmn",
"type": "chat:channel:updated",
"company": "demo_company_12345",
"time": 1719844053444,
"integrationId": "demo_integration_02",
"data": {
"channel": {
"channelId": "demo_channel_002",
"channelType": "group",
"memberCount": 3,
"subject": "Demo New Subject",
"description": "This is a demo updated description.",
"access": "private",
"company": "demo_company_12345",
"service": "demo_service",
"serviceTitle": "Demo Service Title",
"broadcast": false,
"external": true,
"createdAt": "2024-07-01T14:06:43.386258Z",
"updatedAt": "2024-07-01T14:27:33.375099Z"
},
"members": [
{
"id": "demo_member_01",
"createdAt": "2024-07-01T14:06:43.389522Z",
"role": "member"
},
{
"id": "demo_member_02",
"createdAt": "2024-07-01T14:06:43.389522Z",
"role": "member"
},
{
"id": "demo_member_03",
"createdAt": "2024-07-01T14:06:43.389522Z",
"role": "owner"
}
],
"users": [
{
"id": "demo_user_01",
"name": "John Doe",
"email": "john.doe@example.com",
"picture": "https://example.com/avatar1.png",
"company": "demo_company_12345",
"bot": false,
"pbxExtension": "1001",
"pbxSerial": "demo_serial_001",
"pbxUserId": "user_001",
"createdAt": "2022-12-27T22:58:32.370401Z",
"updatedAt": "2022-12-27T22:58:32.370401Z"
},
{
"id": "demo_user_02",
"name": "Jane Smith",
"email": "jane.smith@example.com",
"locale": "en",
"timeZone": "Europe/London",
"company": "demo_company_54321",
"bot": false,
"pbxDomain": "example.com",
"pbxPort": "443",
"pbxExtension": "1002",
"pbxSerial": "demo_serial_002",
"pbxUserId": "user_002",
"createdAt": "2022-06-06T13:52:46.29224Z",
"updatedAt": "2022-12-24T12:22:48.951455Z"
},
{
"id": "demo_user_03",
"name": "Alice Johnson",
"email": "alice.johnson@example.com",
"locale": "en",
"timeZone": "Europe/Berlin",
"company": "demo_company_12345",
"bot": false,
"pbxDomain": "example.com",
"pbxPort": "443",
"pbxExtension": "1003",
"pbxSerial": "demo_serial_003",
"pbxUserId": "user_003",
"createdAt": "2022-05-23T12:38:10.574336Z",
"updatedAt": "2024-06-29T10:09:39.101619Z"
}
]
}
}
chat:member:added
Triggered when a new member is added to a chat channel.
Example
{
"id": "demo1234-5678-9101-1121-314151617181",
"type": "chat:member:added",
"company": "demo_company_12345",
"time": 1719844182067,
"integrationId": "demo_integration_03",
"data": {
"channel": {
"channelId": "demo_channel_003",
"channelType": "group",
"memberCount": 4,
"subject": "Demo New Subject",
"description": "This is a demo updated description.",
"access": "private",
"company": "demo_company_12345",
"service": "demo_service",
"serviceTitle": "Demo Service Title",
"broadcast": false,
"external": true,
"createdAt": "2024-07-01T14:06:43.386258Z",
"updatedAt": "2024-07-01T14:27:33.375099Z"
},
"member": {
"id": "demo_user_04",
"createdAt": "2024-07-01T14:29:41.919174Z",
"role": "member"
},
"user": {
"id": "demo_user_04",
"email": "john.travolta@example.com",
"bot": false,
"createdAt": "2022-12-27T19:00:22.677386Z",
"updatedAt": "2022-12-27T19:00:22.677386Z"
}
}
}
chat:member:removed
Triggered when a member is removed from a chat channel.
Example
{
"id": "demo5678-9101-1121-3141-516171819202",
"type": "chat:member:removed",
"company": "demo_company_12345",
"time": 1719844258276,
"integrationId": "demo_integration_04",
"data": {
"channel": {
"channelId": "demo_channel_004",
"channelType": "group",
"memberCount": 3,
"subject": "Demo New Subject",
"description": "This is a demo updated description.",
"access": "private",
"company": "demo_company_12345",
"service": "demo_service",
"serviceTitle": "Demo Service Title",
"broadcast": false,
"external": true,
"createdAt": "2024-07-01T14:06:43.386258Z",
"updatedAt": "2024-07-01T14:27:33.375099Z"
},
"member": {
"id": "demo_member_02",
"createdAt": "2024-07-01T14:06:43.389522Z",
"role": "member"
},
"user": {
"id": "demo_user_02",
"name": "Jane Smith",
"email": "jane.smith@example.com",
"locale": "en",
"timeZone": "Europe/London",
"company": "demo_company_54321",
"bot": false,
"pbxDomain": "example.com",
"pbxPort": "443",
"pbxExtension": "1002",
"pbxSerial": "demo_serial_002",
"pbxUserId": "user_002",
"createdAt": "2022-06-06T13:52:46.29224Z",
"updatedAt": "2022-12-24T12:22:48.951455Z"
}
}
}
chat:message:new
Triggered when a new message is sent in a chat channel.
Example
{
"id": "demo5678-9101-1121-3141-516171819203",
"type": "chat:message:new",
"company": "demo_company_12345",
"time": 1719844426953,
"integrationId": "demo_integration_06",
"data": {
"channel": {
"channelId": "demo_channel_006",
"channelType": "group",
"memberCount": 3,
"subject": "Demo New Subject",
"description": "This is a demo updated description.",
"access": "private",
"company": "demo_company_12345",
"service": "demo_service",
"serviceTitle": "Demo Service Title",
"broadcast": false,
"external": true,
"createdAt": "2024-07-01T14:06:43.386258Z",
"updatedAt": "2024-07-01T14:27:33.375099Z"
},
"members": [
{
"id": "demo_member_01",
"createdAt": "2024-07-01T14:06:43.389522Z",
"role": "member"
},
{
"id": "demo_member_02",
"createdAt": "2024-07-01T14:06:43.389522Z",
"role": "owner"
},
{
"id": "demo_member_03",
"createdAt": "2024-07-01T14:29:41.919174Z",
"role": "member"
}
],
"users": [
{
"id": "demo_user_01",
"name": "John Doe",
"email": "john.doe@example.com",
"picture": "https://example.com/avatar1.png",
"company": "demo_company_12345",
"bot": false,
"pbxExtension": "1001",
"pbxSerial": "demo_serial_001",
"pbxUserId": "user_001",
"createdAt": "2022-12-27T22:58:32.370401Z",
"updatedAt": "2022-12-27T22:58:32.370401Z"
},
{
"id": "demo_user_02",
"name": "Alice Johnson",
"email": "alice.johnson@example.com",
"locale": "en",
"timeZone": "Europe/Berlin",
"company": "demo_company_12345",
"bot": false,
"pbxDomain": "example.com",
"pbxPort": "443",
"pbxExtension": "1003",
"pbxSerial": "demo_serial_003",
"pbxUserId": "user_003",
"createdAt": "2022-05-23T12:38:10.574336Z",
"updatedAt": "2024-06-29T10:09:39.101619Z"
},
{
"id": "demo_user_03",
"email": "john.travolta@example.com",
"bot": false,
"createdAt": "2022-12-27T19:00:22.677386Z",
"updatedAt": "2022-12-27T19:00:22.677386Z"
}
],
"message": {
"messageId": "demo_message_001",
"channelId": "demo_channel_006",
"type": "regular",
"text": "Hi",
"attachments": [],
"mentions": [],
"giphy": null,
"latestReactions": [],
"reactionCounts": {},
"createdAt": "2024-07-01T14:33:46.794077Z",
"user": {
"id": "demo_user_02",
"name": "Alice Johnson",
"email": "alice.johnson@example.com",
"locale": "en",
"timeZone": "Europe/Berlin",
"company": "demo_company_12345",
"bot": false,
"pbxDomain": "example.com",
"pbxPort": "443",
"pbxExtension": "1003",
"pbxSerial": "demo_serial_003",
"pbxUserId": "user_003",
"createdAt": "2022-05-23T12:38:10.574336Z",
"updatedAt": "2024-06-29T10:09:39.101619Z"
},
"quote": null,
"forward": null,
"sms": false,
"silent": false,
"event": null
}
}
}
chat:message:updated
Triggered when a message is updated in a chat channel.
Example
{
"id": "ad8ead16-a4db-41d9-be00-544f19799215",
"type": "chat:message:updated",
"company": "it_w119414",
"time": 1719844625099,
"integrationId": "a2n2on",
"data": {
"channel": {
"channelId": "04523271-0857-47a1-8324-fd28d8e5",
"channelType": "group",
"memberCount": 3,
"subject": "New subject",
"description": "",
"access": "private",
"company": "it_w119414",
"service": "",
"serviceTitle": "",
"broadcast": false,
"external": true,
"createdAt": "2024-07-01T14:06:43.386258Z",
"updatedAt": "2024-07-01T14:27:33.375099Z"
},
"message": {
"messageId": "3c60c272-66ea-4d0f-8ff2-6ceb12ec",
"channelId": "04523271-0857-47a1-8324-fd28d8e5",
"type": "regular",
"text": "Hi Updated",
"attachments": [],
"mentions": [],
"latestReactions": [],
"reactionCounts": {},
"createdAt": "2024-07-01T14:33:46.794077Z",
"updatedAt": "2024-07-01T14:37:04.899615Z",
"user": {
"id": "rTWHJd8kGZev",
"name": "Vadim Carusto CRM",
"email": "vadim.ruban@carusto.com",
"locale": "en",
"timeZone": "Europe/Rome",
"company": "it_w119414",
"bot": false,
"pbxDomain": "crm-test.wildixin.com",
"pbxPort": "443",
"pbxExtension": "32312",
"pbxSerial": "221100007e84",
"pbxUserId": "3431044",
"createdAt": "2022-05-23T12:38:10.574336Z",
"updatedAt": "2024-06-29T10:09:39.101619Z"
},
"quote": null,
"edit": true,
"silent": false
}
}
}
chat:message:deleted
Triggered when a message is deleted from a chat channel.
Example
{
"id": "82f6fb1b-9b7b-4744-a8c0-bcb600819aea",
"type": "chat:message:deleted",
"company": "it_w119414",
"time": 1719844682813,
"integrationId": "a2n2on",
"data": {
"channel": {
"channelId": "04523271-0857-47a1-8324-fd28d8e5",
"channelType": "group",
"memberCount": 3,
"subject": "New subject",
"description": "",
"access": "private",
"company": "it_w119414",
"service": "",
"serviceTitle": "",
"broadcast": false,
"external": true,
"createdAt": "2024-07-01T14:06:43.386258Z",
"updatedAt": "2024-07-01T14:27:33.375099Z"
},
"message": {
"messageId": "3c60c272-66ea-4d0f-8ff2-6ceb12ec",
"channelId": "04523271-0857-47a1-8324-fd28d8e5",
"type": "deleted",
"text": "Hi Updated",
"attachments": [],
"mentions": [],
"latestReactions": [],
"reactionCounts": {},
"createdAt": "2024-07-01T14:33:46.794077Z",
"updatedAt": "2024-07-01T14:37:04.899615Z",
"user": {
"id": "rTWHJd8kGZev",
"name": "Vadim Carusto CRM",
"email": "vadim.ruban@carusto.com",
"locale": "en",
"timeZone": "Europe/Rome",
"company": "it_w119414",
"bot": false,
"pbxDomain": "crm-test.wildixin.com",
"pbxPort": "443",
"pbxExtension": "32312",
"pbxSerial": "221100007e84",
"pbxUserId": "3431044",
"createdAt": "2022-05-23T12:38:10.574336Z",
"updatedAt": "2024-06-29T10:09:39.101619Z"
},
"quote": null,
"edit": true,
"silent": false
}
}
}
chat:reaction:new
Triggered when a user reacts to a message. Reactions: thumbsup, clap, slightly_smiling_face, smiley, heart, eyes, white_check_mark,confused, thumbsdown
Example
{
"id": "a680e65f-2e1d-400d-ad69-bd42efe93500",
"type": "chat:reaction:new",
"company": "it_w119414",
"time": 1719844746898,
"integrationId": "a2n2on",
"data": {
"channel": {
"channelId": "04523271-0857-47a1-8324-fd28d8e5",
"channelType": "group",
"memberCount": 3,
"subject": "New subject",
"description": "",
"access": "private",
"company": "it_w119414",
"service": "",
"serviceTitle": "",
"broadcast": false,
"external": true,
"createdAt": "2024-07-01T14:06:43.386258Z",
"updatedAt": "2024-07-01T14:27:33.375099Z"
},
"message": {
"messageId": "3e83e9d6-dbf5-4999-a2e5-418f746a",
"channelId": "04523271-0857-47a1-8324-fd28d8e5",
"type": "regular",
"text": "Hi",
"attachments": [],
"mentions": [],
"giphy": null,
"latestReactions": [
{
"type": "thumbsup",
"userId": "rTWHJd8kGZev",
"messageId": "3e83e9d6-dbf5-4999-a2e5-418f746a",
"user": {
"id": "rTWHJd8kGZev",
"name": "Vadim Carusto CRM",
"email": "vadim.ruban@carusto.com",
"locale": "en",
"timeZone": "Europe/Rome",
"company": "it_w119414",
"bot": false,
"pbxDomain": "crm-test.wildixin.com",
"pbxPort": "443",
"pbxExtension": "32312",
"pbxSerial": "221100007e84",
"pbxUserId": "3431044",
"createdAt": "2022-05-23T12:38:10.574336Z",
"updatedAt": "2024-06-29T10:09:39.101619Z"
}
}
],
"reactionCounts": {
"thumbsup": 1
},
"createdAt": "2024-07-01T14:39:03.482914Z",
"updatedAt": "2024-07-01T14:39:06.710173Z",
"user": {
"id": "rTWHJd8kGZev",
"name": "Vadim Carusto CRM",
"email": "vadim.ruban@carusto.com",
"locale": "en",
"timeZone": "Europe/Rome",
"company": "it_w119414",
"bot": false,
"pbxDomain": "crm-test.wildixin.com",
"pbxPort": "443",
"pbxExtension": "32312",
"pbxSerial": "221100007e84",
"pbxUserId": "3431044",
"createdAt": "2022-05-23T12:38:10.574336Z",
"updatedAt": "2024-06-29T10:09:39.101619Z"
},
"quote": null,
"forward": null,
"sms": false,
"silent": false,
"event": null
},
"reaction": {
"type": "thumbsup",
"userId": "rTWHJd8kGZev",
"messageId": "3e83e9d6-dbf5-4999-a2e5-418f746a",
"user": {
"id": "rTWHJd8kGZev",
"name": "Vadim Carusto CRM",
"email": "vadim.ruban@carusto.com",
"locale": "en",
"timeZone": "Europe/Rome",
"company": "it_w119414",
"bot": false,
"pbxDomain": "crm-test.wildixin.com",
"pbxPort": "443",
"pbxExtension": "32312",
"pbxSerial": "221100007e84",
"pbxUserId": "3431044",
"createdAt": "2022-05-23T12:38:10.574336Z",
"updatedAt": "2024-06-29T10:09:39.101619Z"
}
}
}
}
chat:reaction:deleted
Triggered when a user removes a reaction from a message. Reactions: thumbsup, clap, slightly_smiling_face, smiley, heart, eyes, white_check_mark,confused, thumbsdown.
Example
{
"id": "44e826ce-7779-4679-a047-03c04f4ab371",
"type": "chat:reaction:deleted",
"company": "it_w119414",
"time": 1719844772471,
"integrationId": "a2n2on",
"data": {
"channel": {
"channelId": "04523271-0857-47a1-8324-fd28d8e5",
"channelType": "group",
"memberCount": 3,
"subject": "New subject",
"description": "",
"access": "private",
"company": "it_w119414",
"service": "",
"serviceTitle": "",
"broadcast": false,
"external": true,
"createdAt": "2024-07-01T14:06:43.386258Z",
"updatedAt": "2024-07-01T14:27:33.375099Z"
},
"message": {
"messageId": "3e83e9d6-dbf5-4999-a2e5-418f746a",
"channelId": "04523271-0857-47a1-8324-fd28d8e5",
"type": "regular",
"text": "Hi",
"attachments": [],
"mentions": [],
"giphy": null,
"latestReactions": [],
"reactionCounts": {},
"createdAt": "2024-07-01T14:39:03.482914Z",
"updatedAt": "2024-07-01T14:39:32.299854Z",
"user": {
"id": "rTWHJd8kGZev",
"name": "Vadim Carusto CRM",
"email": "vadim.ruban@carusto.com",
"locale": "en",
"timeZone": "Europe/Rome",
"company": "it_w119414",
"bot": false,
"pbxDomain": "crm-test.wildixin.com",
"pbxPort": "443",
"pbxExtension": "32312",
"pbxSerial": "221100007e84",
"pbxUserId": "3431044",
"createdAt": "2022-05-23T12:38:10.574336Z",
"updatedAt": "2024-06-29T10:09:39.101619Z"
},
"quote": null,
"forward": null,
"sms": false,
"silent": false,
"event": null
},
"reaction": {
"type": "thumbsup",
"userId": "rTWHJd8kGZev",
"messageId": "3e83e9d6-dbf5-4999-a2e5-418f746a",
"user": {
"id": "rTWHJd8kGZev",
"name": "Vadim Carusto CRM",
"email": "vadim.ruban@carusto.com",
"locale": "en",
"timeZone": "Europe/Rome",
"company": "it_w119414",
"bot": false,
"pbxDomain": "crm-test.wildixin.com",
"pbxPort": "443",
"pbxExtension": "32312",
"pbxSerial": "221100007e84",
"pbxUserId": "3431044",
"createdAt": "2022-05-23T12:38:10.574336Z",
"updatedAt": "2024-06-29T10:09:39.101619Z"
}
}
}
}
chat:live:progress
Triggered when a live chat session starts or gets updated.
Example
{
"id": "group:demo1234-5678-9101-1121-314151617181",
"company": "demo_company_12345",
"time": 1719844427379,
"type": "chat:live:progress",
"integrationId": "demo_integration_05",
"data": {
"id": "group:demo1234-5678-9101-1121-314151617181",
"time": 1719844427260,
"company": "demo_company_12345",
"event": "chat",
"start": "2024-07-01T14:33:47.260Z",
"channelId": "demo_channel_005",
"channelType": "group",
"subject": "Demo New Subject",
"participants": [
{
"id": "demo_participant_01",
"name": "Alice Johnson",
"email": "alice.johnson@example.com",
"company": "demo_company_12345",
"pbxDomain": "example.com",
"pbxPort": "443",
"pbxExtension": "1003",
"pbxSerial": "demo_serial_003",
"pbxUserId": "user_003",
"createdAt": "2022-05-23T12:38:10.574336Z",
"updatedAt": "2024-06-29T10:09:39.101619Z",
"type": "LOCAL",
"role": "AGENT"
}
],
"agents": [
{
"id": "demo_agent_01",
"name": "John Doe",
"email": "john.doe@example.com",
"picture": "https://example.com/avatar1.png",
"company": "demo_company_12345",
"pbxExtension": "1001",
"pbxSerial": "demo_serial_001",
"pbxUserId": "user_001",
"createdAt": "2022-12-27T22:58:32.370401Z",
"updatedAt": "2022-12-27T22:58:32.370401Z",
"bot": false
},
{
"id": "demo_agent_02",
"name": "Alice Johnson",
"email": "alice.johnson@example.com",
"company": "demo_company_12345",
"pbxDomain": "example.com",
"pbxPort": "443",
"pbxExtension": "1003",
"pbxSerial": "demo_serial_003",
"pbxUserId": "user_003",
"createdAt": "2022-05-23T12:38:10.574336Z",
"updatedAt": "2024-06-29T10:09:39.101619Z",
"bot": false,
"locale": "en",
"timeZone": "Europe/Berlin"
}
],
"agentsCount": 2,
"customers": [
{
"id": "demo_customer_01",
"email": "john.travolta@example.com",
"createdAt": "2022-12-27T19:00:22.677386Z",
"updatedAt": "2022-12-27T19:00:22.677386Z",
"bot": false
}
],
"customersCount": 1,
"tags": [],
"direction": "OUTBOUND",
"status": "WAITFIRSTREPLY"
}
}
chat:live:completed
Triggered when a live chat session ends.
Example
{
"id": "group:1232f7a1-153a-4ec7-bf1f-570bd9f8",
"company": "it_w000001",
"time": 1723647308237,
"type": "chat:completed",
"integrationId": "s6903h",
"data": {
"id": "group:1232f7a1-153a-4ec7-bf1f-570bd9f8",
"time": 1723645508038,
"company": "it_w000001",
"type": "chat",
"duration": 0,
"subject": "guest@example.com, John Doe",
"direction": "OUTBOUND",
"tags": [],
"status": "MISSED",
"participants": [
{
"id": "jDo1hnOE337x",
"info": {
"id": "jDo1hnOE337x",
"name": "John Doe",
"email": "johndoe@example.com",
"picture": "https://pbx.wildixin.com/cticonnect/cticonnect_share/avatar.png",
"company": "it_w000001",
"pbxDomain": "johndoe.wildixin.com",
"pbxPort": "443",
"pbxExtension": "230",
"pbxSerial": "000000000001",
"pbxUserId": "4258467",
"createdAt": "2021-01-22T08:09:54.737575Z",
"updatedAt": "2024-08-14T12:18:19.036966Z",
"type": "LOCAL",
"role": "AGENT"
}
}
]
}
}
chat:live:interrupted
Triggered when a live chat session ends due to an error.
Example
"TODO"
chat:manager:missed
Triggered when a chat detects a missed manager.
Example
{
"id": "group:1232f7a1-153a-4ec7-bf1f-570bd9f8",
"company": "it_w000001",
"time": 1722183145037,
"type": "chat:manager:missed",
"integrationId": "s6903h",
"data": {
"id": "group:1232f7a1-153a-4ec7-bf1f-570bd9f8",
"time": 1722183144947,
"company": "it_w000001",
"event": "chat_manager_missed"
}
}