Webhook Actions
A webhook action lets your agent call a web address you control, for example to check stock, look up a booking or create a ticket, and use the result in its answer.
Where to find it
Open your agent, go to Settings, then Webhook Actions. Click Add Action.
Creating an action
| Field | What to enter |
|---|---|
| Action name | Required. Lower-case with underscores, such as check_availability. It must start with a letter and be at most 64 characters. |
| Description | Required. Tell the AI when to use this action. This is what it reads to decide. |
| Webhook URL and method | Required. Your address, and GET, POST, PUT, PATCH or DELETE (default POST). |
| Parameters | The details the AI should collect and send. Each has a name, a type (string, number or boolean), a description and a Required tick. With none, an empty request is sent. |
| Custom headers (optional) | Name and value pairs, for example Authorization and Bearer your-token. They are stored as plain text. |
| Active | Switch off to stop the AI using the action without deleting it. |
Test it
Once you have entered a URL, a Test webhook box appears. Click Send test request to send harmless sample values and see the status and response. Do this before relying on an action.
How visitors experience it
When the AI decides an action is needed, the chat shows "Running: [action name]…". Your system's reply is passed back to the AI, which uses it to answer the visitor.
Rules and safety
- Only public internet addresses are allowed. Addresses on private networks, localhost and similar are refused.
- Requests time out after 10 seconds, redirects are not followed, and only the first 6,000 characters of a response are used.
- Actions work with OpenAI models. Other models cannot run them.
- Put access tokens in a header, never in the description, and use a token that only has the access this action needs.
Tip: Write the description like an instruction to a colleague: "Use this when the customer asks if a class has space. Needs the class name and date."