Custom API & Webhooks

Custom REST API tool

You can define a custom tool that wraps any HTTP API:

1. Go to Console → Tools → Custom API
2. Click New Custom API
3. Set the Base URL (e.g., https://api.yourservice.com/v1)
4. Configure Authentication (API key, Bearer token, or Basic auth)
5. Define your Endpoints — see format below
6. Save and enable for your agents

---

Endpoint definition format

Each endpoint needs:

Field	Description
Name	A descriptive name the agent uses internally (e.g., “Get Customer”)
Method	GET, POST, PUT, DELETE
Path	Relative path with optional params (e.g., /users/{user_id})
Description	Plain English — this is how the agent decides when to call this endpoint
Parameters	Query params or body fields with types and descriptions

Write detailed descriptions

The endpoint description is critical — it’s how the agent understands when and how to call your API. Be specific about the use case.

---

Example: custom CRM integration

Name: Customer CRM
Base URL: https://crm.acme.com/api/v1
Auth: Bearer {{SECRET_CRM_TOKEN}}

Endpoints:
  - name: Get Customer
    method: GET
    path: /customers/{customer_id}
    description: >
      Retrieve a customer record by ID. Use this when the user asks about
      a specific customer's details, status, or history.
    parameters:
      - name: customer_id
        type: string
        required: true

  - name: Update Customer Status
    method: PUT
    path: /customers/{customer_id}/status
    description: >
      Update the status of a customer account. Use only when the user
      explicitly requests a status change.
    parameters:
      - name: status
        type: string
        required: true
        enum: [active, suspended, cancelled]

With this configured, your agent can handle:

• “Look up customer 12345 and tell me their current plan”
• “Update customer 98765 to suspended status”

---

Storing credentials securely

Store API keys in Account → Secrets and reference them as {{SECRET_NAME}} in your tool configuration. Never paste raw tokens into the tool settings.

---

Webhook triggers (for Flows)

Webhooks let external systems trigger your agent. See Flows → Triggers →.