Webhooks für die Chat API-Plattform

Webhooks ermöglichen es externen Anwendungen, Echtzeitbenachrichtigungen zu erhalten, wenn bestimmte Ereignisse auf der Plattform auftreten.

Wenn Sie Webhooks verwenden möchten, müssen Sie sie aktivieren und Tokens generieren. Wenn Sie zwei separate Secrets für eine einzelne Webhook-URL verwenden, fügen Sie eine zusätzliche Sicherheitsebene hinzu. Wenn ein Secret kompromittiert wird oder aus irgendeinem Grund rotiert werden muss, können Sie die Secrets aktualisieren und rotieren, ohne den Webhook-Dienst zu unterbrechen oder die Datensicherheit zu gefährden.

Webhooks aktivieren

So aktivieren Sie Webhooks:

  1. Klicken Sie im CCAI Platform-Portal auf Einstellungen > Entwicklereinstellungen. Wenn Sie das Menü Einstellungen nicht sehen, klicken Sie auf  Menü.

  2. Rufen Sie den Bereich Webhooks auf und klicken Sie dann auf die Ein/Aus-Schaltfläche Webhooks, um sie zu aktivieren.

  3. Geben Sie unter URL eine Webhook-URL ein. Diese URL ist der Endpunkt, der Echtzeitbenachrichtigungen empfängt. Achten Sie darauf, dass dieser Webhook HTTP-Anfragen empfangen kann.

  4. Klicken Sie auf Generieren. Dadurch wird das primäre Secret generiert, das als Hauptsicherheitstoken für die Authentifizierung und Validierung eingehender Webhook-Nutzlasten verwendet wird. Sie dient als primäres Mittel zur Sicherung der Webhook-Kommunikation.

  5. Kopieren Sie das Token und speichern Sie es an einem sicheren Ort.

  6. Sekundäres Secret generieren Das sekundäre Geheimnis dient als Backup- oder Failover-Sicherheitstoken. Sie dient als zusätzliche Sicherheitsmaßnahme, um die Zuverlässigkeit und Verfügbarkeit von Webhook-Benachrichtigungen zu verbessern. Wenn das primäre Secret aus irgendeinem Grund kompromittiert wird oder Probleme bei der Verwendung auftreten, kann das sekundäre Secret die Kommunikation übernehmen und fortsetzen.

  7. Kopieren Sie das Token und speichern Sie es an einem sicheren Ort.

  8. Klicken Sie auf Speichern.

Secrets rotieren

Als Best Practice für die Sicherheit sollten Sie Webhook-Secrets regelmäßig rotieren. Dazu müssen Sie neue geheime Schlüssel für die primären und sekundären Webhooks generieren und in Ihrer Anwendung aktualisieren, damit Sie weiterhin nahtlos Benachrichtigungen erhalten.

Nach der ersten Einrichtung von Webhooks können Sie nicht direkt ein neues primäres Secret generieren. Sie können jedoch ein neues sekundäres Secret generieren und die Secrets rotieren, um sie zu ändern.

So rotieren Sie Secrets:

  1. Klicken Sie im CCAI Platform-Portal auf Einstellungen > Entwicklereinstellungen. Wenn Sie das Menü Einstellungen nicht sehen, klicken Sie auf  Menü.

  2. Klicken Sie auf Secrets rotieren.

  3. Klicken Sie auf Speichern.

Neue Secrets generieren

So rotieren Sie die Secrets, sodass Sie zwei neue geheime Schlüssel haben:

  1. Klicken Sie im CCAI Platform-Portal auf Einstellungen > Entwicklereinstellungen. Wenn Sie das Menü Einstellungen nicht sehen, klicken Sie auf  Menü.

  2. Klicken Sie auf Generieren, um einen neuen sekundären geheimen Schlüssel zu generieren.

  3. Klicken Sie auf Secrets rotieren, um das neue sekundäre Secret zum primären Secret zu machen.

  4. Klicken Sie auf Generieren, um ein zweites neues sekundäres Secret zu generieren, das das alte primäre Secret ersetzt.

  5. Klicken Sie auf Speichern.