This document introduces the Kakao Talk Share 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.

When invoking the Kakao Talk Share API via the SDK, you must specify custom parameters using serverCallbackArgs to receive the Kakao Talk Share webhook. For more details, see the development guides as below.

• JavaScript
• Android
• iOS

Notifies the service when a user's Kakao Talk Share message is successfully delivered.

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

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

These are examples of the webhook request that Kakao sends to your service when the Kakao Talk message is successfully delivered.

curl -v -G GET "${KAKAOLINK_CALLBACK_URL}?CHAT_TYPE=MemoChat&HASH_CHAT_ID=${HASH_CHAT_ID}&TEMPLATE_ID=10000&custom_parameter_key=custom_parameter_value" \
  -H "Authorization: KakaoAK ${PRIMARY_ADMIN_KEY}" \
  -H "X-Kakao-Resource-ID: ${UNIQUE_ID}" \
  -H "User-Agent: KakaoOpenAPI/1.0"

curl -v -X POST "${KAKAOLINK_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 '{
            "CHAT_TYPE": "MemoChat",
            "HASH_CHAT_ID": "${HASH_CHAT_ID}",
            "TEMPLATE_ID": 10000,
            "custom_parameter_key": "custom_parameter_value"
        }'