Об’єкти

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