Jak połączyć Sentry zShopify Flow

Jak połączyć Sentry zShopify Flow

Skopiuj stronę

Połącz Sentry z Shopify Flow za pomocą Workflow Webhooks: zweryfikowane podpisy HMAC, wraz z instrukcją konfiguracji krok po kroku.

Sentry może powiadomić integrację o utworzeniu zgłoszenia, jego przypisaniu, rozwiązaniu lub uruchomieniu alertu. Funkcja Workflow Webhooks przekształca to wywołanie w wyzwalacz Shopify Flow, dzięki czemu Państwa sklep może na nie zareagować: oznaczyć klienta, dodać notatkę do zamówienia, wysłać wewnętrzną wiadomość e-mail, zaktualizować metapole - czyli wykonać każdą czynność, do której umożliwia Shopify Flow.

Niniejszy przewodnik opisuje cały proces - Sentry wysyła dane, usługa Workflow Webhooks je odbiera i weryfikuje, a Shopify Flow podejmuje odpowiednie działania - przy czym w każdym żądaniu sprawdzany jest podpis HMAC serwisu Sentry, dzięki czemu wyłącznie Sentry może uruchomić Państwa przepływ pracy.

Co można zbudować

  • W przypadku gwałtownego wzrostu liczby błędów przy kasie prosimy o wysłanie wiadomości e-mail do osoby dyżurnej wraz z informacjami dotyczącymi danego sklepu.
  • Proszę zapisać datę ostatniego zdarzenia w polu meta sklepu, do którego ma dostęp Państwa motyw.
  • Uruchom proces w Shopify Flow, który wstrzymuje promocję w przypadku pojawienia się alertu krytycznego.

Typowe zdarzenia, które należy zgłaszać: utworzenie zgłoszenia, uruchomienie reguły ostrzegawczej, zamknięcie zgłoszenia.

Zanim zaczną Państwo

  • Webhooki Workflow Webhooks zainstalowane w Państwa sklepie Shopify.
  • Zainstalowano aplikację Shopify Flow, którą można pobrać bezpłatnie ze sklepu Shopify App Store.
  • Konto w serwisie Sentry z uprawnieniem do tworzenia webhooków.

Krok 1 - Utwórz webhook w sekcji Workflow Webhooks

  1. Proszę otworzyć sekcję Workflow Webhooks → Webhooks → Utwórz webhook i nadać mu nazwę, którą będą Państwo w stanie rozpoznać w Shopify Flow, na przykład Sentry events.
  2. W sekcji Uwierzytelnianie proszę wybrać opcję HMAC.
  3. W sekcji Dostawca podpisu proszę wybrać opcję Sentry. Aplikacja automatycznie wypełni pola dotyczące nagłówka, algorytmu, podpisanej treści oraz okna powtórki - nie ma potrzeby dokonywania żadnych dodatkowych ustawień.
  4. Na razie proszę pozostawić pole „secret” puste i kliknąć Zapisz. Proszę skopiować adres URL webhooka wyświetlony na stronie.

Informacje na temat pozostałych trybów uwierzytelniania można znaleźć w sekcji Uwierzytelnianie, a informacje dotyczące wyboru pól, które mają zostać przesłane do Shopify Flow - w sekcji Mapowanie danych użytkowych i zmienne w Shopify Flow.

Krok 2 - Proszę dodać punkt końcowy w Sentry

W serwisie Sentry proszę otworzyć aplikację Integration Platform, ustawić adres URL webhooka na skopiowany adres, włączyć wybrane zdarzenia oraz skopiować klucz tajny klienta.

Jak znaleźć swój sekret podpisowy w usłudze Sentry

Klucz tajny klienta dla Państwa integracji z Sentry.

Własna dokumentacja serwisu Sentry dotycząca podpisów webhooków zawiera dokładne sformułowania oraz zrzuty ekranu dotyczące Państwa konta.

Wklej ten klucz tajny w polu Secret webhooka w sekcji Workflow Webhooks i zapisz. Od tego momentu każda wiadomość z serwisu Sentry będzie weryfikowana, zanim dotrze do Shopify Flow.

Co to sprawdza

Co Wartość
Nagłówek podpisu Sentry-Hook-Signature
Miejsce umieszczenia podpisu Cała wartość nagłówka
Co zostało podpisane {body}
Podpis HMAC-SHA256, zakodowany w systemie szesnastkowym
Sygnatura czasowa Nie jest używane przez tego nadawcę
Ochrona przed ponownym odtworzeniem Brak - ten nadawca nie podpisuje znacznika czasu, więc każdy ważny podpis zachowuje swoją ważność
Sekret Należy użyć jako zwykły tekst. Proszę wkleić go dokładnie tak, jak przedstawił go nadawca

W podpisanej treści żądania {body} stanowi surową treść żądania, bajt po bajcie.

Żądanie, które nie spełnia któregokolwiek z tych warunków, jest odrzucane z kodem błędu 401, rejestrowane w sekcji Historia i rozwiązywanie problemów i nigdy nie uruchamia przepływu pracy.

Krok 3 - Utwórz proces w Shopify Flow

  1. W Shopify Flow proszę utworzyć przepływ pracy i wybrać wyzwalacz Workflow Webhooks.
  2. Proszę kliknąć opcję Rejestruj zdarzenia, a następnie wysłać zdarzenie testowe z serwisu Sentry (lub skorzystać z opcji Wyślij test w sekcji Workflow Webhooks), aby Shopify Flow rozpoznał strukturę Państwa danych.
  3. Każdy posiadany przez Państwa webhook uruchamia ten sam wyzwalacz w Shopify Flow, dlatego proszę dodać pierwszy warunek oparty na identyfikatorze webhooka, aby ten przepływ pracy dotyczył wyłącznie serwisu Sentry. Identyfikator ten jest widoczny na stronie webhooka.
  4. Proszę dodać swoje działania - oznaczyć klienta, dodać notatkę, wysłać wewnętrzną wiadomość e-mail, zaktualizować metapole.
Shopify Flow
W Shopify Flow wybierz opcję „Wybierz wyzwalacz”, otwórz sekcję Workflow Webhooks i wybierz opcję „Wyzwalacz webhook”.
Warunek w Shopify Flow: identyfikator webhooka jest równy identyfikatorowi jednego z webhooków
Pierwszy krok każdego przepływu pracy: warunek dotyczący identyfikatora webhooka, dzięki czemu przepływ pracy uruchamia się wyłącznie dla tego webhooka.
Gotowy przebieg procesu: wyzwalacz webhooka, warunek oparty na identyfikatorze webhooka, a następnie wysłanie wewnętrznej wiadomości e-mail w gałęzi „True”
Gotowy przepływ pracy: wyzwalacz, warunek oparty na identyfikatorze webhooka, a następnie Państwa działanie w gałęzi „True”.

Krok 4 - Przeprowadź test od początku do końca

Wywołaj rzeczywiste zdarzenie w Sentry. W sekcji Workflow Webhooks → Historia powinno być widoczne wywołanie o statusie Success. Jeśli podpis był nieprawidłowy, pojawi się zamiast tego wpis o niepowodzeniu wraz z przyczyną, a Weryfikacja podpisanych webhooków zawiera opis narzędzia do weryfikacji podpisu, które wskazuje dokładnie, który etap zakończył się niepowodzeniem.

Jedno wywołanie otwarte w sekcji „Historia” wraz z nagłówkami żądania, treścią, statusem, czasem trwania i identyfikatorami
Zrealizowane zdarzenie w module „Historia”: status „Powodzenie” oznacza, że Shopify Flow je zaakceptowało.
Podpis nie jest zgodny

W następującej kolejności: klucz tajny (najczęstsza przyczyna - dodatkowa spacja lub klucz z niewłaściwego środowiska), czy nadawca korzysta z klucza tajnego innego punktu końcowego oraz czy coś pomiędzy Sentry a aplikacją zmienia treść wiadomości. Podpisy obejmują surowe bajty, więc serwer proxy, który zmienia format JSON, powoduje ich uszkodzenie. Narzędzie do sprawdzania podpisów na stronie webhooka wyświetla dokładny tekst, który został podpisany.

Przy każdym żądaniu otrzymuję kod błędu 401

Proszę sprawdzić, czy w ustawieniach uwierzytelniania webhooka wybrano opcję HMAC z dostawcą Sentry, czy wprowadzono klucz tajny oraz czy Sentry wysyła dane na adres URL dokładnie taki, jak pokazano w aplikacji, łącznie z kodem na końcu.

W historii nie ma żadnych wpisów

Żądanie nigdy nie dotarło. Proszę ponownie sprawdzić adres URL w Sentry oraz przejrzeć własny dziennik dostarczania Sentry w celu uzyskania informacji o otrzymanej odpowiedzi. Kod 404 oznacza nieprawidłowy lub usunięty webhook, a kod 429 oznacza przekroczenie limitu wywołań przewidzianego w Państwa planie - zobacz Plany i sposób użytkowania.

Proces jest uruchamiany dla niewłaściwych zdarzeń

Każdy webhook w Państwa sklepie uruchamia ten sam wyzwalacz w Shopify Flow. Proszę dodać warunek oparty na identyfikatorze webhooka jako pierwszy krok przepływu pracy lub zawęzić zakres zdarzeń wysyłanych z Sentry.

Powiązane