Dostosowanie webhooków (BETA)
Data ostatniej aktualizacji: czerwca 20, 2023
Dostępne z każdą z następujących podpisów, z wyjątkiem miejsc, w których zaznaczono:
Operations Hub Professional , Enterprise |
Jeśli używasz webhooków w przepływach pracy do wysyłania żądań POST lub GET ze swoich przepływów, możesz dostosować swoje webhooki, aby kontrolować wysyłane i odbierane dane.
W swoich żądaniach POST, możesz określić właściwości wysyłane do wszelkich systemów zewnętrznych, takich jak CRM. Podobnie, w żądaniach GET, możesz określić właściwości żądane za pomocą parametrów zapytania.
Dowiedz się więcej o webhookach w dokumentacji webhooków deweloperów. Jeśli masz pytania dotyczące konkretnej implementacji webhooków w HubSpot, skontaktuj się z HubSpot Developers Forums
.Uwaga: HubSpot będzie ponawiał próby wykonania nieudanych webhooków przez maksymalnie trzy dni, zaczynając od jednej minuty po niepow odzeniu. Kolejne niepowodzenia będą sprawdzane w coraz większych odstępach czasu, przy czym maksymalna przerwa między próbami może wynosić osiem godzin. Dowiedz się o konkretnych wyjątkach kodu błędu w dokumentacji deweloperskiej HubSpot
.Skonfiguruj swój webhook
Aby utworzyć i dostosować swój webhooks:
- Na koncie HubSpot przejdź do sekcji Automatyzacje > Przepływy pracy.
- Kliknij nazwę przepływu pracy.
- Kliknij ikonę +, aby dodać akcję.
- W prawym panelu wybierz opcję Wyślij webhook.
- Kliknij menu rozwijane Method, a następnie wybierz POST lub GET.
- Wprowadź adres URL webhooka. Adresy URL webhooków są ograniczone do bezpiecznego protokołu i muszą zaczynać się od HTTPS. Aby zażądać określonych informacji, można dodać parametry zapytania, takie jak
?queryparameter=abc
do adresu URL Webhook. Jeśli nie dodano żadnych parametrów zapytania, zostanie wysłane ogólne żądanie POST lub GET. - Skonfiguruj typ uwierzytelniania, aby uwierzytelnić żądania do swojego webhooka:
- Aby użyć podpisu żądania w swoim nagłówku webhook:
- Kliknij menu rozwijane Authentication type. Następnie wybierz opcję Dołącz podpis żądania w nagłówku.
- Następnie wprowadź swój HubSpot App ID. Dowiedz się, jakzweryfikować podpisy żądań.
- Aby użyć podpisu żądania w swoim nagłówku webhook:
-
- Możesz również użyć klucza API do uwierzytelniania. Podczas używania klucza API do uwierzytelniania, nazwa klucza API i lokalizacja klucza API używane są zależne od tego, jak skonfigurowany jest webhook. 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 uwie rzytelniania. Następnie wybierz opcję Klucz API.
- Możesz również użyć klucza API do uwierzytelniania. Podczas używania klucza API do uwierzytelniania, nazwa klucza API i lokalizacja klucza API używane są zależne od tego, jak skonfigurowany jest webhook. Ze względów bezpieczeństwa klucz API nie będzie wyświetlany w żadnych żądaniach testowych. Aby użyć klucza API:
-
-
- Wprowadź nazwę swojego klucza API.
- Kliknij menu rozwijane Lokalizacja klucza API. Następnie wybierz opcję Parametry zapytania lub Nagłówek żądania. Dowiedz się więcej o używaniu kluczy API w HubSpot.
-
Dostosuj swoje żądanie POST
Jeśli ustawiasz żądanie POST, możesz wybrać, aby dołączyć wszystkie właściwości z rekordu CRM lub wysłać tylko określone właściwości:- Aby uwzględnić wszystkie właściwości, w sekcji Dostosuj ciało żądania wybierz opcję Uwzględnij wszystkie właściwości.
- Aby dołączyć tylko określone właściwości:
- W sekcji Customize request body wybierz opcję Choose specific properties.
- Kliknij menu rozwijane Wybierz właściwość. Następnie kliknij [obiekt] w tym przepływie pracy i wybierz właściwość .
- Aby zmienić nazwę właściwości w webhooku, edytuj pole tekstowe Nazwa właściwości. Spowoduje to tylko aktualizację nazwy właściwości w żądaniu POST, nie zaktualizuje nazwy właściwości ani nazwy wewnętrznej w HubSpot.
- Aby dodać kolejną właściwość, kliknij przycisk Dodaj właściwość.
- Aby usunąć właściwość, kliknij ikonę kosza na śmieci z napisem Usuń
.
Dostosowywanie żądań GET
Jeśli ustawiasz żądanie GET, możesz użyć właściwości jako parametrów zapytania, aby pobrać określone dane:- W sekcji Parametry zapytania kliknij menu rozwijane Wybierz właściwość. Następnie kliknij [obiekt] w tym przepływie pracy i wybierz właściwość .
- Aby zmienić nazwę właściwości w parametrze zapytania, należy edytować pole tekstowe Nazwa
- Aby dodać kolejną właściwość, kliknij przycisk Dodaj paramet r zapytania.
- Aby usunąć właściwość, kliknij ikonę kosza na śmieci z napisem Usuń .
- Kliknij przycisk Zapisz
.