Klaviyo 고급 데이터 플랫폼에서 웹후크 이해하기

학습 내용

웹후크와, Klaviyo에서 캡처한 이벤트에 대응해 타사 애플리케이션으로 정보를 전송하는 데 웹후크를 사용하는 방법을 알아보세요. 시스템 웹후크를 수신하는 방법에 대한 더 자세한 내용은 시스템 웹후크 사용하기에 관한 개발자 리소스를 확인해 주세요.

This content requires Functional cookies to be enabled.

Update Cookie Settings

웹후크란 무엇인가요?

웹후크를 사용하면 HTTP 요청을 통해 Klaviyo가 정보를 전달하거나 다른 애플리케이션, 도구, 서버를 “호출”할 수 있어요. 발생한 이벤트(예: 주문 완료, 새 고객 구독 등)에 대한 정보를 보내거나, 해당 이벤트가 발생했음을 외부 시스템에 알릴 수 있어요.

Klaviyo는 2가지 종류의 웹후크를 지원해요:

1. Klaviyo 고급 데이터 플랫폼의 웹후크
   Klaviyo 고급 데이터 플랫폼의 일부로 제공되는 웹후크는 특정 이벤트가 발생했음을 외부 시스템에 알리고, 플로우에 속해 있어야 하는 제한 없이 다양한 이벤트에 대한 응답으로 정보를 전송할 수 있도록 해요.
2. 플로우 웹후크
   플로우 웹후크는 플로우 인터페이스에서만 사용할 수 있으며, 플로우가 특정 단계 또는 스텝에 도달하면 트리거돼요. 플로우를 트리거한 이벤트 또는 수신자에 대한 데이터를 전송하는 데 사용할 수 있어요.

웹후크의 주요 구성 요소

웹후크는 몇 가지 핵심 구성 요소로 이루어져 있어요:

• 주제
  웹후크가 실행되도록 하는 이벤트
• 본문(또는 “페이로드”)
  웹후크가 전송하는 데이터
• 헤더
  추가 정보(예: 인증)를 전달하는 곳

Klaviyo 고급 데이터 플랫폼의 웹후크는 플로우 웹후크와 어떻게 다른가요?

필요에 따라 Klaviyo 고급 데이터 플랫폼의 웹후크 또는 플로우 웹후크를 사용할 수 있어요.

포함된 이벤트

플로우 웹후크는 Klaviyo 이벤트의 일부에만 응답할 수 있으며, 플로우는 일반적으로 메시지 수신으로 시작하기보다는 메시지 수신으로 끝나기 때문에 구독 취소, 이메일 수신 또는 이메일 클릭과 같은 메시지 관련 이벤트는 지원하지 않아요. 반면 Klaviyo 고급 데이터 플랫폼의 웹후크를 사용하면 계정의 모든 이벤트에 응답하여 정보를 전송할 수 있어요.

이러한 이벤트에는 다음이 포함됩니다.

• 이메일 이벤트(예: 이메일 수신, 이메일 클릭, 이메일을 스팸으로 표시, 구독 취소)
• SMS 이벤트(예: Sent SMS, Received SMS)
• 푸시 알림 이벤트(예: 푸시 수신, 푸시 반송)
• 연동의 이벤트(예: Klaviyo에서 만든 자사 연동의 이벤트)
• API 이벤트(예: Klaviyo의 API를 통해 동기화된 이벤트)

페이로드

플로우 웹후크를 사용하면 요청에 포함되는 데이터를 맞춤 설정할 수 있지만, 페이로드는 수동으로 구성해야 해요. 한편, Klaviyo 고급 데이터 플랫폼의 웹후크는 수동 작업이 필요 없는 미리 구성된 페이로드를 사용하며, 이벤트가 발생했음을 외부 시스템에 알리는 데 사용돼요.

플로우 제한 사항

플로우 웹후크는 플로우 인터페이스 내에서 구성해야 하며, 여러 트리거를 동시에 사용할 수 없어요. 서로 다른 트리거는 각각 별도의 플로우를 통해 생성해야 하며, 플로우의 전체 상태에 따라 달라져요(예: 초안 상태의 플로우는 플로우 웹후크를 통해 데이터를 전송하지 않아요). 반면 Klaviyo 고급 데이터 플랫폼의 웹후크는 플로우 인터페이스 외부에 있으며, 플로우 웹후크처럼 웹후크 작업 이전의 단계 흐름에 의존하지 않아요.

웹후크 설정

Klaviyo에서 웹후크를 설정하려면 Klaviyo의 Klaviyo 고급 데이터 플랫폼 > 데이터 관리 > 웹후크 아래에 있는 웹후크 로 이동해 주세요.

새 웹후크를 추가하려면 웹후크 만들기 버튼을 클릭하세요.

1. 웹후크 만들기 모달에서 정보를 입력해 주세요. 여기에는 다음이 포함됩니다.
   • 이름
     웹후크를 식별하는 방법
   • 엔드포인트 URL
     웹후크 요청의 목적지와 연결된 URL
   • 비밀 키
     다른 시스템에서 Klaviyo 웹후크 요청을 식별하기 위한 고유 식별자예요.
   • 설명
     웹후크에 대한 선택적 설명입니다.
2. Topics 섹션에서 웹후크 알림을 트리거할 이벤트를 선택해 주세요.

웹후크를 만들면 웹후크 페이지에 다음 항목과 함께 표시돼요.

• 웹후크 이름
• 웹후크 URL
• 최신 동기화 시간
• 상태

항목 옆의 메뉴를 사용하여 웹후크를 삭제하거나 비활성화할 수 있어요.

시스템 웹후크 테스트

Klaviyo에서 웹후크를 설정할 때 연결이 성공했는지 확인하기 위해 테스트할 수 있습니다. 웹후크를 테스트하려면, 필수 필드를 입력한 다음 연결 테스트 버튼을 사용하세요.

주제를 선택하고 콜백 URL로 테스트를 전송할 수 있는 메뉴가 표시돼요.

테스트를 실행한 후, 성공 여부를 알려주는 메시지가 표시되며 Response 탭에 요청의 헤더와 본문이 채워진 상태로 표시돼요.

예시 페이로드

아래는 이메일 전달됨 주제에 대한 응답으로 웹후크 요청에 사용되는 페이로드의 예입니다.

{
  "meta": {
    "timestamp": "2023-08-10T07:25:23.700369+00:00",
    "klaviyo_webhook_id": "ID",
    "version": "2023-06-03"
  },
  "data": [
    {
      "topic": "event: email_delivered",
      "external_id": "ID",
      "payload": {
        "data": {
          "id": "ID",
          "type": "event",
          "links": {
            "self": "https://a.klaviyo.com/api/events/ID/"
          },
          "attributes": {
            "uuid": "96150200-374e-11ee-8001-a163313bc6c2",
            "datetime": "2023-08-10 07:21:56+00:00",
            "timestamp": 1691652116,
            "event_properties": {
              "$ESP": 0,
              "Subject": "? Free (Cool!) Swag Alert ?",
              "$message": "01H7F525FKR31P27Y7PNGVBBKK",
              "$event_id": "01H7F525FKR31P27Y7PNGVBBKK:125423419905414052533228990613763937641",
              "$group_ids": [
                "V7adxq"
              ],
              "$attribution": {
                "$send_ts": 0,
                "$attributed_event_id": ""
              },
              "Email Domain": "klaviyo-demo.com",
              "Campaign Name": "Daily Newsletter: 2023-08-10",
              "Inbox Provider": "Amazon SES Inbound",
              "$_cohort$message_send_cohort": "1691652081:01H7F525FKR31P27Y7PNGVBBKK"
            }
          },
          "relationships": {
            "metric": {
              "data": {
                "id": "ID",
                "type": "metric"
              },
              "links": {
                "self": "https://a.klaviyo.com/api/events/ID/relationships/metric/",
                "related": "https://a.klaviyo.com/api/events/ID/metric/"
              }
            },
            "profile": {
              "data": {
                "id": "ID",
                "type": "profile"
              },
              "links": {
                "self": "https://a.klaviyo.com/api/events/ID/relationships/profile/",
                "related": "https://a.klaviyo.com/api/events/ID/profile/"
              }
            }
          }
        }
      }
    },
  

추가 자료