الكائنات

WebhookEndpoint

الحقول

• idintegerمطلوب
• urlstringمطلوب
• descriptionstringمطلوب
• eventsarray of WebhookEventFilterمطلوب
• activebooleanمطلوب
• statusWebhookStatusمطلوب
• paused_atstring (date-time) | null
• paused_reasonstring | null

  القيمة failures: 10 محاولات فاشلة متتالية؛ والقيمة feature_disabled: الخطة لا تشمل خطافات الويب.

• disabled_reasonstring | null

  القيمة gone: أجاب المستقبِل بالرمز 410؛ والقيمة manual: عطّله مشرف.

  القيم المسموح بها: gonemanualnull

• disabled_atstring (date-time) | null
• roleWebhookRoleمطلوب
• data_profile_idinteger | null

  ملف تعريف البيانات لخطاف الويب (القيمة null تعني بلا ملف تعريف، كما في مفتاح API بالدور نفسه).

• collection_idsarray of integerمطلوب

  المجموعات التي يستقبل خطاف الويب أحداثها؛ والقائمة الفارغة تعني كل المجموعات المتاحة للدور وملف تعريف البيانات.

• tagsarray of stringمطلوب

  أحداث البطاقات فقط للبطاقات التي تحمل أيًا من هذه الوسوم؛ والقائمة الفارغة تعني بلا تصفية.

• payloadWebhookPayloadModeمطلوب
• headersarray of WebhookHeaderمطلوب
• auth_typestring | null

  نوع التخويل الصادر (القيمة null تعني بلا تخويل).

  القيم المسموح بها: bearerbasicnull

• auth_setbooleanمطلوب

  يشير إلى ضبط التخويل الصادر (لا تُعاد القيم أبدًا).

• previous_secret_valid_untilstring (date-time) | null

  الوقت الذي تُوقَّع التسليمات حتى حلوله بالسر السابق أيضًا (القيمة null تعني أنه لا توجد فترة تداخل).

• healthWebhookHealth
• consecutive_failuresintegerمطلوب
• last_delivery_atstring (date-time) | null
• last_success_atstring (date-time) | null
• last_errorstring | null
• created_byinteger | null
• created_by_namestring | null
• created_atstring (date-time)مطلوب
• updated_atstring (date-time)مطلوب

يُستخدم في

• GET/v1/webhooks/{webhook_id}الحصول على خطاف ويب
• PATCH/v1/webhooks/{webhook_id}تعديل خطاف ويب
• POST/v1/webhooks/{webhook_id}/revoke-previous-secretإبطال السر السابق
• POST/v1/webhooks/{webhook_id}/resumeاستئناف خطاف ويب

جزء من

WebhookCreatedWebhookEndpointList