Configure a webhook Tool

A webhook Tool turns a model-selected call into one outbound HTTP request. Configure the endpoint your service already exposes; Operade does not create or host that endpoint.

Define the request#

Choose one of GET, POST, PUT, PATCH, or DELETE, then enter an absolute http or https URL. Describe when the Tool should run and define its arguments under Parameters. A name inside single braces in the URL becomes a path parameter. Remaining arguments become a query string for GET or DELETE, and a JSON body for POST, PUT, or PATCH.

For example, GET https://api.example.com/orders/{order_id} puts order_id in the path and any other arguments in the query. Path values are URL-encoded. A missing path argument stops the call and returns an actionable Tool error to the model.

Headers, templates, and timeout#

Authentication headers come from workspace Secrets. Saved request headers may also contain a dynamic-variable template such as X-Customer: {{customer_id}}; the URL supports the same form. Unknown templates stay literal so a typo is visible instead of silently becoming an empty value.

Set the timeout from 5 to 300 seconds; the default is 20 seconds. A timeout or network failure is returned to the model as a failed Tool result. Operade validates the destination immediately before connecting, pins the resolved public address, and does not follow redirects for Tool calls.

Interpret the response#

Statuses below HTTP 400 are successful. An empty successful body becomes a clear acceptance message, so the model does not have to guess. HTTP 400 and higher are failed results and do not produce assignments. The response body is capped before it enters the conversation runtime.

Use parameters for the JSON Schema contract and troubleshooting for private-address, timeout, and response failures.