1000 FAQ, 500 Anleitungen und Lernvideos. Hier gibt es nur Lösungen!
Externe Apps mit kChat verbinden
Mit diesem Leitfaden haben Sie Zugriff auf die Verwaltung externer Anwendungen für kChat.
Voraussetzungen
- kein externer Benutzer sein (diese werden das Integrations-Menü nicht sehen)
Zugriff auf die Benutzeroberfläche
Um ein Webhook zu konfigurieren, suchen Sie Anwendungen und selbst gehostete oder Drittanbieter-Integrationen:
- Öffnen Sie die kChat-Anwendung (auf Ihrem Gerät oder über einen Browser unter der URL kchat.infomaniak.com)
- Klicken Sie auf den nach unten zeigenden Pfeil rechts neben dem Namen Ihrer kChat-Organisation
- Klicken Sie auf Integrationen
- Zugriff auf die Kategorien erhalten:
Integrationsbeispiel
Ein einfaches eingehendes Webhook erstellen
Dazu:
- Klicken Sie auf die Kategorie Eingehende Webhooks
- Klicken Sie auf die blaue Schaltfläche Eingehende Webhooks hinzufügen
- Fügen Sie einen Namen und eine Beschreibung (maximal 500 Zeichen) für den Webhook hinzu
- Wählen Sie den Kanal aus, der die Nachrichten empfangen soll
- Speichern Sie, um die URL zu erhalten (die nicht öffentlich preisgegeben werden sollte) vom Typ:
https://your-kchat-server.xyz/hooks/xxx-generierter-schlüssel-xxx
Verwendung des Webhooks
In der Anwendung, die auf kChat posten soll:
- Passen Sie den folgenden Code je nach erhaltener URL an:
POST /hooks/xxx-generierter-schlüssel-xxx HTTP/1.1
Host: your-kchat-server.xyz
Content-Type: application/json
Content-Length: 63
{
"text": "Hallo, dies ist ein Text\nDies ist ein weiterer Text."
} - Verwenden Sie gegebenenfalls dieselbe Anfrage, aber als Curl (um es von einem Terminal auf macOS beispielsweise zu testen):
curl -i -X POST -H 'Content-Type: application/json' -d '{"text": "Hallo, dies ist ein Text\nDies ist ein weiterer Text."}' https://your-kchat-server.xyz/hooks/xxx-generierter-schlüssel-xxx
Wenn kein Content-Type-Header festgelegt ist, muss der Anfragekörper wie folgt mit Payload= beginnen:
Payload={"text": "Hallo, dies ist ein Text\nDies ist ein weiterer Text."}
Eine erfolgreiche Anfrage erhält die folgende Antwort:
HTTP/1.1 200 OK
Content-Type: application/json
X-Version-Id: 4.7.1.dev.12799dvd77e172e8a2eba0f4041ec1471.false
Date: Sun, 01 Jun 2023 17:00:00 GMT
Content-Length: 58
{
"id":"x",
"create_at":1713198308869,
"update_at":1713198308869,
"delete_at":0,
"user_id":"x",
"channel_id":"x",
"root_id":"",
"original_id":"",
"participants":null,
"message":"test",
"type":"",
"props":{
"override_username":"webhook",
"override_icon_url":null,
"override_icon_emoji":null,
"webhook_display_name":"test",
"attachments":[
],
"card":null,
"from_webhook":"true"
},
"hashtags":null,
"metadata":{
"embeds":[
{
"type":"message_attachment"
}
],
"files":[
],
"reactions":[
]
},
"file_ids":null,
"has_reactions":false,
"edit_at":0,
"is_pinned":false,
"remote_id":null,
"reply_count":0,
"pending_post_id":null,
"is_following":false
}
Wenn Sie dieselbe Antwortformatierung wie Slack wünschen:
HTTP/1.1 200 OK
Content-Type: text/plain
X-Request-Id: hoan69ws7rp5xj7wu9rmystry
X-Version-Id: 4.7.1.dev.12799dvd77e172e8a2eba0f4041ec1471.false
Date: Sun, 01 Jun 2023 17:00:00 GMT
Content-Length: 2
ok
fügen Sie ?slack_return_format=true
zur Webhook-URL hinzu.
Einstellungen
Zusätzlich zum text
-Feld finden Sie hier eine vollständige Liste der unterstützten Parameter:
Parameter | Beschreibung | Erforderlich |
---|---|---|
text | Nachricht im Markdown-Format, die in der Veröffentlichung angezeigt werden soll. Um Benachrichtigungen auszulösen, verwenden Sie @<Benutzername> , @channel und @here , wie Sie es in anderen kChat-Nachrichten tun würden. | Ja, wenn attachments nicht definiert ist |
channel | Ersetzt den Kanal, in dem die Nachricht gepostet wird. Verwenden Sie den Kanalnamen, nicht den Anzeigenamen, verwenden Sie z.B. town-square , nicht Place de la Ville .Verwenden Sie "@" gefolgt von einem Benutzernamen, um eine Direktnachricht zu senden. Standardmäßig wird der beim Erstellen des Webhooks festgelegte Kanal verwendet. Der Webhook kann in jedem öffentlichen und privaten Kanal posten, in dem der Webhook-Ersteller präsent ist. Beiträge in Direktnachrichten werden in der Direktnachricht zwischen dem anvisierten Benutzer und dem Ersteller des Webhooks angezeigt. | Nein |
username | Ersetzt den Benutzernamen, unter dem die Nachricht gepostet wird. Standardmäßig wird der beim Erstellen des Webhooks festgelegte Benutzername verwendet; wenn beim Erstellen kein Benutzername festgelegt wurde, wird webhook verwendet.Der Konfigurationsparameter Integrations dürfen Benutzernamen ersetzen muss aktiviert sein, damit die Ersetzung des Benutzernamens wirksam wird. | Nein |
icon_url | Ersetzt das Profilbild, mit dem die Nachricht gepostet wird. Standardmäßig wird die beim Erstellen des Webhooks festgelegte URL verwendet; wenn beim Erstellen kein Symbol festgelegt wurde, wird das Standard-Webhook-Symbol () angezeigt. Der Konfigurationsparameter Integrations dürfen Profilbildsymbole ersetzen muss aktiviert sein, damit die Ersetzung des Symbols wirksam wird. | Nein |
icon_emoji | Ersetzt das Profilbild und den icon_url -Parameter.Standardmäßig ist beim Erstellen des Webhooks nichts festgelegt. Der erwartete Wert ist der Name eines Emojis, wie er in einer Nachricht eingegeben wird, mit oder ohne Doppelpunkte ( : ).Der Konfigurationsparameter Integrations dürfen Profilbildsymbole ersetzen muss aktiviert sein, damit die Ersetzung wirksam wird. | Nein |
attachments | Nachrichtenanlagen, die für umfangreichere Formatierungsoptionen verwendet werden. | Ja, wenn text nicht definiert ist |
type | Legt den Veröffentlichungstyp fest, hauptsächlich für die Verwendung durch Plugins. Wenn es nicht leer ist, muss es mit " custom_ " beginnen. | Nein |
Beispielcode mit Parametern
So generieren Sie eine umfassendere Nachricht mit Parametern, die einige bei der Erstellung des Webhooks festgelegte Parameter (Benutzername, bevorzugter Kanal, Avatar usw.) ersetzen können, wie in der Tabelle oben angegeben:
POST /hooks/xxx-generierter-schlüssel-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": "#### Testergebnisse für den 27. Juli 2023\n@channel Bitte überprüfen Sie die fehlgeschlagenen Tests.\n\n| Komponente | Durchgeführte Tests | Fehlgeschlagene Tests |\n|:-----------|:-----------:|:-----------------------------------------------|\n| Server | 948 | 0 |\n| Web-Client | 123 | 2 [(Details anzeigen)](https://linktologs) |\n| iOS-Client | 78 | 3 [(Details anzeigen)](https://linktologs) |"
}
Dadurch wird diese Nachricht im Organisationskanal kchatemp angezeigt: