Webhooks de App Center

Aperçu

Les webhooks constituent un moyen simple de notifier les applications tierces lorsqu’un événement spécifié s’est produit. L’objectif principal des webhooks est de communiquer des informations importantes d’App Center aux utilisateurs plutôt que d’avoir des utilisateurs à venir sur le portail, ou d’exécuter des appels d’API pour être avertis lorsque certains événements se produisent.

Les webhooks d’App Center permettent aux utilisateurs d’envoyer des notifications automatiques aux applications connectées pour les événements suivants :

• Accidents : lorsqu'un groupe de blocages est créé
• Distribuer : lorsqu’une nouvelle version est publiée dans un groupe de distribution

  Remarque

  Pour Distribuer, le webhook est déclenché lorsqu’une nouvelle version est publiée sur un groupe de distribution. Si vous avez vérifié ne pas avertir les testeurs à l’étape de révision de la création d’une nouvelle version, le webhook ne se déclenche pas. Pour Diagnostics, le webhook est déclenché pour les nouveaux groupes d’erreurs avec des symboles fournis. Si aucun symbole n’est trouvé pour le nouveau groupe d’erreurs, le webhook ne se déclenche pas.

App Center envoie une charge utile HTTP POST à l’URL spécifiée du webhook. Les webhooks sont configurés au niveau de l’application sous la page Paramètres de votre application spécifiée. Les utilisateurs doivent disposer d’autorisations de gestionnaire ou de développeur dans l’application pour créer et configurer les webhooks. Actuellement, nous prenons uniquement en charge les webhooks pour Slack et Microsoft Teams. Pour publier sur d’autres plateformes, vous pouvez écrire une fonction Azure qui traduit la façon dont nous POST pouvons répondre aux exigences de la plateforme.

Pour commencer

1. Accédez à App Center, puis sélectionnez l’application spécifique souhaitée pour l’intégration des webhooks.

2. Dans votre application, dans le volet de gauche, sélectionnez Paramètres

3. Dans le panneau de lignes intitulé Webhooks, accédez au coin droit et cliquez sur l’icône de crayon, ce qui affiche le panneau Webhooks .

   

4. Dans le coin supérieur droit, cliquez sur le bouton bleu nouveau webhook et entrez :

   • Nom de webhook

   • URL de webhook

     Vous pouvez obtenir l’URL du webhook à partir des paramètres de votre application intégrée (par exemple, voici des détails sur la façon d’obtenir l’URL du webhook à partir de Microsoft Teams et comment obtenir l’URL du webhook à partir de Slack).

     Cochez la case pour les notifications de Plantages et de Distribution afin de décider quels événements activeront les alertes de webhook.

     

5. Vous avez terminé. Votre webhook est maintenant créé et activé. Vous pouvez créer plusieurs webhooks en répétant l’étape 4.

6. Basculez vers la main extrême droite du webhook pour tester, désactiver ou supprimer le webhook.

   • test envoie une alerte de test à votre application connectée.
   • disable conserve le webhook inactif, mais présent dans votre tableau de bord.
   • supprimera le webhook de votre tableau de bord.

Lorsque ces événements se produisent, les notifications App Center sont publiées dans vos applications intégrées.

Exemple de charge utile de webhook

Voici quelques exemples de la charge utile du webhook JSON pour :

1. Krach

{
  "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. Distribuer

{
  "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"
}

Vous pouvez également inspecter la charge utile à l’aide de RequestBin. Pour ce faire, accédez à RequestBin, cliquez sur Créer une requêteBin, puis copiez l’URL générée sous l’URL bin et collez l’URL en tant que webhook dans App Center.

Prise en charge personnalisée du webhook

Pour publier sur d’autres plateformes, vous pouvez écrire une fonction Azure qui traduit la façon dont nous POST pouvons répondre aux exigences de la plateforme. Pour ce faire, créez une fonction Azure, collez l’URL sous le champ URL du Webhook à l’étape 4, et App Center publiera la charge utile du webhook sur ce point de terminaison. Vous pouvez ensuite modifier la charge utile selon les exigences de la plateforme.