Elementy webhook centrum aplikacji

Przegląd

Elementy webhook to prosty sposób powiadamiania aplikacji innych firm o wystąpieniu określonego zdarzenia. Głównym celem elementów webhook jest przekazywanie ważnych informacji z Centrum aplikacji do użytkowników, a nie uzyskiwanie użytkownikom informacji do portalu lub uruchamianie wywołań interfejsu API w celu powiadomienia o wystąpieniu niektórych zdarzeń.

Elementy webhook usługi App Center umożliwiają użytkownikom wysyłanie automatycznych powiadomień do połączonych aplikacji pod kątem następujących zdarzeń:

• Awarie: w momencie utworzenia grupy awarii
• Dystrybucja: gdy nowa wersja zostanie wydana do grupy dystrybucyjnej

  Uwaga / Notatka

  W przypadku dystrybucji webhook zostanie wyzwolony, gdy nowa wersja zostanie wydana do grupy dystrybucyjnej. Jeśli zaznaczono pole Nie powiadamiaj testerów na etapie Przegląd tworzenia nowej wersji, webhook nie zostanie wyzwolony. W przypadku diagnostyki webhook zostanie uruchomiony dla nowych grup błędów z podanymi symbolami. Jeśli dla nowej grupy błędów nie zostaną znalezione żadne symbole, webhook nie zostanie uruchomiony.

Usługa App Center wyśle ładunek HTTP POST do określonego adresu URL elementu webhook. Elementy webhook są konfigurowane na poziomie aplikacji na stronie Ustawienia określonej aplikacji. Aby utworzyć i skonfigurować elementy webhook, użytkownicy muszą mieć uprawnienia menedżera lub dewelopera w aplikacji. Obecnie obsługujemy tylko elementy webhook dla usług Slack i Microsoft Teams. Aby opublikować dane na innych platformach, możesz napisać funkcję Azure, która dostosowuje sposób POST do wymagań platformy.

Wprowadzenie

1. Przejdź do centrum aplikacji i wybierz konkretną aplikację, którą chcesz zintegrować z elementami webhook.

2. W aplikacji w panelu po lewej stronie wybierz pozycję Ustawienia

3. W panelu wiersza zatytułowanym Webhooks przejdź do prawego górnego rogu i kliknij ikonę ołówka, co spowoduje otwarcie panelu Webhooks.

   

4. W prawym górnym rogu kliknij przycisk Nowy webhook niebieski i wprowadź:

   • Nazwa elementu webhook

   • Webhook URL

     Adres URL elementu webhook można uzyskać z ustawień zintegrowanej aplikacji (na przykład poniżej przedstawiono szczegółowe informacje na temat uzyskiwania adresu URL elementu webhook z usługi Microsoft Teams i uzyskiwania adresu URL elementu webhook z usługi Slack).

     Zaznacz pole wyboru dla opcji Awarie i dystrybuowania powiadomień, aby zdecydować, które zdarzenia będą wyzwalać alerty webhook.

     

5. Ukończono! Twój webhook został utworzony i włączony. Możesz utworzyć wiele elementów webhook, powtarzając krok 4.

6. Przełącz się do skrajnej prawej strony elementu webhook, aby przetestować, wyłączyć lub usunąć element webhook.

   • test wyśle alert testowy do połączonej aplikacji.
   • Wybranie opcji disable powoduje, że element webhook jest nieaktywny, ale obecny na pulpicie nawigacyjnym.
   • Usunięcie webhooka spowoduje jego usunięcie z pulpitu nawigacyjnego.

Po wystąpieniu tych zdarzeń powiadomienia centrum aplikacji są publikowane w zintegrowanych aplikacjach.

Przykładowy ładunek elementu webhook

Oto przykłady zawartości webhook JSON dla:

1. Wypadek

{
  "id":"3698593379u",
  "name":"android.app.Activity.performResume (Activity.java:5084)",
  "reason":"android.app.SuperNotCalledException",
  "url":"https://appcenter.ms/orgs/{org-id}/apps/{app-name}/crashes/errors/3698273379u",
  "app_display_name":"{app-name}",
  "app_platform":"Java",
  "app_version":"2.0.1(42)",
  "stack_trace":[],
  "affected_users":0,
  "crash_count":0,
  "sent_at":"2019-05-16T23:47:31.4881512Z",
  "app_id":"00001111-aaaa-2222-bbbb-3333cccc4444"
}

2. Rozdziel

{
  "app_name":"{app-name}",
  "app_display_name":"{app-display-name}",
  "release_id":"123",
  "platform":"Android",
  "uploaded_at":"2018-07-17T20:46:14Z",
  "fingerprint":"0abed1269e4ae3bf524e4cc7165f4f34",
  "release_notes":"",
  "version":"74",
  "short_version":"1.7.0",
  "min_os":"4.0.3",
  "mandatory_update":true,
  "size":2634279,
  "provisioning_profile_name":null,
  "provisioning_profile_type":null,
  "bundle_identifier":"com.microsoft.appcenter.test",
  "install_link":"https://install.appcenter.ms/orgs/{org-name}/apps/{app-name}/releases/123?source=email",
  "icon_link":"https://appcenter-filemanagement-distrib4ede6f06e.azureedge.net/f7794e4c-42f1-4e7c-8013-07ed2e1b733d/ic_launcher.png?sv=2020-02-18&sr=c&sig=gs4JfcWjpKeYH%2F%2Fg0jEtSKKbeRkug9q%2FldslmzzeOg0%3D&se=2020-02-26T08%3A57%3A58Z&sp=r",
  "distribution_group_id":"1a5a0605-4b9c-4de2-9a35-t569456df0cc",
  "installable":true,
  "sent_at":"2019-05-16T23:20:08.7799314Z",
  "app_id":"11112222-bbbb-3333-cccc-4444dddd5555"
}

Możesz również sprawdzić ładunek przy użyciu metody RequestBin. W tym celu przejdź do RequestBin, kliknij Utwórz RequestBin, a następnie skopiuj wygenerowany adres URL w obszarze Adres URL pojemnika i wklej adres URL jako element webhook w Centrum Aplikacji.

Obsługa niestandardowego webhooku

Aby opublikować dane na innych platformach, możesz napisać funkcję Azure, która dostosowuje sposób, w jaki POST, aby spełnić wymagania platformy. W tym celu utwórz funkcję platformy Azure, wklej adres URL w polu Adres URL elementu webhook w kroku 4, a App Center prześle ładunek elementu webhook do tego punktu końcowego. Następnie można zmodyfikować ładunek zgodnie z wymaganiami platformy.