Обекти
WebhookEndpoint
Полета
idintegerзадължителноurlstringзадължителноdescriptionstringзадължителноactivebooleanзадължителноpaused_atstring (date-time) | nullpaused_reasonstring | nullfailures: 10 неуспешни опита подред;feature_disabled: планът не включва уебхукове.disabled_reasonstring | nullgone: получателят е отговорил с 410;manual: изключен от администратор.Допустими стойности:
gonemanualnulldisabled_atstring (date-time) | nulldata_profile_idinteger | nullПрофил за достъп на уебхука (
nullозначава без профил, както при API ключ със същата роля).collection_idsarray of integerзадължителноКолекции, за които уебхукът получава събития; празно означава всички колекции, достъпни за ролята и профила за достъп.
tagsarray of stringзадължителноСъбития за карти само за карти с някой от тези етикети; празно означава без филтър.
auth_typestring | nullТип на изходящата оторизация (
nullозначава без такава).Допустими стойности:
bearerbasicnullauth_setbooleanзадължителноДали е зададена изходяща оторизация (стойностите никога не се връщат).
previous_secret_valid_untilstring (date-time) | nullДо кога доставките се подписват и с предишната тайна (
nullозначава, че няма припокриване).healthWebhookHealthconsecutive_failuresintegerзадължителноlast_delivery_atstring (date-time) | nulllast_success_atstring (date-time) | nulllast_errorstring | nullcreated_byinteger | nullcreated_by_namestring | nullcreated_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Възобновяване на уебхук