From 8e003c05c5540eb61f4a95ece061f48c79e2cea7 Mon Sep 17 00:00:00 2001 From: Akshit Vaid Date: Fri, 20 Sep 2024 11:47:15 +0530 Subject: [PATCH] Changes applied as per the review comments --- intercom/README.md | 34 +++++++++---------- .../assets/dashboards/intercom_activity.json | 4 +-- .../dashboards/intercom_conversation.json | 4 +-- .../dashboards/intercom_data_event.json | 4 +-- .../assets/dashboards/intercom_news_item.json | 4 +-- .../assets/dashboards/intercom_ticket.json | 2 +- ...rge_number_of_low_rated_conversations.json | 2 +- intercom/manifest.json | 2 +- 8 files changed, 28 insertions(+), 28 deletions(-) diff --git a/intercom/README.md b/intercom/README.md index 9ef18dbc0fa5b..734e07d8372e4 100644 --- a/intercom/README.md +++ b/intercom/README.md @@ -3,7 +3,7 @@ ## Overview [Intercom][1] is a customer communication platform that enables businesses to engage with their users through in-app messaging, email, and chat. It offers features like live chat, automated messaging, and customer support tools, making it easier for companies to provide personalized customer experiences. -The Intercom integration seamlessly collects admin activities, data events, conversations, news items and tickets data and ingests them into Datadog for comprehensive analysis using webhooks. +The Intercom integration seamlessly collects admin activities, data events, conversations, news items, and ticket data, and ingests them into Datadog for comprehensive analysis using webhooks. ## Setup @@ -17,26 +17,26 @@ Configure the Datadog endpoint to forward Intercom events as logs to Datadog. Se - #### Webhook URL generation - Select an existing API key or create a new one by clicking one of the buttons below: - #### Register a new application - - Sign in to your [Intercom][2] account with a user which has full access to Apps and Integrations. - - Go to **Settings**. - - Under the Integrations section, select **Developer Hub**. - - Click on **New app** - - Fill in the required details for your application, such as the name and associated workspace. - - Click **Create app**. + 1. Sign in to your [Intercom][2] account using a user account with full access to Apps and Integrations. + 2. Go to **Settings**. + 3. In the Integrations section, select **Developer Hub**. + 4. Click **New app**. + 5. Fill in the required details for your application, such as the name and associated workspace. + 6. Click **Create app**. - #### Configure webhook topics - - Select Required permissions - - After creating the app, go to the *Authentication* section in the left-hand menu and click on the **Edit** button in the top-right corner. - - By default, all permissions will be enabled, but ensure that the following permissions are specifically enabled: + 1. Select Required permissions + 1. After creating the app, navigate to the *Authentication* section using the left-side menu and click **Edit** button in the upper-right corner. + 2. By default, all permissions are enabled. However, ensure that the following specific permissions are enabled: - Read admins - Read content data - Read conversations - Read events - Read tickets - - Click **Save** - - Select Webhook topics - - Now, go to the Webhooks section present in the left sidebar. - - Enter the endpoint URL that was generated [here](#webhook-url-generation). - - From the dropdown menu labeled **Select a topic**, select the below webhook topics: + 3. Click **Save**. + 2. Select Webhook topics + 1. Next, navigate to the **Webhooks** section using the left-side menu. + 2. Enter the endpoint URL that was generated [here](#webhook-url-generation). + 3. On the **Select a topic** dropdown menu, select the following webhook topics: - admin.activity_log_event.created - content_stat.news_item - conversation.admin.closed @@ -53,13 +53,13 @@ Configure the Datadog endpoint to forward Intercom events as logs to Datadog. Se - ticket.created - ticket.state.updated - ticket.team.assigned - - Click **Save**. + 4. Click **Save**. ## Data Collected ### Logs -The Intercom integration collects and forwards admin activities, tickets, data events, news items and conversation logs to Datadog. +The Intercom integration collects and forwards admin activities, tickets, data events, news items, and conversation logs to Datadog. ### Metrics diff --git a/intercom/assets/dashboards/intercom_activity.json b/intercom/assets/dashboards/intercom_activity.json index a24b74758327f..009b529a7fc79 100644 --- a/intercom/assets/dashboards/intercom_activity.json +++ b/intercom/assets/dashboards/intercom_activity.json @@ -1,6 +1,6 @@ { "title": "Intercom Activity", - "description": "This dashboard provides a comprehensive overview of activities, highlights patterns through frequent and infrequent activities. Additionally, it offers insights into trends with activity logs over time. Detailed activity logs offer an in-depth analysis of all recorded activities.", + "description": "This dashboard provides a comprehensive overview of activities and highlights patterns through frequent and infrequent occurrences. Additionally, it offers insights into trends with activity logs over time. Detailed activity logs provide an in-depth analysis of all recorded activities.", "widgets": [ { "id": 7729356934643914, @@ -25,7 +25,7 @@ "id": 8083967741378144, "definition": { "type": "note", - "content": "**Overview**\n\nThis dashboard offers an overview of activities, highlighting patterns through frequent and infrequent activities. It includes panels for activity by type, email, and location. Trends are captured with activity logs over time, and detailed logs provide data for analysis.\n\nFor more information, see the [Intercom Integration Documentation](https://docs.datadoghq.com/integrations/intercom/).\n\n**Tips**\n- Use the timeframe selector in the top right of the dashboard to change the default timeframe.\n- Clone this dashboard to rearrange, modify and add widgets and visualizations.", + "content": "**Overview**\n\nThis dashboard offers an overview of activities and highlights patterns through frequent and infrequent activities. It includes panels for activity by type, email, and location. Trends are captured with activity logs over time, and detailed logs provide data for analysis.\n\nFor more information, see the [Intercom Integration Documentation](https://docs.datadoghq.com/integrations/intercom/).\n\n**Tips**\n- Use the timeframe selector in the upper-right corner of the dashboard to change the default timeframe.\n- Clone this dashboard to rearrange, modify, and add widgets and visualizations.", "background_color": "white", "font_size": "14", "text_align": "left", diff --git a/intercom/assets/dashboards/intercom_conversation.json b/intercom/assets/dashboards/intercom_conversation.json index 169dddc256a3b..abdca16530060 100644 --- a/intercom/assets/dashboards/intercom_conversation.json +++ b/intercom/assets/dashboards/intercom_conversation.json @@ -1,6 +1,6 @@ { "title": "Intercom Conversation", - "description": "This dashboard provides a comprehensive view of conversation metrics, tracking total conversations, unique ids, and AI-driven interactions. It covers user engagement with read, unread, and priority conversations and monitors admin participation.", + "description": "This dashboard provides a comprehensive view of conversation metrics, tracking total conversations, unique ids, and AI-driven interactions. It covers user engagement with read, unread, and priority conversations, and monitors admin participation.", "widgets": [ { "id": 6225288685694040, @@ -25,7 +25,7 @@ "id": 2170603558098884, "definition": { "type": "note", - "content": "**Overview**\n\nThis dashboard provides a concise view of conversations, with Overview covering total and AI-driven interactions, Status insights, Rating and Remarks for user feedback, Breakdown by attributes, and Logs for conversation history.\n\nFor more information, see the [Intercom Integration Documentation](https://docs.datadoghq.com/integrations/intercom/).\n\n**Tips**\n- Use the timeframe selector in the top right of the dashboard to change the default timeframe.\n- Clone this dashboard to rearrange, modify and add widgets and visualizations.", + "content": "**Overview**\n\nThis dashboard provides a concise view of conversations, with Overview covering total and AI-driven interactions, Status insights, Rating and Remarks for user feedback, Breakdown by attributes, and Logs for conversation history.\n\nFor more information, see the [Intercom Integration Documentation](https://docs.datadoghq.com/integrations/intercom/).\n\n**Tips**\n- Use the timeframe selector in the upper-right corner of the dashboard to change the default timeframe.\n- Clone this dashboard to rearrange, modify, and add widgets and visualizations.", "background_color": "white", "font_size": "14", "text_align": "left", diff --git a/intercom/assets/dashboards/intercom_data_event.json b/intercom/assets/dashboards/intercom_data_event.json index 49c39a74cd7ef..2804a58e4ed28 100644 --- a/intercom/assets/dashboards/intercom_data_event.json +++ b/intercom/assets/dashboards/intercom_data_event.json @@ -1,6 +1,6 @@ { "title": "Intercom Data Event", - "description": "This dashboard offers a detailed analysis of data events, tracking total data events, highlights patterns through frequent and infrequent activities and offers insights into trends with data events over time. Detailed data event logs offer an in-depth analysis of all recorded activities.", + "description": "This dashboard provides a detailed analysis of data events by tracking total data events, highlighting patterns through frequent and infrequent activities, and offering insights into trends with data events over time. Detailed data event logs offer an in-depth analysis of all recorded activities.", "widgets": [ { "id": 7280427532172846, @@ -25,7 +25,7 @@ "id": 3618593347996828, "definition": { "type": "note", - "content": "**Overview**\n\nThis dashboard offers a detailed analysis of data events, tracking total data events, highlights patterns through frequent and infrequent activities and offers insights into trends with data events over time.\n\nFor more information, see the [Intercom Integration Documentation](https://docs.datadoghq.com/integrations/intercom/).\n\n**Tips**\n- Use the timeframe selector in the top right of the dashboard to change the default timeframe.\n- Clone this dashboard to rearrange, modify and add widgets and visualizations.", + "content": "**Overview**\n\nThis dashboard offers a detailed analysis of data events, tracking total data events, highlights patterns through frequent and infrequent activities and offers insights into trends with data events over time.\n\nFor more information, see the [Intercom Integration Documentation](https://docs.datadoghq.com/integrations/intercom/).\n\n**Tips**\n- Use the timeframe selector in the upper-right of the dashboard to change the default timeframe.\n- Clone this dashboard to rearrange, modify and add widgets and visualizations.", "background_color": "white", "font_size": "14", "text_align": "left", diff --git a/intercom/assets/dashboards/intercom_news_item.json b/intercom/assets/dashboards/intercom_news_item.json index c144902c0defb..460f5c54ebf5c 100644 --- a/intercom/assets/dashboards/intercom_news_item.json +++ b/intercom/assets/dashboards/intercom_news_item.json @@ -1,6 +1,6 @@ { "title": "Intercom News Item", - "description": "This dashboard provides a detailed overview of news item insights, tracking total news items and categorizing them by location and publishing method. Additionally, it offers insights into trends with news items and interactions over time, detailed news item logs for thorough tracking and analysis.", + "description": "This dashboard provides a detailed overview of news item insights by tracking the total number of news items and categorizing them by location and publishing method. Additionally, it offers insights into trends in news items and interactions over time, along with detailed news item logs for thorough tracking and analysis.", "widgets": [ { "id": 1783675717862112, @@ -25,7 +25,7 @@ "id": 1627132489943418, "definition": { "type": "note", - "content": "**Overview**\n\nThis dashboard provides a detailed overview of news item insights, tracking total news items and categorizing them by location and publishing method. Additionally, it offers insights into trends with news items and interactions over time, detailed news item logs for thorough tracking and analysis.\n\nFor more information, see the [Intercom Integration Documentation](https://docs.datadoghq.com/integrations/intercom/).\n\n**Tips**\n- Use the timeframe selector in the top right of the dashboard to change the default timeframe.\n- Clone this dashboard to rearrange, modify and add widgets and visualizations.", + "content": "**Overview**\n\nThis dashboard provides a detailed overview of news item insights by tracking the total number of news items and categorizing them by location and publishing method. Additionally, it offers insights into trends in news items and interactions over time, along with detailed news item logs for thorough tracking and analysis.\n\nFor more information, see the [Intercom Integration Documentation](https://docs.datadoghq.com/integrations/intercom/).\n\n**Tips**\n- Use the timeframe selector in the upper-right of the dashboard to change the default timeframe.\n- Clone this dashboard to rearrange, modify and add widgets and visualizations.", "background_color": "white", "font_size": "14", "text_align": "left", diff --git a/intercom/assets/dashboards/intercom_ticket.json b/intercom/assets/dashboards/intercom_ticket.json index 85c5440633518..10fbf8a4cbe2d 100644 --- a/intercom/assets/dashboards/intercom_ticket.json +++ b/intercom/assets/dashboards/intercom_ticket.json @@ -25,7 +25,7 @@ "id": 1695785703283444, "definition": { "type": "note", - "content": "**Overview**\n\nThis dashboard provides a detailed overview of insights related to tickets, tracking total tickets, shared and archived tickets and categorizing them by type and state. Additionally, it includes insights on Tickets by Teammate Assignee ID and Tickets by Team Assignee ID.\n\nFor more information, see the [Intercom Integration Documentation](https://docs.datadoghq.com/integrations/intercom/).\n\n**Tips**\n- Use the timeframe selector in the top right of the dashboard to change the default timeframe.\n- Clone this dashboard to rearrange, modify and add widgets and visualizations.", + "content": "**Overview**\n\nThis dashboard provides a detailed overview of insights related to tickets, tracking total tickets, shared tickets, and archived tickets, and categorizing them by type and state. Additionally, it includes insights on Tickets by Teammate Assignee ID and Tickets by Team Assignee ID.\n\nFor more information, see the [Intercom Integration Documentation](https://docs.datadoghq.com/integrations/intercom/).\n\n**Tips**\n- Use the timeframe selector in the upper-right corner of the dashboard to change the default timeframe.\n- Clone this dashboard to rearrange, modify, and add widgets and visualizations.", "background_color": "white", "font_size": "14", "text_align": "left", diff --git a/intercom/assets/monitors/large_number_of_low_rated_conversations.json b/intercom/assets/monitors/large_number_of_low_rated_conversations.json index 49725604224f0..3f96def7b83dd 100644 --- a/intercom/assets/monitors/large_number_of_low_rated_conversations.json +++ b/intercom/assets/monitors/large_number_of_low_rated_conversations.json @@ -3,7 +3,7 @@ "created_at": "2024-09-18", "last_updated_at": "2024-09-18", "title": "Large Number of Low Rated Conversations", - "description": "The monitor tracks and alerts when a large number of conversations have received low ratings.", + "description": "This monitor tracks and alerts when a large number of conversations receive low ratings.", "definition": { "id": 153714191, "name": "Large Number of Low Rated Conversations", diff --git a/intercom/manifest.json b/intercom/manifest.json index e63931626ff25..1cc5d7e40f439 100644 --- a/intercom/manifest.json +++ b/intercom/manifest.json @@ -8,7 +8,7 @@ "configuration": "README.md#Setup", "support": "README.md#Support", "changelog": "CHANGELOG.md", - "description": "Gain insights into Intercom Admin activities, Data Events, Conversations, News Items and Tickets data.", + "description": "Gain insights into Intercom Admin activities, Data Events, Conversations, News Items, and Ticket data.", "title": "Intercom", "media": [ {