Skip to content

Automation

Overview

The Automation section allows administrators to configure actions that users can invoke from chat answers. These actions can send filtered results to external systems through webhooks or deliver them by email. Administrators can also configure recurring schedules and review trigger execution activity.

To access Automation, open Admin and select Automation under Operations.

Action Triggers

The Action triggers tab allows administrators to create trigger cards that users can run from a chat answer. A trigger card defines how the action is delivered, what data is required, and how the result is prepared for the destination.

Creating an Action Trigger

  1. Open Admin and select Automation under Operations.
  2. Select the Action triggers tab.
  3. Click New trigger or Create your first trigger.
  4. Enter the trigger details.
  5. Configure the trigger type and its associated settings.
  6. Review the data requirements, user inputs, action payload, and safety settings.
  7. Click Create card to save the trigger.

Identity

Provide the basic details for the trigger card.

  • Name: Enter a name that identifies the trigger.
  • Description: Optionally describe the purpose of the trigger.

Trigger Type

Select the delivery mechanism for the trigger card.

The available configuration shown in the interface includes:

  • Webhook: Sends a JSON body to an HTTP endpoint using the configured HTTP method.
  • Email: Provides an email-based delivery option.

The fields available in the configuration depend on the selected trigger type.

Chat Context

The Chat context section displays the context associated with the trigger type. In the interface, this section is marked as locked and managed by the selected type.

Webhook Configuration

When the Webhook trigger type is selected, configure the webhook action and request method.

  • Action (webhook): Select an existing webhook action. If no action exists, create one using New.
  • HTTP method: Select the request method. The interface shows POST as the default, with POST, PUT, and PATCH supported by the webhook trigger description.

The webhook action defines the destination and connection settings used to deliver the request.

Data Requirements

The Data requirements section defines the entity, key, and fields associated with the data sent by the trigger.

Entity and Key

  • Entity: Specify the entity represented by the data.
  • ID field: Specify the field that identifies an individual record.

Both fields are required.

Required Fields

Required fields define the data that must be included when the trigger is invoked. The destination depends on the required fields configured for the trigger.

Select Add under Required fields to configure the fields that must be included.

Optional Fields

Optional fields represent columns that chat users can choose to include or exclude when sending the data.

Select Add under Optional fields to configure them.

Resolver Strategy

Select the strategy used to determine the data returned by the trigger.

  • Session filters: Uses the chat's current filters as they are.
  • Measure threshold: Marked as a preview feature in the interface.
  • Custom query: Marked as a preview feature in the interface and described as an administrator-authored query template.

Session filters is the available strategy shown without a preview label.

Limits and Safety

Configure the limits applied when resolving data for a trigger.

  • Row limit: Sets the maximum number of rows the resolver can return. The interface shows 10000 by default.
  • Soft warn above: Sets the row count above which the chat user must acknowledge a warning. The interface shows 2000 by default.
  • Block on empty: When enabled, the trigger refuses to send when no rows are resolved.

Sample Data

The Sample data_records section displays a reference for the data the trigger will send. The sample updates as the configuration changes.

Configure at least one required field to populate the sample.

User Inputs (JSON Schema)

The User inputs (JSON Schema) section defines the fields that chat users fill in when invoking the trigger. The schema is prefilled using the selected trigger type's defaults and can be edited.

Use this section to define the input fields required for the action.

Action Payload (JSON Template)

The Action payload (JSON template) section defines the payload delivered with the action. The rendered payload is included alongside the locked Chat Context under an action key.

For webhook delivery, the payload is included in the POST body. For email delivery, it is used for the subject, message, and recipients.

The template supports the following variable namespaces:

  • ctx.* for chat context.
  • user.* for user information.
  • input.* for values entered by the chat user.
  • trigger.* for trigger information.

For example, the following template includes a campaign name entered by the user:

{
  "campaign_name": "{{input.campaign_name}}"
}

Recurring Schedule

The Schedule (optional) section includes a Run on a recurring schedule toggle. Enable this option when the trigger needs to run on a recurring schedule.

Safety Settings

Configure the execution safeguards for the trigger.

  • Cooldown (sec): Sets the cooldown period between invocations. The interface shows 60 seconds by default.
  • Max invocations / hour: Sets the maximum number of invocations allowed per hour. The interface shows 200 by default.
  • Enabled: Controls whether the trigger is enabled.

Review the configuration and select Create card to save it. Use Cancel to discard the creation process.

Managing Actions

Actions are reusable destinations that trigger cards can reference. The interface supports webhook and email destinations, and indicates that credentials are encrypted at rest.

To manage actions:

  1. Open the Action triggers tab.
  2. Open the additional options menu.
  3. Select Manage actions.
  4. Select Add action to configure a destination.

Creating an Action

The New action form includes the following fields:

  • Name: Name of the action.
  • Trigger type: Select the destination type. The interface shows Webhook (HTTP endpoint) as the default.
  • Base URL: Enter the destination endpoint URL.
  • Use local REST API service: Select this option when configuring the local REST API service.
  • Auth type: Select the authentication type supported by the destination.
  • Default headers (JSON): Enter the default request headers in JSON format.

Review the settings and select Create action to save the destination.

Default Action Context

Default Action Context allows administrators to define the default settings inherited by new trigger cards of a selected type.

To open it, use the additional options menu on the Action triggers page and select Default action context.

Trigger Type

Select the trigger type for which you want to configure defaults. The interface shows Webhook as an available type.

Mandatory Context Schema

The mandatory context schema defines the context sent with every invocation. The interface indicates that the validator checks that a non-empty filter set remains available when the configuration is saved.

The default schema includes context such as:

  • App ID.
  • Dimensions.
  • Measures.
  • Filters.
  • Session ID.
  • Last question.
  • Invoking user.

The schema uses Jinja-style templates, such as {{ctx.filters}}, to insert context values.

Default Action Payload

The default action payload defines the payload template inherited by new trigger cards of the selected type.

For example:

{
  "campaign_name": "{{input.campaign_name}}"
}

Default Input Schema

The default input schema uses JSON Schema to define the fields presented to chat users when invoking a trigger. The interface provides a default schema that administrators can edit.

Saving Changes

  • Save overrides: Saves the configured defaults.
  • Reset to registry default: Restores the registry-provided defaults.
  • Close: Closes the configuration panel.

Activity

The Activity panel displays recent trigger executions, with the newest executions shown first.

To review activity:

  1. Open the Action triggers tab.
  2. Select Activity.
  3. Use the status filter to narrow the results.

The available status filters are:

  • All statuses.
  • Pending.
  • Running.
  • Success.
  • Failed.

The panel displays execution activity after a trigger has been invoked from chat.

Schedules

The Schedules tab displays recurring dashboard emails and scheduled chat actions.

To access schedules:

  1. Open Admin and select Automation under Operations.
  2. Select the Schedules tab.
  3. Use the type filter to narrow the displayed schedules.

The available filters are:

  • All types: Displays all schedule types.
  • Dashboards: Filters for dashboard schedules.
  • Chat: Filters for chat schedules.

The page displays the number of schedules and lists the matching entries when available.