Event Type | Category | Description |
---|---|---|
agent_created | Agent Events | Agent was created |
agent_updated | Agent Events | Agent was updated |
agent_deleted | Agent Events | Agent was deleted |
message_received | Message Events | Message received on any channel |
organisation_created | Organisation Events | Organisation was created |
organisation_updated | Organisation Events | Organisation was updated |
organisation_deleted | Organisation Events | Organisation was deleted |
client_created | Client Events | Client was created |
client_updated | Client Events | Client was updated |
client_deleted | Client Events | Client was deleted |
lead_captured | Lead Events | Lead was captured by an agent |
webhook_test | Test Event | Used for testing your webhook endpoint |
Property | Value |
---|---|
HTTP Method | POST |
Content Type | application/json |
agent_created
, agent_updated
, agent_deleted
Payload fields:
agentId
(string): The ID of the agentagentName
(string, optional): The name of the agentagentPlatform
(“vg” | “vf”, optional): The platform of the agentoperation
(“created” | “updated” | “deleted”): The operation performedcreatedAt
(number): Timestamp (ms)workspaceSecret
(string): Workspace secret for verificationmessage_received
Payload fields:
agentId
(string): The ID of the agentagentName
(string, optional): The name of the agentconvoId
(string): The ID of the conversationmessageContent
(string): The content of the messagechannel
(“whatsapp” | “instagram” | “facebook” | “telegram” | “webchat”): The channelmessageType
(string, optional): The type of the messagefrom
(string, optional): The sendercreatedAt
(number): Timestamp (ms)workspaceSecret
(string): Workspace secret for verificationorganisation_created
, organisation_updated
, organisation_deleted
Payload fields:
organisationId
(string): The ID of the organisationorganisationName
(string, optional): The name of the organisationoperation
(“created” | “updated” | “deleted”): The operation performedcreatedAt
(number): Timestamp (ms)workspaceSecret
(string): Workspace secret for verificationclient_created
, client_updated
, client_deleted
Payload fields:
organisationId
(string): The ID of the organisationorganisationName
(string, optional): The name of the organisationclientId
(string): The ID of the clientclientName
(string, optional): The name of the clientclientEmail
(string, optional): The email of the clientoperation
(“created” | “updated” | “deleted”): The operation performedcreatedAt
(number): Timestamp (ms)workspaceSecret
(string): Workspace secret for verificationlead_captured
Payload fields:
agentId
(string): The ID of the agentagentName
(string, optional): The name of the agentleadName
(string, optional): The name of the leadleadEmail
(string, optional): The email of the leadleadPhone
(string, optional): The phone of the leadchannel
(see below): The channel where the lead was capturedoperation
(“captured”): The operation performedcreatedAt
(number): Timestamp (ms)workspaceSecret
(string): Workspace secret for verificationvoice
, vapi
, web-chat
, whatsapp
, instagram
, telegram
, discord
, gb-chat
, messenger
, telephony
, webchat
webhook_test
Payload fields:
message
(string): Test messagecreatedAt
(number): Timestamp (ms)workspaceSecret
(string): Workspace secret for verificationwebhook_test
event. This event is sent with a simple payload and can be used to verify your endpoint is reachable and correctly configured.
Sample: