Teambox Event Webhook
Overview
The Teambox Event Webhook feature is used to trigger webhooks whenever an event occurs in your Teambox conversations, such as when a chat is assigned, a chat request is accepted, rejected, or solved, etc.
The webhook payload includes details of each event, including Project ID, Event ID, Event Description, user details, contact number, Channel ID, and timestamp, etc.. in JSON format.
You can configure the Webhook URL in the Developer Settings within the admin platform to receive all enabled event webhook data in your own application or server. This data can then be used for further actions or automations within your system..
Webhook Setup
To start receiving webhooks, you need to configure them in the Admin Platform under Developer Settings
Steps to access:
Click on All Menu
Navigate to Developers under Settings
Click on the Webhook tab
Scroll down to find the Teambox Event Webhook section, as shown in the image below
In this section, you can enter your Webhook URL in the provided textbox and click Save.
Below the URL field, you will find checkboxes for each event. You can enable or disable specific events by checking or unchecking these boxes and clicking the Save button. This allows you to control which events should trigger webhooks based on your requirements.
Once the setup is complete, webhooks will be triggered for all enabled events whenever they occur in Teambox.
You can update these settings at any time. Make sure to click the Save button after making any changes.
Note: A Connector URL can also be used as the Webhook URL, enabling further automation within the Picky Assist platform
Event Webhook Variables
project_id
String
Your project ID
event_description
String
Represents the name of the event that has been triggered
user
String
Name of the user involved in the event action
user_id
String
System-generated unique identifier for the user
assigned_to
String
The user (agent/admin) to whom the chat has been assigned
assigned_to_userid
String
The unique identifier of the user to whom the chat is assigned
assigned_through
String
Indicates the method through which the chat was assigned (Teambox, Connector, Flows, Smart Replies)
channel
String
ID of the channel where the conversation occurs
contact_id
String
The unique identifier of the contact involved in the chat
contact_mobile
String
Mobile number of the contact involved in the chat
timestamp
String
Indicates the date and time at which the event was triggered
kicked_out_user
String
Represents the user who has been removed from the conversation
kicked_out_by
String
Indicates who performed the action of removing the user from the conversation. This will generally be the System.
connector_name
String
Name of the Connector through which the chat is assigned
flow_name
String
Name of the Flow through which the chat is assigned
assign_type
String
Specifies whether the chat was assigned manually or forcefully
Teambox Events and ID
Chat Assigned
When a chat is assigned by admin or agent
1
Chat Accepted
When the chat request is accepted by admin or agent
2
Chat Rejected
When the chat request is rejected by admin or agent
3
Chat Solved
When the chat is Marked as Done by the admin or agent
4
Missed a Chat
When the chat is missed by admin and agents
5
Started a Conversation
When admin or agent manually joins in a chat
6
Kicked Out of a Conversation
When admins or agents got kicked out off a conversation
7
Events and Sample Payloads
1. Chat Assigned (event_id = 1)
This event is triggered when a user or admin assigns a contact’s chat to another user. Chat assigning can be performed through Teambox and through Connectors, Flows, or Smart Replies by Assign Chat feature in actions.
The webhook payload for this event includes key parameters such as Assigned by user details, Assigned to user details, and Assigned Through (Teambox, Connector, Flow, or Smart Replies), along with other standard parameters.
A sample webhook payload for the Chat Assigned event is provided below;
2. Chat Accepted (event_id = 2)
This event is triggered when a user or admin accepts a chat request in Teambox. It is triggered when accepting an incoming chat request, as well as when accepting chats that were manually assigned by other users through Teambox or via the “Assign Chat” action in Connectors, Flows, or Smart Replies.
In case of bulk chat acceptance, the webhook is triggered separately for each request, along with the corresponding contact details.
A sample webhook payload for the Chat Accepted event is provided below;
3. Chat Rejected (event_id = 3)
This event is triggered when a user or admin rejects a chat request in Teambox, including bulk rejections. For bulk chat rejection, the webhook is triggered separately for each request, along with the corresponding contact’s ID and mobile number.
A sample webhook payload for the Chat Rejected event is provided below;
4. Chat Solved (event_id = 4)
This event is triggered when a user or admin clicks on “Mark as Done” in a chat in Teambox, indicating that the chat has been resolved. The webhook payload includes details of the user who solved the chat, along with the corresponding contact details.
A sample webhook payload for a Solved Chat event is provided below;
5. Missed a Chat (event_id = 5)
This event is triggered when an incoming chat is not accepted by any user or admin and is marked as missed. The chat is then moved to the “Missed Chat” tab in Teambox. The webhook payload includes the contact details of the missed chat and user details of admin.
A sample webhook payload for a Missed Chat event is provided below;
6. Started a Conversation (event_id = 6)
This event is triggered when a user or admin manually joins a chat by clicking the “Join Chat” button. This action can be performed on chats that are either under the Solved Chats or Missed Chats sections in Teambox.
A sample webhook payload for Started a Conversation event is provided below;
7. Kicked Out of a Conversation (event_id = 7)
This event is triggered when a user or admin is removed from a conversation using the “Kick Out User from Conversation” action in Connectors or Flows. This action can only be performed by an admin and allows the removal of any user from the chat.
When the “Kick Out All Users” action is used, all users, including the admin, are removed from the chat. In this case, the webhook is triggered separately for each user who is removed.
The webhook payload for this event includes additional parameters, such as “Kicked Out User”, which indicates the user who was removed, and “Kicked Out By”, which will always be the system.
Last updated
Was this helpful?