아웃고잉 웹훅

요약

아웃고잉 웹훅은 외부 서비스가 구조화된 필드, 버튼, 메뉴와 같은 리치 메시지 첨부로 응답할 수 있게 함으로써 Mattermost에서 풍부하고 인터랙티브한 경험을 만드는 데 사용할 수 있습니다. 아웃고잉 웹훅은 Mattermost에서 구성하는 데 코딩이 필요하지 않지만, HTTP POST 요청을 받는 외부 서비스는 데이터를 처리하고, Mattermost에 메시지로 응답을 포맷하고 전송해야 합니다.

기술 복잡도: 로우코드

아웃고잉 웹훅은 외부 서비스가 구조화된 필드, 버튼, 메뉴와 같은 리치 메시지 첨부로 응답할 수 있게 함으로써 Mattermost에서 풍부하고 인터랙티브한 경험을 만드는 데 사용할 수 있습니다. 또한 이러한 응답은 사용자가 Mattermost에서 직접 추가 입력을 제공하는 대화형 다이얼로그 폼이나 사용자 액션을 기반으로 동적으로 업데이트되는 인터랙티브 메시지를 트리거할 수 있습니다. 이러한 기능들을 결합하면 간단한 키워드 트리거를 최소한의 코딩으로 외부 시스템과의 팀 상호 작용을 간소화하는 강력한 인프로덕트 워크플로로 변환할 수 있습니다.

아웃고잉 웹훅은 Mattermost에서 구성하는 데 코딩이 필요하지 않지만, HTTP POST 요청을 받는 외부 서비스는 데이터를 처리하고, Mattermost에 메시지로 응답을 포맷하고 전송해야 합니다. 이는 일반적으로 요청을 파싱하고 JSON 응답 페이로드를 포맷하는 가벼운 코딩이 필요하지만, 많은 자동화 플랫폼이 커스텀 코드 작성 없이 이를 처리합니다.

아웃고잉 웹훅에 대해 자세히 알아보세요.

활용 사례 예시#

Mattermost에서 아웃고잉 웹훅의 활용 사례 예시입니다:

이슈 추적 통합

사용자가 채널에 bug를 입력하면 아웃고잉 웹훅이 메시지를 외부 서비스로 전송합니다. 외부 서비스는 세부 정보를 파싱하고 Mattermost에서 대화형 다이얼로그로 응답합니다. 사용자는 우선순위, 설명, 담당자와 같은 필드를 입력할 수 있으며, 다이얼로그를 제출하면 자동으로 티켓팅 소프트웨어에서 티켓이 생성됩니다.

지식 베이스 조회

docs와 같은 키워드가 아웃고잉 웹훅을 트리거하면 문서 서비스를 조회하고 각각 클릭 가능한 버튼이나 메뉴가 있는 제안 기사 목록과 함께 리치 인터랙티브 메시지를 반환합니다. 사용자는 Mattermost를 떠나지 않고 검색을 구체화하거나 링크를 열 수 있습니다.

보안 인시던트 강화

보안 채널에서 ioc(침해 지표)와 같은 키워드를 입력하면 위협 인텔리전스 플랫폼을 조회하는 아웃고잉 웹훅을 트리거할 수 있습니다. 응답은 평판 점수, 관련 인시던트, 알림을 에스컬레이션, 조사 또는 해제하는 퀵 액션 버튼이 있는 포맷된 메시지 첨부를 반환할 수 있습니다.

만들기#

Mattermost에서 제품 메뉴 > 통합으로 이동합니다. 통합 옵션이 없으면 아웃고잉 웹훅이 Mattermost 서버에서 활성화되지 않았거나 비관리자용으로 비활성화되었을 수 있습니다. 시스템 관리자는 시스템 콘솔 > 통합 > 통합 관리에서 활성화할 수 있습니다.

통합 페이지에서 아웃고잉 웹훅을 선택합니다.

아웃고잉 웹훅을 추가하는 옵션을 보여주는 다이얼로그 상자.

아웃고잉 웹훅 추가를 선택합니다.

아웃고잉 웹훅을 추가하는 옵션을 보여주는 다이얼로그 상자.

웹훅의 이름과 설명을 입력합니다.
요청의 콘텐츠 유형을 지정합니다.

application/json은 JSON 객체를 전송합니다.
application/x-www-form-urlencoded는 URL에서 매개변수를 인코딩합니다.

채널 및/또는 하나 이상의 트리거 단어를 지정합니다.

채널을 지정하면 웹훅은 해당 채널의 메시지에만 실행됩니다.
트리거 단어를 지정하면 웹훅은 메시지가 해당 단어 중 하나로 시작할 때만 실행됩니다.
둘 다 지정하면 메시지는 두 조건을 모두 충족해야 합니다.
채널을 비워 두면 웹훅은 팀의 모든 공개 채널을 수신합니다.
트리거 단어를 비워 두면 웹훅은 선택한 채널의 모든 메시지에 응답합니다.

아웃고잉 웹훅 세부 정보를 보여주는 다이얼로그 상자.

HTTP POST 요청이 전송될 하나 이상의 콜백 URL을 설정합니다. 저장을 선택합니다.

아웃고잉 웹훅 콜백 URL을 보여주는 다이얼로그 상자.

토큰 값을 복사합니다. 이 토큰은 요청이 Mattermost에서 오는 것임을 확인하는 데 사용됩니다.

아웃고잉 웹훅 토큰을 보여주는 다이얼로그 상자.

사용#

메시지가 웹훅을 트리거하면 Mattermost는 지정한 콜백 URL로 HTTP POST 요청을 전송합니다.

요청 페이로드#

요청 본문에는 다음 데이터가 포함됩니다(선택한 콘텐츠 유형에 따라 JSON 또는 URL 인코딩):

매개변수	설명
`token`	웹훅을 만들 때 생성된 토큰.
`team_id`	메시지가 게시된 팀의 ID.
`team_domain`	팀의 도메인.
`channel_id`	메시지가 게시된 채널의 ID.
`channel_name`	채널의 이름.
`timestamp`	메시지가 게시된 시간.
`user_id`	메시지를 게시한 사용자의 ID.
`user_name`	메시지를 게시한 사용자의 사용자명.
`post_id`	게시물의 ID.
`text`	메시지의 전체 텍스트.
`trigger_word`	일치한 트리거 단어.

애플리케이션은 token을 검증하여 요청이 Mattermost에서 왔는지 확인해야 합니다.

응답 페이로드#

애플리케이션은 POST 요청에 JSON 객체로 응답하여 Mattermost에 메시지를 다시 게시할 수 있습니다.

{
  "text": "| Component  | Tests Run | Tests Failed |\n|:-----------|:----------|:-------------|\n| Server     | 948       | :white_check_mark: 0 |"
}

이는 Mattermost에서 다음과 같이 렌더링됩니다:

아웃고잉 웹훅의 포맷된 테이블 응답 예시.

응답 매개변수#

JSON 응답에는 다음 매개변수를 포함할 수 있습니다:

매개변수	설명
`text`	(`attachments`가 설정되지 않은 경우 필수) 마크다운 포맷 메시지.
`response_type`	웹훅을 트리거한 메시지에 답글로 달려면 `comment`로 설정합니다. 기본값은 `post`로 새 메시지를 생성합니다.
`username`	기본 사용자명을 재정의합니다. 통합이 사용자명을 재정의하도록 허용이 활성화되어야 합니다.
`icon_url`	기본 프로필 사진을 재정의합니다. 통합이 프로필 사진 아이콘을 재정의하도록 허용이 활성화되어야 합니다.
`attachments`	(`text`가 설정되지 않은 경우 필수) 메시지 첨부 객체 배열.
`type`	게시물 유형을 설정하며 주로 플러그인용입니다. 설정하는 경우 `custom_`으로 시작해야 합니다.
`props`	메타데이터를 저장하기 위한 JSON 객체.
`priority`	메시지의 우선순위를 설정합니다. 메시지 우선순위를 참조하세요.

매개변수 포함 예시#

{
  "response_type": "comment",
  "username": "test-automation",
  "icon_url": "https://mattermost.com/wp-content/uploads/2022/02/icon.png",
  "text": "#### Test results for July 27th, 2017\n@channel here are the requested test results.",
  "props": {
    "test_data": {
      "server": 948,
      "web": 123,
      "ios": 78
    }
  }
}

이 응답은 웹훅을 트리거한 원래 메시지에 스레드 답글로 생성됩니다.

아웃고잉 웹훅의 전체 응답 예시.

응답에 메시지 첨부 및 인터랙티브 메시지를 포함하여 더 고급 워크플로를 만들 수 있습니다.