Collegare applicazioni esterne a kChat

Questa guida ti consente di gestire applicazioni esterne con kChat Con l'aiuto di webhook.

Preambolo

• Un webhook è un metodo che consente a un'applicazione di essere informata immediatamente quando un particolare evento si verifica in un'altra applicazione, piuttosto che chiedere costantemente a questa applicazione se è successo qualcosa di nuovo (il cosiddetto "polling").
  • Webhook in uscita: kChat comunica informazioni ad altre app quando si verifica un evento in kChat.
  • Webhook in arrivo: kChat riceve informazioni da altre app per attivare azioni in kChat.
• Non è possibile importare la cronologia delle discussioni da un'altra applicazione (Slack, Teams, Jabber, ecc.) o da un'altra Organizzazione.

Accesso all'interfaccia webhooks kChat

Prerequisiti

• Non essere un utente esterno (questo non vedrà il menu Integrazioni).

Per configurare un webhook, trovare delle applicazioni e integrazioni Auto-ospiti o terze parti:

1. Clicca qui‍ Per accedere all'app Web kChat (Servizio online kchat.infomaniak.com) o aprire l'app desktop kChat (applicazione desktop su macOS / Windows / Linux).
2. Clicca sull'icona Nuovo ‍ il nome della tua organizzazione kChat.
3. Clicca su Integrazioni.
4. Accedi alle categorie:
   

Esempio di integrazione

• Promemoria evento calendario Infomaniak su kChat

Creare un semplice webhook in arrivo

Per questo:

1. Clicca sulla categoria Webhooks in arrivo.
2. Clicca sul pulsante blu Aggiungere Webhook in arrivo:
   
3. Aggiungi un nome e una descrizione (max 500 caratteri) per il webhook.
4. Selezionare il canale che riceverà i messaggi
5. Salva per ottenere l'URL (da non divulgare pubblicamente) di tipo:
   https://votre-serveur-kchat.xyz/hooks/xxx-clé-générée-xxx

Utilizzo del webhook

Nell'app che deve essere postata su kChat:

1. Regolare il codice qui sotto in base all'URL ottenuto:

   POST /hooks/xxx-clé-générée-xxx HTTP/1.1
   Host: votre-serveur-kchat.xyz
   Content-Type: application/json
   Content-Length: 63
   
   {
       "text": "Bonjour, ceci est un texte
   Ceci est un autre texte."
   }

2. È possibile utilizzare la stessa query ma in curl (per testare da un Terminale su macOS p.ex):
   curl -i -X POST -H 'Content-Type: application/json' -d '{"text": "Bonjour, ceci est un texte Ceci est un autre texte."}' https://votre-serveur-kchat.xyz/hooks/xxx-clé-générée-xxx

Se nessuna intestazione Content-Type non è definito, il corpo della richiesta deve essere preceduto da payload come questo:

payload={"text": "Bonjour, ceci est un texte Ceci est un autre texte."}

Una richiesta di successo riceverà la seguente risposta:

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	
}

Se si desidera avere lo stesso formato di risposta di Slack:

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

devi aggiungere ?slack_return_format=true L'URL del webhook.

Impostazioni

Oltre al campo textEcco l’elenco completo dei parametri supportati:

Esempio di codice con parametri

Ecco come generare un messaggio più completo con le impostazioni, alcuni dei quali possono sostituire le impostazioni già stabilite durante la creazione del webhook (nome utente, canale preferito, avatar...) come mostrato nella tabella precedente:

POST /hooks/xxx-clé-générée-xxx HTTP/1.1
Host: votre-serveur-kchat.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": "#### Résultats des tests pour le 27 juillet 2023
@channel veuillez vérifier les tests échoués.

| Composant  | Tests effectués   | Tests échoués                                   |
|:-----------|:-----------:|:-----------------------------------------------|
| Serveur     | 948         |  0                           |
| Client Web | 123         |  2 [(voir détails)](https://linktologs) |
| Client iOS | 78          |  3 [(voir détails)](https://linktologs) |"
}

Ciò comporterà la visualizzazione di questo messaggio nel canale kchatemp dell'organizzazione: