App Center Webhooks

Visão geral

Webhooks são uma maneira simples de notificar aplicativos de terceiros quando um evento especificado ocorreu. O principal objetivo dos webhooks é comunicar informações importantes do App Center aos usuários, em vez de fazer com que os usuários acessem o portal ou executem chamadas de API para serem notificados quando determinados eventos acontecem.

Os webhooks do App Center permitem que os usuários enviem notificações automáticas para aplicativos conectados para os seguintes eventos:

• Falhas: quando um grupo de falhas é criado
• Distribuir: quando uma nova versão é lançada para um grupo de distribuição

  Observação

  Para Distribute, o webhook será acionado quando uma nova versão for lançada para um grupo de distribuição. Se você marcou não notificar os testadores na etapa Revisão da criação de uma nova versão, o webhook não será acionado. Para Diagnósticos, o webhook será acionado para novos grupos de erros com símbolos fornecidos. Se nenhum símbolo for encontrado para o novo grupo de erros, o webhook não será acionado.

O App Center enviará uma carga HTTP POST para a URL especificada do webhook. Webhooks são configurados no nível do aplicativo na página Configurações do seu aplicativo especificado. Os usuários devem ter permissões de gerente ou desenvolvedor no aplicativo para criar e configurar os webhooks. Atualmente, suportamos apenas webhooks para Slack e Microsoft Teams. Para postar em outras plataformas, você pode escrever uma função do Azure que traduza a maneira como nos ajustamos POST aos requisitos da plataforma.

Primeiros passos

1. Navegue até o App Center e selecione o aplicativo específico que deseja para integração de webhooks.

2. Na sua aplicação, no painel mais à esquerda, selecione Definições

3. No painel de linha intitulado Webhooks, vá para o canto direito e clique no ícone de lápis, que exibe o painel Webhooks .

   

4. No canto superior direito, clique no botão azul Novo Webhook e digite:

   • Nome do Webhook

   • Webhook URL

     Você pode obter a URL do webhook nas configurações do seu aplicativo integrado (por exemplo, aqui estão detalhes sobre como obter a URL do webhook do Microsoft Teams e como obter a URL do webhook do Slack).

     Selecione a caixa de seleção para Falhas e Notificações de Distribuição para decidir quais eventos acionarão os alertas de webhook.

     

5. Feito! Seu webhook agora está criado e habilitado. Você pode criar vários webhooks repetindo a etapa 4.

6. Alterne para o canto superior direito do webhook para testar, desativar ou apagar o webhook.

   • O teste enviará um alerta de teste para seu aplicativo conectado.
   • Desativar mantém o webhook inativo, mas presente no seu painel.
   • Excluir removerá o webhook do seu painel.

Quando esses eventos acontecem, as notificações do App Center são publicadas em seus aplicativos integrados.

Exemplo de carga útil webhook

Aqui estão exemplos da carga útil do webhook JSON para:

1. Colisão

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

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

Você também pode inspecionar a carga útil usando RequestBin. Para fazer isso, navegue até RequestBin, clique em Criar um RequestBin e, em seguida, copie o URL gerado em Bin URL e cole o URL como um webhook no App Center.

Suporte a webhook personalizado

Para postar em outras plataformas, você pode escrever uma função do Azure que traduza a maneira como nos ajustamos POST aos requisitos da plataforma. Para fazer isso, crie uma função do Azure, cole a URL no campo URL do Webhook na etapa 4 e o App Center publicará a carga do webhook nesse ponto de extremidade. Você pode então modificar a carga útil de acordo com os requisitos da plataforma.