Integrations
Make the most of Beam by connecting it with your existing tools. Our agents use these tools like a human would, helping you boost productivity and make smarter decisions. With Beam, you can create a more efficient and innovative workspace by combining AI with the tools you already use.
Watch the demo video for an overview of building and managing custom integrations for your agent.
Key Benefits
Automated workflows triggered by specific actions such as data retrieval or ticket management.
Streamlined data flow between Beam and external platforms without manual intervention.
Step-by-Step Guide to Building a Custom Integration
Step 1: Navigate to the Integrations Tab
Seamless integration with third-party systems such as ACME, Contoso, and other APIs.
Step 2: Start Building Your Custom Integration
Upload an Icon (optional).
Integration Name: Name your integration (e.g., ACME Order Management, Contoso CRM).
Integration Category: Select the relevant category (e.g., Supply Chain, Operations).
Authentication Type: Select the required authentication type based on the API being connected
None
API Key
Optionally, select how the API key is sent with the requests. Available options are
Default: Sent via header parameter (Authorization)
Bearer: Sent via header parameter (Authorization) with “Bearer” prefixed
Header: Send via header with a custom parameter
Query: Send via custom query parameter
Basic (username/password)
Credentials are sent as ‘Basic’ Authorization
Step 3: Import or Select Example Schema
In the Schema section, you have two options for adding the schema:
Import from URL
Use Example Schema
Option 1: Import from URL
Use this option if the platform you’re integrating with provides an OpenAPI schema or detailed API documentation that you can import.
In the schema section, paste the OpenAPI schema or Import from URL.
The schema defines the API endpoints, methods (GET, POST, etc.), and parameters for the integration.
Once the schema is imported, Beam will automatically populate the available actions for the integration
In case of an invalid schema, you will receive an Invalid Schema error. Ensure your schema follows the example/template and contains the correct syntax.
Option 2: Use Example Schema
Use this option if you are working with a proprietary or custom API that does not provide an OpenAPI schema. This allows you to define the necessary API endpoints, parameters, and methods manually, starting from a basic template.
Example Schema Format
The schema is JSON format of an array of objects. Each object represents a unique action/API call.
[
{
"type": "beam_tool",
"content": "CustomApiTool_FunctionName: Function description",
"icon_src": "",
"isActive": true,
"tool_name": "Tool name",
"categories": [],
"description": "Description",
"function_name": "CustomApiTool_FunctionName",
"requires_consent": true,
"agent_categories": [],
"integrationIdentifier": "",
"required_extracted_args": [
"parameterName: string // Parameter description"
],
"optional_extracted_args": [],
"required_generated_args": [],
"optional_generated_args": [],
"integration_provider_auth": "none",
"description_human_readable": "Human readable description visible on the platform",
"integration_provider_details": {
"request": {
"body": {
"parameterName": "{{string}}"
},
"query": [
"parameterName: string // Parameter description"
],
"method": "POST",
"endpoint": "https://abc.xyz"
},
"response": {
"message": "Message here"
}
},
"integration_provider_executor": "custom"
}
]
Step 4: Activate Actions
Review the available actions in the Actions section. These actions are derived from the schema you imported.
Activate the actions you need by checking the boxes next to them. Example actions might include:
Listing orders (GET /orders)
Creating a new customer entry (POST /customers)
Searching for products (GET /products/search)
Once done, save the integration.
Step 5: Authentication Methods
After saving the integration, navigate back to the Integrations screen.
You will see your new custom integration listed there with an option to Connect.
Basic Authentication
For integrations requiring Basic Authentication, enter the username and password provided by the API to authenticate.
API Key Authentication
For API Key Authentication, input the API key to authenticate with the external platform.
No Authentication Required
If the API does not require authentication, the system will proceed without any credential input.
Accessing and Utilising Your Integration
Once your custom integration is connected and authenticated, it becomes available across your Beam Workspace for both workflow automation and real-time conversations. This flexibility allows you to enhance agent efficiency and streamline repetitive tasks.
Viewing Your Integration
After authentication, your integration will appear under the Connected section of the Integrations tab. Here you can review or update the integration as needed.
Adding Integration Tools to Agents for Workflow Use
Integration actions will only appear as Tools in the agent dashboard after authentication is successfully completed. These tools can then be assigned to agents and utilised in workflows to automate tasks.
Step 1: After successful authentication, head over to the Tools section.
Step 2: From the Tools screen, click on Add to agent for any tool you want to assign to your agents.
These tools will be accessible to agents within their workflows or during real-time interactions.
Why Use Actions in Workflows?
Automate routine tasks like sending notifications or creating records.
Ensure consistent processes without manual intervention.
Example Workflow Use Case:
Integration actions will only appear as Tools in the agent dashboard after authentication is successfully completed. These tools can then be assigned to agents and utilised in workflows to automate tasks.
Customer Action: A customer places an order.
Automated Action: Automatically trigger the Update Order Status action to notify the warehouse or fulfilment team that the order is ready for processing.
Using Integration Actions in Conversations
Agents can trigger integration actions directly from the Dashboard, providing real-time support without the need to leave the current conversation.
Why Use Actions in Conversations?
Efficiency: Agents can perform actions like checking order status or adding customer data without leaving the conversation.
Contextual Support: Actions can be triggered based on real-time inputs from the conversation, allowing agents to handle tasks instantly.
Example in Action:
If you’re handling a support request in real-time and need to retrieve order information from ACME Order Management, you can quickly retrieve the relevant details by typing
order status {Order ID}
This command triggers the Get Order Status action, retrieving the latest order status from the ACME system without switching platforms.
Similarly, if you need to update customer details in Contoso CRM during a live chat, you can trigger the update by typing:
customer update {Customer ID} "New Address, Phone Number”
Why This Matters
By embedding integrations into your workflows and real-time conversations, you create a seamless, efficient environment where tasks are automated and agents can perform actions without leaving the platform. This enhances productivity and elevates your team’s performance.