Channel framework startup tutorial - Overview
The Channel framework lets you integrate origin services with Zendesk Support. It enables mirroring content between those origin services and Zendesk Support and agents to support customers on origin services through Zendesk Support.
In this tutorial, you'll build an integration service for WordPress. Zendesk Support will call the integration service periodically, converting WordPress blog comments into Zendesk Support tickets and comments. Agents can respond in Zendesk Support. The Channel framework sends these agent responses to the integration service, which creates corresponding comments in WordPress.
- Step 1: Setup the developer environment
- Step 2: Get resources from the origin service (Polling)
- Step 3: Add logging of event callbacks
- Step 4: Post new resources to the origin service (Channelback)
- Step 5: Connect the integration service to Zendesk Support - Part 1 (Admin UI, Manifest)
- Step 6: Connect the integration service to Zendesk Support - Part 2 (Zendesk app)
- Step 7: Store state information in Zendesk Support (Metadata, Pull State)
- Step 8: Provide native resource links in Zendesk Support (Clickthrough)
- Appendix: Environment Setup
Building an integration using the Zendesk REST API requires extensive knowledge of the Zendesk Support data model, and of course of the Zendesk API. Building an integration using the Channel framework doesn’t require any knowledge of the Zendesk Support data model or APIs. Instead, the integration exposes itself as a web service. It implements methods specified by Zendesk Support, but it doesn’t need to call it at all. The methods it exposes are not dependent on internal Zendesk Support details.
This tutorial requires you to:
- Install applications on your computer. (Note: We have not tested the instructions with role escalation. You may need extra configuration if you're sudoing.)
- Use the
curlcommand for testing.
- Have access to a Zendesk Support account for testing
This tutorial uses WordPress as the origin service. To run everything in this tutorial, you need:
- Database for WordPress
- "rest-api" WordPress plugin
- "JSON Basic Authentication" WordPress plugin
- Node for integration service
- Ruby for the Zendesk App Tools
Refer to the installation instructions of these applications on how to install them.
This tutorial was created in 2017 and some information about WordPress is out of date.
Specifically, WordPress and mySQL have been changed behaviors since the tutorial was created a few years back:
- the WordPress plugin used to do REST API calls is no longer necessary as of quite a while ago
- the WordPress user needs to be updated for the mySQL connection to work
- the way the service's code is written, you have to have a non-plain permalink specified under preferences. The value of "plain" is the default, so this needs to be changed by the WordPress administrator.
The recommended WordPress rest-api library is no longer maintained. According to WordPress, the plugin "hasn’t been tested with the latest 3 major releases of WordPress. It may no longer be maintained or supported and may have compatibility issues when used with more recent versions of WordPress."
The plug-in is no longer needed with the latest WordPress. The user is given a link to download.