1000 FAQ, 500 Anleitungen und Lernvideos. Hier gibt es nur Lösungen!
Verbinden Sie externe Apps mit kChat
Dieser Leitfaden ermöglicht Ihnen den Zugriff auf die Verwaltung externer Anwendungen in kChat.
Zugriff auf die Benutzeroberfläche
Um einen Webhook zu konfigurieren, selbst gehostete oder von Dritten bereitgestellte Anwendungen und Integrationen zu finden:
- Klicken Sie oben links in Ihrer kChat-Oberfläche auf den nach unten zeigenden Pfeil rechts neben dem Namen Ihrer kChat-Organisation:
- Klicken Sie auf Integrationen, um auf die Kategorien zuzugreifen:
Ein externer kChat-Benutzer hat dieses Menü nicht.
Beispiel für eine Integration
Erstellen Sie einen einfachen eingehenden Webhook
- Klicken Sie auf die Kategorie Eingehende Webhooks
- Klicken Sie auf die blaue Schaltfläche Eingehende Webhooks hinzufügen
- Geben Sie einen Namen und eine Beschreibung (maximal 500 Zeichen) für den Webhook ein
- Wählen Sie den Kanal aus, der die Nachrichten erhalten soll
- Speichern Sie, um die URL zu erhalten (nicht öffentlich zugänglich) im Format:
https://your-kchat-server.xyz/hooks/xxx-generatedkey-xxx
Verwendung des Webhooks
Auf der Anwendung, die auf kChat posten muss:
- Passen Sie den folgenden Code entsprechend der erhaltenen URL an:
POST /hooks/xxx-generatedkey-xxx HTTP/1.1
Host: your-kchat-server.xyz
Content-Type: application/json
Content-Length: 63
{
"text": "Hallo, dies ist etwas Text\nDas ist mehr Text."
} - Verwenden Sie optional dieselbe Anfrage, jedoch in Curl (um beispielsweise aus einem macOS-Terminal zu testen):
curl -i -X POST -H 'Content-Type: application/json' -d '{"text": "Hallo, dies ist etwas Text\nDas ist mehr Text."}' https://your-kchat-server.xyz/hooks/xxx-generatedkey-xxx
Wenn kein Content-Type-Header definiert ist, muss der Anfragekörper mit payload= vorangestellt sein, wie folgt:
payload={"text": "Hallo, dies ist etwas Text\nDas ist mehr Text."}
Eine erfolgreiche Anfrage erhält die folgende Antwort:
HTTP/1.1 200 OK
Content-Type: text/plain
X-Request-Id: hoan69ws7rp5xj7wu9rmystry
X-Version-Id: 4.7.1.dev.12799dvd77e172e8a2eba0f4041ec1471.false
Datum: So, 01. Juni 2023 17:00:00 GMT
Inhaltliche Länge: 2
ok
Parameter
Zusätzlich zum text-Feld hier die vollständige Liste der unterstützten Parameter:
| Parameter | Beschreibung | Erforderlich |
|---|---|---|
text | Markdown-formatierte Nachricht zur Anzeige im Beitrag. Verwenden Sie zur Auslösung von Benachrichtigungen @, @channel und @here, wie Sie es in anderen kChat-Nachrichten tun würden. | Ja, wenn attachments nicht festgelegt ist |
channel | Überschreibt den Kanal, in dem die Nachricht veröffentlicht wird. Verwenden Sie den Kanalnamen und nicht den Anzeigenamen, z. B. town-square, nicht Town Square.Verwenden Sie ein „@“ gefolgt von einem Benutzernamen, um eine Direktnachricht zu senden. Standardmäßig wird der Kanal während der Webhook-Erstellung festgelegt. Der Webhook kann in jedem öffentlichen Kanal und privaten Kanal posten, in dem der Webhook-Ersteller Mitglied ist. Beiträge in Direktnachrichten erscheinen in der Direktnachricht zwischen dem angezielten Benutzer und dem Webhook-Ersteller. | Nein |
username | Überschreibt den Benutzernamen, unter dem die Nachricht veröffentlicht wird. Standardmäßig wird der Benutzername während der Webhook-Erstellung festgelegt. Wenn bei der Erstellung kein Benutzername festgelegt wurde, wird webhook verwendet.Die Einstellung „Integrationen dürfen Benutzernamen überschreiben“ muss aktiviert sein, damit die Überschreibung des Benutzernamens wirksam wird. | Nein |
icon_url | Überschreibt das Profilbild, das mit der Nachricht veröffentlicht wird. Standardmäßig wird die URL während der Webhook-Erstellung festgelegt. Wenn bei der Erstellung kein Icon festgelegt wurde, wird das Standard-Webhook-Icon () angezeigt. Die Einstellung „Integrationen dürfen Profilbildsymbole überschreiben“ muss aktiviert sein, damit die Überschreibung des Symbols wirksam wird. | Nein |
icon_emoji | Überschreibt das Profilbild und den icon_url-Parameter.Standardmäßig ist keines festgelegt und wird nicht während der Webhook-Erstellung festgelegt. Der erwartete Wert ist ein Emoji-Name, wie er in einer Nachricht eingegeben wird, mit oder ohne Doppelpunkte ( :).Die Einstellung „Integrationen dürfen Profilbildsymbole überschreiben“ muss aktiviert sein, damit die Überschreibung wirksam wird.. | Nein |
attachments | Nachrichtenanlagen zur Verwendung für umfangreichere Formatierungsoptionen. | Ja, wenn text nicht festgelegt ist |
type | Sets the post type, mainly for use by plugins.If not blank, must begin with “ custom_”. | No |
Exemple de code avec paramètres
Voici comment générer un message plus complet avec des paramètres dont certains peuvent écraser d'éventuels paramètres déjà établis lors de la création du webhook (nom d'utilisateur, canal préféré, avatar...) comme indiqué dans le tableau ci-dessus:
POST /hooks/xxx-generatedkey-xxx HTTP/1.1
Host: your-kchat-server.xyz
Content-Type: application/json
Content-Length: 630
{
"channel": "kchatemp",
"username": "test-automation",
"icon_url": "https://domain.xyz/wp-content/uploads/2023/06/icon.png",
"text": "#### Test results for July 27th, 2023\n@channel please review failed tests.\n\n| Component | Tests Run | Tests Failed |\n|:-----------|:-----------:|:-----------------------------------------------|\n| Server | 948 | 0 |\n| Web Client | 123 | 2 [(see details)](https://linktologs) |\n| iOS Client | 78 | 3 [(see details)](https://linktologs) |"
}
ce qui aura comme effet d'afficher ce message dans le canal kchatemp de l'organisation:
Parameter
Zusätzlich zum text-Feld hier die vollständige Liste der unterstützten Parameter:
| Parameter | Beschreibung | Erforderlich |
|---|---|---|
text | Markdown-formatierte Nachricht zur Anzeige im Beitrag. Verwenden Sie zur Auslösung von Benachrichtigungen @, @channel und @here, wie Sie es in anderen kChat-Nachrichten tun würden. | Ja, wenn attachments nicht festgelegt ist |
channel | Überschreibt den Kanal, in dem die Nachricht veröffentlicht wird. Verwenden Sie den Kanalnamen und nicht den Anzeigenamen, z. B. town-square, nicht Town Square.Verwenden Sie ein „@“ gefolgt von einem Benutzernamen, um eine Direktnachricht zu senden. Standardmäßig wird der Kanal während der Webhook-Erstellung festgelegt. Der Webhook kann in jedem öffentlichen Kanal und privaten Kanal posten, in dem der Webhook-Ersteller Mitglied ist. Beiträge in Direktnachrichten erscheinen in der Direktnachricht zwischen dem angezielten Benutzer und dem Webhook-Ersteller. | Nein |
username | Überschreibt den Benutzernamen, unter dem die Nachricht veröffentlicht wird. Standardmäßig wird der Benutzername während der Webhook-Erstellung festgelegt. Wenn bei der Erstellung kein Benutzername festgelegt wurde, wird webhook verwendet.Die Einstellung „Integrationen dürfen Benutzernamen überschreiben“ muss aktiviert sein, damit die Überschreibung des Benutzernamens wirksam wird. | Nein |
icon_url | Überschreibt das Profilbild, das mit der Nachricht veröffentlicht wird. Standardmäßig wird die URL während der Webhook-Erstellung festgelegt. Wenn bei der Erstellung kein Icon festgelegt wurde, wird das Standard-Webhook-Icon () angezeigt. Die Einstellung „Integrationen dürfen Profilbildsymbole überschreiben“ muss aktiviert sein, damit die Überschreibung des Symbols wirksam wird. | Nein |
icon_emoji | Überschreibt das Profilbild und den icon_url-Parameter.Standardmäßig ist keines festgelegt und wird nicht während der Webhook-Erstellung festgelegt. Der erwartete Wert ist ein Emoji-Name, wie er in einer Nachricht eingegeben wird, mit oder ohne Doppelpunkte ( :).Die Einstellung „Integrationen dürfen Profilbildsymbole überschreiben“ muss aktiviert sein, damit die Überschreibung wirksam wird.. | Nein |
attachments | Nachrichtenanlagen zur Verwendung für umfangreichere Formatierungsoptionen. | Ja, wenn text nicht festgelegt ist |
type | Sets the post type, mainly for use by plugins.If not blank, must begin with “ custom_”. | No |