GetZendesk

Description

Incrementally fetches data from Zendesk API.

Tags

zendesk

Properties

In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display Name	API Name	Default Value	Allowable Values	Description
Web Client Service Provider *	web-client-service-provider		Controller Service: WebClientServiceProvider Implementations: StandardWebClientServiceProvider	Controller service for HTTP client operations.
Subdomain Name *	zendesk-subdomain			Name of the Zendesk subdomain. Supports Expression Language, using FlowFile attributes and Environment variables.
User Name *	zendesk-user			Login user to Zendesk subdomain. Supports Expression Language, using FlowFile attributes and Environment variables.
Authentication Type *	zendesk-authentication-type-name		Password Token	Type of authentication to Zendesk API.
Authentication Credential *	zendesk-authentication-value-name			Password or authentication token for Zendesk login user. Supports Expression Language, using FlowFile attributes and Environment variables.
Export Method *	zendesk-export-method		Cursor Based Time Based	Method for incremental export.
Resource *	zendesk-resource		Tickets Ticket Events Ticket Metric Events Users Organizations Articles NPS - Responses NPS - Recipients	The particular Zendesk resource which is meant to be exported.
Query Start Timestamp *	zendesk-query-start-timestamp			Initial timestamp to query Zendesk API from in Unix timestamp seconds format. Supports Expression Language, using FlowFile attributes and Environment variables.

Dynamic Properties

This component does not support dynamic properties.

Relationships

Name	Description
success	For FlowFiles created as a result of a successful HTTP request.

Reads Attributes

This processor does not read attributes.

Writes Attributes

Name	Description
record.count	The number of records fetched by the processor.

State Management

Scope	Description
CLUSTER	Paging 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

This component does not specify system resource considerations.

See Also