Criar Webhooks de entrada

Artigo
04/16/2023

Um Webhook de Entrada permite que aplicativos externos compartilhem conteúdos nos canais do Microsoft Teams. Os webhooks são usados como ferramentas para rastrear e notificar. Os webhooks fornecem uma URL exclusiva para enviar uma carga JSON com uma mensagem no formato de cartão. Os cartões são contêineres de interface do usuário que incluem conteúdo e ações relacionadas a um único artigo. Você pode usar os cartões nos seguintes recursos:

Bots
Extensões de mensagens
Conectores

Importante

Você pode optar por criar um aplicativo de bot de notificação do Teams que não seja Webhooks de entrada. Eles funcionam da mesma forma, mas o bot de notificação tem mais funcionalidades. Para obter mais informações, consulte Criar bot de notificação com JavaScript ou exemplo de notificação do Webhook de entrada. Para começar, baixe e explore o Teams Toolkit. Para obter mais informações, consulte Documentos do Teams Toolkit.

Observação

O limite de tamanho da mensagem é de 28 KB. Quando o tamanho excede 28 KB, você recebe um erro. Para obter mais informações, consulte Limites e especificações para o Microsoft Teams.
Se mais de quatro solicitações forem feitas em um segundo, a conexão do cliente será limitada até que a janela seja atualizada durante a taxa fixa. Uma lógica de repetição com backoff exponencial pode reduzir a limitação de taxa para casos em que as solicitações excedem os limites em um segundo. Para evitar atingir os limites de taxa, consulte respostas HTTP 429.

Confira o vídeo a seguir para saber como criar Webhooks de entrada:

Principais recursos do Webhooks de entrada

A tabela a seguir fornece os recursos e a descrição de um Webhook de Entrada:

Recursos	Descrição
Envie cartões adaptáveis usando um Webhook de Entrada	Cartões Adaptáveis pode ser enviado por meio de Webhooks de Entrada. Para obter mais informações, consulte Enviar Cartões Adaptáveis usando Webhooks de Entrada.
Suporte a mensagens acionáveis	Cartões de mensagem acionáveis têm suporte em todos os grupos do Microsoft 365, incluindo o Teams. Se você enviar mensagens por meio de cartões, deverá usar o formato de cartão de mensagem acionável. Para obter mais informações, consulte Mensagem acionável herdada cartão referência e mensagem cartão playground.
Suporte independente a mensagens HTTPS	Os cartões fornecem informações de forma clara e consistente. Qualquer ferramenta ou estrutura que possa enviar solicitações HTTPS POST pode enviar mensagens para o Teams por meio de um Webhook de Entrada.
Markdown compatível	Todos os campos de texto em cartões de mensagens acionáveis suportam Markdown básico. Não use a marcação HTML em seus cartões. O HTML será ignorado e tratado como texto sem formatação.
Configuração com escopo	O Webhook de Entrada tem escopo e está configurado no nível do canal.
Definições de recursos seguros	As mensagens são formatadas como cargas JSON. Essa estrutura declarativa de mensagens impede a inserção de código mal-intencionado.

Observação

Bots do Teams, extensões de mensagens, Webhook de entrada e Bot Framework suporte a Cartões Adaptáveis. O Cartão Adaptável é uma estrutura de plataforma de cartão aberta que é usada em todas as plataformas, como Windows, Android, iOS e assim por diante. Atualmente, os Conectores Teams não suportam os Cartões Adaptáveis. No entando, é impossível criar um fluxo que publicam Cartões Adaptáveis para um canal Teams.
Para mais informações sobre cartões e webhooks, veja Cartões Adaptáveis e Webhooks de Entrada.

Criar Webhooks de entrada

Para adicionar um Webhook de Entrada a um canal do Teams, siga as seguintes etapas:

Abra o canal no qual você deseja adicionar o webhook e selecione ••• no canto superior direito.
Selecione Conectores de um menu suspenso.
Pesquise para Webhook de Entrada e selecione Adicionar.
Selecione Configurar, forneça um nome e carregue uma imagem para o webhook, se necessário.
Copie e salve a URL de webhook exclusiva presente na caixa de diálogo. A URL mapeia o canal e você pode usá-la para enviar informações ao Teams.
Selecione Concluído.

O webhook agora está disponível no canal do Teams.

Você pode criar e enviar mensagens acionáveis por meio do Webhook ou do conector de entrada para Grupos do Microsoft 365. Para obter mais informações, veja Criar e enviar mensagens.

Observação

No Teams, selecione Definições>Permitir aos membros> criar, atualizar, e remover conectores, para que qualquer membro da equipe possa adicionar, modificar ou excluir um conector.

Exemplo

C#
JavaScript

Referência de código de exemplo

var adaptiveCardJson = @"{
  ""type"": ""message"",
  ""attachments"": [
    {
      ""contentType"": ""application/vnd.microsoft.card.adaptive"",
      ""content"": {
        ""type"": ""AdaptiveCard"",
        ""body"": [
          {
            ""type"": ""TextBlock"",
            ""text"": ""Message Text""
          }
        ],
        ""$schema"": ""http://adaptivecards.io/schemas/adaptive-card.json"",
        ""version"": ""1.0""
      }
    }
  ]
}";

var webhookUrl = "https://xxxxx.webhook.office.com/xxxxxxxxx";

var client = new HttpClient();
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

var content = new StringContent(adaptiveCardJson, System.Text.Encoding.UTF8, "application/json");
var response = await client.PostAsync(webhookUrl, content);

Referência de código de exemplo

 axios.post({{WebhookUrl}}, {{formatted_Card_Payload}})
    .then(res => {
        console.log(`statusCode: ${res.status}`)
        console.log(res)
    })
    .catch(error => {
        console.error(error)
    })