알림 설정

알림 개요

Apidog에서는 특정 이벤트가 발생할 때 지정된 수신자에게 알림을 보내기 위해 서드파티 애플리케이션과 통합할 수 있습니다. 특정 이벤트가 트리거되면 Slack과 같은 플랫폼으로 알림이 실시간 전송됩니다. 현재 지원되는 알림 채널은 다음과 같습니다.

Slack

Teams

Webhook

Jenkins

프로젝트 관리자만 알림 설정을 구성할 수 있습니다. 현재 이메일 알림은 다음 이벤트에 대해서만 사용할 수 있습니다.

자동화 테스트 완료/실패

지속적 통합 완료/실패

예약 작업 완료/실패

알림 대상

알림 대상은 특정 이벤트가 발생할 때 특정 채널을 통해 메시지를 수신하는 수신자입니다.

알림을 설정하려면 먼저 이름을 지정하고, 채널을 선택하며, 해당 설정을 구성하여 알림 대상을 생성해야 합니다. 각 채널에는 고유한 설정 프로세스가 있습니다. 아래 섹션에서는 이를 단계별로 구성하는 방법을 안내합니다.

Slack

Apidog는 Slack 앱인 Incoming WebHooks를 지정된 Channel에 통합하고 Incoming WebHooks의 Webhook URL을 구성하여, Slack의 특정 Channel로 알림 이벤트를 전송하는 기능을 지원합니다. 이를 통해 이벤트 메시지를 Slack Channel로 전송할 수 있습니다.

구성 필드 설명:

구성 필드	필수 여부	설명
알림 이름	아니요	서드파티 통합 알림의 목적을 기록하기 위해 이름을 지정합니다.
트리거 이벤트	예	지원되는 이벤트: API 변경, 스키마 변경, 문서 변경, 데이터 가져오기, 자동화 테스트
서비스 URL	예	"Incoming WebHooks - Integration Settings"의 Webhook URL

Apidog 알림을 Slack과 통합하기

프로젝트 관리자는 서드파티 통합 기능을 사용하여 Slack의 Channels에 추가된 Slack 앱인 Incoming WebHooks를 Apidog의 프로젝트 알림 이벤트와 연결할 수 있습니다. 이를 통해 관련 API 변경, 문서 변경, 테스트 완료 등을 Slack의 지정된 Channel로 푸시할 수 있습니다.

1단계: 채널 세부 정보 열기

Slack 채널에서 오른쪽 상단의 "Open channel details" 옵션을 클릭합니다.

2단계: Incoming WebHook 설치

특정 Channel의 Integrations - Apps에서 Incoming WebHook을 설치하고 추가합니다.

3단계: Incoming WebHooks 보기

설치가 완료되면 Incoming WebHooks 오른쪽의 View 버튼을 클릭합니다.

4단계: Incoming WebHooks 구성

그러면 Incoming WebHooks 설명 페이지가 열립니다. 설정하려면 Configuration을 클릭합니다.

5단계: Slack에 추가

Add to Slack을 클릭합니다.

6단계: Channel 선택 및 통합 추가

Apidog 알림 이벤트 메시지를 푸시할 Channel을 선택한 다음, Add Incoming WebHooks integration을 클릭합니다.

7단계: Webhook URL 가져오기

Webhook URL을 가져와 복사합니다.

8단계: Apidog에서 알림 대상 생성

"Settings" > "Notifications" > "Notification Targets"를 클릭한 다음 새 알림 Target을 생성합니다.

알림 대상 이름을 입력합니다.

알림 채널로 Slack을 선택합니다.

Incoming WebHooks 설정에서 가져온 Webhook URL을 Service URL에 붙여넣습니다.

Save를 클릭하면 설정이 완료됩니다. 이제 알림 이벤트 생성으로 이동할 수 있습니다.

알림 이벤트가 설정되고 트리거되면 지정한 Slack 채널에서 메시지를 수신하게 됩니다.

Teams

Microsoft Teams로 알림을 보내는 기능을 지원하므로, Teams의 Workflows에서 이러한 메시지를 추가 작업의 트리거로 사용할 수 있습니다. 예를 들어 그룹 또는 채널에 메시지를 자동으로 게시하여 팀이 Apidog의 중요한 이벤트를 파악할 수 있도록 돕습니다.

구체적으로 Workflow 내에서 Webhook Trigger를 구성할 수 있습니다. Apidog에서 특정 알림 이벤트가 트리거되면(예: API 변경, 문서 업데이트 또는 자동화 테스트 완료), Apidog는 이벤트 페이로드를 포함하여 해당 트리거의 지정된 HTTP POST URL로 POST 요청을 전송합니다.

구성 필드:

필드	필수 여부	설명
Name	예	이 알림 대상의 목적을 설명하는 이름
HTTP POST URL	예	Workflow의 Webhook Trigger가 POST 요청을 수신하는 URL

Apidog 알림을 Teams 채널과 통합하기

1단계: Teams에서 워크플로 생성

Microsoft Teams → Workflow에서 Create를 클릭하면 Post to a channel when a webhook request is received 템플릿을 선택하여 빠르게 시작할 수 있습니다.

2단계: 흐름 이름 및 계정 설정

흐름의 이름을 설정하고 적절한 계정을 선택한 다음 Next를 클릭합니다.

3단계: 그룹 및 채널 선택

알림을 수신할 그룹과 채널을 선택한 다음 Create flow를 클릭합니다.

4단계: HTTP POST URL 가져오기

흐름이 생성되면 트리거 단계 아래에 HTTP POST URL이 표시됩니다. 이를 직접 복사하거나 나중에 흐름의 트리거 단계에서 찾을 수 있습니다.

5단계: Apidog에서 알림 대상 구성

이 HTTP POST URL을 Apidog의 알림 대상 구성에 붙여넣습니다.

6단계: 알림 이벤트 생성

Apidog에서 알림 이벤트를 생성하고 구성된 Teams 알림 대상과 연결합니다.

7단계: Teams 알림 확인

이 알림 이벤트가 트리거되면 이전에 생성한 워크플로가 선택한 Teams 채널에 메시지를 자동으로 게시합니다.

Webhook

HTTP Server로 알림 이벤트를 전송하는 기능을 지원합니다. POST 요청을 수신할 URL 주소를 지정하여 이벤트 메시지를 HTTP Server로 전송할 수 있습니다.

구성 필드 설명:

구성 필드	필수 여부	설명
알림 이름	아니요	알림의 목적을 기록하기 위해 서드파티 통합 알림에 이름을 지정합니다.
트리거 이벤트	예	지원되는 이벤트: API 변경, 데이터 모델 변경, 문서 변경, 데이터 가져오기, 자동화 테스트
서버 URL	예	요청을 수신할 HTTP Server의 URL 주소
서명 인증	아니요	전송된 콘텐츠는 HMAC SHA1 암호화 알고리즘으로 암호화되며, 토큰을 KEY로 사용하여 값을 16진수로 표시합니다(구성된 토큰 필요). 또한 sha1= 접두사를 포함합니다.

Apidog 알림을 자체 호스팅 HTTP Server와 통합하기

프로젝트 관리자는 서드파티 통합을 사용하여 자체 호스팅 HTTP Server를 Apidog의 프로젝트 알림 이벤트와 연결할 수 있습니다. 이를 통해 관련 API 변경, 문서 변경 및 자동화 테스트 완료 알림을 HTTP Server에서 수신할 수 있습니다.

Apidog 알림을 자체 호스팅 HTTP 서버와 통합하려면 "Settings" > "Notifications" > "Notification Targets"를 클릭한 다음 새 알림 Target을 생성합니다.

알림 대상 이름을 입력합니다.

채널로 Webhook을 선택합니다.

자체 호스팅 HTTP Server의 URL을 Service URL 필드에 붙여넣습니다.

서명 검증이 활성화된 경우 키를 복사하여 Signature Key 필드에 붙여넣습니다.

Save를 클릭하면 설정이 완료됩니다. 이제 알림 이벤트 생성으로 이동할 수 있습니다.

Jenkins

Jenkins 서비스로 알림 이벤트를 전송하는 기능을 지원합니다. Jenkins Webhook URL을 구성하면 이벤트 메시지를 Jenkins로 전송할 수 있습니다.

구성 필드 설명:

구성 필드	필수 여부	설명
알림 이름	아니요	서드파티 통합 알림의 목적을 기록하기 위해 이름을 지정합니다.
트리거 이벤트	예	API 변경, 데이터 모델 변경, 데이터 가져오기, 자동화 테스트. 위 이벤트 중 하나가 발생하면 실시간 알림이 트리거됩니다.
서비스 URL	예	URL은 Generic Webhook Trigger 플러그인에서 구성됩니다.
서명 인증	아니요	Authorization Bearer 헤더를 통해 Generic Webhook Trigger 플러그인으로 전송됩니다.

Apidog 알림을 Jenkins 서비스와 통합하기

프로젝트 관리자는 서드파티 통합 기능을 사용하여 Jenkins Generic Webhook Trigger 플러그인에 구성된 Webhook URL을 Apidog의 프로젝트 알림 이벤트와 연결할 수 있습니다. 이를 통해 API 변경, 문서 변경 및 자동화 테스트 완료와 같은 이벤트가 트리거될 때 Jenkins에서 빌드 작업을 자동으로 시작하고, 빌드 기록에서 메시지를 확인할 수 있습니다.

1단계: Jenkins Generic Webhook Trigger 플러그인에서 Webhook URL 구성

Jenkins Dashboard에서 새 보기를 생성합니다.

이전 단계의 보기를 클릭하여 Configure>Build Triggers로 이동한 다음 Generic Webhook Trigger를 선택합니다. Webhook URL은 "http://"+"your service address"+"/generic-webhook-trigger/invoke"입니다.

사용자 지정 토큰이 지원됩니다.

2단계: 새 알림 대상 생성

"Settings" > "Notifications" > "Notification Targets"를 클릭한 다음 새 알림 Target을 생성합니다.

알림 대상 이름을 입력합니다.

채널로 Jenkins를 선택합니다.

Generic Webhook Trigger 플러그인에서 구성한 Webhook URL을 Service URL 필드에 붙여넣습니다.

사용자 지정 토큰을 사용하는 경우 Token을 복사하여 Signature Token 필드에 붙여넣습니다.

Save를 클릭하면 설정이 완료됩니다. 이제 알림 이벤트 생성으로 이동할 수 있습니다.

알림 이벤트가 설정되고 트리거되면 Jenkins가 자동으로 빌드 작업을 시작하며, 빌드 기록에서 메시지를 확인할 수 있습니다.

Email

지정된 이메일 주소로 이메일을 통해 알림을 보낼 수 있습니다. 현재 이메일 알림은 다음 이벤트에 대해서만 사용할 수 있습니다.

자동화 테스트 완료/실패

지속적 통합 완료/실패

예약 작업 완료/실패

구성 필드 설명:

필드	필수 여부	세부 정보
이름	예	알림 대상의 목적 또는 특징을 강조하는 설명형 이름입니다.
알림 이메일 주소	예	알림을 수신할 이메일 주소를 입력합니다. 프로젝트 멤버의 이메일 주소를 선택하거나 주소를 직접 입력할 수 있습니다. 여러 이메일 주소가 지원됩니다.

Apidog 알림을 Email과 통합하기

알림 대상 이름을 입력합니다.

채널로 Email을 선택합니다.

이메일을 입력합니다.

Save를 클릭하면 설정이 완료됩니다. 이제 알림 이벤트 생성으로 이동할 수 있습니다.

알림 이벤트

지정된 수신자(알림 대상)에게 알림을 트리거할 이벤트를 지정하기 위해 알림 이벤트를 생성할 수 있습니다. 알림 이벤트를 설정하려면 다음을 구성해야 합니다.

알림 이벤트 이름

트리거 이벤트

알림 대상

트리거 이벤트

알림을 트리거할 다음 알림 이벤트 중에서 선택할 수 있습니다.

트리거 이벤트	세부 정보
엔드포인트 변경됨	엔드포인트 생성됨 엔드포인트 업데이트됨 엔드포인트 삭제됨
스키마 변경됨	스키마 생성됨 스키마 업데이트됨 스키마 삭제됨
문서 변경됨	문서 생성됨 문서 업데이트됨 문서 삭제됨
데이터 가져오기	가져오기(수동 가져오기) 가져오기(자동 동기화)
응답 컴포넌트 변경됨	응답 컴포넌트 생성됨 응답 컴포넌트 업데이트됨 응답 컴포넌트 삭제됨
스프린트 브랜치 변경됨	스프린트 브랜치 병합됨 스프린트 브랜치 생성됨 스프린트 브랜치 보관됨 스프린트 브랜치 삭제됨 스프린트 브랜치 검색됨
API 버전 변경됨	API 버전 생성됨 API 버전 삭제됨
보안 스키마 변경됨	보안 스키마 생성됨 보안 스키마 업데이트됨 보안 스키마 삭제됨

TIP

자동화 테스트와 관련된 알림(예: 자동화 테스트 완료, 지속적 통합 완료, 예약 작업 완료)의 경우 각 테스트 시나리오별로 설정을 개별적으로 구성해야 합니다. 이 방식은 더 유연하며 실제 사용 사례에 더 적합합니다.

알림 대상

트리거 이벤트가 발생할 때 어떤 알림 대상이 알림을 수신할지 선택합니다. 프로젝트에 이미 설정된 알림 대상 중에서 선택할 수 있으며, 필요한 경우 여러 대상을 선택할 수 있습니다.

다만 이메일 알림은 다음 세 가지 특정 이벤트에 대해서만 지원됩니다.

자동화 테스트 완료/실패

지속적 통합 완료/실패

예약 작업 완료/실패

알림 개요#

알림 대상#

Slack#

Apidog 알림을 Slack과 통합하기#

Teams#

Apidog 알림을 Teams 채널과 통합하기#

Webhook#

Apidog 알림을 자체 호스팅 HTTP Server와 통합하기#

Jenkins#

Apidog 알림을 Jenkins 서비스와 통합하기#

Email#

Apidog 알림을 Email과 통합하기#

알림 이벤트#

트리거 이벤트#

알림 대상#

알림 개요

알림 대상

Slack

Apidog 알림을 Slack과 통합하기

Teams

Apidog 알림을 Teams 채널과 통합하기

Webhook

Apidog 알림을 자체 호스팅 HTTP Server와 통합하기

Jenkins

Apidog 알림을 Jenkins 서비스와 통합하기

Email

Apidog 알림을 Email과 통합하기

알림 이벤트

트리거 이벤트

알림 대상