Overview
Actions let you define and reuse API/webhook calls to external systems. Think of them as building blocks for your assistant’s advanced capabilities. If your Scenario needs to interact with other tools or systems, you’ll use an API Call Step powered by an Action.When to Use Actions
Use an Action when your assistant needs to:- Trigger a webhook to another app
- Retrieve data from a third-party API
- Update your CRM or lead database
- Schedule, reschedule, or cancel appointments
Creating a New Action
When you add an API Call step to a Scenario, you’ll be prompted to either:- Select an existing Action, or
- Create a new one
Action Configuration Fields
Field | Description |
---|---|
Name | Internal name for the action (e.g. SendToCRM , CheckMembership ); used in the Scenario to trigger this action. |
API Endpoint | The external URL you’re calling (e.g. https://api.yourtool.com/v1/leads ) |
Description | Optional helper text for teammates |
Method | HTTP method: GET , POST , PUT , or DELETE |
Auth Header | Optional authentication header depending on auth type(e.g. x-api-key) |
API Key | API key to authenticate; must be a long-lived API key |
Headers | Key-value pairs for authentication or content-type (e.g. Authorization: Bearer {{org.apiToken}} ) |
Parameters | Request body (for POST /PUT ) or query string (for GET ); add a clear description as the AI Assistant will dynamically determine what values to set each parameter. AI Assistant will wait to call the function until all required parameter values are provided. |
Error Message | What should the AI Assistant say if the API call fails |
You can also pass in custom Assistant attributes. Define these at the Scenario
level and then you can add the value for each Assistant.
Editing or Deleting Actions
Actions can be edited from the Actions Library or from within a Scenario step.- Edits are reflected in all Scenarios that use that Action
- Deletion is permanent and will break any Scenario using it