| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetZendesk</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">GetZendesk</h1><h2>Description: </h2><p>Incrementally fetches data from Zendesk API.</p><h3>Tags: </h3><p>zendesk</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Web Client Service Provider</strong></td><td>web-client-service-provider</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>WebClientServiceProvider<br/><strong>Implementation: </strong><a href="../../../nifi-web-client-provider-service-nar/1.19.0/org.apache.nifi.web.client.provider.service.StandardWebClientServiceProvider/index.html">StandardWebClientServiceProvider</a></td><td id="description">Controller service for HTTP client operations.</td></tr><tr><td id="name"><strong>Zendesk Subdomain Name</strong></td><td>zendesk-subdomain</td><td></td><td id="allowable-values"></td><td id="description">Name of the Zendesk subdomain.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Zendesk User Name</strong></td><td>zendesk-user</td><td></td><td id="allowable-values"></td><td id="description">Login user to Zendesk subdomain.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Zendesk Authentication Type</strong></td><td>zendesk-authentication-type-name</td><td></td><td id="allowable-values"><ul><li>Password <img src="../../../../../html/images/iconInfo.png" alt="Password of Zendesk login user." title="Password of Zendesk login user."></img></li><li>Token <img src="../../../../../html/images/iconInfo.png" alt="Authentication token generated in Zendesk Admin menu for API access." title="Authentication token generated in Zendesk Admin menu for API access."></img></li></ul></td><td id="description">Type of authentication to Zendesk API.</td></tr><tr><td id="name"><strong>Zendesk Authentication Credential</strong></td><td>zendesk-authentication-value-name</td><td></td><td id="allowable-values"></td><td id="description">Password or authentication token for Zendesk login user.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Zendesk Export Method</strong></td><td>zendesk-export-method</td><td></td><td id="allowable-values"><ul><li>Cursor Based <img src="../../../../../html/images/iconInfo.png" alt="In cursor-based incremental exports, each page of results includes an "after" cursor pointer to use as the starting cursor for the next page of results." title="In cursor-based incremental exports, each page of results includes an "after" cursor pointer to use as the starting cursor for the next page of results."></img></li><li>Time Based <img src="../../../../../html/images/iconInfo.png" alt="In time-based incremental exports, each page of results includes an end time to use as the start time for the next page of results." title="In time-based incremental exports, each page of results includes an end time to use as the start time for the next page of results."></img></li></ul></td><td id="description">Method for incremental export.</td></tr><tr><td id="name"><strong>Zendesk Resource</strong></td><td>zendesk-resource</td><td></td><td id="allowable-values"><ul><li>Tickets <img src="../../../../../html/images/iconInfo.png" alt="Tickets are the means through which end users (customers) communicate with agents in Zendesk Support." title="Tickets are the means through which end users (customers) communicate with agents in Zendesk Support."></img></li><li>Ticket Events <img src="../../../../../html/images/iconInfo.png" alt="Stream of changes that occurred on tickets. Each event is tied to an update on a ticket and contains all the fields that were updated in that change." title="Stream of changes that occurred on tickets. Each event is tied to an update on a ticket and contains all the fields that were updated in that change."></img></li><li>Ticket Metric Events <img src="../../../../../html/images/iconInfo.png" alt="Ticket metric events API can be used to track reply times, agent work times, and requester wait times." title="Ticket metric events API can be used to track reply times, agent work times, and requester wait times."></img></li><li>Users <img src="../../../../../html/images/iconInfo.png" alt="Zendesk Support has three types of users: end users (customers), agents, and administrators." title="Zendesk Support has three types of users: end users (customers), agents, and administrators."></img></li><li>Organizations <img src="../../../../../html/images/iconInfo.png" alt="Just as agents can be segmented into groups in Zendesk Support, customers (end-users) can be segmented into organizations." title="Just as agents can be segmented into groups in Zendesk Support, customers (end-users) can be segmented into organizations."></img></li><li>Articles <img src="../../../../../html/images/iconInfo.png" alt="Articles are content items such as help topics or tech notes contained in sections." title="Articles are content items such as help topics or tech notes contained in sections."></img></li><li>NPS - Responses <img src="../../../../../html/images/iconInfo.png" alt="When a recipient responds to an NPS survey, their rating, comment, and last survey date are captured." title="When a recipient responds to an NPS survey, their rating, comment, and last survey date are captured."></img></li><li>NPS - Recipients <img src="../../../../../html/images/iconInfo.png" alt="Every NPS survey is delivered to one or multiple recipients. For most businesses that use Zendesk Support, the recipients are customers. Agents and admins will never receive surveys." title="Every NPS survey is delivered to one or multiple recipients. For most businesses that use Zendesk Support, the recipients are customers. Agents and admins will never receive surveys."></img></li></ul></td><td id="description">The particular Zendesk resource which is meant to be exported.</td></tr><tr><td id="name"><strong>Zendesk Query Start Timestamp</strong></td><td>zendesk-query-start-timestamp</td><td></td><td id="allowable-values"></td><td id="description">Initial timestamp to query Zendesk API from in Unix timestamp seconds format.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>For FlowFiles created as a result of a successful HTTP request.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>record.count</td><td>The number of records fetched by the processor.</td></tr></table><h3>State management: </h3><table id="stateful"><tr><th>Scope</th><th>Description</th></tr><tr><td>CLUSTER</td><td>Paging cursor for Zendesk API is stored. Cursor is updated after each successful request.</td></tr></table><h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component does not allow an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> |