Links

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
{
"sentBy":{
"id":"639575b2c280a7001e892906",
"name":"Samantha Smith",
"avatar": "urltoavatar.com/mercyavatar.jpg"
},
"sentTo":[
{
"id":"639575b2c280a7001e892906",
"name":"Jackie",
"avatar": "urltoavatar.com/mercyavatar.jpg"
}
],
"text":"Hello guys!",
"channelId": "63d3e12d669fc928b3d78f80"
}
Field
Type
Description
sentBy
User
The user that sent the message
sentTo
User[]
An array of users that have received the message
text
string
The content of the message
channelId
string
The id of the conversation this message was sent to
Last modified 4mo ago