웹훅 엔드포인트 수정
PATCH /v1/webhook-endpoints/{endpoint_id} · 권한 webhook-endpoints:write · 모든 요금제
JSON 병합 패치(RFC 7396, Content-Type: application/merge-patch+json)로 엔드포인트를 변경합니다. If-Match는 필수이며, 현재 값은 웹훅 엔드포인트 조회의 ETag 헤더입니다. 아무것도 변경하지 않는 패치는 기록되지 않으며 버전도 유지됩니다.
status는enabled와disabled_by_user만 허용합니다.enabled로 설정하면 요금제의 활성 엔드포인트 한도에 포함되며failing_since가 지워집니다. 실패 후 비활성화되었거나 수신 측에 의해 비활성화된 엔드포인트를 다시 활성화하는 방법입니다.null은description과event_schema_versions를 지웁니다(또는 항목 하나만 지울 수 있습니다:{"event_schema_versions": {"user.created": null}}). 그 밖의 다른 필드에서는422 invalid가 반환됩니다.event_types는 전체가 교체됩니다.
요청
| 필드 | 유형 | 필수 | 설명 |
|---|---|---|---|
endpoint_id |
path | 예 | 웹훅 엔드포인트 ID(whe_…). |
If-Match |
header | 예 | 엔드포인트의 현재 ETag(*는 모든 버전과 일치). |
key, url, description, event_types, event_schema_versions, payload_mode, rate_limit_per_second |
아니요 | 웹훅 엔드포인트 추가와 동일합니다. | |
status |
string | 아니요 | enabled 또는 disabled_by_user. |
{
"status": "enabled",
"event_types": ["user.created", "user.updated", "user.deleted"]
}
응답
200 OK와 함께 엔드포인트(웹훅 엔드포인트 조회와 동일)와 새 ETag를 반환합니다.
오류
| HTTP | code | 발생 조건 |
|---|---|---|
| 400 | malformed_request |
본문이 JSON 객체가 아닙니다. |
| 400 | unknown_field |
패치에 위에 나열되지 않은 필드가 있습니다. |
| 403 | quota_exceeded |
status: enabled로 설정하면 요금제의 활성 엔드포인트 수를 초과합니다. |
| 404 | not_found |
이 환경에 해당 엔드포인트가 없습니다. |
| 409 | conflict |
같은 환경의 다른 엔드포인트가 이 key를 사용하고 있습니다. |
| 412 | precondition_failed |
If-Match가 현재 버전과 일치하지 않습니다(읽은 이후에 엔드포인트가 변경되었습니다). |
| 422 | validation_failed |
필드가 유효하지 않습니다(포인터는 웹훅 엔드포인트 추가와 동일). enabled 또는 disabled_by_user가 아닌 상태 값은 /status invalid로 표시됩니다. |
| 428 | precondition_required |
If-Match가 없습니다. |
| 401 | unauthenticated |
자격 증명이 없거나, 유효하지 않거나, 폐기되었습니다. |
| 403 | insufficient_permissions |
자격 증명에 webhook-endpoints:write 권한이 없습니다. |
| 503 | service_unavailable |
웹훅 관리 기능을 일시적으로 사용할 수 없습니다. Retry-After 기간 이후에 다시 시도하십시오. |
예시
curl -X PATCH https://api.eu.keenauth.com/v1/webhook-endpoints/whe_01k8a3m5q7t9v1w3x5y7z9b2c4 \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
-H "Content-Type: application/merge-patch+json" \
-H 'If-Match: "3"' \
-d '{"status":"enabled"}'
CLI: keenauth webhook-endpoints update whe_01k8a3m5q7t9v1w3x5y7z9b2c4 --status enabled --if-match '"3"'