This document introduces the Kakao Talk Channel webhook feature.

This document explains the webhook requests that Kakao sends to your service's endpoint. Note that this specification describes incoming webhook requests from Kakao, not API requests that your service makes to Kakao.

For the overall workflow and detailed implementation guide for webhooks, see Implementation steps.

The Kakao Talk Channel webhook notifies the service when a user adds or blocks a Kakao Talk channel linked to the app.

Upon receiving the callback, the service must respond with an HTTP status code 2XX within 3 seconds.

For how to implement webhooks, refer to Implementation steps.

You must respond with HTTP status code 2XX within 3 seconds of receiving the webhook request.

This is the example of the webhook request that Kakao sends to your service when one of Kakao Talk Channels is added or blocked.

curl -v -X POST "${KAKAOTALK_CHANNEL_CALLBACK_URL}" \
  -H "Authorization: KakaoAK ${PRIMARY_ADMIN_KEY}" \
  -H "X-Kakao-Resource-ID: ${UNIQUE_ID}" \
  -H "User-Agent: KakaoOpenAPI/1.0" \
  -H "Content-Type: application/json" \
  -d '{
            "event": "added",
            "id": "1111",
            "id_type": "app_user_id",
            "channel_public_id": "_FLX",
            "channel_uuid": "@ad",
            "updated_at": "2019-11-21T10:14:07Z"
        }'