# Zendesk Support ## Pipeline Concepts Before setting up the Pipeline, learn about Pipeline concepts [here](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines) ## Step by Step Guide ### STEP-1: Configure Connection To learn about Connection, refer [here](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines) * Log into Sprinkle application * Navigate to Ingest -> Connections Tab -> New Connection -> * Select Zendesk Support * Provide all the mandatory details * *Name*: Name to identify this connection * *Sub Domain*: Only Give {SUBDOMAIN}. For ex:- https\://{SUBDOMAIN}.zendesk.com * *Email Id:* Give Email ID connected to your zendesk account * *API Token:* API token for zendesk account.\ (Refer the link to generate API Token - [https://support.zendesk.com/hc/en-us/articles/4408889192858-Generating-a-new-API-token )](https://support.zendesk.com/hc/en-us/articles/4408889192858-Generating-a-new-API-token) * *Advance Settings:* Refer [here](#advanced-connection-setting) * Test Connection * Create ### STEP-2: Configure Pipeline To learn about Pipeline, refer [here](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines) * Navigate to Ingest -> Pipeline Tab -> Add -> * Select Zendesk Support * Provide the name -> Create * **Connection Tab**: * From the drop-down, select the name of connection created in STEP-2 * Update ### STEP-3: Create Dataset **Datasets Tab**: To learn about Dataset, refer[ here](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines). Add Dataset for each report/dataset that you want to integrate, providing following details * *Report Type* (Required): Select from the drop-down: * *Groups* * *Group\_Memberships* * *Organizations* * *Organization\_Memberships* * *Satisfaction\_Ratings* * *Macros* * *Tickets* * *Suspended\_Tickets* * *Ticket\_Metrics* * *Ticket\_Fields* * *Target\_Failures* * *Tags* * *Brands* * *Views* * *Triggers* * *Automations* * *Targets* * *Apps* * *Sharing\_Agreements* * Flatten Level(Required) : Select One Level or Multi Level. In one level, flattening will not be applied on complex type. They will be stored as string. In multi level, flattening will be applied in complex level till they become simple type. * *Destination Schema* (Required) : Data warehouse schema where the table will be ingested into * *Destination Table name* (Required) : It is the table name to be created on the warehouse. If not given, sprinkle will create like ds\_\\_\ * *Destination Create Table Clause*: Provide additional clauses to warehouse-create table queries such as clustering, partitioning, and more, useful for optimizing DML statements. [Learn more](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines/databases/features/destination-create-table-clause) on how to use this field. * Create ### STEP-4: Run and schedule Ingestion In the **Ingestion Jobs** tab**:** * Trigger the Job, using Run button * To schedule, enable Auto-Run. Change the frequency if needed ### Advanced Connection Setting * **API Read Timeout (In seconds) :** Maximum time of inactivity between two data packets when waiting for the server's response. The default value is 30 seconds * **API Connection Timeout (In seconds) :** Time period within which a connection between a client and a server must be established. * **Retry Limit :** Number of retries allowed when an API call fails. For example if an API call fails and retry limit is 5 then it will check 5 times for that API call and if it succeeded then it will stop checking**.** * **Retry Sleep Time (In milliseconds) :** Given time, after which retry should happen in case an API call fails. * **API Delay Time (In milliseconds) :** The time difference (in milliseconds) between two successive API calls. * **Version :** it gives information about the version of Zendesk Support API being used. ### Dataset Fields
Groups * url * id * is\_public * name * description * default * deleted * created\_at * updated\_at
Group_Memberships * url * id * user\_id * group\_id * default * created\_at * updated\_at
Organizations * url * id * name * shared\_tickets * shared\_comments * created\_at * updated\_at * domain\_names * tags * organization\_fields
Organization_Memberships * url * id * user\_id * organization\_id * default * created\_at * organization\_name * updated\_at * view\_tickets
Satisfaction_Ratings * assignee\_id * comment * created\_at * group\_id * id * reason * reason\_code * requester\_id * score * ticket\_id * updated\_at * url
Macros * url * id * title * active * updated\_at * created\_at * position * actions\_0\_\_field * actions\_0\_\_value * actions\_1\_\_field * actions\_1\_\_value * actions\_2\_\_field * actions\_2\_\_value * actions\_3\_\_field * actions\_3\_\_value * actions\_4\_\_field * actions\_4\_\_value * actions\_5\_\_field * actions\_5\_\_value
Tickets * url * id * via\_channel * via\_source\_from * via\_source\_to * created\_at * updated\_at * type * subject * raw\_subject * description * priority * status * requester\_id * submitter\_id * assignee\_id * group\_id * collaborator\_ids * follower\_ids * email\_cc\_ids * has\_incidents * is\_public * tags\_0\_ * tags\_1\_ * tags\_2\_ * custom\_fields * sharing\_agreement\_ids * fields * followup\_ids * ticket\_form\_id * brand\_id * allow\_channelback * allow\_attachments
Suspended_Tickets * attachments * author * brand\_id * cause * cause\_id * content * created\_at * error\_messages * id * message\_id * recipient * subject * tickey\_id * updated\_at * url * via
Ticket_Metrics * url * id * ticket\_id * created\_at * updated\_at * group\_stations * assignee\_stations * reopens * replies * assignee\_updated\_at * requester\_updated\_at * status\_updated\_at * initially\_assigned\_at * assigned\_at * latest\_comment\_added\_at * reply\_time\_in\_minutes * first\_resolution\_time\_in\_minutes * full\_resolution\_time\_in\_minutes * agent\_wait\_time\_in\_minutes * requester\_wait\_time\_in\_minutes * on\_hold\_time\_in\_minutes\_calendar * on\_hold\_time\_in\_minutes\_business
Ticket_Fields * url * id * type * title * raw\_title * description * raw\_description * position * active * required * collapsed\_for\_agents * title\_in\_portal * raw\_title\_in\_portal * visible\_in\_portal * editable\_in\_portal * required\_in\_portal * created\_at * updated\_at * removable * system\_field\_options\_0\_\_name * system\_field\_options\_0\_\_value * system\_field\_options\_1\_\_name * system\_field\_options\_1\_\_value * system\_field\_options\_2\_\_name * system\_field\_options\_2\_\_value * sub\_type\_id * system\_field\_options\_3\_\_name * system\_field\_options\_3\_\_value
Target_Failures * consecutive*failure*count * created\_at * id * raw\_request * raw\_response * status\_code * target\_name * url
Tags * name * count
Brands * url * id * name * brand\_url * subdomain * has\_help\_center * help\_center\_state * active * default * is\_deleted * ticket\_form\_ids\_0\_ * signature\_template * created\_at * updated\_at
Views * url * id * title * active * updated\_at * created\_at * position * execution\_group\_by * execution\_group\_order * execution\_sort\_by * execution\_sort\_order * execution\_group\_id * execution\_group\_title * execution\_sort\_id * execution\_sort\_title * execution\_columns\_0\_\_id * execution\_columns\_0\_\_title * execution\_columns\_1\_\_id * execution\_columns\_1\_\_title * execution\_columns\_2\_\_id * execution\_columns\_2\_\_title * execution\_columns\_3\_\_id * execution\_columns\_3\_\_title * execution\_columns\_4\_\_id * execution\_columns\_4\_\_title * execution\_fields\_0\_\_id * execution\_fields\_0\_\_title * execution\_fields\_1\_\_id * execution\_fields\_1\_\_title * execution\_fields\_2\_\_id * execution\_fields\_2\_\_title * execution\_fields\_3\_\_id * execution\_fields\_3\_\_title * execution\_fields\_4\_\_id * execution\_fields\_4\_\_title * execution\_custom\_fields * conditions\_all\_0\_\_field * conditions\_all\_0\_\_operator * conditions\_all\_0\_\_value * conditions\_all\_1\_\_field * conditions\_all\_1\_\_operator * conditions\_all\_1\_\_value * conditions\_any * watchable * raw\_title * execution\_columns\_5\_\_id * execution\_columns\_5\_\_title * execution\_fields\_5\_\_id * execution\_fields\_5\_\_title * conditions\_all\_2\_\_field * conditions\_all\_2\_\_operator * conditions\_all\_2\_\_value
Triggers * url * id * title * active * updated\_at * created\_at * actions\_0\_\_field * actions\_0\_\_value\_0\_ * actions\_0\_\_value\_1\_ * actions\_0\_\_value\_2\_ * conditions\_all\_0\_\_field * conditions\_all\_0\_\_operator * conditions\_all\_0\_\_value * conditions\_any * position * raw\_title * category\_id * conditions\_all\_1\_\_field * conditions\_all\_1\_\_operator * conditions\_all\_1\_\_value * conditions\_all\_2\_\_field * conditions\_all\_2\_\_operator * conditions\_all\_2\_\_value * conditions\_all\_3\_\_field * conditions\_all\_3\_\_operator * conditions\_all\_4\_\_field * conditions\_all\_4\_\_operator * conditions\_all\_4\_\_value * conditions\_any\_0\_\_field * conditions\_any\_0\_\_operator * conditions\_any\_0\_\_value * conditions\_any\_1\_\_field * conditions\_any\_1\_\_operator * conditions\_any\_1\_\_value * conditions\_all\_3\_\_value * description actions\_0\_\_value
Automations * url * id * title * active * updated\_at * created\_at * actions\_0\_\_field * actions\_0\_\_value * conditions\_all\_0\_\_field * conditions\_all\_0\_\_operator * conditions\_all\_0\_\_value * conditions\_all\_1\_\_field * conditions\_all\_1\_\_operator * conditions\_all\_1\_\_value * conditions\_any * position * raw\_title * actions\_0\_\_value\_0\_ * actions\_0\_\_value\_1\_ * actions\_0\_\_value\_2\_
Targets * active * created\_at * id * title * type
Apps * id * name * state * version * framework\_version * parameters\_0\_\_id * parameters\_0\_\_app\_id * parameters\_0\_\_name * parameters\_0\_\_kind * parameters\_0\_\_required * parameters\_0\_\_position * parameters\_0\_\_created\_at * parameters\_0\_\_updated\_at * parameters\_0\_\_secure * parameters\_1\_\_id * parameters\_1\_\_app\_id * parameters\_1\_\_name * parameters\_1\_\_kind * parameters\_1\_\_required * parameters\_1\_\_position * parameters\_1\_\_created\_at * parameters\_1\_\_updated\_at * parameters\_1\_\_secure * parameters\_2\_\_id * parameters\_2\_\_app\_id * parameters\_2\_\_name * parameters\_2\_\_kind * parameters\_2\_\_required * parameters\_2\_\_position * parameters\_2\_\_created\_at * parameters\_2\_\_updated\_at * parameters\_2\_\_default\_value * parameters\_2\_\_secure * parameters\_3\_\_id * parameters\_3\_\_app\_id * parameters\_3\_\_name * parameters\_3\_\_kind * parameters\_3\_\_required * parameters\_3\_\_position * parameters\_3\_\_created\_at * parameters\_3\_\_updated\_at * parameters\_3\_\_default\_value * parameters\_3\_\_secure * plans\_0\_\_id * plans\_0\_\_entity\_id * plans\_0\_\_app\_id * plans\_0\_\_amount * plans\_0\_\_description * plans\_0\_\_plan\_type * plans\_0\_\_cost\_id * plans\_0\_\_cost\_type * plans\_0\_\_active * plans\_0\_\_created\_at * plans\_0\_\_updated\_at * plans\_0\_\_trial\_days * rating\_total\_count * rating\_average * rating\_count\_3 * rating\_count\_5 * rating\_count\_4 * rating\_count\_1 * rating\_count\_2 * single\_install * default\_locale * feature\_color * products\_0\_ * categories\_0\_\_id * categories\_0\_\_name * categories\_1\_\_id * categories\_1\_\_name * collections * created\_at * updated\_at * terms\_conditions\_url * app\_organization\_id * app\_organization\_name * app\_organization\_email * app\_organization\_website * app\_organization\_country\_code * locations\_0\_ * locations\_1\_ * date\_published * owner\_id * author\_name * author\_email * author\_url * short\_description * long\_description * installation\_instructions * raw\_long\_description * raw\_installation\_instructions * visibility * promoted * featured * paid * deprecated * obsolete * installable * marketing\_only * small\_icon
Sharing_Agreements * created\_at * id * name * partner\_name * remote\_subdomain * status * type * url