Poznaj webhooki w Zaawansowanej platformie danych klientów Klaviyo

Czego się dowiesz?

Dowiedz się więcej o webhook, oraz jak możesz ich używać do wysyłania informacji do aplikacji innych firm w odpowiedzi na zdarzenia zarejestrowane w Klaviyo. Aby uzyskać bardziej szczegółowe informacje o tym, jak odbierać webhooki systemowe, przejdź do naszego zasobu dla deweloperów: praca z webhookami systemowymi.

This content requires Functional cookies to be enabled.

Update Cookie Settings

Czym są webhooki?

Webhooki umożliwiają Klaviyo przekazywanie informacji lub „wywoływanie” innych aplikacji, narzędzi i serwerów za pomocą żądań HTTP. Mogą wysyłać informacje o zdarzeniu, które miało miejsce (np. złożono zamówienie, nowy klient zasubskrybował itp.) lub powiadamiać zewnętrzne systemy, że zdarzenie wystąpiło.

Klaviyo obsługuje 2 rodzaje webhooków:

1. Webhooki w Zaawansowanej platformie danych klientów Klaviyo
   Webhooki dostępne w ramach Zaawansowanej platformy danych klientów Klaviyo służą do powiadamiania zewnętrznych systemów o tym, że wystąpiło określone zdarzenie, oraz umożliwiają wysyłanie informacji w odpowiedzi na szeroki zakres zdarzeń bez ograniczeń wynikających z działania w sekwencji.
2. Webhooki sekwencji
   Webhooki sekwencji są dostępne tylko w interfejsie sekwencji i są uruchamiane, gdy sekwencja osiągnie określony etap lub krok. Można ich używać do wysyłania danych o zdarzeniu lub odbiorcy, które uruchomiły sekwencję.

Kluczowe elementy webhooków

Webhook składa się z kilku kluczowych elementów:

• Temat
  Zdarzenie, które powoduje uruchomienie webhooka
• Treść (lub „payload”)
  Dane, które webhook wysyła
• Nagłówki
  Miejsce do przekazania dodatkowych informacji (np. uwierzytelniania)

Czym webhooki w Zaawansowanej platformie danych klientów Klaviyo różnią się od webhooków sekwencji?

Możesz używać webhooków w Zaawansowanej platformie danych klientów Klaviyo lub webhooków sekwencji, w zależności od potrzeb.

Uwzględnione zdarzenia

Webhooki sekwencji mogą reagować tylko na podzbiór zdarzeń Klaviyo i nie obsługują zdarzeń związanych z wiadomościami, takich jak wycofać subskrypcję, Otrzymano e-mail lub Kliknięto e-mail, ponieważ sekwencje zazwyczaj kończą się na odebraniu wiadomości, a nie zaczynają się od niego. Tymczasem webhooki w Zaawansowanej platformie danych klientów Klaviyo pozwalają wysyłać informacje w odpowiedzi na dowolne zdarzenie na koncie.

Należą do nich:

• Zdarzenia e-mail (np. Otrzymano e-mail, Kliknięto e-mail, Oznaczono e-mail jako spam, Wycofać subskrypcję)
• Zdarzenia SMS (np. Wysłano SMS, Odebrano SMS)
• Zdarzenia powiadomień push (np. Odebrano push, Odrzucono push)
• Zdarzenia z integracji (tj. zdarzenia z integracji pierwszej strony utworzonych przez Klaviyo)
• Zdarzenia API (np. zdarzenia zsynchronizowane przez API Klaviyo)

Payload

Webhooki sekwencji umożliwiają dostosowanie danych uwzględnionych w żądaniu, ale ładunek musisz ręcznie skonstruować. Tymczasem webhooki w Zaawansowanej platformie danych klientów Klaviyo korzystają z gotowego ładunku, który nie wymaga żadnej pracy ręcznej po Twojej stronie, i służą do powiadamiania systemów zewnętrznych o wystąpieniu zdarzenia.

Ograniczenia sekwencji

Webhooki sekwencji muszą być skonfigurowane w interfejsie sekwencji i nie pozwalają na użycie kilku wyzwalaczy jednocześnie. Różne wyzwalacze trzeba tworzyć w ramach oddzielnych sekwencji i zależą one od ogólnego statusu sekwencji (np. sekwencja w wersji roboczej nie wysyłałaby danych przez webhook sekwencji). Tymczasem webhooki w Zaawansowanej platformie danych klientów Klaviyo istnieją poza interfejsem sekwencji i nie są zależne od serii kroków poprzedzających działanie webhooka, jak ma to miejsce w przypadku webhooka sekwencji.

Skonfiguruj webhook

Aby skonfigurować webhook w Klaviyo, przejdź do webhook w sekcji Zaawansowana platforma danych klientów Klaviyo > Zarządzanie danymi > webhook w Klaviyo.

Aby dodać nowy webhook, kliknij przycisk Utwórz webhook.

1. W modalu Utwórz webhook wprowadź informacje. Obejmuje to:
   • Nazwa
     W ten sposób zidentyfikujesz swój webhook
   • Adres URL punktu końcowego
     Adres URL powiązany z miejscem docelowym żądania webhook
   • Tajny klucz
     Unikatowy identyfikator umożliwiający identyfikowanie żądań webhook Klaviyo w innych systemach
   • Opis
     Opcjonalny opis dla webhooka.
2. W sekcji Tematy wybierz zdarzenia, które mają wyzwalać powiadomienie webhook.

Po utworzeniu webhooka będzie on widoczny na stronie Webhooks wraz z:

• Nazwa webhooka
• Adres URL webhooka
• Czas ostatniej synchronizacji
• Status

Możesz usunąć lub wyłączyć webhooka, korzystając z menu obok elementu.

Testowanie webhooków systemu

Podczas konfigurowania webhook w Klaviyo możesz go przetestować, aby upewnić się, że połączenie działa poprawnie. Aby przetestować webhooka, po wprowadzeniu wymaganych pól kliknij przycisk Testuj połączenie .

Pojawi się menu, w którym można wybrać temat i wysłać test do adresu URL wywołania zwrotnego.

Po przeprowadzeniu testu zobaczysz komunikat wskazujący, czy zakończył się powodzeniem, a także nagłówek i treść żądania wypełnione w karcie Odpowiedź.

Przykładowy payload

Poniżej znajduje się przykład ładunku dla żądania webhook w odpowiedzi na temat Email delivered.

{
  "meta": {
    "timestamp": "2023-08-10T07:25:23.700369+00:00",
    "klaviyo_webhook_id": "ID",
    "version": "2023-06-03"
  },
  "data": [
    {
      "topic": "event: email_delivered",
      "external_id": "ID",
      "payload": {
        "data": {
          "id": "ID",
          "type": "event",
          "links": {
            "self": "https://a.klaviyo.com/api/events/ID/"
          },
          "attributes": {
            "uuid": "96150200-374e-11ee-8001-a163313bc6c2",
            "datetime": "2023-08-10 07:21:56+00:00",
            "timestamp": 1691652116,
            "event_properties": {
              "$ESP": 0,
              "Subject": "? Free (Cool!) Swag Alert ?",
              "$message": "01H7F525FKR31P27Y7PNGVBBKK",
              "$event_id": "01H7F525FKR31P27Y7PNGVBBKK:125423419905414052533228990613763937641",
              "$group_ids": [
                "V7adxq"
              ],
              "$attribution": {
                "$send_ts": 0,
                "$attributed_event_id": ""
              },
              "Email Domain": "klaviyo-demo.com",
              "Campaign Name": "Daily Newsletter: 2023-08-10",
              "Inbox Provider": "Amazon SES Inbound",
              "$_cohort$message_send_cohort": "1691652081:01H7F525FKR31P27Y7PNGVBBKK"
            }
          },
          "relationships": {
            "metric": {
              "data": {
                "id": "ID",
                "type": "metric"
              },
              "links": {
                "self": "https://a.klaviyo.com/api/events/ID/relationships/metric/",
                "related": "https://a.klaviyo.com/api/events/ID/metric/"
              }
            },
            "profile": {
              "data": {
                "id": "ID",
                "type": "profile"
              },
              "links": {
                "self": "https://a.klaviyo.com/api/events/ID/relationships/profile/",
                "related": "https://a.klaviyo.com/api/events/ID/profile/"
              }
            }
          }
        }
      }
    },
  

Dodatkowe źródła