Skip to main content

@wildix/xbees-conversations-client > DescribeEventCommand

DescribeEventCommand class

Signature:

export declare class DescribeEventCommand extends DescribeEventCommand_base 

Extends: DescribeEventCommand_base

Example

Use a bare-bones client and the command you need to make an API call.

import { ConversationsClient, DescribeEventCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
// const { ConversationsClient, DescribeEventCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
const client = new ConversationsClient(config);
const input = {};
const command = new DescribeEventCommand(input);
const response = await client.send(command);
// { // DescribeEventOutput
// WebhookChatChannelCreatedEvent: { // WebhookChatChannelCreatedEvent
// id: "STRING_VALUE", // required
// company: "STRING_VALUE", // required
// type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted" || "chat:action:triggered", // required
// time: Number("long"), // required
// integrationId: "STRING_VALUE",
// botId: "STRING_VALUE",
// data: { // WebhookChatChannelCreatedOrUpdatedEventData
// channel: { // Channel
// subject: "STRING_VALUE",
// description: "STRING_VALUE",
// picture: "STRING_VALUE",
// pictureColor: "STRING_VALUE",
// access: "private" || "public",
// company: "STRING_VALUE",
// context: { // ChannelContext
// source: "kite",
// target: "STRING_VALUE",
// events: [ // ChannelContextEventList
// { // ChannelContextEvent
// id: "STRING_VALUE",
// owner: "STRING_VALUE",
// start: "STRING_VALUE",
// end: "STRING_VALUE",
// summary: "STRING_VALUE",
// attendees: [ // ChannelContextEventAttendeeList
// { // ChannelContextEventAttendee
// email: "STRING_VALUE", // required
// name: "STRING_VALUE",
// status: "accepted" || "tentative" || "declined" || "none", // required
// },
// ],
// },
// ],
// },
// kite: true || false,
// kiteTarget: "STRING_VALUE",
// kiteVariant: "STRING_VALUE",
// kiteAssign: "STRING_VALUE",
// kiteServiceName: "STRING_VALUE",
// kiteDefaultSubject: "STRING_VALUE",
// service: "STRING_VALUE",
// serviceTitle: "STRING_VALUE",
// serviceRecipient: "STRING_VALUE",
// assignee: { // User
// id: "STRING_VALUE", // required
// name: "STRING_VALUE",
// email: "STRING_VALUE",
// phone: "STRING_VALUE",
// picture: "STRING_VALUE",
// locale: "STRING_VALUE",
// timeZone: "STRING_VALUE",
// company: "STRING_VALUE",
// bot: true || false,
// pbxDomain: "STRING_VALUE",
// pbxPort: "STRING_VALUE",
// pbxExtension: "STRING_VALUE",
// pbxSerial: "STRING_VALUE",
// pbxUserId: "STRING_VALUE",
// createdAt: "STRING_VALUE",
// updatedAt: "STRING_VALUE",
// },
// telephony: true || false,
// sms: true || false,
// mms: true || false,
// whatsapp: true || false,
// whatsappStatus: "24h_channel_closed",
// broadcast: true || false,
// external: true || false,
// channelId: "STRING_VALUE", // required
// channelType: "direct" || "group", // required
// memberCount: Number("int"), // required
// createdAt: "STRING_VALUE", // required
// createdBy: "STRING_VALUE", // required
// updatedAt: "STRING_VALUE",
// },
// members: [ // ChannelMembersList // required
// { // ChannelMember
// id: "STRING_VALUE", // required
// createdAt: "STRING_VALUE", // required
// role: "member" || "supervisor", // required
// },
// ],
// users: [ // UsersList // required
// {
// id: "STRING_VALUE", // required
// name: "STRING_VALUE",
// email: "STRING_VALUE",
// phone: "STRING_VALUE",
// picture: "STRING_VALUE",
// locale: "STRING_VALUE",
// timeZone: "STRING_VALUE",
// company: "STRING_VALUE",
// bot: true || false,
// pbxDomain: "STRING_VALUE",
// pbxPort: "STRING_VALUE",
// pbxExtension: "STRING_VALUE",
// pbxSerial: "STRING_VALUE",
// pbxUserId: "STRING_VALUE",
// createdAt: "STRING_VALUE",
// updatedAt: "STRING_VALUE",
// },
// ],
// },
// },
// WebhookChatChannelUpdatedEvent: { // WebhookChatChannelUpdatedEvent
// id: "STRING_VALUE", // required
// company: "STRING_VALUE", // required
// type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted" || "chat:action:triggered", // required
// time: Number("long"), // required
// integrationId: "STRING_VALUE",
// botId: "STRING_VALUE",
// data: {
// channel: {
// subject: "STRING_VALUE",
// description: "STRING_VALUE",
// picture: "STRING_VALUE",
// pictureColor: "STRING_VALUE",
// access: "private" || "public",
// company: "STRING_VALUE",
// context: {
// source: "kite",
// target: "STRING_VALUE",
// events: [
// {
// id: "STRING_VALUE",
// owner: "STRING_VALUE",
// start: "STRING_VALUE",
// end: "STRING_VALUE",
// summary: "STRING_VALUE",
// attendees: [
// {
// email: "STRING_VALUE", // required
// name: "STRING_VALUE",
// status: "accepted" || "tentative" || "declined" || "none", // required
// },
// ],
// },
// ],
// },
// kite: true || false,
// kiteTarget: "STRING_VALUE",
// kiteVariant: "STRING_VALUE",
// kiteAssign: "STRING_VALUE",
// kiteServiceName: "STRING_VALUE",
// kiteDefaultSubject: "STRING_VALUE",
// service: "STRING_VALUE",
// serviceTitle: "STRING_VALUE",
// serviceRecipient: "STRING_VALUE",
// assignee: {
// id: "STRING_VALUE", // required
// name: "STRING_VALUE",
// email: "STRING_VALUE",
// phone: "STRING_VALUE",
// picture: "STRING_VALUE",
// locale: "STRING_VALUE",
// timeZone: "STRING_VALUE",
// company: "STRING_VALUE",
// bot: true || false,
// pbxDomain: "STRING_VALUE",
// pbxPort: "STRING_VALUE",
// pbxExtension: "STRING_VALUE",
// pbxSerial: "STRING_VALUE",
// pbxUserId: "STRING_VALUE",
// createdAt: "STRING_VALUE",
// updatedAt: "STRING_VALUE",
// },
// telephony: true || false,
// sms: true || false,
// mms: true || false,
// whatsapp: true || false,
// whatsappStatus: "24h_channel_closed",
// broadcast: true || false,
// external: true || false,
// channelId: "STRING_VALUE", // required
// channelType: "direct" || "group", // required
// memberCount: Number("int"), // required
// createdAt: "STRING_VALUE", // required
// createdBy: "STRING_VALUE", // required
// updatedAt: "STRING_VALUE",
// },
// members: [ // required
// {
// id: "STRING_VALUE", // required
// createdAt: "STRING_VALUE", // required
// role: "member" || "supervisor", // required
// },
// ],
// users: [ // required
// {
// id: "STRING_VALUE", // required
// name: "STRING_VALUE",
// email: "STRING_VALUE",
// phone: "STRING_VALUE",
// picture: "STRING_VALUE",
// locale: "STRING_VALUE",
// timeZone: "STRING_VALUE",
// company: "STRING_VALUE",
// bot: true || false,
// pbxDomain: "STRING_VALUE",
// pbxPort: "STRING_VALUE",
// pbxExtension: "STRING_VALUE",
// pbxSerial: "STRING_VALUE",
// pbxUserId: "STRING_VALUE",
// createdAt: "STRING_VALUE",
// updatedAt: "STRING_VALUE",
// },
// ],
// },
// },
// WebhookChatMemberAddedEvent: { // WebhookChatMemberAddedEvent
// id: "STRING_VALUE", // required
// company: "STRING_VALUE", // required
// type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted" || "chat:action:triggered", // required
// time: Number("long"), // required
// integrationId: "STRING_VALUE",
// botId: "STRING_VALUE",
// data: { // WebhookChatMemberAddedOrRemovedEventData
// channel: {
// subject: "STRING_VALUE",
// description: "STRING_VALUE",
// picture: "STRING_VALUE",
// pictureColor: "STRING_VALUE",
// access: "private" || "public",
// company: "STRING_VALUE",
// context: {
// source: "kite",
// target: "STRING_VALUE",
// events: [
// {
// id: "STRING_VALUE",
// owner: "STRING_VALUE",
// start: "STRING_VALUE",
// end: "STRING_VALUE",
// summary: "STRING_VALUE",
// attendees: [
// {
// email: "STRING_VALUE", // required
// name: "STRING_VALUE",
// status: "accepted" || "tentative" || "declined" || "none", // required
// },
// ],
// },
// ],
// },
// kite: true || false,
// kiteTarget: "STRING_VALUE",
// kiteVariant: "STRING_VALUE",
// kiteAssign: "STRING_VALUE",
// kiteServiceName: "STRING_VALUE",
// kiteDefaultSubject: "STRING_VALUE",
// service: "STRING_VALUE",
// serviceTitle: "STRING_VALUE",
// serviceRecipient: "STRING_VALUE",
// assignee: {
// id: "STRING_VALUE", // required
// name: "STRING_VALUE",
// email: "STRING_VALUE",
// phone: "STRING_VALUE",
// picture: "STRING_VALUE",
// locale: "STRING_VALUE",
// timeZone: "STRING_VALUE",
// company: "STRING_VALUE",
// bot: true || false,
// pbxDomain: "STRING_VALUE",
// pbxPort: "STRING_VALUE",
// pbxExtension: "STRING_VALUE",
// pbxSerial: "STRING_VALUE",
// pbxUserId: "STRING_VALUE",
// createdAt: "STRING_VALUE",
// updatedAt: "STRING_VALUE",
// },
// telephony: true || false,
// sms: true || false,
// mms: true || false,
// whatsapp: true || false,
// whatsappStatus: "24h_channel_closed",
// broadcast: true || false,
// external: true || false,
// channelId: "STRING_VALUE", // required
// channelType: "direct" || "group", // required
// memberCount: Number("int"), // required
// createdAt: "STRING_VALUE", // required
// createdBy: "STRING_VALUE", // required
// updatedAt: "STRING_VALUE",
// },
// member: {
// id: "STRING_VALUE", // required
// createdAt: "STRING_VALUE", // required
// role: "member" || "supervisor", // required
// },
// user: "<User>", // required
// },
// },
// WebhookChatMemberRemovedEvent: { // WebhookChatMemberRemovedEvent
// id: "STRING_VALUE", // required
// company: "STRING_VALUE", // required
// type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted" || "chat:action:triggered", // required
// time: Number("long"), // required
// integrationId: "STRING_VALUE",
// botId: "STRING_VALUE",
// data: {
// channel: {
// subject: "STRING_VALUE",
// description: "STRING_VALUE",
// picture: "STRING_VALUE",
// pictureColor: "STRING_VALUE",
// access: "private" || "public",
// company: "STRING_VALUE",
// context: {
// source: "kite",
// target: "STRING_VALUE",
// events: [
// {
// id: "STRING_VALUE",
// owner: "STRING_VALUE",
// start: "STRING_VALUE",
// end: "STRING_VALUE",
// summary: "STRING_VALUE",
// attendees: [
// {
// email: "STRING_VALUE", // required
// name: "STRING_VALUE",
// status: "accepted" || "tentative" || "declined" || "none", // required
// },
// ],
// },
// ],
// },
// kite: true || false,
// kiteTarget: "STRING_VALUE",
// kiteVariant: "STRING_VALUE",
// kiteAssign: "STRING_VALUE",
// kiteServiceName: "STRING_VALUE",
// kiteDefaultSubject: "STRING_VALUE",
// service: "STRING_VALUE",
// serviceTitle: "STRING_VALUE",
// serviceRecipient: "STRING_VALUE",
// assignee: "<User>",
// telephony: true || false,
// sms: true || false,
// mms: true || false,
// whatsapp: true || false,
// whatsappStatus: "24h_channel_closed",
// broadcast: true || false,
// external: true || false,
// channelId: "STRING_VALUE", // required
// channelType: "direct" || "group", // required
// memberCount: Number("int"), // required
// createdAt: "STRING_VALUE", // required
// createdBy: "STRING_VALUE", // required
// updatedAt: "STRING_VALUE",
// },
// member: {
// id: "STRING_VALUE", // required
// createdAt: "STRING_VALUE", // required
// role: "member" || "supervisor", // required
// },
// user: "<User>", // required
// },
// },
// WebhookChatMessageNewEvent: { // WebhookChatMessageNewEvent
// id: "STRING_VALUE", // required
// company: "STRING_VALUE", // required
// type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted" || "chat:action:triggered", // required
// time: Number("long"), // required
// integrationId: "STRING_VALUE",
// botId: "STRING_VALUE",
// data: { // WebhookChatMessageNewEventData
// channel: {
// subject: "STRING_VALUE",
// description: "STRING_VALUE",
// picture: "STRING_VALUE",
// pictureColor: "STRING_VALUE",
// access: "private" || "public",
// company: "STRING_VALUE",
// context: {
// source: "kite",
// target: "STRING_VALUE",
// events: [
// {
// id: "STRING_VALUE",
// owner: "STRING_VALUE",
// start: "STRING_VALUE",
// end: "STRING_VALUE",
// summary: "STRING_VALUE",
// attendees: [
// {
// email: "STRING_VALUE", // required
// name: "STRING_VALUE",
// status: "accepted" || "tentative" || "declined" || "none", // required
// },
// ],
// },
// ],
// },
// kite: true || false,
// kiteTarget: "STRING_VALUE",
// kiteVariant: "STRING_VALUE",
// kiteAssign: "STRING_VALUE",
// kiteServiceName: "STRING_VALUE",
// kiteDefaultSubject: "STRING_VALUE",
// service: "STRING_VALUE",
// serviceTitle: "STRING_VALUE",
// serviceRecipient: "STRING_VALUE",
// assignee: "<User>",
// telephony: true || false,
// sms: true || false,
// mms: true || false,
// whatsapp: true || false,
// whatsappStatus: "24h_channel_closed",
// broadcast: true || false,
// external: true || false,
// channelId: "STRING_VALUE", // required
// channelType: "direct" || "group", // required
// memberCount: Number("int"), // required
// createdAt: "STRING_VALUE", // required
// createdBy: "STRING_VALUE", // required
// updatedAt: "STRING_VALUE",
// },
// members: [ // required
// {
// id: "STRING_VALUE", // required
// createdAt: "STRING_VALUE", // required
// role: "member" || "supervisor", // required
// },
// ],
// users: [ // required
// "<User>",
// ],
// message: { // Message
// text: "STRING_VALUE",
// elements: [ // ElementsList
// { // Element Union: only one key present
// actions: [ // ActionsElementsList
// { // ActionElement Union: only one key present
// button: { // ButtonElement
// text: "STRING_VALUE", // required
// variant: "contained" || "outlined",
// disabled: true || false,
// handler: { // ButtonHandler Union: only one key present
// link: { // ButtonLinkHandler
// url: "STRING_VALUE", // required
// },
// reply: { // ButtonReplyHandler
// text: "STRING_VALUE",
// },
// action: { // ButtonActionHandler
// id: "STRING_VALUE", // required
// },
// },
// },
// },
// ],
// },
// ],
// attachments: [ // MessageAttachmentList
// { // MessageAttachment
// id: "STRING_VALUE", // required
// fsId: "STRING_VALUE", // required
// mime: "STRING_VALUE",
// name: "STRING_VALUE", // required
// size: Number("int"), // required
// width: Number("int"),
// height: Number("int"),
// thumbnail: "STRING_VALUE",
// },
// ],
// quote: { // MessageQuote
// messageId: "STRING_VALUE", // required
// channelId: "STRING_VALUE", // required
// user: "<User>", // required
// text: "STRING_VALUE",
// attachments: [
// {
// id: "STRING_VALUE", // required
// fsId: "STRING_VALUE", // required
// mime: "STRING_VALUE",
// name: "STRING_VALUE", // required
// size: Number("int"), // required
// width: Number("int"),
// height: Number("int"),
// thumbnail: "STRING_VALUE",
// },
// ],
// forward: { // MessageForward
// forwardCompany: "STRING_VALUE",
// forwardDate: "STRING_VALUE", // required
// forwardEmail: "STRING_VALUE",
// forwardName: "STRING_VALUE",
// messageId: "STRING_VALUE", // required
// channelId: "STRING_VALUE", // required
// },
// mentions: [
// "<User>",
// ],
// giphy: { // MessageGiphy
// id: "STRING_VALUE", // required
// size: "STRING_VALUE", // required
// url: "STRING_VALUE", // required
// height: "STRING_VALUE", // required
// width: "STRING_VALUE", // required
// },
// createdAt: "STRING_VALUE", // required
// updatedAt: "STRING_VALUE",
// },
// forward: {
// forwardCompany: "STRING_VALUE",
// forwardDate: "STRING_VALUE", // required
// forwardEmail: "STRING_VALUE",
// forwardName: "STRING_VALUE",
// messageId: "STRING_VALUE", // required
// channelId: "STRING_VALUE", // required
// },
// type: "regular" || "system", // required
// giphy: {
// id: "STRING_VALUE", // required
// size: "STRING_VALUE", // required
// url: "STRING_VALUE", // required
// height: "STRING_VALUE", // required
// width: "STRING_VALUE", // required
// },
// silent: true || false,
// event: "STRING_VALUE",
// sms: true || false,
// smsStatus: "sent" || "delivered" || "trying" || "error",
// whatsapp: true || false,
// whatsappStatus: "trying" || "sent" || "delivered" || "error",
// messageId: "STRING_VALUE", // required
// channelId: "STRING_VALUE", // required
// user: "<User>", // required
// edit: true || false,
// mentions: "<UsersList>",
// latestReactions: [ // ReactionList
// { // Reaction
// type: "STRING_VALUE",
// userId: "STRING_VALUE",
// messageId: "STRING_VALUE",
// user: "<User>",
// },
// ],
// reactionCounts: { // ReactionCounts
// "<keys>": Number("int"),
// },
// createdAt: "STRING_VALUE", // required
// updatedAt: "STRING_VALUE",
// },
// },
// },
// WebhookChatMessageUpdatedEvent: { // WebhookChatMessageUpdatedEvent
// id: "STRING_VALUE", // required
// company: "STRING_VALUE", // required
// type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted" || "chat:action:triggered", // required
// time: Number("long"), // required
// integrationId: "STRING_VALUE",
// botId: "STRING_VALUE",
// data: { // WebhookChatMessageUpdatedOrDeletedEventData
// channel: "<Channel>", // required
// message: {
// text: "STRING_VALUE",
// elements: [
// {// Union: only one key present
// actions: [
// {// Union: only one key present
// button: {
// text: "STRING_VALUE", // required
// variant: "contained" || "outlined",
// disabled: true || false,
// handler: {// Union: only one key present
// link: {
// url: "STRING_VALUE", // required
// },
// reply: {
// text: "STRING_VALUE",
// },
// action: {
// id: "STRING_VALUE", // required
// },
// },
// },
// },
// ],
// },
// ],
// attachments: [
// {
// id: "STRING_VALUE", // required
// fsId: "STRING_VALUE", // required
// mime: "STRING_VALUE",
// name: "STRING_VALUE", // required
// size: Number("int"), // required
// width: Number("int"),
// height: Number("int"),
// thumbnail: "STRING_VALUE",
// },
// ],
// quote: {
// messageId: "STRING_VALUE", // required
// channelId: "STRING_VALUE", // required
// user: "<User>", // required
// text: "STRING_VALUE",
// attachments: [
// {
// id: "STRING_VALUE", // required
// fsId: "STRING_VALUE", // required
// mime: "STRING_VALUE",
// name: "STRING_VALUE", // required
// size: Number("int"), // required
// width: Number("int"),
// height: Number("int"),
// thumbnail: "STRING_VALUE",
// },
// ],
// forward: {
// forwardCompany: "STRING_VALUE",
// forwardDate: "STRING_VALUE", // required
// forwardEmail: "STRING_VALUE",
// forwardName: "STRING_VALUE",
// messageId: "STRING_VALUE", // required
// channelId: "STRING_VALUE", // required
// },
// mentions: "<UsersList>",
// giphy: {
// id: "STRING_VALUE", // required
// size: "STRING_VALUE", // required
// url: "STRING_VALUE", // required
// height: "STRING_VALUE", // required
// width: "STRING_VALUE", // required
// },
// createdAt: "STRING_VALUE", // required
// updatedAt: "STRING_VALUE",
// },
// forward: {
// forwardCompany: "STRING_VALUE",
// forwardDate: "STRING_VALUE", // required
// forwardEmail: "STRING_VALUE",
// forwardName: "STRING_VALUE",
// messageId: "STRING_VALUE", // required
// channelId: "STRING_VALUE", // required
// },
// type: "regular" || "system", // required
// giphy: {
// id: "STRING_VALUE", // required
// size: "STRING_VALUE", // required
// url: "STRING_VALUE", // required
// height: "STRING_VALUE", // required
// width: "STRING_VALUE", // required
// },
// silent: true || false,
// event: "STRING_VALUE",
// sms: true || false,
// smsStatus: "sent" || "delivered" || "trying" || "error",
// whatsapp: true || false,
// whatsappStatus: "trying" || "sent" || "delivered" || "error",
// messageId: "STRING_VALUE", // required
// channelId: "STRING_VALUE", // required
// user: "<User>", // required
// edit: true || false,
// mentions: "<UsersList>",
// latestReactions: [
// {
// type: "STRING_VALUE",
// userId: "STRING_VALUE",
// messageId: "STRING_VALUE",
// user: "<User>",
// },
// ],
// reactionCounts: {
// "<keys>": Number("int"),
// },
// createdAt: "STRING_VALUE", // required
// updatedAt: "STRING_VALUE",
// },
// },
// },
// WebhookChatMessageDeletedEvent: { // WebhookChatMessageDeletedEvent
// id: "STRING_VALUE", // required
// company: "STRING_VALUE", // required
// type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted" || "chat:action:triggered", // required
// time: Number("long"), // required
// integrationId: "STRING_VALUE",
// botId: "STRING_VALUE",
// data: {
// channel: "<Channel>", // required
// message: {
// text: "STRING_VALUE",
// elements: [
// {// Union: only one key present
// actions: [
// {// Union: only one key present
// button: {
// text: "STRING_VALUE", // required
// variant: "contained" || "outlined",
// disabled: true || false,
// handler: {// Union: only one key present
// link: {
// url: "STRING_VALUE", // required
// },
// reply: {
// text: "STRING_VALUE",
// },
// action: {
// id: "STRING_VALUE", // required
// },
// },
// },
// },
// ],
// },
// ],
// attachments: [
// {
// id: "STRING_VALUE", // required
// fsId: "STRING_VALUE", // required
// mime: "STRING_VALUE",
// name: "STRING_VALUE", // required
// size: Number("int"), // required
// width: Number("int"),
// height: Number("int"),
// thumbnail: "STRING_VALUE",
// },
// ],
// quote: {
// messageId: "STRING_VALUE", // required
// channelId: "STRING_VALUE", // required
// user: "<User>", // required
// text: "STRING_VALUE",
// attachments: "<MessageAttachmentList>",
// forward: {
// forwardCompany: "STRING_VALUE",
// forwardDate: "STRING_VALUE", // required
// forwardEmail: "STRING_VALUE",
// forwardName: "STRING_VALUE",
// messageId: "STRING_VALUE", // required
// channelId: "STRING_VALUE", // required
// },
// mentions: "<UsersList>",
// giphy: {
// id: "STRING_VALUE", // required
// size: "STRING_VALUE", // required
// url: "STRING_VALUE", // required
// height: "STRING_VALUE", // required
// width: "STRING_VALUE", // required
// },
// createdAt: "STRING_VALUE", // required
// updatedAt: "STRING_VALUE",
// },
// forward: "<MessageForward>",
// type: "regular" || "system", // required
// giphy: "<MessageGiphy>",
// silent: true || false,
// event: "STRING_VALUE",
// sms: true || false,
// smsStatus: "sent" || "delivered" || "trying" || "error",
// whatsapp: true || false,
// whatsappStatus: "trying" || "sent" || "delivered" || "error",
// messageId: "STRING_VALUE", // required
// channelId: "STRING_VALUE", // required
// user: "<User>", // required
// edit: true || false,
// mentions: "<UsersList>",
// latestReactions: [
// {
// type: "STRING_VALUE",
// userId: "STRING_VALUE",
// messageId: "STRING_VALUE",
// user: "<User>",
// },
// ],
// reactionCounts: {
// "<keys>": Number("int"),
// },
// createdAt: "STRING_VALUE", // required
// updatedAt: "STRING_VALUE",
// },
// },
// },
// WebhookChatReactionNewEvent: { // WebhookChatReactionNewEvent
// id: "STRING_VALUE", // required
// company: "STRING_VALUE", // required
// type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted" || "chat:action:triggered", // required
// time: Number("long"), // required
// integrationId: "STRING_VALUE",
// botId: "STRING_VALUE",
// data: { // WebhookChatReactionNewOrDeletedEventData
// channel: "<Channel>", // required
// message: {
// text: "STRING_VALUE",
// elements: [
// {// Union: only one key present
// actions: [
// {// Union: only one key present
// button: {
// text: "STRING_VALUE", // required
// variant: "contained" || "outlined",
// disabled: true || false,
// handler: {// Union: only one key present
// link: {
// url: "STRING_VALUE", // required
// },
// reply: {
// text: "STRING_VALUE",
// },
// action: {
// id: "STRING_VALUE", // required
// },
// },
// },
// },
// ],
// },
// ],
// attachments: "<MessageAttachmentList>",
// quote: {
// messageId: "STRING_VALUE", // required
// channelId: "STRING_VALUE", // required
// user: "<User>", // required
// text: "STRING_VALUE",
// attachments: "<MessageAttachmentList>",
// forward: "<MessageForward>",
// mentions: "<UsersList>",
// giphy: "<MessageGiphy>",
// createdAt: "STRING_VALUE", // required
// updatedAt: "STRING_VALUE",
// },
// forward: "<MessageForward>",
// type: "regular" || "system", // required
// giphy: "<MessageGiphy>",
// silent: true || false,
// event: "STRING_VALUE",
// sms: true || false,
// smsStatus: "sent" || "delivered" || "trying" || "error",
// whatsapp: true || false,
// whatsappStatus: "trying" || "sent" || "delivered" || "error",
// messageId: "STRING_VALUE", // required
// channelId: "STRING_VALUE", // required
// user: "<User>", // required
// edit: true || false,
// mentions: "<UsersList>",
// latestReactions: [
// {
// type: "STRING_VALUE",
// userId: "STRING_VALUE",
// messageId: "STRING_VALUE",
// user: "<User>",
// },
// ],
// reactionCounts: {
// "<keys>": Number("int"),
// },
// createdAt: "STRING_VALUE", // required
// updatedAt: "STRING_VALUE",
// },
// reaction: {
// type: "STRING_VALUE",
// userId: "STRING_VALUE",
// messageId: "STRING_VALUE",
// user: "<User>",
// },
// },
// },
// WebhookChatReactionDeletedEvent: { // WebhookChatReactionDeletedEvent
// id: "STRING_VALUE", // required
// company: "STRING_VALUE", // required
// type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted" || "chat:action:triggered", // required
// time: Number("long"), // required
// integrationId: "STRING_VALUE",
// botId: "STRING_VALUE",
// data: {
// channel: "<Channel>", // required
// message: {
// text: "STRING_VALUE",
// elements: [
// {// Union: only one key present
// actions: [
// {// Union: only one key present
// button: {
// text: "STRING_VALUE", // required
// variant: "contained" || "outlined",
// disabled: true || false,
// handler: {// Union: only one key present
// link: {
// url: "STRING_VALUE", // required
// },
// reply: {
// text: "STRING_VALUE",
// },
// action: {
// id: "STRING_VALUE", // required
// },
// },
// },
// },
// ],
// },
// ],
// attachments: "<MessageAttachmentList>",
// quote: {
// messageId: "STRING_VALUE", // required
// channelId: "STRING_VALUE", // required
// user: "<User>", // required
// text: "STRING_VALUE",
// attachments: "<MessageAttachmentList>",
// forward: "<MessageForward>",
// mentions: "<UsersList>",
// giphy: "<MessageGiphy>",
// createdAt: "STRING_VALUE", // required
// updatedAt: "STRING_VALUE",
// },
// forward: "<MessageForward>",
// type: "regular" || "system", // required
// giphy: "<MessageGiphy>",
// silent: true || false,
// event: "STRING_VALUE",
// sms: true || false,
// smsStatus: "sent" || "delivered" || "trying" || "error",
// whatsapp: true || false,
// whatsappStatus: "trying" || "sent" || "delivered" || "error",
// messageId: "STRING_VALUE", // required
// channelId: "STRING_VALUE", // required
// user: "<User>", // required
// edit: true || false,
// mentions: "<UsersList>",
// latestReactions: [
// "<Reaction>",
// ],
// reactionCounts: {
// "<keys>": Number("int"),
// },
// createdAt: "STRING_VALUE", // required
// updatedAt: "STRING_VALUE",
// },
// reaction: "<Reaction>", // required
// },
// },
// WebhookChatActionTriggeredEvent: { // WebhookChatActionTriggeredEvent
// id: "STRING_VALUE", // required
// company: "STRING_VALUE", // required
// type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted" || "chat:action:triggered", // required
// time: Number("long"), // required
// integrationId: "STRING_VALUE",
// botId: "STRING_VALUE",
// data: { // WebhookChatActionTriggeredEventData
// channel: "<Channel>", // required
// message: "<Message>", // required
// user: "<User>", // required
// actionId: "STRING_VALUE", // required
// triggerId: "STRING_VALUE", // required
// },
// },
// };