Tworzenie elementów webhook

Elementy webhook to narzędzie do pobierania i przechowywania danych z określonego zdarzenia. Umożliwiają one zarejestrowanie adresu URL https://, pod którym dane dotyczące zdarzenia mogą być przechowywane w formacie JSON lub XML. Elementy webhook są powszechnie używane z następujących powodów:

  • Składanie zamówienia
  • Zmiana ceny produktu
  • Powiadamianie klienta komunikatora internetowego lub pagera, gdy jesteś offline
  • Gromadzenie danych na potrzeby hurtowni danych
  • Integracja oprogramowania księgowego
  • Filtrowanie pozycji zamówienia i informowanie różnych spedytorów o zamówieniu
  • Usuwanie danych klientów z bazy danych, gdy odinstalują Twoją aplikację

Obsługiwane zdarzenia elementów webhook

Podczas tworzenia elementu webhook można wybrać dowolne z wymienionych zdarzeń. Na przykład, jeśli chcesz utworzyć element webhook, który będzie wysyłany za każdym razem, gdy zamówienie zostanie opłacone, wybierz opcję Płatność za zamówienie. Inny przykład: jeśli chcesz utworzyć element webhook, który będzie wysyłany za każdym razem, gdy właściwość sklepu zostanie zaktualizowana, wybierz opcję Aktualizacja sklepu.

Tabela zawierająca listę obsługiwanych zdarzeń elementów webhook dostępnych w panelu administracyjnym Shopify.
KategoriaZdarzenia
Koszyk
  • Utworzenie koszyka
  • Aktualizacja koszyka
Realizacja zakupu
  • Utworzenie realizacji zakupu
  • Usunięcie realizacji zakupu
  • Aktualizacja realizacji zakupu
Kolekcja
  • Utworzenie kolekcji
  • Usunięcie kolekcji
  • Aktualizacja kolekcji
Klient
  • Aktualizacja zgody klienta na marketing SMS
  • Aktualizacja ustawień konta klienta
  • Utworzenie klienta
  • Usunięcie klienta
  • Wyłączenie klienta
  • Aktualizacja zgody klienta na otrzymywanie e-maili marketingowych
  • Włączenie klienta
  • Utworzenie grupy klientów
  • Usunięcie grupy klientów
  • Aktualizacja grupy klientów
  • Dodanie tagów klienta
  • Usunięcie tagów klienta
  • Aktualizacja klienta
Rabat
  • Utworzenie rabatu
  • Usunięcie rabatu
  • Aktualizacja rabatu
Wersja robocza zamówienia
  • Utworzenie wersji roboczej zamówienia
  • Usunięcie wersji roboczej zamówienia
  • Aktualizacja wersji roboczej zamówienia
Realizacja
  • Utworzenie realizacji
  • Usługa realizacji nie może sfinalizować zlecenia realizacji
  • Pozycje pojedyncze zlecenia realizacji są przygotowane do odbioru
  • Przeniesienie zlecenia realizacji
  • Wstrzymanie zlecenia realizacji
  • Zmiana terminu zlecenia realizacji
  • Nadejście terminu zaplanowanego zlecenia realizacji
  • Ukończenie routingu zamówienia dla zlecenia realizacji
  • Anulowanie zamówień realizacji
  • Zaakceptowanie żądania anulowania zamówień realizacji
  • Odrzucenie żądania anulowania zamówień realizacji
  • Przesłanie żądania anulowania zamówień realizacji
  • Zaakceptowanie żądania realizacji zamówień realizacji
  • Odrzucenie żądania realizacji zamówień realizacji
  • Przesłanie żądania realizacji zamówień realizacji
  • Zwolnienie wstrzymania zamówień realizacji
  • Pozycje pojedyncze zamówień realizacji przygotowane do dostawy lokalnej
  • Scalenie zamówień realizacji
  • Podział zamówień realizacji
  • Aktualizacja realizacji
Zapasy
  • Utworzenie pozycji zapasów
  • Usunięcie pozycji zapasów
  • Aktualizacja pozycji zapasów
  • Połączenie poziomu zapasów
  • Rozłączenie poziomu zapasów
  • Aktualizacja poziomu zapasów
Lokalizacja
  • Aktywacja lokalizacji
  • Utworzenie lokalizacji
  • Dezaktywacja lokalizacji
  • Usunięcie lokalizacji
  • Aktualizacja pozycji lokalizacji
Rynek
  • Utworzenie rynku
  • Usunięcie rynku
  • Aktualizacja rynku
Zamówienie
  • Anulowanie zamówienia
  • Utworzenie zamówienia
  • Usunięcie zamówienia
  • Edycja zamówienia
  • Realizacja zamówienia
  • Płatność za zamówienie
  • Zmiana oceny ryzyka zamówienia
  • Aktualizacja zamówienia
Produkt
  • Utworzenie produktu
  • Usunięcie produktu
  • Aktualizacja produktu
Zwrot kosztów
  • Utworzenie zwrotu kosztów
Sklep
  • Aktualizacja sklepu
Transakcja płatnicza
  • Utworzenie transakcji płatniczej
Szablon
  • Utworzenie szablonu
  • Usunięcie szablonu
  • Publikacja szablonu
  • Aktualizacja szablonu
Transakcja
  • Utworzenie transakcji

Tworzenie elementów webhook

Element webhook można utworzyć w dowolnym momencie. Elementy webhook są podpisywane za pomocą unikalnego dla sklepu ID, składającego się z kombinacji liter i cyfr.

Kroki:

Desktop
  1. W panelu administracyjnym Shopify przejdź do opcji Ustawienia > Powiadomienia.

  2. Kliknij opcję Elementy webhook.

  3. Kliknij opcję ⊕ Utwórz element webhook.

  4. W menu rozwijanym Zdarzenie wybierz jedno z obsługiwanych zdarzeń elementu webhook, którego chcesz użyć jako zdarzenia elementu webhook. Po utworzeniu elementu webhook nie można zmienić jego zdarzenia.

  5. W menu rozwijanym Format wybierz format, w którym Shopify ma wysyłać Ci te informacje. Dostępne opcje to JSON i XML.

  6. W polu URL wprowadź adres URL, pod którym mają być przechowywane dane. Elementów webhook nie można zwracać na następujące adresy URL:

    • Localhost
    • Dowolny adres URL zakończony słowem „internal” (np. example.com/internal)
    • Dowolny adres URL z dowolnej niestandardowej domeny dołączonej do sklepu
    • „Fałszywe” domeny (np. www.example.com)
    • Domeny Shopify (np. shopify.com i myshopify.com)
  7. W polu Wersja API elementu webhook wybierz preferowaną wersję elementu webhook.

  8. Kliknij opcję Zapisz.

Aplikacja mobilna
  1. W Shopify app naciśnij Menu, a następnie naciśnij Ustawienia Ustawienia.

  2. W sekcji Ustawienia sklepu naciśnij opcję Powiadomienia.

  3. Naciśnij opcję Elementy webhook.

  4. Naciśnij opcję ⊕ Utwórz element webhook.

  5. W menu rozwijanym Zdarzenie wybierz jedno z obsługiwanych zdarzeń elementu webhook, którego chcesz użyć jako zdarzenia elementu webhook. Po utworzeniu elementu webhook nie można zmienić jego zdarzenia.

  6. W menu rozwijanym Format wybierz format, w którym Shopify ma wysyłać Ci te informacje. Dostępne opcje to JSON i XML.

  7. W polu URL wprowadź adres URL, pod którym mają być przechowywane dane. Elementów webhook nie można zwracać na następujące adresy URL:

    • Localhost
    • Dowolny adres URL zakończony słowem „internal” (np. example.com/internal)
    • Dowolny adres URL z dowolnej niestandardowej domeny dołączonej do sklepu
    • „Fałszywe” domeny (np. www.example.com)
    • Domeny Shopify (np. shopify.com i myshopify.com)
  8. W polu Wersja API elementu webhook wybierz preferowaną wersję elementu webhook.

  9. Naciśnij opcję Zapisz lub .

Po zapisaniu nowego elementu webhook zostanie on wyświetlony na stronie Elementy webhook.

Edycja elementów webhook

Konfigurację elementu webhook można edytować po jego utworzeniu. Nie można jednak modyfikować wybranego zdarzenia elementu webhook.

Kroki:

Desktop
  1. W panelu administracyjnym Shopify przejdź do opcji Ustawienia > Powiadomienia.

  2. Kliknij opcję Elementy webhook.

  3. W wierszu zawierającym element webhook, który chcesz edytować, kliknij ... > Edytuj.

  4. W oknie dialogowym Edytuj element webhook zmodyfikuj element webhook zgodnie z potrzebami.

  5. Kliknij opcję Zapisz.

Aplikacja mobilna
  1. W Shopify app naciśnij Menu, a następnie naciśnij Ustawienia Ustawienia.

  2. W sekcji Ustawienia sklepu naciśnij opcję Powiadomienia.

  3. Naciśnij opcję Elementy webhook.

  4. W wierszu zawierającym element webhook, który chcesz edytować, naciśnij ... > Edytuj.

  5. W oknie dialogowym Edytuj element webhook zmodyfikuj element webhook zgodnie z potrzebami.

  6. Naciśnij opcję Zapisz lub .

Testowanie elementów webhook

Możesz przetestować swój element webhook, aby upewnić się, że informacje o zdarzeniu, które chcesz otrzymywać, są wysyłane na prawidłowy adres URL.

Kroki:

Desktop
  1. W panelu administracyjnym Shopify przejdź do opcji Ustawienia > Powiadomienia.

  2. Kliknij opcję Elementy webhook.

  3. W wierszu zawierającym element webhook, który chcesz przetestować, kliknij ... > Wyślij test.

  4. Pod adresem URL określonym dla elementu webhook sprawdź, czy powiadomienie działa.

Aplikacja mobilna
  1. W Shopify app naciśnij Menu, a następnie naciśnij Ustawienia Ustawienia.

  2. W sekcji Ustawienia sklepu naciśnij opcję Powiadomienia.

  3. Naciśnij opcję Elementy webhook.

  4. W wierszu zawierającym element webhook, który chcesz przetestować, naciśnij ... > Wyślij test.

  5. Pod adresem URL określonym dla elementu webhook sprawdź, czy powiadomienie działa.

Usuwanie elementów webhook

Możesz usunąć element webhook z panelu administracyjnego Shopify. Tej czynności nie można cofnąć.

Kroki:

Desktop
  1. W panelu administracyjnym Shopify przejdź do opcji Ustawienia > Powiadomienia.

  2. Kliknij opcję Elementy webhook.

  3. W wierszu zawierającym element webhook, który chcesz usunąć, kliknij ... > Usuń.

Aplikacja mobilna
  1. W Shopify app naciśnij Menu, a następnie naciśnij Ustawienia Ustawienia.

  2. W sekcji Ustawienia sklepu naciśnij opcję Powiadomienia.

  3. Naciśnij opcję Elementy webhook.

  4. W wierszu zawierającym element webhook, który chcesz usunąć, naciśnij ... > Usuń.