웹훅 캠페인 만들기

웹훅 캠페인을 만들거나 멀티채널 캠페인에 웹훅을 포함하면 다른 시스템과 애플리케이션에 실시간 정보를 제공하여 앱 이외의 동작을 트리거할 수 있습니다.

웹훅을 사용하여 Salesforce 또는 Marketo와 같은 시스템이나 백엔드 시스템으로 정보를 보낼 수 있습니다. 예를 들어 고객이 특정 횟수만큼 커스텀 이벤트를 수행한 후 고객의 계정에 프로모션 크레딧을 적립하고 싶을 수 있습니다.

1단계: 메시지 구축 위치 선택하기

메시지를 캠페인으로 보내야 할지 캔버스로 보내야 할지 잘 모르시겠어요? 캠페인은 단일의 간단한 메시징 캠페인에 적합하며, 캔버스는 여러 단계의 사용자 여정에 적합합니다.

• campaign
• canvas

2단계: 웹훅 구축하기

웹훅을 처음부터 새로 만들거나 기존 템플릿을 사용하거나 기존 템플릿 중 하나를 사용할 수 있습니다. 그런 다음 편집기의 작성 탭에서 웹훅을 구축합니다.

작성 탭은 다음 필드로 구성됩니다:

• 언어
• 웹훅 URL
• HTTP 메서드
• 요청 본문

웹훅 템플릿 예시가 있는 ‘작성’ 탭입니다.](/docs/ko/assets/img_archive/webhook_compose.png?50ea81f106ae80aeeab8889296098081)

언어

URL과 요청 본문에서 국제화가 지원됩니다. 메시지를 국제화하려면 언어 추가를 선택하고 필수 입력란을 채우세요.

콘텐츠를 작성하기 전에 언어를 선택하여 Liquid에서 원하는 위치에 텍스트를 채울 수 있도록 하는 것이 좋습니다. 사용 가능한 전체 언어 목록은 지원되는 언어를 참조하세요.

오른쪽에서 왼쪽으로 쓰이는 언어로 문구를 추가하는 경우, 오른쪽에서 왼쪽으로 쓰이는 메시징의 최종 모양은 서비스 제공업체의 렌더링 방식에 따라 크게 달라질 수 있습니다. 최대한 정확하게 오른쪽에서 왼쪽으로 표시되는 메시지를 작성하는 모범 사례는 오른쪽에서 왼쪽으로 메시지 만들기를 참조하세요.

웹훅 URL

웹훅 URL 또는 HTTP URL은 엔드포인트를 지정합니다. 엔드포인트는 웹훅에서 캡처하는 정보를 전송하는 곳입니다.

공급업체에 정보를 보내려면 공급업체가 API 설명서에 이 URL을 제공해야 합니다. 자체 시스템으로 정보를 전송하는 경우 개발자 또는 엔지니어링 팀에 문의하여 올바른 URL을 사용하고 있는지 확인하세요.

Braze는 표준 포트 80 (HTTP) 및 443 (HTTPS)를 통해 통신하는 URL만 허용합니다.

Liquid 사용

Liquid를 사용하여 웹훅 URL을 개인화할 수 있습니다. 특정 엔드포인트에서는 사용자를 식별하거나 URL의 일부로 사용자별 정보를 제공해야 하는 경우가 있습니다. Liquid를 사용할 때는 URL에 사용하는 각 사용자별 정보에 대한 기본값을 포함해야 합니다.

HTTP 메서드

정보를 전송하는 엔드포인트에 따라 사용해야 하는 HTTP 방식이 달라집니다. 대부분의 경우 POST를 사용합니다.

요청 본문

요청 본문은 지정한 URL로 전송될 정보입니다. 웹훅 요청의 본문은 JSON 키-값 페어 또는 원시 텍스트로 작성할 수 있습니다.

JSON 키-값 페어

JSON 키-값 페어를 사용하면 JSON 형식을 기대하는 엔드포인트에 대한 요청을 쉽게 작성할 수 있습니다. JSON 요청을 기대하는 엔드포인트에서만 사용할 수 있습니다. 예를 들어 키가 message_body 인 경우 해당 값은 Your order just arrived! 일 수 있습니다. 키-값 페어를 입력하면 작성기가 JSON 구문으로 요청을 구성하고 JSON 요청의 미리보기가 자동으로 채워집니다.

!!! 요청 본문이 JSON 키-값 페어로 설정되었습니다.](/docs/ko/assets/img/webhook_json_1.png?becf0ae2980f8d192ffab479cc8e4120)

요청에 사용자 속성, 커스텀 속성 또는 이벤트 속성정보를 포함하는 등 Liquid를 사용하여 키-값 페어를 개인화할 수 있습니다. 예를 들어 요청에 고객의 이름과 이메일을 포함할 수 있습니다. 각 속성에 대한 기본값을 포함해야 합니다.

원시 텍스트

원시 텍스트 옵션을 사용하면 모든 형식의 본문을 예상하는 엔드포인트에 대한 요청을 유연하게 작성할 수 있습니다. 예를 들어, 요청이 XML 형식일 것으로 예상되는 엔드포인트에 대한 요청을 작성하는 데 이 기능을 사용할 수 있습니다.

Liquid를 사용한 개인화 및 국제화는 모두 원시 텍스트에서 지원됩니다.

Liquid를 사용한 원시 텍스트가 포함된 요청 본문 예시입니다.](/docs/ko/assets/img_archive/webhook_rawtext.png?bf17237fbbf1ba70de38934d6c262d4f)

Content-Type 요청 헤더를 application/x-www-form-url-encoded 으로 설정한 경우 요청 본문은 URL 인코딩 문자열로 형식화해야 합니다. 예를 들어

1
to={{custom_attribute.${example}}}&text=Your+order+just+arrived

!!! URL 인코딩 문자열이 포함된 요청 본문.](/docs/ko/assets/img_archive/webhook_rawtext_URL-encoded.png?046771a87fd7d2bb85315dceab3e81f8)

3단계: 추가 설정 구성

요청 헤더(선택 사항)

특정 엔드포인트에서는 요청에 헤더를 포함해야 할 수도 있습니다. 작성기의 작성 섹션에서 필요한 만큼 헤더를 추가할 수 있습니다.

‘권한 부여’ 키와 ‘콘텐츠 유형’ 키에 대한 요청 헤더 예시.](/docs/ko/assets/img_archive/webhook_request_headers_example.png?4715c97a5b7a3437fa7555e4f8ec8298)

일반적인 요청 헤더는 Content-Type 사양(본문에서 예상되는 데이터 유형(예: XML 또는 JSON)을 설명)과 공급업체 또는 시스템에 대한 자격 증명을 포함하는 권한 부여 헤더입니다.

콘텐츠 유형 사양은 Content-Type 키를 사용해야 합니다. 일반적인 값은 application/json 또는 application/x-www-form-urlencoded 입니다.

인증 헤더는 Authorization 키를 사용해야 합니다. 일반적인 값은 Bearer {{YOUR_TOKEN}} 또는 Basic {{YOUR_TOKEN}} 이며, YOUR_TOKEN 은 공급업체 또는 시스템에서 제공한 자격 증명입니다.

4단계: 메시지 테스트 보내기

캠페인을 시작하기 전에 웹훅을 테스트하여 요청 형식이 제대로 지정되었는지 확인하는 것이 좋습니다.

테스트 탭으로 전환하여 테스트 웹훅을 전송합니다. 웹훅을 무작위 사용자, 특정 사용자(외부 사용자 ID의 이메일 주소 입력) 또는 원하는 속성을 가진 커스텀 사용자로 테스트할 수 있습니다.

테스트 웹훅을 보내면 응답 메시지와 함께 대화 상자가 나타납니다. 웹훅 요청이 실패한 경우 오류 메시지를 참조하여 웹훅 문제 해결에 대한 도움을 받으세요. 다음 예제에서는 잘못된 웹훅 URL을 사용한 웹훅의 응답에 대해 자세히 설명합니다.

1
2
3
4
5
6
7
8
9
404 Not Found

{
  "error": {
    "message": "Unrecognized request URL. Please see https://lob.com/docs or email us at [email protected].",
    "status_code": 404
  }
}

5단계: 나머지 캠페인 또는 캔버스 구축하기

• campaign
• canvas

6단계: 검토 및 배포

캠페인 또는 캔버스의 마지막 구축을 완료한 후에는 세부 사항을 검토하고 테스트한 다음 전송하세요!

알아두어야 할 사항

오류, 재시도 로직 및 시간 초과

웹훅은 외부 엔드포인트에 요청을 보내는 Braze 서버에 의존하므로 오류가 가끔 발생할 수 있습니다. 가장 일반적인 오류로는 구문 오류, 만료된 API 키, 요금 제한, 예기치 않은 서버 측 문제 등이 있습니다. 웹훅 캠페인을 보내기 전에:

• 웹훅에 구문 오류가 있는지 테스트하기
• 개인화된 변수에 기본값이 있는지 확인합니다.

웹훅이 전송에 실패하면 메시지 활동 로그에 오류 메시지가 기록되며 오류 타임스탬프, 앱 이름, 오류에 대한 세부 정보 등이 포함됩니다.

!”현재 사용자에 대한 정보를 쿼리하려면 활성 액세스 토큰을 사용해야 합니다”라는 메시지가 표시되는 웹훅 오류가 발생했습니다.](/docs/ko/assets/img_archive/webhook-error.png?27ca392cc5bec5126e9ab4375324438e)

오류 메시지에 오류의 원인이 명확하지 않은 경우 사용 중인 API 엔드포인트의 설명서를 확인해야 합니다. 여기에는 일반적으로 엔드포인트에서 사용하는 오류 코드와 일반적으로 발생하는 원인에 대한 설명이 제공됩니다.

응답 코드 및 재시도 로직

웹훅 요청이 전송되면 수신 서버는 요청에 어떤 일이 발생했는지를 나타내는 응답 코드를 반환합니다. 다음 표에는 서버가 보낼 수 있는 다양한 응답, 이러한 응답이 캠페인 분석에 미치는 영향, 오류 발생 시 Braze가 캠페인을 재전송할지 여부가 요약되어 있습니다:

문제 해결 및 추가 오류 세부 정보

특정 웹훅 오류 해결에 대한 자세한 설명, 문제 해결 단계 및 지침은 웹훅 및 연결된 콘텐츠 요청 문제 해결을 참조하세요. 또한, 비정상 호스트 감지 시스템의 작동 방식과 자동화된 이메일 및 추가 로그인을 통해 오류 알림을 제공하는 Braze 커런츠에 대한 자세한 설명도 확인할 수 있습니다.

IP 허용 목록

Braze에서 웹훅이 전송되면, Braze 서버는 고객 또는 타사 서버에 네트워크 요청을 보냅니다. IP 허용 목록을 사용하면 웹훅 요청이 Braze에서 오는지 확인할 수 있어 보안을 한층 강화할 수 있습니다.

Braze는 다음 IP에서 웹훅을 전송합니다. 나열된 IP는 허용 목록에 옵트인한 모든 API 키에 자동으로 동적으로 추가됩니다.

• united states (us)
• european union (eu)
• australia (au)
• indonesia (id)

Braze 파트너와 웹훅 사용하기

웹훅을 사용하는 방법에는 여러 가지가 있으며, 기술 파트너(Alloys)와 함께 웹훅을 사용하여 고객 및 사용자와 직접 커뮤니케이션 수준을 높일 수 있습니다.

확인해보세요:

• 메신저
• Remerge
• Lob.com
• 그리고 더 많은 기술 파트너가 있습니다!