الانتقال إلى المحتوى الرئيسي
POST
إنشاء نقطة نهاية webhook
يسجل نقطة نهاية webhook جديدة للمستأجر المصادق عليه. تتلقى نقطة النهاية طلبات HTTP POST عند حدوث أحداث مطابقة. يتم إرجاع سر نقطة النهاية مرة واحدة في الاستجابة — قم بتخزينه بأمان.
يعتمد عدد نقاط نهاية الويب هوك التي يمكنك إنشاؤها على خطة الفوترة الخاصة بك. إذا تجاوزت حد خطتك، فستُرجع واجهة برمجة التطبيقات 402 Payment Required.

الاستجابات

يتم إرجاع حقل secret فقط في استجابة الإنشاء. قم بتخزينه بأمان — لا يمكنك استرداده لاحقًا. إذا فقدته، قم بتدوير السر لإنشاء سر جديد.

التفويضات

X-API-Key
string
header
مطلوب

مفتاح API للمصادقة من جهاز إلى جهاز

الجسم

application/json
name
string
مطلوب

اسم نقطة النهاية المقروء بشريًا

url
string
مطلوب

عنوان URL لـ HTTPS لتسليمات webhook

event_filters
string[]
مطلوب

أنواع الأحداث أو أنماط البدل

الاستجابة

تم إنشاء نقطة النهاية

id
string
name
string
url
string
status
string
secret
string
event_filters
string[]
created_at
string