Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Create custom events to monitor

Create custom events and monitor them in the Conversational Analytics dashboard.

Before you begin

Role required: Chat Analytics Admin.

About this task

An event is a combination of conditions that apply to a subset of Virtual Agent (VA) conversations. For example, an event might be conversations originating on a Slack channel that VA transferred to a live agent.

Most metrics you see on the dashboard, for example topic and conversation details, are derived from pre-built events. The dashboard displays these events on the Topics and Conversations tabs. To build custom events, you can use the Custom Events feature. Use custom events to create analytics about data you're interested in, for example:

  • Number of conversations on a Slack channel that transferred to a live agent.
  • Number of conversations on a Slack channel where the user never returned.
Image omitted: dashboard-custom-events-dashboard-2-pae.png
Virtual Agent Custom Events tab.

Custom events appear on the Custom Events tab. If you haven't configured any custom events, the dashboard won't display any. You can create up to 20 custom events.

Custom events take effect when you create them. You cannot use them to analyze data collected before you created the custom event.

Procedure

  1. Navigate to All > Conversational Analytics > Event Configuration and select New.

    The Event New record page appears.

Image omitted: dashboard-event-config-new1.png
Event new record form.
  1. In the form, fill in the fields.

    FieldDescription
    NameCustom event's name.
    TypeChoose Custom. Choosing any other type changes the default behavior of the dashboard and is not recommended. This field specifies the type of event to include in the dashboard analytics.
    Source tableTable of conversations to examine to detect custom events.
    Source Table FilterUse the condition builder to select specific data from the source table.
    Conversation Mapping FieldMaps fields in the source table to fields in another conversation-related table. For example, a channel metadata column in the interaction table can be mapped to the sys ID column of the conversation table. Every event must be mapped to a Conversation ID.
    ActiveSelect the check box to enable the custom event.
    Event TimeSpecifies a time-based event, such as the time VA transferred a chat to a live agent. Selecting this check box opens the Event Time Field.
    Event Time FieldSpecifies the time in an event that you want to monitor, for example, the time a chat was transferred to a live agent. This field appears when you select Event Time.
    Apply Post Fetch FilterEnables you to use a script to filter data that was already filtered by the condition builder, Source Table Filter.
    Post Fetch ScriptText field to enter a script that filters the data that has been filtered by the Source Table Filter. This field appears when you select Apply Post Fetch Filter.
  2. Click Submit.

    The Events page appears, which lists all custom events. You've specified the table to look for custom events. Now, you must specify the parameter values that trigger the custom event.

  3. Click the custom event you created.

  4. In the Event Properties related list, select New.

    The Event Property New Record page appears where you specify the properties for a custom event that you want to track on the dashboard.

Image omitted: dashboard-event-property-new-record.png
Event Property new record form with Value Field selected.
In this example, the **Custom Event** tab shows metrics for **Updated by** for the custom event, Messages-from-Slack.
  1. In the form, fill in the fields.

    FieldDescription
    NameRecord name for the property you want to collect metrics on.
    EventName of the custom event associated with this property.
    AdvancedSelecting this check box opens a text field in which you can enter a script that specifies the field value you want to filter on. Selecting this check box removes the Value Field field.
    Value FieldSpecifies the field you want to collect metrics on.
    ApplicationThe scope of the custom event.
    Event Source TableThe same value for this field you entered on the Event New Record page.
  2. Click Submit.

    The Event page appears.

  3. Click Update.

    The Events page appears, which lists all custom events. You can open the Custom Events tab on the dashboard to see the custom event. This custom event is not retroactive; the dashboard only displays new events that satisfy the custom event criteria.

Parent Topic:Setting up the Conversational Analytics dashboard