Création de webhooks pour Amazon Chime - Amazon Chime
Résolution des erreurs liées au webhook

Vous devez être un administrateur système Amazon Chime pour effectuer les étapes décrites dans ce guide. Si vous avez besoin d'aide concernant le client de bureau, l'application Web ou l'application mobile Amazon Chime, consultez la section Obtenir de l'aide dans le guide de l'utilisateur Amazon Chime.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Création de webhooks pour Amazon Chime

Les webhooks permettent aux applications Web de communiquer entre elles en temps réel. Généralement, les webhooks envoient des notifications lorsqu'une action se produit. Supposons, par exemple, que vous gérez un site d'achat en ligne. Les webhooks peuvent vous avertir lorsqu'un client ajoute des articles à son panier, paie une commande ou envoie un commentaire. Les webhooks ne nécessitent pas autant de programmation que les applications traditionnelles et n'utilisent pas autant de puissance de traitement. Sans webhook, un programme doit rechercher des données fréquemment afin de les obtenir en temps réel. Avec un webhook, l'application d'envoi publie les données immédiatement.

Les webhooks entrants que vous créez peuvent envoyer des messages de manière programmatique aux salons de discussion Amazon Chime. Par exemple, un webhook peut informer une équipe du service client de la création d'un nouveau ticket prioritaire et ajouter un lien vers le ticket dans le salon de discussion.

Les messages de webhooks peuvent être mis en forme avec Markdown et peuvent inclure des émoticônes. Les liens HTTP et les adresses e-mail s'affichent sous forme de liens actifs. Les messages peuvent également inclure les annotations @All et @Present pour alerter respectivement tous les membres et les membres présents d'une salle de conversation. Pour mentionner (@mention) directement un participant d'une salle de conversation, utilisez son alias ou son adresse e-mail complète. Par exemple, @alias ou @alias@domain.com.

Les webhooks peuvent uniquement faire partie d'un salon de discussion et ne peuvent pas être partagés. Les administrateurs de salon de discussion Amazon Chime peuvent ajouter jusqu'à 10 webhooks pour chaque salon de discussion.

Après avoir créé un webhook, vous pouvez l'intégrer à un salon de discussion Amazon Chime, comme indiqué dans la procédure suivante.

Pour intégrer un webhook à un salon de discussion

  1. Obtenez l'URL du webhook auprès de l'administrateur du salon de discussion. Pour plus d'informations, voirAjouter des webhooks à un salon de discussiondans leGuide de l'utilisateur d'Amazon Chime.

  2. Utilisez l'URL du webhook dans le script ou l'application que vous avez créé pour envoyer des messages au salon de discussion :

    1. L'URL accepte une requête HTTP POST.

    2. Les webhooks Amazon Chime acceptent une charge utile JSON à l'aide d'une seule cléContenu. Voici un exemple de commande curl avec un exemple de charge utile :

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

      Ce qui suit est un exemplePowerShellcommande pour les utilisateurs de 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"}'

Lorsque le programme externe envoie la requête HTTP POST à l'URL de webhook, le serveur vérifie que le webhook est valide et qu'une salle de conversation lui est attribuée. Le webhook s'affiche dans la liste de la salle de conversation avec une icône de webhook en regard de son nom. Les messages de la salle de conversation envoyés par le webhook apparaissent dans la salle de conversation sous le nom du webhook suivi de (Webhook).

Note

CORS n'est actuellement pas activé pour les webhooks.

Résolution des erreurs liées au webhook

voici une liste d'erreurs liées aux webhooks :

  • La limite de fréquence de webhook entrant par webhook est de 1 TPS par salle de conversation. La limitation entraîne une erreur HTTP 429.

  • La taille des messages publiés par un webhook doit être inférieure ou égale à 4 Ko. Une charge utile de message plus importante génère une erreur HTTP 413.

  • Les messages publiés par un webhook avec des annotations @All et @Present fonctionnent uniquement pour les salles de conversation avec 50 membres maximum. S'il existe plus de 50 membres, une erreur HTTP 400 est générée.

  • Si l'URL de webhook est régénérée, l'utilisation de l'ancienne URL génère une erreur HTTP 404.

  • Si l'URL de webhook est supprimée, l'utilisation de l'ancienne URL génère une erreur HTTP 404.

  • Des URL de webhook non valides génèrent des erreurs HTTP 403.

  • Si le service n'est pas disponible, l'utilisateur reçoit une erreur HTTP 503 dans la réponse.