官方套件 · 自動化與基礎架構

在你自己的頁面上即時顯示 Jira 工單更新

一個 Jira Cloud app，工單變更與新留言一發生就送到你的頻道，客戶入口、App 或看板牆不必輪詢 Jira API 就能更新。

Hibira Realtime for JiraGitHub ↗

• issue-created、帶有變更欄位的 issue-updated、issue-deleted 與 comment-added，送到 jira-{projectKey} 與 jira-issue-{issueKey}。
• 可用私人頻道、指定要送出的專案，人名預設不送出，需要時再開啟。
• 以 Atlassian Forge 打造：設定與 secret 存在 Jira 裡，app 只會連到 Jira 和你的 Hibira 叢集。
• 只需要一條規則的話不必裝 app：把 app 設定中的傳入 webhook 網址貼進 Jira Automation 的 Send web request 動作即可。

登入後，範例程式碼會自動帶入您的叢集主機。 登入

1. 安裝

   git clone https://github.com/hibira-io/jira && cd jira
   npm install
   forge register && forge deploy
   forge install --product jira --site your-site.atlassian.net

2. 設定

   Jira → Settings → Apps → Hibira Realtime
     App ID:  YOUR_APP_ID
     Key:     YOUR_APP_KEY
     Secret:  YOUR_APP_SECRET
     → Save → Send test event

3. 使用

   const pusher = new Pusher('YOUR_APP_KEY', {
     cluster: 'hkg',
     wsHost: 'ws.hibira.io',
   });
   pusher.subscribe('jira-issue-SUP-42').bind('issue-updated', ({ issue, changes }) => {
     document.querySelector('#status').textContent = issue.status;
   });

4. 或使用 Jira Automation

   Hibira portal → your app → Settings → Incoming webhook URL
     Channel: jira-SUP   Event: issue-updated   → Create URL
   
   Jira → Project settings → Automation → Create rule
     When: Issue transitioned
     Then: Send web request
       URL:    the incoming webhook URL
                (add ?pick=issue.key,issue.fields.status.name to send less)
       Method: POST    Body: Issue data

開始之前

• 應用程式的密鑰只會在建立應用程式或輪替密鑰時顯示一次。請只放在伺服器上，不要放進瀏覽器或遊戲的建置檔。
• Free 方案需要把頁面載入的每個來源都加進應用程式的「允許的來源」（開發時是 http://localhost:3000，之後是您的網域）。"*" 需要付費方案。
• Forge 需要免費的 Atlassian 開發者帳號與 Forge CLI（npm install -g @forge/cli）。

請使用儀表板中的應用程式 Key；Secret 只放在你的伺服器上。頻道、事件與授權端點的用法和 Pusher 完全相同。 免費建立帳號 →