웹훅 캠페인 생성

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

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

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

메시지를 Campaign으로 보낼지 Canvas로 보낼지 확실하지 않으신가요? Campaign은 단일 타겟 메시징에 적합하고, Canvas는 다단계 사용자 여정에 적합합니다.

• campaign
• canvas

2단계: 웹훅 구축

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

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

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

언어

국제화는 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 요청의 미리보기가 자동으로 채워집니다.

사용자 속성, 커스텀 속성 또는 이벤트 속성정보를 포함하여 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 사양은 Content-Type 키를 사용해야 합니다. 일반적인 값은 application/json 또는 application/x-www-form-urlencoded입니다.

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

4단계: 테스트 메시지 전송

캠페인을 라이브로 전환하기 전에 Braze에서는 웹훅을 테스트하여 요청이 올바르게 형식화되었는지 확인하는 것을 권장합니다.

이를 위해 테스트 탭으로 전환하여 테스트 웹훅을 전송합니다. 임의의 사용자, 특정 사용자(이메일 주소 또는 외부 사용자 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단계: 캠페인 또는 Canvas의 나머지 부분 구축

• campaign
• canvas

6단계: 검토 및 배포

캠페인 또는 Canvas의 마지막 부분을 완성한 후 세부 정보를 검토하고 테스트한 다음 전송하세요!

알아두어야 할 사항

오류, 재시도 로직 및 타임아웃

웹훅은 Braze 서버가 외부 엔드포인트에 요청을 보내는 것에 의존하며, 간혹 오류가 발생할 수 있습니다. 가장 일반적인 오류에는 구문 오류, 만료된 API 키, 사용량 제한 및 예기치 않은 서버 측 문제가 포함됩니다. 웹훅 캠페인을 전송하기 전에:

• 웹훅의 구문 오류를 테스트하세요
• 개인화된 변수에 기본값이 있는지 확인하세요

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

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

응답 코드 및 재시도 로직

웹훅 요청이 전송되면 수신 서버는 요청에 대해 발생한 상황을 나타내는 응답 코드를 반환합니다. 다음 표는 서버가 보낼 수 있는 다양한 응답, 캠페인 분석에 미치는 영향, 오류 발생 시 Braze가 캠페인을 재전달하려고 시도하는지 여부를 요약합니다:

Retry-After 및 사용량 제한 응답 헤더는 재시도 가능한 시도(예: 408, 429 또는 5XX 이후) 전에 Braze가 대기하는 시간에 영향을 줄 수 있습니다. 401과 같은 재시도 불가능한 응답을 재시도 대상으로 만들지는 않습니다.

인증 및 연결된 콘텐츠 자격 증명

아웃바운드 웹훅 HTTP 요청은 엔드포인트에 대한 인증을 위해 연결된 콘텐츠 자격 증명(:basic_auth 또는 :auth_credentials)을 첨부하는 것을 지원하지 않습니다. 대신 웹훅의 요청 헤더를 사용하여 인증을 설정하세요. 전송 시 토큰이나 시크릿을 가져오려면 헤더 또는 본문 필드에 {% connected_content %} 태그를 배치하여 웹훅이 전송되기 전에 Liquid가 이를 해석하도록 할 수 있습니다.

저장된 웹훅 템플릿 및 캠페인 사용

Braze는 특정 저장된 웹훅 템플릿을 참조하는 모든 캠페인 또는 캔버스 단계를 나열하는 기본 제공 보고서를 제공하지 않습니다. 사용 현황을 감사하려면 동일한 URL과 HTTP 메서드를 사용하는 웹훅 단계를 검토하거나 Braze 고객지원에 문의하세요.

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

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

IP 허용 목록

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

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

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