Public APITools
Create a tool
POST
Creates a new webhook-type tool. tool_key must be unique within your
organization; reuse returns 409. Submit auth secrets on create or PATCH
to set or rotate them.
bearerAuthheader
AuthorizationBearer <token>API key in the Authorization: Bearer <key> header.
Keys are created in the Hallolara dashboard (Settings → API Keys).
application/json- body
tool_key*stringMatch
^[a-z][a-z0-9_]*$Length
1 <= length <= 80display_name*stringLeading/trailing whitespace is trimmed.
Length
1 <= length <= 200description?stringLength
length <= 1000Default
""execution_type*"webhook"v1 accepts webhook only. Integration-type tools must be created via the dashboard (OAuth flow).
Value in
"webhook"parameters?JSON Schema defining the tool arguments.
webhook*auth?||Auth credentials sent on POST/PATCH. Shape varies by type.
Note: secret and password are write-only; responses use ToolAuthSummary.
Created.
application/json- response
data?curl -X POST 'https://api.hallolara.ai/api/v1/tools' \ -H 'Content-Type: application/json' \ -d '{ "tool_key": "get_opening_hours", "display_name": "Get Opening Hours", "execution_type": "webhook", "webhook": { "url": "https://api.example.com/assistant-tools" }}'Example Response
{ "data": { "id": "string", "tool_key": "string", "display_name": "string", "description": "string", "parameters": {}, "execution_type": "webhook", "source": "custom", "webhook": { "url": "http://example.com", "method": "GET", "headers": {}, "body_template": "string", "timeout_ms": 10000, "retry_count": 0 }, "integration": null, "auth": { "type": "apiKey", "header_name": "string", "username": "string", "has_secret": true }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }}