Comment on page

Overview

A webhook is a way for MinChat to notify your server in real-time when a specific event occurs.
When webhooks are enabled in the minchat dashboard, your server will receive HTTP POST requests from minchat servers notifying you about events that happen in your application between your users.
​
Webhook Events
MinChat supports the following webhook events
Message Sent
Is triggered when a message is sent by a user.
payload
{
 "sent_by":{
 "id":"639575b2c280a7001e892906",
 "name":"Samantha Smith",
 "username":"samantha",
 "avatar": "urltoavatar.com/mercyavatar.jpg"
 },
 "sent_to":[
 {
 "id":"289575b9b280a7001e892956",
 "name":"Jackie",
 "username":"jackie_01",
 "avatar": "urltoavatar.com/mercyavatar.jpg"
 }
 ],
 "chat_id": "63d3e12d669fc928b3d78f80",
 "text":"Hello guys!",
 "file": {
 type: "image",
 url: "https://urltofile.com/image.jpeg",
 "name": "Assignment Project",
 "size": "2 MB",
 }
}
Field
Type
Description
sent_by
​User​
The user that sent the message
sent_to
​User[]​
An array of users that have received the message
text
string
The content of the message
file
​File​
A file attachment associated with this message
chat_id
string
The id of the conversation this message was sent to
​
New Daily Active User
Is triggered when there is a new daily active user.
{
 "id":"639575b2c280a7001e892906",
 "name":"Samantha Smith",
 "username":"samantha",
 "avatar": "urltoavatar.com/mercyavatar.jpg"
}
The payload is a User object

Field	Type	Description
`sent_by`	`User`	The user that sent the message
`sent_to`	`User[]`	An array of users that have received the message
`text`	`string`	The content of the message
`file`	`File`	A file attachment associated with this message
`chat_id`	`string`	The id of the conversation this message was sent to

Last modified 1mo ago