Incoiming Webhook 이란, 외부서비스의 데이터를 콜라비가 지정한 포맷으로 연결하여 메신저 대화방으로 연결한 데이터를 메세지로 전송해주는 기능을 말합니다.

협업툴 콜라비에서 아래 절차대로 연결하면 메신저의 대화방으로 데이터가 전송됩니다. 메신저 앱 다운로드

💁‍♀️ 콜라비의 데이터 포맷 변환 지원 서비스

콜라비는 서비스 자체적으로 데이터 포맷 변환을 지원하고 있습니다. 아래 서비스는 위 Webhook URL 을 입력하면 별도의 데이터 포맷 변환 과정을 하지 않아도 됩니다.

  • GitHub
    지원 가능한 이벤트 - create, delete, push, pull_request, pull_request_review, commit_comment, repository, issues, issue_comment, membership

  • Bugsnag

  • App Center

Incoming Webhook 등록

협업툴 콜라비에 접속하여 오른쪽 상단의 나의 프로필을 누른 다음 [설정] 버튼을 눌러 접속해 주세요. 그리고, 오른쪽 중간의 [Webhook 설정] 메뉴를 눌러 연결할 수 있습니다.

1. Webhook 연결 시 메세지를 받을 메신저의 대화방을 선택하고, 메세지 발송자로 표시될 이름을 설정해 주세요.

2. Webhook 을 생성하면, Webhook 관리 페이지에서 URL 을 볼 수 있습니다.

이 URL을 복사하여 데이터를 받고 싶은 서비스에 설정하면 웹훅 메세지가 발송됩니다.

3. 아래 데이터 포맷에 따라 설정하면 콜라비 메신저로 메세지를 받아볼 수 있습니다.
콜라비 메신저는 앱을 설치한 후에 사용할 수 있습니다. 메신저 앱 다운로드

Webhook 연동 방법

아래 이미지는 실제 전송된 메세지입니다. 참고하여 설정해 주세요.

아래 이미지는 아래 code와 무관합니다.

1. 콜라비 Webhook 등록페이지에서 Webhook URL을 복사하여 원하는 서비스에 설정해 주세요.

2. method : POST

3. request header

  • “Accept: application/json”

  • “Content-type: application/json”

4. request body - 사용예시

{
"datas": [
{
"type": "section",
"data": {
"type": "markdown",
"content": "![Kayak][logo]\n[logo]: http://www.gstatic.com/webp/gallery/2.jpg \"To go kayaking.\"",
"color": null
}
},
{
"type": "section",
"data": {
"type": "text",
"content": "this is text content",
"color": "#FF0000"
}
}
]
}

필드 설명

  • datas : 여러 데이터의 List입니다. 각각 데이터는 포맷과 형식을 다르게 가질 수 있으며, 하나의 문단과 같은 의미로 나눌 수 있습니다.

  • datas[].type : datas의 각 객체의 형식입니다.
    (only “section” / section 타입만 가능, 필수값)

  • datas[].data : 메세지에서 표현될 데이터 object 입니다.

    • datas[].data.content : 메세지에서 표현될 데이터의 내용입니다. (필수값)

    • datas[].data.type : 메세지에서 표현될 데이터의 타입입니다. (markdown/text, 필수값)

    • datas[].data.color : 메세지에서 표현될 데이터의 색상코드 입니다.(옵션값)
      ex) red / #FF0000

테스트 방법 : Curl 이용한 Webhook 호출

Curl 문법에 유의하여 요청해 주시고, 실제로 생성된 Webhook URL 로 꼭 대체해 주세요.

curl -X POST https://hook.collabee.co/service/웹훅URL  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"datas": [
{
"type": "section",
"data": {
"type": "markdown",
"content": "![Kayak][logo]\n[logo]: http://www.gstatic.com/webp/gallery/2.jpg \"To go kayaking.\"",
"color": null
}
},
{
"type": "section",
"data": {
"type": "text",
"content": "this is text content",
"color": "#FF0000"
}
}
]
}'

테스트 방법 : Postman 이용한 Webhook 호출

Zapier로 메신저에서 Gmail/Outlook 메일알림 받는 방법

아래 이미지는 실제 전송된 메일알림 메시지입니다. 참고하여 설정해 보세요.

1. Zapier를 가입 후, "Create Zap"을 눌러 연동을 시작해 주세요.

  • 'Gmail' 또는 'Outlook' 을 선택해 주세요.

  • Trigger Event는 'New Email Matching Search' / 'New Email' 를 선택해 주세요.

  • 메일을 수신받고 있는 Gmail 계정 또는 Outlook 메일을 연결해 주세요.

  • Gmail은 트리거로 설정할 항목(제목/받는사람)과 문자열을 설정해 주세요.
    Gmail 트리거로 설정가능한 항목 보기

    예시) subject:웨비나

  • 테스트를 진행해 주세요.

2. 그리고 Webhook by Zapier 를 검색하여 선택해 주세요.

3. Action event 에서 'Custom Request' 를 검색하여 선택해 주세요.
이때 'custom request' 로 꼭 설정해 주세요. request body로 json raw 데이터를 보낼수 있습니다.

4. 이벤트 값들을 설정을 해주세요.

  • Method : Post

  • URL : 콜라비 Webhook URL을 붙여주세요.

  • Data Pass-Through : False

  • Data(예시) : "content" 에 받을 내용을 선택해 주세요. "Body HTML"은 개선예정입니다.
    ex) Message URL / From Email / Body Plain

  • Basic Auth :

  • Unflatten : Yes

  • Headers

    • Accept : application/json

    • Content-Type : application/json

5. 통합 테스트를 진행한 다음 연동을 완료하면 메시지를 받아보실 수 있습니다.

Did this answer your question?