الكائنات

WebhookCreate

الحقول

• urlstringمطلوب

  عنوان URL للمستقبِل، https:// فقط، حتى 2048 حرفًا.

  length ≤ 2048

• descriptionstring

  length ≤ 200

• eventsarray of WebhookEventFilterمطلوب

  items ≥ 1

• roleWebhookRole
• data_profile_idinteger | null
• collection_idsarray of integer

  المجموعات التي يستقبل خطاف الويب أحداثًا عنها. غياب القيمة أو القائمة الفارغة يعني كل المجموعات المتاحة للدور وملف تعريف البيانات. والمفتاح المقصور هو نفسه على مجموعات لا ينشئ خطاف ويب إلا بقائمة غير فارغة من مجموعاته. وبدون هذا الحقل، أو مع قائمة فارغة، أو مع مجموعة خارج قائمته، يعيد الطلب 403 webhooks.collections_outside_key.

  items ≤ 200

• tagsarray of string

  items ≤ 50

• payloadWebhookPayloadMode
• headersarray of WebhookHeaderInput

  items ≤ 10

• authWebhookAuthInput

يُستخدم في

• POST/v1/webhooksإنشاء خطاف ويب