[Eric's Web] API를 통해서 Jira Webhook 등록하기. ( OAuth2.0 Token얻기 포함)

API를 통해서 Jira Webhook 등록하기. ( OAuth2.0 Token얻기 포함)

 

안녕하세요.

Eric입니다.

오늘 제가 준비한 내용은

Jira API를 통한 Jira Webhook 등록하기 입니다.

 

웹훅(Webhook)이란?

웹훅(Webhook)은 한 시스템에서 다른 시스템으로 이벤트 정보를 전달하는 자동화된 방법입니다. 웹훅은 주로 웹 서비스 간의 실시간 상호 작용에 사용되며, 특정 이벤트가 발생할 때마다 정보를 전달하는 역할을 합니다.

 

웹훅 개념은 하단의 저의 게시글 참조해주세요.

https://just09.tistory.com/363

[Eric's CS] 웹훅(WebHook) ? 🎣

---

시작전에 앞서,

저는 이번에 Postman 을 통해서 오늘의 글을 작성할 예정입니다!

 

[개요]

 

1. OAuth 2.0 Token 얻기

2. 내가 진행중인 Jira 의 id값 얻기

3. API를 통한 Webhook 등록하기

4. 등록된 Webhook 확인하기

5. 등록된 Webhook 제거하기

---

1. OAuth 2.0 Token 얻기

 

이번에 제가 API를 통해서 Jira API를 등록하기위해서는

OAuth 2.0 Token이 필요합니다.

그러면 우선 Token을 가져오기 위해서 Postman에 

 

Authorization 에 접속해서,

Type : OAuth2.0 으로 접속하고

Add authorization data를 Reqeust Header로 우선 설정합니다.(Jira는 이렇게 해야함)

---

그리고 나서 Token 값을 얻기 위한

여러가지 준비물이 필요한데요,

- Callback URL

- Auth URL

- Access Token URL

- Client ID

- Client Secret 

- Scope

가 필요합니다. 그러면 차근차근 하나씩 알아보겠습니다.

 

1.1 Callback URL

Callback URL은 OAuth 2.0 인증 과정이 성공적으로 완료된 후에 사용자가 리디렉션될 URL입니다.

이 URL은 애플리케이션을 등록할 때 OAuth 제공자에게 알려줘야 하며, 인증 코드나 액세스 토큰이 이 URL로 전달됩니다.

저는 PostMan을 이용해서 진행할것이기때문에, PostMan이 제공하는 URL

https://getpostman.com/oauth2/callback

을 사용할것입니다.

그리고 해당 내용을 Jira Devolper Console 의 Authorization 부분에

동일한 URL을 입력해주셔야합니다.

1.2 Auth URL

Auth URL은 사용자가 처음으로 OAuth 2.0 인증을 시작할 때 방문하는 URL입니다.

이 URL은 일반적으로 OAuth 제공자의 웹사이트에 위치하며,

사용자는 이곳에서 로그인하고 애플리케이션에 대한 접근 권한을 부여합니다.

 

이번에 저는 Jira를 이용할것이므로 Jira의 Auth URL을 이용할것입니다.

https://auth.atlassian.com/authorize

 

1.3 Access Token URL

Access Token URL은 인증 코드를 액세스 토큰으로 교환하는 과정에서 사용되는 URL입니다.

이 URL에 인증 코드와 클라이언트 정보를 POST 요청으로 보내면, 액세스 토큰이 반환됩니다.

이번에 저는 Jira를 이용할것이므로 Jira의 Access Token URL을 이용할것입니다.

https://auth.atlassian.com/oauth/token

 

 

Clinet ID 와 Client Secret 의 경우에는

Jira Developer Console의 Settings 에서 하단과 같이 확인하셔서

넣으시면됩니다.

https://developer.atlassian.com/console/myapps

1.4 Client ID

Client ID는 OAuth 2.0 클라이언트 애플리케이션을 식별하는 고유한 식별자입니다.

이 ID는 애플리케이션을 OAuth 제공자에 등록할 때 생성됩니다.

위의 사진 값을 입력해줍니다.

1.5 Client Secret

Client Secret은 클라이언트 ID와 함께 사용되어 애플리케이션의 신원을 확인하는 데 사용됩니다.

이 값은 보안을 유지해야 하며, 절대 사용자에게 노출되어서는 안됩니다.

마찬가지로 위의 사진 값을 입력해줍니다.

1.6 Scope

Scope는 애플리케이션에 부여될 수 있는 권한의 범위를 정의합니다.

예를 들어, 사용자의 이메일, 프로필 정보, 사진 등에 접근할 수 있는 권한을 요청할 수 있습니다.

Scope는 일반적으로 공백이나 쉼표로 구분된 문자열로 표현됩니다.

저는 이번 토큰으로 여러가지 하고싶어서 Classic Scopes 는 모두다 등록하였습니다.

read:jira-work manage:jira-project manage:jira-configuration read:jira-user write:jira-work manage:jira-webhook manage:jira-data-provider

원하시는 Scope를 찾으시려면

하단의 내용 및 링크를 참조!

https://developer.atlassian.com/cloud/jira/platform/scopes-for-oauth-2-3LO-and-forge-apps/

이렇게 하면 OAuth2.0 Token을 얻수 있습니다.

---

2. 내가 진행중인 Jira 의 id값 얻기

 

우선 이번에 API를 통해서 Webhook을 등록하기 위해서는

내가 사용중인 Jira의 id값이 필요합니다.

 

저희가 사용할 API는

https://api.atlassian.com/ex/jira/{jira_id}/rest/api/2/webhook

이러한 형식인데,

이를 위해서 jira-id을 얻기위해서는

우선 앞서 발급받았던 Token을 통해서 하단의 API를 통해서 가져옵니다.

 

GET

https://api.atlassian.com/oauth/token/accessible-resources

 

 

그러면 하단의 사진처럼

제가 가진 Token으로 접속이 가능한 Jira 목록이 나옵니다.

여기에서 사진상에서 노란박스에 있는 

제가 원하는 id값을 가져옵니다.

---

3. API를 통한 Webhook 등록하기

마지막 단계입니다.

이제 

 

POST

https://api.atlassian.com/ex/jira/{jira_id}/rest/api/2/webhook

를 통해서 Webhook을 등록해줍니다.

 

이때, Token은 앞에서 발급받았던 Token을 사용해주고,

 

중요한건, Body값에

하단의 내용을 입력해주어야합니다.

{
"url": "https://helloworld.com/notification/jira", // webhook을 통해서 API를 받을 url주소
  "webhooks": [
    {
      "events": [ // 어떤 Event들을 webhook을 통해서 전달받을지
        "jira:issue_created",
        "jira:issue_updated",
        "comment_created"
      ],
      "jqlFilter": "project = KAN" // 어떤 Project에서 해당 webhook을 동작시킬지
    }   
  ]
}

3.1 url

이 URL은 Jira에서 특정 이벤트가 발생했을 때 알림을 받을 외부 서비스의 URL입니다.

3.2 webhooks

이 배열은 하나 이상의 웹훅 설정을 포함합니다.

각 웹훅은 어떤 이벤트에 반응할지와 어떤 필터를 사용할지를 정의합니다.

3.3 events

이 배열은 웹훅이 반응할 Jira 이벤트의 목록입니다.

- jira:issue_created: 이슈가 새로 생성되었을 때

- jira:issue_updated: 기존 이슈가 업데이트되었을 때

- comment_created: 새로운 댓글이 생성되었을 때

3.4 jqlFilter

JQL(Jira Query Language) 필터는 웹훅이 반응할 이슈를 좁혀주는 역할을 합니다.

이 필터에 맞는 이슈에만 웹훅이 작동합니다.

예시: "project = KAN"은 KAN 프로젝트에 속한 이슈에만 웹훅이 작동하도록 설정합니다.

이렇게 되면 Webhook이 등록이 완료되었습니다.

---

4. 등록된 Webhook 확인하기

이제 웹훅이 등록되었으니 확인해보도록 하겠습니다.

등록된 웹훅을 확인을 하기 위해서는

 

GET

https://api.atlassian.com/ex/jira/{jira_id}/rest/api/2/webhook

을 통해서 Token을 사용해서 요청하면

하단과 같이 등록된 Webhook을 Array 형태로 받아 볼 수 있습니다.

---

5. 등록된 Webhook 제거하기

 

등록된 Webhook을 상단의 사진처럼 조회 하고나서,

values의 값중 id 값이 필요합니다

 

DELETE

https://api.atlassian.com/ex/jira/{jira_id}/rest/api/2/webhook

를 통해서

Body 값에 지워줄 Webhook의 id값들을 입력합니다.

{"webhookIds" : [
    9,10 // id값을 입력
]}

그러면 상단의 사진처럼

202 Accepted 가 되면서 Webhook이 지워진것을 확인 하실 수 있습니다.

---

오늘은 Jira의 API를 통해서 Webhook을 등록, 삭제, 조회 를 해보았는데요,

제 글이 많은 도움이 되셨기를 바라며

다음에 저는 더 좋은 정보로 찾아뵙겠습니다.

 

이상 개발자 Eric이었습니다.

감사합니다.

 

 

참고자료

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-webhooks/#api-group-webhooks