Webhooks für Amazon Chime erstellen - Amazon Chime

Sie müssen ein Amazon Chime Chime-Systemadministrator sein, um die Schritte in diesem Handbuch ausführen zu können. Wenn Sie Hilfe mit dem Amazon Chime Chime-Desktop-Client, der Web-App oder der mobilen App benötigen, finden Sie weitere Informationen unter Support erhalten im Amazon Chime Chime-Benutzerhandbuch.

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Webhooks für Amazon Chime erstellen

Webhooks ermöglichen es Webanwendungen, in Echtzeit miteinander zu kommunizieren. Normalerweise senden Webhooks Benachrichtigungen, wenn eine Aktion stattfindet. Angenommen, Sie betreiben eine Online-Shopping-Website. Webhooks können Sie benachrichtigen, wenn ein Kunde Artikel in einen Warenkorb legt, eine Bestellung bezahlt oder einen Kommentar sendet. Webhooks benötigen nicht so viel Programmierung wie herkömmliche Anwendungen und verbrauchen nicht so viel Rechenleistung. Ohne einen Webhook muss ein Programm häufig Daten abfragen, um sie in Echtzeit zu erhalten. Mit einem Webhook veröffentlicht die sendende Anwendung die Daten sofort.

Eingehende Webhooks, die Sie erstellen, können programmgesteuert Nachrichten an Amazon Chime-Chatrooms senden. Ein Webhook kann beispielsweise ein Kundenservice-Team über die Erstellung eines neuen Tickets mit hoher Priorität informieren und einen Link zu dem Ticket im Chatroom hinzufügen.

Webhooks-Nachrichten können mit Markdown formatiert werden und Emojis enthalten. HTTP-Links und E-Mail-Adressen werden als aktive Links wiedergegeben. Die Nachrichten können auch die Anmerkungen "@All" und "@Present" enthalten, um alle Mitglieder bzw. anwesende Mitglieder eines Chatrooms aufmerksam zu machen. Um einen Chatroom-Teilnehmer direkt anzusprechen (@mention), verwenden Sie sein Alias oder seine vollständige E-Mail-Adresse. Beispiel: @alias oder @alias@domain.com.

Webhooks können nur Teil eines Chatrooms sein und nicht geteilt werden. Amazon Chime-Chatroom-Administratoren können bis zu 10 Webhooks für jeden Chatraum hinzufügen.

Nachdem Sie einen Webhook erstellt haben, können Sie ihn in einen Amazon Chime-Chatroom integrieren, wie im folgenden Verfahren gezeigt.

Um einen Webhook in einen Chatroom zu integrieren
  1. Holen Sie sich die Webhook-URL vom Chatroom-Administrator. Weitere Informationen finden Sie unterHinzufügen von Webhooks zu einem Chatroomin derAmazon Chime-Benutzerhandbuch.

  2. Verwenden Sie die Webhook-URL in dem Skript oder der Anwendung, die Sie erstellt haben, um Nachrichten an den Chatroom zu senden:

    1. Die URL akzeptiert eine HTTP-POST-Anforderung.

    2. Amazon Chime-Webhooks akzeptieren eine JSON-Payload mit einem einzigen SchlüsselInhalt. Es folgt ein curl-Bespielbefehl mit einer Beispielnutzlast:

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

      Das Folgende ist ein BeispielPowerShellBefehl für Windows-Benutzer:

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

Nachdem das externe Programm die HTTP-POST-Anforderung an die Webhook-URL gesendet hat, validiert der Server, dass der Webhook gültig ist und ihm ein Chatroom zugewiesen ist. Der Webhook wird in der Chatroom-Liste mit einem Webhook-Symbol neben dem Namen angezeigt. Chatroom-Nachrichten, die vom Webhook gesendet werden, erscheinen im Chatroom unter dem Webhook-Namen gefolgt von (Webhook).

Anmerkung

CORS ist derzeit nicht für Webhooks aktiviert.

Behebung von Webhook-Fehlern

Im Folgenden finden Sie eine Liste von Fehlern bezüglich Webhook:

  • Das eingehende Webhook-Ratenlimit für jeden Webhook ist 1 TPS pro Chatroom. Eine Drosselung der Ergebnisse führt zu einem HTTP 429-Fehler.

  • Die von einem Webhook-Host geposteten Nachrichten dürfen maximal 4 KB betragen. Eine größere Nachrichtennutzlast führt zu einem HTTP 413-Fehler.

  • Von einem Webhook mit @All- und @Present-Anmerkungen gesendete Nachrichten eignen sich nur für Chatrooms mit 50 oder weniger Mitgliedern. Bei mehr als 50 Mitgliedern führt dies zu einem HTTP 400-Fehler.

  • Wenn die Webhook-URL neu generiert wird, führt die Verwendung des alten URL zu einem HTTP 404-Fehler.

  • Wenn der Webhook in einem Raum gelöscht wird, führt die Verwendung der alten URL zu einem HTTP 404-Fehler.

  • Ungültige Webhook-URLs ergeben HTTP 403-Fehler.

  • Wenn der Service nicht verfügbar ist, erhält der Benutzer in der Antwort einen HTTP 503-Fehler.