GITBOOK-1185: Omnichannel - Livechat trigger

RocketChat · Nov 26, 2023 · 41480d4 · 41480d4
1 parent dc15409
commit 41480d4
Show file tree

Hide file tree

Showing 13 changed files with 53 additions and 52 deletions.
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -483,15 +483,15 @@
             * [Get Default Business Hour](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/business-hours/get-default-business-hour.md)
             * [Business Hours List](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/business-hours/business-hours-list.md)
           * [Livechat Dashboards](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/dashboards/README.md)
-            * [Get Conversation Metrics](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/dashboards/get-conversation-metrics.md)
-            * [Get Agent Service Time Metrics](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/dashboards/get-agent-service-time-metrics.md)
-            * [Get Chat Metrics](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/dashboards/get-chat-metrics.md)
-            * [Get Chat Metrics by Time](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/dashboards/get-chat-metrics-by-time.md)
-            * [Get Chats Status](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/dashboards/get-chats-status.md)
-            * [Get Chat Status of Agents](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/dashboards/get-chat-status-of-agents.md)
-            * [Get Status of Agents](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/dashboards/get-status-of-agents.md)
-            * [Get Chats Status for Departments](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/dashboards/get-chats-status-for-departments.md)
-            * [Get Chat Times](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/dashboards/get-chat-times.md)
+            * [Get Conversation Metrics](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/dashboards/conversation-totalizers.md)
+            * [Get Agent Service Time Metrics](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/dashboards/agent-productivity-totalizers.md)
+            * [Get Chat Metrics](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/dashboards/chat-totalizers.md)
+            * [Get Chat Metrics by Time](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/dashboards/productivity-totalizers.md)
+            * [Get Chats Status](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/dashboards/chats-chart.md)
+            * [Get Chat Status of Agents](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/dashboards/chats-per-agent-chart.md)
+            * [Get Status of Agents](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/dashboards/agents-statuses-chart.md)
+            * [Get Chats Status for Departments](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/dashboards/chats-per-department-chart.md)
+            * [Get Chat Times](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/dashboards/timings-charts.md)
           * [Livechat Inquiries](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-inquiries/README.md)
             * [Inquiries List](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-inquiries/inquiries-list.md)
             * [Take Inquiry](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-inquiries/take-inquiry.md)
@@ -503,8 +503,8 @@
           * [Livechat Queue](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-queue.md)
           * [Livechat SMS Incoming (Twilio)](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-sms-incoming-twilio.md)
           * [Livechat Triggers](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-triggers/README.md)
-            * [List Livechat Triggers](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-triggers/list-livechat-triggers.md)
-            * [Get a Livechat Trigger](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-triggers/get-a-livechat-trigger.md)
+            * [Get List of Livechat Triggers](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-triggers/get-list-of-livechat-triggers.md)
+            * [Get Livechat Trigger](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-triggers/get-livechat-trigger.md)
           * [Livechat Upload](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-upload.md)
           * [Livechat Monitors](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-monitors/README.md)
             * [Get Monitors](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-monitors/get-monitors.md)

diff --git a/reference/api/rest-api/endpoints/README.md b/reference/api/rest-api/endpoints/README.md
@@ -415,17 +415,17 @@ From version 0.50.0 and on, you can call the methods using `dm` instead of `im`.
 
 #### Livechat Dashboards
 
-| Url                                                                   | Short Description                                       | Details Page                                                                          |
-| --------------------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------- |
-| `api/v1/livechat/analytics/dashboards/conversation-totalizers`        | Retrieves conversation totalizers for a department      | [Link](omnichannel/livechat-endpoints/dashboards/get-conversation-metrics.md)         |
-| `api/v1/livechat/analytics/dashboards/agents-productivity-totalizers` | Retrieves agent productivity totalizer for a department | [Link](omnichannel/livechat-endpoints/dashboards/get-agent-service-time-metrics.md)   |
-| `api/v1/livechat/analytics/dashboards/chats-totalizers`               | Retrieves chat totalizers for a department              | [Link](omnichannel/livechat-endpoints/dashboards/get-chat-metrics.md)                 |
-| `api/v1/livechat/analytics/dashboards/productivity-totalizers`        | Retrieves productivity totalizers for a department      | [Link](omnichannel/livechat-endpoints/dashboards/get-chat-metrics-by-time.md)         |
-| `api/v1/livechat/analytics/dashboards/charts/chats`                   | Retrieves chats chart for a department                  | [Link](omnichannel/livechat-endpoints/dashboards/get-chats-status.md)                 |
-| `api/v1/livechat/analytics/dashboards/charts/chats-per-agent`         | Retrieves chats per agent for a department chart        | [Link](omnichannel/livechat-endpoints/dashboards/get-chat-status-of-agents.md)        |
-| `api/v1/livechat/analytics/dashboards/charts/agents-status`           | Retrieves agent's statuses chart                        | [Link](omnichannel/livechat-endpoints/dashboards/get-status-of-agents.md)             |
-| `api/v1/livechat/analytics/dashboards/charts/chats-per-department`    | Retrieves chats per department chart                    | [Link](omnichannel/livechat-endpoints/dashboards/get-chats-status-for-departments.md) |
-| `api/v1/livechat/analytics/dashboards/charts/timings`                 | Retrieves timing charts                                 | [Link](omnichannel/livechat-endpoints/dashboards/get-chat-times.md)                   |
+| Url                                                                   | Short Description                                       | Details Page                                                                       |
+| --------------------------------------------------------------------- | ------------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| `api/v1/livechat/analytics/dashboards/conversation-totalizers`        | Retrieves conversation totalizers for a department      | [Link](omnichannel/livechat-endpoints/dashboards/conversation-totalizers.md)       |
+| `api/v1/livechat/analytics/dashboards/agents-productivity-totalizers` | Retrieves agent productivity totalizer for a department | [Link](omnichannel/livechat-endpoints/dashboards/agent-productivity-totalizers.md) |
+| `api/v1/livechat/analytics/dashboards/chats-totalizers`               | Retrieves chat totalizers for a department              | [Link](omnichannel/livechat-endpoints/dashboards/chat-totalizers.md)               |
+| `api/v1/livechat/analytics/dashboards/productivity-totalizers`        | Retrieves productivity totalizers for a department      | [Link](omnichannel/livechat-endpoints/dashboards/productivity-totalizers.md)       |
+| `api/v1/livechat/analytics/dashboards/charts/chats`                   | Retrieves chats chart for a department                  | [Link](omnichannel/livechat-endpoints/dashboards/chats-chart.md)                   |
+| `api/v1/livechat/analytics/dashboards/charts/chats-per-agent`         | Retrieves chats per agent for a department chart        | [Link](omnichannel/livechat-endpoints/dashboards/chats-per-agent-chart.md)         |
+| `api/v1/livechat/analytics/dashboards/charts/agents-status`           | Retrieves agent's statuses chart                        | [Link](omnichannel/livechat-endpoints/dashboards/agents-statuses-chart.md)         |
+| `api/v1/livechat/analytics/dashboards/charts/chats-per-department`    | Retrieves chats per department chart                    | [Link](omnichannel/livechat-endpoints/dashboards/chats-per-department-chart.md)    |
+| `api/v1/livechat/analytics/dashboards/charts/timings`                 | Retrieves timing charts                                 | [Link](omnichannel/livechat-endpoints/dashboards/timings-charts.md)                |
 
 #### Livechat Departments
 
@@ -490,10 +490,10 @@ From version 0.50.0 and on, you can call the methods using `dm` instead of `im`.
 
 #### Livechat Triggers
 
-| Url                             | Short Description                  | Details Page                                                                       |
-| ------------------------------- | ---------------------------------- | ---------------------------------------------------------------------------------- |
-| `api/v1/livechat/triggers`      | Lists all Livechat triggers        | [Link](omnichannel/livechat-endpoints/livechat-triggers/list-livechat-triggers.md) |
-| `api/v1/livechat/triggers/:_id` | Retrieves a Livechat Trigger by id | [Link](omnichannel/livechat-endpoints/livechat-triggers/get-a-livechat-trigger.md) |
+| Url                             | Short Description                  | Details Page                                                                              |
+| ------------------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------- |
+| `api/v1/livechat/triggers`      | Lists all Livechat triggers        | [Link](omnichannel/livechat-endpoints/livechat-triggers/get-list-of-livechat-triggers.md) |
+| `api/v1/livechat/triggers/:_id` | Retrieves a Livechat Trigger by id | [Link](omnichannel/livechat-endpoints/livechat-triggers/get-livechat-trigger.md)          |
 
 #### Livechat Upload
 

diff --git a/...hboards/get-agent-service-time-metrics.md → ...shboards/agent-productivity-totalizers.md b/...hboards/get-agent-service-time-metrics.md → ...shboards/agent-productivity-totalizers.md
diff --git a/...points/dashboards/get-status-of-agents.md → ...oints/dashboards/agents-statuses-chart.md b/...points/dashboards/get-status-of-agents.md → ...oints/dashboards/agents-statuses-chart.md
diff --git a/...-endpoints/dashboards/get-chat-metrics.md → ...t-endpoints/dashboards/chat-totalizers.md b/...-endpoints/dashboards/get-chat-metrics.md → ...t-endpoints/dashboards/chat-totalizers.md
diff --git a/...-endpoints/dashboards/get-chats-status.md → ...echat-endpoints/dashboards/chats-chart.md b/...-endpoints/dashboards/get-chats-status.md → ...echat-endpoints/dashboards/chats-chart.md
diff --git a/...s/dashboards/get-chat-status-of-agents.md → ...oints/dashboards/chats-per-agent-chart.md b/...s/dashboards/get-chat-status-of-agents.md → ...oints/dashboards/chats-per-agent-chart.md
diff --git a/...oards/get-chats-status-for-departments.md → .../dashboards/chats-per-department-chart.md b/...oards/get-chats-status-for-departments.md → .../dashboards/chats-per-department-chart.md
diff --git a/...ts/dashboards/get-conversation-metrics.md → ...nts/dashboards/conversation-totalizers.md b/...ts/dashboards/get-conversation-metrics.md → ...nts/dashboards/conversation-totalizers.md
diff --git a/...ts/dashboards/get-chat-metrics-by-time.md → ...nts/dashboards/productivity-totalizers.md b/...ts/dashboards/get-chat-metrics-by-time.md → ...nts/dashboards/productivity-totalizers.md
diff --git a/...at-endpoints/dashboards/get-chat-times.md → ...at-endpoints/dashboards/timings-charts.md b/...at-endpoints/dashboards/get-chat-times.md → ...at-endpoints/dashboards/timings-charts.md
diff --git a/...vechat-triggers/list-livechat-triggers.md → ...triggers/get-list-of-livechat-triggers.md b/...vechat-triggers/list-livechat-triggers.md → ...triggers/get-list-of-livechat-triggers.md
@@ -1,26 +1,26 @@
----
-description: Lists all Livechat triggers.
----
+# Get List of Livechat Triggers
 
-# List Livechat Triggers
+<table><thead><tr><th width="163">HTTP Method</th><th width="332">URL</th><th>Requires Auth</th></tr></thead><tbody><tr><td><code>GET</code></td><td><code>/api/v1/livechat/triggers</code></td><td><a href="../../../authentication-endpoints/">yes</a></td></tr></tbody></table>
 
-&#x20;It supports the [#pagination](../../../../#pagination "mention") parameters.
+{% hint style="info" %}
+Permission required: `view-livechat-manager`
+{% endhint %}
 
-| URL                         | Requires Auth | HTTP Method |
-| --------------------------- | ------------- | ----------- |
-| `/api/v1/livechat/triggers` | `yes`         | `GET`       |
+## Query Parameters
+
+This supports the optional [#pagination](../../../../#pagination "mention") parameters.
 
 ## Example Call
 
-```bash
+```powershell
 curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
      -H "X-User-Id: aobEdbYhXfu5hkeqG" \
      http://localhost:3000/api/v1/livechat/triggers
 ```
 
-## Example Result
+## Example Response
 
-```javascript
+```json
 {
     "triggers": [
         {
@@ -59,5 +59,3 @@ curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
 | Version | Description |
 | ------- | ----------- |
 | 2.2.0   | Added       |
-
-##
diff --git a/...vechat-triggers/get-a-livechat-trigger.md → ...livechat-triggers/get-livechat-trigger.md b/...vechat-triggers/get-a-livechat-trigger.md → ...livechat-triggers/get-livechat-trigger.md
@@ -1,24 +1,28 @@
----
-description: Get a Livechat Trigger by id.
----
+# Get Livechat Trigger
 
-# Get a Livechat Trigger
+Get the details about a specific trigger.
 
-| URL | Requires Auth | HTTP Method |
-| :--- | :--- | :--- |
-| `/api/v1/livechat/triggers/:_id` | `yes` | `GET` |
+<table><thead><tr><th width="163">HTTP Method</th><th width="332">URL</th><th>Requires Auth</th></tr></thead><tbody><tr><td><code>GET</code></td><td><code>/api/v1/livechat/triggers/:_id</code></td><td><a href="../../../authentication-endpoints/">yes</a></td></tr></tbody></table>
+
+{% hint style="info" %}
+Permission required: `view-livechat-manager`
+{% endhint %}
+
+## Path Variables
+
+<table><thead><tr><th width="163">Key</th><th width="285">Example Value</th><th>Description</th></tr></thead><tbody><tr><td><code>_id</code><mark style="color:red;"><code>*</code></mark></td><td><code>Lk52shJFYyb55trw8</code></td><td>The trigger ID.</td></tr></tbody></table>
 
 ## Example Call
 
-```bash
+```powershell
 curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
      -H "X-User-Id: aobEdbYhXfu5hkeqG" \
      http://localhost:3000/api/v1/livechat/triggers/Lk52shJFYyb55trw8
 ```
 
-## Example Result
+## Example Response
 
-```javascript
+```json
 {
     "trigger": {
         "_id": "Lk52shJFYyb55trw8",
@@ -50,6 +54,5 @@ curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
 ## Change Log
 
 | Version | Description |
-| :--- | :--- |
-| 2.2.0 | Added |
-
+| ------- | ----------- |
+| 2.2.0   | Added       |