Configuration
Action Name
A short, specific identifier that tells the Agent what this action does (e.g. check_order_status, create_support_ticket).
When to Use
A detailed description of what the action does and when it must be used.
When applicable, you can specify one or more of the following:
- Positive cues/phrases: Example utterances and keywords that signal this action (include a few variations).
- Preconditions: What must be true before running.
- Do not use when: Explicit exclusions to avoid false triggers.
Frequency
Specify how often the Agent can invoke this action to avoid overusing it, e.g Once per chat or Whenever applicable.
Input parameters
Define the parameters the Agent must gather before sending the request. The Agent can capture these from user input, existing chat context, or saved contact data.
For each parameter, you can specify the following:
- Name: The name of the parameter. Must start with a letter and contain only letters, numbers, and underscores.
- Description (optional): A description of the parameter to indicate what it is and if applicable, the formatting rules and min/max length.
- Save to variable (optional): The variable where the data can be saved. Applicable when you want to use the data in the HTTP request’s parameters, such as URL, body, headers, etc.
Request
Configure how the HTTP call is made.
- Method: GET, POST, PUT, PATCH, DELETE
- URL: Enter the request URL, such as an API endpoint.
- Query Params (optional): Key-value pairs appended to the URL.
- Body (optional): The request payload which can be passed as form data, form URL encoded, or raw JSON.
- Headers (optional): Data to be sent as the headers of the request, such as Content-Type and Authorization.