---
title: Log case assist events
slug: '3437'
canonical_url: https://docs.coveo.com/en/3437/
collection: service
source_format: adoc
---
# Log case assist events
This article lays out the different actions involved in the Case Assist workflow and which [Coveo Analytics events](https://docs.coveo.com/en/260/) to log for each of them.
> **Note**
>
> In the [Coveo for Salesforce](https://docs.coveo.com/en/1404/) environment, use the [Coveo Quantic Case Assist components](https://docs.coveo.com/en/quantic/latest/reference/case-assist-components/), which can simplify your implementation by logging [Coveo Analytics events](https://docs.coveo.com/en/260/) for you.
>
> Outside the Salesforce environment, use the dedicated [Coveo Headless Case Assist controllers](https://docs.coveo.com/en/headless/latest/reference/modules/Case_Assist.html), which can simplify your implementation by logging [events](https://docs.coveo.com/en/260/) and wrapping Customer Service API calls for you.

You must log each user interaction with your Case Assist interface.
For each interaction, specify the action and as much ticket information as possible.
For some [events](https://docs.coveo.com/en/260/), specific action and ticket information is required.
The following summary table lists the action type for each [event](https://docs.coveo.com/en/260/) and, when required, the necessary action and ticket payload parameters, as well as a link to the corresponding implementation guidelines.
[%header,cols="4"]
|===
|Event
|Action type
|Required action payload parameters
|Required ticket payload parameters
|[Enter the interface](#enter-the-interface)
|`ticket_create_start`
|
|
|[Fill a field](#fill-a-field)
|`ticket_field_update`
|`fieldName`
|
|[Rate a document suggestion](#rate-a-document-suggestion)
|`suggestion_rate`
|`rate`, `suggestionId`, `responseId`, `suggestion`
|
|[Select a field suggestion](#select-a-case-classification)
|`ticket_classification_click`
|`classificationId`, `responseId`, `fieldName`, `classification`, `autoSelection`
|
.2+|[Select a document suggestion](#select-a-document-suggestion)
|`documentSuggestionClick` [.footnote]^[[1](#documentSuggestionClick)]^
|`actionCause`, `clientId`, `contentIDKey`, `contentIDValue`, `documentPosition`, `documentTitle`, `documentUrl`, `language`, `originContext`, `originLevel1`, `searchQueryUid`, `sourceName`, `userAgent`
|
|`suggestion_click` (Deprecated)
|`suggestionId`, `responseId`, `suggestion`
|
|[Select document suggestion quick view](#select-the-document-suggestion-quick-view)
|`documentSuggestionQuickview` [footnote]^[[2](#documentSuggestionQuickview)]^
|`actionCause`, `clientId`, `contentIDKey`, `contentIDValue`, `documentPosition`, `documentTitle`, `documentUrl`, `language`, `originContext`, `originLevel1`, `searchQueryUid`, `sourceName`, `userAgent`
|
|[Move to the next step](#move-to-the-next-step)
|`ticket_next_stage`
|
|
|[Submit a ticket](#submit-a-ticket)
|`ticket_create`
|
|`id`
|[Cancel a ticket](#cancel-a-ticket)
|`ticket_cancel`
|`reason`
|
|===
--
1. This action is available as of the [Coveo UA library v2.30.45](https://www.npmjs.com/package/coveo.analytics/v/2.30.45) release.
It replaces the deprecated [`suggestion_click`](#suggestion_click) action.
2. This action is available as of the [Coveo UA library v2.30.45](https://www.npmjs.com/package/coveo.analytics/v/2.30.45) release.
It replaces the `fromQuickview` parameter key in the deprecated [`suggestion_click`](#suggestion_click) action.
--
You should [use the Coveo UA library](#use-the-coveo-ua-library) to log these [events](https://docs.coveo.com/en/260/).
## Use the Coveo UA library
The [Coveo UA library](https://docs.coveo.com/en/1818/) exposes methods that let you log Case Assist [events](https://docs.coveo.com/en/260/) to the [Coveo Analytics](https://docs.coveo.com/en/182/) service.
Once you've [initialized the library](#prerequisite-initialize-the-library), you can log Case Assists [events](https://docs.coveo.com/en/260/) by [registering the Case Assist action](#1-register-a-case-assist-action), [registering the ticket state](#2-register-a-ticket), and [sending the event](#3-send-an-event).
**Example**
A user selects a case classification suggestion.
You tag the action as a `ticket_classification_click` and set the `classificationId`, `responseId`, `fieldName`, `classification`, and `autoSelection` parameters in the action payload.
```javascript
coveoua("svc:setAction", "ticket_classification_click", {
classificationId: "sd8cn3d8-d9n3-s7cb-4knd-d9cnal3njd8c",
responseId: "123e4567-e89b-12d3-a456-426614174000",
fieldName: "category",
classification: {
value: "Electrical",
confidence: 0.76
},
autoSelection: "false"
});
```
You also set the updated ticket data.
```javascript
coveoua("svc:setTicket", {
subject: "GC110 malfunction",
description: "My GC110 electrical panel is cutting off intermittently",
category: "Electrical",
custom: {
visitorAge: 18,
rewardsMember: true
}
});
```
Finally, you send the [event](https://docs.coveo.com/en/260/).
```javascript
coveoua('send', 'event', 'svc', 'click', {'searchHub': 'case_assist_interface'});
```
### (Prerequisite) Initialize the library
To be able to invoke the [Coveo UA library](https://github.com/coveo/coveo.analytics.js), include the following `
```
Where you replace:
* `` with an [API Key](https://docs.coveo.com/en/1718/) that was created using the **Authenticated search** [template](https://docs.coveo.com/en/1718#api-key-templates) or a [search token](https://docs.coveo.com/en/56/) that has the [**Push** access level on the **Analytics Data** domain](https://docs.coveo.com/en/1707#analytics-data-domain) and the [**Allowed** access level on the **Impersonate** domain](https://docs.coveo.com/en/1707#impersonate-domain-analytics).
* `` with the unique identifier of your [Coveo organization](https://docs.coveo.com/en/185/).
This optional argument lets you leverage [your organization analytics endpoint](https://docs.coveo.com/en/mcc80216#analytics-endpoint).
For a HIPAA organization, you would use `\https://.analytics.orghipaa.coveo.com` instead.
### 1: Register a Case Assist action
To set the action, use the `coveoua('svc:setAction', , )` command:
```javascript
coveoua('svc:setAction', 'ticket_classification_click', {
classificationId: "d8cn3d8-d9n3-s7cb-4knd-d9cnal3njd8c",
responseId: "123e4567-e89b-12d3-a456-426614174000",
fieldName: "category",
classification: {
value: "Electrical",
confidence: 0.76
},
autoSelection: "true",
});
```
### 2: Register a ticket
To set the ticket content, use the `coveoua('svc:setTicket', )` command:
```javascript
coveoua('svc:setTicket', {
subject: "GC110 malfunction",
description: "My GC110 electrical panel is cutting off intermittently",
category: "Electrical",
custom: {
visitorAge: 18,
rewardsMember: true
}
});
```
### 3: Send an event
To send an [event](https://docs.coveo.com/en/260/), use the `coveoua('send', 'event', 'svc', , {'searchHub': })` command, where:
. `` can be either of the following:
.. `'flowStart'`: Used when the user enters your Case Assist interface.
.. `'click'`: Used when the user interacts within your Case Assist interface.
. `` (optional) indicates the name or identifier of the Case Assist interface from which the [event](https://docs.coveo.com/en/260/) originates.
When specified, this parameter populates the `originLevel1` [metadata](https://docs.coveo.com/en/218/) of the resulting [event](https://docs.coveo.com/en/260/).
> **Note**
>
> As a best practice, specify the [`searchHub`](https://docs.coveo.com/en/13#operation/searchUsingPost-searchHub).
You don't need to worry about the other three parameters (`send`, `event`, and `svc`), as they don't change in the context of Case Assist.
```javascript
coveoua('send', 'event', 'svc', 'click', {'searchHub': 'case_assist_interface'});
```
## Case Assist events
Log every user interaction in the Case Assist workflow.
For each interaction, specify the action and as much ticket information as possible.
For some [events](https://docs.coveo.com/en/260/), specific action and ticket information is required.
> **Note**
>
> To log a Case Assist event, the [Coveo UA library](https://docs.coveo.com/en/1818/) checks the browser's [local storage](https://docs.coveo.com/en/mbeh0288/) for a [client ID](https://docs.coveo.com/en/lbjf0131/).
> If there's no [client ID](https://docs.coveo.com/en/lbjf0131/) in [local storage](https://docs.coveo.com/en/mbeh0288/), it creates one.
> To optimize [Coveo Analytics reporting](https://docs.coveo.com/en/266/), it's important that all your sources of [events](https://docs.coveo.com/en/260/) use the same [client ID](https://docs.coveo.com/en/lbjf0131/) value.
> For information on how to manage [client IDs](https://docs.coveo.com/en/lbjf0131/), see [Integrate a Coveo ClientIdAccessor Lightning component](https://docs.coveo.com/en/n6jh0013/).
### Enter the interface
When the user enters your Case Assist interface, register a [`ticket_create_start`](#ticket_create_start) action.
If you already have some information on the ticket, provide it in the [ticket payload](#ticket-payload-reference).
```javascript
coveoua("svc:setAction", "ticket_create_start");
coveoua("svc:setTicket", {
custom: {
"visitorAge": 18,
"rewardsMember": true
}
});
coveoua("send", "event", "svc", "flowStart", {"searchHub": "case_assist_interface"});
```
### Fill a field
If the user fills a [field](https://docs.coveo.com/en/200/), register a [`ticket_field_update`](#ticket_field_update) action and specify the updated ticket information in the [ticket payload](#ticket-payload-reference).
```javascript
coveoua("svc:setAction", "ticket_field_update", {
fieldName: "category"
});
coveoua("svc:setTicket", {
category: "Electrical",
custom: {
"visitorAge": 18,
"rewardsMember": true
}
});
coveoua("send", "event", "svc", "click", {"searchHub": "case_assist_interface"});
```
### Rate a document suggestion
If the user rates a document suggestion, register a [`suggestion_rate`](#suggestion_rate) action and provide all available ticket information in the [ticket payload](#ticket-payload-reference).
```javascript
coveoua("svc:setAction", "suggestion_rate", {
rate: 0.75,
suggestionId: "0064770b2e4788f42dfd277b384c6e24cef82b04",
responseId: "7d8f0s7d-8fhd-3jdh-897f-d79skdnf7g3l",
suggestion: {
documentUriHash: "gizDGrXcVñbV7mñy",
documentTitle: "GC3000 Series Propane Generator Ignition",
documentUrl: "http://www.salesforce.com/org:organization/object:Solution/record:5013h000000tPmnAAE",
documentPosition: 1
}
});
coveoua("svc:setTicket", {
category: "Electrical",
custom: {
"visitorAge": 18,
"rewardsMember": true
}
});
coveoua("send", "event", "svc", "click", {"searchHub": "case_assist_interface"});
```
### Select a case classification
If the user selects a case classification that you provided, register a [`ticket_classification_click`](#ticket_classification_click) action and specify the updated ticket information in the [ticket payload](#ticket-payload-reference).
```javascript
coveoua("svc:setAction", "ticket_classification_click", {
classificationId: "d8cn3d8-d9n3-s7cb-4knd-d9cnal3njd8c",
responseId: "123e4567-e89b-12d3-a456-426614174000",
fieldName: "category",
classification: {
value: "Electrical",
confidence: 0.76
},
autoSelection: "false",
});
coveoua("svc:setTicket", {
subject: "GC110 malfunction",
description: "My GC110 electrical panel is cutting off intermittently",
category: "Electrical",
custom: {
visitorAge: 18,
rewardsMember: true
}
});
coveoua("send", "event", "svc", "click", {"searchHub": "case_assist_interface"});
```
### Select a document suggestion
If the user selects a document suggestion that you provided, send a [`documentSuggestionClick`](#documentsuggestionclick) action.
> **Important**
>
> The [`documentSuggestionClick`](#documentsuggestionclick) action, which is a [Coveo Analytics](https://docs.coveo.com/en/182/) click event, is available as of the [Coveo UA library v2.30.45](https://www.npmjs.com/package/coveo.analytics/v/2.30.45) release.
> It replaces the deprecated [`suggestion_click`](#suggestion_click) action.
```javascript
coveoua('send', 'click',
{
anonymous: false,
clientId: "489aa3e3-aed2-4563-8e81-62bb73178a56",
actionCause: "documentSuggestionClick",
documentPosition: 2,
documentTitle: "GC3000 Series Propane Generator Ignition",
documentUrl: "http://www.salesforce.com/org:organization/object:Solution/record:5013h000000tPmnAAE",
language: "en",
originContext: "CaseAssist",
originLevel1: "CaseAssistFlow",
originLevel2: "default",
searchQueryUid: "df60b2fb-c276-49ae-b704-2ee45609f3a6",
sourceName: "AnswersCloud",
userAgent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.181 Safari/537.36",
customData: {
contentIDKey: "permanentid",
contentIDValue: "648a63d6a19545297692b4ae41a7d5e947c711be5f3c23dff69af3106960"
}
});
```
### Select the document suggestion quick view
If the user selects the document suggestion quick view button, send a [`documentSuggestionQuickview`](#documentsuggestionquickview) action.
> **Important**
>
> The [`documentSuggestionQuickview`](#documentsuggestionquickview) action, which is a [Coveo Analytics](https://docs.coveo.com/en/182/) click event, is available as of the [Coveo UA library v2.30.45](https://www.npmjs.com/package/coveo.analytics/v/2.30.45) release.
> It replaces the `fromQuickview` parameter key in the deprecated [suggestion_click](#suggestion_click) action.
```javascript
coveoua('send', 'click',
{
anonymous: false,
clientId: "489aa3e3-aed2-4563-8e81-62bb73178a56",
actionCause: "documentSuggestionQuickview",
documentPosition: 2,
documentTitle: "GC3000 Series Propane Generator Ignition",
documentUrl: "http://www.salesforce.com/org:organization/object:Solution/record:5013h000000tPmnAAE",
language: "en",
originContext: "CaseAssist",
originLevel1: "CaseAssistFlow",
originLevel2: "default",
searchQueryUid: "df60b2fb-c276-49ae-b704-2ee45609f3a6",
sourceName: "AnswersCloud",
userAgent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.181 Safari/537.36",
customData: {
contentIDKey: "permanentid",
contentIDValue: "648a63d6a19545297692b4ae41a7d5e947c711be5f3c23dff69af3106960"
}
});
```
### Move to the next step
If the user moves to the next page of your case creation flow, register a [`ticket_next_stage`](#ticket_next_stage) action and specify all available ticket information in the [ticket payload](#ticket-payload-reference).
```javascript
coveoua("svc:setAction", "ticket_next_stage");
coveoua("svc:setTicket", {
category: "Electrical",
custom: {
"visitorAge": 18,
"rewardsMember": true
}
});
coveoua("send", "event", "svc", "click", {"searchHub": "case_assist_interface"});
```
### Cancel a ticket
If the user cancels their ticket creation, register a [`ticket_cancel`](#ticket_cancel) action.
Provide all available ticket information in the [ticket payload](#ticket-payload-reference).
```javascript
coveoua("svc:setAction", "ticket_cancel", {
reason: "Solved"
});
coveoua("svc:setTicket", {
subject: "GC110 malfunction",
description: "My GC110 electrical panel is cutting off intermittently",
category: "Electrical",
custom: {
visitorAge: 18,
rewardsMember: true
}
});
coveoua("send", "event", "svc", "click", {"searchHub": "case_assist_interface"});
```
### Submit a ticket
If the user creates a ticket, register a [`ticket_create`](#ticket_create) action and specify all available ticket information in the [ticket payload](#ticket-payload-reference).
In particular, specify the `id` in the ticket payload.
```javascript
coveoua("svc:setAction", "ticket_create");
coveoua("svc:setTicket", {
subject: "GC110 malfunction",
description: "My GC110 electrical panel is cutting off intermittently",
category: "Electrical",
id: "5003000000D8cuI",
custom: {
visitorAge: 18,
rewardsMember: true
}
});
coveoua("send", "event", "svc", "click", {"searchHub": "case_assist_interface"});
```
## Case Assist actions reference
### `ticket_create_start`
When the user enters your Case Assist interface.
### `ticket_field_update`
When the user fills a [field](https://docs.coveo.com/en/200/).
Payload:
* `fieldName` (String, Required)
The name of the [field](https://docs.coveo.com/en/200/) updated by the user.
### `suggestion_rate`
When the user rates a document suggestion you provide.
Payload:
* `rate` (Float between `0` and `1`, Required)
The rating of the document suggestion, where `0` means terrible and `1` means perfect.
* `suggestionId` (String, Required)
The permanent identifier (`fields.permanentid` in the Service API response) of the rated document.
* `responseId` (String, Required)
The unique identifier (`responseId` in the Service API response) of the document suggestion response.
* `suggestion` (Object, Required)
The object describing the selected suggestion.
It contains the following parameters:
** `documentUriHash` (String, Required)
> **Important - Deprecated parameter**
>
> Deprecated, covered by `documentUrl` instead.
The hashed URI of the selected document.
** `documentUrl` (String, Required)
The URL of the selected document.
** `documentTitle` (String, Required)
The title of the selected document.
** `documentPosition` (Integer greater than or equal to `1`, Required)
The 1-based position of the selected document in the array of suggested documents.
### `ticket_classification_click`
When the user selects a case classification.
Payload:
* `classificationId` (String, Required)
The unique identifier (`id` in the Service API response) of the selected case classification suggestion.
* `responseId` (String, Required)
The unique identifier (`responseId` in the Service API response) of the case classification response.
* `fieldName` (String, Required)
The name of the [field](https://docs.coveo.com/en/200/) for which the user selected a classification.
* `classification` (Object, Required)
The object which describes the selected classification suggestion.
If provided, this object must contain the following parameters:
** `value` (String, Required)
The [field](https://docs.coveo.com/en/200/) value of the selected classification suggestion.
** `confidence` (Float between `0` and `1`, Required)
The `confidence` value of the selected classification suggestion.
* `autoSelection` (Boolean, Required)
A flag indicating whether the update was triggered by an automatic selection.
For example, if a value is automatically selected because it has the highest confidence, set this parameter to `true`.
### `documentSuggestionClick`
> **Important**
>
> This action is a [Coveo Analytics](https://docs.coveo.com/en/182/) click event.
> It's available as of the [Coveo UA library v2.30.45](https://www.npmjs.com/package/coveo.analytics/v/2.30.45) release, and it replaces the deprecated [`suggestion_click`](#suggestion_click) action.
When the user selects a document suggestion.
Payload:
> **Tip**
>
> See [Log click events](https://docs.coveo.com/en/2064/) for more information about the following payload parameters.
* `actionCause` (String, Required)
The identifier of the user action that caused the search interface to log a click event, for example, if the user selects the document suggestion quick view button, the `actionCause` would be `documentSuggestionQuickview`.
* `clientId` (String, Required)
A Globally Unique Identifier (GUID) which represents the current user.
See [What's the clientId?](https://docs.coveo.com/en/masb0234/) for details.
* `contentIDKey` (String, Required)
The name of a field in the index that uniquely identifies the item.
* `contentIDValue` (String, Required)
The value of the field selected as `contentIDkey`.
* `documentPosition` (Integer greater or equal to `1`, Required)
The 1-based position of the selected document in the array of suggested documents.
* `documentTitle` (String, Required)
The title of the selected document.
* `documentUrl` (String, Required)
The URL of the selected document.
* `language` (String, Required)
The language of the search interface from which the click event originates.
* `originContext` (String, Optional)
The origin of the event.
Used to specify the deployment from which the user performs the action.
**Example**
```javascript
{
...
originContext: "CaseAssist",
...
}
```
* `originLevel1` (String, Required)
The name or identifier of the search interface from which the event originates.
If unspecified and the request is authenticated with a search token, the service tries to extract the [search hub](https://docs.coveo.com/en/1342/) value from the access token that authenticated the request to log a search event.
* `originLevel2` (String, Optional)
The name or identifier of the [tab](https://docs.coveo.com/en/1406/) from which the click event originates.
* `originLevel3` (String, Optional)
The URL of the page that redirected the browser to the search interface from which the click event originates (that is, `document.referrer`).
* `searchQueryUid` (String, Required)
The unique identifier (`responseId` in the Service API response) of the query that caused the Case Assist interface to log a click event.
* `sourceName` (String, Required)
The `@source` of the document that was clicked.
* `userAgent` (String, Required)
Information about the browser and operating system of the user who caused the search interface to log a click event.
### `suggestion_click`
> **Important**
>
> Deprecated.
> As of the [Coveo UA library v2.30.45](https://www.npmjs.com/package/coveo.analytics/v/2.30.45) release, this action has been replaced by the [`documentSuggestionClick`](#documentsuggestionclick) action.
When the user selects a suggestion.
Payload:
* `suggestionId` (String, Required)
The permanent identifier (`fields.permanentid` in the Service API response) of the selected document.
* `responseId` (String, Required)
The unique identifier (`responseId` in the Service API response) of the document suggestion response.
* `suggestion` (Object - Required)
The object describing the selected suggestion.
It contains the following parameters:
** `documentUriHash` (String, Required)
> **Important - Deprecated parameter**
>
> Deprecated, covered by `documentUrl` instead.
The hashed URI of the selected document.
** `documentUrl` (String, Required)
The URL of the selected document.
** `documentTitle` (String, Required)
The title of the selected document.
** `documentPosition` (Integer greater or equal to `1`, Required)
The 1-based position of the selected document in the array of suggested documents.
** `fromQuickview` (Boolean, Optional)
> **Important**
>
> Deprecated.
> As of the [Coveo UA library v2.30.45](https://www.npmjs.com/package/coveo.analytics/v/2.30.45) release, this parameter key has been replaced by the [documentSuggestionQuickview](#documentsuggestionquickview) action.
Whether the user selected the document suggestion quick view button.
### `documentSuggestionQuickview`
> **Important**
>
> This action is a [Coveo Analytics](https://docs.coveo.com/en/182/) click event.
> It's available as of the [Coveo UA library v2.30.45](https://www.npmjs.com/package/coveo.analytics/v/2.30.45) release, and it replaces the `fromQuickview` parameter key in the deprecated [suggestion_click](#suggestion_click) action.
When a user selects the document suggestion quick view button.
Payload:
> **Tip**
>
> See [Log click events](https://docs.coveo.com/en/2064/) for more information about the following payload parameters.
* `actionCause` (String, Required)
The identifier of the user action that caused the search interface to log a click event, for example, if the user selects the document suggestion quick view button, the `actionCause` would be `documentSuggestionQuickview`.
* `clientId` (String, Required)
A Globally Unique Identifier (GUID) which represents the current user.
See [What's the clientId?](https://docs.coveo.com/en/masb0234/) for details.
* `contentIDKey` (String, Required)
The name of a field in the index that uniquely identifies the item.
* `contentIDValue` (String, Required)
The value of the field selected as `contentIDkey`.
* `documentPosition` (Integer greater or equal to `1`, Required)
The 1-based position of the selected document in the array of suggested documents.
* `documentTitle` (String, Required)
The title of the selected document.
* `documentUrl` (String, Required)
The URL of the selected document.
* `language` (String, Required)
The language of the search interface from which the click event originates.
* `originContext` (String, Optional)
The origin of the event.
Used to specify the deployment from which the user performs the action.
**Example**
```javascript
{
...
originContext: "CaseAssist",
...
}
```
* `originLevel1` (String, Required)
The name or identifier of the search interface from which the event originates.
If unspecified and the request is authenticated with a search token, the service tries to extract the [search hub](https://docs.coveo.com/en/1342/) value from the access token that authenticated the request to log a search event.
* `originLevel2` (String, Optional)
The name or identifier of the [tab](https://docs.coveo.com/en/1406/) from which the click event originates.
* `originLevel3` (String, Optional)
The URL of the page that redirected the browser to the search interface from which the click event originates (that is, `document.referrer`).
* `searchQueryUid` (String, Required)
The unique identifier (`responseId` in the Service API response) of the query that caused the Case Assist interface to log a click event.
* `sourceName` (String, Required)
The `@source` of the document that was clicked.
* `userAgent` (String, Required)
Information about the browser and operating system of the user who caused the search interface to log a click event.
### `ticket_next_stage`
When the user proceeds to the next stage in your Case Assist interface.
### `ticket_cancel`
When the user cancels the ticket they were creating.
Payload:
* `reason` (String, Required)
Possible values:
** `"Quit"`: When the user simply cancels or leaves the interface.
** `"Solved"`: When the user cancels after clicking a button to the effect that they have solved their case.
### `ticket_create`
When the user creates the ticket.
There's no action payload to log, but be sure to log the `id` in the ticket payload.
## Ticket payload reference
### `category` (String, Optional)
The category of the support case.
```txt
"Electrical"
```
### `custom` (Object, Optional)
A custom object containing parameters of your choice.
```json
{
"visitorAge": 18,
"rewardsMember": true
}
```
### `description` (Object, Optional)
The description of the support case.
```txt
"My GC110 electrical panel is cutting off intermittently"
```
### `subject` (String, Optional)
The subject of the support case.
```txt
"GC110 malfunction"
```
### `id` (String, Optional)
Required when registering a `ticket_create` action.
The unique identifier of the created ticket.
```txt
"5003000000D8cuI"
```
## What's next?
* For information on how to manage [client IDs](https://docs.coveo.com/en/lbjf0131/), see [Integrate a Coveo ClientIdAccessor Lightning component](https://docs.coveo.com/en/n6jh0013/).
* For information on how to generate a Case Assist [dashboard](https://docs.coveo.com/en/256/) based on the standard [Case Assist events](#case-assist-events), see [Generate Case Assist reports](https://docs.coveo.com/en/l45l0380/).