Zendesk Source Docs

blog-service/2024-09-13-collection.md

@@ -0,0 +1,14 @@
+---
+title: Zendesk C2C Source (Collection)
+image: https://help.sumologic.com/img/sumo-square.png
+keywords:
+  - collection
+  - zendesk
+hide_table_of_contents: true    
+---
+
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
+<a href="https://help.sumologic.com/release-notes-service/rss.xml"><img src={useBaseUrl('img/release-notes/rss-orange2.png')} alt="icon" width="50"/></a>
+
+We're excited to announce the release of our new cloud-to-cloud source for Zendesk. This source helps you to collect audit logs using the [Zendesk API](https://developer.zendesk.com/api-reference/ticketing/account-configuration/audit_logs/) and ingests it into Sumo Logic. [Learn more](/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/zendesk-source).

cid-redirects.json

@@ -2635,6 +2635,7 @@
   "/cid/15632": "/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cloudquery-azure-plugin-source",
   "/cid/15633": "/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cloudquery-source",
   "/cid/14323": "/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/docusign-source",
+  "/cid/14324": "/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/zendesk-source",
   "/cid/14326": "/docs/integrations/global-intelligence/kubernetes-devops",
   "/cid/30001": "/docs/integrations/microsoft-azure/azure-batch",
   "/cid/30002": "/docs/integrations/microsoft-azure/azure-application-gateway",

docs/integrations/product-list/product-list-m-z.md

@@ -219,7 +219,7 @@ For descriptions of the different types of integrations Sumo Logic offers, see [
 | Logo | Vendors and Products | Integrations |
 | :-- | :-- | :-- |
 |  <img src={useBaseUrl('img/integrations/webhooks/zebrium-rcaas-logo.png')} alt="Thumbnail icon" width="50"/>   | [Zebrium](https://www.zebrium.com/)  | Webhook: [Zebrium RCaaS](/docs/integrations/webhooks/zebrium-rcaas/)	 |
-| <img src={useBaseUrl('img/platform-services/automation-service/app-central/logos/zendesk.png')} alt="Thumbnail icon" width="75"/> | [Zendesk](https://www.zendesk.com/) | Automation integration: [Zendesk](/docs/platform-services/automation-service/app-central/integrations/zendesk/) |
+| <img src={useBaseUrl('img/platform-services/automation-service/app-central/logos/zendesk.png')} alt="Thumbnail icon" width="75"/> | [Zendesk](https://www.zendesk.com/) | Automation integration: [Zendesk](/docs/platform-services/automation-service/app-central/integrations/zendesk/) <br/>Collector: [Zendesk Source](/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/zendesk-source/) |
 |  <img src={useBaseUrl('img/integrations/webhooks/zenduty-logo.png')} alt="Thumbnail icon" width="50"/>   |  [Zenduty](https://www.zenduty.com/) | Webhook: [Zenduty](/docs/integrations/webhooks/zenduty/)	 |
 |  <img src={useBaseUrl('img/send-data/zero-networks-icon.png')} alt="Thumbnail icon" width="50"/>   |  [Zero Networks](https://zeronetworks.com/) | Cloud SIEM integration: [Zero Networks](https://github.com/SumoLogic/cloud-siem-content-catalog/blob/master/vendors/3e3c8813-9644-4fd6-9d6f-78bb8ffc5f44.md) <br/>Collector: [Zero Networks Segment Source](/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/zero-networks-segment-source/)	 |
 |  <img src={useBaseUrl('img/integrations/misc/zerofox-logo.png')} alt="Thumbnail icon" width="50"/>   | [ZeroFox](https://www.zerofox.com/) | Automation integration: [ZeroFOX](/docs/platform-services/automation-service/app-central/integrations/zerofox/) <br/> Partner integration: [ZeroFox integration](https://drive.google.com/file/d/13svc5FP0WP3WAES6DvXhK1O8WRiPenf3/edit)	 |

docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/index.md

@@ -447,19 +447,19 @@ In this section, we'll introduce the following concepts:
       </div>
       <div className="box smallbox card">
         <div className="container">
-        <a href="/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/tenable-source"><img src={useBaseUrl('img/send-data/tenable-logo.png')} alt="icon" width="190"/><h4>Tenable</h4></a>
+        <a href="/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/tenable-source"><img src={useBaseUrl('img/send-data/tenable-logo.png')} alt="icon" width="120"/><h4>Tenable</h4></a>
         <p>Learn to ingest audit-log events, vulnerability, and asset data from the Tenable.io APIs.</p>
         </div>
       </div>
       <div className="box smallbox card">
         <div className="container">
-        <a href="/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/trellix-mvisio-epo-source"><img src={useBaseUrl('img/send-data/trellix-logo.png')} alt="icon" width="100"/><h4>Trellix mVision ePO</h4></a>
+        <a href="/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/trellix-mvisio-epo-source"><img src={useBaseUrl('img/send-data/trellix-logo.png')} alt="icon" width="80"/><h4>Trellix mVision ePO</h4></a>
         <p>Learn how to collect event logs using the Trellix mVision ePO.</p>
         </div>
       </div>
       <div className="box smallbox card">
         <div className="container">
-        <a href="/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/webex-source"><img src={useBaseUrl('img/send-data/webex-logo.png')} alt="Thumbnail icon" width="250"/><h4>Webex</h4></a>
+        <a href="/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/webex-source"><img src={useBaseUrl('img/send-data/webex-logo.png')} alt="Thumbnail icon" width="100"/><h4>Webex</h4></a>
         <p>Learn to collect admin audit events using Webex API.</p>
         </div>
       </div>
@@ -471,7 +471,13 @@ In this section, we'll introduce the following concepts:
       </div>
       <div className="box smallbox card">
         <div className="container">
-        <a href="/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/zero-networks-segment-source"><img src={useBaseUrl('img/send-data/zero-networks-icon.png')} alt="Thumbnail icon" width="50"/><h4>Zero Networks Segment</h4></a>
+        <a href="/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/zendesk-source"><img src={useBaseUrl('img/send-data/zendesk-icon.png')} alt="Thumbnail icon" width="80"/><h4>Zendesk</h4></a>
+        <p>Learn to collect audit logs from the Zendesk platform.</p>
+        </div>
+      </div>
+      <div className="box smallbox card">
+        <div className="container">
+        <a href="/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/zero-networks-segment-source"><img src={useBaseUrl('img/send-data/zero-networks-icon.png')} alt="Thumbnail icon" width="45"/><h4>Zero Networks Segment</h4></a>
         <p>Learn to collect audit logs and network activity data from Zero Networks Segment.</p>
         </div>
       </div>

docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/zendesk-source.md

@@ -0,0 +1,90 @@
+---
+id: zendesk-source
+title: Zendesk Source
+sidebar_label: Zendesk
+tags:
+  - cloud-to-cloud
+  - zendesk
+description: Learn how to collect audit logs using the Zendesk API.
+---
+import CodeBlock from '@theme/CodeBlock';
+import ExampleJSON from '/files/c2c/zendesk/example.json';
+import MyComponentSource from '!!raw-loader!/files/c2c/zendesk/example.json';
+import TerraformExample from '!!raw-loader!/files/c2c/zendesk/example.tf';
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
+<img src={useBaseUrl('img/send-data/zendesk-icon.png')} alt="Zendesk-icon" width="70" />
+
+Zendesk is widely used across various industries, including technology, retail, healthcare, education, financial services, and many more. This platform is vital for its ease of use, scalability, and ability to integrate with other business tools and applications. The audit log shows various changes in the Zendesk account since the account was created. Records of these changes are saved indefinitely, and you can view the entire change history. This source collects the audit logs from the Zendesk API and ingests them into Sumo Logic.
+
+## Data collected
+
+| Polling Interval | Data |
+| :--- | :--- |
+| 5 min |  [Audit logs](https://developer.zendesk.com/api-reference/ticketing/account-configuration/audit_logs/) |
+
+## Setup
+
+### Vendor configuration
+
+The Zendesk source requires you to provide the API Token. To generate the API token, refer to the [Zendesk documentation](https://support.zendesk.com/hc/en-us/articles/4408889192858-Managing-access-to-the-Zendesk-API#topic_tcb_fk1_2yb). 
+
+### Source configuration
+
+When you create a Zendesk Source, you add it to a Hosted Collector. Before creating the source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see [Configure a Hosted Collector and Source](/docs/send-data/hosted-collectors/configure-hosted-collector).
+
+To configure a Zendesk Source, follow the steps below:
+1. <!--Kanso [**Classic UI**](/docs/get-started/sumo-logic-ui/). Kanso--> In the main Sumo Logic menu, select **Manage Data > Collection > Collection**. <!--Kanso <br/>[**New UI**](/docs/get-started/sumo-logic-ui-new/). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection** select **Collection**. You can also click the **Go To...** menu at the top of the screen and select **Collection**. Kanso-->
+1. On the Collection page, click **Add Source** next to a Hosted Collector.
+1. Search for and select **Zendesk**.
+1. Enter a **Name** for the Source. The description is optional.
+1. (Optional) For **Source Category**, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called `_sourceCategory`.
+1. (Optional) **Fields**. Click the **+Add** button to define the fields you want to associate. Each field needs a name (key) and value.
+   * ![green check circle.png](/img/reuse/green-check-circle.png) A green circle with a check mark is shown when the field exists in the Fields table schema.
+   * ![orange exclamation point.png](/img/reuse/orange-exclamation-point.png) An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, an option to automatically add the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo Logic that does not exist in the Fields schema it is ignored, known as dropped.
+1. **Base URL**. Enter the Base URL value `https://{subdomain}.zendesk.com`. Replace `subdomain` with your subdomain value. For example, `https://unityd.zendesk.com`.
+1. **Email Address**. Enter your Zendesk account email address. 
+1. **API Token**. Enter the **API Token** for authorization collected from the [Zendesk platform](#vendor-configuration).
+1. The **Polling Interval** is set for 5 minutes by default. You can adjust it based on your needs. This sets how often the Source checks for new data.
+1. When you are finished configuring the Source, click **Save**.
+
+## JSON schema
+
+Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See [How to Use JSON to Configure Sources](/docs/send-data/use-json-configure-sources) for more details. 
+
+| Parameter | Type | Value | Required | Description |
+|:--|:--|:--|:--|:--|
+| schemaRef | JSON Object  | `{"type":"Zendesk"}` | Yes | Define the specific schema type. |
+| sourceType | String | `"Universal"` | Yes | Type of source. |
+| config | JSON Object | [Configuration object](#configuration-object) | Yes | Source type specific values. |
+
+### Configuration Object
+
+| Parameter | Type | Required | Default | Description | Example |
+|:--|:--|:--|:--|:--|:--|
+| name | String | Yes | `null` | Type a desired name of the source. The name must be unique per Collector. This value is assigned to the [metadata](/docs/search/get-started-with-search/search-basics/built-in-metadata) field `_source`. | `"mySource"` |
+| description | String | No | `null` | Type a description of the source. | `"Testing source"`
+| category | String | No | `null` | Type a category of the source. This value is assigned to the [metadata](/docs/search/get-started-with-search/search-basics/built-in-metadata) field `_sourceCategory`. See [best practices](/docs/send-data/best-practices) for details. | `"mySource/test"`
+| fields | JSON Object | No | `null` | JSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field _siemForward to enable forwarding to SIEM.|`{"_siemForward": false, "fieldA": "valueA"}` |
+| baseURL | String | Yes | `null` | Your Zendesk instance domain.  |  |
+| emailId | String | Yes | `null` | Email Address of your account. |  |
+| apiToken | String | Yes | `null` | API Token created for your account in the Zendesk Admin center. |  |
+| pollingInterval | Integer | No | `5 minutes` | Choose how often the Source checks for new data (In minutes). |  |
+
+### JSON example
+
+<CodeBlock language="json">{MyComponentSource}</CodeBlock>
+
+<a href="/files/c2c/zendesk/example.json" target="_blank">Download example</a>
+
+### Terraform example
+
+<CodeBlock language="json">{TerraformExample}</CodeBlock>
+
+<a href="/files/c2c/zendesk/example.tf" target="_blank">Download example</a>
+
+## FAQ
+
+:::info
+Click [here](/docs/c2c/info) for more information about Cloud-to-Cloud sources.
+:::

sidebars.ts

@@ -323,6 +323,7 @@ module.exports = {
                 'send-data/hosted-collectors/cloud-to-cloud-integration-framework/trellix-mvisio-epo-source',
                 'send-data/hosted-collectors/cloud-to-cloud-integration-framework/webex-source',
                 'send-data/hosted-collectors/cloud-to-cloud-integration-framework/workday-source',
+                'send-data/hosted-collectors/cloud-to-cloud-integration-framework/zendesk-source',
                 'send-data/hosted-collectors/cloud-to-cloud-integration-framework/zero-networks-segment-source',
               ],
             },

static/files/c2c/zendesk/example.json

@@ -0,0 +1,16 @@
+{
+	"api.version": "v1",
+	"source": {
+		"config": {
+                "name": "Zendesk",
+                "emailId": "bob123@example.com",
+                "apiToken": "gfygwfihwcboghbuwguwdsyu",
+                "baseURL": "https://sumologic.zendesk.com",
+                "pollingIntervalMin": 5
+		},
+		"schemaRef": {
+            		"type": "Zendesk"
+        	    },
+        	"sourceType": "Universal"
+	}
+}

static/files/c2c/zendesk/example.tf

@@ -0,0 +1,17 @@
+resource "sumologic_cloud_to_cloud_source" "zendesk_source" {
+  collector_id = sumologic_collector.collector.id
+  schema_ref = {
+    type = "Zendesk"
+  }
+  config = jsonencode({
+                "name": "Zendesk",
+                "emailId": "bob123@example.com",
+                "apiToken": "gfygwfihwcboghbuwguwdsyu",
+                "baseURL": "https://sumologic.zendesk.com",
+                "pollingIntervalMin": 5
+  })
+}
+resource "sumologic_collector" "collector" {
+  name        = "my-collector"
+  description = "Just testing this"
+}