Beam Webhook-Auslöse-Leitfaden

Diese Anleitung erklärt, wie Sie Payloads für POST-Aufrufe mit dem Webhook-Modul von Beam strukturieren. Die Beam-Plattform akzeptiert Payloads im JSON-Format und kann verschiedene Datenstrukturen verarbeiten, einschließlich strukturierter Objekte, Anhänge und Metadaten.

Beam Webhook-Auslöse-Leitfaden

Abrufen des Webhook-Endpunkts

Befolgen Sie diese Schritte, um einen Webhook-Endpunkt für Ihren Agenten zu erstellen

Schritt 1: Navigieren Sie zum Trigger-Modul

Öffnen Sie die Konfiguration Ihres Agenten und gehen Sie zum Auslösemodul.

Schritt 2: Wählen Sie Webhook als Auslöser

Klicken Sie auf Trigger hinzufügen und wählen Sie Webhook aus der Liste der verfügbaren Optionen.

Schritt 3: Generieren Sie die Webhook-URL

Klicken Sie auf Trigger generieren, um die Webhook-URL zu erstellen. Diese URL wird verwendet, um POST-Anfragen zu senden.

Schritt 4: API-Schlüssel-Authentifizierung aktivieren (optional)

Wenn Ihre Integration eine Authentifizierung erfordert, aktivieren Sie API-Schlüssel aktivieren.

Geben Sie einen Beschriftungsnamen ein und klicken Sie auf Neuen API-Schlüssel erstellen.

- Der generierte API-Schlüssel wird nur einmal angezeigt – bewahren Sie ihn sicher auf.

Strukturierung des Payload-Schemas

Schritt 1: Struktur des Kern-Payloads

Beam verarbeitet JSON-Payloads und versteht sie basierend auf dem Kontext. Die Plattform interpretiert dynamisch Schlüssel und Werte, um sie der Verarbeitungslogik des Agenten zuzuordnen.
Nachfolgend ist ein Beispiel, wie ein standardmäßiger Webhook-Payload aussehen könnte:

Schritt 2: Umgang mit strukturierten Daten (verschachtelte Objekte und Arrays)

Viele Systeme benötigen strukturierte Daten, wie Kandidatenprofile, Stellenangebote oder Finanztransaktionen. Beam unterstützt verschachtelte Objekte und Arrays, um diese Anwendungsfälle zu erfüllen.

Schritt 3: Umgang mit Dateianhängen (Base64-Kodierung)

Beam unterstützt Dateianhänge wie Lebensläufe, Rechnungen und Verträge. Diese Dateien müssen Base64-codiert werden und unter encodedContextFiles enthalten sein.
Sobald sie hochgeladen sind, kann Beam sie entweder zur späteren Verwendung speichern und wichtige Informationen daraus extrahieren, um sie innerhalb der Abläufe zu verwenden.