Webhooks

Webhooks enable you to transmit data from ConverseIQ to external platforms when specific events occur.

To subscribe to events, go to Settings, then API settings, and click on the "Webhook" tab. From there, add a new Webhook endpoint. In the dialog box that appears, set the Webhook endpoint URL and choose the events you wish to receive.

Each webhook request has this JSON data schema:

{
    "event": "EVENT_NAME",
    "id": "00000000-0000-0000-0000-000000000000",
    "ts": 1749402870,
    "data": [
        "workspace": "00000000-0000-0000-0000-000000000000",
        "guid": "00000000-0000-0000-0000-000000000000",
        [object]: [
             // JSON object
        ]
    ]
}

param	type	description
event	String	The name of the event (see table below).
id	String (GUID)	ID of the event
ts	Int	Timestamp
data	Object	Event data details. Data object contain workspace and object guid and also details of the related object.

Please note that the *.deleted events contains only GUID/ID of the deleted object, but not details of the object as the object is no longer exists.

Below are the descriptions of supported events:

event	data type	description
User
user.created	User	User is created
user.updated	User	User is updated
user.deleted	GUID of the User	User is deleted
Chat
chat.created	Chat	Chat is created
chat.message.created	Message	Message is created
chat.message.updated	Message	Message is updated
chat.message.deleted	ID of the Message	Message is deleted
chat.muted	Chat	Chat is muted
chat.unmuted	Chat	Chat is unmuted
chat.archived	Chat	Chat is archived
chat.unarchived	Chat	Chat is unarchived
chat.resolved	Chat	Chat is resolved
chat.reopened	Chat	Chat is re-opened
chat.deleted	GUID of the Chat	Chat is deleted
Contact
contact.created	Contact	Contact is created
contact.updated	Contact	Contact is updated
contact.deleted	GUID of the Contact	Contact is deleted

Webhooks

Related Articles