Jak wyzwalać Webhooki w przepływach pracy opartych na kontaktach HubSpot

Używaj webhooków w przepływach pracy, aby wysyłać lub pobierać informacje między HubSpot a innymi narzędziami zewnętrznymi. Webhooki mają wiele zastosowań. Przykłady popularnych zastosowań webhooków obejmują:

• Przesyłanie danych kontaktowych HubSpot do innego systemu, takiego jak CRM, gdy kontakt wypełnia określony formularz w witrynie.

• 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 HubSpot.

Za pomocą przepływów pracy można wysyłać żądania POST i GET. HubSpot reguluje ruch webhooków oddzielnie od innych procesów przepływu pracy. Ma to na celu usprawnienie przepływu pracy i wydajności webhooków. Gdy webhook działa wolno lub przekracza limit czasu, wykonanie akcji przepływu pracy może potrwać dłużej niż oczekiwano.

Uwaga: HubSpot będzie ponawiać nieudane webhooki przez maksymalnie trzy dni, począwszy od minuty po niepowodzeniu. Kolejne niepowodzenia będą ponawiane w coraz dłuższych odstępach czasu, z maksymalną przerwą ośmiu godzin między próbami. Workflow nie będą ponawiane po otrzymaniu kodów statusu odpowiedzi z serii 4XX.
Jedynym wyjątkiem od tej zasady są błędy limitu szybkości 429; workflow będą automatycznie ponawiane po otrzymaniu odpowiedzi 429 i będą respektować nagłówek Retry-After, jeśli jest obecny. Retry-After jest rejestrowane w milisekundach. Dowiedz się więcej o konkretnych wyjątkach kodów błędów w dokumentacji dla programistów HubSpot.

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

Skonfiguruj żądanie POST

1. Na koncie HubSpot przejdź do Automatyzacja > Przepływy pracy.
2. Aby edytować istniejący przepływ pracy, kliknij jego nazwę. Możesz też utworzyć nowy przepływ pracy.
3. W edytorze przepływu pracy kliknij ikonę +, aby dodać akcję.
4. W lewym panelu, w sekcji Operacje danych, wybierz opcję Wyślij webhook.
    

5. Kliknij menu rozwijane Metoda i wybierz POST.
6. Wprowadź adres URL webhooka.
   • Adresy URL webhooków są ograniczone do bezpiecznego protokołu i muszą zaczynać się od HTTPS.
   • Aby uzyskać określone informacje, można dodać parametry zapytania, takie jak ?queryparameter=abc, do adresu URL webhooka.
   • Jeśli nie dodano żadnych parametrów zapytania, zostanie wysłane ogólne żądanie POST lub GET.
7. Skonfiguruj typ uwierzytelniania, aby uwierzytelnić żądania do swojego 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ź swój identyfikator aplikacji HubSpot. Dowiedz się, jak weryfikować podpisy żądań.
   • Aby użyć klucza API lub publicznej aplikacji utworzonej za pośrednictwem konta programisty do uwierzytelniania:
     • W przypadku używania klucza API do uwierzytelniania nazwa klucza API i lokalizacja klucza API 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ść lokalizacji 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. Kliknij Zapisz.

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

Skonfiguruj żądanie GET

1. Na koncie HubSpot przejdź do Automatyzacja > Przepływy pracy.
2. Aby edytować istniejący przepływ pracy, kliknij jego nazwę. Możesz też utworzyć nowy przepływ pracy.
3. W edytorze przepływu pracy kliknij ikonę +, aby dodać akcję.
4. W lewym panelu, w sekcji Operacje danych, wybierz opcję Wyślij webhook.
    

5. Kliknij menu rozwijane Metoda i wybierz GET.
6. Wprowadź adres URL webhooka.
   • Adresy URL webhooków są ograniczone do bezpiecznego protokołu i muszą zaczynać się od HTTPS.
   • Aby uzyskać określone informacje, można dodać parametry zapytania, takie jak ?queryparameter=abc, do adresu URL webhooka.
   • Jeśli nie dodano żadnych parametrów zapytania, zostanie wysłane ogólne żądanie POST lub GET.
7. Skonfiguruj typ uwierzytelniania, aby uwierzytelnić żądania do swojego 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ź swój identyfikator aplikacji HubSpot. Dowiedz się, jak weryfikować podpisy żądań.
   • Aby użyć klucza API lub publicznej aplikacji utworzonej za pośrednictwem konta programisty do uwierzytelniania:
     • W przypadku używania klucza API do uwierzytelniania nazwa klucza API i lokalizacja klucza API 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ść lokalizacji 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 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 Dodaj wartość statyczną.
    • Aby usunąć właściwość, kliknij ikonę usuwania.
11. Kliknij przycisk Zapisz.

Ustaw limit częstotliwości dla swojego webhooka

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

1. Na koncie HubSpot przejdź do Automatyzacja > Przepływy pracy.
2. Kliknij nazwę przepływu pracy.
3. W edytorze przepływu pracy kliknij akcję Wyślij webhook.
4. W lewym panelu kliknij opcję Konfiguruj limit szybkości, aby rozwinąć sekcję.
5. Kliknij, aby włączyć przełącznik Włącz limit częstotliwości. Domyślnie to ustawienie jest wyłączone. 
6. Skonfiguruj limit szybkości: 
   • Wykonania akcji: ustaw maksymalną liczbę wykonań w danym okresie czasu. 
   • Ramy czasowe: ustaw ramy czasowe dla limitu szybkości. Ramy czasowe można ustawić w sekundach, minutach lub godzinach. 

Przetestuj swój webhook w HubSpot

Podczas konfigurowania webhooka POST lub GET możesz 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 używasz klucza API do uwierzytelniania, klucz API nie będzie wyświetlany w żadnych żądaniach testowych.

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

1. Na koncie HubSpot przejdź do Automatyzacja > Przepływy pracy.
2. Kliknij nazwę przepływu pracy.
3. W edytorze przepływu pracy kliknij akcję Wyślij webhook.
4. W lewym panelu kliknij op cję Testuj akcję, aby rozwinąć sekcję.
5. Jeśli testujesz żądanie POST, konfiguracja testu webhooka będzie się różnić w zależności od tego, czy wybrałeś opcję Dostosuj treść żądania, czy też opcję Dołącz wszystkie właściwości [obiektu] w akcji webhooka.
   • Jeśli wybrałeś opcję Dostosuj treść żądania, wprowadź wartości testowe właściwości dla swojego testu.
   • Jeśli wybrałeś opcję Dołącz wszystkie właściwości [obiektu], kliknij menu rozwijane [obiekt], a następnie wybierz rekord, który chcesz przetestować.
6. Kliknij 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 zwinąć wszystkie sekcje.
   • W zakładce Odpowiedź kliknij nagłówki: lub treść:, aby rozwinąć każdą sekcję.
   • W zakładce Żądanie kliknij httpHeaders:, aby rozwinąć sekcję.
     
     

Przetestuj swój webhook zewnętrznie

Po utworzeniu przepływu pracy z akcją webhook możesz przeprowadzić szybki test przy użyciu fikcyjnego adresu URL webhook:

1. W przeglądarce przejdź do strony https://webhook.site i skopiuj unikalny adres URL.
2. Wklej adres URL w polu Adres URL webhooka w akcji webhooka.
3. Po włączeniu przepływu pracy możesz ręcznie zarejestrować kontakt testowy.
   
   

4. Podczas testowania webhooka zewnętrznie:
   • Jeśli zostanie uruchomiona akcja webhook z żądaniem POST, do webhook zostanie wysłana treść odpowiedzi JSON zawierająca wszystkie informacje o kontakcie, w tym przesłane formularze, członkostwo w listach i wszystkie wartości właściwości kontaktu. System odbiorczy może następnie przeanalizować dane JSON i wykorzystać je we własnej aplikacji.
   • Jeśli zostanie uruchomiona akcja webhooka z żądaniem GET, zostanie wysłane ogólne żądanie GET, chyba że zastosowano dodatkowe parametry zapytania.

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

Weryfikacja podpisów żądań w webhookach przepływu pracy

Jeśli w sekcji Uwierzytelnianie dla akcji Wyzwalanie webhooka wybrano opcję Podpis żądania, HubSpot wypełni webhook nagłówkiem X-HubSpot-Signature z skrótem SHA-256 połączonym z sekretem aplikacji, metodą HTTP, adresem URI i nieprzetworzoną treścią. Więcej informacji na ten temat można znaleźć w dokumentacji dla programistów.

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

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

Uruchamianie przepływów pracy z webhooków

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 z webhooków.

Korzystanie z danych webhooków w panelu danych

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

Aby skorzystać z danych z podłączonego webhooka:

1. Na koncie HubSpot przejdź do Automatyzacja > Przepływy pracy.
2. Kliknij nazwę przepływu pracy.
3. Kliknij ikonę +, aby dodać akcję.
4. W lewym panelu wybierz akcję, która wykorzystuje panel danych.
5. W panelu danych kliknij menu rozwijane Wyświetl właściwości lub wyniki działania i wybierz op cję Wyzwalacz webhook. Następnie możesz użyć właściwości z podłączonego webhooka.