Jak uruchamiać webhooki w przepływach pracy opartych na kontaktach w HubSpot

Wykorzystaj webhooki w przepływach pracy opartych na kontaktach, aby wysyłać lub pobierać dane między HubSpot a narzędziami zewnętrznymi. Pozwala to na automatyzację procesów na różnych platformach. Możesz używać webhooków typu POST do wysyłania danych z HubSpot, a webhooków typu GET do pobierania danych z narzędzi zewnętrznych.

Podczas konfigurowania webhooków typu POST lub GET możesz kontrolować szybkość ich wykonywania za pomocą limitów częstotliwości oraz ręcznie przetestować konfigurację webhooków w HubSpot lub przy użyciu narzędzi zewnętrznych. 
Możesz również dowiedzieć się, jak weryfikować żądania z HubSpot, jak używać webhooków do automatycznego uruchamiania przepływów pracy oraz jak wykorzystywać dane odpowiedzi webhooków w innych akcjach przepływu pracy.

Dowiedz się więcej o webhookach w dokumentacji webhooków dla programistów. Jeśli masz pytania dotyczące konkretnego wdrożenia webhooków w HubSpot, skontaktuj się z nami na forach programistów HubSpot.

Jakie są przykładowe zastosowania webhooków?

Przykłady popularnych zastosowań webhooków obejmują:

• Przesyłanie danych kontaktowych z HubSpot do innego systemu, takiego jak CRM, gdy dany kontakt wypełni określony formularz na Twojej stronie.

• Wysyłanie danych dotyczących transakcji do zewnętrznego systemu obsługi wysyłek w celu utworzenia zamówienia zakupu.

• Pobieranie danych z innego systemu w celu aktualizacji rekordów w HubSpot.

Za pomocą

przepływów pracy można wysyłać zarówno żądania POST, jak i GET. HubSpot reguluje ruch webhooków oddzielnie od innych procesów przepływów pracy. Ma to na celu usprawnienie działania przepływów pracy i webhooków. Gdy webhook działa wolno lub nastąpi przekroczenie limitu czasu, wykonanie akcji przepływu pracy może potrwać dłużej niż oczekiwano.

Jak wysłać dane z HubSpot za pomocą webhooka POST?

1. Na koncie HubSpot kliknij Więcej, a następnie przejdź do Automatyzacja > Przepływy pracy. Jeśli opcja Więcej się nie pojawia, przejdź bezpośrednio do sekcji Automatyzacja > Przepływy pracy.
2. Aby edytować istniejący przepływ pracy, kliknij nazwę przepływu. Możesz też utworzyć nowy przepływ pracy.
3. W edytorze przepływu pracy kliknij ikonę plusa (+), aby dodać akcję.
4. W lewym panelu, w sekcji „Operacje na danych ”, wybierz op cję „Wyślij webhook”.
    

5. Kliknij menu rozwijane „Metoda ” i wybierz opcję „POST”.
6. Wprowadź adres URL webhooka.
   • Adresy URL webhooków muszą korzystać z bezpiecznego protokołu i zaczynać się od HTTPS.
   • Aby uzyskać konkretne informacje, do adresu URL webhooka można dodać parametry zapytania, np. ?queryparameter=abc .
   • Jeśli nie dodano żadnych parametrów zapytania, zostanie wysłane ogólne żądanie POST lub GET.
7. Skonfiguruj typ uwierzytelniania, aby uwierzytelnić żądania kierowane do Twojego webhooka. Możesz użyć podpisu żądania w nagłówku webhooka lub klucza API:
   • Aby użyć podpisu żądania w nagłówku webhooka:
     • Kliknij menu rozwijane Typ uwierzytelniania. Następnie wybierz opcję Dołącz podpis żądania w nagłówku.
     • Następnie wprowadź identyfikator aplikacji HubSpot. Dowiedz się, jak weryfikować podpisy żądań.
   • Aby użyć klucza API lub publicznej aplikacji utworzonej za pośrednictwem konta deweloperskiego do uwierzytelniania:
     • W przypadku używania klucza API do uwierzytelniania nazwa klucza API i jego lokalizacja zależą od konfiguracji webhooka. Ze względów bezpieczeństwa klucz API nie będzie wyświetlany w żadnych żądaniach testowych. Aby użyć klucza API:
       • Kliknij menu rozwijane „Typ uwierzytelniania ”. Następnie wybierz opcję „Klucz API”.
       • Wprowadź nazwę klucza API.
       • Kliknij menu rozwijane „Lokalizacja klucza API ”. Następnie wybierz opcję „Parametry zapytania ” lub „Nagłówek żądania”. Dowiedz się więcej o korzystaniu z kluczy API w HubSpot.
     • Jeśli wysyłasz żądanie do interfejsów API HubSpot:
       • Kliknij menu rozwijane „Klucz API ” i wybierz sekret. Wartość sekretu musi mieć format Bearer [TWÓJ_TOKEN].
       • Ustaw wartość nazwy klucza API na „Autoryzacja”.
       • Ustaw wartość pola „Lokalizacja klucza API” na „Nagłówek żądania”.
8. Aby uwzględnić wszystkie właściwości, wybierz opcję „Uwzględnij wszystkie właściwości [obiektu]”.
9. Aby uwzględnić tylko określone właściwości:
   • Wybierz opcję „Dostosuj treść żądania”.
   • Aby dostosować treść żądania przy użyciu właściwości HubSpot, wprowadź klucz i wybierz właściwość. Aby dodać kolejną właściwość, kliknij „Dodaj właściwość”.
   • Aby dostosować treść żądania przy użyciu pola statycznego, wprowadź klucz i wartość. Aby dodać kolejną właściwość, kliknij „Dodaj wartość statyczną”.
   • Aby usunąć właściwość lub wartość statyczną, kliknij ikonę kosza.
10. W górnej części strony kliknij „Zapisz”.

Uwaga: aby wybrać wiele wyników, odpowiedź powinna mieć strukturę obiektu JSON.

Jak pobrać dane do HubSpot za pomocą webhooka GET?

1. Na koncie HubSpot kliknij Więcej, a następnie przejdź do Automatyzacja > Przepływy pracy. Jeśli opcja Więcej się nie pojawia, przejdź bezpośrednio do sekcji Automatyzacja > Przepływy pracy.
2. Aby edytować istniejący przepływ pracy, kliknij nazwę przepływu. Możesz też utworzyć nowy przepływ pracy.
3. W edytorze przepływu pracy kliknij ikonę plusa (+), aby dodać akcję.
4. W panelu po lewej stronie, w sekcji „Operacje na danych ”, wybierz op cję „Wyślij webhook”.
    

5. Kliknij menu rozwijane „Metoda ” i wybierz opcję GET.
6. Wprowadź adres URL webhooka.
   • Adresy URL webhooków muszą korzystać z bezpiecznego protokołu i zaczynać się od HTTPS.
   • Aby uzyskać konkretne informacje, do adresu URL webhooka można dodać parametry zapytania, takie jak ?queryparameter=abc .
   • Jeśli nie dodano żadnych parametrów zapytania, zostanie wysłane ogólne żądanie POST lub GET.
7. Skonfiguruj typ uwierzytelniania, aby uwierzytelnić żądania kierowane do Twojego webhooka. Możesz użyć podpisu żądania w nagłówku webhooka lub klucza API:
   • Aby użyć podpisu żądania w nagłówku webhooka:
     • Kliknij menu rozwijane Typ uwierzytelniania. Następnie wybierz opcję Dołącz podpis żądania w nagłówku.
     • Następnie wprowadź identyfikator aplikacji HubSpot. Dowiedz się, jak weryfikować podpisy żądań.
   • Aby użyć klucza API lub publicznej aplikacji utworzonej za pośrednictwem konta deweloperskiego do uwierzytelniania:
     • W przypadku używania klucza API do uwierzytelniania nazwa klucza API i jego lokalizacja zależą od konfiguracji webhooka. Ze względów bezpieczeństwa klucz API nie będzie wyświetlany w żadnych żądaniach testowych. Aby użyć klucza API:
       • Kliknij menu rozwijane „Typ uwierzytelniania ”. Następnie wybierz opcję „Klucz API”.
       • Wprowadź nazwę klucza API.
       • Kliknij menu rozwijane „Lokalizacja klucza API ”. Następnie wybierz opcję „Parametry zapytania ” lub „Nagłówek żądania”. Dowiedz się więcej o korzystaniu z kluczy API w HubSpot.
     • Jeśli wysyłasz żądanie do interfejsów API HubSpot:
       • Kliknij menu rozwijane „Klucz API ” i wybierz sekret. Wartość sekretu musi mieć format Bearer [TWÓJ_TOKEN].
       • Ustaw wartość nazwy klucza API na „Autoryzacja”.
       • Ustaw wartość pola „Lokalizacja klucza API” na „Nagłówek żądania”.
8. Jeśli konfigurujesz żądanie GET, możesz użyć właściwości HubSpot lub dodać wartości statyczne jako parametry zapytania: 

9. Aby użyć właściwości HubSpot jako parametru zapytania:
   • W sekcji „Parametry zapytania ” wprowadź klucz, a następnie wybierz właściwość.
   • Aby dodać kolejną właściwość, kliknij opcję Dodaj właściwość.
   • Aby usunąć właściwość, kliknij ikonę usuwania.
10. Aby użyć wartości statycznej jako parametru zapytania:
    • W sekcji „Parametry zapytania ” wprowadź klucz, a następnie wprowadź wartość.
    • Aby dodać kolejną właściwość, kliknij opcję „Dodaj wartość statyczną”.
    • Aby usunąć właściwość, kliknij ikonę usuwania.
11. Kliknij „Zapisz”.

Jak kontrolować szybkość wykonywania webhooków za pomocą limitów

częstotliwości

?

Ustaw limit częstotliwości, aby określić, jak szybko powinna być wykonywana akcja webhooka. Limit częstotliwości wpłynie również na wszystkie kolejne akcje w przepływie pracy.

1. Na koncie HubSpot kliknij Więcej, a następnie przejdź do Automatyzacja > Przepływy pracy. Jeśli opcja Więcej się nie pojawia, przejdź bezpośrednio do sekcji Automatyzacja > Przepływy pracy.
2. Kliknij nazwę przepływu pracy.
3. W edytorze przepływu pracy kliknij akcję Wyślij webhook.
4. W panelu po lewej stronie kliknij opcję „Skonfiguruj limit częstotliwości”, aby rozwinąć tę sekcję.
5. Kliknij, aby włączyć przełącznik „Włącz ograniczenie częstotliwości ”. Domyślnie to ustawienie jest wyłączone. 
6. Skonfiguruj limit częstotliwości: 
   • Wykonania akcji: ustaw maksymalną liczbę wykonań w danym przedziale czasowym. 
   • Ramy czasowe: ustaw ramy czasowe dla limitu częstotliwości. Możesz ustawić te ramy czasowe w sekundach, minutach lub godzinach. 

Jak przetestować konfigurację webhooka w HubSpot?

Podczas konfigurowania webhooka POST lub GET można przeprowadzić test, aby wyświetlić odpowiedź webhooka. Podczas testu, gdy dane są wysyłane do podmiotu zewnętrznego i pobierane z niego, nie ma to wpływu na istniejące rekordy w HubSpot. Jeśli do uwierzytelniania używasz klucza API, klucz ten nie będzie wyświetlany w żadnych żądaniach testowych.

Po przetestowaniu webhooka możesz wybrać pola, które mają być wyświetlane jako dane wyjściowe, aby wykorzystać je później jako dane wejściowe w przepływie pracy. Wybierz tylko te pola wyjściowe, które są dostępne w każdej odpowiedzi. Jeśli dane wyjściowe zostaną wykorzystane w późniejszej akcji, ale nie będą dostępne w odpowiedzi, akcja zakończy się niepowodzeniem.

1. Na koncie HubSpot kliknij Więcej, a następnie przejdź do Automatyzacja > Przepływy pracy. Jeśli opcja Więcej się nie pojawia, przejdź bezpośrednio do sekcji Automatyzacja > Przepływy pracy.
2. Kliknij nazwę przepływu pracy.
3. W edytorze przepływu pracy kliknij akcję Wyślij webhook.
4. W panelu po lewej stronie kliknij opcję „Testuj akcję ”, aby rozwinąć tę sekcję.
5. Jeśli testujesz żądanie POST, konfiguracja testu webhooka będzie się różnić w zależności od tego, czy w akcji webhooka wybrałeś opcję Dostosuj treść żądania, czy opcję Uwzględnij wszystkie właściwości [obiektu].
   • Jeśli wybrałeś opcję Dostosuj treść żądania, wprowadź testowe wartości właściwości do swojego testu.
   • Jeśli wybrałeś opcję „Uwzględnij wszystkie właściwości [obiektu]”, kliknij menu rozwijane [obiekt], a następnie wybierz rekord, który chcesz przetestować.
6. Kliknij przycisk „Testuj”.
7. Aby sprawdzić szczegóły webhooka, wybierz kartę „Odpowiedź ” lub „Żądanie ”. Na każdej karcie możesz kliknąć „Otwórz wszystko ”, aby rozwinąć wszystkie sekcje, lub „Zwiń wszystko”, aby je zwinąć.
   • W zakładce „Odpowiedź ” kliknij „nagłówki:” lub „treść:”, aby rozwinąć każdą sekcję.
   • W zakładce „Żądanie” kliknij „httpHeaders:”, aby rozwinąć tę sekcję.
     
     

Jak przetestować webhooki za pomocą narzędzi zewnętrznych?

Po utworzeniu przepływu pracy zawierającego akcję webhook można przeprowadzić szybki test przy użyciu fikcyjnego adresu URL webhooka:

1. W przeglądarce przejdź do strony https://webhook.site i skopiuj unikalny adres URL.
2. W polu „Adres URL webhooka ” w akcji webhooka wklej ten adres.
3. Po włączeniu przepływu pracy możesz ręcznie dodać kontakt testowy.
4. Podczas testowania webhooka zewnętrznie:
   • Jeśli zostanie wywołana akcja webhooka z żądaniem POST, do webhooka zostanie wysłana treść odpowiedzi w formacie JSON zawierająca wszystkie informacje o kontakcie, w tym przesłane formularze, przynależność do list oraz wszystkie wartości właściwości kontaktu. System odbierający może następnie przeanalizować dane JSON i wykorzystać je we własnej aplikacji.
   • Jeśli uruchomiona zostanie akcja webhooka z żądaniem GET, zostanie wysłane ogólne żądanie GET, o ile nie zastosowano dodatkowych parametrów zapytania.

Uwaga: historyczne wartości właściwości będą zwracane wyłącznie w przepływach pracy opartych na kontaktach. Webhooki używane we wszystkich innych typach przepływów pracy będą zwracać wyłącznie najnowszą wartość.

Jak sprawdzić, czy żądania webhooków pochodzą z HubSpot?

Jeśli w sekcji „Uwierzytelnianie” dla akcji „Wywołaj webhook” wybrano opcję „Podpis żądania”, HubSpot uzupełni webhook o nagłówek X-HubSpot-Signature zawierający skrót SHA-256 powstały z połączenia klucza tajnego aplikacji, metody HTTP, adresu URI oraz nieprzetworzonej treści żądania. Więcej informacji na ten temat znajdziesz w dokumentacji dla programistów.

Aby sprawdzić, czy żądania otrzymane pod Twoim adresem URL pochodzą z HubSpot:

• Posiadaj konto programisty. Jeśli go nie masz, załóż konto programisty.
• Posiadaj aplikację. Jeśli nie masz aplikacji, dowiedz się, jak ją utworzyć.
• Sprawdź wartość skrótu podpisu.

Jak używać webhooków do automatycznego uruchamiania przepływów pracy?

Webhooki mogą służyć do uruchamiania przepływów pracy. Zmiana danych w aplikacji zewnętrznej może spowodować uruchomienie przepływu pracy. Dowiedz się więcej o uruchamianiu przepływów pracy za pomocą webhooków.

Jak wykorzystać dane odpowiedzi

z

webhooków w innych akcjach przepływu pracy?

Dane z webhooka podłączonego do Twojego konta mogą być wykorzystywane w niektórych akcjach w panelu danych.

Aby wykorzystać dane z podłączonego webhooka:

1. Na koncie HubSpot kliknij Więcej, a następnie przejdź do Automatyzacja > Przepływy pracy. Jeśli opcja Więcej się nie pojawia, przejdź bezpośrednio do sekcji Automatyzacja > Przepływy pracy.
2. Kliknij nazwę swojego przepływu pracy.
3. Kliknij ikonę plusa (+), aby dodać akcję.
4. W panelu po lewej stronie wybierz akcję, która korzysta z panelu danych.
5. W panelu danych, w sekcji Dane akcji, wybierz akcję Wyślij webhook. Następnie możesz korzystać z właściwości z podłączonego webhooka.
    

Co się dzieje, gdy webhook zakończy się niepowodzeniem?

HubSpot będzie ponawiać nieudane webhooki przez maksymalnie trzy dni, zaczynając od jednej minuty po niepowodzeniu. Kolejne nieudane próby będą ponawiane w coraz dłuższych odstępach czasu, przy czym maksymalna przerwa między próbami wynosi osiem godzin.

Przepływy pracy nie będą ponawiane po otrzymaniu kodów statusu odpowiedzi z serii 4XX. Wyjątkiem są błędy ograniczenia częstotliwości 429; przepływy pracy będą automatycznie ponawiane po otrzymaniu odpowiedzi 429 i będą uwzględniać nagłówek „Retry-After”, jeśli jest obecny. Wartość „Retry-After” jest podawana w milisekundach. Dowiedz się więcej o konkretnych wyjątkach dotyczących kodów błędów w dokumentacji dla programistów HubSpot.