وبهوکها به شما امکان دریافت اعلانهای بلادرنگ هنگام وقوع رویدادها در رباتها را میدهند. به جای نظرسنجی API، یک آدرس وبهوک پیکربندی کنید و ما رویدادها را فوراً برای شما ارسال میکنیم.
رویدادهای موجود
message.receivedپیام جدید در یک چت
message.editedپیام ویرایش شد
member.joinedکاربر به یک گروه پیوست
member.leftکاربر از یک گروه خارج شد
bot.addedربات به یک گروه اضافه شد
bot.removedربات از یک گروه حذف شد
command.executedدستور ربات اجرا شد
module.triggeredیک عمل ماژول فعال شد
Endpoints
GET
/api/webhooksفهرست تمام وبهوکهای پیکربندی شده
botId
POST
/api/webhooksایجاد یک نقطه پایانی وبهوک جدید
urleventssecret
PATCH
/api/webhooks/:idبهروزرسانی پیکربندی وبهوک
urleventsstatus
DELETE
/api/webhooks/:idحذف یک وبهوک
id
POST
/api/webhooks/:id/testارسال یک رویداد آزمایشی به وبهوک شما
id
امنیت وبهوک
تأیید امضا
تمام بارهای وبهوک شامل یک هدر امضا برای تأیید هستند:
X-BotLaunch-Signature: sha256=abc123...Example Payload
{
"event": "message.received",
"timestamp": "2024-01-15T10:30:00Z",
"data": {
"messageId": "msg_abc123",
"chatId": "-100123456789",
"from": {
"id": 123456789,
"username": "johndoe"
},
"text": "Hello, bot!"
}
}سیاست تلاش مجدد
If your endpoint returns a non-2xx status, we'll retry up to 3 times with exponential backoff (10s, 30s, 90s). After 3 failures, the webhook is paused.