GetZendesk

Description:

Incrementally fetches data from Zendesk API.

Additional Details...

Tags:

zendesk

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Web Client Service Providerweb-client-service-providerController Service API:
WebClientServiceProvider
Implementation: StandardWebClientServiceProvider		Controller service for HTTP client operations.
Subdomain Namezendesk-subdomainName of the Zendesk subdomain.
Supports Expression Language: true (will be evaluated using Environment variables only)
User Namezendesk-userLogin user to Zendesk subdomain.
Supports Expression Language: true (will be evaluated using Environment variables only)
Authentication Typezendesk-authentication-type-name
  • Password Password of Zendesk login user.
  • Token Authentication token generated in Zendesk Admin menu for API access.
Type of authentication to Zendesk API.
Authentication Credentialzendesk-authentication-value-namePassword or authentication token for Zendesk login user.
Sensitive Property: true
Supports Expression Language: true (will be evaluated using Environment variables only)
Export Methodzendesk-export-method
  • Cursor Based 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.
  • Time Based 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.
Method for incremental export.
Resourcezendesk-resource
  • Tickets Tickets are the means through which end users (customers) communicate with agents in Zendesk Support.
  • Ticket Events 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.
  • Ticket Metric Events Ticket metric events API can be used to track reply times, agent work times, and requester wait times.
  • Users Zendesk Support has three types of users: end users (customers), agents, and administrators.
  • Organizations Just as agents can be segmented into groups in Zendesk Support, customers (end-users) can be segmented into organizations.
  • Articles Articles are content items such as help topics or tech notes contained in sections.
  • NPS - Responses When a recipient responds to an NPS survey, their rating, comment, and last survey date are captured.
  • NPS - Recipients 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.
The particular Zendesk resource which is meant to be exported.
Query Start Timestampzendesk-query-start-timestampInitial timestamp to query Zendesk API from in Unix timestamp seconds format.
Supports Expression Language: true (will be evaluated using Environment variables only)

Relationships:

NameDescription
successFor FlowFiles created as a result of a successful HTTP request.

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
record.countThe number of records fetched by the processor.

State management:

ScopeDescription
CLUSTERPaging cursor for Zendesk API is stored. Cursor is updated after each successful request.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified.