Webhooks

W procesie dołączania zmian do gałęzi głównej istnieje możliwość poinformowania o tym fakcie usługi zewnętrzej poprzez skonfigurowanie Webhook'a. Webhook to automatyczny wyzwalacz pewnych akcji w systemie które wysyłają tą informację do dowolnego, zewnętrznego serwisu internetowego za pomocą protokołu HTTP.

Dodawanie nowego Webhooka

Do skonfigurowania takiej notyfikacji potrzebny będzie nam adres URL usługi zewnętrzej która powinna odebrać dane oraz wybranie konkretnych eventów w aplikacji Documently.io po wywołaniu których notyfikacja zostanie wysłana. Należy w tym celu przejść do Ustawień projektu a dalej wybrać zakładkę Webhooks. Formularz wymaga wspomnianych wcześniej dwóch pól oraz umożliwia aktywację lub dezaktywację notyfikacji.

Pole URL powinno być poprawnym adresem internetowym który jest dostępny publicznie i składać się z pełnej ścieżki włączając rodzaj protokołu na początku (http/https). Przełącznik Active pozwala na tymczasowe wyłączenie wysyłania powiadomień. Dostępne są poniższe rodzaje zdarzeń po których wywołaniu w Documently zostanie wysłany webhook:

• branch.merged - moment w którym użytkownik dołącza nowe zmiany do głównej gałęzi

Gdy webhook jest aktywny Documently.io wysyła request poprzez protokuł HTTP, metodą POST na url który został skonfigurowany. W requeśtcie wysyłane są podstawowe informację o zdarzeniu takie jak:

• branchId - identyfikator brancha który został właśnie dołączony do głównej gałęzi
• projectId - identyfikator projektu w którym zdarzenie zostało wywołane
• mergedAt - czas kiedy zdarzenie się wydarzyło
• mergeMessage - opis dołączonych zmian

Wysłany requst ignoruje certyfikaty self-signed oraz weryfikację hosta. Oznacza to, że system mimo wszystko będzie próbował wyśłać notyfikację pod rządany URL. Wynik każdego requestu podejrzeć można na liście logów webhooków.