웹훅

이 문서는 카카오 API 플랫폼에서 제공하는 웹훅(Webhook) 기능을 안내합니다.

기능 소개

서비스 외부에서 발생하는 사용자의 활동이나 계정 상태의 변화에 대응할 수 있도록 웹훅 기능을 제공합니다. 카카오 API 플랫폼에서 제공하는 웹훅 종류는 아래와 같습니다.

웹훅	설명	관련 제품
연결 끊기 웹훅	사용자 카카오계정과 서비스 앱의 연결이 끊어졌을 때, 해당 사용자를 탈퇴 처리할 수 있도록 관련 정보를 서비스로 전달	카카오 로그인
계정 상태 변경 웹훅	서비스로 사용자 계정 상태 변경 이벤트 정보 전달	카카오 로그인
카카오톡 공유 웹훅	카카오톡 공유 메시지 전송에 성공했을 때, 전송한 메시지의 정보를 서비스로 전달	카카오톡 공유
카카오톡 채널 웹훅	사용자가 서비스의 카카오톡 채널을 추가 또는 차단했을 때, 서비스로 관련 정보 전달	카카오톡 채널

이용 정책

웹훅 수신 시 필수 응답 규격

서비스 서버는 웹훅 수신 시 각 웹훅의 필수 응답 규격을 만족하도록 응답해야 합니다. 그렇지 않으면 웹훅 일시 중지 상태로 변경될 수 있습니다. 웹훅별 필수 응답 규격은 기능 소개의 해당 개발 문서를 참고합니다.

웹훅 일시 중지

1개월 이상 웹훅 수신 응답이 없거나 오류 발생 빈도가 높은 경우, 각 웹훅 기능을 [일시 중지] 상태로 변경합니다. 이 경우, 다시 사용 설정하기 전까지 해당 웹훅의 발송이 중단됩니다.

웹훅 수신을 위한 IP 허용 설정

서비스 서버에서 ACL(Access Control List, 접근 제어 목록)을 관리하는 경우, 웹훅을 정상적으로 수신하려면 아래 카카오 API 플랫폼의 IP를 허용 목록(Allowlist)에 추가해야 합니다. 방화벽을 참고합니다.