オブジェクト

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