Skip to main content
A webhook tool describes an HTTP request to a service you control or have permission to use. Start with one clearly defined action and the service’s actual request and response contract.
Use the authenticated dashboard to manage tools; personal API keys are currently rejected for these operations. Saving a webhook tool does not demonstrate request delivery, retries, or successful execution during a conversation.

​
Define the request

Recording pending for webhook tool authoring and read-back. No playable video is available yet.

Recording pending: define and inspect a webhook tool. Follow the written guide below.

1

Open the webhook form

Open Tools and choose Add webhook tool. Give the action a precise name and description. Prefer a read-only lookup for initial integration planning.
2

Match the service contract

Review the URL, method, path parameters, query parameters, and request body. A path placeholder such as {record_id} needs a matching entry in path_params_schema.
3

Review authentication and returned data

Use supported auth connections or secret references. Keep credentials out of the tool description and model-supplied arguments.Define the smallest response the task needs. The service must validate arguments and authorize access independently of the prompt.
4

Save and inspect

Select Add tool, reopen the resource, and check the persisted request definition. Attach the reviewed tool through the agent’s Tools page, then inspect its ID in the agent draft.

​
Request fields

These fields are under the webhook tool’s api_schema. The outer tool configuration also includes follow_redirects and follow_redirects_allowed_domains. Enabling redirects requires a nonempty allowed-domain list. Review it with the endpoint operator and the current schema. A saved setting is not proof of network-policy enforcement.

​
Frequently asked questions

No. A webhook tool describes an agent-requested HTTP action. Notifications about product events are a separate feature; this guide does not establish event delivery or signature verification.
Define authorization, required confirmation, duplicate-request handling, and a way to inspect an uncertain result in your service. Do not infer those protections from a tool description.