对象

WebhookEndpoint

字段

idinteger必填
urlstring必填
descriptionstring必填
eventsarray of WebhookEventFilter必填
activeboolean必填
statusWebhookStatus必填
paused_atstring (date-time) | null
paused_reasonstring | null
failures：连续 10 次投递尝试失败；feature_disabled：套餐不包含 Webhook。
disabled_reasonstring | null
gone：接收端返回了 410；manual：由管理员停用。
可选值: gonemanualnull
disabled_atstring (date-time) | null
roleWebhookRole必填
data_profile_idinteger | null
Webhook 的数据权限档案（null 表示没有档案，与具有相同角色的 API 密钥相同）。
collection_idsarray of integer必填
Webhook 接收其事件的合集；为空表示角色和数据权限档案可访问的所有合集。
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)必填

使用方

所属对象

WebhookCreated WebhookEndpointList