zendesk

README

Conduit Connector Zendesk

General

The Zendesk connector is one of Conduit custom plugins. It provides both, a source and a destination zendesk connectors.

How to build it

Run make.

Testing

Run make test to run all the tests.

HTTP Client

A new HTTP Zendesk client is created in source and destination, as the scope of existing GO client libraries for zendesk is restricted to cursor increment flow for exporting tickets and bulk import operations.

Zendesk Source

The Zendesk client connector will connect with Zendesk API through the url constructed using subdomain specific to individual organization. Upon successful configuration with zendesk.userName and zendesk.apiToken the tickets from the given domain is fetched using cursor based incremental exports provided by zendesk. The cursor is initiated with start_time set to 0 or the time set in position of last successfully ack'd record and all subsequent iterations are done using after_url returned by the zendesk till the pipeline is paused. On resuming of the pipeline updated_at time of the last fetched ticket is used to restart the cursor.

Generating API token in Zendesk

The api token for the zendesk can be created through zendesk portal by logging in as admin. Refer the zendesk documentation for step-by-step setup.

Change Data Capture (CDC)

The connector uses the zendesk cursor based incremental exports to listen iterate over tickets changed after the given start_time. We initiate a cursor at the start of the pipeline using the start_time as 0, which means we start fetching all the tickets from the start. The subsequent data is fetched using the after_url received as part of response. When the pipeline resumed after pause/crash, we use the position of the last successfully read record to restart the cursor using the updated_at data from position as the start_time.

Position Handling

The connector uses the combination of last_modified_time time and id to uniquely identify the records. last_modified_time: The updated_at time of last successfully read ticket is used. In case the updated_at time is empty, the created_at time of the last ticket is used. id: This is the ticket id associated with the ticket, received from zendesk.

The last_modified_time is used as start_time query param for restarting the cursor based incremental export.

Sample position:

{
  "last_modified_time": "2006-01-02T15:04:05Z07:00",
  "id": 12345
}

Record Keys

The id of the ticket is used as the unique key for the record.

Sample Record:

{
  "position": {
    "last_modified_time": "2006-01-02T15:04:05Z07:00",
    "id": 12345
  },
  "metadata": null,
  "key": "12345",
  "payload": {
       "before" : null,
       "after" : "<ticket json received from zendesk>"
  }
}

Configuration - Source

name	description	required	default
zendesk.domain	domain is the registered by organization to zendesk	true
zendesk.userName	username is the registered for login	true
zendesk.apiToken	password associated with the username for login	true
pollingPeriod	pollingPeriod is the frequency of conduit hitting zendesk API- Default is 6s	false	"6s"

NOTE: pollingPeriod will be in time.Duration - 2ns,2ms,2s,2m,2h

Known Limitations

• The zendesk API has a rate limit of 10 requests per minute. If rate limit is exceeded, zendesk sends 429 status code with Cool off duration in Retry-After header. We use this duration to skip hitting the zendesk APIs repeatedly.
• Currently, the connector only supports ticket data fetching. Other type of data fetching will be part of subsequent phases.

Destination Connector

The destination connector receives the records from the conduit as individual record object and store it to the buffer as an array of records. Then it will push the tickets to zendesk using bulk import api. Configuration for zendesk destination api includes zendesk.domain, zendesk.userName,zendesk.apiToken. Once the zendesk client is initialized, it will wait for the buffer to be filled, before writing the data to zendesk destination account.

The connector can accept both structured payloads and raw payloads(JSON bytes).

Buffer converts the payload bytes of individual record to map[string]interface{} and send the tickets to zendesk with request body structure:

{
  "tickets": [
    "ticket_1_json",
    "ticket_2_json"
  ]
}

In case the rate limit is exceeded, i.e 429 error is received from zendesk, connector blocks for the duration received in Retry-After header from zendesk and retries the API call, if the API retry count doesn't exceed the maxRetries. If unsuccessful even after the retries, the writer returns an error.

Configuration - Destination

name	description	required	default
zendesk.domain	domain is the registered by organization to zendesk	true
zendesk.userName	username is the registered for login	true
zendesk.apiToken	password associated with the username for login	true
bufferSize	bufferSize stores the ticket objects as array	false	100
maxRetries	max API retry attempts, in case of rate-limit exceeded error(429)	false	3

Limitations

• Max 100 tickets that can be written in one API call to zendesk
• Ticket import can be authorized only by admins
• Currently, only ticket import is supported, other data type import will be added in later phases.

References

• https://developer.zendesk.com/documentation/ticketing/using-the-zendesk-apibest-practices-for-avoiding-rate-limiting/#catching-errors-caused-by-rate-limiting
• https://developer.zendesk.com/api-reference/ticketing/ticket-management/incremental_exports/#cursor-based-pagination-json-format
• https://developer.zendesk.com/documentation/ticketing/managing-tickets/using-the-incremental-export-api/#cursor-based-incremental-exports
• https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_import/#ticket-bulk-import

Documentation

Index

• Variables
• func Specification() sdk.Specification

Variables

var Connector = sdk.Connector{
	NewSpecification: Specification,
	NewSource:        source.NewSource,
	NewDestination:   destination.NewDestination,
}

Connector represents a sdk.Connector of Zendesk.

Functions

func Specification

func Specification() sdk.Specification