웹훅 연동

연동 개요

이 연동을 통해 웹훅 엔드포인트를 설정하여 Pushwoosh로부터 실시간 데이터, 특히 이메일 상태 이벤트(예: 이메일 전송됨, 이메일 전달됨, 이메일 반송됨, 이메일 열람됨 등)를 수신할 수 있습니다.

연동 유형

소스: 데이터는 웹훅을 통해 Pushwoosh에서 사용자의 시스템으로 전송됩니다.

용어집

웹훅 엔드포인트: Pushwoosh로부터 HTTP POST 요청을 수신하는 서버 측 URL입니다. 클라이언트는 특정 포트를 지정할 수 있습니다.

포트가 없는 예시: https://clientdomainname.com/webhook_endpoint
포트가 지정된 예시: https://clientdomainname.com:8081/webhook_endpoint

동기화되는 엔티티

사용자가 보낸 메시지와의 상호작용에 대한 데이터를 제공하는 이메일 상태 이벤트입니다.

연동 설정하기

연동을 설정하려면:

Pushwoosh 계정에서 Settings > 3rd Party Integrations로 이동하여 Webhook Integration을 찾습니다. Configure를 클릭합니다.

열리는 창에서 웹훅 엔드포인트의 전체 URL을 입력하고 Apply를 클릭합니다.

성공적으로 구성되면 Pushwoosh로부터 요청을 받기 시작합니다.

연동이 작동하는지 확인하는 방법

연동이 설정되면 지정된 웹훅 엔드포인트에서 Pushwoosh로부터 HTTP POST 요청을 받게 됩니다.

웹훅 요청 본문

필드 이름	유형	필수 여부	설명	예시
event_name	string	예	이벤트의 이름입니다.	`"Email Sent"`
message_id	uint64	아니요	이벤트와 관련된 메시지의 고유 ID입니다.	`200XXXX3258`
message_code	string	예	이벤트와 관련된 메시지의 코드입니다.	`"B780-XXXXXX3C-XXXX0375"`
campaign_id	uint64	아니요	이벤트와 관련된 캠페인의 고유 ID입니다.	`96XXXX`
platform	string	예	이벤트와 관련된 기기 플랫폼입니다(예: iOS, Android, Email).	`"Email"`
application_code	string	예	이벤트와 관련된 애플리케이션의 코드입니다.	`"3XXXX-XXXX1"`
hwid	string	예	이벤트와 관련된 기기 식별자(HWID)입니다.	`"example@gmail.com"`
user_id	string	예	이벤트와 관련된 Pushwoosh User ID입니다.	`"15XXXX8"`
payload	string	아니요	메시지와 관련된 콘텐츠는 플랫폼에 따라 다릅니다. 이메일 이벤트의 경우, 이 필드에는 이메일 제목이 포함됩니다. 다른 플랫폼의 경우, 이벤트에 특정한 다른 관련 콘텐츠(예: 메시지 내용 또는 제목)가 포함될 수 있습니다.	`"Don't miss our summer sale!"`
timestamp	int64	예	이벤트가 발생한 시간이며, UNIX 타임스탬프 형식입니다.	`1723798222`
journey_title	string	아니요	이벤트와 관련된 Journey의 제목입니다.	`"Summer sale"`
journey_point_title	string	아니요	이벤트와 관련된 Journey 내 특정 지점의 제목입니다.	`"5_summer sale_new"`

요청 예시

{
  "event_name": "Email Sent",
  "message_code": "B780-XXXXXX3C-XXXX0375",
  "campaign_id": 96XXXX,
  "platform": "Email",
  "payload": "Don't miss our summer sale!",
  "application_code": "3XXXX-XXXX1",
  "hwid": "example@gmail.com",
  "user_id": "15XXXX8",
  "timestamp": 1723798222,
  "journey_title": "Summer sale",
  "journey_point_title": "5_summer sale_promoemail"
}