Zendesk Source

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

Setup

Vendor configuration

The Zendesk source requires you to provide the API Token. To generate the API token, refer to the Zendesk documentation.

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.

To configure a Zendesk Source, follow the steps below:

1. In the main Sumo Logic menu, select Manage Data > Collection > Collection.
2. On the Collection page, click Add Source next to a Hosted Collector.
3. Search for and select Zendesk.
4. Enter a Name for the Source. The description is optional.
5. (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.
6. (Optional) Fields. Click the +Add button to define the fields you want to associate. Each field needs a name (key) and value.
   •  A green circle with a check mark is shown when the field exists in the Fields table schema.
   •  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.
7. Base URL. Enter the Base URL value https://{subdomain}.zendesk.com. Replace subdomain with your subdomain value. For example, https://unityd.zendesk.com.
8. Email Address. Enter your Zendesk account email address.
9. API Token. Enter the API Token for authorization collected from the Zendesk platform.
10. 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.
11. 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 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	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 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 field _sourceCategory. See 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

{
	"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"
	}
}

Download example

Terraform example

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"
}

Download example

FAQ

info

Click here for more information about Cloud-to-Cloud sources.