Prosty przewodnik po webhookach Jira

Starając się, aby temat webhooków był dostępny dla wszystkich, publikujemy serię artykułów zawierających definicje, przypadki użycia i przykłady webhooków.

Po opublikowaniu artykułu wprowadzającego wyjaśniającego, czym są webhooki , skupiamy się teraz na popularnych aplikacjach obsługujących webhooki, takich jak Discord .

Dzisiaj przyszła kolej na Jira. Skorzystamy z tej okazji, aby przeanalizować webhooki Jira, podzielić się przykładami ich użycia i pokazać, jak je tworzyć (zarówno natywnie, jak i przy użyciu Integromatu).

Zacznijmy od podstaw: definicje, zakres i przykłady.

Co to są webhooki Jira?

Podobnie jak wszystkie elementy webhook, elementy webhook Jira to zdefiniowane przez użytkownika wywołania zwrotne HTTP, które przesyłają ładunek danych o zdarzeniu do adresu URL skonfigurowanego dla elementu webhook.

Mówiąc prościej, webhooki Jira to metoda informowania innych aplikacji o wydarzeniu w Jira.

Załóżmy na przykład, że chcesz zachować zaległości dotyczące problemów Jira w arkuszu kalkulacyjnym programu Excel, ale nie masz czasu na śledzenie wszystkich nowych problemów, które pojawiają się w przestrzeni Jira, a następnie kopiowanie ich do programu Excel.

Aby rozwiązać ten problem, możesz polegać na webhooku, który automatycznie eksportuje problemy Jira do programu Excel .

Każda nowa sprawa utworzona w Jira liczy się jako zdarzenie, a zatem webhook odbierze ją i wyśle odpowiednie dane (takie jak identyfikator sprawy, podsumowanie sprawy i osoba przypisana) do programu Excel.

Warto wspomnieć, że webhooki są obsługiwane zarówno przez Jira Cloud, jak i Jira Server, więc możesz na nich polegać niezależnie od używanej wersji Jira.

Do czego służą webhooki Jira?

Jira posiada listę zdarzeń, które można wysłać do webhooka. Wydarzenia związane są z:

  • Zagadnienia
  • Właściwości wydania
  • Dzienniki pracy
  • Uwagi
  • Załączniki
  • Projektowanie
  • Użytkownicy
  • Konfiguracja systemu
  • Sprinty

Reprezentują one różne kategorie ładunków danych, które można wysłać do elementu webhook Jira. Możesz sprawdzić pełną listę wydarzeń dostępnych dla webhooków Jira na odpowiedniej stronie Atlassian Developers .

Od tego momentu do Ciebie będzie należało określenie, w jaki sposób wykorzystać te dane na swoją korzyść. Możliwości są ogromne!

Na przykład wyobraźmy sobie, że odpowiadasz za raportowanie projektu, który ma się rozwijać w wielu równoległych sprintach programistycznych.

Zamiast czekać, aż liderzy zespołu powiedzą Ci, kiedy kończą sprint, możesz wdrożyć webhooki dla każdego sprintu. Webhooki odbiorą zdarzenia, które Cię interesują (w tym przypadku byłyby to „zamknięte sprinty”).

Tak więc, gdy status sprintu jest ustawiony jako „zamknięty” przez któregokolwiek z liderów zespołu, odpowiedni webhook wyśle te dane o stanie do wcześniej określonego adresu URL webhooka.

Co więcej, możesz połączyć każdy z webhooków, aby wymówić aplikację e-mail i otrzymać wiadomość e-mail za każdym razem, gdy status sprintu zostanie ustawiony przez kierowników zespołu na „zamknięty”.

To bardzo prosty przykład tego, co można zrobić z webhookami Jira, ale jak wspomniano powyżej, możliwości są interesujące.

Na przykład bardziej zaawansowany przypadek użycia może polegać na webhookach do monitorowania zamkniętych problemów i określania produktywności pracowników na podstawie danych wynikowych (zakładając, że dany podzbiór pracowników ma przypisane zadania o podobnym stopniu trudności).

Podobnie jak w przypadku wszystkich webhooków (i nie tylko Jira), klucz do zrozumienia możliwości będzie wymagał zastanowienia się nad następującymi pytaniami:

  • Jakie zdarzenia należy monitorować w czasie rzeczywistym?
  • Czy aplikacja, której używam, obsługuje elementy webhook do monitorowania tych zdarzeń?
  • Jakie aplikacje mogę połączyć z webhookami monitorującymi te zdarzenia?
  • Po co?

Udzielenie odpowiedzi na nie otworzy świat możliwości osiągania celów w pracy, automatyzacji tysięcy służebnych zadań i maksymalnego wykorzystania przydatnych informacji w czasie rzeczywistym.

Jak stworzyć webhooka w Jira?

Tworzenie webhooków Jira jest stosunkowo proste, a pokażemy Ci dwa różne sposoby na to:

  • Natywnie przy użyciu Jira
  • Z Integromatem

Zacznijmy od pierwszego. Możesz tworzyć webhooki bezpośrednio z przestrzeni Jira, o ile jesteś administratorem lub masz „globalne uprawnienia” od administratora. Ponadto wymagane są pewne umiejętności kodowania, aby w przyszłości wykorzystać je w pełni.

Aby utworzyć webhooka w Jira, kliknij małą ikonę ustawień w prawym górnym rogu ekranu, a następnie wybierz opcję „System” z menu.

ustawienia-systemu jira

Wylądujesz na pulpicie nawigacyjnym systemu. Tam kliknij opcję „Webhooki” w kolumnie po lewej stronie ekranu. Następnie kliknij przycisk „Utwórz webhooka” w prawym górnym rogu ekranu.

tworzenie-webhooka-jira

Następnie należy nazwać webhooka, określić adres URL (zgodnie z parametrami Jira dla adresów URL webhooka), umieścić go w odpowiednim polu i ustawić status webhooka na „Włączony”.

jira-webhook-listener

Po wykonaniu tej czynności przewiń stronę w dół, aby zobaczyć dostępne zdarzenia, które możesz wysłać na adres URL webhooka.

jira-webhooks-wydarzenia

 

Tutaj możesz wybrać wydarzenie, które chcesz dołączyć do swojego webhooka. Gdy to zrobisz, kliknij przycisk „Utwórz” u dołu ekranu.

zapisywanie-jira-webhook

I to wszystko!

Teraz Twój webhook jest gotowy. Możesz dodać go do funkcji księgowania przepływu pracy w Jira (aby opublikować dane odebrane przez webhook w innym miejscu) lub zakodować za pomocą interfejsu API Jira, aby uzyskać wynikowe ładunki danych w wygodny dla Ciebie sposób.

Wysyłanie wynikowych ładunków danych do innych aplikacji może być nieco wymagające, jeśli nie znasz kodu lub interfejsów API, dlatego ważne jest, aby pokazać Ci również, jak tworzyć i zarządzać webhookami Jira za pomocą Integromatu.

Jak tworzyć i zarządzać webhookami Jira za pomocą Integromatu

Tworzenie webhooków Jira za pomocą Integromatu jest tak samo proste, jak robienie tego za pomocą Jira.

Kluczowa różnica polega na tym, co dzieje się dalej — czyli manipulowaniu i publikowaniu danych webhooka w jednej lub kilku aplikacjach.

W Jira będzie to wymagało interakcji z kodem. Z Integromat nie będziesz musiał.

Ponadto w ciągu kilku minut możesz połączyć swoje webhooki Jira z praktycznie dowolną aplikacją.

Pamiętasz przykład otrzymywania powiadomień e-mail, gdy sprint jest zamykany przez lidera zespołu? To prosta integracja webhooka Jira z aplikacją do obsługi poczty e-mail i dokładnie to, o czym tutaj mówimy.

Zobaczmy teraz, jak tworzyć i zarządzać webhookami za pomocą Integromatu.

W panelu Integromatu musisz nacisnąć przycisk „Utwórz nowy scenariusz”.

integromat-tworzenie-scenariusz

Na następnym ekranie kliknij kółko na środku i poszukaj aplikacji „Webhooks”. Gdy go znajdziesz, kliknij go i wybierz moduł „Niestandardowy webhook”.

Przed tobą pojawi się okno konfiguracji. Tutaj kliknij przycisk „Dodaj”.

moduł-webhook-integromat

Pojawi się kolejne okno konfiguracji. Jedyne, co musisz tutaj zrobić, to nadać nazwę swojemu webhookowi. Po prostu dodaj swoją nazwę webhooka (może to być dowolna) w polu "Nazwa webhooka", a następnie kliknij "Zapisz".

niestandardowa konfiguracja-webhook

Ponownie znajdziesz się w oryginalnym oknie konfiguracyjnym modułu. Jeśli przyjrzysz się uważnie, zauważysz, że jest dostępny adres URL — jest to Twój nowy niestandardowy adres URL webhooka.

Dzięki temu nie będziesz musiał określać struktury adresu URL, co jest nieuniknionym wymogiem podczas natywnego tworzenia webhooków Jira.

integromat-copy-webhook-url

Webhook teraz „nasłuchuje” danych, aby określić strukturę danych.

Więc teraz musimy skopiować ten adres URL i przejść do Jira.

Tam wykonaj te same kroki, co podczas tworzenia natywnego webhooka Jira:

  • Kliknij ikonę „System” w prawym górnym rogu pulpitu Jira
  • Kliknij „System” na liście opcji
  • W panelu systemowym kliknij „Webhooki” (po prawej stronie ekranu)
  • Zaznacz wydarzenie, które chcesz monitorować

A następnie wklej skopiowany adres URL webhooka (ten, który skopiowałeś z modułu Integromat) w polu adresu URL w Jira.

jira-niestandardowy-webhook

Ponieważ Integromat potrzebuje próbki danych do określenia struktury danych webhooka, pozostaje tylko jedna, ostatnia rzecz do zrobienia: utworzenie zdarzenia, które ma odebrać webhook.

Na przykład, jeśli wybrałeś zdarzenie „utworzona sprawa”, śmiało utwórz nową sprawę w swojej przestrzeni Jira.

Webhook otrzyma te dane, a Integromat będzie mógł określić odpowiednią dla nich strukturę.

Aby zapoznać się ze skróconą wersją, obejrzyj poniższy film, który pokazuje cały proces tworzenia webhooka Jira z Integromat:

I to wszystko!

Teraz możesz dodać dowolną aplikację do scenariusza Integromat, który zawiera ten konkretny webhook. Na przykład możesz dodać moduł Slack „Utwórz wiadomość” i automatycznie powiadamiać kogoś (lub siebie!) o utworzeniu nowego zgłoszenia w Jira.

Całkiem fajnie, co? I nie była potrzebna ani jedna linijka kodu. 😉

Webhooki Jira: zasoby edukacyjne

Teraz, gdy omówiliśmy definicje, przykłady, przypadki użycia i kroki niezbędne do utworzenia webhooków Jira, nadszedł czas, aby udostępnić więcej zasobów na ich temat.

Ufamy, że okażą się one przydatne, jeśli zechcesz zagłębić się w temat. Oto nasza lista dodatkowych zasobów webhooków Jira:

Wniosek: Używanie webhooków do lepszego zarządzania projektami Jira

Mamy nadzieję, że ten artykuł pomoże Ci rozpocząć pracę z webhookami Jira.

Jak wspomnieliśmy powyżej, webhooki pozwalają zautomatyzować zadania, które wyczerpują czas i zasoby, takie jak raportowanie, powiadomienia i zarządzanie zaległościami.

W ostatecznym rozrachunku uważamy, że ważne jest, aby skupić się na tym, co najważniejsze, i pozostawić sprawy podrzędne w rękach automatyzacji.

Zanim to zrobimy, sprawdź dostępne plany Integromatu ! Nasza bezpłatna oferta pozwoli Ci eksperymentować z webhookami tak długo, jak tylko zechcesz. Ponadto nasza platforma będzie bardzo przydatna, jeśli nie chcesz brudzić sobie rąk kodem lub skomplikowanymi (i niekończącymi się!) dokumentami API.

Miłej automatyzacji!