Mit Webhooks sendet die Apps API Ihrer Anwendung eine Echtzeitbenachrichtigung, wenn während einer Chatsitzung ein relevantes Ereignis eintritt, z. B. wenn ein Chat erstellt, eine Nachricht empfangen oder ein Chat übertragen oder eskaliert wird. Mit Webhooks können Sie auf Chataktivitäten reagieren, sobald sie auftreten, anstatt die API abzufragen.
Webhooks sind auf Chatsitzungen in der Apps API beschränkt. Contact Center AI Platform stellt alle unterstützten API-Chat-Webhook-Ereignisse von Apps als HTTP-POST-Anfragen an eine einzelne von Ihnen konfigurierte Webhook-URL bereit. Es gibt kein Abo für einzelne Events.
Hinweis
- Sie müssen Administrator sein oder eine Rolle mit der Berechtigung zum Bearbeiten der Entwicklereinstellungen haben, um Webhooks zu konfigurieren.
- Bereiten Sie einen Endpunkt vor, der HTTP-
POST-Anfragen empfangen kann. Für die Webhook-URL muss HTTPS verwendet werden.
Webhooks aktivieren
Wenn Sie Webhooks aktivieren, werden Webhook-Ereignisse von der Contact Center AI Platform an die von Ihnen konfigurierte URL gesendet. Die Felder „URL“ und „Secret“ werden angezeigt. Wenn Webhooks deaktiviert sind, werden keine Ereignisse gesendet.
So aktivieren Sie Webhooks:
- Klicken Sie im CCAI Platform-Portal auf Einstellungen > Entwicklereinstellungen. Wenn Sie das Menü Einstellungen nicht sehen, klicken Sie auf Menü.
- Rufen Sie den Bereich Webhooks auf und klicken Sie dann auf den Ein/Aus-Schalter Webhooks, um ihn zu aktivieren.
Webhook-URL konfigurieren
- Geben Sie unter URL Ihren Webhook-Endpunkt ein.
- Prüfen Sie, ob der Endpunkt HTTPS verwendet und
POST-Anfragen empfangen kann. Die Contact Center AI Platform sendet alle unterstützten Ereignisse an diese einzelne URL.
Signatur-Secrets generieren
Die Contact Center AI Platform signiert jede Webhook-Anfrage, damit Ihre Anwendung bestätigen kann, dass die Anfrage von der Contact Center AI Platform stammt. Die Signatur wird im Anfrageheader X-Signature und der Signaturzeitstempel in X-Signature-Timestamp gesendet.
Sie können bis zu zwei Signatur-Secrets konfigurieren:
- Primärer geheimer Schlüssel: Das Haupttoken, das zum Signieren von Webhook-Anfragen verwendet wird.
- Sekundäres Secret: Ein optionales zweites Token. Wenn ein sekundäres Secret festgelegt ist, signiert die Contact Center AI Platform jede Anfrage mit beiden Secrets. So können Sie Secrets rotieren, ohne dass Ereignisse verloren gehen.
Generieren Sie jedes Secret separat. So generieren Sie ein Secret:
- Klicken Sie im CCAI Platform-Portal auf Einstellungen > Entwicklereinstellungen. Wenn Sie das Menü Einstellungen nicht sehen, klicken Sie auf Menü.
- Rufen Sie den Bereich Webhooks auf.
- Klicken Sie im Bereich Primäres Secret auf Generieren. Klicken Sie auf Kopieren, um ein Secret zu kopieren und sicher zu speichern. Das vollständige Secret wird nur direkt nach der Generierung angezeigt. Danach wird sie maskiert.
- Optional: Klicken Sie im Abschnitt Secondary Secret (Sekundäres Secret) auf Generate (Generieren). Klicken Sie auf Kopieren, um ein Secret zu kopieren und sicher zu speichern.
- Bestätigen Sie den Vorgang im Warnungsdialogfeld. Ein neues Secret wird sofort wirksam. Alles, was noch ein ersetzt Secret verwendet, schlägt fehl.
Signatur-Secrets rotieren
Wenn ein primäres Secret vorhanden ist, wird die Aktion Secrets rotieren verfügbar. Das regelmäßige Rotieren von Secrets ist eine Best Practice für die Sicherheit. Da die Contact Center AI Platform jede Anfrage mit dem primären und dem sekundären Secret signiert, können Sie die Secrets rotieren, ohne die Bereitstellung zu unterbrechen:
- Klicken Sie im CCAI Platform-Portal auf Einstellungen > Entwicklereinstellungen. Wenn Sie das Menü Einstellungen nicht sehen, klicken Sie auf Menü.
- Achten Sie darauf, dass sowohl ein primäres als auch ein sekundäres Secret festgelegt sind.
- Klicken Sie auf Secrets rotieren, um die primären und sekundären Secrets zu tauschen.
- Aktualisieren Sie Ihre Anwendung, um Signaturen mit dem neuen aktiven Secret zu überprüfen. Während der Überschneidung signiert die Contact Center AI Platform jede Anfrage mit beiden konfigurierten Secrets. Akzeptieren Sie daher beide, damit die Bereitstellung nicht unterbrochen wird.
Konfiguration speichern
Klicken Sie auf Speichern, um den aktivierten Status und die URL des Webhooks zu übernehmen. Das Generieren oder Rotieren eines Secrets wird sofort wirksam und erfordert kein Speichern. Contact Center AI Platform beginnt mit der Bereitstellung von Ereignissen, nachdem Webhooks aktiviert und eine Webhook-URL und ein primäres Secret festgelegt wurden.
Was Ihre Anwendung erhält
Nachdem Sie Webhooks aktiviert haben, sendet die Contact Center AI Platform für jedes unterstützte Chatereignis eine HTTP-POST-Anfrage, z. B. für Änderungen des Lebenszyklus, Teilnehmeraktivitäten, Nachrichten, Weiterleitungen, Eskalierungen, Webformulare und Warnungen zum Schließen. Jeder Anfragetext ist ein JSON-Umschlag mit event_type, timestamp, chat_id und einem ereignisspezifischen body.