Retrieving the Webhook Endpoint
Follow these steps to generate a webhook endpoint for your agent
Step 1: Navigate to the Trigger Module
Open your agent’s configuration and go to the Trigger Module.
Step 2: Select Webhook as a Trigger
Click on Add Trigger and choose Webhook from the list of available options.
Step 3: Generate the Webhook URL
Click Generate Trigger to create the webhook URL. This URL will be used to send POST requests.
Step 4: Enable API Key Authentication (Optional)
If your integration requires authentication, toggle Activate API Keys.
Provide a label name and click Create new API Key.
- The generated API key will be displayed only once—store it securely.
Structuring the Payload Schema
Step 1: Core Payload Structure
Beam processes JSON payload and understands it based on context. The platform dynamically interprets keys and values to map them to the agent’s processing logic.
Below is an example of how a standard webhook payload could like:
Step 2: Handling Structured Data (Nested Objects & Arrays)
Many systems require structured data, such as candidate records, job openings, or financial transactions. Beam supports nested objects and arrays to accommodate these use cases.
Step 3: Handling File Attachments (Base64 Encoding)
Beam supports file attachments such as resumes, invoices, and contracts. These files must be Base64-encoded and included under
encodedContextFiles.Once uploaded, Beam can either store them for future reference and extract key information from them to be used within the flows.
Step 4: Handling Missing or Null Values
If a field is optional but unavailable, it should either be omitted or set to null.
Complete Payload Example
If a field is optional but unavailable, it should either be omitted or set to null.
