Webhooks: actions in your systems

Let the agent look things up and take actions: orders, bookings, CRM, tickets and payments.

A webhook is a call from the agent to your system. In prompt mode the AI decides when to call it, from the webhook's description and parameters.

1. Open the agent, go to Webhooks and click New webhook.
2. Give it a clear name, like Order status.
3. Write the description carefully: the AI reads it to decide when to call the webhook. For example: “Look up an order by its number and return its status and expected delivery date.”
4. Enter the method and URL of your API, and any headers it needs (for example an API key).
5. Add parameters: what the AI must find out from the customer before calling, like order_number.
6. For refunds, cancellations or discounts, tick Ask a person first: each call then waits on the Approvals page.
7. Save, then try it on the Test tab.

Enlarge

Related guides