Criação de webhooks para o Amazon Chime - Amazon Chime
Solucionar de problemas de erros de webhook

Você deve ser administrador do sistema Amazon Chime para concluir as etapas deste guia. Se você precisar de ajuda com o cliente de desktop, a aplicação web ou aplicativo móvel do Amazon Chime, consulte Getting support no Guia do usuário do Amazon Chime.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Criação de webhooks para o Amazon Chime

Os webhooks permitem que aplicativos da web se comuniquem entre si em tempo real. Normalmente, os webhooks enviam notificações quando ocorre uma ação. Por exemplo, digamos que você administra um site de compras on-line. Os webhooks podem notificá-lo quando um cliente adiciona itens a um carrinho de compras, paga por um pedido ou envia um comentário. Os webhooks não precisam de tanta programação quanto os aplicativos tradicionais e não usam tanto poder de processamento. Sem um webhook, um programa precisa pesquisar dados com frequência para obtê-los em tempo real. Com um webhook, o aplicativo de envio publica os dados imediatamente.

Os webhooks de entrada que você cria podem enviar mensagens de forma programática a salas de bate-papo do Amazon Chime. Por exemplo, um webhook pode notificar uma equipe de atendimento ao cliente sobre a criação de um novo tíquete de alta prioridade e adicionar um link ao tíquete na sala de bate-papo.

As mensagens do Webhooks podem ser formatadas com markdown e podem incluir emojis. Links HTTP e endereços de e-mail são renderizados como links ativos. As mensagens também podem incluir anotações @All e @Present para alertar todos os membros e apresentar os membros de uma sala de bate-papo, respectivamente. Para @mencionar diretamente um participante da sala de bate-papo, use seu alias ou endereço de e-mail completo. Por exemplo, @alias, ou @alias@domain.com.

Os webhooks só podem fazer parte de uma sala de bate-papo e não podem ser compartilhados. Os administradores da sala de bate-papo do Amazon Chime podem adicionar até 10 webhooks para cada sala de bate-papo.

Depois de criar um webhook, você poderá integrá-lo a uma sala de bate-papo do Amazon Chime, conforme mostrado no procedimento a seguir.

Para integrar um webhook a uma sala de bate-papo

  1. Obtenha o URL do webhook com o administrador da sala de bate-papo. Para obter mais informações, consulte Adicionar webhooks a uma sala de bate-papo no Guia do usuário do Amazon Chime.

  2. Use o URL do webhook no script ou aplicativo que você criou para enviar mensagens para a sala de bate-papo:

    1. O URL aceita uma solicitação HTTP POST.

    2. Os webhooks do Amazon Chime aceitam uma carga útil JSON com uma única chave Content. Veja a seguir um comando curl de amostra com uma carga útil de amostra:

      curl -X POST "<Insert your webhook URL here>" -H "Content-Type:application/json" --data '{"Content":"Message Body emoji test: :) :+1: link test: http://sample.com email test: marymajor@example.com All member callout: @All All Present member callout: @Present"}'

      Veja a seguir um exemplo de comando do PowerShell para usuários do Windows:

      Invoke-WebRequest -Uri '<Insert your webhook URL here>' -Method 'Post' -ContentType 'application/JSON' -Body '{"Content":"Message Body emoji test: :) :+1: link test: http://sample.com email test: marymajor@example.com All member callout: @All All Present member callout: @Present"}'

Depois que o programa externo envia o HTTP POST para a URL do webhook, o servidor verifica se o webhook é válido e se há uma sala de bate-papo atribuída a ele. O webhook é exibido na lista de salas de bate-papo com um ícone de webhook ao lado do nome. As mensagens da sala de bate-papo enviadas pelo webhook são exibidas na sala de bate-papo com o nome do webhook seguido por (Webhook).

nota

O CORS não está habilitado atualmente para webhooks.

Solucionar de problemas de erros de webhook

A seguir, uma lista de erros relacionados a webhooks:

  • O limite de taxa do webhook recebido para cada um deles é de 1 TPS por sala de bate-papo. O controle de utilização resulta em um erro HTTP 429.

  • As mensagens postadas por um webhook devem ter 4 KB ou menos. Um payload de mensagem maior resulta em um erro HTTP 413.

  • As mensagens publicadas por um webhook com anotações @Todas e @Presentes funcionam somente em salas de bate-papo com 50 membros ou menos. Mais de 50 membros resultará em um erro HTTP 400.

  • Se o URL do webhook for gerado novamente, o uso do URL antigo resultará em um erro HTTP 404.

  • Se o webhook em uma sala for excluído, o uso do URL antigo resultará em um erro HTTP 404.

  • Os URLs de webhook inválidos resultam em erros HTTP 403.

  • Se o serviço estiver indisponível, o usuário receberá um erro HTTP 503 na resposta.