웹훅 만들기

웹훅 캠페인을 생성하거나 멀티채널 캠페인에 웹훅을 포함하면 앱 이외의 액션을 트리거할 수 있습니다. 보다 구체적으로 웹훅은 다른 시스템과 애플리케이션에 실시간 정보를 제공하는 데 사용할 수 있습니다.

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

웹훅의 정의와 Braze에서 웹훅을 사용하는 방법에 대해 자세히 알아보려면 계속 진행하기 전에 웹훅 소개를 확인하세요.

1단계: 메시지를 작성할 위치 선택

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

• 캠페인
• 캔버스

2단계: 웹훅 작성하기

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

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

언어

URL과 요청 본문에서 국제화가 지원됩니다. 메시지를 국제화하려면 언어 추가를 클릭하고 필수 입력란을 채우세요. 콘텐츠를 작성하기 전에 언어를 선택하여 Liquid에서 원하는 위치에 텍스트를 채울 수 있도록 하는 것이 좋습니다. 사용 가능한 언어 전체 목록을 확인하세요.

웹훅 URL

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

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

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

요청 본문

요청 본문은 지정한 URL로 전송될 정보입니다. 웹훅 요청 본문은 두 가지 방법으로 작성할 수 있습니다:

JSON 키-값 쌍

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

사용자 속성, 사용자 지정 속성 또는 이벤트 속성을 요청에 포함하는 등 Liquid를 사용하여 키-값 쌍을 개인화할 수 있습니다. 예를 들어 요청에 고객의 이름과 이메일을 포함할 수 있습니다. 각 속성에 대한 기본값을 포함하는 것을 잊지 마세요!

원시 텍스트

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

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

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

3단계: 추가 설정 구성

요청 헤더(선택 사항)

특정 엔드포인트의 경우 요청에 헤더를 포함해야 할 수도 있습니다. 작성기의 설정 섹션에서 원하는 만큼 헤더를 추가할 수 있습니다. 일반적인 요청 헤더는 Content-Type 사양(본문에서 예상되는 데이터 유형(예: XML 또는 JSON)을 설명)과 공급업체 또는 시스템에 대한 자격 증명을 포함하는 권한 부여 헤더입니다.

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

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

HTTP 메서드

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

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

캠페인을 시작하기 전에 웹훅을 테스트하여 요청 형식이 올바른지 확인하는 것이 좋습니다.

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

테스트 웹훅을 보내면 응답 메시지와 함께 대화 상자가 나타납니다. 웹훅 요청이 실패한 경우 오류 메시지를 참조하여 웹훅 문제 해결에 도움을 받으세요. 다음 예에서는 잘못된 웹훅 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 support@lob.com.",
    "status_code": 404
  }
}

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

• 캠페인
• 캔버스

6단계: 검토 및 배포

캠페인 또는 캔버스의 마지막 제작을 완료한 후에는 세부 정보를 검토하고 테스트한 다음 전송하세요!

알아두어야 할 사항

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

웹훅은 외부 엔드포인트에 요청을 하는 Braze 서버에 의존하므로 구문 및 기타 오류가 발생할 수 있습니다. 웹훅 오류를 방지하는 첫 번째 단계는 웹훅 캠페인에 구문 오류가 있는지 테스트하고 개인화된 변수에 기본값이 있는지 확인하는 것입니다. 그러나 만료된 API 키, 요금 제한 또는 예기치 않은 서버 오류 등의 문제로 인해 웹훅이 여전히 실패할 수 있습니다. 웹훅 전송에 실패하면 [메시지 활동 로그]42]에 오류 메시지가 기록됩니다.

이 설명에는 오류가 발생한 시간, 앱 이름, 오류 메시지가 포함됩니다:

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

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

Braze는 최대 24시간 동안 웹훅 전송을 다시 시도합니다. 재시도 시 Braze는 개별 웹훅 호출을 중단하기 전에 약 30분 동안 지수 백오프를 사용하여 5번 시도합니다.

각 웹훅은 시간 초과되기 90초까지 허용됩니다.

IP 허용 목록

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

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

Braze 파트너와 웹훅 사용

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

확인해보세요:

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