Jak połączyć Linear zShopify Flow

Linear wysyła webhook w przypadku zmian dotyczących zgłoszeń, projektów lub komentarzy w Państwa obszarze roboczym. 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ć adnotację do zamówienia, wysłać wewnętrzną wiadomość e-mail, zaktualizować metapole - czyli wykonać każdą czynność, do której zdolny jest Shopify Flow.

Niniejszy przewodnik opisuje cały proces - Linear 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 Linear, dzięki czemu wyłącznie Linear może uruchomić Państwa przepływ pracy.

Co można zbudować

• Proszę wysłać wiadomość e-mail do zespołu ds. merchandisingu, gdy zgłoszenie oznaczone tagiem storefront osiągnie status „Zakończone”.
• Proszę wpisać numer bieżącego sprintu lub wydania w polu metadanych sklepu.
• Po zamknięciu zgłoszenia dotyczącego wprowadzenia produktu na rynek należy uruchomić proces oparty na liście kontrolnej dla sklepu.

Typowe zdarzenia, które należy przesłać: utworzenie zgłoszenia lub zmiana jego statusu, dodanie komentarza, opublikowanie aktualizacji projektu.

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 Linear z uprawnieniami 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 Linear events.
2. W sekcji Uwierzytelnianie proszę wybrać opcję HMAC.
3. W sekcji Dostawca podpisu proszę wybrać opcję Linear. Aplikacja automatycznie wypełni pola dotyczące nagłówka, algorytmu, podpisanej treści oraz okna powtórki - nie ma potrzeby konfigurowania żadnych innych 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 - Dodanie punktu końcowego w systemie Linear

W serwisie Linear proszę otworzyć sekcję Ustawienia → API → Webhooki, utworzyć webhook przy użyciu skopiowanego adresu URL, a następnie skopiować wyświetlony tam klucz podpisu.

Jak znaleźć swój sekret podpisywania Linear

Sekret podpisu wyświetlany w webhooku w serwisie Linear (Ustawienia -> API -> Webhooki).

Własna dokumentacja firmy Linear 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 (Klucz tajny) webhooka w sekcji Workflow Webhooks i zapisz. Od tego momentu każda dostawa w usłudze Linear będzie weryfikowana, zanim trafi do Shopify Flow.

Co to sprawdza

Co	Wartość
Nagłówek podpisu	Linear-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 Linear (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 platformy Linear. 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.

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

Wywołaj rzeczywiste zdarzenie w systemie Linear. W sekcji Workflow Webhooks → Historia powinno pojawić się 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 wyjaśnienie dotyczące narzędzia do weryfikacji podpisu, które wskazuje dokładnie, który etap zakończył się niepowodzeniem.

Powiązane

• Weryfikacja podpisanych webhooków - każdy dostawca, którego weryfikujemy, oraz sposób opisania dostawcy, którego nie weryfikujemy.
• Mapowanie danych użytkowych i zmienne w Shopify Flow - pobieranie odpowiednich pól z danych przesyłanych i wprowadzanie ich do Shopify Flow.
• Ochrona przed podwójną dostawą - co się dzieje, gdy firma Linear ponawia próbę dostawy.
• Historia i rozwiązywanie problemów - dziennik wszystkich żądań wraz z możliwością odtworzenia.