Zrozum webhook w Zaawansowana platforma danych klientów Klaviyo

Czego się dowiesz

Dowiedz się więcej o webhookach i o tym, jak można ich używać do wysyłania informacji do aplikacji innych firm w odpowiedzi na zdarzenia zbierane w witrynie Klaviyo. Aby uzyskać bardziej szczegółowe informacje na temat odbierania systemowych webhooków, zapoznaj się z naszymi zasobami dla deweloperów dotyczącymi pracy z systemowymi webhookami.

Co to jest webhook?

webhook umożliwiają stronie Klaviyo przekazywanie informacji lub "wywoływanie" innych aplikacji, narzędzi i serwerów za pośrednictwem żądań HTTP. Mogą wysyłać informacje o zdarzeniu, które miało miejsce (np. złożone zamówienie, nowy klient subskrybowany itp.) lub powiadamiać Twoje zewnętrzne systemy o wystąpieniu zdarzenia.

Klaviyo pomoc 2 rodzaje webhooków:

1. webhook w Zaawansowanej platformie danych klientów Klaviyo
   Webhook dostępny w ramach Zaawansowanej platformy danych klientów Klaviyo służy do powiadamiania Twoich zewnętrznych systemów o wystąpieniu określonego zdarzenia i umożliwia wysyłanie informacji w odpowiedzi na szeroki wachlarz zdarzeń bez ograniczeń wynikających z bycia w sekwencji.
2. Webhooki przepływu
   Webhooki przepływu są dostępne tylko w interfejsie przepływów i są uruchamiane, gdy przepływ osiągnie określony etap lub krok. Można ich używać do wysyłania danych o zdarzeniu lub odbiorcy, które wywołały przepływ.

Kluczowe składniki webhooków

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

• Temat
  Zdarzenie powodujące uruchomienie elementu webhook
• Treść (lub „dane użytkowe”)
  Dane wysyłane przez webhook
• Nagłówki
  Miejsce na przekazanie dodatkowych informacji (takich jak uwierzytelnienie)

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

Możesz użyć webhook w Zaawansowana platforma danych klientów Klaviyo lub sekwencja webhook w zależności od potrzeb.

Wydarzenia obejmowały

Sekwencja webhook może reagować tylko na podzbiór zdarzeń Klaviyo i nie pomaga w zdarzeniach związanych z wiadomościami, takich jak wycofać subskrypcję, odebrana wiadomość e-mail lub kliknięta wiadomość e-mail, ponieważ sekwencja zwykle kończy się otrzymaniem wiadomości, a nie zaczyna się od nich. Tymczasem webhook w Zaawansowanej platformie danych klientów Klaviyo pozwala na wysyłanie informacji w odpowiedzi na dowolne zdarzenie na Twoim koncie.

Należą do nich:

• zdarzenia e-mail (np. otrzymana wiadomość e-mail, kliknięta wiadomość e-mail, oznaczenie wiadomości e-mail jako spam, wycofanie subskrypcji)
• Zdarzenia SMS (np. wysłane wiadomości SMS, odebrane wiadomości SMS)
• powiadomienie o zdarzeniach push (np. Odebrane push, Odbite push)
• Zdarzenia z integracji (tj. zdarzenia z własnych integracji utworzonych przez Klaviyo)
• Zdarzenia API (np. zdarzenia zsynchronizowane za pośrednictwem interfejsów API Klaviyo)

Ładunek

Sekwencja webhook umożliwia dostosowanie danych zawartych w żądaniu, ale musisz ręcznie skonstruować ładunek. Tymczasem webhook w Zaawansowanej platformie danych klientów Klaviyo wykorzystuje wstępnie zbudowany ładunek, który nie wymaga żadnej ręcznej pracy po Twojej stronie i służy do powiadamiania zewnętrznych systemów o wystąpieniu zdarzenia.

ograniczenia sekwencji

Webhooki przepływu muszą być skonfigurowane w interfejsie przepływów i nie pozwalają na użycie kilku wyzwalaczy jednocześnie. Różne wyzwalacze muszą być tworzone poprzez indywidualne przepływy i są zależne od ogólnego statusu przepływu (np. przepływ w wersji roboczej nie wysyła danych poprzez webhook przepływu). Tymczasem webhooki w Advanced KDP istnieją poza interfejsem przepływów i nie są zależne od serii kroków prowadzących do akcji webhooka, tak jak webhooki przepływu.

Skonfiguruj webhook

Aby skonfigurować webhook w Klaviyo, przejdź do webhook w Zaawansowana platforma danych klientów Klaviyo > dane zarządzania > webhook w Klaviyo.

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

1. W oknie dialogowym Utwórz webhook wprowadź informacje. Obejmuje to:
   • Nazwa
     Jak zidentyfikują Państwo swój webhook
   • Adres URL punktu końcowego
     Adres URL powiązany z miejscem docelowym żądania webhooka.
   • Tajny klucz
     Unikalny identyfikator służący do identyfikacji żądań webhooków Klaviyo w innych systemach użytkownika.
   • Opis
     Opcjonalny opis Twojego elementu webhook.
2. W sekcji Tematy wybierz zdarzenia, które mają wyzwalać powiadomienia webhook.

Po utworzeniu adresu webhook, zostanie on wyświetlony na stronie webhook wraz z adresem:

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

Możesz usunąć lub wyłączyć swoją stronę webhook za pomocą menu obok pozycji.

Przetestuj system webhook 

Podczas konfigurowania webhooka w Klaviyo można go przetestować, aby upewnić się, że połączenie działa poprawnie. Aby przetestować webhook, po wypełnieniu wymaganych pól należy użyć przycisku Testuj połączenie .

Pojawi się menu, w którym możesz wybrać temat i wysłać test na swój zwrotny adres URL. 

Po wykonaniu testu zobaczysz komunikat wskazujący, czy test się powiódł, wraz z nagłówkiem i treścią żądania wypełnionymi w zakładce Response.

Przykładowy ładunek

Poniżej znajduje się przykład ładunku dla żądania webhook w odpowiedzi na dostarczony temat wiadomości e-mail. 

{
 " meta": {
    "timestamp": "2023-08-10T07:25:23.700369+00:00",
    "klaviyo_webhook_id": "ID",
    "version": "2023-06-03"
  },
 " dane": [
 {
 " topic": "event: email_delivered",
 " external_id": "ID",
 " payload": {
 " dane": {
 " id": "ID",
 " type": "event",
 " links": {
            "self": "https://a.klaviyo.com/api/events/ID/"
          },
 " atrybuty": {
            "uuid": "96150200-374e-11ee-8001-a163313bc6c2",
 " datetime": "2023-08-10 07:21:56+00:00",
 " timestamp": 1691652116,
 " event_properties": {
 " $ESP": 0,
 " Subject": "? Darmowy (Fajny!) Swag Alert ?",
 " $message": "01H7F525FKR31P27Y7PNGVBBKK",
 " $event_id": "01H7F525FKR31P27Y7PNGVBBKK:125423419905414052533228990613763937641",
 " $group_ids": [
 " V7adxq"
 ],
 " $attribution": {
                "$send_ts": 0,
                "$attributed_event_id": ""
              },
 " e-mail Domena": "Klaviyo-demo.com",
              "kampania Nazwa": "Codzienny newsletter: 2023-08-10",
 " Skrzynka odbiorcza usługodawca
dostawca": "Amazon SES Inbound",
 " $_cohort$message_send_cohort": "1691652081:01H7F525FKR31P27Y7PNGVBBKK"
 }
         },
 " relacje": {
 " metryka": {
 " dane": {
                "id": "ID",
                "type": "metric"
              },
 " linki": {
                "self": "https://a.klaviyo.com/api/events/ID/relationships/metric/",
                "related": "https://a.klaviyo.com/api/events/ID/metric/"
              }
            },
 " dane profilowe": {
                "id": "ID",
                "type": "profile"
              },
              "linki": {
                "self": "https://a.klaviyo.com/api/events/ID/relationships/profile/",
                "related": "https://a.klaviyo.com/api/events/ID/profile/"
              }
            }
          }
        }
      }
    },
  

Dodatkowe źródła

Jak dodać akcję webhook do sekwencji

Zrozumienie webhooków Klaviyo

Praca z systemowym webhookiem (Klaviyo's webhook API)