Mit Webhooks können Sie Daten automatisch von unserem System an andere Anwendungen übermitteln. In diesem Hilfsartikel erfahren Sie, wie Sie Webhooks einrichten und durch einen Sicherheitsschlüssel absichern können.
Was sind Webhooks und wozu werden sie verwendet?
Webhooks ermöglichen es Ihnen, Benachrichtigungen an Ihre eigenen Systeme zu senden, wenn bestimmte Ereignisse in unserem System auftreten. Dies ist besonders nützlich, wenn Sie Daten automatisch in andere Anwendungen übertragen möchten, ohne manuell Exporte durchführen zu müssen.
Typische Anwendungsfälle sind zum Beispiel:
- Automatische Benachrichtigung an Ihren Server, wenn ein neuer Kontakt angelegt wird
- Datenübertragung an Ihre Webseite, wenn sich der Status eines Objekts ändert
- Integration mit anderen Systemen für eine nahtlose Datenverarbeitung
Mit der neuen Sicherheitsschlüssel-Funktion können Sie nun sicherstellen, dass die empfangenen Webhook-Anfragen tatsächlich von unserem System stammen.
So richten Sie einen Webhook ein
-
Navigieren Sie zu Verwaltung > API-Schlüssel, wo Sie den Bereich "Webhooks" finden. Klicken Sie dort auf den Button "+ Webhook hinzufügen", um einen neuen Webhook anzulegen.
-
Geben Sie die URL ein, an die die Webhook-Daten gesendet werden sollen. Dies ist typischerweise ein Endpunkt auf Ihrem eigenen Server oder einer anderen Anwendung, die Sie verwenden.
-
Wählen Sie aus dem Dropdown-Menü das Ereignis, bei dem der Webhook ausgelöst werden soll. Es stehen verschiedene Ereignistypen zur Verfügung, wie zum Beispiel:
- Kontakt erstellt
- Objekt aktualisiert
- Deal-Phase geändert
- und weitere Ereignisse
-
Für eine erhöhte Sicherheit können Sie einen Sicherheitsschlüssel eingeben. Dieser Schlüssel wird verwendet, um eine eindeutige Signatur zu erstellen, mit der Sie die Authentizität der Webhook-Anfragen überprüfen können.
Der Sicherheitsschlüssel wird als Header mit dem Namen 'X-Propstack-Signature' an den Webhook gesendet. Ihre Anwendung kann diesen Schlüssel verwenden, um zu überprüfen, ob die Anfrage tatsächlich von unserem System stammt.
-
Klicken Sie auf "Speichern", um den Webhook zu aktivieren. Ab sofort werden bei Auftreten des ausgewählten Ereignisses Daten an die angegebene URL gesendet.
Um die korrekte Funktionsweise Ihres Webhooks zu testen, können Sie ein Testevent in Ihrem System auslösen (z.B. einen Testkontakt anlegen) und prüfen, ob die Daten an Ihrem Ziel-Endpunkt ankommen.
Funktionsweise der Webhook-Sicherheit
Die neue Sicherheitsfunktion verwendet einen branchenüblichen Ansatz namens HMAC (Hash-based Message Authentication Code), um die Authentizität der Webhook-Anfragen zu gewährleisten. Wenn Sie einen Sicherheitsschlüssel angeben, wird dieser als Header mit der eingehenden Anfrage mitgesendet.
Detaillierte Erläuterungen finden Sie in unserer Entwicklerdokumentation.
Häufig gestellte Fragen
Muss ich die Sicherheitsschlüssel-Funktion nutzen?
Nein, die Verwendung eines Sicherheitsschlüssels ist optional. Bestehende Webhooks funktionieren weiterhin ohne Änderungen. Für sensible Daten oder produktive Umgebungen wird die Nutzung jedoch empfohlen.
Was passiert, wenn ich den Sicherheitsschlüssel verliere?
Der Sicherheitsschlüssel kann nur einmalig beim Anlegen des Webhooks eingetragen werden und ist später nicht mehr abrufbar. Bei Verlust müssen Sie den Webhook neu anlegen, wodurch ein neuer Sicherheitsschlüssel vergeben werden kann.
Kann ich mehrere Webhooks für verschiedene Ereignisse einrichten?
Ja, Sie können beliebig viele Webhooks anlegen, jeweils mit eigenen Events und Sicherheitsschlüsseln.