Objetos

WebhookEndpoint

Campos

idintegerobrigatório
urlstringobrigatório
descriptionstringobrigatório
eventsarray of WebhookEventFilterobrigatório
activebooleanobrigatório
statusWebhookStatusobrigatório
paused_atstring (date-time) | null
paused_reasonstring | null
failures: 10 tentativas com falha seguidas; feature_disabled: o plano não inclui webhooks.
disabled_reasonstring | null
gone: o receptor respondeu 410; manual: desativado por um administrador.
Valores permitidos: gonemanualnull
disabled_atstring (date-time) | null
roleWebhookRoleobrigatório
data_profile_idinteger | null
Perfil de dados do webhook (null significa sem perfil, como em uma chave de API com a mesma função).
collection_idsarray of integerobrigatório
Coleções sobre as quais o webhook recebe eventos; vazio significa todas as coleções disponíveis para a função e o perfil de dados.
tagsarray of stringobrigatório
Eventos de cartões só para cartões com alguma destas etiquetas; vazio significa sem filtro.
payloadWebhookPayloadModeobrigatório
headersarray of WebhookHeaderobrigatório
auth_typestring | null
Tipo da autorização de saída (null significa nenhuma).
Valores permitidos: bearerbasicnull
auth_setbooleanobrigatório
Indica se a autorização de saída está definida (os valores nunca são retornados).
previous_secret_valid_untilstring (date-time) | null
Até quando as entregas também são assinadas com o segredo anterior (null significa que não há sobreposição).
healthWebhookHealth
consecutive_failuresintegerobrigatório
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)obrigatório
updated_atstring (date-time)obrigatório

Usado em

Parte de

WebhookCreated WebhookEndpointList