أحداث Webhooks في API داخل المواقع

اشترك في أحداث Webhooks للحصول على إشعارات حول الرسائل التي يتلقاها نشاطك التجاري وتحديثات الملف الشخصي للعميل. راجع نظرة عامة، أحداث Webhooks لمزيد من المعلومات حول أحداث webhooks لمنصة واتساب للأعمال.

قبل البدء

ستحتاج إلى ما يلي:

• رمز يدعم HTTPS ويتضمن شهادة SSL صالحة
• نقطة نهاية عنوان URL الاستدعاء التي تم تكوينها لقبول الطلبات الواردة من Coreapp
• نقطة نهاية عنوان URL الاستدعاء التي تُرجع استجابة HTTPS 200 OK عند تلقي إشعار

إعادة المحاولة

في حالة عدم تسليم الإشعار لأي سبب أو في حالة إرجاع طلب webhook رمز حالة HTTP بخلاف 200، سنعيد محاولة التسليم. وسنستمر في إعادة محاولة تسليم الحدث مع زيادة فترات التأخير حتى مهلة محددة (بصفة أساسية لمدة 24 ساعة على الرغم من احتمالية اختلاف هذه المدة) أو حتى تنجح عملية التسليم.

تعيين نقطة نهاية عنوان URL الاستدعاء

أرسل طلب PATCH إلى نقطة النهاية /v1/settings/application مع تعيين المعلمة webhooks في نقطة نهاية عنوان URL الاستدعاء. ومن المعلمات الشائعة الأخرى التي تم تكوينها sent_status وcallback_persist.

مثال على الطلب

PATCH /v1/settings/application
{
    "callback_persist": true,
    "sent_status": true,  // Either use this or webhooks.message.sent, but webhooks.message.sent property is preferred as sent_status will be deprecated soon
    "webhooks": { 
    	"url": "webhook.your-domain", 
        "message": {     // Available on v2.41.2 and above
        	"sent": false,
        	"delivered": true,
        	"read": false
       },
    }
}

عند نجاح الأمر، تحتوي الاستجابة على 200 OK يتضمن null أو كائن JSON.

تفضل بزيارة مرجع إعدادات التطبيق لمزيد من المعلومات حول تكوين تطبيقك ومعلمات أحداث webhooks الإضافية.

حمولة بيانات إشعار Webhook

راجع المكونات لمزيد من المعلومات حول كل حقل.

إشعار الخطأ

{
    "errors": [ {
       "code": <error-code>,
       "title": "<error-title>",
       "details": "<error-description>",
       "href": "location for error detail"
    },
    {
       ...
    }
    ]
 }

عينة من نقاط نهاية التطبيق

لاختبار أحداث Webhooks، يمكنك إنشاء عينة من التطبيق تتضمن نقطة نهاية لتلقي الإشعارات.

• عينة من نقاط نهاية التطبيق باستخدام Glitch