객체

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