Poznaj webhooki w Zaawansowanej platformie danych klientów Klaviyo

Czego się dowiesz?

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

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 pośrednictwem żądań HTTP. Mogą wysyłać informacje o zdarzeniu, które miało miejsce (np. złożeniu zamówienia, subskrybowaniu przez nowego klienta itp.), lub powiadamiać Twoje systemy zewnętrzne o tym, ż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 Twoich zewnętrznych systemów o tym, że wystąpiło określone zdarzenie, oraz umożliwiają przesyłanie informacji w odpowiedzi na szeroki zakres zdarzeń bez ograniczeń wynikających z bycia w sekwencji.
2. Webhooki w sekwencjach
   Webhooki w sekwencjach to działania w sekwencjach. Wysyłają dane, gdy profil dociera do działania webhook, i mogą zawierać informacje o tym profilu lub o zdarzeniu, które wyzwoliło 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 albo webhooków sekwencji — w zależności od Twoich potrzeb.

Uwzględnione zdarzenia

W sekwencjach wyzwalanych metryką webhooki sekwencji mogą reagować tylko na zdarzenia obsługiwane jako wyzwalacze sekwencji. Na przykład Received Email i Clicked Email nie są dostępne w selektorze wyzwalacza metryki, natomiast Unsubscribed from marketing e-mailowy jest obsługiwane. Webhooki systemowe w Zaawansowanej platformie danych klientów Klaviyo pozwalają Ci wybierać tematy dla zdarzeń związanych z wiadomościami, a także zdarzenia z integracji i API Klaviyo.

Należą do nich:

• Zdarzenia e-mail (np. Otrzymano e-mail, Kliknięto e-mail, Oznaczono e-mail jako spam, wycofał/-a subskrypcję z marketingu e-mailowego)
• Zdarzenia SMS (np. Wysłano SMS, Odebrano SMS)
• Zdarzenia powiadomień push (np. Odebrano push, Odrzucono push)
• Zdarzenia z integracji (tzn. zdarzenia z integracji własnych utworzonych przez Klaviyo)
• Zdarzenia API (np. zdarzenia zsynchronizowane przez API Klaviyo)

Payload

Webhooki sekwencji pozwalają Ci dostosować dane żądania poprzez skonfigurowanie treści body w formacie JSON. Webhooki systemowe w Zaawansowanej platformie danych klientów Klaviyo korzystają z gotowego payloadu z danymi o zdarzeniach, które wystąpiły. Jedno żądanie może zawierać wiele zdarzeń z tematów, które wybrałeś(-aś).

Ograniczenia sekwencji

webhook w sekwencji postępują zgodnie z wyzwalaczem i krokami sekwencji, w której się znajdują. Używaj oddzielnych sekwencji, aby odpowiadać na różne wyzwalacze sekwencji. Aby wysyłać żądania automatycznie, działanie webhooka musi mieć status Aktywne; działanie w statusie Wersja robocza nie wysyła żądań. Webhooki systemowe działają poza sekwencjami i mogą subskrybować wiele tematów w 1 punkcie końcowym.

Skonfiguruj webhook

1. W Klaviyo przejdź do Zarządzanie danymi > webhooki.
2. Kliknij Utwórz webhook.
3. Na stronie Utwórz webhook wprowadź następujące informacje:
   • 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
     Wpisz tajny klucz o długości 16–100 znaków. Klaviyo używa tego klucza do podpisywania żądań, aby aplikacja odbierająca mogła zweryfikować, że pochodzą one z Klaviyo.
   • Opis
     Opcjonalny opis dla webhooka.
4. W sekcji Tematy wybierz co najmniej 1 temat, który ma wywoływać powiadomienia. Na przykład event:klaviyo.received_email odpowiada wartości Otrzymany e-mail.

5. Opcjonalnie: Zanim zapiszesz, przetestuj połączenie, wykonując poniższe kroki w sekcji Testowanie webhooków systemowych.
6. Kliknij Zapisz, aby utworzyć webhook. Klaviyo przeniesie Cię z powrotem na stronę Webhooki.

Po zapisaniu webhook pojawi się na stronie Webhooki z następującymi szczegółami:

• Nazwa webhooka
• URL punktu końcowego (skrócony ze względów bezpieczeństwa)
• Status

Aby zatrzymać wysyłanie powiadomień, otwórz menu obok webhooka i wybierz Wyłącz. Aby to usunąć, wybierz Usuń i potwierdź usunięcie.

Testowanie webhooków systemu

1. Po wypełnieniu wymaganych pól na stronie Utwórz webhook i wybraniu tematów kliknij Przetestuj połączenie.

2. W panelu Test webhook wybierz temat w sekcji Topics, a następnie kliknij Test, aby wysłać przykładowe żądanie na adres URL Twojego punktu końcowego.

3. Sprawdź wiadomość wskazującą, czy test zakończył się powodzeniem. Karta Żądanie pokazuje nagłówki i ładunek wysłane do twojego punktu końcowego. Karta Odpowiedź pokazuje nagłówki odpowiedzi punktu końcowego, treść i kod stanu.

1. Kliknij Anuluj, aby zamknąć panel testowy i wrócić do konfiguracji webhooka.

Przykładowy payload

Poniżej znajduje się przykładowy payload dla żądania wyzwalanego przez otrzymanie e-maila (event:klaviyo.received_email).

{
  "meta": {
    "timestamp": "2023-08-10T07:25:23.700369+00:00",
    "klaviyo_webhook_id": "ID",
    "version": "2024-06-28",
    "klaviyo_payload_id": "3843971dcfdee5083e6289e1bbdbb003e538b5a8a668fc43ae4f19d415ac18a2",
    "klaviyo_account_id": "ACCOUNT_ID"
  },
  "data": [
    {
      "topic": "event:klaviyo.received_email",
      "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