Creazione di webhook per Amazon Chime

I webhook consentono alle applicazioni Web di comunicare tra loro in tempo reale. In genere, i webhook inviano notifiche quando si verifica un'azione. Ad esempio, supponiamo che tu gestisca un sito di shopping online. I webhook possono avvisarti quando un cliente aggiunge articoli a un carrello, paga un ordine o invia un commento. I webhook non richiedono tanta programmazione come le applicazioni tradizionali e non utilizzano la stessa potenza di elaborazione. Senza un webhook, un programma deve interrogare frequentemente i dati per ottenerli in tempo reale. Con un webhook, l'applicazione di invio pubblica immediatamente i dati.

I webhook in entrata che crei possono inviare messaggi a livello di programmazione alle chat room di Amazon Chime. Ad esempio, un webhook può notificare a un team del servizio clienti la creazione di un nuovo ticket ad alta priorità e aggiungere un link al ticket nella chat room.

I messaggi Webhooks possono essere formattati con Markdown e possono includere emoji. I collegamenti HTTP e gli indirizzi e-mail vengono visualizzati come collegamenti attivi. I messaggi possono anche includere annotazioni @All e @Present per avvisare rispettivamente tutti i membri e quelli presenti della chat room. Per @rivolgervi direttamente a un partecipante della chat room, utilizzate il loro alias o l'indirizzo e-mail completo. Ad esempio, @alias o @[e-mail].

I webhook possono solo far parte di una chat room e non possono essere condivisi. Gli amministratori delle chat room di Amazon Chime possono aggiungere fino a 10 webhook per ogni chat room.

Dopo aver creato un webhook, puoi integrarlo con una chat room di Amazon Chime, come illustrato nella procedura seguente.

Per integrare un webhook con una chat room

1. Ottieni l'URL del webhook dall'amministratore della chat room. Per ulteriori informazioni, vedereAggiungere webhook a una chat roomnelGuida per l'utente di Amazon Chime.

2. Usa l'URL del webhook nello script o nell'applicazione che hai creato per inviare messaggi alla chat room:

   1. L'URL accetta una richiesta HTTP POST.

   2. I webhook di Amazon Chime accettano un payload JSON con una sola chiaveContenuto. Di seguito è riportato un esempio di comando curl con un payload di esempio:

      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: [e-mail] All member callout: @All All Present member callout: @Present"}'

      Di seguito è riportato un esempioPowerShellcomando per utenti 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: [e-mail] All member callout: @All All Present member callout: @Present"}'

Dopo che il programma esterno invia la richiesta HTTP POST all'URL del webhook, il server conferma che il webhook è valido e che ha una chat room assegnata. Il webhook viene visualizzato nel registro della chat room con un'icona webhook accanto al nome. I messaggi della chat room inviati dal webhook vengono visualizzati nella chat room sotto il nome del webhook seguito da (Webhook).

Nota

CORS non è attualmente abilitato per i webhook.

Risoluzione degli errori del webhook

Di seguito è riportato un elenco di errori correlati ai webhook:

• Il limite di velocità dei webhook in ingresso è di 1 TPS per chat room. Il throttling genera un errore HTTP 429.

• I messaggi pubblicati da un webhook devono essere al massimo di 4 KB. Un payload del messaggio più grande genera un errore HTTP 413.

• I messaggi pubblicati da un webhook con annotazioni @Tutti e @Present funzionano solo per chat con un massimo di 50 membri. Più di 50 membri generano un errore HTTP 400.

• Se l'URL del webhook viene rigenerato, l'utilizzo del vecchio URL genera un errore HTTP 404.

• Se il webhook in una chat room viene eliminato, l'utilizzo del vecchio URL genera un errore HTTP 404.

• Gli URL non validi dei webhook generano errori HTTP 403.

• Se il servizio non è disponibile, l'utente riceve un errore HTTP 503 nella risposta.