웹훅(Webhooks)

왜 웹훅인가? 웹훅을 통해, 애플리케이션에서 이벤트나 작업이 발생할 때마다 제3자 애플리케이션에 HTTP 요청을 보낼 수 있습니다. 간단히 말해, 웹페이지에서 이벤트가 발생하면 데이터를 지속적으로 폴링하지 않고도 제3자 애플리케이션에 자동으로 알릴 수 있습니다. 예를 들어, 전자상거래 웹사이트가 있고 청구 애플리케이션이 통합되어 있다고 가정해 봅시다. 구매가 발생할 때마다 해당 웹훅 URL을 사용하여 청구 시스템에 자동으로 알릴 수 있습니다.

Freshmarketer 웹훅: Freshmarketer 웹훅을 사용하면 데이터를 애플리케이션으로 자동으로 푸시할 수 있으며, 이를 통해 자동으로 실행되는 간단한 일대일 연결을 가질 수 있습니다. Freshmarketer에서 이벤트가 발생할 때마다, 구성한 웹훅 URL로 JSON 형식의 POST 이벤트가 전송됩니다. Freshmarketer의 연락처에 대해 지정된 작업/이벤트가 발생할 때마다 URL이 자동으로 호출됩니다. 예를 들어, 새로운 연락처가 추가될 때마다 Freshmarketer를 구성하여 애플리케이션의 웹훅 URL로 데이터를 자동으로 푸시할 수 있습니다.

Freshmarketer에서 웹훅 구성:
'작업' 아래에 있는 웹훅 블록을 드래그 앤 드롭합니다.
'웹훅 선택 또는 생성'을 클릭합니다. 아래 팝업이 표시되어 사용 가능한 웹훅 목록에서 선택하거나 새로 생성할 수 있는 옵션을 제공합니다.
'새 웹훅 생성'을 클릭합니다.
팝업 창이 로드되어 웹훅 URL의 세부 정보를 구성할 수 있습니다.

• 웹훅 이름: 웹훅에 대한 이름을 제공합니다.
• URL: 웹훅 URL을 입력합니다. URL에 필요한 매개변수가 있는 경우 아래 옵션을 사용하여 플레이스홀더로 추가할 수 있습니다.

필수 인증:
제3자 애플리케이션 URL이 보호되어 있고 인증이 필요한 경우, 두 가지 방법으로 인증할 수 있습니다. Basic을 통해 사용자 이름과 비밀번호를 전달할 수 있으며, Token을 통해 토큰이나 API 키를 전달하여 URL에 접근할 수 있도록 도와줍니다.

사용자 정의 헤더 추가:
웹훅 URL이 보안 정보 등과 같은 콘텐츠와 함께 추가 정보를 요구하는 경우, 이 옵션을 활성화하여 사용자 정의 헤더로 추가할 수 있습니다.

사용자 정의 페이로드 추가:
기본 이벤트 트리거 정보 외에도 페이로드에 사용자 정의 연락처/이벤트 속성을 추가할 수 있습니다. 이러한 이벤트는 HTTP 요청 본문에 JSON 데이터로 전송됩니다.

샘플 페이로드:

{
    "Headers": {
        "Content-Type": "application/json;charset=UTF-8"
    },
    "Body": {
        "event_type": "List",
        "data": {
            "contact": {
                "first name": "test_contact_fname",
                "mobile": "1234567890",
                "email": "testuser@freshmarketer.com"
            },
            "event_details": {
                "list_id": "100",
                "contact_id": "200"
            },
            "custom_data": {
                "name": "test_contact_fname",
                "salary": "123",
                "age": "12"
            }
        },
        "id": "7c076336-6072-4be3-a86f-b7255dbd0d63",
        "event": "list.add_contact",
        "event_category": "system",
        "event_time": 1563186327795
    }
}

웹훅 테스트:
샘플 데이터를 사용하여 웹훅 URL을 테스트할 수 있습니다. 수신된 응답 상태는 200이어야 하며, 그 외의 응답은 실패로 간주됩니다. 이를 통해 웹훅 URL이 유효한지 여부를 확인할 수 있습니다.

구성이 완료되면 '웹훅 생성'을 클릭합니다.

웹훅을 사용한 샘플 여정:
여기서 'Test' 목록의 연락처가 발송된 이메일 캠페인 'Sample'을 클릭할 때마다 웹훅 URL이 호출됩니다.