인커밍 웹훅
인커밍 웹훅이란?
Swit 인커밍 웹훅(Incoming Webhooks)은 외부 서비스에서 Swit으로 정보를 공유하는 간편한 방법으로, '역방향 API'라고도 합니다. 웹훅 기능을 이용하면 웹앱에서 발생한 이벤트 정보를 실시간으로 제공받을 수 있고, 많은 업무를 보다 쉽고 일관적으로 처리할 수 있습니다.
Swit 인커밍 웹훅 활용
Swit의 채널과 프로젝트에서 바로 생성하고 삭제할 수 있으며, 웹훅의 생성, 삭제, 변경 시 채널의 시스템 메시지를 통해 알림을 받을 수 있습니다. 해당 채널과 연계된 프로젝트가 있다면 웹훅으로 업무가 생성된 경우, 연계 채널의 시스템 메시지 및 해당 업무 상세 페이지의 활동 내역에도 알림이 쌓이게 됩니다.
인커밍 웹훅 구성하기
- 인커밍 웹훅을 사용할 채널 또는 프로젝트 페이지에 진입 후, 상단의 채널명 또는 프로젝트명을 클릭합니다.
- 드롭다운 메뉴 중 인커밍 웹훅을 클릭합니다.
- 인커밍 웹훅 창이 열리면 새 웹훅 버튼을 클릭합니다.
- 생성할 웹훅의 이름을 입력하고, 원하는 동작에 따라 게시물 유형을 메시지 또는 아이디어 중 선택한 다음, 생성 버튼을 클릭합니다.
- 생성된 Webhook URL을 복사하여 필요 시 HTTP 요청을 보냅니다.
웹훅으로 생성 가능한 게시물 유형
인커밍 웹훅을 통해 다음과 같은 게시물을 생성할 수 있습니다.
-
특정 채널에 메시지 전송: 채널에서 새로운 인커밍 웹훅 생성 시, 게시물 유형을 메시지로 선택하면 해당 동작이 가능합니다.
-
특정 채널에 아이디어 게시: 채널에서 새로운 인커밍 웹훅 생성 시, 게시물 유형을 아이디어로 선택하면 해당 동작이 가능합니다.
-
특정 프로젝트 Backlog에 업무 게시: 프로젝트에서 새로운 인커밍 웹훅 생성 시, 게시물 유형을 업무로 선택하면 해당 동작이 가능합니다.
HTTP 요청 형식
생성한 인커밍 웹훅이 동작하도록 HTTP 요청을 보낼 수 있습니다. 요청 시 필요한 웹훅 URL은 다음과 같이 웹훅창에서 웹훅 URL 복사 버튼을 클릭하여 복사할 수 있습니다.
웹훅 URL 복사 후, 아래의 형식대로 요청을 보내면 지정된 채널이나 프로젝트에 메시지, 아이디어, 업무가 생성됩니다.
POST https://hook.swit.io/chat/<CHANNEL_ID>/<WEBHOOK_ID>
Content-type: application/json
{
"text": "Hello World!"
}
TIP
제공되는 샘플 cURL 요청을 복사하면 빠르고 간편하게 테스트할 수 있습니다.
인커밍 웹훅 삭제하기
삭제하려는 웹훅의 우측 화살표 버튼을 클릭한 다음, 삭제 버튼 클릭 시 웹훅이 즉시 삭제됩니다. 삭제된 웹훅은 되돌릴 수 없습니다.
자주 묻는 질문
Swit 인커밍 웹훅은 언제 유용할까요?
웹훅 기능을 이용하려면 어느 정도 프로그래밍 지식이 필요하기 때문에 모든 사람에게 유용하지는 않을 수 있습니다. 그러나 Swit의 자동화 플러그인을 이용하면 프로그래밍 지식이 부족한 사용자도 외부 정보에 대한 알림을 받거나 워크플로를 자동화하는 데 도움을 받을 수 있습니다.
시간당 API 요청에 속도 제한이 있나요?
초당 3개의 요청으로 제한됩니다.
